com.alee.managers.drag.transfer

Class ImageTransferHandler

java.lang.Object

javax.swing.TransferHandler

com.alee.managers.drag.transfer.AbstractTransferHandler

com.alee.managers.drag.transfer.FilesTransferHandler

com.alee.managers.drag.transfer.ImageTransferHandler

All Implemented Interfaces:

Serializable

public class ImageTransferHandler
extends FilesTransferHandler

Custom TransferHandler that provides easy and convenient way to support images drag and drop in any Swing component. It is based on FilesTransferHandler and only adds an additional supported flavor.

Author:

Mikle Garin

See Also:

How to use DragManager, DragManager, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.TransferHandler

TransferHandler.DropLocation, TransferHandler.TransferSupport

Field Summary

Fields inherited from class com.alee.managers.drag.transfer.AbstractTransferHandler

dragEnabled, dropEnabled, sourceAction

Fields inherited from class javax.swing.TransferHandler

COPY, COPY_OR_MOVE, LINK, MOVE, NONE

Constructor Summary

Constructors

Constructor and Description
ImageTransferHandler(boolean dragEnabled, boolean dropEnabled) Constructs new ImageTransferHandler.

Method Summary

Modifier and Type	Method and Description
boolean	canImport(TransferHandler.TransferSupport support)
protected Transferable	createTransferable(JComponent component)
Image	getDraggedImage() Informs that drag action has started and dragged image should be provided.
protected boolean	imagesImported(List<ImageIcon> images) Informs that specified images were dropped.
boolean	importData(TransferHandler.TransferSupport info)

Methods inherited from class com.alee.managers.drag.transfer.FilesTransferHandler

filesDropped, getDraggedFile, getDraggedFiles

Methods inherited from class com.alee.managers.drag.transfer.AbstractTransferHandler

getSourceActions, isDragEnabled, isDropEnabled, setDragEnabled, setDropEnabled, setSourceAction

Methods inherited from class javax.swing.TransferHandler

canImport, exportAsDrag, exportDone, exportToClipboard, getCopyAction, getCutAction, getDragImage, getDragImageOffset, getPasteAction, getVisualRepresentation, importData, setDragImage, setDragImageOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageTransferHandler

public ImageTransferHandler(boolean dragEnabled,
                            boolean dropEnabled)

Constructs new ImageTransferHandler.

Parameters:

dragEnabled - whether drag operations are allowed

dropEnabled - whether drop operations are allowed

Method Detail

createTransferable

@Nullable
protected Transferable createTransferable(@NotNull
                                                    JComponent component)

Overrides:

createTransferable in class FilesTransferHandler

getDraggedImage

@Nullable
public Image getDraggedImage()

Informs that drag action has started and dragged image should be provided. You can override this method to provide custom dragged image.

Returns:

dragged image

canImport

public boolean canImport(@NotNull
                         TransferHandler.TransferSupport support)

Overrides:

canImport in class FilesTransferHandler

importData

public boolean importData(@NotNull
                          TransferHandler.TransferSupport info)

Overrides:

importData in class FilesTransferHandler

imagesImported

protected boolean imagesImported(@NotNull
                                 List<ImageIcon> images)

Informs that specified images were dropped. You can override this method to perform desired actions.

Parameters:

images - list of dropped images

Returns:

true if drop was successfully completed, false otherwise