com.alee.extended.tree

Class AbstractTreeTransferHandler<N extends UniqueNode,T extends WebTree<N>,M extends WebTreeModel<N>>

java.lang.Object

javax.swing.TransferHandler

com.alee.extended.tree.AbstractTreeTransferHandler<N,T,M>

Type Parameters:

N - nodes type

T - tree type

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AsyncTreeTransferHandler, ExTreeTransferHandler

public abstract class AbstractTreeTransferHandler<N extends UniqueNode,T extends WebTree<N>,M extends WebTreeModel<N>>
extends javax.swing.TransferHandler

Most common transfer handler implementation that handles tree nodes transfer.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.TransferHandler.DropLocation, javax.swing.TransferHandler.TransferSupport

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.Integer>>	draggedNodeIndices Map of node indices lists under their parent node IDs.
protected java.util.List<N>	draggedNodes Array of dragged nodes.
protected java.util.List<TreeDropHandler<N,T>>	dropHandlers Transferred data handlers.
protected boolean	expandMultiplyNodes Whether or not should expand multiply dragged nodes when they are dropped onto the tree.
protected boolean	expandSingleNode Whether or not should expand single dragged node when it is dropped onto the tree.
protected boolean	optimizeDraggedNodes Whether or not should optimize dragged nodes list to minimum.

Fields inherited from class javax.swing.TransferHandler

COPY, COPY_OR_MOVE, LINK, MOVE, NONE

Constructor Summary

Constructors

Constructor and Description
AbstractTreeTransferHandler() Constructs new tree transfer handler.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canBeDragged(T tree, java.util.List<N> nodes) Returns whether the specified nodes drag can be started or not.
protected boolean	canDropTo(T tree, N destination) Returns whether or not specified destination is acceptable for drop.
boolean	canImport(javax.swing.TransferHandler.TransferSupport support)
protected abstract N	copy(T tree, N node) Returns node copy used in createTransferable.
protected java.util.List<TreeDropHandler<N,T>>	createDropHandlers() Returns supported drop handlers.
protected java.awt.datatransfer.Transferable	createTransferable(javax.swing.JComponent c) Creates a Transferable to use as the source for a data transfer.
protected java.awt.datatransfer.Transferable	createTransferable(T tree, java.util.List<N> nodes) Returns new transferable based on dragged nodes.
protected void	exportDone(javax.swing.JComponent source, java.awt.datatransfer.Transferable data, int action) Invoked after data has been exported.
protected <O> java.util.List<O>	extract(java.util.List<N> nodes) Returns user objects extracted from specified nodes.
protected int	getAdjustedDropIndex(int dropIndex, int dropAction, N parent) Returns properly adjusted nodes drop index.
int	getSourceActions(javax.swing.JComponent c) Returns the type of transfer actions supported by the source.
protected java.util.List<TreeDropHandler<N,T>>	getSupportedDropHandlers(javax.swing.TransferHandler.TransferSupport support) Returns list of drop handlers supporting this drop operation.
boolean	importData(javax.swing.TransferHandler.TransferSupport support)
protected void	informNodesDropped(T tree, java.util.List<N> nodes, N parent, M model, int index) Informing about nodes drop operation.
protected boolean	isCopyAction(int action) Returns whether action is COPY or not.
boolean	isExpandMultiplyNodes() Returns whether or not should expand multiply dragged nodes when they are dropped onto the tree.
boolean	isExpandSingleNode() Returns whether should expand single dragged node when it is dropped onto the tree or not.
protected boolean	isMoveAction(int action) Returns whether action is MOVE or not.
boolean	isOptimizeDraggedNodes() Return whether or not should optimize dragged nodes list to minimum.
void	nodesDropped(java.util.List<N> nodes, N parent, T tree, M model, int index) Informs about nodes drop operation completition in a separate tree thread.
protected boolean	performDropOperation(T tree, java.util.List<N> nodes, N parent, M model, int index) Performs actual nodes drop operation.
protected boolean	prepareDropOperation(javax.swing.TransferHandler.TransferSupport support, T tree, java.util.List<N> nodes, int dropIndex, N parent, M model) Performs all preparations required to perform drop operation and calls for actual drop when ready.
protected void	removeTreeNodes(T tree, java.util.List<N> nodesToRemove) Asks tree to remove nodes after drag move operation has completed.
void	setExpandMultiplyNodes(boolean expand) Sets whether or not should expand multiply dragged nodes when they are dropped onto the tree.
void	setExpandSingleNode(boolean expand) Sets whether should expand single dragged node when it is dropped onto the tree or not.
void	setOptimizeDraggedNodes(boolean optimize) Sets whether or not should optimize dragged nodes list to minimum.
java.lang.String	toString()

Methods inherited from class javax.swing.TransferHandler

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

Methods inherited from class java.lang.Object

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

Field Detail

optimizeDraggedNodes

protected boolean optimizeDraggedNodes

Whether or not should optimize dragged nodes list to minimum.

expandSingleNode

protected boolean expandSingleNode

Whether or not should expand single dragged node when it is dropped onto the tree.

expandMultiplyNodes

protected boolean expandMultiplyNodes

Whether or not should expand multiply dragged nodes when they are dropped onto the tree.

dropHandlers

protected java.util.List<TreeDropHandler<N extends UniqueNode,T extends WebTree<N>>> dropHandlers

Transferred data handlers.

draggedNodes

protected java.util.List<N extends UniqueNode> draggedNodes

Array of dragged nodes.

draggedNodeIndices

protected java.util.Map<java.lang.String,java.util.List<java.lang.Integer>> draggedNodeIndices

Map of node indices lists under their parent node IDs. This map is used to properly adjust drop index in the destination node if D&D performed within one tree.

Constructor Detail

AbstractTreeTransferHandler

public AbstractTreeTransferHandler()

Constructs new tree transfer handler.

Method Detail

createDropHandlers

protected java.util.List<TreeDropHandler<N,T>> createDropHandlers()

Returns supported drop handlers. These handlers are requested only once on transfer handler initialization. They will be used to check and process drop operations on the tree that uses this transfer handler.

Returns:

supported drop handlers

isOptimizeDraggedNodes

public boolean isOptimizeDraggedNodes()

Return whether or not should optimize dragged nodes list to minimum.

Returns:

true if should optimize dragged nodes list to minimum, false otherwise

setOptimizeDraggedNodes

public void setOptimizeDraggedNodes(boolean optimize)

Sets whether or not should optimize dragged nodes list to minimum.

Parameters:

optimize - whether or not should optimize dragged nodes list to minimum

isExpandSingleNode

public boolean isExpandSingleNode()

Returns whether should expand single dragged node when it is dropped onto the tree or not.

Returns:

true if should expand single dragged node when it is dropped onto the tree, false otherwise

setExpandSingleNode

public void setExpandSingleNode(boolean expand)

Sets whether should expand single dragged node when it is dropped onto the tree or not.

Parameters:

expand - whether should expand single dragged node when it is dropped onto the tree or not

isExpandMultiplyNodes

public boolean isExpandMultiplyNodes()

Returns whether or not should expand multiply dragged nodes when they are dropped onto the tree.

Returns:

true if should expand multiply dragged nodes when they are dropped onto the tree, false otherwise

setExpandMultiplyNodes

public void setExpandMultiplyNodes(boolean expand)

Sets whether or not should expand multiply dragged nodes when they are dropped onto the tree.

Parameters:

expand - whether or not should expand multiply dragged nodes when they are dropped onto the tree

getSourceActions

public int getSourceActions(javax.swing.JComponent c)

Returns the type of transfer actions supported by the source. Any bitwise-OR combination of COPY, MOVE and LINK. Returning NONE disables transfers from the component.

Overrides:

getSourceActions in class javax.swing.TransferHandler

Parameters:

c - the component holding the data to be transferred

Returns:

type of transfer actions supported by the source

createTransferable

protected java.awt.datatransfer.Transferable createTransferable(javax.swing.JComponent c)

Creates a Transferable to use as the source for a data transfer. Returns the representation of the data to be transferred, or null if the component's property is null

Overrides:

createTransferable in class javax.swing.TransferHandler

Parameters:

c - the component holding the data to be transferred, provided to enable sharing of TransferHandlers

Returns:

the representation of the data to be transferred, or null if the property associated with component is null

canBeDragged

protected abstract boolean canBeDragged(T tree,
                                        java.util.List<N> nodes)

Returns whether the specified nodes drag can be started or not.

Parameters:

tree - source tree

nodes - nodes to drag

Returns:

true if the specified nodes drag can be started, false otherwise

copy

protected abstract N copy(T tree,
                          N node)

Returns node copy used in createTransferable. Used each time when node is moved within tree or into another tree. Node copy should have the same ID and content but must be another instance of node type class.

Parameters:

tree - source tree

node - node to copy

Returns:

node copy

createTransferable

protected java.awt.datatransfer.Transferable createTransferable(T tree,
                                                                java.util.List<N> nodes)

Returns new transferable based on dragged nodes.

Parameters:

tree - source tree

nodes - dragged nodes

Returns:

new transferable based on dragged nodes

canImport

public boolean canImport(javax.swing.TransferHandler.TransferSupport support)

Overrides:

canImport in class javax.swing.TransferHandler

getSupportedDropHandlers

protected java.util.List<TreeDropHandler<N,T>> getSupportedDropHandlers(javax.swing.TransferHandler.TransferSupport support)

Returns list of drop handlers supporting this drop operation.

Parameters:

support - transfer support data

Returns:

list of drop handlers supporting this drop operation

canDropTo

protected boolean canDropTo(T tree,
                            N destination)

Returns whether or not specified destination is acceptable for drop. This check is performed before another check for nodes drop possibility.

Parameters:

tree - destination tree

destination - node onto which drop was performed

Returns:

true if the specified destination is acceptable for drop, false otherwise

importData

public boolean importData(javax.swing.TransferHandler.TransferSupport support)

Overrides:

importData in class javax.swing.TransferHandler

prepareDropOperation

protected boolean prepareDropOperation(javax.swing.TransferHandler.TransferSupport support,
                                       T tree,
                                       java.util.List<N> nodes,
                                       int dropIndex,
                                       N parent,
                                       M model)

Performs all preparations required to perform drop operation and calls for actual drop when ready.

Parameters:

support - transfer support data

tree - tree to drop nodes onto

nodes - list of nodes to drop

dropIndex - preliminary nodes drop index

parent - parent node to drop nodes into

model - tree model

Returns:

true if drop operation was successfully completed, false otherwise

performDropOperation

protected boolean performDropOperation(T tree,
                                       java.util.List<N> nodes,
                                       N parent,
                                       M model,
                                       int index)

Performs actual nodes drop operation.

Parameters:

tree - tree to drop nodes onto

nodes - list of nodes to drop

parent - parent node to drop nodes into

model - tree model

index - nodes drop index

Returns:

true if drop operation was successfully completed, false otherwise

informNodesDropped

protected void informNodesDropped(T tree,
                                  java.util.List<N> nodes,
                                  N parent,
                                  M model,
                                  int index)

Informing about nodes drop operation. This method is separate to allowmodifying logic of this specific call.

Parameters:

tree - tree nodes were dropped onto

nodes - list of dropped nodes

parent - parent where nodes were dropped

model - tree model

index - nodes drop index

nodesDropped

public void nodesDropped(java.util.List<N> nodes,
                         N parent,
                         T tree,
                         M model,
                         int index)

Informs about nodes drop operation completition in a separate tree thread. This method should be used to perform actual data move operation.

Parameters:

nodes - list of nodes to drop

parent - parent node to drop nodes into

tree - tree to drop nodes onto

model - tree model

index - nodes drop index

getAdjustedDropIndex

protected int getAdjustedDropIndex(int dropIndex,
                                   int dropAction,
                                   N parent)

Returns properly adjusted nodes drop index.

Parameters:

dropIndex - drop index if dropped between nodes under dropLocation node or -1 if dropped directly onto dropLocation node

dropAction - actual drop action

parent - parent node to drop nodes into @return properly adjusted nodes drop index

Returns:

properly adjusted nodes drop index

exportDone

protected void exportDone(javax.swing.JComponent source,
                          java.awt.datatransfer.Transferable data,
                          int action)

Invoked after data has been exported. This method should remove the data that was transferred if the action was MOVE. This method is invoked from EDT so it is safe to perform tree operations.

Overrides:

exportDone in class javax.swing.TransferHandler

Parameters:

source - the component that was the source of the data

data - the data that was transferred or possibly null if the action is NONE

action - the actual action that was performed

removeTreeNodes

protected void removeTreeNodes(T tree,
                               java.util.List<N> nodesToRemove)

Asks tree to remove nodes after drag move operation has completed.

Parameters:

tree - tree to remove nodes from

nodesToRemove - nodes that should be removed

extract

protected <O> java.util.List<O> extract(java.util.List<N> nodes)

Returns user objects extracted from specified nodes.

Type Parameters:

O - user object type

Parameters:

nodes - list of nodes to extract user objects from

Returns:

user objects extracted from specified nodes

isMoveAction

protected boolean isMoveAction(int action)

Returns whether action is MOVE or not.

Parameters:

action - drag action

Returns:

true if action is MOVE, false otherwise

isCopyAction

protected boolean isCopyAction(int action)

Returns whether action is COPY or not.

Parameters:

action - drag action

Returns:

true if action is COPY, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object