程式扎記

Preface:
在平常我們常常使用 Windows 的 Ctrl+C (複製) , Ctrl+P (貼上) etc, 那我們有沒有辦法在 Java UI 上添加類似的快捷鍵呢? 答案是使用 KeyAdapter 類別. 底下我們透過一個簡單範例說明如何為 UI 添加快捷鍵與剪貼簿的使用.

CalcUI 範例:
考慮我們有個只有加法的 Calculator 如下, 在按下 "=" 按鈕後會將計算結果顯示於最右邊的 TextField:

而如果我們要將計算結果取出, 則需要到最右邊的 TextField 選取所有內容後, 再按下 Ctrl+C 的複製快捷鍵. 但我們希望一旦按下 "=" 鍵, 接著直接按下 Ctrl+C 的快捷鍵便可以將計算結果置於剪貼簿中. 因此下面將說明如何完成這個需求.

Step1. 第一步就是要先讓 UI 可以監聽到鍵盤的 Event, 此因我們新增另一個類別來處理 Key event 並監聽 Ctrl+C 的事件:

view plaincopy to clipboardprint?
class MyKeyListener extends KeyAdapter{    
    public void keyPressed(KeyEvent e){    
        if ((e.getKeyCode() == KeyEvent.VK_C) && ((e.getModifiers() & KeyEvent.CTRL_MASK) != 0)) {  
            // Copy calculation result to clipboard  
           }  
    }    
}  

Step2. 接著為了要能操作 clipboard, 最外層的 JFrame 需要實作 ClipboardOwner 介面; 並加入剛剛建立的 KeyEvent 監聽類別建立的物件:

view plaincopy to clipboardprint?
public class CalcUI extends JFrame implements ClipboardOwner{  
...  
    public CalcUI() {  
        super();  
        initGUI();  
        clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();    
        addKeyListener(new MyKeyListener());  
        setFocusable(true); // 確保自己能得到 focus 已收到監聽事件  
        frame = this; // 方便後續 reference 到自己.  
    }  
...  
}  

Step3. 然後因為按下 "=" 按鈕後外面的 JFrame 會失去 focus (導致不能監聽鍵盤事件), 因此要稍作修改:

view plaincopy to clipboardprint?
jButtonEq.addActionListener(new ActionListener() {  
    public void actionPerformed(ActionEvent evt) {  
        int sum = Integer.valueOf(jTextFieldA.getText()) + Integer.valueOf(jTextFieldB.getText());  
        jTextFieldSum.setText(String.valueOf(sum));  
        frame.requestFocus(); // 讓外面的 JFrame 獲得 focus 以繼續監聽事件  
    }  
});  

Step4. 最後修改原先的 MyKeyListener 讓使用者鍵入 Ctrl+C 後將計算結果置於剪貼簿:

view plaincopy to clipboardprint?
class MyKeyListener extends KeyAdapter{    
    public void keyPressed(KeyEvent e){    
        if ((e.getKeyCode() == KeyEvent.VK_C) && ((e.getModifiers() & KeyEvent.CTRL_MASK) != 0)) {  
            StringSelection contents = new StringSelection(jTextFieldSum.getText());  
            clipboard.setContents(contents, frame);    
           }  
    }    
}  

完整代碼如下:

view plaincopy to clipboardprint?
package swing.demo;  
import java.awt.Toolkit;  
import java.awt.datatransfer.Clipboard;  
import java.awt.datatransfer.ClipboardOwner;  
import java.awt.datatransfer.StringSelection;  
import java.awt.datatransfer.Transferable;  
import java.awt.event.ActionEvent;  
import java.awt.event.ActionListener;  
import java.awt.event.KeyAdapter;  
import java.awt.event.KeyEvent;  
  
import javax.swing.JButton;  
import javax.swing.JFrame;  
import javax.swing.JLabel;  
import javax.swing.JTextField;  
import javax.swing.SwingConstants;  
import javax.swing.SwingUtilities;  
import javax.swing.WindowConstants;  
  
public class CalcUI extends JFrame implements ClipboardOwner{  
    private JTextField jTextFieldA;  
    private JTextField jTextFieldSum;  
    private JButton jButtonEq;  
    private JTextField jTextFieldB;  
    private JLabel jLabelPlus;  
    public CalcUI frame;  
    private Clipboard clipboard;    
  
    /** 
    * Auto-generated main method to display this JFrame 
    */  
    public static void main(String[] args) {  
        SwingUtilities.invokeLater(new Runnable() {  
            public void run() {  
                CalcUI inst = new CalcUI();  
                inst.setLocationRelativeTo(null);  
                inst.setVisible(true);  
            }  
        });  
    }  
      
    public CalcUI() {  
        super();  
        initGUI();  
        clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();    
        addKeyListener(new MyKeyListener());  
        setFocusable(true);  
        frame = this;  
    }  
      
    private void initGUI() {  
        try {  
            setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);  
            getContentPane().setLayout(null);  
            {  
                jTextFieldA = new JTextField();  
                getContentPane().add(jTextFieldA);  
                jTextFieldA.setText("10");  
                jTextFieldA.setBounds(12, 12, 83, 24);  
                jTextFieldA.setHorizontalAlignment(SwingConstants.CENTER);  
            }  
            {  
                jLabelPlus = new JLabel();  
                getContentPane().add(jLabelPlus);  
                jLabelPlus.setText("+");  
                jLabelPlus.setBounds(101, 15, 17, 17);  
                jLabelPlus.setFont(new java.awt.Font("Arial",1,12));  
                jLabelPlus.setHorizontalAlignment(SwingConstants.CENTER);  
            }  
            {  
                jTextFieldB = new JTextField();  
                getContentPane().add(jTextFieldB);  
                jTextFieldB.setText("10");  
                jTextFieldB.setBounds(125, 12, 20, 24);  
                jTextFieldB.setSize(83, 24);  
                jTextFieldB.setHorizontalAlignment(SwingConstants.CENTER);  
            }  
            {  
                jButtonEq = new JButton();  
                getContentPane().add(jButtonEq);  
                jButtonEq.setText("=");  
                jButtonEq.setFocusable(false);  
                jButtonEq.setBounds(214, 12, 42, 24);  
                jButtonEq.setFont(new java.awt.Font("Arial",1,12));  
                jButtonEq.addActionListener(new ActionListener() {  
                    public void actionPerformed(ActionEvent evt) {  
                        int sum = Integer.valueOf(jTextFieldA.getText()) + Integer.valueOf(jTextFieldB.getText());  
                        jTextFieldSum.setText(String.valueOf(sum));  
                        frame.requestFocus(); // 讓外面的 JFrame 獲得 focus 以繼續監聽事件  
                    }  
                });  
            }  
            {  
                jTextFieldSum = new JTextField();  
                getContentPane().add(jTextFieldSum);  
                jTextFieldSum.setText("?");  
                jTextFieldSum.setBounds(267, 12, 105, 24);  
                jTextFieldSum.setHorizontalAlignment(SwingConstants.CENTER);  
            }  
            pack();  
            this.setSize(400, 86);  
        } catch (Exception e) {  
            //add your error handling code here  
            e.printStackTrace();  
        }  
    }  
      
    class MyKeyListener extends KeyAdapter{    
        public void keyPressed(KeyEvent e){    
            if ((e.getKeyCode() == KeyEvent.VK_C) && ((e.getModifiers() & KeyEvent.CTRL_MASK) != 0)) {  
                StringSelection contents = new StringSelection(jTextFieldSum.getText());  
                clipboard.setContents(contents, frame);    
            }  
        }    
    }  
  
    @Override  
    public void lostOwnership(Clipboard arg0, Transferable arg1) {}   
}  

Supplement:
* [blog] java Gui 键盘监听事件
* [ Java 代碼範本 ] 用 java 設定、取用剪貼簿內容
* stackoverflow: Java detect CTRL+X key
* Java Tutorial : How to write key listener

Preface:
假設裡有個 URL, 你希望得到該 URL 連到的 Web page 的影像, 硬幹的方法是:

1. 打開瀏覽器
2. 輸入 URL
3. 影像擷取

但如果你要 automation 的話, 則可以利用 Java 的 Deskop 類別上的方法 browse(URI uri) 幫你打開瀏覽器並輸入 URL; 並利用類別 Robot 上面的方法 createScreenCapture(Rectangle screenRect) 幫你擷取桌面上的截圖. 然而這樣的方法必須在有 UI 的環境下才生效, 如果你是在 Linux runlevel<=2 (沒有 UI) 的情況下, 則會有 exception 發生. 此時就麻煩點要採用第二種方法.

方法一:
使用 Java 自帶類別就可以辦到, 但是前提必須待在有 UI 的環境下 (這樣才打得開瀏覽器 orz), 底下為範例代碼:

view plaincopy to clipboardprint?
/** 
* BD: Take Image of web page from given URL. 
* REF: 
*  - http://stackoverflow.com/questions/2746289/converting-webpage-into-jpeg-image-using-java 
*  - http://stackoverflow.com/questions/602032/getting-java-gui-to-open-a-webpage-in-web-browser 
*  - http://stackoverflow.com/questions/7032556/how-to-take-a-webpage-screenshot 
* @param url: URL to browse 
* @param output: Output image file (.png) 
* @param st: Sleep time which should exceed browsing time to have correct image. 
* @throws Exception 
*/  
public static void TakeImageOfWebPage(String url, File output, long st) throws Exception  
{         
    Desktop.getDesktop().browse(new URI(url));  
       Robot robot = new Robot();  
       Dimension screenDim = Toolkit.getDefaultToolkit().getScreenSize();  
       Rectangle rect = new Rectangle(screenDim);  
       Thread.sleep(st);  
       BufferedImage img = robot.createScreenCapture( rect );          
       ImageIO.write(img, "png", output);  
}  

假設你要 take 雅虎的 web page image, 則可以如下使用上面 API:

view plaincopy to clipboardprint?
public static void main(String[] args) throws Exception{          
    TakeImageOfWebPage("http://www.kimo.com.tw", new File("yahoo.png"), 1000);            
}  

此時你會發現你的瀏覽器被打開, 而輸出的 "yahoo.png" 即是當前 yahoo 的首頁 image. 這會有個困擾就是當你執行幾次, 你的瀏覽器就會產生多少個分頁....

方法二:
第二個方法不會有第一個方法造成瀏覽器產生多個分頁的問題, 而且是使用在 Linux runlevel=2 沒有 UI 的環境下. 但是在使用這個方法前有些 library 要去下載:

* selenium: Selenium browser automation framework
* Apache Commons IO: Commons IO is a library of utilities to assist with developing IO functionality.
* google-collections: Guava is a fully compatible superset of the old Google Collections Library.
* java-json.jar

除此之外, 你還需要安裝 xvfb, 如果是在 Ubuntu, 下面的命令會幫你搞定:

# apt-get install xvfb

接著下面是範例代碼:

view plaincopy to clipboardprint?
   private static int      DISPLAY_NUMBER  = 99;  
   private static String   XVFB            = "/usr/bin/Xvfb";  
   private static String   XVFB_COMMAND    = XVFB + " :" + DISPLAY_NUMBER;      
public static void TakeImageOfWebPageViaFirefox(String url, String fn) throws Exception  
{  
    // http://stackoverflow.com/questions/7032556/how-to-take-a-webpage-screenshot  
    // https://code.google.com/p/selenium/  
    Process p = Runtime.getRuntime().exec(XVFB_COMMAND);  
       FirefoxBinary firefox = new FirefoxBinary();  
       firefox.setEnvironmentProperty("DISPLAY", ":" + DISPLAY_NUMBER);  
       WebDriver driver = new FirefoxDriver(firefox, null);  
       driver.get(url);  
       File scrFile = ( (TakesScreenshot) driver ).getScreenshotAs(OutputType.FILE);  
       FileUtils.copyFile(scrFile, new File(fn));  
       driver.close();  
       p.destroy();  
}  

這次我們來 take google web page 的 image 並存成檔案 "google.png":

view plaincopy to clipboardprint?
TakeImageOfWebPageViaFirefox("http://www.google.com.tw", "google.png");   

Supplement:
* stackoverflow: How to take a webpage screenshot?
* ConvertWebpage: 工具幫你自動轉換
* CutyCapt

CutyCapt is a small cross-platform command-line utility to capture WebKit's rendering of a web page into a variety of vector and bitmap formats, including SVG, PDF, PS, PNG, JPEG, TIFF, GIF, and BMP...

Using CutyCapt without X server 執行範例:
# xvfb-run --auto-servernum ./CutyCapt --url=http://cutycapt.sourceforge.net --out=cutycapt.png

程式扎記

標籤

2013年9月13日星期五

[ Java 代碼範本 ] 如何為 Java UI 添加 Key Listener

2013年9月12日星期四

[ Java 代碼範本 ] 擷取 Web page 的影像

[Git 常見問題] error: The following untracked working tree files would be overwritten by merge

檢舉濫用情形

學習筆記

標籤

2013年9月13日 星期五