fr.lri.swingstates.sm.transitions

Class Wheel

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

public class Wheel
extends MouseOnPosition

A transition triggered by a mouse wheel event with no button pressed.

Author:

Caroline Appert

Constructor Summary

Constructors

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

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

Wheel

public Wheel()

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

Wheel

public Wheel(int m)

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

Parameters:

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

Wheel

public Wheel(java.lang.String outState)

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

Parameters:

outState - The name of the output state

Wheel

public Wheel(int m,
     java.lang.String outState)

Builds a transition triggered by a mouse wheel event.

Parameters:

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

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 MouseOnPosition

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.