fr.lri.swingstates.sm.transitions

Class MouseOnPosition

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

Direct Known Subclasses:

Click, Drag, Enter, Leave, Move, Press, Release, Wheel

public abstract class MouseOnPosition
extends EventOnPosition

A transition triggered by a mouse event on a location. The transition is specified by a button and modifiers. The position of the mouse when the transition fired can be retrieved.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
MouseOnPosition() Builds a mouse transition with any modifier.
MouseOnPosition(int b) Builds a mouse transition with any modifier that loops on the current state.
MouseOnPosition(int b, int m) Builds a mouse transition that loops on the current state.
MouseOnPosition(int b, int m, java.lang.String outState) Builds a mouse transition.
MouseOnPosition(int b, java.lang.String outState) Builds a mouse transition with any modifier.
MouseOnPosition(java.lang.String outState) Builds a mouse transition with any modifier.

Method Summary

Methods

Modifier and Type	Method and Description
int	getButton() Returns the button of the mouse event that fires this transition.
java.awt.event.InputEvent	getInputEvent()
int	getModifier() Returns the modifier of the mouse event that fires this transition.
java.awt.event.MouseEvent	getMouseEvent()
java.awt.geom.Point2D	getPoint() Returns the location at which this transition has occured.
boolean	matches(java.util.EventObject eventObject) Tests if an event can trigger that transition.
java.lang.String	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

MouseOnPosition

public MouseOnPosition(java.lang.String outState)

Builds a mouse transition with any modifier.

Parameters:

outState - The name of the output state

MouseOnPosition

public MouseOnPosition()

Builds a mouse transition with any modifier.

MouseOnPosition

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

Builds a mouse transition.

Parameters:

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

outState - The name of the output state

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

MouseOnPosition

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

Builds a mouse transition with any modifier.

Parameters:

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

outState - The name of the output state

MouseOnPosition

public MouseOnPosition(int b,
               int m)

Builds a mouse transition that loops on the current state.

Parameters:

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

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

MouseOnPosition

public MouseOnPosition(int b)

Builds a mouse transition with any modifier that loops on the current state.

Parameters:

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

Method Detail

getButton

public int getButton()

Returns the button of the mouse event that fires this transition.

Returns:

the button of the mouse event that fires this transition (NOBUTTON, BUTTON1, BUTTON2 or BUTTON3).

getModifier

public int getModifier()

Returns the modifier of the mouse event that fires this transition.

Returns:

the modifier : NOMODIFIER, CONTROL, ALT, SHIFT, ALT_CONTROL, CONTROL_SHIFT, ALT_SHIFT or ALT_CONTROL_SHIFT

toString

public java.lang.String toString()

Overrides:

toString in class EventOnPosition

getInputEvent

public java.awt.event.InputEvent getInputEvent()

Returns:

the awt mouse event that fires this transition.

getMouseEvent

public java.awt.event.MouseEvent getMouseEvent()

Returns:

the awt mouse event that fires this transition.

getPoint

public java.awt.geom.Point2D getPoint()

Returns the location at which this transition has occured.

Overrides:

getPoint in class EventOnPosition

Returns:

the location at which the mouse event firing this transition has occured.

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class EventOnPosition

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.