org.fujion.event

Enum MouseEvent.MouseButton

java.lang.Object

java.lang.Enum<MouseEvent.MouseButton>

org.fujion.event.MouseEvent.MouseButton

All Implemented Interfaces:

Serializable, Comparable<MouseEvent.MouseButton>

Enclosing class:

MouseEvent

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

Mouse button specifier.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT The left mouse button was depressed.
MIDDLE The middle mouse button was depressed.
RIGHT The right mouse button was depressed.
UNSPECIFIED The mouse button could not be determined.

Method Summary

Modifier and Type	Method and Description
static MouseEvent.MouseButton	valueOf(String name) Returns the enum constant of this type with the specified name.
static MouseEvent.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

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

UNSPECIFIED

public static final MouseEvent.MouseButton UNSPECIFIED

The mouse button could not be determined.

LEFT

public static final MouseEvent.MouseButton LEFT

The left mouse button was depressed.

MIDDLE

public static final MouseEvent.MouseButton MIDDLE

The middle mouse button was depressed.

RIGHT

public static final MouseEvent.MouseButton RIGHT

The right mouse button was depressed.

Method Detail

values

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

Returns:

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

valueOf

public static MouseEvent.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