com.yworks.yfiles.graph

Interface IClipboardIdProvider

public interface IClipboardIdProvider

Used by the GraphClipboard to assign IDs for elements in the clipboard.

IDs are created when items are copied (or cut) into the clipboard and queried when the items are pasted from the clipboard.
Providing a custom ID provider allows for identifying conceptually identical items across different graph instances.
The default implementation uses the IModelItem object reference as the ID.

Method Summary

Modifier and Type	Method and Description
Object	getId(IGraphClipboardContext context, IModelItem originalItem) Gets the ID for the given originalItem.
IModelItem	getItem(IGraphClipboardContext context, Object id) Gets the item which is represented by the given id.

Method Detail

getId

Object getId(IGraphClipboardContext context,
             IModelItem originalItem)

Gets the ID for the given originalItem.

Parameters:

context - The clipboard context

originalItem - The original item which is copied. The item is part of the original graph from which the item is copied.

Returns:

An ID for the given item. The object should be suitable for use in a HashMap.

getItem

IModelItem getItem(IGraphClipboardContext context,
                   Object id)

Gets the item which is represented by the given id.

Parameters:

context - The clipboard context.

id - The ID to get the item for.

Returns:

The item which is represented by the given ID or null if the item cannot be located or is invalid. The item needs to be part of the target graph for paste operations.