fr.lri.swingstates.canvas

Class CExtensionalTag

java.lang.Object

fr.lri.swingstates.sm.Tag

fr.lri.swingstates.canvas.CTag

fr.lri.swingstates.canvas.CExtensionalTag

All Implemented Interfaces:

CElement, java.util.Iterator

Direct Known Subclasses:

CNamedTag, ColorTag

public abstract class CExtensionalTag
extends CTag

A CExtensionalTag tag is a tag that can be explicitely attached to and detached from a shape, i.e. a shape can be added to or removed to the tag's collection.

Author:

Caroline Appert

See Also:

CTag

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	added(CShape s) Method called when this tag is added to an CShape.
CExtensionalTag	addTo(CShape s) Adds the shape s to the collection containing all the shapes that have this tag.
void	removed(CShape s) Method called when this tag is removed from an CShape.
CExtensionalTag	removeFrom(CShape s) Removes the shape s from the collection containing all the shapes that have this tag.
void	reset() Inits the tag's iterator.

Methods inherited from class fr.lri.swingstates.canvas.CTag

above, aboveAll, action, action, addGhost, addTag, addTag, and, and, animate, attachSM, below, belowAll, contains, contains, contains, contains, detachSM, firstShape, fixReferenceShapeToCurrent, getAntialiasedShapes, getBoundingBox, getCanvas, getCenterX, getCenterY, getFilledShapes, getFirstAntialiasedShape, getFirstFilledShape, getFirstHavingTag, getFirstOutlinedShape, getIntersection, getMaxX, getMaxY, getMinX, getMinY, getOutlinedShapes, getTopLeastShape, getTopMostShape, hasNext, hasTag, hasTag, intersects, isAntialiased, isDrawable, isFilled, isOnOutline, isOutlined, isPickable, next, nextShape, or, or, removeGhost, removeTag, removeTag, rotateBy, rotateTo, scaleBy, scaleBy, scaleTo, scaleTo, setAntialiased, setClip, setDrawable, setFilled, setFillPaint, setOutlined, setOutlinePaint, setParent, setPickable, setReferencePoint, setRenderingHint, setShape, setStroke, setTransformToIdentity, setTransparencyFill, setTransparencyFill, setTransparencyOutline, setTransparencyOutline, tagsShape, translateBy, translateTo

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

getCollection, remove, size

Methods inherited from class java.lang.Object

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

Constructor Detail

CExtensionalTag

public CExtensionalTag()

Builds a CExtensionalTag that can tag shapes.

CExtensionalTag

public CExtensionalTag(Canvas c)

Builds a CExtensionalTag that can tag the shapes displayed on the canvas c. This tag can be explicitely removed to any shape displayed on c.

Parameters:

c - The canvas

Method Detail

reset

public final void reset()

Inits the tag's iterator.

Specified by:

reset in class Tag

added

public void added(CShape s)

Method called when this tag is added to an CShape. By default, this method does nothing. Redefine it in a subclass to specify side effects, such as changing the color of the attached CShape.

Parameters:

s - The CShape

removed

public void removed(CShape s)

Method called when this tag is removed from an CShape. By default, this method does nothing. Redefine it in a subclass to specify side effects, such as changing the color of the attached CShape.

Parameters:

s - The CShape

addTo

public final CExtensionalTag addTo(CShape s)

Adds the shape s to the collection containing all the shapes that have this tag. This method calls begin(CShape), which can be redefined in subclasses to specify side effects, such as changing the color of the attached object when the tag is added.

Parameters:

s - The CShape

Returns:

this tag

See Also:

added(CShape)

removeFrom

public final CExtensionalTag removeFrom(CShape s)

Removes the shape s from the collection containing all the shapes that have this tag. This method calls end(CShape), which can be redefined in subclasses to specify side effects, such as changing the color of the attached object when the tag is removed.

Parameters:

s - The CShape

Returns:

this tag

See Also:

removed(CShape)