com.yworks.yfiles.view

Enum VisualCachingPolicy

java.lang.Object

java.lang.Enum<VisualCachingPolicy>

com.yworks.yfiles.view.VisualCachingPolicy

All Implemented Interfaces:

Serializable, Comparable<VisualCachingPolicy>

public enum VisualCachingPolicy
extends Enum<VisualCachingPolicy>

Determines the policy whether and how Nodes are cached when they are removed temporarily from the CanvasControl's visual tree.

Nodes are temporarily removed when they are moved outside the visual part of the canvas (the Viewport) and re-added when they enter the Viewport again. Caching prevents the need to re-build the visuals from scratch.

In order to be cached a IDisposeVisualCallback has to be registered during creation.

See Also:

CanvasControl.getVisualCaching(), IRenderContext.setDisposeCallback(javafx.scene.Node, IDisposeVisualCallback), IDisposeVisualCallback

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEVER Disables caching of Nodes completely.
STRONG Nodes will always be cached.
WEAK Nodes will be cached using a weak reference, which means they might be removed by the Garbage Collection.

Method Summary

Modifier and Type	Method and Description
static VisualCachingPolicy	fromOrdinal(int ordinal)
int	value()
static VisualCachingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static VisualCachingPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final VisualCachingPolicy NEVER

Disables caching of Nodes completely.

STRONG

public static final VisualCachingPolicy STRONG

Nodes will always be cached.

The cached reference will be kept until the corresponding ICanvasObject is removed.

WEAK

public static final VisualCachingPolicy WEAK

Nodes will be cached using a weak reference, which means they might be removed by the Garbage Collection.

Method Detail

fromOrdinal

public static final VisualCachingPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static VisualCachingPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

values

public static VisualCachingPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VisualCachingPolicy c : VisualCachingPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared