fr.lri.swingstates.sm.jtransitions

Class WheelOnJTag

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

fr.lri.swingstates.sm.jtransitions.WheelOnJTag

public class WheelOnJTag
extends MouseOnJTag

A transition triggered by a mouse wheel event with no button pressed on a component with a given tag.

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
WheelOnJTag(java.lang.Class tagClass) Builds a transition triggered by a mouse wheel event with any modifier on a tagged component that loops on the current state.
WheelOnJTag(java.lang.Class tagClass, int modifier) Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.
WheelOnJTag(java.lang.Class tagClass, int modifier, java.lang.String outState) Builds a transition triggered by a mouse wheel event on a tagged component.
WheelOnJTag(java.lang.Class tagClass, java.lang.String outState) Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.
WheelOnJTag(JTag tag) Builds a transition triggered by a mouse wheel event with any modifier on a tagged component that loops on the current state.
WheelOnJTag(JTag tag, int modifier) Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.
WheelOnJTag(JTag tag, int modifier, java.lang.String outState) Builds a transition triggered by a mouse wheel event on a tagged component.
WheelOnJTag(JTag tag, java.lang.String outState) Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.
WheelOnJTag(java.lang.String tagName) Builds a transition triggered by a mouse motion event with any modifier on a tagged component that loops on the current state.
WheelOnJTag(java.lang.String tagName, int modifier) Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.
WheelOnJTag(java.lang.String tagName, int modifier, java.lang.String outState) Builds a transition triggered by a mouse wheel event on a tagged component.
WheelOnJTag(java.lang.String tagName, java.lang.String outState) Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.

Method Summary

Methods

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

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

getButton, getComponent, getPoint, toString

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

getTag, getTagName

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

WheelOnJTag

public WheelOnJTag(java.lang.String tagName)

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

Parameters:

tagName - The name of the tag

WheelOnJTag

public WheelOnJTag(java.lang.Class tagClass)

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

Parameters:

tagClass - The class of the tag

WheelOnJTag

public WheelOnJTag(JTag tag)

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

Parameters:

tag - The tag

WheelOnJTag

public WheelOnJTag(java.lang.String tagName,
           int modifier)

Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.

Parameters:

tagName - The name of the tag

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

WheelOnJTag

public WheelOnJTag(java.lang.Class tagClass,
           int modifier)

Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.

Parameters:

tagClass - The class of the tag

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

WheelOnJTag

public WheelOnJTag(JTag tag,
           int modifier)

Builds a transition triggered by a mouse wheel event on a tagged component that loops on the current state.

Parameters:

tag - The tag

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

WheelOnJTag

public WheelOnJTag(java.lang.String tagName,
           java.lang.String outState)

Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.

Parameters:

tagName - The name of the tag

outState - The name of the output state

WheelOnJTag

public WheelOnJTag(java.lang.Class tagClass,
           java.lang.String outState)

Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.

Parameters:

tagClass - The class of the tag

outState - The name of the output state

WheelOnJTag

public WheelOnJTag(JTag tag,
           java.lang.String outState)

Builds a transition triggered by a mouse wheel event with any modifier on a tagged component.

Parameters:

tag - The tag

outState - The name of the output state

WheelOnJTag

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

Builds a transition triggered by a mouse wheel event on a tagged component.

Parameters:

tagName - The name of the tag

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

outState - The name of the output state

WheelOnJTag

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

Builds a transition triggered by a mouse wheel event on a tagged component.

Parameters:

tagClass - The class of the tag

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

outState - The name of the output state

WheelOnJTag

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

Builds a transition triggered by a mouse wheel event on a tagged component.

Parameters:

tag - The tag

modifier - 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

getScrollAmount

public int getScrollAmount()

Returns:

the number of units that should be scrolled in response to this event.

See Also:

MouseWheelEvent.getScrollAmount()

getScrollType

public int getScrollType()

Returns:

the type of scrolling that should take place in response to this event.

See Also:

MouseWheelEvent.getScrollType()

getUnitsToScroll

public int getUnitsToScroll()

Returns:

This is a convenience method to aid in the implementation of the common-case MouseWheelListener - to scroll a ScrollPane or JScrollPane by an amount which conforms to the platform settings.

See Also:

MouseWheelEvent.getUnitsToScroll()

getWheelRotation

public int getWheelRotation()

Returns:

the number of "clicks" the mouse wheel was rotated.

See Also:

MouseWheelEvent.getWheelRotation()

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class EventOnJTag

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.