com.goldencode.p2j.ui.client.driver

Class KeyCode

java.lang.Object

com.goldencode.p2j.ui.client.driver.KeyCode

public class KeyCode
extends java.lang.Object

Holds key code and extended key state.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALT_BIT_MASK Extended key state bit masks
int	code Key code value
static int	CTRL_BIT_MASK
static int	META_BIT_MASK
static int	RELEASED_BIT_MASK
static int	SHIFT_BIT_MASK
int	state Extended key state

Constructor Summary

Constructors

Constructor and Description
KeyCode(int code) Constructor.
KeyCode(int code, boolean alt, boolean ctrl, boolean shift, boolean meta) Constructor.
KeyCode(int code, boolean alt, boolean ctrl, boolean shift, boolean meta, boolean released) Constructor.
KeyCode(int code, int state) Constructor.

Method Summary

Modifier and Type	Method and Description
static boolean	isAlt(int state) Returns the Alt key state based on the supplied extended key state value.
static boolean	isCtrl(int state) Returns the Ctrl key state based on the supplied extended key state value.
static boolean	isMeta(int state) Returns the Meta key state based on the supplied extended key state value.
static boolean	isReleased(int state) Returns the Released key state based on the supplied extended key state value.
static boolean	isShift(int state) Returns the Shift key state based on the supplied extended key state value.
static int	keyState(boolean alt, boolean ctrl, boolean shift, boolean meta, boolean released) Build key state value from the supplied key states.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALT_BIT_MASK

public static final int ALT_BIT_MASK

Extended key state bit masks

See Also:

Constant Field Values

CTRL_BIT_MASK

public static final int CTRL_BIT_MASK

See Also:

Constant Field Values

SHIFT_BIT_MASK

public static final int SHIFT_BIT_MASK

See Also:

Constant Field Values

META_BIT_MASK

public static final int META_BIT_MASK

See Also:

Constant Field Values

RELEASED_BIT_MASK

public static final int RELEASED_BIT_MASK

See Also:

Constant Field Values

code

public int code

Key code value

state

public int state

Extended key state

Constructor Detail

KeyCode

public KeyCode(int code)

Constructor.

Parameters:

code - Key code value.

KeyCode

public KeyCode(int code,
               int state)

Constructor.

Parameters:

code - Key code value.

state - Extended key state. See ALT_BIT_MASK, CTRL_BIT_MASK, SHIFT_BIT_MASK, META_BIT_MASK for the expected bit.

KeyCode

public KeyCode(int code,
               boolean alt,
               boolean ctrl,
               boolean shift,
               boolean meta)

Constructor.

Parameters:

code - Key code value.

alt - The expected Alt key state, true for down, false for up.

ctrl - The expected Ctrl key state, true for down, false for up.

shift - The expected Shift key state, true for down, false for up.

meta - The expected Meta key state, true for down, false for up.

KeyCode

public KeyCode(int code,
               boolean alt,
               boolean ctrl,
               boolean shift,
               boolean meta,
               boolean released)

Constructor.

Parameters:

code - Key code value.

alt - The expected Alt key state, true for down, false for up.

ctrl - The expected Ctrl key state, true for down, false for up.

shift - The expected Shift key state, true for down, false for up.

meta - The expected Meta key state, true for down, false for up.

released - The expected Released key state, true if code generated by a key release, false otherwise.

Method Detail

isAlt

public static boolean isAlt(int state)

Returns the Alt key state based on the supplied extended key state value.

Parameters:

state - Extended key state value.

Returns:

true for key down, false for key up.

isCtrl

public static boolean isCtrl(int state)

Returns the Ctrl key state based on the supplied extended key state value.

Parameters:

state - Extended key state value.

Returns:

true for key down, false for key up.

isShift

public static boolean isShift(int state)

Returns the Shift key state based on the supplied extended key state value.

Parameters:

state - Extended key state value.

Returns:

true for key down, false for key up.

isMeta

public static boolean isMeta(int state)

Returns the Meta key state based on the supplied extended key state value.

Parameters:

state - Extended key state value.

Returns:

true for key down, false for key up.

isReleased

public static boolean isReleased(int state)

Returns the Released key state based on the supplied extended key state value.

Parameters:

state - Extended key state value.

Returns:

true for released keys, false otherwise.

keyState

public static int keyState(boolean alt,
                           boolean ctrl,
                           boolean shift,
                           boolean meta,
                           boolean released)

Build key state value from the supplied key states.

Parameters:

alt - Alt key state, true for key down, false for key up.

ctrl - Ctrk key state, true for key down, false for key up.

shift - Shift key state, true for key down, false for key up.

meta - Meta key state, true for key down, false for key up.

Returns:

key state value

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.