fr.lri.swingstates.sm.jtransitions

Class MouseOnComponent

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.MouseOnComponent

Direct Known Subclasses:

ClickOnComponent, DragOnComponent, EnterOnComponent, LeaveOnComponent, MoveOnComponent, PressOnComponent, ReleaseOnComponent, WheelOnComponent

public class MouseOnComponent
extends EventOnComponent

A transition triggered by a mouse event on a 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
MouseOnComponent(int button) Builds a mouse transition with any modifier that loops on the current state.
MouseOnComponent(int button, int modifier) Builds a mouse transition that loops on the current state.
MouseOnComponent(int button, int modifier, java.lang.String outState) Builds a mouse transition.
MouseOnComponent(int button, 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.Component	getComponent() Returns the component on which the mouse event firing this transition has occured.
java.awt.event.InputEvent	getInputEvent()
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.EventOnComponent

getPointInComponent, matches

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

MouseOnComponent

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

Builds a mouse transition.

Parameters:

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

MouseOnComponent

public MouseOnComponent(int button,
                int modifier)

Builds a mouse transition that loops on the current state.

Parameters:

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

MouseOnComponent

public MouseOnComponent(int button,
                java.lang.String outState)

Builds a mouse transition with any modifier.

Parameters:

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

outState - The name of the output state

MouseOnComponent

public MouseOnComponent(int button)

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

Parameters:

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 EventOnComponent

getInputEvent

public java.awt.event.InputEvent getInputEvent()

Returns:

the input 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.

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.