jpen.internal.filter

Enum RelativeLocationFilter.State

java.lang.Object

java.lang.Enum<RelativeLocationFilter.State>

jpen.internal.filter.RelativeLocationFilter.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RelativeLocationFilter.State>

Enclosing class:

RelativeLocationFilter

public static enum RelativeLocationFilter.State
extends java.lang.Enum<RelativeLocationFilter.State>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE The filter considers the sample values to be in absolute mode.
OFF The filter does nothing.
RELATIVE The filter considers the sample values to be in relative mode and replace them with the reference (mouse pointer info).
UNDEFINED The filter tries to see if the values are absolute or relative and sets the state if possible.

Method Summary

Modifier and Type	Method and Description
static RelativeLocationFilter.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RelativeLocationFilter.State[]	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

UNDEFINED

public static final RelativeLocationFilter.State UNDEFINED

The filter tries to see if the values are absolute or relative and sets the state if possible.

ABSOLUTE

public static final RelativeLocationFilter.State ABSOLUTE

The filter considers the sample values to be in absolute mode.

RELATIVE

public static final RelativeLocationFilter.State RELATIVE

The filter considers the sample values to be in relative mode and replace them with the reference (mouse pointer info).

OFF

public static final RelativeLocationFilter.State OFF

The filter does nothing. This state is used when there is not mouse pointer info available on the system.

Method Detail

values

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

Returns:

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

valueOf

public static RelativeLocationFilter.State valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null