javax.swing
public class TransferHandler extends Object implements Serializable
Field Summary | |
---|---|
static int | COPY |
static int | COPY_OR_MOVE |
static int | MOVE |
static int | NONE |
Constructor Summary | |
---|---|
protected | TransferHandler() |
TransferHandler(String property) |
Method Summary | |
---|---|
boolean | canImport(JComponent c, DataFlavor[] flavors)
Returns true if the data in this TransferHandler can be
imported into the specified component. |
protected Transferable | createTransferable(JComponent c)
Creates a {@link Transferable} that can be used to export data
from the specified component.
|
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.
|
void | exportToClipboard(JComponent c, Clipboard clip, int action)
Exports the property of the component c that was
specified for this TransferHandler to the clipboard, performing
the specified action.
|
static Action | getCopyAction() |
static Action | getCutAction() |
static Action | getPasteAction() |
int | getSourceActions(JComponent c) |
Icon | getVisualRepresentation(Transferable t) |
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. |
true
if the data in this TransferHandler can be
imported into the specified component. This will be the case when:
application/x-java-jvm-local-object-ref
.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
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 {@link 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
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
c
that was
specified for this TransferHandler to the clipboard, performing
the specified action.
This will check if the action is allowed by calling
{@link #getSourceActions(JComponent)}. If the action is not allowed,
then no export is performed.
In either case the method {@link #exportDone} will be called with
the action that has been performed, or {@link #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
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