com.yworks.yfiles.graph

Interface IClipboardHelper

public interface IClipboardHelper

This interface can be used to customize the clipboard behavior for individual IModelItems.

Implementations of this interface can decorate the ILookup.lookup(java.lang.Class) method of IModelItems to change their behavior during clipboard actions.

The easiest way to decorate certain model items with a custom IClipboardHelper implementation is via the various decorators available on GraphDecorator:

Method Summary

Modifier and Type	Method and Description
Object	copy(IGraphClipboardContext context, IModelItem item) This method is called during the copy operation of the given item to retrieve additional state that can be later used during a paste(IGraphClipboardContext, IModelItem, Object) operation.
Object	cut(IGraphClipboardContext context, IModelItem item) This method is called during the cut operation of the given item to retrieve additional state that can be later used during a paste(IGraphClipboardContext, IModelItem, Object) operation.
void	paste(IGraphClipboardContext context, IModelItem item, Object userData) This method is called after the item has been pasted from the clipboard.
boolean	shouldCopy(IGraphClipboardContext context, IModelItem item) Determines whether the given item can or should be copied to the clipboard.
boolean	shouldCut(IGraphClipboardContext context, IModelItem item) Determines whether the given item can or should be cut to the clipboard.
boolean	shouldPaste(IGraphClipboardContext context, IModelItem item, Object userData) Determines whether the given item can or should be pasted from the clipboard to the target graph.

Method Detail

copy

Object copy(IGraphClipboardContext context,
            IModelItem item)

This method is called during the copy operation of the given item to retrieve additional state that can be later used during a paste(IGraphClipboardContext, IModelItem, Object) operation.

If the source graph is a managed folding view, the item is always a master item.

Parameters:

context - The context in which this interface is used, can be null

item - The item to copy to the clipboard.

Returns:

A custom user object that will later be provided to paste(IGraphClipboardContext, IModelItem, Object).

cut

Object cut(IGraphClipboardContext context,
           IModelItem item)

This method is called during the cut operation of the given item to retrieve additional state that can be later used during a paste(IGraphClipboardContext, IModelItem, Object) operation.

If the source graph is a managed folding view, the item is always a master item.

Parameters:

context - The context in which this interface is used, can be null

item - The item to cut to the clipboard.

Returns:

A custom user object that will later be provided to paste(IGraphClipboardContext, IModelItem, Object).

paste

void paste(IGraphClipboardContext context,
           IModelItem item,
           Object userData)

This method is called after the item has been pasted from the clipboard.

The item is always a master item since the clipboard graph is not a managed folding view.

Parameters:

context - The context in which this interface is used, can be null

item - The item that has been created during the paste operation.

userData - The data that had been queried during cut(IGraphClipboardContext, IModelItem) or copy(IGraphClipboardContext, IModelItem) respectively.

shouldCopy

boolean shouldCopy(IGraphClipboardContext context,
                   IModelItem item)

Determines whether the given item can or should be copied to the clipboard.

If the source graph is a managed folding view, the item is always a view item. Furthermore, if collapsed nodes are to be copied, this method will be queried with the collapsed group node as item for each "hidden" node that is currently not visible.

Parameters:

context - The context in which this interface is used, can be null

item - The item in question.

Returns:

Whether this item should be copied.

shouldCut

boolean shouldCut(IGraphClipboardContext context,
                  IModelItem item)

Determines whether the given item can or should be cut to the clipboard.

If the source graph is a managed folding view, the item is always a view item. Furthermore, if collapsed nodes are to be cut, this method will be queried with the collapsed group node as item for each "hidden" node that is currently not visible.

Parameters:

context - The context in which this interface is used, can be null

item - The item in question.

Returns:

Whether this item should be cut.

shouldPaste

boolean shouldPaste(IGraphClipboardContext context,
                    IModelItem item,
                    Object userData)

Determines whether the given item can or should be pasted from the clipboard to the target graph.

The item is always a master item since the clipboard graph is not a managed folding view.

Parameters:

context - The context in which this interface is used, can be null

item - The item in the clipboard graph.

userData - The state memento that had been created during cut(IGraphClipboardContext, IModelItem) or copy(IGraphClipboardContext, IModelItem).

Returns:

Whether this item should be pasted.