com.yworks.yfiles.view

Class VoidVisualCreator

java.lang.Object

com.yworks.yfiles.view.VoidVisualCreator

All Implemented Interfaces:

IVisualCreator

public final class VoidVisualCreator
extends Object
implements IVisualCreator

A void/null implementation of the IVisualCreator interface that does nothing.

Use INSTANCE for methods that require non-null IVisualCreator implementations if you want to have no visualization.

Field Summary

Fields

Modifier and Type	Field and Description
static VoidVisualCreator	INSTANCE An immutable and shareable convenience instance of the VoidVisualCreator class.

Constructor Summary

Constructors

Constructor and Description
VoidVisualCreator()

Method Summary

Modifier and Type	Method and Description
Node	createVisual(IRenderContext context) Returns null.
Node	updateVisual(IRenderContext context, Node oldVisual) Returns null.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final VoidVisualCreator INSTANCE

An immutable and shareable convenience instance of the VoidVisualCreator class.

Constructor Detail

VoidVisualCreator

public VoidVisualCreator()

Method Detail

createVisual

public final Node createVisual(IRenderContext context)

Returns null.

Specified by:

createVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used.

Returns:

The visual to include in the canvas object visual tree. This may be null.

See Also:

IVisualCreator.updateVisual(IRenderContext, Node)

updateVisual

public final Node updateVisual(IRenderContext context,
                               Node oldVisual)

Returns null.

Specified by:

updateVisual in interface IVisualCreator

Parameters:

context - The context that describes where the visual will be used in.

oldVisual - The visual instance that had been returned the last time the IVisualCreator.createVisual(IRenderContext) method was called on this instance.

Returns:

oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.

See Also:

IVisualCreator.createVisual(IRenderContext), ICanvasObjectDescriptor, CanvasControl