com.alee.extended.tree

Interface TreeDropHandler<N extends UniqueNode,T extends WebTree<N>,M extends WebTreeModel<N>>

Type Parameters:

N - nodes type

T - tree type

M - tree model type

All Known Implementing Classes:

NodesDropHandler

public interface TreeDropHandler<N extends UniqueNode,T extends WebTree<N>,M extends WebTreeModel<N>>

Base for any tree drop operation handler.

Author:

Mikle Garin

See Also:

AbstractTreeTransferHandler.getDropHandler(javax.swing.TransferHandler.TransferSupport, com.alee.laf.tree.WebTree, com.alee.laf.tree.WebTreeModel, com.alee.laf.tree.UniqueNode)

Method Summary

Modifier and Type	Method and Description
boolean	canDrop(TransferHandler.TransferSupport support, T tree, M model, N destination) Returns whether or not drop operation can be performed on the specified destination node.
List<DataFlavor>	getSupportedFlavors() Returns list of data flavors supported by this drop handler.
void	performDrop(TransferHandler.TransferSupport support, T tree, M model, N destination, int index, NodesDropCallback<N> callback) Performs nodes drop operations.
boolean	prepareDrop(TransferHandler.TransferSupport support, T tree, M model, N destination, int index) Returns whether or not drop operation can be performed on the specified destination node.

Method Detail

getSupportedFlavors

@NotNull
List<DataFlavor> getSupportedFlavors()

Returns list of data flavors supported by this drop handler. These will be used to filter out drop handlers for each specific drop operation.

Returns:

list of data flavors supported by this drop handler

canDrop

boolean canDrop(@NotNull
                TransferHandler.TransferSupport support,
                @NotNull
                T tree,
                @NotNull
                M model,
                @NotNull
                N destination)

Returns whether or not drop operation can be performed on the specified destination node. Be aware that this method is called multiple times while drag operation is performed. Avoid performing any heavy operations here as they will be called multiple times as well.

Parameters:

support - transfer support data

tree - destination tree

model - tree model

destination - drop destination node

Returns:

true if drop operation can be performed on the specified destination node, false otherwise

prepareDrop

boolean prepareDrop(@NotNull
                    TransferHandler.TransferSupport support,
                    @NotNull
                    T tree,
                    @NotNull
                    M model,
                    @NotNull
                    N destination,
                    int index)

Returns whether or not drop operation can be performed on the specified destination node. This method is called only once just before the drop operation gets completed and you can still cancel drop from here. You can also perform any heavy synchronous checks here as this method is called only once.

Parameters:

support - transfer support data

tree - destination tree

model - tree model

destination - drop destination node

index - nodes drop index

Returns:

true if drop operation can be performed on the specified destination node, false otherwise

performDrop

void performDrop(@NotNull
                 TransferHandler.TransferSupport support,
                 @NotNull
                 T tree,
                 @NotNull
                 M model,
                 @NotNull
                 N destination,
                 int index,
                 @NotNull
                 NodesDropCallback<N> callback)

Performs nodes drop operations. Those might be either extracted from or created based on transferred data. This method basically maps any kind of transferred data into tree nodes.

Parameters:

support - transfer support data

tree - destination tree

model - tree model

destination - drop destination node

index - nodes drop index

callback - operation callback