fr.lri.swingstates.events

Class Utils

java.lang.Object

fr.lri.swingstates.events.Utils

public class Utils
extends java.lang.Object

A class containing utility methods.

Author:

Caroline Appert

Method Summary

Methods

Modifier and Type	Method and Description
static int	button(java.awt.event.InputEvent e) Returns the button of an input mouse event : BasicInputStateMachine.NOBUTTON BasicInputStateMachine.BUTTON1 BasicInputStateMachine.BUTTON2 BasicInputStateMachine.BUTTON3 .
static java.lang.String	getButtonAsText(int button) Returns the text corresponding to a button for toString methods in Transition classes.
static java.lang.String	getModifiersAsText(int modifier) Returns the text corresponding to a modifier for toString methods in Transition classes.
static java.lang.String	getPrefixInputEvent(java.awt.event.KeyEvent e) Returns the string describing this awt key event ("KeyType", "KeyPress" or "KeyRelease").
static java.lang.String	getPrefixInputEvent(java.awt.event.MouseEvent me) Returns the string describing this awt mouse event ("Down", "Move", "Drag", "Release", "Click", "Enter", "Leave" or "Wheel") concatenated with the number of the mouse button (0, 1 or 2).
static int	modifiers(java.awt.event.InputEvent e) Returns the modifier of an input event : BasicInputStateMachine.NOMODIFIER BasicInputStateMachine.ALT BasicInputStateMachine.SHIFT BasicInputStateMachine.CONTROL BasicInputStateMachine.CONTROL_SHIFT BasicInputStateMachine.ALT_CONTROL BasicInputStateMachine.ALT_SHIFT BasicInputStateMachine.ALT_CONTROL_SHIFT .

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPrefixInputEvent

public static java.lang.String getPrefixInputEvent(java.awt.event.KeyEvent e)

Returns the string describing this awt key event ("KeyType", "KeyPress" or "KeyRelease").

Parameters:

e - The awt key event.

Returns:

The string describing this awt key event.

getPrefixInputEvent

public static java.lang.String getPrefixInputEvent(java.awt.event.MouseEvent me)

Returns the string describing this awt mouse event ("Down", "Move", "Drag", "Release", "Click", "Enter", "Leave" or "Wheel") concatenated with the number of the mouse button (0, 1 or 2).

Parameters:

me - The awt mouse event.

Returns:

The string describing this awt mouse event.

modifiers

public static int modifiers(java.awt.event.InputEvent e)

Returns the modifier of an input event :

• BasicInputStateMachine.NOMODIFIER
• BasicInputStateMachine.ALT
• BasicInputStateMachine.SHIFT
• BasicInputStateMachine.CONTROL
• BasicInputStateMachine.CONTROL_SHIFT
• BasicInputStateMachine.ALT_CONTROL
• BasicInputStateMachine.ALT_SHIFT
• BasicInputStateMachine.ALT_CONTROL_SHIFT

.

Parameters:

e - The awt input event.

Returns:

The modifier of the event e.

button

public static int button(java.awt.event.InputEvent e)

Returns the button of an input mouse event :

• BasicInputStateMachine.NOBUTTON
• BasicInputStateMachine.BUTTON1
• BasicInputStateMachine.BUTTON2
• BasicInputStateMachine.BUTTON3

.

Parameters:

e - The awt input event.

Returns:

The button of the event e.

getButtonAsText

public static java.lang.String getButtonAsText(int button)

Returns the text corresponding to a button for toString methods in Transition classes. e.g.

 getButtonAsText(BasicInputStateMachine.BUTTON1)
 

returns "BUTTON1".

Parameters:

button - The button

Returns:

The corresponding text

getModifiersAsText

public static java.lang.String getModifiersAsText(int modifier)

Returns the text corresponding to a modifier for toString methods in Transition classes. e.g.

 getModifiersAsText(BasicInputStateMachine.SHIFT)
 

returns "SHIFT".

Parameters:

modifier - The modifier

Returns:

The corresponding text