Canvas

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - fr.lri.swingstates.canvas.Canvas

All Implemented Interfaces:

CElement, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

GraphicalEditor, StateMachineVisualization
```
public class Canvas
extends javax.swing.JPanel
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.awt.event.KeyListener, CElement
```
A canvas that displays a scene composed of graphical objects. A canvas handles a display list containing CShape objects. It is ordered from back to front, i.e. the frontmost object is the last in the list. Whenever the contents of the display list is modified, a repaint is triggered to update the display.

The display list contains CShape objects. It is ordered from back to front, i.e. the frontmost object is the last in the list. Whenever the contents of the display list is modified, a repaint is triggered to update the display.
CStateMachine is a class that implements state machines dedicated to program interaction with a canvas. See StateMachine for a description of the syntax and use of state machines. Once a state machine is attached to a canvas and is active, it receives and handles all input events. The canvas may have several active state machines; they receive and handle the same events. State machines can be attached to a subpart of a canvas, i.e. a shape or a tag, to reduce their scope.

Events handled by state machines are mouse events, the keyboard events, the time out events (triggered by armTimer) and animation events.

Author:

Caroline Appert

See Also:
CStateMachine, CShape, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.BaselineResizeBehavior

Field Summary
- Fields inherited from class javax.swing.JComponent
  TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

Canvas()
Builds a Canvas.

Canvas(int w, int h)
Builds a Canvas.

Constructors
Constructor and Description
`Canvas()` Builds a Canvas.
`Canvas(int w, int h)` Builds a Canvas.

Method Summary

Methods
Modifier and Type	Method and Description
`CElement`	`above(CElement before)` Does Anything.
`CElement`	`aboveAll()` Does Anything.
`void`	`addGhost()` Calls addGhost() on every CShape contained in this `CElement`.
`Canvas`	`addShape(CShape sms)` Adds a shape to the canvas.
`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`.
`CElement`	`animate(Animation anim)` Calls `animate(Animation animTagScale)` for every CShape contained in this `Canvas`.
`void`	`attachSM(CStateMachine sm, boolean reset)` Attaches a state machine to this `CElement` to describe its behavior.
`CElement`	`below(CElement after)` Does Anything.
`CElement`	`belowAll()` Does Anything.
`static boolean`	`contains(CElement container, CElement element)` Tests if a `CElement` is a subset of another `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 R.
`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 contained in this `CElement`.
`CElement`	`fixReferenceShapeToCurrent()`
`java.util.List<CTag>`	`getAllTags()`
`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.awt.Shape`	`getClip()`
`java.util.List<CShape>`	`getDisplayList()`
`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.
`java.util.List<CStateMachine>`	`getSMs()` Returns the state machines attached to this canvas.
`ClassTag`	`getTag(java.lang.Class tagClass)` Returns an intentional tag object grouping shapes having a tag of a given class.
`CNamedTag`	`getTag(java.lang.String tag)` Returns the tag object given its name.
`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()` Returns True if the canvas is antialiased.
`boolean`	`isDrawable()` Returns true if every shape contained in this `CElement` 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 contained in this `CElement` is outlined.
`boolean`	`isPickable()` Returns true if every shape contained in this `CElement` is pickable.
`boolean`	`isTracking(CElement element)` Tests if one of the attached state machines is waiting for changes of `element`.
`void`	`keyPressed(java.awt.event.KeyEvent arg0)`
`void`	`keyReleased(java.awt.event.KeyEvent arg0)`
`void`	`keyTyped(java.awt.event.KeyEvent arg0)`
`void`	`mouseClicked(java.awt.event.MouseEvent event)`
`void`	`mouseDragged(java.awt.event.MouseEvent event)`
`void`	`mouseEntered(java.awt.event.MouseEvent event)`
`void`	`mouseExited(java.awt.event.MouseEvent event)`
`void`	`mouseMoved(java.awt.event.MouseEvent arg0)`
`void`	`mousePressed(java.awt.event.MouseEvent event)`
`void`	`mouseReleased(java.awt.event.MouseEvent event)`
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent event)`
`CDynamicWidget`	`newDynamicWidget(javax.swing.JComponent b, double x, double y, int delayInMilliseconds)` Create a new dynamic widget and add it to the canvas (i.e.
`CEllipse`	`newEllipse(double x, double y, double w, double h)` Creates a new ellipse and add it to the canvas.
`CEllipse`	`newEllipse(java.awt.geom.Point2D p, double w, double h)` Creates a new ellipse and add it to the canvas.
`CImage`	`newImage(double x, double y, java.awt.image.BufferedImage image)` Create a new image and add it to the canvas.
`CImage`	`newImage(double x, double y, java.io.InputStream imageStream)` Create a new image and add it to the canvas.
`CImage`	`newImage(double x, double y, java.lang.String imageFile)` Create a new image and add it to the canvas.
`CImage`	`newImage(double x, double y, java.net.URL imageURL)` Create a new image and add it to the canvas.
`CPolyLine`	`newPolyLine()` Create a new empty polyline and add it to the canvas.
`CPolyLine`	`newPolyLine(double x, double y)` Create a new polyline and add it to the canvas.
`CPolyLine`	`newPolyLine(java.awt.geom.Point2D p)` Create a new polyline and add it to the canvas.
`CRectangle`	`newRectangle(double x, double y, double w, double h)` Creates a new rectangle and add it to the canvas.
`CRectangle`	`newRectangle(java.awt.geom.Point2D p, double w, double h)` Creates a new rectangle and add it to the canvas.
`CRectangle`	`newRoundRectangle(double x, double y, double w, double h, double arcw, double arch)` Creates a new rectangle and add it to the canvas.
`CRectangle`	`newRoundRectangle(java.awt.geom.Point2D p, double w, double h, double arcw, double arch)` Creates a new rectangle and add it to the canvas.
`CSegment`	`newSegment(double x1, double y1, double x2, double y2)` Creates a new segment and add it to the canvas.
`CSegment`	`newSegment(java.awt.geom.Point2D p1, java.awt.geom.Point2D p2)` Creates a new segment and add it to the canvas.
`CNamedTag`	`newTag(java.lang.String t)` Returns a named tag object given its name.
`CText`	`newText(double x, double y, java.lang.String text)` Create a new text and add it to the canvas.
`CText`	`newText(double x, double y, java.lang.String text, java.awt.Font font)` Create a new text and add it to the canvas.
`CText`	`newText(java.awt.geom.Point2D p, java.lang.String text)` Create a new text and add it to the canvas.
`CText`	`newText(java.awt.geom.Point2D p, java.lang.String text, java.awt.Font font)` Create a new text and add it to the canvas.
`CWidget`	`newWidget(javax.swing.JComponent b)` Create a new widget and add it to the canvas.
`CWidget`	`newWidget(javax.swing.JComponent b, double x, double y)` Create a new widget and add it to the canvas (i.e.
`CWidget`	`newWidget(javax.swing.JComponent b, double x, double y, double w, double h)` Create a new widget and add it to the canvas.
`void`	`paintComponent(java.awt.Graphics g)`
`CShape`	`pick(java.awt.geom.Point2D p)` Returns the topmost shape at a given position.
`java.util.LinkedList<CShape>`	`pickAll(java.awt.geom.Point2D p)` Returns a list containing all the shapes at a given position.
`CShape`	`pickShapeHavingTag(java.awt.geom.Point2D p, CTag tag)` Returns the top most shape having a given tag at a given position.
`CShape`	`pickShapeHavingTag(java.awt.geom.Point2D p, java.lang.String tag)` Returns the top most shape having a given named tag at a given position.
`void`	`processEvent(java.lang.String event, java.awt.geom.Point2D pt)` Processes an event to all the state machines that monitor this canvas, a shape in this canvas or a tag attached to shapes in this canvas.
`void`	`processEvent(VirtualEvent virtualEvent)` Processes an event to all the state machines that monitor this canvas, a shape in this canvas or a tag attached to shapes in this canvas.
`Canvas`	`removeAllShapes()` Removes all shapes from this canvas.
`void`	`removeGhost()` Calls removeGhost() on every CShape contained in this `CElement`.
`Canvas`	`removeShape(CShape shape)` Removes a shape from the canvas.
`Canvas`	`removeShapes(CTag shapes)` Removes a set of tagged shapes from the canvas.
`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)` Sets the antialiasing for every CShape drawn in this canvas (global antialiasing).
`CElement`	`setClip(CShape clip)` Sets the clip for every CShape drawn in this canvas (global rendering hints).
`void`	`setClip(java.awt.Shape clip)`
`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)` Sets the rendering hints for every CShape drawn in this canvas (global rendering hints).
`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`.
`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 javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

- Constructor Detail
  - Canvas
```
public Canvas()
```
    Builds a Canvas.
  - Canvas
```
public Canvas(int w,
      int h)
```
    Builds a Canvas.
    
    Parameters:
    w - The width of the canvas
    h - The height of the canvas
- Method Detail
  - getAllTags
```
public java.util.List<CTag> getAllTags()
```
    Returns:
    all the tags registered on this Canvas.
  - getTag
```
public CNamedTag getTag(java.lang.String tag)
```
    Returns the tag object given its name.
    
    Parameters:
    tag - The name of the tag
    
    Returns:
    The tag, or null if no such tag exists.
  - getTag
```
public ClassTag getTag(java.lang.Class tagClass)
```
    Returns an intentional tag object grouping shapes having a tag of a given class.
    
    Parameters:
    tagClass - The class of the tag
    
    Returns:
    The tag, or null if no such tag exists.
  - paintComponent
```
public void paintComponent(java.awt.Graphics g)
```
    Overrides:
    
    paintComponent in class javax.swing.JComponent
  - processEvent
```
public void processEvent(java.lang.String event,
                java.awt.geom.Point2D pt)
```
    Processes an event to all the state machines that monitor this canvas, a shape in this canvas or a tag attached to shapes in this canvas. Performs picking using the location pt.
    
    Parameters:
    event - The name of the virtual event to process.
    pt - The point on which this event occurred.
  - processEvent
```
public void processEvent(VirtualEvent virtualEvent)
```
    Processes an event to all the state machines that monitor this canvas, a shape in this canvas or a tag attached to shapes in this canvas. If virtualEvent has the type VirtualCanvasEvent, this method performs picking on the canvas so transitions EventOnShape and EventOnTag can be triggered.
    
    Parameters:
    virtualEvent - The virtual event to process.
  - contains
```
public static boolean contains(CElement container,
               CElement element)
```
    Tests if a CElement is a subset of another CElement.
    
    Parameters:
    container - The CElement container
    element - The CElement contained
    
    Returns:
    true if element is a subset of container.
  - isTracking
```
public boolean isTracking(CElement element)
```
    Tests if one of the attached state machines is waiting for changes of element. (if there is one machine whose current state contains a CElementEvent(element, ...) transition).
    
    Parameters:
    element - The element.
    
    Returns:
    true if element is tracked by a machine, false otherwise.
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent event)
```
    Specified by:
    
    mouseWheelMoved in interface java.awt.event.MouseWheelListener
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent arg0)
```
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent event)
```
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
  - keyTyped
```
public void keyTyped(java.awt.event.KeyEvent arg0)
```
    Specified by:
    
    keyTyped in interface java.awt.event.KeyListener
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent arg0)
```
    Specified by:
    
    keyPressed in interface java.awt.event.KeyListener
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent arg0)
```
    Specified by:
    
    keyReleased in interface java.awt.event.KeyListener
  - pick
```
public CShape pick(java.awt.geom.Point2D p)
```
    Returns the topmost shape at a given position.
    
    Parameters:
    p - The position.
    
    Returns:
    the topmost shape under p, or null if there is no shape at this postion.
  - pickAll
```
public java.util.LinkedList<CShape> pickAll(java.awt.geom.Point2D p)
```
    Returns a list containing all the shapes at a given position.
    
    Parameters:
    p - The position.
    
    Returns:
    the list of shapes, with the topmost shape first.
  - pickShapeHavingTag
```
public CShape pickShapeHavingTag(java.awt.geom.Point2D p,
                        CTag tag)
```
    Returns the top most shape having a given tag at a given position.
    
    Parameters:
    p - The position.
    tag - The tag.
    
    Returns:
    the picked tagged shape, null if there is no tagged shape at p.
  - pickShapeHavingTag
```
public CShape pickShapeHavingTag(java.awt.geom.Point2D p,
                        java.lang.String tag)
```
    Returns the top most shape having a given named tag at a given position.
    
    Parameters:
    p - The position.
    tag - The name of the tag.
    
    Returns:
    the picked tagged shape, null if there is no tagged shape at p.
  - addShape
```
public Canvas addShape(CShape sms)
```
    Adds a shape to the canvas.
    
    Parameters:
    sms - the shape to add.
    
    Returns:
    this canvas.
  - removeShape
```
public Canvas removeShape(CShape shape)
```
    Removes a shape from the canvas. Before being removed, the tags of this shape are removed, the shape is removed from its hierarchy (its parent and children are set to null), and its ghost, if any, is removed.
    WARNING: Since this method potentially modifies the tags registered on this canvas, be sure to not use it while iterating on any of these canvas' tags.
    
    Sometimes, it can be more efficient or more convenient to just "hide" a shape by using the method setDrawable in class CShape.
    
    Parameters:
    shape - The shape to remove from this canvas.
    
    Returns:
    this canvas.
    See Also:
    CShape.setDrawable(boolean)
  - removeShapes
```
public Canvas removeShapes(CTag shapes)
```
    Removes a set of tagged shapes from the canvas.
    
    Parameters:
    shapes - The shapes that have to be deleted.
    
    Returns:
    this canvas.
  - removeAllShapes
```
public Canvas removeAllShapes()
```
    Removes all shapes from this canvas.
    
    Returns:
    this canvas.
  - newSegment
```
public CSegment newSegment(java.awt.geom.Point2D p1,
                  java.awt.geom.Point2D p2)
```
    Creates a new segment and add it to the canvas.
    
    Parameters:
    p1 - The first point of the segment.
    p2 - The second point of the segment.
    
    Returns:
    the newly created segment.
  - newSegment
```
public CSegment newSegment(double x1,
                  double y1,
                  double x2,
                  double y2)
```
    Creates a new segment and add it to the canvas.
    
    Parameters:
    x1 - The x-coordinate of the first point of the segment.
    y1 - The y-coordinate of the first point of the segment.
    x2 - The x-coordinate of the second point of the segment.
    y2 - The y-coordinate of the second point of the segment.
    
    Returns:
    the newly created segment.
  - newRectangle
```
public CRectangle newRectangle(double x,
                      double y,
                      double w,
                      double h)
```
    Creates a new rectangle and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the upper left point of the bounding box.
    y - The y coordinate of the upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    
    Returns:
    the newly created rectangle.
  - newRectangle
```
public CRectangle newRectangle(java.awt.geom.Point2D p,
                      double w,
                      double h)
```
    Creates a new rectangle and add it to the canvas.
    
    Parameters:
    p - The upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    
    Returns:
    the newly created rectangle.
  - newRoundRectangle
```
public CRectangle newRoundRectangle(double x,
                           double y,
                           double w,
                           double h,
                           double arcw,
                           double arch)
```
    Creates a new rectangle and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the upper left point of the bounding box.
    y - The y coordinate of the upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    arcw - The width of the arc to use to round off the corners of the newly constructed CRectangle
    arch - The height of the arc to use to round off the corners of the newly constructed CRectangle
    
    Returns:
    the newly created CRectangle.
  - newRoundRectangle
```
public CRectangle newRoundRectangle(java.awt.geom.Point2D p,
                           double w,
                           double h,
                           double arcw,
                           double arch)
```
    Creates a new rectangle and add it to the canvas.
    
    Parameters:
    p - The upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    arcw - The width of the arc to use to round off the corners of the newly constructed CRectangle
    arch - The height of the arc to use to round off the corners of the newly constructed CRectangle
    
    Returns:
    the newly created CRectangle.
  - newEllipse
```
public CEllipse newEllipse(java.awt.geom.Point2D p,
                  double w,
                  double h)
```
    Creates a new ellipse and add it to the canvas.
    
    Parameters:
    p - The upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    
    Returns:
    the newly created ellipse.
  - newEllipse
```
public CEllipse newEllipse(double x,
                  double y,
                  double w,
                  double h)
```
    Creates a new ellipse and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the upper left point of the bounding box.
    y - The y coordinate of the upper left point of the bounding box.
    w - The width of the bounding box.
    h - The height of the bounding box.
    
    Returns:
    the newly created ellipse.
  - newPolyLine
```
public CPolyLine newPolyLine(java.awt.geom.Point2D p)
```
    Create a new polyline and add it to the canvas.
    
    Parameters:
    p - The starting point.
    
    Returns:
    the newly created polyline.
  - newPolyLine
```
public CPolyLine newPolyLine()
```
    Create a new empty polyline and add it to the canvas.
    
    Returns:
    the newly created polyline.
  - newPolyLine
```
public CPolyLine newPolyLine(double x,
                    double y)
```
    Create a new polyline and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the starting point.
    y - The y coordinate of the starting point.
    
    Returns:
    the newly created polyline.
  - newText
```
public CText newText(java.awt.geom.Point2D p,
            java.lang.String text,
            java.awt.Font font)
```
    Create a new text and add it to the canvas.
    
    Parameters:
    p - The lower left point.
    text - The text to display.
    font - The font to use to render this text.
    
    Returns:
    the newly created text.
  - newText
```
public CText newText(java.awt.geom.Point2D p,
            java.lang.String text)
```
    Create a new text and add it to the canvas.
    
    Parameters:
    p - The lower left point.
    text - The text to display.
    
    Returns:
    the newly created text.
  - newText
```
public CText newText(double x,
            double y,
            java.lang.String text,
            java.awt.Font font)
```
    Create a new text and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    text - The text to display.
    font - The font to use to render this text.
    
    Returns:
    the newly created text.
  - newText
```
public CText newText(double x,
            double y,
            java.lang.String text)
```
    Create a new text and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    text - The text to display.
    
    Returns:
    the newly created text.
  - newImage
```
public CImage newImage(double x,
              double y,
              java.lang.String imageFile)
```
    Create a new image and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    imageFile - The name of the file image (gif, jpeg or png)
    
    Returns:
    the newly created image.
  - newImage
```
public CImage newImage(double x,
              double y,
              java.net.URL imageURL)
```
    Create a new image and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    imageURL - The url of the file image (gif, jpeg or png)
    
    Returns:
    the newly created image.
  - newImage
```
public CImage newImage(double x,
              double y,
              java.awt.image.BufferedImage image)
```
    Create a new image and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    image - The image
    
    Returns:
    the newly created image.
  - newImage
```
public CImage newImage(double x,
              double y,
              java.io.InputStream imageStream)
```
    Create a new image and add it to the canvas.
    
    Parameters:
    x - The x coordinate of the lower left point.
    y - The y coordinate of the lower left point.
    imageStream - The url of the file image (gif, jpeg or png)
    
    Returns:
    the newly created image.
  - newWidget
```
public CWidget newWidget(javax.swing.JComponent b)
```
    Create a new widget and add it to the canvas.
    
    Parameters:
    b - The swing widget.
    
    Returns:
    The newly created widget.
  - newWidget
```
public CWidget newWidget(javax.swing.JComponent b,
                double x,
                double y)
```
    Create a new widget and add it to the canvas (i.e. the widget is refreshed each time it receives an input event).
    
    Parameters:
    b - The swing widget.
    x - The x coordinate of the upper left point.
    y - The y coordinate of the upper left point.
    
    Returns:
    The newly created widget.
  - newDynamicWidget
```
public CDynamicWidget newDynamicWidget(javax.swing.JComponent b,
                              double x,
                              double y,
                              int delayInMilliseconds)
```
    Create a new dynamic widget and add it to the canvas (i.e. a widget that must be refreshed every delayInMilliseconds milliseconds, e.g. a video or an animated widget).
    
    Parameters:
    b - The swing widget.
    x - The x coordinate of the upper left point.
    y - The y coordinate of the upper left point.
    delayInMilliseconds - The refreshing rate
    
    Returns:
    The newly created widget.
  - newWidget
```
public CWidget newWidget(javax.swing.JComponent b,
                double x,
                double y,
                double w,
                double h)
```
    Create a new widget and add it to the canvas.
    
    Parameters:
    b - The swing widget.
    x - The x coordinate of the upper left point.
    y - The y coordinate of the upper left point.
    w - The width of the bounding box.
    h - The height of the bounding box.
    
    Returns:
    The newly created widget.
  - getSMs
```
public java.util.List<CStateMachine> getSMs()
```
    Returns the state machines attached to this canvas.
    
    Returns:
    the state machines attached to this canvas.
  - isAntialiased
```
public boolean isAntialiased()
```
    Returns True if the canvas is antialiased.
    
    Specified by:
    
    isAntialiased in interface CElement
    
    Returns:
    the value of the global antialiasing.
    See Also:
    CShape.isAntialiased()
  - setRenderingHint
```
public CElement setRenderingHint(java.awt.RenderingHints.Key hintKey,
                        java.lang.Object hintValue)
```
    Sets the rendering hints for every CShape drawn in this canvas (global rendering hints). NOTE: Calling this method instead of calling setRenderingHint for each shape in the canvas is more efficient (the same RenderingHints is referenced by all shapes).
    
    Specified by:
    
    setRenderingHint in interface CElement
    
    Parameters:
    hintKey - The hint key
    hintValue - The hint value
    
    Returns:
    this canvas
  - setAntialiased
```
public CElement setAntialiased(boolean a)
```
    Sets the antialiasing for every CShape drawn in this canvas (global antialiasing). NOTE: Calling this method instead of calling setAntialiased for each shape in the canvas is more efficient (the same RenderingHints is referenced by all shapes).
    
    Specified by:
    
    setAntialiased in interface CElement
    
    Parameters:
    a - True if the canvas is antialiased.
    
    Returns:
    this canvas
    See Also:
    CShape.setAntialiased(boolean)
  - newTag
```
public CNamedTag newTag(java.lang.String t)
```
    Returns a named tag object given its name. If a tag with this name already exists, return it, otherwise create a new one.
    
    Parameters:
    t - The name of the tag
    
    Returns:
    The tag.
  - 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.
  - 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.
  - 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)
  - 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()
  - 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 contained in this CElement is outlined.
    
    Specified by:
    
    isOutlined in interface CElement
    
    Returns:
    true if every shape contained in this CElement is outlined.
    See Also:
    CShape.isOutlined()
  - getOutlinedShapes
```
public java.util.LinkedList<CShape> getOutlinedShapes()
```
    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 contained in this CElement is drawable.
    
    Specified by:
    
    isDrawable in interface CElement
    
    Returns:
    true if every shape contained in this CElement 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 contained in this CElement is pickable.
    
    Specified by:
    
    isPickable in interface CElement
    
    Returns:
    true if every shape contained in this CElement 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)
  - fixReferenceShapeToCurrent
```
public CElement fixReferenceShapeToCurrent()
```
    Specified by:
    
    fixReferenceShapeToCurrent in interface CElement
  - 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()
  - 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
    y - The y coordinate
    
    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.
    
    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 R.
    
    Specified by:
    
    contains in interface CElement
    
    Parameters:
    x - The x coordinate of the upper left corner of R
    y - The y coordinate of the upper left corner of R
    w - The width of R
    h - The height of R
    
    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
    
    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
    
    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
    
    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
    
    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
    
    Returns:
    true if every shape with this tag also has tag t, false otherwise.
  - above
```
public CElement above(CElement before)
```
    Does Anything. Changes the display list order so that every CShape contained in this CElement is right above the top most shape in another CElement. The relative display order between shapes contained in this CElement is unchanged. WARNING: If this CElement also contains one of the elements contained in before, this method does nothing.
    
    Specified by:
    
    above in interface CElement
    
    Parameters:
    before - The element 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()
```
    Does Anything. Calls aboveAll() for every CShape contained in this CElement.
    
    Specified by:
    
    aboveAll in interface CElement
    
    Returns:
    This CElement
    See Also:
    CShape.aboveAll()
  - below
```
public CElement below(CElement after)
```
    Does Anything. Changes the display list order so that every CShape contained in this CElement is right below the top least shape in another CElement. The relative display order between shapes contained in this CElement is unchanged. WARNING: If this CElement also contains one of the elements contained in after, this method does nothing.
    
    Specified by:
    
    below in interface CElement
    
    Parameters:
    after - The element 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()
```
    Does Anything. 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)
```
    Sets the clip for every CShape drawn in this canvas (global rendering hints). NOTE: Calling this method instead of calling setClip for each shape in the canvas is more efficient (the same CShape clip is referenced by all shapes).
    
    Specified by:
    
    setClip in interface CElement
    
    Parameters:
    clip - The clipping shape
    
    Returns:
    this canvas
    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 contained in this CElement.
  - 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 contained in this CElement.
  - 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 contained in this CElement.
  - 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 contained in this CElement.
  - 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 contained in this CElement.
  - 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 contained in this CElement.
  - 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 contained in this CElement.
  - firstShape
```
public CShape firstShape()
```
    Returns the first shape contained in this CElement.
    
    Specified by:
    
    firstShape in interface CElement
    
    Returns:
    the first shape contained in this CElement, null if no shape is contained.
  - 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 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)
  - animate
```
public CElement animate(Animation anim)
```
    Calls animate(Animation animTagScale) for every CShape contained in this Canvas.
    
    Specified by:
    
    animate in interface CElement
    
    Parameters:
    anim - The animation to associate to each shape in this Canvas.
    
    Returns:
    this Canvas as a CElement
    See Also:
    CShape.animate(Animation)
  - getDisplayList
```
public java.util.List<CShape> getDisplayList()
```
    Returns:
    The display list of this canvas.
  - getClip
```
public java.awt.Shape getClip()
```
  - setClip
```
public void setClip(java.awt.Shape clip)
```

Class Canvas

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

Canvas

Canvas

Method Detail

getAllTags

getTag

getTag

paintComponent

processEvent

processEvent

contains

isTracking

mouseWheelMoved

mouseClicked

mouseReleased

mouseEntered

mouseExited

mouseDragged

mouseMoved

mousePressed

keyTyped

keyPressed

keyReleased

pick

pickAll

pickShapeHavingTag

pickShapeHavingTag

addShape

removeShape

removeShapes

removeAllShapes

newSegment

newSegment

newRectangle

newRectangle

newRoundRectangle

newRoundRectangle

newEllipse

newEllipse

newPolyLine

newPolyLine

newPolyLine

newText

newText

newText

newText

newImage

newImage

newImage

newImage

newWidget

newWidget

newDynamicWidget

newWidget

getSMs

isAntialiased

setRenderingHint

setAntialiased

newTag

getCanvas

attachSM

detachSM

setShape

setParent

setStroke