com.yworks.yfiles.graph.styles

Class VoidEdgeStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.VoidEdgeStyleRenderer

All Implemented Interfaces:

IEdgeStyleRenderer

public final class VoidEdgeStyleRenderer
extends Object
implements IEdgeStyleRenderer

A void implementation of an edge 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 IEdgeStyle.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(IEdge edge, IEdgeStyle style) Yields the IBoundsProvider.EMPTY that will return empty bounds.
ILookup	getContext(IEdge edge, IEdgeStyle style) Yields the ILookup.EMPTY that will not yield anything.
IHitTestable	getHitTestable(IEdge edge, IEdgeStyle style) Yields the IHitTestable.NEVER that will always report misses.
static VoidEdgeStyleRenderer	getInstance() Returns the com.yworks.yfiles.common.drawing.VoidEdgeStyleRenderer singleton.
IMarqueeTestable	getMarqueeTestable(IEdge edge, IEdgeStyle style) Yields the IMarqueeTestable.NEVER that will always report misses.
IPathGeometry	getPathGeometry(IEdge edge, IEdgeStyle style) This method always returns the VoidPathGeometry instance.
IVisibilityTestable	getVisibilityTestable(IEdge edge, IEdgeStyle style) Yields the IVisibilityTestable.NEVER that will always claim invisibility.
IVisualCreator	getVisualCreator(IEdge edge, IEdgeStyle 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 VoidEdgeStyleRenderer INSTANCE

The VoidEdgeStyleRenderer singleton.

Method Detail

getBoundsProvider

public final IBoundsProvider getBoundsProvider(IEdge edge,
                                               IEdgeStyle style)

Yields the IBoundsProvider.EMPTY that will return empty bounds.

Specified by:

getBoundsProvider in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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 edge'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(IEdge edge,
                                IEdgeStyle style)

Yields the ILookup.EMPTY that will not yield anything.

Specified by:

getContext in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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(IEdge edge,
                                         IEdgeStyle style)

Yields the IHitTestable.NEVER that will always report misses.

Specified by:

getHitTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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 edge cannot be hit tested.

getInstance

public static VoidEdgeStyleRenderer getInstance()

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

Returns:

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

getMarqueeTestable

public final IMarqueeTestable getMarqueeTestable(IEdge edge,
                                                 IEdgeStyle style)

Yields the IMarqueeTestable.NEVER that will always report misses.

Specified by:

getMarqueeTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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

getPathGeometry

public final IPathGeometry getPathGeometry(IEdge edge,
                                           IEdgeStyle style)

This method always returns the VoidPathGeometry instance.

Specified by:

getPathGeometry in interface IEdgeStyleRenderer

Parameters:

edge - The edge to provide an instance for

style - The style to use for the rendering

Returns:

The VoidPathGeometry instance.

See Also:

IEdgeStyleRenderer.getPathGeometry(IEdge, IEdgeStyle)

getVisibilityTestable

public final IVisibilityTestable getVisibilityTestable(IEdge edge,
                                                       IEdgeStyle style)

Yields the IVisibilityTestable.NEVER that will always claim invisibility.

Specified by:

getVisibilityTestable in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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 edge'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(IEdge edge,
                                             IEdgeStyle style)

Yields the VoidVisualCreator.INSTANCE that will do nothing.

Specified by:

getVisualCreator in interface IEdgeStyleRenderer

Parameters:

edge - The edge 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 edge. 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