com.levigo.jadice.swing.lens
Enum FrozenStateMode

java.lang.Object
  java.lang.Enum<FrozenStateMode>
      com.levigo.jadice.swing.lens.FrozenStateMode

All Implemented Interfaces:

Serializable, Comparable<FrozenStateMode>

public enum FrozenStateMode
extends Enum<FrozenStateMode>

Describes how an instance of HoverLensTool / LensView handles the frozen mode.

Since:

5.0

Enum Constant Summary

DISABLED
Disabled frozen state

ENABLED
Deprecated. since 5.1.0.7. This state will lead to undefined frozen states. Therefore it is strongly recommended not to use anymore. This constant will be removed with with one of the next major releases.

RESET_ON_DOCUMENT_CHANGE
Enabled frozen state, reset on document change

RESET_ON_PAGE_CHANGE
Enabled frozen state, reset on page change

Method Summary

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

Disabled frozen state

ENABLED

public static final FrozenStateMode ENABLED

Deprecated. since 5.1.0.7. This state will lead to undefined frozen states. Therefore it is strongly recommended not to use anymore. This constant will be removed with with one of the next major releases.

Enabled frozen state

Indicates, that the frozen state function is switched on. Due to historical reasons this state is part of the API, but this state is no longer relevant. It indicates the availability of the frozen state function, but without any commitment about the frozen state after a document change. This can lead to an undefined behaviour. Nevertheless, if this mode is applied it this tool behaves like RESET_ON_DOCUMENT_CHANGE.

RESET_ON_DOCUMENT_CHANGE

public static final FrozenStateMode RESET_ON_DOCUMENT_CHANGE

Enabled frozen state, reset on document change

RESET_ON_PAGE_CHANGE

public static final FrozenStateMode RESET_ON_PAGE_CHANGE

Enabled frozen state, reset on page change

Method Detail

values

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

Returns:

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

valueOf

public static FrozenStateMode 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