org.assertj.swing.core

Enum MouseButton

java.lang.Object

java.lang.Enum<MouseButton>

org.assertj.swing.core.MouseButton

All Implemented Interfaces:

Serializable, Comparable<MouseButton>

public enum MouseButton
extends Enum<MouseButton>

Mouse buttons. Provides better type safety that the int values in AWT.

Author:

Alex Ruiz

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT_BUTTON
MIDDLE_BUTTON
RIGHT_BUTTON

Field Summary

Fields

Modifier and Type	Field and Description
int	mask The mouse button modifier.

Method Summary

Methods

Modifier and Type	Method and Description
static MouseButton	lookup(int mask) Returns the mouse button whose mask matches the given mask.
static MouseButton	valueOf(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_BUTTON

public static final MouseButton LEFT_BUTTON

MIDDLE_BUTTON

public static final MouseButton MIDDLE_BUTTON

RIGHT_BUTTON

public static final MouseButton RIGHT_BUTTON

Field Detail

mask

public final int mask

The mouse button modifier.

See Also:

InputEvent

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(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

lookup

@Nonnull
public static MouseButton lookup(int mask)

Returns the mouse button whose mask matches the given mask. Valid values are the constants BUTTON1_MASK, BUTTON2_MASK, and BUTTON3_MASK in java.awt.event.InputEvent.

Parameters:

mask - the mask of the button we are looking for.

Returns:

the found button.

Throws:

IllegalArgumentException - if the given mask is not a valid one.