Package com.ardor3d.input

Enum Class MouseButton

java.lang.Object

java.lang.Enum<MouseButton>

com.ardor3d.input.MouseButton

All Implemented Interfaces:

Serializable, Comparable<MouseButton>, Constable

public enum MouseButton
extends Enum<MouseButton>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EIGHT
FIVE
FOUR
LEFT
MIDDLE
NINE
RIGHT
SEVEN
SIX

Method Summary

Modifier and Type	Method	Description
static EnumMap<MouseButton,ButtonState>	makeMap(ButtonState left, ButtonState right, ButtonState middle)
static EnumMap<MouseButton,ButtonState>	makeMap(ButtonState left, ButtonState right, ButtonState middle, ButtonState four, ButtonState five, ButtonState six, ButtonState seven, ButtonState eight, ButtonState nine)
static MouseButton	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MouseButton[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT

public static final MouseButton LEFT

RIGHT

public static final MouseButton RIGHT

MIDDLE

public static final MouseButton MIDDLE

FOUR

public static final MouseButton FOUR

FIVE

public static final MouseButton FIVE

SIX

public static final MouseButton SIX

SEVEN

public static final MouseButton SEVEN

EIGHT

public static final MouseButton EIGHT

NINE

public static final MouseButton NINE

Method Details

values

public static MouseButton[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MouseButton valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

makeMap

public static EnumMap<MouseButton,ButtonState> makeMap(ButtonState left,
 ButtonState right,
 ButtonState middle)

makeMap

public static EnumMap<MouseButton,ButtonState> makeMap(ButtonState left,
 ButtonState right,
 ButtonState middle,
 ButtonState four,
 ButtonState five,
 ButtonState six,
 ButtonState seven,
 ButtonState eight,
 ButtonState nine)