com.alee.utils.swing
Enum MouseButton

java.lang.Object
  extended by java.lang.Enum<MouseButton>
      extended by com.alee.utils.swing.MouseButton
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MouseButton>

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

Enumeration representing mouse button types.

Author:
Mikle Garin

Enum Constant Summary
left
           
middle
           
right
           
 
Method Summary
static MouseButton get(int code)
          Returns mouse button type for the specified mouse button code.
static MouseButton get(java.awt.event.MouseEvent event)
          Returns mouse button type used within specified mouse event.
 int getCode()
          Returns mouse button code.
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

left

public static final MouseButton left

middle

public static final MouseButton middle

right

public static final MouseButton right
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

getCode

public int getCode()
Returns mouse button code.

Returns:
mouse button code

get

public static MouseButton get(java.awt.event.MouseEvent event)
Returns mouse button type used within specified mouse event.

Parameters:
event - mouse event
Returns:
mouse button type used within specified mouse event

get

public static MouseButton get(int code)
Returns mouse button type for the specified mouse button code.

Parameters:
code - mouse button code
Returns:
mouse button type for the specified mouse button code