fr.lri.swingstates.sm.transitions

Class KeyTransition

java.lang.Object

fr.lri.swingstates.sm.Transition

fr.lri.swingstates.sm.transitions.KeyTransition

Direct Known Subclasses:

KeyPress, KeyRelease, KeyType

public abstract class KeyTransition
extends Transition

A transition triggered by a key event. Keys can be specified either by the ASCII character they represent or by their keycode.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
KeyTransition() Builds a transition triggered by a key event with any modifier that loops on the current state.
KeyTransition(char character) Builds a transition triggered by a key event with any modifier that loops on the current state.
KeyTransition(char character, java.lang.String outState) Builds a transition triggered by a key event with any modifier.
KeyTransition(int keyCode) Builds a transition triggered by a key event with any modifier that loops on the current state.
KeyTransition(int keyCode, java.lang.String outState) Builds a transition triggered by a key event with any modifier.
KeyTransition(java.lang.String outState) Builds a transition triggered by a key event with any modifier.

Method Summary

Methods

Modifier and Type	Method and Description
char	getChar() Returns the character associated with the key event that triggers this transition.
java.awt.event.InputEvent	getInputEvent()
int	getKeyCode()
void	setChar(char character) Sets the character associated with the key event that triggers this transition.
void	setKeyCode(int keyCode)
java.lang.String	toString()

Methods inherited from class fr.lri.swingstates.sm.Transition

action, getEvent, getInputState, getOutputState, guard, manageEventID, matches, oldToString, pickingRequired, setTriggeringEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyTransition

public KeyTransition(java.lang.String outState)

Builds a transition triggered by a key event with any modifier.

Parameters:

outState - The name of the output state

KeyTransition

public KeyTransition()

Builds a transition triggered by a key event with any modifier that loops on the current state.

KeyTransition

public KeyTransition(char character,
             java.lang.String outState)

Builds a transition triggered by a key event with any modifier.

Parameters:

character - The char corresponding to the key event

outState - The name of the output state

KeyTransition

public KeyTransition(int keyCode,
             java.lang.String outState)

Builds a transition triggered by a key event with any modifier.

Parameters:

keyCode - The key code (ASCII) corresponding to the key event

outState - The name of the output state

KeyTransition

public KeyTransition(char character)

Builds a transition triggered by a key event with any modifier that loops on the current state.

Parameters:

character - The char corresponding to the key event

KeyTransition

public KeyTransition(int keyCode)

Builds a transition triggered by a key event with any modifier that loops on the current state.

Parameters:

keyCode - The key code (ASCII) corresponding to the key event

Method Detail

setChar

public void setChar(char character)

Sets the character associated with the key event that triggers this transition.

Parameters:

character - The character

getChar

public char getChar()

Returns the character associated with the key event that triggers this transition.

Returns:

the character associated with the key event that triggers this transition

setKeyCode

public void setKeyCode(int keyCode)

Parameters:

keyCode - The key code (ASCII) to associate to the key event that initiates this transition

getKeyCode

public int getKeyCode()

Returns:

the key code (ASCII) associating to the key event that initiates this transition

getInputEvent

public java.awt.event.InputEvent getInputEvent()

Returns:

the awt mouse event that fires this transition.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object