Packagecom.yworks.graph.model
Classpublic class EdgeDecorator
InheritanceEdgeDecorator Inheritance ItemDecorator Inheritance Object

A subclass of the ItemDecorator that is specifically tailored for IEdges.

See also

ItemDecorator


Public Properties
 PropertyDefined By
 InheritedactionButtonProviderDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IActionButtonProvider type for the type of items this instance has been created for.
ItemDecorator
  bendCreatorDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IBendCreator type for IEdges.
EdgeDecorator
  bendSelectionTesterDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IBendSelectionTester type for IEdges.
EdgeDecorator
 InheritedclipboardHelperDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IClipboardHelper type for the type of items this instance has been created for.
ItemDecorator
 Inheriteddecorator : ILookupDecorator
The decorator to use.
ItemDecorator
  edgePortCandidateProviderDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IEdgePortCandidateProvider type for IEdges.
EdgeDecorator
  edgePortHandleProviderDecorator : LookupDecorator
[read-only] Gets a LookupDecorator that decorates the IEdgePortHandleProvider type for the IEdges of the graph this instance has been created for.
EdgeDecorator
  edgeSnapResultProviderDecorator : LookupDecorator
[read-only] Gets a LookupDecorator that decorates the IEdgeSnapResultProvider type for the IEdges of the graph this instance has been created for.
EdgeDecorator
 InheritedfocusPaintableDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IFocusPaintableInstaller type for the type of items this instance has been created for.
ItemDecorator
 InheritedhandleProviderDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IHandleProvider type for the type of items this instance has been created for.
ItemDecorator
 InheritedhighlightDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IHighlightPaintableInstaller type for the type of items this instance has been created for.
ItemDecorator
 InheritedmarqueeTestableDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IMarqueeTestable type for the type of items this instance has been created for.
ItemDecorator
 InheritedmementoSupportDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IMementoSupport type for the type of items this instance has been created for.
ItemDecorator
  orthogonalEdgeHelperDecorator : LookupDecorator
[read-only] Gets a LookupDecorator that decorates the IOrthogonalEdgeHelper type for the IEdges of the graph this instance has been created for.
EdgeDecorator
 InheritedpositionHandlerDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the IPositionHandler type for the type of items this instance has been created for.
ItemDecorator
 InheritedselectionDecorator : LookupDecorator
[read-only] The LookupDecorator that decorates the ISelectionPaintable type for the type of items this instance has been created for.
ItemDecorator
  snapLineProviderDecorator : LookupDecorator
[read-only] Gets a LookupDecorator that decorates the ISnapLineProvider for the IEdges this instance has been created for.
EdgeDecorator
Public Methods
 MethodDefined By
  
Creates a new instance that uses the given decorator.
EdgeDecorator
Property Detail
bendCreatorDecoratorproperty
bendCreatorDecorator:LookupDecorator  [read-only]

The LookupDecorator that decorates the IBendCreator type for IEdges.

The IBendCreator is queried by the CreateBendInputMode to create a new IBend.


Implementation
    public function get bendCreatorDecorator():LookupDecorator

See also

bendSelectionTesterDecoratorproperty 
bendSelectionTesterDecorator:LookupDecorator  [read-only]

The LookupDecorator that decorates the IBendSelectionTester type for IEdges.

The IBendSelectionTester is used by the GraphEditorInputMode and the CreateBendInputMode to find bends at a given location.


Implementation
    public function get bendSelectionTesterDecorator():LookupDecorator

See also

IBendSelectionTester
GraphEditorInputMode
CreateBendInputMode
edgePortCandidateProviderDecoratorproperty 
edgePortCandidateProviderDecorator:LookupDecorator  [read-only]

The LookupDecorator that decorates the IEdgePortCandidateProvider type for IEdges.

The IEdgePortCandidateProvider is queried to return alternative IPortCandidates for an existing edge.


Implementation
    public function get edgePortCandidateProviderDecorator():LookupDecorator

See also

edgePortHandleProviderDecoratorproperty 
edgePortHandleProviderDecorator:LookupDecorator  [read-only]

Gets a LookupDecorator that decorates the IEdgePortHandleProvider type for the IEdges of the graph this instance has been created for. Custom IEdgePortHandleProvider implementations can be used to provide interactive draggable handles for the source and target end points of an edge. This interface is mainly used by the HandleInputMode in the GraphEditorInputMode and by the implementations that work with OrthogonalEdgeEditingContext. Implementations my decide, e.g. whether to yield IHandle implementations that either move the edge to another port (-candidate) using IGraph.setPorts or whether to move the port the edge is currently connected to itself, instead. This is a convenient alternative to the direct usage of the ILookupDecororator that is provided by the IGraph's lookup


Implementation
    public function get edgePortHandleProviderDecorator():LookupDecorator

See also

IEdgePortHandleProvider
HandleInputMode
GraphEditorInputMode
OrthogonalEdgeEditingContext
IGraph.setPorts
PortRelocationHandle
IHandle
IHandleProvider
edgeSnapResultProviderDecoratorproperty 
edgeSnapResultProviderDecorator:LookupDecorator  [read-only]

Gets a LookupDecorator that decorates the IEdgeSnapResultProvider type for the IEdges of the graph this instance has been created for. Custom IEdgeSnapResultProvider implementations can be used to change the snapping behavior of edges while they are being moved in the context of a GraphSnapContext. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's lookup.


Implementation
    public function get edgeSnapResultProviderDecorator():LookupDecorator

See also

IEdgeSnapResultProvider
GraphSnapContext
orthogonalEdgeHelperDecoratorproperty 
orthogonalEdgeHelperDecorator:LookupDecorator  [read-only]

Gets a LookupDecorator that decorates the IOrthogonalEdgeHelper type for the IEdges of the graph this instance has been created for. Custom IOrthogonalEdgeHelper implementations can be used to change the orthogonal edge editing behavior in the context of OrthogonalEdgeEditingContext. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's lookup.


Implementation
    public function get orthogonalEdgeHelperDecorator():LookupDecorator

See also

IOrthogonalEdgeHelper
OrthogonalEdgeEditingContext
snapLineProviderDecoratorproperty 
snapLineProviderDecorator:LookupDecorator  [read-only]

Gets a LookupDecorator that decorates the ISnapLineProvider for the IEdges this instance has been created for. Custom ISnapLineProvider implementations can be used to provide custom SnapLines based on the IEdges this instance has been created for. This could e.g. be a horizontal SnapLine vertically centered between two horizontal segments of one of these edges. This interface is mainly used by the GraphSnapContext to collect all available SnapLines of orthogonal edge segments. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's lookup.


Implementation
    public function get snapLineProviderDecorator():LookupDecorator

See also

ISnapLineProvider
GraphSnapContext
Constructor Detail
EdgeDecorator()Constructor
public function EdgeDecorator(decorator:ILookupDecorator)

Creates a new instance that uses the given decorator.

Parameters
decorator:ILookupDecorator — The decorator to use.