com.yworks.yfiles.graph.styles

Class VoidNodeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.VoidNodeStyleRenderer

All Implemented Interfaces:

INodeStyleRenderer

public final class VoidNodeStyleRenderer
extends Object
implements INodeStyleRenderer

A void implementation of a node style renderer that does nothing.

This class implements the singleton pattern. Use the shared static INSTANCE of this class instead of null where null is not allowed. For example you cannot assign null to the Renderer property of an INodeStyle.

Field Summary

Fields

Modifier and Type	Field and Description
static VoidNodeStyleRenderer	INSTANCE The VoidNodeStyleRenderer singleton.

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(INode node, INodeStyle style) Yields the IBoundsProvider.EMPTY that will return empty bounds.
ILookup	getContext(INode node, INodeStyle style) Yields the ILookup.EMPTY that will not yield anything.
IHitTestable	getHitTestable(INode node, INodeStyle style) Yields the IHitTestable.NEVER that will always report misses.
static VoidNodeStyleRenderer	getInstance() Returns the com.yworks.yfiles.common.drawing.VoidNodeStyleRenderer singleton.
IMarqueeTestable	getMarqueeTestable(INode node, INodeStyle style) Yields the IMarqueeTestable.NEVER that will always report misses.
IShapeGeometry	getShapeGeometry(INode node, INodeStyle style) This implementation always returns the VoidShapeGeometry instance.
IVisibilityTestable	getVisibilityTestable(INode node, INodeStyle style) Yields the IVisibilityTestable.NEVER that will always claim invisibility.
IVisualCreator	getVisualCreator(INode node, INodeStyle style) Yields the VoidVisualCreator.INSTANCE that will do nothing.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final VoidNodeStyleRenderer INSTANCE

The VoidNodeStyleRenderer singleton.

Method Detail

getBoundsProvider

public final IBoundsProvider getBoundsProvider(INode node,
                                               INodeStyle style)

Yields the IBoundsProvider.EMPTY that will return empty bounds.

Specified by:

getBoundsProvider in interface INodeStyleRenderer

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

public final ILookup getContext(INode node,
                                INodeStyle style)

Yields the ILookup.EMPTY that will not yield anything.

Specified by:

getContext in interface INodeStyleRenderer

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

public final IHitTestable getHitTestable(INode node,
                                         INodeStyle style)

Yields the IHitTestable.NEVER that will always report misses.

Specified by:

getHitTestable in interface INodeStyleRenderer

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.

getInstance

public static VoidNodeStyleRenderer getInstance()

Returns the com.yworks.yfiles.common.drawing.VoidNodeStyleRenderer singleton.

Returns:

the com.yworks.yfiles.common.drawing.VoidNodeStyleRenderer singleton.

getMarqueeTestable

public final IMarqueeTestable getMarqueeTestable(INode node,
                                                 INodeStyle style)

Yields the IMarqueeTestable.NEVER that will always report misses.

Specified by:

getMarqueeTestable in interface INodeStyleRenderer

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

public final IShapeGeometry getShapeGeometry(INode node,
                                             INodeStyle style)

This implementation always returns the VoidShapeGeometry instance.

Specified by:

getShapeGeometry in interface INodeStyleRenderer

Parameters:

node - The node to provide an instance for

style - The style to use for the rendering

Returns:

The VoidShapeGeometry instance.

See Also:

INodeStyleRenderer.getShapeGeometry(INode, INodeStyle)

getVisibilityTestable

public final IVisibilityTestable getVisibilityTestable(INode node,
                                                       INodeStyle style)

Yields the IVisibilityTestable.NEVER that will always claim invisibility.

Specified by:

getVisibilityTestable in interface INodeStyleRenderer

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

public final IVisualCreator getVisualCreator(INode node,
                                             INodeStyle style)

Yields the VoidVisualCreator.INSTANCE that will do nothing.

Specified by:

getVisualCreator in interface INodeStyleRenderer

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