com.yworks.yfiles.graph.styles

Class VoidPortStyleRenderer

java.lang.Object

com.yworks.yfiles.graph.styles.VoidPortStyleRenderer

All Implemented Interfaces:

IPortStyleRenderer

public final class VoidPortStyleRenderer
extends Object
implements IPortStyleRenderer

A void implementation of a port 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 IPortStyle.

Field Summary

Fields

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

Method Summary

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

The VoidPortStyleRenderer singleton.

Method Detail

getBoundsProvider

public final IBoundsProvider getBoundsProvider(IPort port,
                                               IPortStyle style)

Yields the IBoundsProvider.EMPTY that will return empty bounds.

Specified by:

getBoundsProvider in interface IPortStyleRenderer

Parameters:

port - The port 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 port'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(IPort port,
                                IPortStyle style)

Yields the ILookup.EMPTY that will not yield anything.

Specified by:

getContext in interface IPortStyleRenderer

Parameters:

port - The port 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(IPort port,
                                         IPortStyle style)

Yields the IHitTestable.NEVER that will always report misses.

Specified by:

getHitTestable in interface IPortStyleRenderer

Parameters:

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

getInstance

public static VoidPortStyleRenderer getInstance()

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

Returns:

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

getMarqueeTestable

public final IMarqueeTestable getMarqueeTestable(IPort port,
                                                 IPortStyle style)

Yields the IMarqueeTestable.NEVER that will always report misses.

Specified by:

getMarqueeTestable in interface IPortStyleRenderer

Parameters:

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

getVisibilityTestable

public final IVisibilityTestable getVisibilityTestable(IPort port,
                                                       IPortStyle style)

Yields the IVisibilityTestable.NEVER that will always claim invisibility.

Specified by:

getVisibilityTestable in interface IPortStyleRenderer

Parameters:

port - The port 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 port'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(IPort port,
                                             IPortStyle style)

Yields the VoidVisualCreator.INSTANCE that will do nothing.

Specified by:

getVisualCreator in interface IPortStyleRenderer

Parameters:

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