ej.fp

Enum MouseListener.MouseButton

java.lang.Object

java.lang.Enum<MouseListener.MouseButton>

ej.fp.MouseListener.MouseButton

All Implemented Interfaces:

Serializable, Comparable<MouseListener.MouseButton>

Enclosing interface:

MouseListener

public static enum MouseListener.MouseButton
extends Enum<MouseListener.MouseButton>

Some mouse events hold a mouse button. This enumeration provides an abstraction of mouse buttons identifiers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST_BUTTON Value for first mouse button; often the left one.
OTHER_BUTTON Value for all others mouse buttons.
SECOND_BUTTON Value for second mouse button; often the middle one.
THIRD_BUTTON Value for third mouse button; often the right one.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIRST_BUTTON

public static final MouseListener.MouseButton FIRST_BUTTON

Value for first mouse button; often the left one.

OTHER_BUTTON

public static final MouseListener.MouseButton OTHER_BUTTON

Value for all others mouse buttons.

SECOND_BUTTON

public static final MouseListener.MouseButton SECOND_BUTTON

Value for second mouse button; often the middle one.

THIRD_BUTTON

public static final MouseListener.MouseButton THIRD_BUTTON

Value for third mouse button; often the right one.

Method Detail

valueOf

public static MouseListener.MouseButton 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

values

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

Returns:

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