com.levigo.jadice.swing.crosshair
Enum FrozenMode

java.lang.Object
  java.lang.Enum<FrozenMode>
      com.levigo.jadice.swing.crosshair.FrozenMode

All Implemented Interfaces:

Serializable, Comparable<FrozenMode>

public enum FrozenMode
extends Enum<FrozenMode>

An enumeration of possible frozen modes.

Describes how an instance of CrossHairTool handles the frozen mode.

Enum Constant Summary

DISABLED
Indicates, that the frozen state function is switched off.

ENABLED_DOCCHANGE_RESET
Indicates, that the frozen state function is switched on.

ENABLED_PAGECHANGE_RESET
Indicates, that the frozen state function is switched on.

Method Summary

static FrozenMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrozenMode[]	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

DISABLED

public static final FrozenMode DISABLED

Indicates, that the frozen state function is switched off.

ENABLED_DOCCHANGE_RESET

public static final FrozenMode ENABLED_DOCCHANGE_RESET

Indicates, that the frozen state function is switched on. To ensure a consistent behaviour an activated frozen state will be released on a document change.

ENABLED_PAGECHANGE_RESET

public static final FrozenMode ENABLED_PAGECHANGE_RESET

Indicates, that the frozen state function is switched on. To ensure a consistent behaviour an activated frozen state will be released on a change of current page.

Method Detail

values

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

Returns:

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

valueOf

public static FrozenMode 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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null