javafx.scene.input

Enum MouseButton

java.lang.Object

java.lang.Enum<MouseButton>

javafx.scene.input.MouseButton

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MouseButton>

public enum MouseButton
extends java.lang.Enum<MouseButton>

Mapping for Button Names

Since:

JavaFX 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
MIDDLE Represents middle (button 2) mouse button.
NONE Represents no button.
PRIMARY Represents primary (button 1, usually the left) mouse button.
SECONDARY Represents seconday (button 3, usually the right) mouse button.

Method Summary

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

NONE

public static final MouseButton NONE

Represents no button.

PRIMARY

public static final MouseButton PRIMARY

Represents primary (button 1, usually the left) mouse button.

MIDDLE

public static final MouseButton MIDDLE

Represents middle (button 2) mouse button.

SECONDARY

public static final MouseButton SECONDARY

Represents seconday (button 3, usually the right) mouse button.

Method Detail

values

public static 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 (MouseButton c : 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 MouseButton 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