---
category: swing
folder: GhostDragImage
title: JListのTransferHandlerにドラッグイメージを設定する
tags: [JList, TransferHandler, DragAndDrop, BufferedImage]
author: aterai
pubdate: 2014-10-06T00:03:35+09:00
description: JListのアイテムをドラッグ中に表示するイメージをカスタマイズしてTransferHandlerに設定します。
image: https://lh4.googleusercontent.com/-lGkFK-bJoYE/VDEztZsJyOI/AAAAAAAACOg/Hs7B-dcJAkk/s800/GhostDragImage.png
hreflang:
    href: https://java-swing-tips.blogspot.com/2015/08/create-custom-drag-ghost-image.html
    lang: en
---
* 概要 [#summary]
`JList`のアイテムをドラッグ中に表示するイメージをカスタマイズして`TransferHandler`に設定します。

#download(https://lh4.googleusercontent.com/-lGkFK-bJoYE/VDEztZsJyOI/AAAAAAAACOg/Hs7B-dcJAkk/s800/GhostDragImage.png)

* サンプルコード [#sourcecode]
#code(link){{
class ListItemTransferHandler extends TransferHandler {
  @Override public int getSourceActions(JComponent c) {
    System.out.println("getSourceActions");
    if (!(c instanceof JList)) {
      return TransferHandler.NONE;
    }
    JList source = (JList) c;
    Point pt;
    if (compact) {
      int w = source.getFixedCellWidth();
      int h = source.getFixedCellHeight() - 20; //TODO
      int h = source.getFixedCellHeight() - 20; // TODO: 20 ???
      setDragImage(createCompactDragImage(source, w, h));
      pt = new Point(w / 2, h);
    } else {
      setDragImage(createDragImage(source));
      pt = c.getMousePosition();
    }
    if (pt != null) {
      setDragImageOffset(pt);
    }
    return TransferHandler.MOVE; //TransferHandler.COPY_OR_MOVE;
    return TransferHandler.MOVE; // TransferHandler.COPY_OR_MOVE;
  }

  private static BufferedImage createDragImage(JList source) {
    int w = source.getWidth();
    int h = source.getHeight();
    BufferedImage bi = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
    Graphics g = bi.getGraphics();
    DefaultListCellRenderer renderer =
      (DefaultListCellRenderer) source.getCellRenderer();
    for (int i : source.getSelectedIndices()) {
      Component c = renderer.getListCellRendererComponent(
          source, source.getModel().getElementAt(i), i, false, false);
      Rectangle rect = source.getCellBounds(i, i);
      SwingUtilities.paintComponent(g, c, source, rect);
    }
    g.dispose();
    return bi;
  }

  private BufferedImage createCompactDragImage(JList source, int w, int h) {
    BufferedImage br = null;
    if (w > 0 && h > 0) {
      br = source.getGraphicsConfiguration().createCompatibleImage(
          w, h, Transparency.TRANSLUCENT);
    } else {
      return null;
    }
    int[] selectedIndices = source.getSelectedIndices();
    int length = selectedIndices.length;
    Graphics g = br.getGraphics();
    DefaultListCellRenderer renderer =
      (DefaultListCellRenderer) source.getCellRenderer();
    int idx = selectedIndices[0];
    Object valueAt = source.getModel().getElementAt(idx);
    Component c = renderer.getListCellRendererComponent(
        source, valueAt, idx, false, false);
    Rectangle rect = source.getCellBounds(idx, idx);
    SwingUtilities.paintComponent(g, c, source, 0, 0, rect.width, rect.height);
    if (length > 1) {
      LABEL.setText(String.valueOf(length));
      Dimension d = LABEL.getPreferredSize();
      SwingUtilities.paintComponent(
          g, LABEL, source, (w - d.width) / 2, (h - d.height) / 2, d.width, d.height);
    }
    g.dispose();
    br.coerceData(true);
    return br;
  }
// ...
}}

* 解説 [#explanation]
- `CompactDragImageMode`: `false`
-- `JList`のサイズで`BufferedImage`を作成し、これに選択したリストアイテムのみドラッグイメージとして位置を変更せずに描画
-- オフセットは、`JList#getMousePosition()`メソッドで取得したドラッグ開始位置を設定
-- オフセットは`JList#getMousePosition()`メソッドで取得したドラッグ開始位置を設定
- `CompactDragImageMode`: `true`
-- 複数アイコンを選択してドラッグする場合のゴーストイメージをコンパクト化した独自画像に変更
-- `JList`のリストアイテムの固定サイズ(リストアイテム一個分)で`BufferedImage`を作成し、これに選択されたリストアイテムの最初のイメージと選択数を設定した`JLabel`を描画
-- オフセットは、作成したドラッグイメージの底辺中央付近を設定
-- オフセットは作成したドラッグイメージの底辺中央付近を設定

* 参考リンク [#reference]
- [[JListのアイテムをラバーバンドで複数選択、ドラッグ&ドロップで並べ替え>Swing/DragSelectDropReordering]]

* コメント [#comment]
#comment
#comment