org.cell2d.control

Class MouseButtonControl

java.lang.Object

org.cell2d.control.Control

org.cell2d.control.MouseButtonControl

public class MouseButtonControl
extends Control

A MouseButtonControl is a Control that represents a button on the mouse. The button is specified by an integer button code that is equal to one of the MOUSE_ constants of the MouseButtonControl class. All other integers are invalid as button codes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MOUSE_LEFT_BUTTON
static int	MOUSE_MIDDLE_BUTTON
static int	MOUSE_RIGHT_BUTTON

Constructor Summary

Constructors

Constructor and Description
MouseButtonControl(int buttonCode) Constructs a MouseButtonControl that represents the mouse button with the specified button code.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns whether the specified object is a MouseButtonControl that is equal to this MouseButtonControl.
int	getButtonCode() Returns this MouseButtonControl's button code.
java.lang.String	getName() Returns a short, descriptive, and unique String name for this Control.
int	hashCode()

Methods inherited from class org.cell2d.control.Control

getControl

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

MOUSE_LEFT_BUTTON

public static final int MOUSE_LEFT_BUTTON

See Also:

Constant Field Values

MOUSE_RIGHT_BUTTON

public static final int MOUSE_RIGHT_BUTTON

See Also:

Constant Field Values

MOUSE_MIDDLE_BUTTON

public static final int MOUSE_MIDDLE_BUTTON

See Also:

Constant Field Values

Constructor Detail

MouseButtonControl

public MouseButtonControl(int buttonCode)
                   throws InvalidControlException

Constructs a MouseButtonControl that represents the mouse button with the specified button code.

Parameters:

buttonCode - This MouseButtonControl's button code

Throws:

InvalidControlException - if the button code is invalid

Method Detail

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Returns whether the specified object is a MouseButtonControl that is equal to this MouseButtonControl. Two MouseButtonControls are equal if and only if they represent the same button.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to be compared with this MouseButtonControl

Returns:

Whether the specified object is a MouseButtonControl that is equal to this MouseButtonControl

getName

public java.lang.String getName()

Description copied from class: Control

Returns a short, descriptive, and unique String name for this Control. The name will be no more than 6 characters long and contain only ASCII characters and no whitespace. Two distinct Control objects have the same name if and only if they are equal.

Specified by:

getName in class Control

Returns:

This Control's name

getButtonCode

public final int getButtonCode()

Returns this MouseButtonControl's button code.

Returns:

This MouseButtonControl's button code