com.teamdev.jxbrowser.dom.event

Enum MouseEvent.Button

java.lang.Object

java.lang.Enum<MouseEvent.Button>

com.teamdev.jxbrowser.dom.event.MouseEvent.Button

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MouseEvent.Button>

Enclosing interface:

MouseEvent

public static enum MouseEvent.Button
extends java.lang.Enum<MouseEvent.Button>

A DOM mouse button.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK A fourth button.
FORWARD A fifth button.
MAIN A main mouse button.
MIDDLE An auxiliary button.
RIGHT A secondary button.

Method Summary

Modifier and Type	Method and Description
int	number() Returns a number of the button.
static MouseEvent.Button	of(int number) Returns the Button instance for the given value.
static MouseEvent.Button	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MouseEvent.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MAIN

public static final MouseEvent.Button MAIN

A main mouse button. Usually the left button or the un-initialized state.

MIDDLE

public static final MouseEvent.Button MIDDLE

An auxiliary button. Usually the wheel button or the middle button (if present).

RIGHT

public static final MouseEvent.Button RIGHT

A secondary button. Usually the right button.

BACK

public static final MouseEvent.Button BACK

A fourth button. Typically the Browser Back button.

FORWARD

public static final MouseEvent.Button FORWARD

A fifth button. Typically the Browser Forward button.

Method Detail

values

public static MouseEvent.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 (MouseEvent.Button c : MouseEvent.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 MouseEvent.Button 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

of

public static MouseEvent.Button of(int number)

Returns the Button instance for the given value.

Throws:

java.lang.IllegalArgumentException - when there is no button associated with the given value

number

public int number()

Returns a number of the button.