com.yworks.yfiles.graph.styles

Interface INodeStyleRenderer

All Known Implementing Classes:

BevelNodeStyleRenderer, CollapsibleNodeStyleDecoratorRenderer, GeneralPathNodeStyleRenderer, ImageNodeStyleRenderer, MemoryImageNodeStyleRenderer, PanelNodeStyleRenderer, ShapeNodeStyleRenderer, ShinyPlateNodeStyleRenderer, TableNodeStyleRenderer, TemplateNodeStyleRenderer, VoidNodeStyleRenderer

public interface INodeStyleRenderer

Interface used by INodeStyle implementations that can be used to query the actual IVisualCreator, IBoundsProvider, IHitTestable, and IMarqueeTestable implementations for a node and an associated style.

Implementations of this interface should be designed to be sharable between multiple style instances and should therefore not contain style specific state.

See Also:

INodeStyle, INode, IEdgeStyleRenderer, ILabelStyleRenderer, IPortStyleRenderer

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Gets an implementation of the IBoundsProvider interface that can handle the provided node and its associated style.
ILookup	getContext(INode node, INodeStyle style) Gets a temporary context instance that can be used to query additional information for the node's style.
IHitTestable	getHitTestable(INode node, INodeStyle style) Gets an implementation of the IHitTestable interface that can handle the provided node and its associated style.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Gets an implementation of the IMarqueeTestable interface that can handle the provided node and its associated style.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) Gets an implementation of the IShapeGeometry interface that can handle the provided node and its associated style.
IVisibilityTestable	getVisibilityTestable(INode node, INodeStyle style) Gets an implementation of the IVisibilityTestable interface that can handle the provided node and its associated style.
IVisualCreator	getVisualCreator(INode node, INodeStyle style) Gets an implementation of the IVisualCreator interface that can handle the provided node and its associated style.

Method Detail

getBoundsProvider

IBoundsProvider getBoundsProvider(INode node,
                                  INodeStyle style)

Gets an implementation of the IBoundsProvider interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Parameters:

node - The node to provide an instance for

style - The style to use for the calculating the painting bounds

Returns:

An implementation that may be used to subsequently query the node's painting bounds. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getContext

ILookup getContext(INode node,
                   INodeStyle style)

Gets a temporary context instance that can be used to query additional information for the node's style.

Implementations may return ILookup.EMPTY if they don't support this, but may not return null.

Parameters:

node - The node to provide a context instance for.

style - The style to use for the context.

Returns:

An non-null lookup implementation.

See Also:

ILookup.EMPTY, ILookup

getHitTestable

IHitTestable getHitTestable(INode node,
                            INodeStyle style)

Gets an implementation of the IHitTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Parameters:

node - The node to provide an instance for

style - The style to use for the querying hit tests

Returns:

An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return null to indicate that the node cannot be hit tested.

getMarqueeTestable

IMarqueeTestable getMarqueeTestable(INode node,
                                    INodeStyle style)

Gets an implementation of the IMarqueeTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Parameters:

node - The node to provide an instance for

style - The style to use for the querying marquee intersection test.

Returns:

An implementation that may be used to subsequently query the marquee intersections. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getShapeGeometry

IShapeGeometry getShapeGeometry(INode node,
                                INodeStyle style)

Gets an implementation of the IShapeGeometry interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Parameters:

node - The node to provide an instance for

style - The style to use for the rendering

Returns:

An implementation that may be used to subsequently query geometry information from. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getVisibilityTestable

IVisibilityTestable getVisibilityTestable(INode node,
                                          INodeStyle style)

Gets an implementation of the IVisibilityTestable interface that can handle the provided node and its associated style.

This method may return a flyweight implementation.

Parameters:

node - The node to provide an instance for

style - The style to use for the testing the visibility

Returns:

An implementation that may be used to subsequently query the node's visibility. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations

getVisualCreator

IVisualCreator getVisualCreator(INode node,
                                INodeStyle style)

Gets an implementation of the IVisualCreator interface that can handle the provided node and its associated style.

This method may return a flyweight implementation, but never null.

Parameters:

node - The node to provide an instance for

style - The style to use for the creation of the visual

Returns:

An implementation that may be used to subsequently create or update the visual for the node. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may not return null but should yield a void implementation instead.

See Also:

VoidVisualCreator.INSTANCE