com.yworks.yfiles.graph

Class NodeDecorator

java.lang.Object

com.yworks.yfiles.graph.NodeDecorator

public final class NodeDecorator
extends Object

A utility class that helps in decorating the ILookup.lookup(Class) method of INode instances that are contained in an IGraph which are managed by an ILookupDecorator.

This decorator can be used to conveniently decorate the lookup of INodes in an IGraph. It serves as a factory for predefined LookupDecorator instances that are specifically useful for the INode type. Note that the list of possible decorations that are available using this class is not exhaustive in any way. This is merely a way to provide access to those interfaces that are more commonly being decorated by the developer.

See Also:

GraphDecorator, LookupDecorator

Constructor Summary

Constructors

Constructor and Description
NodeDecorator(ILookupDecorator decorator) Initializes a new instance of the NodeDecorator class.

Method Summary

Modifier and Type	Method and Description
LookupDecorator<INode,IClipboardHelper>	getClipboardHelperDecorator() Gets a LookupDecorator that decorates the IClipboardHelper type for the type of items this instance has been created for.
<TInterface> LookupDecorator<INode,TInterface>	getDecoratorFor(Class<TInterface> interfaceType) Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.
<TInterface> LookupDecorator<INode,TInterface>	getDecoratorFor(Class<TInterface> interfaceType, boolean decorateNulls) Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.
<TInterface> LookupDecorator<INode,TInterface>	getDecoratorFor(Class<TInterface> interfaceType, boolean decorateNulls, boolean nullIsFallback) Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.
LookupDecorator<INode,IEditLabelHelper>	getEditLabelHelperDecorator() Gets a LookupDecorator that decorates the IEditLabelHelper type for the INodes this instance has been created for.
LookupDecorator<INode,IFocusIndicatorInstaller>	getFocusIndicatorDecorator() Gets a LookupDecorator that decorates the IFocusIndicatorInstaller type for the type of items this instance has been created for.
LookupDecorator<INode,IGroupBoundsCalculator>	getGroupBoundsCalculatorDecorator() Gets a LookupDecorator that decorates the IGroupBoundsCalculator type for the INodes this instance has been created for.
LookupDecorator<INode,IHandleProvider>	getHandleProviderDecorator() Gets a LookupDecorator that decorates the IHandleProvider type for the type of items this instance has been created for.
LookupDecorator<INode,IHighlightIndicatorInstaller>	getHighlightDecorator() Gets a LookupDecorator that decorates the IHighlightIndicatorInstaller type for the type of items this instance has been created for.
LookupDecorator<INode,INodeInsetsProvider>	getInsetsProviderDecorator() Gets a LookupDecorator that decorates the INodeInsetsProvider (tied to the INode type parameter) for the INodes this instance has been created for.
LookupDecorator<INode,IMarqueeTestable>	getMarqueeTestableDecorator() Gets a LookupDecorator that decorates the IMarqueeTestable type for the type of items this instance has been created for.
LookupDecorator<INode,IMementoSupport>	getMementoSupportDecorator() Gets a LookupDecorator that decorates the IMementoSupport type for the type of items this instance has been created for.
LookupDecorator<INode,INodeReshapeSnapResultProvider>	getNodeReshapeSnapResultProviderDecorator() Gets a LookupDecorator that decorates the ISnapLineProvider for the INodes this instance has been created for.
LookupDecorator<INode,INodeSnapResultProvider>	getNodeSnapResultProviderDecorator() Gets a LookupDecorator that decorates the INodeSnapResultProvider for the INodes this instance has been created for.
LookupDecorator<INode,IObstacleProvider>	getObstacleProviderDecorator() Gets a LookupDecorator that decorates the IObstacleProvider type for the type of items this instance has been created for.
LookupDecorator<INode,IPortCandidateProvider>	getPortCandidateProviderDecorator() Gets a LookupDecorator that decorates the IPortCandidateProvider for the INodes this instance has been created for.
LookupDecorator<INode,IPositionHandler>	getPositionHandlerDecorator() Gets a LookupDecorator that decorates the IPositionHandler type for the type of items this instance has been created for.
LookupDecorator<INode,IReshapeHandleProvider>	getReshapeHandleProviderDecorator() Gets a LookupDecorator that decorates the IReshapeHandleProvider type for the INodes this instance has been created for.
LookupDecorator<INode,ISelectionIndicatorInstaller>	getSelectionDecorator() Gets a LookupDecorator that decorates the ISelectionIndicatorInstaller type for the type of items this instance has been created for.
LookupDecorator<INode,IShapeGeometry>	getShapeGeometryDecorator() Gets a LookupDecorator that decorates the IShapeGeometry type for the type INodes this instance has been created for.
LookupDecorator<INode,INodeSizeConstraintProvider>	getSizeConstraintProviderDecorator() Gets a LookupDecorator that decorates the INodeSizeConstraintProvider type for the type INodes this instance has been created for.
LookupDecorator<INode,ISnapLineProvider>	getSnapLineProviderDecorator() Gets a LookupDecorator that decorates the ISnapLineProvider for the INodes this instance has been created for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeDecorator

public NodeDecorator(ILookupDecorator decorator)

Initializes a new instance of the NodeDecorator class.

Parameters:

decorator - The decorator to use, which can be null.

Method Detail

getClipboardHelperDecorator

public final LookupDecorator<INode,IClipboardHelper> getClipboardHelperDecorator()

Gets a LookupDecorator that decorates the IClipboardHelper type for the type of items this instance has been created for.

Custom IClipboardHelper implementations can be used to customize the way the clipboard operations are performed by GraphClipboard. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IClipboardHelper instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getDecoratorFor

public final <TInterface> LookupDecorator<INode,TInterface> getDecoratorFor(Class<TInterface> interfaceType)

Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.

Type Parameters:

TInterface - The type of the interface that should be decorated of the instances' ILookup.lookup(Class).

Returns:

A new LookupDecorator for the specified interface.

getDecoratorFor

public final <TInterface> LookupDecorator<INode,TInterface> getDecoratorFor(Class<TInterface> interfaceType,
                                                                            boolean decorateNulls)

Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.

Type Parameters:

TInterface - The type of the interface that should be decorated of the instances' ILookup.lookup(Class).

Parameters:

decorateNulls - if set to true null values will be decorated, otherwise not.

Returns:

A new LookupDecorator for the specified interface.

getDecoratorFor

public final <TInterface> LookupDecorator<INode,TInterface> getDecoratorFor(Class<TInterface> interfaceType,
                                                                            boolean decorateNulls,
                                                                            boolean nullIsFallback)

Creates a LookupDecorator for INodes that can be used to decorate TInterface types of the nodes.

Type Parameters:

TInterface - The type of the interface that should be decorated of the instances' ILookup.lookup(Class).

Parameters:

interfaceType - The type of the interface that should be decorated of the instances' ILookup.lookup(Class).

decorateNulls - if set to true null values will be decorated, otherwise not.

nullIsFallback - if set to true null values will be treated as fallback values, otherwise they will be used as the final result.

Returns:

A new LookupDecorator for the specified interface.

getEditLabelHelperDecorator

public final LookupDecorator<INode,IEditLabelHelper> getEditLabelHelperDecorator()

Gets a LookupDecorator that decorates the IEditLabelHelper type for the INodes this instance has been created for.

Custom IEditLabelHelper implementations can be used to change or customize interactive label editing and label creation. This interface is mainly used by the GraphEditorInputMode which uses the callbacks from the implementation to determine the label to add or edit, as well as to customize the TextEditorInputMode appearance for the upcoming edit. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IEditLabelHelper instances on INodes.

getFocusIndicatorDecorator

public final LookupDecorator<INode,IFocusIndicatorInstaller> getFocusIndicatorDecorator()

Gets a LookupDecorator that decorates the IFocusIndicatorInstaller type for the type of items this instance has been created for.

Custom IFocusIndicatorInstaller implementations can be used change the way the focus of an item is represented in a GraphControl. This interface is mainly used by the FocusIndicatorManager in the GraphControl. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IFocusIndicatorInstaller instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getGroupBoundsCalculatorDecorator

public final LookupDecorator<INode,IGroupBoundsCalculator> getGroupBoundsCalculatorDecorator()

Gets a LookupDecorator that decorates the IGroupBoundsCalculator type for the INodes this instance has been created for.

Custom IGroupBoundsCalculator implementations can be used to change the way the bounds of group nodes are being calculated if the geometry of child nodes is changed by the user. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IGroupBoundsCalculator instances on INodes.

getHandleProviderDecorator

public final LookupDecorator<INode,IHandleProvider> getHandleProviderDecorator()

Gets a LookupDecorator that decorates the IHandleProvider type for the type of items this instance has been created for.

Custom IHandleProvider implementations provide interactive draggable handles for the user to change the geometry or other aspects of items in the GraphControl. This interface is mainly used by the HandleInputMode in the GraphEditorInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IHandleProvider instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getHighlightDecorator

public final LookupDecorator<INode,IHighlightIndicatorInstaller> getHighlightDecorator()

Gets a LookupDecorator that decorates the IHighlightIndicatorInstaller type for the type of items this instance has been created for.

Custom IHighlightIndicatorInstaller implementations can be used change the way the highlighting of an item is represented in a CanvasControl. This interface is mainly used by the HighlightIndicatorManager in the GraphControl. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IHighlightIndicatorInstaller instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getInsetsProviderDecorator

public final LookupDecorator<INode,INodeInsetsProvider> getInsetsProviderDecorator()

Gets a LookupDecorator that decorates the INodeInsetsProvider (tied to the INode type parameter) for the INodes this instance has been created for.

Custom INodeInsetsProvider implementations can be used to change the way the bounds of group nodes are being calculated if the geometry of child nodes is changed by the user. This interface will be used if there is no custom IGroupBoundsCalculator associated with the nodes (see GroupBoundsCalculatorDecorator). This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class). Note that many INodeStyle implementations provide an Insets property whose value will be reported by a INodeInsetsProvider implementation that is provided by the corresponding INodeStyleRenderer. Using this property instead of decorating the lookup of the INode is thus often simpler.

Returns:

A decorator that can be used to modify the queries for INodeInsetsProvider instances on INodes.

getMarqueeTestableDecorator

public final LookupDecorator<INode,IMarqueeTestable> getMarqueeTestableDecorator()

Gets a LookupDecorator that decorates the IMarqueeTestable type for the type of items this instance has been created for.

Custom IMarqueeTestable implementations can be used to change the way tests for marquee inclusions are performed on the items in the editor. This interface is mainly used by the GraphEditorInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IMarqueeTestable instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getMementoSupportDecorator

public final LookupDecorator<INode,IMementoSupport> getMementoSupportDecorator()

Gets a LookupDecorator that decorates the IMementoSupport type for the type of items this instance has been created for.

Custom IMementoSupport implementations can be used to make the UndoEngine aware of changes to data that is associated with the model items. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IMementoSupport instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getNodeReshapeSnapResultProviderDecorator

public final LookupDecorator<INode,INodeReshapeSnapResultProvider> getNodeReshapeSnapResultProviderDecorator()

Gets a LookupDecorator that decorates the ISnapLineProvider for the INodes this instance has been created for.

Custom INodeReshapeSnapResultProvider implementations can be used to provide custom SnapResults based on the INodes this instance has been created for. This could e.g. be a SnapResult describing that the top left corner of the node wants to snap to a grid point. This interface is mainly used by the node reshape IHandles to collect SnapResults during a resize gesture for the node. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify queries for ISnapLineProvider instances on INodes.

getNodeSnapResultProviderDecorator

public final LookupDecorator<INode,INodeSnapResultProvider> getNodeSnapResultProviderDecorator()

Gets a LookupDecorator that decorates the INodeSnapResultProvider for the INodes this instance has been created for.

Custom INodeSnapResultProvider implementations can be used to provide custom SnapResults based on the INodes this instance has been created for. This could e.g. be a SnapResult describing that the top left corner of the node wants to snap to a grid point. This interface is mainly used by the node's IPositionHandler to collect SnapResults during a drag gesture for the node. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify queries for INodeSnapResultProvider instances on INodes.

getObstacleProviderDecorator

public final LookupDecorator<INode,IObstacleProvider> getObstacleProviderDecorator()

Gets a LookupDecorator that decorates the IObstacleProvider type for the type of items this instance has been created for.

Custom IObstacleProvider implementations provide information about obstacles that will be considered by GraphObstacleProvider which itself serves as a provider for geometric obstacles to BridgeManager that manages the rendering of bridges in edge paths. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IObstacleProvider instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

See Also:

GraphObstacleProvider, BridgeManager

getPortCandidateProviderDecorator

public final LookupDecorator<INode,IPortCandidateProvider> getPortCandidateProviderDecorator()

Gets a LookupDecorator that decorates the IPortCandidateProvider for the INodes this instance has been created for.

Custom IPortCandidateProvider implementations can be used to present the user with a set of IPortCandidates that newly created edges can use as their source and target IPorts. This interface is mainly used by the CreateEdgeInputMode mode of GraphEditorInputMode. Also the default implementation of IEdgeReconnectionPortCandidateProvider will use this interface to determine the candidates that are available if the user interactively moves the ports using PortRelocationHandle (see HandleDecorator). This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IPortCandidateProvider instances on INodes.

getPositionHandlerDecorator

public final LookupDecorator<INode,IPositionHandler> getPositionHandlerDecorator()

Gets a LookupDecorator that decorates the IPositionHandler type for the type of items this instance has been created for.

Custom IPositionHandler implementations can be used to restrict or enhance the way the user moves elements interactively in the editor. This interface is mainly used by the MoveInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IPositionHandler instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getReshapeHandleProviderDecorator

public final LookupDecorator<INode,IReshapeHandleProvider> getReshapeHandleProviderDecorator()

Gets a LookupDecorator that decorates the IReshapeHandleProvider type for the INodes this instance has been created for.

Custom IReshapeHandleProvider implementations can be used to change the number and type of IHandles that can be used by the user to reshape the INodes in interactively in the editor. This interface is mainly used by the GraphEditorInputMode which passes the IHandles to the HandleInputMode. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IReshapeHandleProvider instances on INodes.

getSelectionDecorator

public final LookupDecorator<INode,ISelectionIndicatorInstaller> getSelectionDecorator()

Gets a LookupDecorator that decorates the ISelectionIndicatorInstaller type for the type of items this instance has been created for.

Custom ISelectionIndicatorInstaller implementations can be used change the way the selection of an item is represented in a CanvasControl. This interface is mainly used by the SelectionIndicatorManager in the GraphControl. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for ISelectionIndicatorInstaller instances on items that implement the TModelItem interface this instance uses as the generic type parameter.

getShapeGeometryDecorator

public final LookupDecorator<INode,IShapeGeometry> getShapeGeometryDecorator()

Gets a LookupDecorator that decorates the IShapeGeometry type for the type INodes this instance has been created for.

Custom IShapeGeometry implementations can be used to change the way different code parts interpret the Layout of an INode. This interface is mainly used by the DefaultEdgePathCropper, and a custom IPortCandidateProvider that can be obtained from IPortCandidateProvider.fromShapeGeometry(com.yworks.yfiles.graph.IPortOwner, double[]). Note that decorating the IShapeGeometry for an INode will not change the result of a call to INodeStyleRenderer.getShapeGeometry(INode, com.yworks.yfiles.graph.styles.INodeStyle) of the Style. So standard hit tests will not be influenced by such a change. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for IShapeGeometry instances on INodes.

getSizeConstraintProviderDecorator

public final LookupDecorator<INode,INodeSizeConstraintProvider> getSizeConstraintProviderDecorator()

Gets a LookupDecorator that decorates the INodeSizeConstraintProvider type for the type INodes this instance has been created for.

Custom INodeSizeConstraintProvider implementations can be used to add constraints to the size of a node. These constraints are used by the default IReshapeHandleProvider implementation for nodes to enforce size constraints for interactive resize gestures. Also GraphEditorInputMode uses this interface to constrain the size of a node whenever its labels are being edited interactively. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify the queries for INodeSizeConstraintProvider instances on INodes.

getSnapLineProviderDecorator

public final LookupDecorator<INode,ISnapLineProvider> getSnapLineProviderDecorator()

Gets a LookupDecorator that decorates the ISnapLineProvider for the INodes this instance has been created for.

Custom ISnapLineProvider implementations can be used to provide custom OrthogonalSnapLines based on the INodes this instance has been created for. This could e.g. be a horizontal OrthogonalSnapLine at the vertical center of the node to which other nodes should snap with their top border. This interface is mainly used by the GraphSnapContext to collect all available OrthogonalSnapLines. This is a convenient alternative to the direct usage of the ILookupDecorator that is provided by the IGraph's ILookup.lookup(Class).

Returns:

A decorator that can be used to modify queries for ISnapLineProvider instances on INodes.