魔法使いの弟子（その3-1）

【ミッション： ファイルのドラッグ & ドロップをサポートしたい！】

今さらながら、O'reilly の “JAVA SWING HACKS” に載っていた HACK #59 『ファイルをドラッグ & ドロップする』 を試してみた。

これは、アプリ画面上部のアイコンをドラッグ & ドロップすると、テキストエリアに入力した内容でファイルが作られるのだ。

アイコンをドラッグ & ドロップすると、その先に「myfile.txt」が作られる。
ファイルの中身はアプリのテキストエリアと同じ。

本に載っている断片的なソースコードを継ぎ合わせると、だいたい以下のようになる。

+ expand sourceview plainprint?

1. import java.awt.BorderLayout;  
2. import java.awt.Cursor;  
3. import java.awt.Dimension;  
4. import java.awt.Point;  
5. import java.awt.Toolkit;  
6. import java.awt.datatransfer.DataFlavor;  
7. import java.awt.datatransfer.Transferable;  
8. import java.awt.dnd.DnDConstants;  
9. import java.awt.dnd.DragGestureEvent;  
10. import java.awt.dnd.DragGestureListener;  
11. import java.awt.dnd.DragGestureRecognizer;  
12. import java.awt.dnd.DragSource;  
13. import java.awt.dnd.DragSourceAdapter;  
14. import java.awt.dnd.DragSourceContext;  
15. import java.awt.dnd.DragSourceDragEvent;  
16. import java.awt.dnd.DragSourceEvent;  
17. import java.awt.image.BufferedImage;  
18. import java.io.File;  
19. import java.io.FileOutputStream;  
20. import java.io.IOException;  
21. import java.util.ArrayList;  
22. import java.util.List;  
23. import javax.swing.Icon;  
24. import javax.swing.JFrame;  
25. import javax.swing.JLabel;  
26. import javax.swing.JTextArea;  
27. import javax.swing.SwingConstants;  
28. import javax.swing.filechooser.FileSystemView;  
29.   
30. // ドラッグ&ドロップのテスト  
31. public class FileDropper {  
32.     public static void main(String[] args) throws IOException {  
33.         JFrame frame = new JFrame("Drag and Drop File Hack");  
34.         frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);  
35.   
36.         FileSystemView fsv = FileSystemView.getFileSystemView();  
37.         Icon icon = fsv.getSystemIcon(File.createTempFile("myfile.",".txt"));  
38.   
39.         frame.getContentPane().setLayout(new BorderLayout());  
40.         JTextArea text = new JTextArea();  
41.   
42.         JLabel label = new JLabel("myfile.txt",icon,SwingConstants.CENTER);  
43.         DragSource ds = DragSource.getDefaultDragSource();  
44.         DragGestureRecognizer dgr = ds.createDefaultDragGestureRecognizer(  
45.                 label,  
46.                 DnDConstants.ACTION_MOVE,  
47.                 new FileDragGestureListener(text));  
48.   
49.         frame.getContentPane().add("North",label);  
50.         frame.getContentPane().add("Center",text);  
51.   
52.         frame.pack();  
53.         frame.setSize(400,300);  
54.         frame.setVisible(true);  
55.     }  
56. }  
57.   
58. class FileDragGestureListener extends DragSourceAdapter implements DragGestureListener {  
59.     JTextArea text;  
60.     Cursor cursor;  
61.       
62.     public FileDragGestureListener(JTextArea text) {  
63.         this.text = text;  
64.     }  
65.   
66.     public void dragGestureRecognized(DragGestureEvent evt) {  
67.         try {  
68.             // 一時ファイルを生成  
69.             File temp_dir = File.createTempFile("tempdir",".dir",null);  
70.             File temp = new File(temp_dir.getParent(),"myfile.txt");  
71.             FileOutputStream out = new FileOutputStream(temp);  
72.             out.write(text.getText().getBytes());  
73.             out.close();  
74.   
75.             // 適切なアイコンを取得  
76.             FileSystemView fsv = FileSystemView.getFileSystemView();  
77.             Icon icn = fsv.getSystemIcon(temp);  
78.   
79.             Toolkit tk = Toolkit.getDefaultToolkit();  
80.             Dimension dim = tk.getBestCursorSize(icn.getIconWidth(),icn.getIconHeight());  
81.             BufferedImage buff = new BufferedImage(dim.width,dim.height,BufferedImage.TYPE_INT_ARGB);  
82.             icn.paintIcon(text,buff.getGraphics(),0,0);  
83.   
84.             // ドラッグイメージをセットアップ  
85.             if(DragSource.isDragImageSupported()) {  
86.                 evt.startDrag(DragSource.DefaultCopyDrop, buff, new Point(0,0),  
87.                         new TextFileTransferable(temp),  
88.                         this);  
89.             } else {  
90.                 cursor = tk.createCustomCursor(buff,new Point(0,0),"billybob");  
91.                 evt.startDrag(cursor, null, new Point(0,0),  
92.                         new TextFileTransferable(temp),  
93.                         this);  
94.             }  
95.   
96.         } catch (IOException ex) {  
97.             /* なんかバグってるよ */  
98.         }  
99.     }  
100.   
101.     public void dragEnter(DragSourceDragEvent evt) {  
102.         DragSourceContext ctx = evt.getDragSourceContext();  
103.         ctx.setCursor(cursor);  
104.     }  
105.   
106.     public void dragExit(DragSourceEvent evt) {  
107.         DragSourceContext ctx = evt.getDragSourceContext();  
108.         ctx.setCursor(DragSource.DefaultCopyNoDrop);  
109.     }  
110. }  
111.   
112. // 一時ファイルを保持するTransferable  
113. class TextFileTransferable implements Transferable {  
114.     File temp;  
115.   
116.     public TextFileTransferable(File temp) throws IOException {  
117.         this.temp = temp;  
118.     }  
119.   
120.     public Object getTransferData(DataFlavor flavor) {  
121.         List<File> list = new ArrayList<File>();  
122.         list.add(temp);  
123.         return list;  
124.     }  
125.   
126.     public DataFlavor[] getTransferDataFlavors() {  
127.         DataFlavor[] df = new DataFlavor[1];  
128.         df[0] = DataFlavor.javaFileListFlavor;  
129.         return df;  
130.     }  
131.   
132.     public boolean isDataFlavorSupported(DataFlavor flavor) {  
133.         if(flavor == DataFlavor.javaFileListFlavor) {  
134.             return true;  
135.         }  
136.         return false;  
137.     }  
138. }  

import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Dimension;
import java.awt.Point;
import java.awt.Toolkit;
import java.awt.datatransfer.DataFlavor;
import java.awt.datatransfer.Transferable;
import java.awt.dnd.DnDConstants;
import java.awt.dnd.DragGestureEvent;
import java.awt.dnd.DragGestureListener;
import java.awt.dnd.DragGestureRecognizer;
import java.awt.dnd.DragSource;
import java.awt.dnd.DragSourceAdapter;
import java.awt.dnd.DragSourceContext;
import java.awt.dnd.DragSourceDragEvent;
import java.awt.dnd.DragSourceEvent;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.swing.Icon;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextArea;
import javax.swing.SwingConstants;
import javax.swing.filechooser.FileSystemView;

// ドラッグ&ドロップのテスト
public class FileDropper {
    public static void main(String[] args) throws IOException {
        JFrame frame = new JFrame("Drag and Drop File Hack");
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

        FileSystemView fsv = FileSystemView.getFileSystemView();
        Icon icon = fsv.getSystemIcon(File.createTempFile("myfile.",".txt"));

        frame.getContentPane().setLayout(new BorderLayout());
        JTextArea text = new JTextArea();

        JLabel label = new JLabel("myfile.txt",icon,SwingConstants.CENTER);
        DragSource ds = DragSource.getDefaultDragSource();
        DragGestureRecognizer dgr = ds.createDefaultDragGestureRecognizer(
                label,
                DnDConstants.ACTION_MOVE,
                new FileDragGestureListener(text));

        frame.getContentPane().add("North",label);
        frame.getContentPane().add("Center",text);

        frame.pack();
        frame.setSize(400,300);
        frame.setVisible(true);
    }
}

class FileDragGestureListener extends DragSourceAdapter implements DragGestureListener {
    JTextArea text;
    Cursor cursor;
    
    public FileDragGestureListener(JTextArea text) {
        this.text = text;
    }

    public void dragGestureRecognized(DragGestureEvent evt) {
        try {
            // 一時ファイルを生成
            File temp_dir = File.createTempFile("tempdir",".dir",null);
            File temp = new File(temp_dir.getParent(),"myfile.txt");
            FileOutputStream out = new FileOutputStream(temp);
            out.write(text.getText().getBytes());
            out.close();

            // 適切なアイコンを取得
            FileSystemView fsv = FileSystemView.getFileSystemView();
            Icon icn = fsv.getSystemIcon(temp);

            Toolkit tk = Toolkit.getDefaultToolkit();
            Dimension dim = tk.getBestCursorSize(icn.getIconWidth(),icn.getIconHeight());
            BufferedImage buff = new BufferedImage(dim.width,dim.height,BufferedImage.TYPE_INT_ARGB);
            icn.paintIcon(text,buff.getGraphics(),0,0);

            // ドラッグイメージをセットアップ
            if(DragSource.isDragImageSupported()) {
                evt.startDrag(DragSource.DefaultCopyDrop, buff, new Point(0,0),
                        new TextFileTransferable(temp),
                        this);
            } else {
                cursor = tk.createCustomCursor(buff,new Point(0,0),"billybob");
                evt.startDrag(cursor, null, new Point(0,0),
                        new TextFileTransferable(temp),
                        this);
            }

        } catch (IOException ex) {
            /* なんかバグってるよ */
        }
    }

    public void dragEnter(DragSourceDragEvent evt) {
        DragSourceContext ctx = evt.getDragSourceContext();
        ctx.setCursor(cursor);
    }

    public void dragExit(DragSourceEvent evt) {
        DragSourceContext ctx = evt.getDragSourceContext();
        ctx.setCursor(DragSource.DefaultCopyNoDrop);
    }
}

// 一時ファイルを保持するTransferable
class TextFileTransferable implements Transferable {
    File temp;

    public TextFileTransferable(File temp) throws IOException {
        this.temp = temp;
    }

    public Object getTransferData(DataFlavor flavor) {
        List<File> list = new ArrayList<File>();
        list.add(temp);
        return list;
    }

    public DataFlavor[] getTransferDataFlavors() {
        DataFlavor[] df = new DataFlavor[1];
        df[0] = DataFlavor.javaFileListFlavor;
        return df;
    }

    public boolean isDataFlavorSupported(DataFlavor flavor) {
        if(flavor == DataFlavor.javaFileListFlavor) {
            return true;
        }
        return false;
    }
}

このサンプルは、 Java アプリケーションから外部へファイルをドラッグ & ドロップするというものだが、逆に外部からファイルを Java アプリケーションへドロップできたら何かと便利そうである。

---

例えば、 SD カードから特定の画像だけを『セロテープぺったん画像』に変換したい場合に、ドラッグ & ドロップでアプリにファイルを放り込む事ができたらきっとラクだろう。

というわけで、上記のソースをじゃっかん改造して作ってみた。『アプリから』ドラッグするのと『アプリへ』ドラッグするのとでは、ドラッグまわりの実装方針が異なるが、ファイルのやりとりの抽象化に関しては一緒である。

あと、 GUI 構築に関するコードを中心に、ぼくのスタイルに（勝手に）書き換えている。

作ったのは右下のふざけたアプリ。
テキストエリアにファイルをドラッグ & ドロップすると、フルパスが表示される。

ドロップされた時点でファイル群はリスト List に格納されているので、あとは for ループで一つずつ取り出して処理を行えばよい。

一応ソースコードを晒しておく。

+ expand sourceview plainprint?

1. import java.awt.datatransfer.DataFlavor;  
2. import java.awt.datatransfer.Transferable;  
3. import java.awt.datatransfer.UnsupportedFlavorException;  
4. import java.awt.dnd.DnDConstants;  
5. import java.awt.dnd.DropTarget;  
6. import java.awt.dnd.DropTargetDragEvent;  
7. import java.awt.dnd.DropTargetDropEvent;  
8. import java.awt.dnd.DropTargetEvent;  
9. import java.awt.dnd.DropTargetListener;  
10. import java.io.File;  
11. import java.io.IOException;  
12. import java.util.List;  
13. import javax.swing.JFrame;  
14. import javax.swing.JScrollPane;  
15. import javax.swing.JTextArea;  
16.   
17. /** 
18.  * テキストエリアのところにファイルをドロップすると、 
19.  * その絶対パスの一覧を表示するらしい。 
20.  * @author tercel 
21.  */  
22. public class FilesDropTest extends JFrame implements DropTargetListener {  
23.     public static void main(String args[]) {  
24.         FilesDropTest app = new FilesDropTest();  
25.         app.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);  
26.         app.setSize(400, 300);  
27.         app.setVisible(true);  
28.     }  
29.   
30.     DropTarget dropTarget;  
31.     JTextArea textArea; // ここにファイルの一覧を表示するよ！  
32.   
33.     // コンストラクタ  
34.     public FilesDropTest() {  
35.         super("テストだっち ∩( ・ω・)∩");  
36.   
37.         textArea = new JTextArea();  
38.         JScrollPane scroll = new JScrollPane(textArea);  
39.         this.add(scroll);  
40.   
41.         dropTarget = new DropTarget(textArea, this);  
42.   
43.     }  
44.       
45.     // DropTargetListener の各メソッドのオーバーライド  
46.     @Override  
47.     public void dragEnter(DropTargetDragEvent dtde) {}  
48.   
49.     @Override  
50.     public void dragOver(DropTargetDragEvent dtde) {}  
51.   
52.     @Override  
53.     public void dropActionChanged(DropTargetDragEvent dtde) {}  
54.   
55.     @Override  
56.     public void dragExit(DropTargetEvent dte) {}  
57.   
58.     @Override  
59.     public void drop(DropTargetDropEvent dtde) {  
60.         dtde.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);  
61.         Transferable trans = dtde.getTransferable();  
62.   
63.         List<File> fileList = null;  
64.   
65.         if(trans.isDataFlavorSupported(DataFlavor.javaFileListFlavor)) {  
66.             try {  
67.                 fileList = (List<File>) trans.getTransferData(DataFlavor.javaFileListFlavor);  
68.             } catch (UnsupportedFlavorException ex) {  
69.                 /* 例外処理 */  
70.             } catch (IOException ex) {  
71.                 /* 例外処理 */  
72.             }  
73.         }  
74.   
75.         /* ここの時点で、fileList にはドロップされたファイルのリストが入ってるよ！ */  
76.         /* 煮るなり焼くなりできるね */  
77.         if(fileList == null) return;  
78.         for(File f : fileList)  
79.             textArea.append(f.getAbsolutePath() + "\n");  
80.     }  
81. }  

import java.awt.datatransfer.DataFlavor;
import java.awt.datatransfer.Transferable;
import java.awt.datatransfer.UnsupportedFlavorException;
import java.awt.dnd.DnDConstants;
import java.awt.dnd.DropTarget;
import java.awt.dnd.DropTargetDragEvent;
import java.awt.dnd.DropTargetDropEvent;
import java.awt.dnd.DropTargetEvent;
import java.awt.dnd.DropTargetListener;
import java.io.File;
import java.io.IOException;
import java.util.List;
import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;

/**
 * テキストエリアのところにファイルをドロップすると、
 * その絶対パスの一覧を表示するらしい。
 * @author tercel
 */
public class FilesDropTest extends JFrame implements DropTargetListener {
    public static void main(String args[]) {
        FilesDropTest app = new FilesDropTest();
        app.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        app.setSize(400, 300);
        app.setVisible(true);
    }

    DropTarget dropTarget;
    JTextArea textArea; // ここにファイルの一覧を表示するよ！

    // コンストラクタ
    public FilesDropTest() {
        super("テストだっち ∩( ・ω・)∩");

        textArea = new JTextArea();
        JScrollPane scroll = new JScrollPane(textArea);
        this.add(scroll);

        dropTarget = new DropTarget(textArea, this);

    }
    
    // DropTargetListener の各メソッドのオーバーライド
    @Override
    public void dragEnter(DropTargetDragEvent dtde) {}

    @Override
    public void dragOver(DropTargetDragEvent dtde) {}

    @Override
    public void dropActionChanged(DropTargetDragEvent dtde) {}

    @Override
    public void dragExit(DropTargetEvent dte) {}

    @Override
    public void drop(DropTargetDropEvent dtde) {
        dtde.acceptDrop(DnDConstants.ACTION_COPY_OR_MOVE);
        Transferable trans = dtde.getTransferable();

        List<File> fileList = null;

        if(trans.isDataFlavorSupported(DataFlavor.javaFileListFlavor)) {
            try {
                fileList = (List<File>) trans.getTransferData(DataFlavor.javaFileListFlavor);
            } catch (UnsupportedFlavorException ex) {
                /* 例外処理 */
            } catch (IOException ex) {
                /* 例外処理 */
            }
        }

        /* ここの時点で、fileList にはドロップされたファイルのリストが入ってるよ！ */
        /* 煮るなり焼くなりできるね */
        if(fileList == null) return;
        for(File f : fileList)
            textArea.append(f.getAbsolutePath() + "\n");
    }
}

たったこれだけで、ドラッグ & ドロップによるファイルのインポートがサポートできた。

うれしい。