com.yworks.yfiles.view.input

Enum SnapPolicy

java.lang.Object

java.lang.Enum<SnapPolicy>

com.yworks.yfiles.view.input.SnapPolicy

All Implemented Interfaces:

Serializable, Comparable<SnapPolicy>

public enum SnapPolicy
extends Enum<SnapPolicy>

The policy constants used by IGridConstraintProvider.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_SNAPPING Don't perform snapping.
TO_GREATER Snap to the nearest grid coordinate whose value is not less than the current coordinate.
TO_NEAREST Snap to the nearest grid coordinate.
TO_SMALLER Snap to the nearest grid coordinate whose value is not greater than the current coordinate.

Method Summary

Modifier and Type	Method and Description
static SnapPolicy	fromOrdinal(int ordinal)
int	value()
static SnapPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SnapPolicy[]	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

NO_SNAPPING

public static final SnapPolicy NO_SNAPPING

Don't perform snapping.

TO_GREATER

public static final SnapPolicy TO_GREATER

Snap to the nearest grid coordinate whose value is not less than the current coordinate.

TO_NEAREST

public static final SnapPolicy TO_NEAREST

Snap to the nearest grid coordinate.

TO_SMALLER

public static final SnapPolicy TO_SMALLER

Snap to the nearest grid coordinate whose value is not greater than the current coordinate.

Method Detail

fromOrdinal

public static final SnapPolicy fromOrdinal(int ordinal)

value

public int value()

valueOf

public static SnapPolicy 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 SnapPolicy[] 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 (SnapPolicy c : SnapPolicy.values())
    System.out.println(c);

Returns:

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