ClipboardOperationContext

Show Usages

Context passed from the GraphClipboard to the ClipboardGraphCopier about the items to copy.

Inheritance Hierarchy

Remarks

This class cannot be instantiated

Members

No filters for this type

Properties

allMasterItems

: IEnumerable<IModelItem>

readonly

All items to be copied as master items.

Contains all items to be copied, their dependent items and items which are required to maintain the structural integrity of the clipboardGraph. If the sourceGraph is not a managed view these are normal graph elements.

readonlyfinal

allViewItems

: IEnumerable<IModelItem>

readonly

All items from the sourceGraph that should be copied.

If the sourceGraph is a managed view, these are view items. Contains the items that should be copied and items which depend on these.

readonlyfinal

allViewStateItems

: IEnumerable<IModelItem>

readonly

All items to be copied that cannot be represented as master items.

Contains all items to be copied that are not present in the master graph. Also contains their dependent items and items which are required to maintain the structural integrity of the clipboardGraph.

readonlyfinal

clipboard

: GraphClipboard

readonly

The GraphClipboard that created this instance.

readonlyfinal

sourceFoldingView

: IFoldingView

readonly

The IFoldingView of the sourceGraph.

null if the source graph is not a managed view.

readonlyfinal

sourceGraph

: IGraph

readonly

The graph to copy the items from.

If the actual source is folding-enabled, this is a masterGraph.

readonlyfinal

targetFoldingView

: IFoldingView

readonly

The IFoldingView of the targetGraph.

null if the target graph is not a managed view.

readonlyfinal

targetGraph

: IGraph

readonly

The graph to copy the items to.

If the actual target is folding-enabled, this is a masterGraph.

readonlyfinal

Methods

addMasterItem

(item: IModelItem, isHelper?: boolean): boolean

Adds an item to be copied.

final

Parameters

item: IModelItem: The item to be copied. If the sourceGraph is a managed view, this item has to be an item from the view's masterGraph.
isHelper?: boolean: Whether the item is only copied to maintain the structural integrity of the clipboardGraph.

Return Value

boolean: false if the item is already registered and therefore not added again.

addViewStateItem

(item: IModelItem, isHelper?: boolean): boolean

Adds an item without master representation to be copied.

final

Parameters

item: IModelItem: The item to be copied if the item is not represented by a master item. If the sourceGraph is not a managed view nothing should be added here.
isHelper?: boolean: Whether the item is only copied to maintain the structural integrity of the clipboardGraph.

Return Value

boolean: false if the item is already registered and therefore not added again.

getClipboardHelper

(item: IModelItem): IClipboardHelper

Gets the IClipboardHelper for the given item.

final

Parameters

item: IModelItem: The item to get the helper for.

Return Value

IClipboardHelper: The IClipboardHelper for the given item or null if none has been registered before.

getIndependentBends

(): IEnumerable<IBend>

Gets the bends whose owners are not copied.

Returns only bends which should be copied.

final

Return Value

IEnumerable<IBend>: All bends which should be copied but whose owners don't.

getIndependentLabels

(): IEnumerable<ILabel>

Gets the labels whose owners are not copied.

Returns only labels which should be copied.

final

Return Value

IEnumerable<ILabel>: All labels that should be copied but whose owners don't.

getIndependentPorts

(): IEnumerable<IPort>

Gets the ports whose owners are not copied.

Returns only ports which should be copied.

final

Return Value

IEnumerable<IPort>: All ports that should be copied but whose owners don't.

isHelper

(item: IModelItem): boolean

Returns whether the item is no item to copy or was only copied to the clipboardGraph as it is required to maintain its structural integrity.

final

Parameters

item: IModelItem: The item to check.

Return Value

boolean: Whether the item is only copied to clipboard for integrity.

isItemToCopy

(item: IModelItem): boolean

Whether the item should be copied by copy.

Returns true if the item should be copied, regardless of whether the item is represented as master item, without master representation, or only to maintain structural integrity.

final

Parameters

item: IModelItem: The item to query for.

Return Value

boolean: true if the item should be copied in a clipboard operation.

isMasterItemToCopy

(item: IModelItem): boolean

Whether the item was added as master item and should be copied by copy.

Returns true if the item should be copied as master item.

final

Parameters

item: IModelItem: The item to query for.

Return Value

boolean: true if the item is a master item that should be copied in a clipboard operation.

isViewStateItemToCopy

(item: IModelItem): boolean

Whether the item was added as view state item and should be copied by copy.

Returns true if the item should be copied without master representation.

final

Parameters

item: IModelItem: The item to query for.

Return Value

boolean: true if the item is a view state item that should be copied in a clipboard operation.

markAsHelper

(item: IModelItem): boolean

Marks an item in the clipboardGraph that should not be pasted but was copied to the clipboardGraph as it was required to maintain its structural integrity.

final

Parameters

item: IModelItem: The item to add.

Return Value

boolean: true if the element is added; false if the element is already present.