com.yworks.yfiles.graph.styles

Class VoidLabelStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.VoidLabelStyleRenderer

All Implemented Interfaces:

ILabelStyleRenderer

public final class VoidLabelStyleRenderer
extends Object
implements ILabelStyleRenderer

A void implementation of a label 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 ILabelStyle.

Field Summary

Fields

Modifier and Type	Field and Description
static VoidLabelStyleRenderer	INSTANCE The singleton instance of this renderer.

Method Summary

Modifier and Type	Method and Description
IBoundsProvider	getBoundsProvider(ILabel label, ILabelStyle style) Yields the IBoundsProvider.EMPTY that will return empty bounds.
ILookup	getContext(ILabel label, ILabelStyle style) Yields the ILookup.EMPTY that will not yield anything.
IHitTestable	getHitTestable(ILabel label, ILabelStyle style) Yields the IHitTestable.NEVER that will always report misses.
static VoidLabelStyleRenderer	getInstance() Returns the com.yworks.yfiles.common.drawing.VoidLabelStyleRenderer singleton.
IMarqueeTestable	getMarqueeTestable(ILabel label, ILabelStyle style) Yields the IMarqueeTestable.NEVER that will always report misses.
SizeD	getPreferredSize(ILabel label, ILabelStyle style) Yields SizeD.EMPTY.
IVisibilityTestable	getVisibilityTestable(ILabel label, ILabelStyle style) Yields the IVisibilityTestable.NEVER that will always claim invisibility.
IVisualCreator	getVisualCreator(ILabel label, ILabelStyle 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 VoidLabelStyleRenderer INSTANCE

The singleton instance of this renderer.

Method Detail

getBoundsProvider

public final IBoundsProvider getBoundsProvider(ILabel label,
                                               ILabelStyle style)

Yields the IBoundsProvider.EMPTY that will return empty bounds.

Specified by:

getBoundsProvider in interface ILabelStyleRenderer

Parameters:

label - The label 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 label'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(ILabel label,
                                ILabelStyle style)

Yields the ILookup.EMPTY that will not yield anything.

Specified by:

getContext in interface ILabelStyleRenderer

Parameters:

label - The label 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(ILabel label,
                                         ILabelStyle style)

Yields the IHitTestable.NEVER that will always report misses.

Specified by:

getHitTestable in interface ILabelStyleRenderer

Parameters:

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

getInstance

public static VoidLabelStyleRenderer getInstance()

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

Returns:

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

getMarqueeTestable

public final IMarqueeTestable getMarqueeTestable(ILabel label,
                                                 ILabelStyle style)

Yields the IMarqueeTestable.NEVER that will always report misses.

Specified by:

getMarqueeTestable in interface ILabelStyleRenderer

Parameters:

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

getPreferredSize

public final SizeD getPreferredSize(ILabel label,
                                    ILabelStyle style)

Yields SizeD.EMPTY.

Specified by:

getPreferredSize in interface ILabelStyleRenderer

Parameters:

label - The label to determine the preferred size for

style - The style instance that uses this instance as its Renderer

Returns:

A size that can be used as the PreferredSize if this renderer renders the label using the associated style.

getVisibilityTestable

public final IVisibilityTestable getVisibilityTestable(ILabel label,
                                                       ILabelStyle style)

Yields the IVisibilityTestable.NEVER that will always claim invisibility.

Specified by:

getVisibilityTestable in interface ILabelStyleRenderer

Parameters:

label - The label 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 label'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(ILabel label,
                                             ILabelStyle style)

Yields the VoidVisualCreator.INSTANCE that will do nothing.

Specified by:

getVisualCreator in interface ILabelStyleRenderer

Parameters:

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