com.swath.event

Class HotKeyPressed

java.lang.Object

com.swath.event.HotKeyPressed

All Implemented Interfaces:

EventIfc

public final class HotKeyPressed
extends java.lang.Object

The HotKeyPressed event.
Posted: When a hot key is pressed.

Since:

SWATH 1.7

See Also:

HotKeyReleased

Field Summary

Fields

Modifier and Type	Field and Description
static int	MOD_FLAG_ALT The ALT modifier flag.
static int	MOD_FLAG_CTRL The CTRL modifier flag.
static int	MOD_FLAG_SHIFT The SHIFT modifier flag.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Gets the event class name.
int	getKey() Gets the key that was pressed.
int	getModifiers() Gets the key modifiers that were in use.
boolean	isEventClass(java.lang.Class eventClass) Indicates if this event matches a given event class.
boolean	isUserDefined() Indicates if this event is user defined or not.

Methods inherited from class java.lang.Object

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

Field Detail

MOD_FLAG_SHIFT

public static final int MOD_FLAG_SHIFT

The SHIFT modifier flag.

See Also:

Constant Field Values

MOD_FLAG_CTRL

public static final int MOD_FLAG_CTRL

The CTRL modifier flag.

See Also:

Constant Field Values

MOD_FLAG_ALT

public static final int MOD_FLAG_ALT

The ALT modifier flag.

See Also:

Constant Field Values

Method Detail

getKey

public int getKey()

Gets the key that was pressed.

Returns:

The key character.

Since:

SWATH 1.7

getModifiers

public int getModifiers()

Gets the key modifiers that were in use. The modifier flags are combined with logical OR.

Returns:

The modifier flags or 0 if none.

Since:

SWATH 1.7

See Also:

MOD_FLAG_SHIFT, MOD_FLAG_CTRL, MOD_FLAG_ALT

isEventClass

public final boolean isEventClass(java.lang.Class eventClass)

Description copied from interface: EventIfc

Indicates if this event matches a given event class.

Specified by:

isEventClass in interface EventIfc

Parameters:

eventClass - The event class.

Returns:

true if this event is of the same class, otherwise false.

isUserDefined

public final boolean isUserDefined()

Description copied from interface: EventIfc

Indicates if this event is user defined or not.

Specified by:

isUserDefined in interface EventIfc

Returns:

true if user defined, otherwise false.

getClassName

public final java.lang.String getClassName()

Description copied from interface: EventIfc

Gets the event class name.

Specified by:

getClassName in interface EventIfc

Returns:

The class name.