CTag

java.lang.Object
- fr.lri.swingstates.sm.Tag
- - fr.lri.swingstates.canvas.CTag

All Implemented Interfaces:

CElement, java.util.Iterator

Direct Known Subclasses:

CAndTag, CExtensionalTag, CIntentionalTag, COrTag
```
public abstract class CTag
extends Tag
implements CElement
```
CTags are labels associated to canvas' shapes. The CTag class has most of the methods of the CShape class. Calling one of these CTag's methods calls the CShape method that has the same name on every shape having this tag.

A tag is an object corresponding to a set of CShape shapes that can be browsed (i.e. a collection and an iterator on it). One example is a CNamedTag which is a set of shapes having a given label attached to them. Another example is a CHierarchyTag(CShape s) which is a set composed of s and every shape whose s is an ancestor.

Some tags, CExtensionalTag tags, can be explicitely attached to and detached from a shape, i.e. a shape can be added to or removed from the tag's collection, while others can not. For example, a CNamedTag can while a CHierarchyTag can not (it is added by setting the parent of a CShape).

A tag can be attached to any number of shapes in the same canvas. A shape in the canvas can have any number of tags attached to it.

Tags are used for two main purposes : grouping and interaction.
- In order to create a group of objects in the canvas, one creates a new tag and attaches it to each shape in the group.
- Tags are also used in connection with state machines to describe interaction.
  - For example, if some objects in the canvas can be moved but not others, one creates a tag called, say, movable and attaches it to those shapes that can be moved. Then, in the canvas' state machine, one can specify transitions such as ClickOnTag(BUTTON1, movable) that will fire only when the user is clicking on an object with tag "movable".
  - Transitions in state machines can also be fired on any object having a tag of a given class. One can define a ColorTag class (with a color field) and attach many instances of this class to many shapes.
```
  class ColorTag extends CTag {
                Color color;
                ...
  }
 
```
    Then, in a state machine, one can use transitions like:
```
        Transition onAnyColor = new PressOnTag(ColoredTag.class, BUTTON1) {
                public void action() {
                        System.out.println("This object has a "+((ColoredTag)getTag()).color+" tag");
                }
        };
 
```
Author:

Caroline Appert

See Also:
Tag

Constructor Summary

Constructors
Constructor and Description

CTag(Canvas c)
Builds a CTag that can tag the shapes displayed on the canvas c.

Constructors
Constructor and Description
`CTag(Canvas c)` Builds a CTag that can tag the shapes displayed on the canvas c.

Method Summary

Methods
Modifier and Type	Method and Description
`CElement`	`above(CElement before)` Changes the display list order so that every CShape tagged by this tag is right above the top most shape in another CElement.
`CElement`	`aboveAll()` Calls `aboveAll()` for every CShape contained in this `CElement`.
`CTag`	`action()` Calls `action(CShape s)` for every CShape s that has this tag.
`void`	`action(CShape s)` Method called by `action()`.
`void`	`addGhost()` Calls addGhost() on every CShape contained in this `CElement`.
`CElement`	`addTag(CExtensionalTag t)` Calls `addTag(Canvas.Tag t)` for every CShape contained in this `CElement`.
`CElement`	`addTag(java.lang.String t)` Calls `addTag(String t)` for every CShape contained in this `CElement`.
`CTag`	`and(CTag t)` Builds a tag corresponding to the set of shapes tagged by this tag and by t.
`CTag`	`and(java.lang.String t)` Builds a tag corresponding to the set of shapes tagged by this tag and by the `SMNamedTag` t.
`CElement`	`animate(Animation anim)` Calls `animate(Animation anim)` for every CShape tagged by this `CTag`.
`void`	`attachSM(CStateMachine sm, boolean reset)` Attaches a state machine to this `CElement` to describe its behavior.
`CElement`	`below(CElement after)` Changes the display list order so that every CShape tagged by this tag is right below the top least shape in another CElement.
`CElement`	`belowAll()` Calls `belowAll()` for every CShape contained in this `CElement`.
`CShape`	`contains(double x, double y)` Returns the topmost CShape containing the point (x, y).
`CShape`	`contains(double x, double y, double w, double h)` Returns the topmost CShape containing a given rectangle.
`CShape`	`contains(java.awt.geom.Point2D p)` Returns the topmost CShape containing the point p.
`CShape`	`contains(java.awt.Rectangle r)` Returns the topmost CShape containing a given rectangle.
`void`	`detachSM(CStateMachine sm)` Detaches a state machine from this `CElement`.
`CShape`	`firstShape()` Returns the first shape that has this tag.
`CElement`	`fixReferenceShapeToCurrent()`
`java.util.LinkedList<CShape>`	`getAntialiasedShapes()` Returns the list of CShape that have this tag and that are antialiased.
`CRectangle`	`getBoundingBox()`
`Canvas`	`getCanvas()` Returns the canvas in which this CElement is displayed.
`double`	`getCenterX()`
`double`	`getCenterY()`
`java.util.LinkedList<CShape>`	`getFilledShapes()` Returns the list of CShape that have this tag and that are filled.
`CShape`	`getFirstAntialiasedShape()` Returns the first antialiased CShape contained in this `CElement`.
`CShape`	`getFirstFilledShape()` Returns the first CShape contained in this `CElement` and that is filled.
`CShape`	`getFirstHavingTag(CTag t)` Returns the topmost CShape that has tag t.
`CShape`	`getFirstOutlinedShape()` Returns the first CShape contained in this `CElement` and that is outlined.
`CPolyLine`	`getIntersection(CShape s)` Tests whether a `CShape` s intersects this `CElement`.
`double`	`getMaxX()`
`double`	`getMaxY()`
`double`	`getMinX()`
`double`	`getMinY()`
`java.util.LinkedList<CShape>`	`getOutlinedShapes()` Returns the list of CShape that have this tag and that are outlined.
`CShape`	`getTopLeastShape()`
`CShape`	`getTopMostShape()`
`boolean`	`hasNext()` Tests if there is other objects tagged by this tag.
`boolean`	`hasTag(CTag t)` Returns true if every shape with this tag also has tag t.
`boolean`	`hasTag(java.lang.String t)` Returns true if every shape with this tag also has tag t.
`CShape`	`intersects(CShape s)` Returns the topmost `CShape` that intersects the given `CShape` s.
`boolean`	`isAntialiased()` Calls `isAntialiased()` for every CShape that has this tag.
`boolean`	`isDrawable()` Returns true if every shape that has this tag is drawable.
`boolean`	`isFilled()` Calls `isFilled()` for every CShape contained in this `CElement`.
`CShape`	`isOnOutline(java.awt.geom.Point2D p)` Returns the topmost CShape whose outline contains the point p.
`boolean`	`isOutlined()` Returns true if every shape that has this tag is outlined.
`boolean`	`isPickable()` Returns true if every shape that has this tag is pickable.
`java.lang.Object`	`next()`
`CShape`	`nextShape()`
`CTag`	`or(CTag t)` Builds a tag corresponding to the set of shapes tagged by this tag or by t.
`CTag`	`or(java.lang.String t)` Builds a tag corresponding to the set of shapes tagged by this tag or by the `SMNamedTag` t.
`void`	`removeGhost()` Calls removeGhost() on every CShape contained in this `CElement`.
`CElement`	`removeTag(CExtensionalTag t)` Calls `removeTag(Tag t)` for every CShape contained in this `CElement` only if t is a `SMExtensionalTag`, does nothing otherwise.
`CElement`	`removeTag(java.lang.String t)` Calls `removeTag(String t)` for every CShape contained in this `CElement`.
`CElement`	`rotateBy(double theta)` Calls `rotateBy(double theta)` for every CShape contained in this `CElement`.
`CElement`	`rotateTo(double theta)` Calls `rotateTo(double theta)` for every CShape contained in this `CElement`.
`CElement`	`scaleBy(double s)` Calls `scaleBy(double s)` for every CShape contained in this `CElement`.
`CElement`	`scaleBy(double sx, double sy)` Calls `scale(double sx, double sy)` for every CShape contained in this `CElement`.
`CElement`	`scaleTo(double s)` Calls `scaleTo(double s)` for every CShape contained in this `CElement`.
`CElement`	`scaleTo(double sx, double sy)` Calls `scaleTo(double sx, double sy)` for every CShape contained in this `CElement`.
`CElement`	`setAntialiased(boolean a)` Calls `setAntialiased(boolean)` for every CShape contained in this `CElement`.
`CElement`	`setClip(CShape clip)` Calls `setClip(CShape clip)` for every CShape contained in this `CElement`.
`CElement`	`setDrawable(boolean f)` Calls `setDrawable(boolean)` for every CShape contained in this `CElement`.
`CElement`	`setFilled(boolean f)` Calls `setFilled(boolean)` for every CShape contained in this `CElement`.
`CElement`	`setFillPaint(java.awt.Paint fp)` Calls `setFillPaint(Paint fp)` for every CShape contained in this `CElement`.
`CElement`	`setOutlined(boolean f)` Calls `setOutlined(boolean)` for every CShape contained in this `CElement`.
`CElement`	`setOutlinePaint(java.awt.Paint op)` Calls `setOutlinePaint(Paint op)` for every CShape contained in this `CElement`.
`CElement`	`setParent(CShape parent)` Calls `setParent(CShape parent)` for every CShape contained in this `CElement`.
`CElement`	`setPickable(boolean pick)` Calls `setPickable(boolean)` for every CShape contained in this `CElement`.
`CElement`	`setReferencePoint(double x, double y)` Calls `setReferencePoint(double x, double y)` for every CShape contained in this `CElement`.
`CElement`	`setRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue)` Calls `setRenderingHint(hintKey, hintValue)` for every CShape contained in this `CElement`.
`CElement`	`setShape(java.awt.Shape sh)` Calls `setShape(Shape sh)` for every CShape contained in this `CElement`.
`CElement`	`setStroke(java.awt.Stroke str)` Calls `setStroke(Shape sh)` for every CShape contained in this `CElement`.
`CElement`	`setTransformToIdentity()` Calls `setTransformToIdentity()` for every CShape contained in this `CElement`.
`CElement`	`setTransparencyFill(java.awt.AlphaComposite transparencyFill)` Calls `setTransparencyFill(AlphaComposite transparencyFill)` for every CShape contained in this `CElement`.
`CElement`	`setTransparencyFill(float alpha)` Calls `setTransparencyFill(float alpha)` for every CShape contained in this `CElement`.
`CElement`	`setTransparencyOutline(java.awt.AlphaComposite transparencyOutline)` Calls `setTransparencyOutline(AlphaComposite transparencyOutline)` for every CShape contained in this `CElement`.
`CElement`	`setTransparencyOutline(float alpha)` Calls `setTransparencyOutline(float alpha)` for every CShape contained in this `CElement`.
`boolean`	`tagsShape(CShape s)` Tests if the shape s is tagged by this tag.
`CElement`	`translateBy(double tx, double ty)` Calls `translateBy(double tx, double ty)` for every CShape contained in this `CElement`.
`CElement`	`translateTo(double tx, double ty)` Calls `translateTo(double tx, double ty)` every CShape contained in this `CElement`.

Methods inherited from class fr.lri.swingstates.sm.Tag
getCollection, remove, reset, size

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CTag
```
public CTag(Canvas c)
```
    Builds a CTag that can tag the shapes displayed on the canvas c.
    
    Parameters:
    c - The canvas.
- Method Detail
  - getCanvas
```
public Canvas getCanvas()
```
    Returns the canvas in which this CElement is displayed. This method is required because the global handler that dispatches all the events to all the state machines attached to this CElement is the canvas in which this CElement is displayed.
    
    Specified by:
    
    getCanvas in interface CElement
    
    Returns:
    the canvas.
  - hasNext
```
public boolean hasNext()
```
    Tests if there is other objects tagged by this tag.
    
    Specified by:
    
    hasNext in interface java.util.Iterator
    
    Specified by:
    
    hasNext in class Tag
    
    Returns:
    true if there is other objects tagged by this tag, false otherwise.
    See Also:
    Iterator.hasNext()
  - next
```
public final java.lang.Object next()
```
    Specified by:
    
    next in interface java.util.Iterator
    
    Specified by:
    
    next in class Tag
  - nextShape
```
public CShape nextShape()
```
    Returns:
    the next shape tagged by this tag as a CShape.
    See Also:
    Iterator.next()
  - tagsShape
```
public boolean tagsShape(CShape s)
```
    Tests if the shape s is tagged by this tag.
    
    Parameters:
    s - The shape
    
    Returns:
    true if s is tagged by this tag, false otherwise.
  - and
```
public CTag and(CTag t)
```
    Builds a tag corresponding to the set of shapes tagged by this tag and by t.
    
    Parameters:
    t - The second tag.
    
    Returns:
    a new CTag to access shapes tagged by this tag and t.
    See Also:
    CAndTag
  - and
```
public CTag and(java.lang.String t)
```
    Builds a tag corresponding to the set of shapes tagged by this tag and by the SMNamedTag t.
    
    Parameters:
    t - The name of the second tag.
    
    Returns:
    a new CTag to access shapes tagged by this tag and the tag named by t.
    See Also:
    CNamedTag, CAndTag
  - or
```
public CTag or(CTag t)
```
    Builds a tag corresponding to the set of shapes tagged by this tag or by t.
    
    Parameters:
    t - The second tag.
    
    Returns:
    a new CTag to access shapes tagged by this tag or t.
    See Also:
    COrTag
  - or
```
public CTag or(java.lang.String t)
```
    Builds a tag corresponding to the set of shapes tagged by this tag or by the SMNamedTag t.
    
    Parameters:
    t - The name of the second tag.
    
    Returns:
    a new CTag to access shapes tagged by this tag or the tag named by t.
    See Also:
    CNamedTag, COrTag
  - action
```
public void action(CShape s)
```
    Method called by action(). This method does nothing. Redefine it in a subclass to specify the effect of CTag#action()
    
    Parameters:
    s - The CShape on which applying specific treatments.
  - action
```
public final CTag action()
```
    Calls action(CShape s) for every CShape s that has this tag.
    
    Returns:
    this tag
  - setShape
```
public CElement setShape(java.awt.Shape sh)
```
    Calls setShape(Shape sh) for every CShape contained in this CElement.
    
    Specified by:
    
    setShape in interface CElement
    
    Parameters:
    sh - The shape
    
    Returns:
    this CElement
    See Also:
    CShape.setShape(java.awt.Shape)
  - setParent
```
public CElement setParent(CShape parent)
```
    Calls setParent(CShape parent) for every CShape contained in this CElement.
    
    Specified by:
    
    setParent in interface CElement
    
    Parameters:
    parent - The parent shape
    
    Returns:
    this CElement
    See Also:
    CShape.setParent(CShape)
  - setStroke
```
public CElement setStroke(java.awt.Stroke str)
```
    Calls setStroke(Shape sh) for every CShape contained in this CElement.
    
    Specified by:
    
    setStroke in interface CElement
    
    Parameters:
    str - The stroke
    
    Returns:
    this CElement
    See Also:
    CShape.setStroke(java.awt.Stroke)
  - setTransparencyFill
```
public CElement setTransparencyFill(java.awt.AlphaComposite transparencyFill)
```
    Calls setTransparencyFill(AlphaComposite transparencyFill) for every CShape contained in this CElement.
    
    Specified by:
    
    setTransparencyFill in interface CElement
    
    Parameters:
    transparencyFill - The transparency
    
    Returns:
    this CElement
    See Also:
    CShape.setTransparencyFill(AlphaComposite)
  - setTransparencyFill
```
public CElement setTransparencyFill(float alpha)
```
    Calls setTransparencyFill(float alpha) for every CShape contained in this CElement.
    
    Specified by:
    
    setTransparencyFill in interface CElement
    
    Parameters:
    alpha - The transparency
    
    Returns:
    this CElement
    See Also:
    CShape.setTransparencyFill(float)
  - setTransparencyOutline
```
public CElement setTransparencyOutline(java.awt.AlphaComposite transparencyOutline)
```
    Calls setTransparencyOutline(AlphaComposite transparencyOutline) for every CShape contained in this CElement.
    
    Specified by:
    
    setTransparencyOutline in interface CElement
    
    Parameters:
    transparencyOutline - The transparency
    
    Returns:
    this CElement
    See Also:
    CShape.setTransparencyOutline(AlphaComposite)
  - setTransparencyOutline
```
public CElement setTransparencyOutline(float alpha)
```
    Calls setTransparencyOutline(float alpha) for every CShape contained in this CElement.
    
    Specified by:
    
    setTransparencyOutline in interface CElement
    
    Parameters:
    alpha - The transparency
    
    Returns:
    this CElement
    See Also:
    CShape.setTransparencyOutline(float)
  - setFillPaint
```
public CElement setFillPaint(java.awt.Paint fp)
```
    Calls setFillPaint(Paint fp) for every CShape contained in this CElement.
    
    Specified by:
    
    setFillPaint in interface CElement
    
    Parameters:
    fp - The paint value
    
    Returns:
    this CElement
    See Also:
    CShape.setFillPaint(Paint)
  - setOutlinePaint
```
public CElement setOutlinePaint(java.awt.Paint op)
```
    Calls setOutlinePaint(Paint op) for every CShape contained in this CElement.
    
    Specified by:
    
    setOutlinePaint in interface CElement
    
    Parameters:
    op - The paint value
    
    Returns:
    this CElement
    See Also:
    CShape.setOutlinePaint(Paint)
  - isAntialiased
```
public boolean isAntialiased()
```
    Calls isAntialiased() for every CShape that has this tag.
    
    Specified by:
    
    isAntialiased in interface CElement
    
    Returns:
    true if every shape that has this tag is antialiased.
    See Also:
    CShape.isAntialiased()
  - getAntialiasedShapes
```
public java.util.LinkedList<CShape> getAntialiasedShapes()
```
    Returns the list of CShape that have this tag and that are antialiased.
    
    Specified by:
    
    getAntialiasedShapes in interface CElement
    
    Returns:
    the list of CShape that have this tag and that are antialiased.
    See Also:
    CShape.isAntialiased()
  - setRenderingHint
```
public CElement setRenderingHint(java.awt.RenderingHints.Key hintKey,
                        java.lang.Object hintValue)
```
    Calls setRenderingHint(hintKey, hintValue) for every CShape contained in this CElement. See java.awt.RenderingHints for available hint keys and hint values.
    
    Specified by:
    
    setRenderingHint in interface CElement
    
    Parameters:
    hintKey - The hint key
    hintValue - The hint value
    
    Returns:
    this CElement.
  - setAntialiased
```
public CElement setAntialiased(boolean a)
```
    Calls setAntialiased(boolean) for every CShape contained in this CElement.
    
    Specified by:
    
    setAntialiased in interface CElement
    
    Parameters:
    a - True to activate the antialiasing, false to deactivate it.
    
    Returns:
    this CElement
    See Also:
    CShape.setAntialiased(boolean)
  - isFilled
```
public boolean isFilled()
```
    Calls isFilled() for every CShape contained in this CElement.
    
    Specified by:
    
    isFilled in interface CElement
    
    Returns:
    true if every shape contained in this CElement is filled.
    See Also:
    CShape.isFilled()
  - getFilledShapes
```
public java.util.LinkedList<CShape> getFilledShapes()
```
    Returns the list of CShape that have this tag and that are filled.
    
    Specified by:
    
    getFilledShapes in interface CElement
    
    Returns:
    the list of CShape that have this tag and that are filled.
    See Also:
    CShape.isFilled()
  - setFilled
```
public CElement setFilled(boolean f)
```
    Calls setFilled(boolean) for every CShape contained in this CElement.
    
    Specified by:
    
    setFilled in interface CElement
    
    Parameters:
    f - True if the shape must be filled, false otherwise.
    
    Returns:
    this CElement
    See Also:
    CShape.setFilled(boolean)
  - isOutlined
```
public boolean isOutlined()
```
    Returns true if every shape that has this tag is outlined.
    
    Specified by:
    
    isOutlined in interface CElement
    
    Returns:
    true if every shape that has this tag is outlined.
    See Also:
    CShape.isOutlined()
  - getOutlinedShapes
```
public java.util.LinkedList<CShape> getOutlinedShapes()
```
    Description copied from interface: CElement
    
    Returns the list of CShape that have this tag and that are outlined.
    
    Specified by:
    
    getOutlinedShapes in interface CElement
    
    Returns:
    the list of CShape that have this tag and that are outlined.
    See Also:
    CShape.isOutlined()
  - setOutlined
```
public CElement setOutlined(boolean f)
```
    Calls setOutlined(boolean) for every CShape contained in this CElement.
    
    Specified by:
    
    setOutlined in interface CElement
    
    Parameters:
    f - True if the shape must be outlined, false otherwise.
    
    Returns:
    this CElement
    See Also:
    CShape.setOutlined(boolean)
  - isDrawable
```
public boolean isDrawable()
```
    Returns true if every shape that has this tag is drawable.
    
    Specified by:
    
    isDrawable in interface CElement
    
    Returns:
    true if every shape that has this tag is drawable.
    See Also:
    CShape.isDrawable()
  - setDrawable
```
public CElement setDrawable(boolean f)
```
    Calls setDrawable(boolean) for every CShape contained in this CElement.
    
    Specified by:
    
    setDrawable in interface CElement
    
    Parameters:
    f - True if the shape must be drawn, false otherwise.
    
    Returns:
    this CElement
    See Also:
    CShape.setDrawable(boolean)
  - isPickable
```
public boolean isPickable()
```
    Returns true if every shape that has this tag is pickable.
    
    Specified by:
    
    isPickable in interface CElement
    
    Returns:
    true if every shape that has this tag is pickable.
    See Also:
    CShape.isPickable()
  - setPickable
```
public CElement setPickable(boolean pick)
```
    Calls setPickable(boolean) for every CShape contained in this CElement.
    
    Specified by:
    
    setPickable in interface CElement
    
    Parameters:
    pick - True if the shape must be pickable, false otherwise.
    
    Returns:
    this CElement
    See Also:
    CShape.setOutlined(boolean)
  - setReferencePoint
```
public CElement setReferencePoint(double x,
                         double y)
```
    Calls setReferencePoint(double x, double y) for every CShape contained in this CElement.
    
    Specified by:
    
    setReferencePoint in interface CElement
    
    Parameters:
    x - The x coordinate of the new reference point.
    y - The y coordinate of the new reference point.
    
    Returns:
    this CElement
    See Also:
    CShape.setReferencePoint(double, double)
  - setTransformToIdentity
```
public CElement setTransformToIdentity()
```
    Calls setTransformToIdentity() for every CShape contained in this CElement.
    
    Specified by:
    
    setTransformToIdentity in interface CElement
    
    Returns:
    this CElement
    See Also:
    CShape.setTransformToIdentity()
  - fixReferenceShapeToCurrent
```
public CElement fixReferenceShapeToCurrent()
```
    Specified by:
    
    fixReferenceShapeToCurrent in interface CElement
  - translateBy
```
public CElement translateBy(double tx,
                   double ty)
```
    Calls translateBy(double tx, double ty) for every CShape contained in this CElement.
    
    Specified by:
    
    translateBy in interface CElement
    
    Parameters:
    tx - The x offset
    ty - The y offset
    
    Returns:
    this CElement
    See Also:
    CShape.translateBy(double, double)
  - translateTo
```
public CElement translateTo(double tx,
                   double ty)
```
    Calls translateTo(double tx, double ty) every CShape contained in this CElement.
    
    Specified by:
    
    translateTo in interface CElement
    
    Parameters:
    tx - The x coordinate
    ty - The y coordinate
    
    Returns:
    this CElement
    See Also:
    CShape.translateTo(double, double)
  - scaleBy
```
public CElement scaleBy(double sx,
               double sy)
```
    Calls scale(double sx, double sy) for every CShape contained in this CElement.
    
    Specified by:
    
    scaleBy in interface CElement
    
    Parameters:
    sx - The x scale factor
    sy - The y scale factor
    
    Returns:
    this CElement
    See Also:
    CShape.scaleBy(double, double)
  - scaleBy
```
public CElement scaleBy(double s)
```
    Calls scaleBy(double s) for every CShape contained in this CElement.
    
    Specified by:
    
    scaleBy in interface CElement
    
    Parameters:
    s - The scale factor
    
    Returns:
    this CElement
    See Also:
    CShape.scaleBy(double)
  - scaleTo
```
public CElement scaleTo(double sx,
               double sy)
```
    Calls scaleTo(double sx, double sy) for every CShape contained in this CElement.
    
    Specified by:
    
    scaleTo in interface CElement
    
    Parameters:
    sx - The x scale
    sy - The y scale
    
    Returns:
    this CElement
    See Also:
    CShape.scaleTo(double, double)
  - scaleTo
```
public CElement scaleTo(double s)
```
    Calls scaleTo(double s) for every CShape contained in this CElement.
    
    Specified by:
    
    scaleTo in interface CElement
    
    Parameters:
    s - The scale value
    
    Returns:
    this CElement
    See Also:
    CShape.scaleTo(double)
  - rotateBy
```
public CElement rotateBy(double theta)
```
    Calls rotateBy(double theta) for every CShape contained in this CElement.
    
    Specified by:
    
    rotateBy in interface CElement
    
    Parameters:
    theta - The angle offset
    
    Returns:
    this CElement
    See Also:
    CShape.rotateBy(double)
  - rotateTo
```
public CElement rotateTo(double theta)
```
    Calls rotateTo(double theta) for every CShape contained in this CElement.
    
    Specified by:
    
    rotateTo in interface CElement
    
    Parameters:
    theta - The angle
    
    Returns:
    this CElement
    See Also:
    CShape.rotateTo(double)
  - contains
```
public CShape contains(double x,
              double y)
```
    Returns the topmost CShape containing the point (x, y).
    
    Specified by:
    
    contains in interface CElement
    
    Parameters:
    x - The x-coordinate of the point to test.
    y - The y-coordinate of the point to test.
    
    Returns:
    the topmost CShape containing the point (x, y), null if no CShape contains the point (x, y).
    See Also:
    CShape.contains(double, double)
  - contains
```
public CShape contains(java.awt.geom.Point2D p)
```
    Returns the topmost CShape containing the point p.
    
    Specified by:
    
    contains in interface CElement
    
    Parameters:
    p - The point to test.
    
    Returns:
    the topmost CShape containing the point p, null if no CShape contains the point p.
    See Also:
    CShape.contains(Point2D)
  - contains
```
public CShape contains(double x,
              double y,
              double w,
              double h)
```
    Returns the topmost CShape containing a given rectangle.
    
    Specified by:
    
    contains in interface CElement
    
    Parameters:
    x - The x-coordinate of the left corner of the rectangle to test.
    y - The y-coordinate of the left corner of the rectangle to test.
    w - The width of the rectangle to test.
    h - The height of the rectangle to test.
    
    Returns:
    the topmost CShape containing the rectangle defined by the upper left corner (x, y), the width w and the height h, null if no CShape contains the rectangle.
    See Also:
    CShape.contains(double, double, double, double)
  - contains
```
public CShape contains(java.awt.Rectangle r)
```
    Returns the topmost CShape containing a given rectangle.
    
    Specified by:
    
    contains in interface CElement
    
    Parameters:
    r - The rectangle to test.
    
    Returns:
    the topmost CShape containing the rectangle r, null if no CShape contains r.
    See Also:
    CShape.contains(Rectangle)
  - isOnOutline
```
public CShape isOnOutline(java.awt.geom.Point2D p)
```
    Returns the topmost CShape whose outline contains the point p.
    
    Specified by:
    
    isOnOutline in interface CElement
    
    Parameters:
    p - The point to test.
    
    Returns:
    the topmost CShape whose outline contains the point p, null if no CShape's outline contains p.
    See Also:
    CShape.isOnOutline(Point2D)
  - intersects
```
public CShape intersects(CShape s)
```
    Returns the topmost CShape that intersects the given CShape s.
    
    Specified by:
    
    intersects in interface CElement
    
    Parameters:
    s - The shape
    
    Returns:
    the topmost CShape that intersects the given CShape, null if no CShape intersects s.
    See Also:
    CShape.intersects(CShape)
  - getIntersection
```
public CPolyLine getIntersection(CShape s)
```
    Tests whether a CShape s intersects this CElement.
    
    Specified by:
    
    getIntersection in interface CElement
    
    Parameters:
    s - The shape
    
    Returns:
    the intersection as a CPolyLine if s intersects it, null otherwise.
    See Also:
    CShape.getIntersection(CShape)
  - getFirstHavingTag
```
public CShape getFirstHavingTag(CTag t)
```
    Returns the topmost CShape that has tag t.
    
    Specified by:
    
    getFirstHavingTag in interface CElement
    
    Parameters:
    t - The tag to test.
    
    Returns:
    the topmost CShape that has tag t, null if no CShape has tag t.
    See Also:
    CShape.hasTag(fr.lri.swingstates.canvas.CTag)
  - hasTag
```
public boolean hasTag(java.lang.String t)
```
    Returns true if every shape with this tag also has tag t.
    
    Specified by:
    
    hasTag in interface CElement
    
    Parameters:
    t - The name of the tag to test
    
    Returns:
    true if every shape with this tag also has tag t, false otherwise.
    See Also:
    CShape.hasTag(String)
  - hasTag
```
public boolean hasTag(CTag t)
```
    Returns true if every shape with this tag also has tag t.
    
    Specified by:
    
    hasTag in interface CElement
    
    Parameters:
    t - the tag to test.
    
    Returns:
    true if every shape with this tag also has tag t, false otherwise.
  - above
```
public CElement above(CElement before)
```
    Changes the display list order so that every CShape tagged by this tag is right above the top most shape in another CElement. The relative display order between shapes tagged by this tag is unchanged. WARNING: If this tag also tags one of the elements contained in before, this method does nothing.
    
    Specified by:
    
    above in interface CElement
    
    Parameters:
    before - The shape that must be right below every shape contained in this CElement in the display list
    
    Returns:
    This CElement
    See Also:
    CShape.below(CElement)
  - aboveAll
```
public CElement aboveAll()
```
    Calls aboveAll() for every CShape contained in this CElement.
    
    Specified by:
    
    aboveAll in interface CElement
    
    Returns:
    This CElement
    See Also:
    CShape.aboveAll()
  - getTopMostShape
```
public CShape getTopMostShape()
```
    Returns:
    The shape tagged by this tag that has the highest index in the display list, null if this tag is not registered to a canvas.
  - getTopLeastShape
```
public CShape getTopLeastShape()
```
    Returns:
    The shape tagged by this tag that has the lowest index in the display list, null if this tag is not registered to a canvas.
  - below
```
public CElement below(CElement after)
```
    Changes the display list order so that every CShape tagged by this tag is right below the top least shape in another CElement. The relative display order between shapes tagged by this tag is unchanged. WARNING: If this tag also tags one of the elements contained in after, this method does nothing.
    
    Specified by:
    
    below in interface CElement
    
    Parameters:
    after - The shape that must be right above every shape contained in this CElement in the display list
    
    Returns:
    This tag
    See Also:
    CShape.below(CElement)
  - belowAll
```
public CElement belowAll()
```
    Calls belowAll() for every CShape contained in this CElement.
    
    Specified by:
    
    belowAll in interface CElement
    
    Returns:
    This CElement
    See Also:
    CShape.belowAll()
  - setClip
```
public CElement setClip(CShape clip)
```
    Calls setClip(CShape clip) for every CShape contained in this CElement.
    
    Specified by:
    
    setClip in interface CElement
    
    Parameters:
    clip - The clipping shape, or null to reset clipping of this shape
    
    Returns:
    This CElement
    See Also:
    CShape.setClip(CShape)
  - addGhost
```
public void addGhost()
```
    Calls addGhost() on every CShape contained in this CElement.
    
    Specified by:
    
    addGhost in interface CElement
    
    See Also:
    CShape.addGhost()
  - removeGhost
```
public void removeGhost()
```
    Calls removeGhost() on every CShape contained in this CElement.
    
    Specified by:
    
    removeGhost in interface CElement
    
    See Also:
    CShape.removeGhost()
  - getBoundingBox
```
public CRectangle getBoundingBox()
```
    Specified by:
    
    getBoundingBox in interface CElement
    
    Returns:
    the rectangle that is the bounding box of the group of SMShapes that has this tag.
  - getMinX
```
public double getMinX()
```
    Specified by:
    
    getMinX in interface CElement
    
    Returns:
    the minimum x-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - getMaxX
```
public double getMaxX()
```
    Specified by:
    
    getMaxX in interface CElement
    
    Returns:
    the maximum x-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - getCenterX
```
public double getCenterX()
```
    Specified by:
    
    getCenterX in interface CElement
    
    Returns:
    center x-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - getMinY
```
public double getMinY()
```
    Specified by:
    
    getMinY in interface CElement
    
    Returns:
    the minimum y-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - getMaxY
```
public double getMaxY()
```
    Specified by:
    
    getMaxY in interface CElement
    
    Returns:
    the maximum y-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - getCenterY
```
public double getCenterY()
```
    Specified by:
    
    getCenterY in interface CElement
    
    Returns:
    center y-coordinate of the rectangle that is the bounding box of the group of CShapes that has this tag.
  - firstShape
```
public CShape firstShape()
```
    Returns the first shape that has this tag.
    
    Specified by:
    
    firstShape in interface CElement
    
    Returns:
    the first shape that has this tag, null if no shape has this tag.
  - getFirstAntialiasedShape
```
public CShape getFirstAntialiasedShape()
```
    Returns the first antialiased CShape contained in this CElement.
    
    Specified by:
    
    getFirstAntialiasedShape in interface CElement
    
    Returns:
    the first antialiased CShape contained in this CElement, null if no CShape is antialiased.
    See Also:
    CShape.isAntialiased()
  - getFirstFilledShape
```
public CShape getFirstFilledShape()
```
    Returns the first CShape contained in this CElement and that is filled.
    
    Specified by:
    
    getFirstFilledShape in interface CElement
    
    Returns:
    the first CShape contained in this CElement and that is filled, null if no CShape is filled.
    See Also:
    CShape.isFilled()
  - getFirstOutlinedShape
```
public final CShape getFirstOutlinedShape()
```
    Returns the first CShape contained in this CElement and that is outlined.
    
    Specified by:
    
    getFirstOutlinedShape in interface CElement
    
    Returns:
    the first CShape contained in this CElement and that is outlined, null if no CShape is outlined.
    See Also:
    CShape.isOutlined()
  - addTag
```
public CElement addTag(CExtensionalTag t)
```
    Calls addTag(Canvas.Tag t) for every CShape contained in this CElement.
    
    Specified by:
    
    addTag in interface CElement
    
    Parameters:
    t - The tag
    
    Returns:
    this CElement
  - addTag
```
public CElement addTag(java.lang.String t)
```
    Calls addTag(String t) for every CShape contained in this CElement.
    
    Specified by:
    
    addTag in interface CElement
    
    Parameters:
    t - The name of the tag
    
    Returns:
    this CElement
    See Also:
    CShape.addTag(String)
  - removeTag
```
public CElement removeTag(CExtensionalTag t)
```
    Calls removeTag(Tag t) for every CShape contained in this CElement only if t is a SMExtensionalTag, does nothing otherwise.
    
    Specified by:
    
    removeTag in interface CElement
    
    Parameters:
    t - The tag
    
    Returns:
    this CElement
    See Also:
    CShape.removeTag(CExtensionalTag)
  - removeTag
```
public CElement removeTag(java.lang.String t)
```
    Calls removeTag(String t) for every CShape contained in this CElement.
    
    Specified by:
    
    removeTag in interface CElement
    
    Parameters:
    t - The name of the tag
    
    Returns:
    this CElement
    See Also:
    CShape.removeTag(String)
  - attachSM
```
public void attachSM(CStateMachine sm,
            boolean reset)
```
    Attaches a state machine to this CElement to describe its behavior.
    
    Specified by:
    
    attachSM in interface CElement
    
    Parameters:
    sm - The State machine that describes the behavior of this CElement.
    reset - True if the machine must be reset, false otherwise.
  - detachSM
```
public void detachSM(CStateMachine sm)
```
    Detaches a state machine from this CElement.
    
    Specified by:
    
    detachSM in interface CElement
    
    Parameters:
    sm - The State machine to detach.
  - animate
```
public CElement animate(Animation anim)
```
    Calls animate(Animation anim) for every CShape tagged by this CTag.
    
    Specified by:
    
    animate in interface CElement
    
    Parameters:
    anim - The animation to associate to each shape tagged by this CTag.
    
    Returns:
    this CTag as a CElement
    See Also:
    CShape.animate(Animation)

Class CTag

Constructor Summary

Method Summary

Methods inherited from class fr.lri.swingstates.sm.Tag

Methods inherited from class java.lang.Object

Constructor Detail

CTag

Method Detail

getCanvas

hasNext

next

nextShape

tagsShape

and

and

or

or

action

action

setShape

setParent

setStroke

setTransparencyFill

setTransparencyFill

setTransparencyOutline

setTransparencyOutline

setFillPaint

setOutlinePaint

isAntialiased

getAntialiasedShapes

setRenderingHint

setAntialiased

isFilled

getFilledShapes

setFilled

isOutlined

getOutlinedShapes

setOutlined

isDrawable

setDrawable

isPickable

setPickable

setReferencePoint

setTransformToIdentity

fixReferenceShapeToCurrent

translateBy

translateTo

scaleBy

scaleBy

scaleTo

scaleTo

rotateBy

rotateTo

contains

contains

contains

contains

isOnOutline

intersects

getIntersection

getFirstHavingTag

hasTag

hasTag

above

aboveAll

getTopMostShape

getTopLeastShape

below

belowAll

setClip

addGhost

removeGhost

getBoundingBox

getMinX

getMaxX

getCenterX

getMinY

getMaxY

getCenterY

firstShape