Class mxGraphTransferHandler

java.lang.Object

javax.swing.TransferHandler

com.mxgraph.swing.handler.mxGraphTransferHandler

All Implemented Interfaces:

Serializable

public class mxGraphTransferHandler
extends TransferHandler

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class TransferHandler

TransferHandler.DropLocation, TransferHandler.TransferSupport

Field Summary

Fields

Modifier and Type	Field	Description
static Color	DEFAULT_BACKGROUNDCOLOR	Specifies the background color of the transfer image.
static boolean	DEFAULT_TRANSFER_IMAGE_ENABLED	Boolean that specifies if an image of the cells should be created for each transferable.
protected int	importCount	Counter for the last imported cell array.
protected int	initialImportCount	Sets the value for the initialImportCount.
protected Transferable	lastImported	Reference to the last imported cell array.
protected Point	location
protected Point	offset
protected Object[]	originalCells	Reference to the original cells for removal after a move.
protected Color	transferImageBackground	Specifies the background color for the transfer image.
protected boolean	transferImageEnabled	Specifies if a transfer image should be created for the transferable.

Fields inherited from class TransferHandler

COPY, COPY_OR_MOVE, LINK, MOVE, NONE

Constructor Summary

Constructors

Constructor	Description
mxGraphTransferHandler()

Method Summary

Modifier and Type	Method	Description
boolean	canImport(JComponent comp, DataFlavor[] flavors)
mxGraphTransferable	createGraphTransferable(mxGraphComponent graphComponent, Object[] cells, mxRectangle bounds, ImageIcon icon)
mxGraphTransferable	createGraphTransferable(mxGraphComponent graphComponent, Object[] cells, ImageIcon icon)
Transferable	createTransferable(JComponent c)	(non-Javadoc)
ImageIcon	createTransferableImage(mxGraphComponent graphComponent, Object[] cells)
void	exportDone(JComponent c, Transferable data, int action)
protected Object	getDropTarget(mxGraphComponent graphComponent, mxGraphTransferable gt)	Returns the drop target for the given transferable and location.
int	getImportCount()
int	getSourceActions(JComponent c)
Color	getTransferImageBackground()
protected Object[]	importCells(mxGraphComponent graphComponent, mxGraphTransferable gt, double dx, double dy)	Gets a drop target using getDropTarget and imports the cells using mxGraph.splitEdge or mxGraphComponent.importCells depending on the drop target and the return values of mxGraph.isSplitEnabled and mxGraph.isSplitTarget.
boolean	importData(JComponent c, Transferable t)	Checks if the mxGraphTransferable data flavour is supported and calls importGraphTransferable if possible.
protected boolean	importGraphTransferable(mxGraphComponent graphComponent, mxGraphTransferable gt)	Returns true if the cells have been imported using importCells.
boolean	isLocalDrag()	Returns true if the DnD operation started from this handler.
boolean	isTransferImageEnabled()
protected void	removeCells(mxGraphComponent graphComponent, Object[] cells)
void	setImportCount(int value)
void	setLocation(Point value)
void	setOffset(Point value)
void	setTransferImageBackground(Color transferImageBackground)
void	setTransferImageEnabled(boolean transferImageEnabled)
protected void	updateImportCount(Transferable t)	Counts the number of times that the given transferable has been imported.

Methods inherited from class TransferHandler

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

Methods inherited from class Object

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

Field Details

DEFAULT_TRANSFER_IMAGE_ENABLED

public static boolean DEFAULT_TRANSFER_IMAGE_ENABLED

Boolean that specifies if an image of the cells should be created for each transferable. Default is true.

DEFAULT_BACKGROUNDCOLOR

public static Color DEFAULT_BACKGROUNDCOLOR

Specifies the background color of the transfer image. If no color is given here then the background color of the enclosing graph component is used. Default is Color.WHITE.

originalCells

protected Object[] originalCells

Reference to the original cells for removal after a move.

lastImported

protected Transferable lastImported

Reference to the last imported cell array.

initialImportCount

protected int initialImportCount

Sets the value for the initialImportCount. Default is 1. Updated in exportDone to contain 0 after a cut and 1 after a copy.

importCount

protected int importCount

Counter for the last imported cell array.

transferImageEnabled

protected boolean transferImageEnabled

Specifies if a transfer image should be created for the transferable. Default is DEFAULT_TRANSFER_IMAGE.

transferImageBackground

protected Color transferImageBackground

Specifies the background color for the transfer image. Default is DEFAULT_BACKGROUNDCOLOR.

location

protected Point location

offset

protected Point offset

Constructor Details

mxGraphTransferHandler

public mxGraphTransferHandler()

Method Details

getImportCount

public int getImportCount()

setImportCount

public void setImportCount(int value)

setTransferImageEnabled

public void setTransferImageEnabled(boolean transferImageEnabled)

isTransferImageEnabled

public boolean isTransferImageEnabled()

setTransferImageBackground

public void setTransferImageBackground(Color transferImageBackground)

getTransferImageBackground

public Color getTransferImageBackground()

isLocalDrag

public boolean isLocalDrag()

Returns true if the DnD operation started from this handler.

setLocation

public void setLocation(Point value)

setOffset

public void setOffset(Point value)

canImport

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

Overrides:

canImport in class TransferHandler

createTransferable

public Transferable createTransferable(JComponent c)

(non-Javadoc)

Overrides:

createTransferable in class TransferHandler

See Also:

• TransferHandler.createTransferable(javax.swing.JComponent)

createGraphTransferable

public mxGraphTransferable createGraphTransferable(mxGraphComponent graphComponent,
 Object[] cells,
 ImageIcon icon)

createGraphTransferable

public mxGraphTransferable createGraphTransferable(mxGraphComponent graphComponent,
 Object[] cells,
 mxRectangle bounds,
 ImageIcon icon)

createTransferableImage

public ImageIcon createTransferableImage(mxGraphComponent graphComponent,
 Object[] cells)

exportDone

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

Overrides:

exportDone in class TransferHandler

removeCells

protected void removeCells(mxGraphComponent graphComponent,
 Object[] cells)

getSourceActions

public int getSourceActions(JComponent c)

Overrides:

getSourceActions in class TransferHandler

importData

public boolean importData(JComponent c,
 Transferable t)

Checks if the mxGraphTransferable data flavour is supported and calls importGraphTransferable if possible.

Overrides:

importData in class TransferHandler

updateImportCount

protected void updateImportCount(Transferable t)

Counts the number of times that the given transferable has been imported.

importGraphTransferable

protected boolean importGraphTransferable(mxGraphComponent graphComponent,
 mxGraphTransferable gt)

Returns true if the cells have been imported using importCells.

getDropTarget

protected Object getDropTarget(mxGraphComponent graphComponent,
 mxGraphTransferable gt)

Returns the drop target for the given transferable and location.

importCells

protected Object[] importCells(mxGraphComponent graphComponent,
 mxGraphTransferable gt,
 double dx,
 double dy)

Gets a drop target using getDropTarget and imports the cells using mxGraph.splitEdge or mxGraphComponent.importCells depending on the drop target and the return values of mxGraph.isSplitEnabled and mxGraph.isSplitTarget. Selects and returns the cells that have been imported.