org.jsfml.window

Enum Mouse.Button

java.lang.Object

java.lang.Enum<Mouse.Button>

org.jsfml.window.Mouse.Button

All Implemented Interfaces:

Serializable, Comparable<Mouse.Button>

Enclosing class:

Mouse

public static enum Mouse.Button
extends Enum<Mouse.Button>

Enumeration of supported mouse buttons.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT The left mouse button.
MIDDLE The middle mouse button, or mouse wheel on many mouses, if available.
RIGHT The right mouse button.
XBUTTON1 The first extra mouse button, if available.
XBUTTON2 The second extra mouse button, if available.

Method Summary

Methods

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

LEFT

public static final Mouse.Button LEFT

The left mouse button.

RIGHT

public static final Mouse.Button RIGHT

The right mouse button.

MIDDLE

public static final Mouse.Button MIDDLE

The middle mouse button, or mouse wheel on many mouses, if available.

XBUTTON1

public static final Mouse.Button XBUTTON1

The first extra mouse button, if available.

XBUTTON2

public static final Mouse.Button XBUTTON2

The second extra mouse button, if available.

Method Detail

values

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

Returns:

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

valueOf

public static Mouse.Button 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