fr.lri.swingstates.sm

Class EventOnComponent

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

Direct Known Subclasses:

EventOnJTag, MouseOnComponent

public abstract class EventOnComponent
extends EventOnPosition

A transition triggered on a JComponent. OnComponent transitions allow developpers to retrieve the component where this transition has been fired:

        Transition tcomponent = new EventOnComponent("anEvent") {
                public void action() {
                        // colors in red the component on which the transition has been fired
                        getComponent().setBackground(Color.RED);
                }
        }
 

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
EventOnComponent(java.lang.Class eventClass) Builds a transition on a JComponent with no modifier that loops on the current state.
EventOnComponent(java.lang.Class eventClass, java.lang.String outState) Builds a transition on a component with no modifier.
EventOnComponent(java.lang.String keyEvent) Builds a transition on a JComponent with no modifier that loops on the current state.
EventOnComponent(java.lang.String keyEvent, java.lang.String outState) Builds a transition on a component with no modifier.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Component	getComponent() Returns the component on which the mouse event firing this transition has occured.
java.awt.geom.Point2D	getPointInComponent(java.awt.Component c) Returns the location at which this transition has occured in the coordinate system of a given component.
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.EventOnPosition

getPoint

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

EventOnComponent

public EventOnComponent(java.lang.String keyEvent)

Builds a transition on a JComponent with no modifier that loops on the current state.

Parameters:

keyEvent - The string describing the events for which this transition must be triggered

EventOnComponent

public EventOnComponent(java.lang.String keyEvent,
                java.lang.String outState)

Builds a transition on a component with no modifier.

Parameters:

keyEvent - The string describing the events for which this transition must be triggered

outState - The name of the output state

EventOnComponent

public EventOnComponent(java.lang.Class eventClass)

Builds a transition on a JComponent with no modifier that loops on the current state. This transition can be triggered by any virtual events whose type is a subclass of eventClass.

Parameters:

eventClass - The class of events

EventOnComponent

public EventOnComponent(java.lang.Class eventClass,
                java.lang.String outState)

Builds a transition on a component with no modifier. This transition can be triggered by any virtual events whose type is a subclass of eventClass.

Parameters:

eventClass - The class of events

outState - The name of the output state

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class EventOnPosition

getComponent

public java.awt.Component getComponent()

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

Returns:

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

getPointInComponent

public java.awt.geom.Point2D getPointInComponent(java.awt.Component c)

Returns the location at which this transition has occured in the coordinate system of a given component.

Parameters:

c - the component defining the coordinate system.

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.