fr.lri.swingstates.sm.jtransitions

Class EventOnJTag

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

Direct Known Subclasses:

MouseOnJTag

public abstract class EventOnJTag
extends EventOnComponent

A transition triggered on a tagged component. OnTag transitions allow developpers to retrieve the component and the tag where this transition has been fired:

  Class ColorTag extends JNamedTag {
                Color color;
                public ColorTag(String tagName, Color c) {
                        super(n);
                }
  }
  ...
  JButton button1 = new JButton("button1");
  JButton button2 = new JButton("button2");
  JCheckbox cb = new JCheckbox("checkbox");
  ColorTag red = new ColorTag("red", Color.RED);
  red.addTo(button1).addTo(cb);
  ColorTag green = new ColorTag("green", Color.GREEN);
  green.addTo(button2);
  

• Transitions can be marked by a tag:

    // The transition is triggered when an event occurs on button1 or on cb.
          Transition t = new EventOnTag (red, BUTTON1) {
                  public void action() {
                          ...
                          // set the background color of button1 and cb.
                          getTag().setBackground(Color.RED);
                          // print the text of the tooltip of the component on which this transition has been triggered (button1 OR cb)
                          System.out.println(getComponent().getToolTipText());
                  }
          }
   

• Transitions can be marked by a class of tag:

    // The transition is triggered when an event occurs on button1, button2 or on cb (any component tagged by an instance of ColorTag).
          Transition t = new EventOnTag (ColorTag.class, BUTTON1) {
                  public void action() {
                          ...
                          getComponent().setBackground(((ColorTag)getTag()).color));
                          ...
                  }
          }
   

• Transitions can be marked by the name of the tag (if the tag is an instance of a subclass of a JNamedTag):

    // The transition is triggered when an event occurs on ellipse2 (the only component tagged by the instance of ColorTag having the name "green").
          Transition t = new EventOnTag ("green", BUTTON1) {
                  public void action() {
                          ...
                          System.out.println("This component is tagged by the color "+((ColoredTag)getTag()).color);
                          ...
                  }
          }
   

Note that each component is tagged by the name of the class of the component. For instance, one can retrieve any press on any JButton:

   Transition pressOnButton = new PressOnTag(BUTTON1, "javax.swing.JButton") { ... };
 

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
EventOnJTag(java.lang.Class tagClass, java.lang.String keyEvent) Builds a transition with any modifier on a tagged component that loops on the current state.
EventOnJTag(java.lang.Class tagClass, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged component.
EventOnJTag(JTag tag, java.lang.String keyEvent) Builds a transition with any modifier on a tagged component that loops on the current state.
EventOnJTag(JTag tag, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged component.
EventOnJTag(java.lang.String tagName, java.lang.String keyEvent) Builds a transition with any modifier on a tagged component that loops on the current state.
EventOnJTag(java.lang.String tagName, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged component.

Method Summary

Methods

Modifier and Type	Method and Description
JTag	getTag() Returns the tag instance attached to the JComponent on which the mouse event firing this transition has occured.
java.lang.String	getTagName() Returns the name of the tag attached to the component on which the mouse event firing this transition has occured.
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.EventOnComponent

getComponent, getPointInComponent

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

EventOnJTag

public EventOnJTag(JTag tag,
           java.lang.String keyEvent)

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

Parameters:

tag - The tag

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

EventOnJTag

public EventOnJTag(java.lang.Class tagClass,
           java.lang.String keyEvent)

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

Parameters:

tagClass - The class of the tag

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

EventOnJTag

public EventOnJTag(java.lang.String tagName,
           java.lang.String keyEvent)

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

Parameters:

tagName - The name of the tag

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

EventOnJTag

public EventOnJTag(java.lang.String tagName,
           java.lang.String keyEvent,
           java.lang.String outState)

Builds a transition with any modifier on a tagged component.

Parameters:

tagName - The name of the tag

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

outState - The name of the output state

EventOnJTag

public EventOnJTag(java.lang.Class tagClass,
           java.lang.String keyEvent,
           java.lang.String outState)

Builds a transition with any modifier on a tagged component.

Parameters:

tagClass - The class of the tag

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

outState - The name of the output state

EventOnJTag

public EventOnJTag(JTag tag,
           java.lang.String keyEvent,
           java.lang.String outState)

Builds a transition with any modifier on a tagged component.

Parameters:

tag - The tag

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

outState - The name of the output state

Method Detail

getTagName

public java.lang.String getTagName()

Returns the name of the tag attached to the component on which the mouse event firing this transition has occured.

Returns:

name of the tag.

getTag

public JTag getTag()

Returns the tag instance attached to the JComponent on which the mouse event firing this transition has occured.

Returns:

the tag instance.

toString

public java.lang.String toString()

Overrides:

toString in class EventOnComponent

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class EventOnComponent

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.