org.openbp.jaspira.event
Class KeySequenceEvent

java.lang.Object
  java.util.EventObject
      org.openbp.jaspira.event.JaspiraEvent
          org.openbp.jaspira.event.KeySequenceEvent

All Implemented Interfaces:

java.io.Serializable

public class KeySequenceEvent
extends JaspiraEvent

Special event that is passed when a key sequence has been recognized.

Author:

Stephan Moritz

See Also:

Serialized Form

Field Summary

static java.lang.String

KEYEVENTNAME Keystroke event name.

Fields inherited from class org.openbp.jaspira.event.JaspiraEvent

CONSUMED, HANDELED, STACKABLE, TYPE_BOTTOM_UP, TYPE_DIRECT, TYPE_FLOOD, TYPE_GLOBAL, UNCONSUMABLE

Fields inherited from class java.util.EventObject

source

Constructor Summary

KeySequenceEvent(Plugin source, KeySequence sequence, int type)
Constructor.

Method Summary

KeySequence

getKeySequence() Returns the KeySequence associated with this event.

Methods inherited from class org.openbp.jaspira.event.JaspiraEvent

brand, getBrand, getEventGroup, getEventName, getFlags, getLevel, getObject, getOriginalEvent, getSourcePlugin, getTargetClassName, getTargetPluginId, getType, isConsumed, isStackable, isUnconsumable, setObject, setTargetClassName, setTargetPluginId, toString, updateFlags, updateFlags

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

KEYEVENTNAME

public static final java.lang.String KEYEVENTNAME

Keystroke event name.

See Also:

Constant Field Values

Constructor Detail

KeySequenceEvent

public KeySequenceEvent(Plugin source,
                        KeySequence sequence,
                        int type)

Constructor.

Parameters:

source - The plugin that dispatches this event. Must not be null. Will be converted to lower case.

sequence - The key sequence to be processed

type - The type of the event (i\.e\. the mode of passing the event).

Method Detail

getKeySequence

public KeySequence getKeySequence()

Returns the KeySequence associated with this event.