fr.lri.swingstates.canvas.transitions

Class EventOnTag

java.lang.Object

fr.lri.swingstates.sm.Transition

fr.lri.swingstates.sm.transitions.Event

fr.lri.swingstates.sm.transitions.EventOnPosition

fr.lri.swingstates.canvas.transitions.EventOnShape

fr.lri.swingstates.canvas.transitions.EventOnTag

Direct Known Subclasses:

MouseOnTag

public abstract class EventOnTag
extends EventOnShape

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

  class ColorTag extends CNamedTag {
                Color color;
                public ColorTag(String tagName, Color c) {
                        super(n);
                }
  }
  ...
  CShape ellipse1 = canvas.newEllipse(100, 100, 20, 30);
  CShape ellipse2 = canvas.newEllipse(200, 200, 20, 30);
  CShape rectangle = canvas.newRectangle(300, 300, 20, 30);
  ColorTag red = new ColorTag("red", Color.RED);
  red.addTo(ellipse1).addTo(rectangle);
  ColorTag green = new ColorTag("green", Color.GREEN);
  green.addTo(ellipse2);
 

• Transitions can be marked by a tag:

    // The transition is triggered when an event occurs on ellipse1 or on rectangle.
          Transition t = new EventOnTag (red, BUTTON1) {
                  public void action() {
                          ...
                          // scale ellipse1 and rectangle
                          getTag().scaleBy(1.5);
                          // set the transparencyFill of the shape on which this transition has been triggered (ellipse1 OR rectangle)
                          getShape().setTransparency(0.5f);
                  }
          }
   

• Transitions can be marked by a class of tag:

    // The transition is triggered when an event occurs on ellipse1, ellipse2 or on rectangle (any shape tagged by an instance of ColorTag).
          Transition t = new EventOnTag (ColorTag.class, BUTTON1) {
                  public void action() {
                          ...
                          getShape().setFillPaint(((ColorTag)getTag()).color));
                          ...
                  }
          }
   

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

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

Author:

Caroline Appert

Constructor Summary

Constructors

Constructor and Description
EventOnTag(java.lang.Class<? extends CTag> tagClass, java.lang.Class eventClass) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(java.lang.Class<? extends CTag> tgClass, java.lang.Class eventClass, java.lang.String outState) Builds a transition with any modifier on a tagged shape.
EventOnTag(java.lang.Class<? extends CTag> tagClass, java.lang.String keyEvent) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(java.lang.Class<? extends CTag> tagClass, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged shape.
EventOnTag(CTag tag, java.lang.Class eventClass) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(CTag tag, java.lang.Class eventClass, java.lang.String outState) Builds a transition with any modifier on a tagged shape.
EventOnTag(CTag tag, java.lang.String keyEvent) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(CTag tag, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged shape.
EventOnTag(java.lang.String tagName, java.lang.Class eventClass) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(java.lang.String tagName, java.lang.Class eventClass, java.lang.String outState) Builds a transition with any modifier on a tagged shape.
EventOnTag(java.lang.String tagName, java.lang.String keyEvent) Builds a transition with any modifier on a tagged shape that loops on the current state.
EventOnTag(java.lang.String tagName, java.lang.String keyEvent, java.lang.String outState) Builds a transition with any modifier on a tagged shape.

Method Summary

Methods

Modifier and Type	Method and Description
CTag	getTag() Returns the tag instance hold by the CShape on which the mouse event firing this transition has occurred.
java.lang.String	getTagName() Returns the name of the tag hold by the CShape on which the mouse event firing this transition has occurred.
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.canvas.transitions.EventOnShape

getPoint, getShape, pickingRequired

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, setTriggeringEvent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EventOnTag

public EventOnTag(CTag tag,
          java.lang.String keyEvent)

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

Parameters:

tag - The tag

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

EventOnTag

public EventOnTag(java.lang.Class<? extends CTag> tagClass,
          java.lang.String keyEvent)

Builds a transition with any modifier on a tagged shape 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

EventOnTag

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

Builds a transition with any modifier on a tagged shape 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

EventOnTag

public EventOnTag(CTag tag,
          java.lang.Class eventClass)

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

Parameters:

tag - The tag

eventClass - The class of events

EventOnTag

public EventOnTag(java.lang.Class<? extends CTag> tagClass,
          java.lang.Class eventClass)

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

Parameters:

tagClass - The class of the tag

eventClass - The class of events

EventOnTag

public EventOnTag(java.lang.String tagName,
          java.lang.Class eventClass)

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

Parameters:

tagName - The name of the tag

eventClass - The class of events

EventOnTag

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

Builds a transition with any modifier on a tagged shape.

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

EventOnTag

public EventOnTag(java.lang.Class<? extends CTag> tagClass,
          java.lang.String keyEvent,
          java.lang.String outState)

Builds a transition with any modifier on a tagged shape.

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

EventOnTag

public EventOnTag(CTag tag,
          java.lang.String keyEvent,
          java.lang.String outState)

Builds a transition with any modifier on a tagged shape.

Parameters:

tag - The tag

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

outState - The name of the output state

EventOnTag

public EventOnTag(java.lang.String tagName,
          java.lang.Class eventClass,
          java.lang.String outState)

Builds a transition with any modifier on a tagged shape.

Parameters:

tagName - The name of the tag

eventClass - The class of events

outState - The name of the output state

EventOnTag

public EventOnTag(java.lang.Class<? extends CTag> tgClass,
          java.lang.Class eventClass,
          java.lang.String outState)

Builds a transition with any modifier on a tagged shape.

Parameters:

tgClass - The class of the tag

eventClass - The class of events

outState - The name of the output state

EventOnTag

public EventOnTag(CTag tag,
          java.lang.Class eventClass,
          java.lang.String outState)

Builds a transition with any modifier on a tagged shape.

Parameters:

tag - The tag

eventClass - The class of events for which that triggers this transition.

outState - The name of the output state

Method Detail

getTagName

public java.lang.String getTagName()

Returns the name of the tag hold by the CShape on which the mouse event firing this transition has occurred.

Returns:

name of the tag.

getTag

public CTag getTag()

Returns the tag instance hold by the CShape on which the mouse event firing this transition has occurred.

Returns:

the tag instance.

toString

public java.lang.String toString()

Overrides:

toString in class EventOnShape

matches

public boolean matches(java.util.EventObject eventObject)

Tests if an event can trigger that transition.

Overrides:

matches in class EventOnShape

Parameters:

eventObject - The event to test

Returns:

True if the eventObject can trigger this transition.