Class TransferHandler

public static final int COPY

Field Value:

1

public static final int COPY_OR_MOVE

Field Value:

3

public static final int MOVE

Field Value:

2

public static final int NONE

Field Value:

0

protected TransferHandler()

public TransferHandler(String property)

public boolean canImport(JComponent c,
                         DataFlavor[] flavors)

Returns true if the data in this TransferHandler can be imported into the specified component. This will be the case when:

• The component has a readable and writable property with the property name specified in the TransferHandler constructor.
• There is a dataflavor with a mime type of application/x-java-jvm-local-object-ref.
• The dataflavor's representation class matches the class of the property in the component.

Parameters:

c - the component to check

flavors - the possible data flavors

Returns:

true if the data in this TransferHandler can be imported into the specified component, false otherwise

protected Transferable createTransferable(JComponent c)

Creates a Transferable that can be used to export data from the specified component. This method returns null when the specified component doesn't have a readable property that matches the property name specified in the TransferHandler constructor.

Parameters:

c - the component to create a transferable for

Returns:

a Transferable that can be used to export data from the specified component, or null if the component doesn't have a readable property like the transfer handler

public void exportAsDrag(JComponent c,
                         InputEvent e,
                         int action)

protected void exportDone(JComponent c,
                          Transferable data,
                          int action)

This method is invoked after data has been exported. Subclasses should implement this method to remove the data that has been transferred when the action was MOVE. The default implementation does nothing because MOVE is not supported.

Parameters:

c - the source component

data - the data that has been transferred or null when the action is NONE

action - the action that has been performed

public void exportToClipboard(JComponent c,
                              Clipboard clip,
                              int action)
            throws IllegalStateException

Exports the property of the component c that was specified for this TransferHandler to the clipboard, performing the specified action. This will check if the action is allowed by calling getSourceActions(JComponent). If the action is not allowed, then no export is performed. In either case the method exportDone(JComponent,Transferable,int) will be called with the action that has been performed, or NONE if the action was not allowed or could otherwise not be completed. Any IllegalStateException that is thrown by the Clipboard due to beeing unavailable will be propagated through this method.

Parameters:

c - the component from which to export

clip - the clipboard to which the data will be exported

action - the action to perform

Throws:

IllegalStateException - when the clipboard is not available

public static Action getCopyAction()

public static Action getCutAction()

public static Action getPasteAction()

public int getSourceActions(JComponent c)

public Icon getVisualRepresentation(Transferable t)

public boolean importData(JComponent c,
                          Transferable t)

Imports the transfer data represented by t into the specified component c by setting the property of this TransferHandler on that component. If this succeeds, this method returns true, otherwise false.

Parameters:

c - the component to import into

t - the transfer data to import

Returns:

true if the transfer succeeds, false otherwise