fr.lri.swingstates.sm.jtransitions

Class MouseOnJTag

java.lang.Object

fr.lri.swingstates.sm.Transition

fr.lri.swingstates.sm.transitions.Event

fr.lri.swingstates.sm.transitions.EventOnPosition

fr.lri.swingstates.sm.EventOnComponent

fr.lri.swingstates.sm.jtransitions.EventOnJTag

fr.lri.swingstates.sm.jtransitions.MouseOnJTag

Direct Known Subclasses:

ClickOnJTag, DragOnJTag, EnterOnJTag, LeaveOnJTag, MoveOnJTag, PressOnJTag, ReleaseOnJTag, WheelOnJTag

public class MouseOnJTag
extends EventOnJTag

A transition triggered by a mouse event on a tagged component. 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
MouseOnJTag(java.lang.Class tagClass, int button) Builds a mouse transition with no modifier on tagged component that loops on the current state.
MouseOnJTag(java.lang.Class tagClass, int button, int modifier) Builds a mouse transition on tagged component that loops on the current state.
MouseOnJTag(java.lang.Class tagClass, int button, int modifier, java.lang.String outState) Builds a mouse transition on tagged component.
MouseOnJTag(java.lang.Class tagClass, int button, java.lang.String outState) Builds a mouse transition with no modifier on tagged component.
MouseOnJTag(JTag tag, int button) Builds a mouse transition with no modifier on tagged component that loops on the current state.
MouseOnJTag(JTag tag, int button, int modifier) Builds a mouse transition on tagged component that loops on the current state.
MouseOnJTag(JTag tag, int button, int modifier, java.lang.String outState) Builds a mouse transition on tagged component.
MouseOnJTag(JTag tag, int button, java.lang.String outState) Builds a mouse transition with no modifier on tagged component.
MouseOnJTag(java.lang.String tagName, int button) Builds a mouse transition with no modifier on tagged component that loops on the current state.
MouseOnJTag(java.lang.String tagName, int button, int modifier) Builds a mouse transition on tagged component that loops on the current state.
MouseOnJTag(java.lang.String tagName, int button, int modifier, java.lang.String outState) Builds a mouse transition on tagged component.
MouseOnJTag(java.lang.String tagName, int button, java.lang.String outState) Builds a mouse transition with no modifier on tagged component.

Method Summary

Methods

Modifier and Type	Method and Description
int	getButton() Returns the button of the mouse event that fires this transition.
java.awt.Component	getComponent() Returns the component on which the mouse event firing this transition has occured.
java.awt.geom.Point2D	getPoint() Returns the location at which this transition has occured.
java.lang.String	toString()

Methods inherited from class fr.lri.swingstates.sm.jtransitions.EventOnJTag

getTag, getTagName, matches

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

getPointInComponent

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

MouseOnJTag

public MouseOnJTag(JTag tag,
           int button,
           int modifier,
           java.lang.String outState)

Builds a mouse transition on tagged component.

Parameters:

tag - The tag

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

outState - The name of the output state

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

MouseOnJTag

public MouseOnJTag(JTag tag,
           int button,
           int modifier)

Builds a mouse transition on tagged component that loops on the current state.

Parameters:

tag - The tag

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

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

MouseOnJTag

public MouseOnJTag(JTag tag,
           int button,
           java.lang.String outState)

Builds a mouse transition with no modifier on tagged component.

Parameters:

tag - The tag

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

outState - The name of the output state

MouseOnJTag

public MouseOnJTag(JTag tag,
           int button)

Builds a mouse transition with no modifier on tagged component that loops on the current state.

Parameters:

tag - The tag

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

MouseOnJTag

public MouseOnJTag(java.lang.String tagName,
           int button,
           int modifier,
           java.lang.String outState)

Builds a mouse transition on tagged component.

Parameters:

tagName - The name of the tag

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

outState - The name of the output state

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

MouseOnJTag

public MouseOnJTag(java.lang.String tagName,
           int button,
           int modifier)

Builds a mouse transition on tagged component that loops on the current state.

Parameters:

tagName - The name of the tag

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

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

MouseOnJTag

public MouseOnJTag(java.lang.String tagName,
           int button,
           java.lang.String outState)

Builds a mouse transition with no modifier on tagged component.

Parameters:

tagName - The name of the tag

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

outState - The name of the output state

MouseOnJTag

public MouseOnJTag(java.lang.String tagName,
           int button)

Builds a mouse transition with no modifier on tagged component that loops on the current state.

Parameters:

tagName - The name of the tag

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

MouseOnJTag

public MouseOnJTag(java.lang.Class tagClass,
           int button,
           int modifier,
           java.lang.String outState)

Builds a mouse transition on tagged component.

Parameters:

tagClass - The class of the tag

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

outState - The name of the output state

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

MouseOnJTag

public MouseOnJTag(java.lang.Class tagClass,
           int button,
           int modifier)

Builds a mouse transition on tagged component that loops on the current state.

Parameters:

tagClass - The class of the tag

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

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

MouseOnJTag

public MouseOnJTag(java.lang.Class tagClass,
           int button,
           java.lang.String outState)

Builds a mouse transition with no modifier on tagged component.

Parameters:

tagClass - The class of the tag

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

outState - The name of the output state

MouseOnJTag

public MouseOnJTag(java.lang.Class tagClass,
           int button)

Builds a mouse transition with no modifier on tagged component that loops on the current state.

Parameters:

tagClass - The class of the tag

button - 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).

toString

public java.lang.String toString()

Overrides:

toString in class EventOnJTag

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.

getComponent

public java.awt.Component getComponent()

Returns the component on which the mouse event firing this transition has occured.

Overrides:

getComponent in class EventOnComponent

Returns:

the JComponent on which the mouse event firing this transition has occured.