net.petterroea.starterkit
Enum Input.MouseBtn

java.lang.Object
  java.lang.Enum<Input.MouseBtn>
      net.petterroea.starterkit.Input.MouseBtn

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Input.MouseBtn>

Enclosing class:

Input

public static enum Input.MouseBtn
extends java.lang.Enum<Input.MouseBtn>

An enum to make it easier to understand mouse buttons

Author:

petterroea

Enum Constant Summary

LEFT
Left mouse button

MIDDLE
Middle mouse button

NONE
Not a valid mosue button, or nothing

RIGHT
Right mouse button

Method Summary

static Input.MouseBtn	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Input.MouseBtn[]	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 Input.MouseBtn NONE

Not a valid mosue button, or nothing

LEFT

public static final Input.MouseBtn LEFT

Left mouse button

MIDDLE

public static final Input.MouseBtn MIDDLE

Middle mouse button

RIGHT

public static final Input.MouseBtn RIGHT

Right mouse button

Method Detail

values

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

Returns:

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

valueOf

public static Input.MouseBtn 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