fr.lri.swingstates.sm.transitions

Class Click

java.lang.Object

fr.lri.swingstates.sm.Transition

fr.lri.swingstates.sm.transitions.Event

fr.lri.swingstates.sm.transitions.EventOnPosition

fr.lri.swingstates.sm.transitions.MouseOnPosition

fr.lri.swingstates.sm.transitions.Click

public class Click
extends MouseOnPosition

A transition triggered by a mouse clicked event. A click is defined as a quick succession of mouse press and mouse release, without significant motion in between. Note that the mouse press and mouse release events are always sent, even when a mouse click event is sent.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
Click() Builds a transition triggered by a mouse clicked event with any modifier and any button that loops on the current state.
Click(int b) Builds a transition triggered by a mouse clicked event with any modifier that loops on the current state.
Click(int b, int m) Builds a transition triggered by a mouse clicked event that loops on the current state.
Click(int b, int m, java.lang.String outState) Builds a transition triggered by a mouse clicked event.
Click(int b, java.lang.String outState) Builds a transition with any modifier triggered by a mouse clicked event.
Click(java.lang.String outState) Builds a transition triggered by a mouse clicked event with any modifier and any button.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(java.util.EventObject eventObject) Tests if an event can trigger that transition.

Methods inherited from class fr.lri.swingstates.sm.transitions.MouseOnPosition

getButton, getInputEvent, getModifier, getMouseEvent, getPoint, toString

Methods inherited from class fr.lri.swingstates.sm.transitions.Event

getClassEvent

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Click

public Click(java.lang.String outState)

Builds a transition triggered by a mouse clicked event with any modifier and any button.

Parameters:

outState - The name of the output state

Click

public Click()

Builds a transition triggered by a mouse clicked event with any modifier and any button that loops on the current state.

Click

public Click(int b)

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

Parameters:

b - The button of the mouse event: BasicInputStateMachine.NOBUTTON, BUTTON1, BUTTON2 or BUTTON3

Click

public Click(int b,
     int m)

Builds a transition triggered by a mouse clicked event that loops on the current state.

Parameters:

b - The button of the mouse event: BasicInputStateMachine.NOBUTTON, BUTTON1, BUTTON2 or BUTTON3

m - The modifier: NOMODIFIER, CONTROL, ALT, SHIFT, ALT_CONTROL, CONTROL_SHIFT, ALT_SHIFT or ALT_CONTROL_SHIFT

Click

public Click(int b,
     java.lang.String outState)

Builds a transition with any modifier triggered by a mouse clicked event.

Parameters:

b - The button of the mouse event: BasicInputStateMachine.NOBUTTON, BUTTON1, BUTTON2 or BUTTON3

outState - The name of the output state

Click

public Click(int b,
     int m,
     java.lang.String outState)

Builds a transition triggered by a mouse clicked event.

Parameters:

b - The button of the mouse event: BasicInputStateMachine.NOBUTTON, BUTTON1, BUTTON2 or BUTTON3

m - The modifier: NOMODIFIER, CONTROL, ALT, SHIFT, ALT_CONTROL, CONTROL_SHIFT, ALT_SHIFT or ALT_CONTROL_SHIFT

outState - The name of the output state

Method Detail

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class MouseOnPosition

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.