Overlay

java.lang.Object
- icy.painter.Overlay

All Implemented Interfaces:

ChangeListener, XMLPersistent, Painter, java.lang.Comparable<Overlay>

Direct Known Subclasses:

Anchor2D, Anchor3D, AnimatedOverlay, ImageOverlay, IntensityOverRoiPainter, OverlayPlugin1.SimpleCrossOverlay, OverlayWrapper, ROI.ROIPainter, VtkAnimatedEarthPainter, VtkComplexeSplinePainter, VtkCubePainter, VtkLabelPainter, VtkSpherePainter, VtkText2DPainter, VtkText3DPainter
```
public abstract class Overlay
extends java.lang.Object
implements Painter, ChangeListener, java.lang.Comparable<Overlay>, XMLPersistent
```
Overlay class.

This class allow interaction and rich informations display on Sequences.
IcyCanvas subclasses should propagate mouse and key events to overlay.

Author:

Stephane

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Overlay.OverlayPriority` Define the overlay priority: Lowest \| BACKGROUND (below image) \| IMAGE (image level) \| SHAPE (just over the image) \| TEXT (over image and shape) \| TOOLTIP (all over the rest) Highest \| TOPMOST (absolute topmost) You have 4 levels for each category (except TOPMOST) for finest adjustment: Lowest \| LOW \| NORMAL \| HIGH Highest \| TOP TOP level should be used to give focus to a specific Overlay over all other in the same category.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID_CANBEREMOVED`
`static java.lang.String`	`ID_CLASSNAME`
`static java.lang.String`	`ID_ID`
`static java.lang.String`	`ID_NAME`
`static java.lang.String`	`ID_OVERLAY`
`static java.lang.String`	`ID_PRIORITY`
`static java.lang.String`	`ID_READONLY`
`static java.lang.String`	`ID_RECEIVEKEYEVENTONHIDDEN`
`static java.lang.String`	`ID_RECEIVEMOUSEEVENTONHIDDEN`
`static int`	`LOD_SMALL` We consider as tiny object anything with a size of 10 pixels or less
`static int`	`LOD_TINY`
`static java.lang.String`	`PROPERTY_CANBEREMOVED`
`static java.lang.String`	`PROPERTY_NAME`
`static java.lang.String`	`PROPERTY_PERSISTENT`
`static java.lang.String`	`PROPERTY_PRIORITY`
`static java.lang.String`	`PROPERTY_READONLY`
`static java.lang.String`	`PROPERTY_RECEIVEKEYEVENTONHIDDEN`
`static java.lang.String`	`PROPERTY_RECEIVEMOUSEEVENTONHIDDEN`

Constructor Summary

Constructors
Constructor and Description

Overlay(java.lang.String name)

Overlay(java.lang.String name, Overlay.OverlayPriority priority)

Constructors
Constructor and Description
`Overlay(java.lang.String name)`
`Overlay(java.lang.String name, Overlay.OverlayPriority priority)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addOverlayListener(OverlayListener listener)` Add a listener.
`void`	`attachTo(Sequence sequence)` Deprecated. Use `Sequence.addOverlay(Overlay)` instead.
`void`	`beginUpdate()`
`void`	`changed()` Deprecated. Use `painterChanged()` instead.
`int`	`compareTo(Overlay o)`
`static Overlay`	`createFromXML(org.w3c.dom.Node node)` Create a Overlay from a XML node.
`void`	`detachFrom(Sequence sequence)` Deprecated. Use `Sequence.removeOverlay(Overlay)` instead.
`void`	`endUpdate()`
`java.util.List<IcyCanvas>`	`getAttachedCanvas()` Returns all canvas where the overlay is currently present as a layer.
`boolean`	`getCanBeRemoved()` Returns `true` if the overlay can be freely removed from the Canvas where it appears and `false` otherwise.
`java.lang.String`	`getName()`
`javax.swing.JPanel`	`getOptionsPanel()` Override this method to provide an extra options panel for the overlay.
`static int`	`getOverlayCount(org.w3c.dom.Node node)` Return the number of Overlay defined in the specified XML node.
`Overlay.OverlayPriority`	`getPriority()`
`boolean`	`getReceiveKeyEventOnHidden()`
`boolean`	`getReceiveMouseEventOnHidden()`
`java.util.List<Sequence>`	`getSequences()` Returns all sequences where the overlay is currently attached.
`boolean`	`isAttached(Sequence sequence)` Returns `true` if the overlay is attached to the specified `Sequence`.
`boolean`	`isFixed()` Deprecated. Use `getCanBeRemoved()` instead.
`boolean`	`isPersistent()` Return persistent property.
`boolean`	`isReadOnly()` Return read only property.
`boolean`	`isUpdating()`
`void`	`keyPressed(java.awt.event.KeyEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `keyPressed(KeyEvent, Point5D.Double, IcyCanvas)` instead
`void`	`keyPressed(java.awt.event.KeyEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Key press event forwarded to the overlay.
`void`	`keyReleased(java.awt.event.KeyEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `keyReleased(KeyEvent, Point5D.Double, IcyCanvas)` instead
`void`	`keyReleased(java.awt.event.KeyEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Key release event forwarded to the overlay.
`boolean`	`loadFromXML(org.w3c.dom.Node node)` LOAD
`boolean`	`loadFromXML(org.w3c.dom.Node node, boolean preserveId)`
`static java.util.List<Overlay>`	`loadOverlaysFromXML(org.w3c.dom.Node node)` Return a list of Overlay from a XML node.
`void`	`mouseClick(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseClick(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseClick(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse click event forwarded to the overlay.
`void`	`mouseDrag(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseDrag(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseDrag(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse drag event forwarded to the overlay.
`void`	`mouseEntered(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseEntered(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseEntered(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse enter event forwarded to the overlay.
`void`	`mouseExited(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseExited(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseExited(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse exit event forwarded to the overlay.
`void`	`mouseMove(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseMove(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseMove(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse move event forwarded to the overlay.
`void`	`mousePressed(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mousePressed(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mousePressed(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse press event forwarded to the overlay.
`void`	`mouseReleased(java.awt.event.MouseEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseReleased(MouseEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseReleased(java.awt.event.MouseEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse release event forwarded to the overlay.
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e, java.awt.geom.Point2D imagePoint, IcyCanvas canvas)` Deprecated. Use `mouseWheelMoved(MouseWheelEvent, Point5D.Double, IcyCanvas)` instead
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e, Point5D.Double imagePoint, IcyCanvas canvas)` Mouse wheel moved event forwarded to the overlay.
`void`	`onChanged(CollapsibleEvent object)` fire changed event
`void`	`paint(java.awt.Graphics2D g, Sequence sequence, IcyCanvas canvas)` Paint method called to draw the overlay.
`void`	`painterChanged()` Notify the painter content has changed.
`void`	`propertyChanged(java.lang.String propertyName)` Notify the overlay property has changed.
`void`	`remove()` Remove the Overlay from all sequences and canvas where it is currently attached.
`void`	`removeOverlayListener(OverlayListener listener)` Remove a listener.
`static void`	`saveOverlaysToXML(org.w3c.dom.Node node, java.util.List<Overlay> overlays)` Set a list of Overlay to a XML node.
`boolean`	`saveToXML(org.w3c.dom.Node node)` SAVE
`void`	`setCanBeRemoved(boolean value)` Set the `canBeRemoved` property.
`void`	`setFixed(boolean value)` Deprecated. Use `setCanBeRemoved(boolean)` instead.
`void`	`setName(java.lang.String name)`
`void`	`setPersistent(boolean value)` Set persistent property.
`void`	`setPriority(Overlay.OverlayPriority priority)`
`void`	`setReadOnly(boolean value)` Set read only property.
`void`	`setReceiveKeyEventOnHidden(boolean value)` Set to `true` if you want to overlay to receive `KeyEvent` even when it is not visible.
`void`	`setReceiveMouseEventOnHidden(boolean value)` Set to `true` if you want to overlay to receive `KeyEvent` even when it is not visible.

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

- Field Detail
  - ID_OVERLAY
```
public static final java.lang.String ID_OVERLAY
```
    See Also:
    Constant Field Values
  - ID_CLASSNAME
```
public static final java.lang.String ID_CLASSNAME
```
    See Also:
    Constant Field Values
  - ID_ID
```
public static final java.lang.String ID_ID
```
    See Also:
    Constant Field Values
  - ID_NAME
```
public static final java.lang.String ID_NAME
```
    See Also:
    Constant Field Values
  - ID_PRIORITY
```
public static final java.lang.String ID_PRIORITY
```
    See Also:
    Constant Field Values
  - ID_READONLY
```
public static final java.lang.String ID_READONLY
```
    See Also:
    Constant Field Values
  - ID_CANBEREMOVED
```
public static final java.lang.String ID_CANBEREMOVED
```
    See Also:
    Constant Field Values
  - ID_RECEIVEKEYEVENTONHIDDEN
```
public static final java.lang.String ID_RECEIVEKEYEVENTONHIDDEN
```
    See Also:
    Constant Field Values
  - ID_RECEIVEMOUSEEVENTONHIDDEN
```
public static final java.lang.String ID_RECEIVEMOUSEEVENTONHIDDEN
```
    See Also:
    Constant Field Values
  - PROPERTY_NAME
```
public static final java.lang.String PROPERTY_NAME
```
    See Also:
    Constant Field Values
  - PROPERTY_PRIORITY
```
public static final java.lang.String PROPERTY_PRIORITY
```
    See Also:
    Constant Field Values
  - PROPERTY_READONLY
```
public static final java.lang.String PROPERTY_READONLY
```
    See Also:
    Constant Field Values
  - PROPERTY_PERSISTENT
```
public static final java.lang.String PROPERTY_PERSISTENT
```
    See Also:
    Constant Field Values
  - PROPERTY_CANBEREMOVED
```
public static final java.lang.String PROPERTY_CANBEREMOVED
```
    See Also:
    Constant Field Values
  - PROPERTY_RECEIVEKEYEVENTONHIDDEN
```
public static final java.lang.String PROPERTY_RECEIVEKEYEVENTONHIDDEN
```
    See Also:
    Constant Field Values
  - PROPERTY_RECEIVEMOUSEEVENTONHIDDEN
```
public static final java.lang.String PROPERTY_RECEIVEMOUSEEVENTONHIDDEN
```
    See Also:
    Constant Field Values
  - LOD_SMALL
```
public static final int LOD_SMALL
```
    We consider as tiny object anything with a size of 10 pixels or less
    
    See Also:
    Constant Field Values
  - LOD_TINY
```
public static final int LOD_TINY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Overlay
```
public Overlay(java.lang.String name,
       Overlay.OverlayPriority priority)
```
  - Overlay
```
public Overlay(java.lang.String name)
```
- Method Detail
  - createFromXML
```
public static Overlay createFromXML(org.w3c.dom.Node node)
```
    Create a Overlay from a XML node.
    
    Parameters:
    node - XML node defining the overlay
    
    Returns:
    the created Overlay or null if the Overlay class does not support XML persistence a default constructor
  - getOverlayCount
```
public static int getOverlayCount(org.w3c.dom.Node node)
```
    Return the number of Overlay defined in the specified XML node.
    
    Parameters:
    node - XML node defining the Overlay list
    
    Returns:
    the number of Overlay defined in the XML node.
  - loadOverlaysFromXML
```
public static java.util.List<Overlay> loadOverlaysFromXML(org.w3c.dom.Node node)
```
    Return a list of Overlay from a XML node.
    
    Parameters:
    node - XML node defining the Overlay list
    
    Returns:
    a list of Overlay
  - saveOverlaysToXML
```
public static void saveOverlaysToXML(org.w3c.dom.Node node,
                     java.util.List<Overlay> overlays)
```
    Set a list of Overlay to a XML node.
    
    Parameters:
    node - XML node which is used to store the list of Overlay
    overlays - the list of Overlay to store in the XML node
  - getName
```
public java.lang.String getName()
```
    Returns:
    the name
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    name - the name to set
  - getPriority
```
public Overlay.OverlayPriority getPriority()
```
    Returns:
    the priority
  - setPriority
```
public void setPriority(Overlay.OverlayPriority priority)
```
    Parameters:
    priority - the priority to set
  - isAttached
```
public boolean isAttached(Sequence sequence)
```
    Returns true if the overlay is attached to the specified Sequence.
  - isFixed
```
@Deprecated
public boolean isFixed()
```
    Deprecated. Use getCanBeRemoved() instead.
    
    See Also:
    setCanBeRemoved(boolean)
  - setFixed
```
@Deprecated
public void setFixed(boolean value)
```
    Deprecated. Use setCanBeRemoved(boolean) instead.
  - getCanBeRemoved
```
public boolean getCanBeRemoved()
```
    Returns true if the overlay can be freely removed from the Canvas where it appears and false otherwise.
    
    See Also:
    setCanBeRemoved(boolean)
  - setCanBeRemoved
```
public void setCanBeRemoved(boolean value)
```
    Set the canBeRemoved property.
    Set it to false if you want to prevent the overlay to be removed from the Canvas where it appears.
  - isPersistent
```
public boolean isPersistent()
```
    Return persistent property.
    When set to true the Overlay will be saved in the Sequence persistent XML data.
  - setPersistent
```
public void setPersistent(boolean value)
```
    Set persistent property.
    When set to true the Overlay will be saved in the Sequence persistent XML data (default is false).
  - isReadOnly
```
public boolean isReadOnly()
```
    Return read only property.
    When set to true we cannot anymore modify overlay properties from the GUI.
  - setReadOnly
```
public void setReadOnly(boolean value)
```
    Set read only property.
    When set to true we cannot anymore modify overlay properties from the GUI.
  - getReceiveKeyEventOnHidden
```
public boolean getReceiveKeyEventOnHidden()
```
    Returns:
    true is the overlay should receive KeyEvent even when it is not visible.
  - setReceiveKeyEventOnHidden
```
public void setReceiveKeyEventOnHidden(boolean value)
```
    Set to true if you want to overlay to receive KeyEvent even when it is not visible.
  - getReceiveMouseEventOnHidden
```
public boolean getReceiveMouseEventOnHidden()
```
    Returns:
    true is the overlay should receive MouseEvent even when it is not visible.
  - setReceiveMouseEventOnHidden
```
public void setReceiveMouseEventOnHidden(boolean value)
```
    Set to true if you want to overlay to receive KeyEvent even when it is not visible.
  - getOptionsPanel
```
public javax.swing.JPanel getOptionsPanel()
```
    Override this method to provide an extra options panel for the overlay.
    The options panel will appears in the inspector when the layer's overlay is selected.
  - attachTo
```
@Deprecated
public void attachTo(Sequence sequence)
```
    Deprecated. Use Sequence.addOverlay(Overlay) instead.
  - detachFrom
```
@Deprecated
public void detachFrom(Sequence sequence)
```
    Deprecated. Use Sequence.removeOverlay(Overlay) instead.
  - remove
```
public void remove()
```
    Remove the Overlay from all sequences and canvas where it is currently attached.
  - getSequences
```
public java.util.List<Sequence> getSequences()
```
    Returns all sequences where the overlay is currently attached.
  - getAttachedCanvas
```
public java.util.List<IcyCanvas> getAttachedCanvas()
```
    Returns all canvas where the overlay is currently present as a layer.
  - beginUpdate
```
public void beginUpdate()
```
  - endUpdate
```
public void endUpdate()
```
  - isUpdating
```
public boolean isUpdating()
```
  - changed
```
@Deprecated
public void changed()
```
    Deprecated. Use painterChanged() instead.
  - painterChanged
```
public void painterChanged()
```
    Notify the painter content has changed.
    All sequence containing the overlay will be repainted to reflect the change.
  - propertyChanged
```
public void propertyChanged(java.lang.String propertyName)
```
    Notify the overlay property has changed.
  - onChanged
```
public void onChanged(CollapsibleEvent object)
```
    Description copied from interface: ChangeListener
    
    fire changed event
    
    Specified by:
    
    onChanged in interface ChangeListener
  - addOverlayListener
```
public void addOverlayListener(OverlayListener listener)
```
    Add a listener.
  - removeOverlayListener
```
public void removeOverlayListener(OverlayListener listener)
```
    Remove a listener.
  - paint
```
public void paint(java.awt.Graphics2D g,
         Sequence sequence,
         IcyCanvas canvas)
```
    Paint method called to draw the overlay.
    
    Specified by:
    
    paint in interface Painter
  - mousePressed
```
@Deprecated
public void mousePressed(java.awt.event.MouseEvent e,
                           java.awt.geom.Point2D imagePoint,
                           IcyCanvas canvas)
```
    Deprecated. Use mousePressed(MouseEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Mouse press event forwarded to the painter.
    
    Specified by:
    
    mousePressed in interface Painter
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseReleased
```
@Deprecated
public void mouseReleased(java.awt.event.MouseEvent e,
                            java.awt.geom.Point2D imagePoint,
                            IcyCanvas canvas)
```
    Deprecated. Use mouseReleased(MouseEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Mouse release event forwarded to the painter.
    
    Specified by:
    
    mouseReleased in interface Painter
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseClick
```
@Deprecated
public void mouseClick(java.awt.event.MouseEvent e,
                         java.awt.geom.Point2D imagePoint,
                         IcyCanvas canvas)
```
    Deprecated. Use mouseClick(MouseEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Mouse click event forwarded to the painter.
    
    Specified by:
    
    mouseClick in interface Painter
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseMove
```
@Deprecated
public void mouseMove(java.awt.event.MouseEvent e,
                        java.awt.geom.Point2D imagePoint,
                        IcyCanvas canvas)
```
    Deprecated. Use mouseMove(MouseEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Mouse move event forwarded to the painter.
    
    Specified by:
    
    mouseMove in interface Painter
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseDrag
```
@Deprecated
public void mouseDrag(java.awt.event.MouseEvent e,
                        java.awt.geom.Point2D imagePoint,
                        IcyCanvas canvas)
```
    Deprecated. Use mouseDrag(MouseEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Mouse drag event forwarded to the painter.
    
    Specified by:
    
    mouseDrag in interface Painter
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseEntered
```
@Deprecated
public void mouseEntered(java.awt.event.MouseEvent e,
                           java.awt.geom.Point2D imagePoint,
                           IcyCanvas canvas)
```
    Deprecated. Use mouseEntered(MouseEvent, Point5D.Double, IcyCanvas) instead
  - mouseExited
```
@Deprecated
public void mouseExited(java.awt.event.MouseEvent e,
                          java.awt.geom.Point2D imagePoint,
                          IcyCanvas canvas)
```
    Deprecated. Use mouseExited(MouseEvent, Point5D.Double, IcyCanvas) instead
  - mouseWheelMoved
```
@Deprecated
public void mouseWheelMoved(java.awt.event.MouseWheelEvent e,
                              java.awt.geom.Point2D imagePoint,
                              IcyCanvas canvas)
```
    Deprecated. Use mouseWheelMoved(MouseWheelEvent, Point5D.Double, IcyCanvas) instead
  - keyPressed
```
@Deprecated
public void keyPressed(java.awt.event.KeyEvent e,
                         java.awt.geom.Point2D imagePoint,
                         IcyCanvas canvas)
```
    Deprecated. Use keyPressed(KeyEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Key press event forwarded to the painter.
    
    Specified by:
    
    keyPressed in interface Painter
    
    Parameters:
    e - key event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - keyReleased
```
@Deprecated
public void keyReleased(java.awt.event.KeyEvent e,
                          java.awt.geom.Point2D imagePoint,
                          IcyCanvas canvas)
```
    Deprecated. Use keyReleased(KeyEvent, Point5D.Double, IcyCanvas) instead
    
    Description copied from interface: Painter
    
    Key release event forwarded to the painter.
    
    Specified by:
    
    keyReleased in interface Painter
    
    Parameters:
    e - key event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e,
                Point5D.Double imagePoint,
                IcyCanvas canvas)
```
    Mouse press event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e,
                 Point5D.Double imagePoint,
                 IcyCanvas canvas)
```
    Mouse release event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseClick
```
public void mouseClick(java.awt.event.MouseEvent e,
              Point5D.Double imagePoint,
              IcyCanvas canvas)
```
    Mouse click event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseMove
```
public void mouseMove(java.awt.event.MouseEvent e,
             Point5D.Double imagePoint,
             IcyCanvas canvas)
```
    Mouse move event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseDrag
```
public void mouseDrag(java.awt.event.MouseEvent e,
             Point5D.Double imagePoint,
             IcyCanvas canvas)
```
    Mouse drag event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e,
                Point5D.Double imagePoint,
                IcyCanvas canvas)
```
    Mouse enter event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e,
               Point5D.Double imagePoint,
               IcyCanvas canvas)
```
    Mouse exit event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent e,
                   Point5D.Double imagePoint,
                   IcyCanvas canvas)
```
    Mouse wheel moved event forwarded to the overlay.
    
    Parameters:
    e - mouse event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent e,
              Point5D.Double imagePoint,
              IcyCanvas canvas)
```
    Key press event forwarded to the overlay.
    
    Parameters:
    e - key event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent e,
               Point5D.Double imagePoint,
               IcyCanvas canvas)
```
    Key release event forwarded to the overlay.
    
    Parameters:
    e - key event
    imagePoint - mouse position (image coordinates)
    canvas - icy canvas
  - loadFromXML
```
public boolean loadFromXML(org.w3c.dom.Node node,
                  boolean preserveId)
```
  - loadFromXML
```
public boolean loadFromXML(org.w3c.dom.Node node)
```
    Description copied from interface: XMLPersistent
    
    LOAD
    
    Specified by:
    
    loadFromXML in interface XMLPersistent
  - saveToXML
```
public boolean saveToXML(org.w3c.dom.Node node)
```
    Description copied from interface: XMLPersistent
    
    SAVE
    
    Specified by:
    
    saveToXML in interface XMLPersistent
  - compareTo
```
public int compareTo(Overlay o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Overlay>

Class Overlay

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_OVERLAY

ID_CLASSNAME

ID_ID

ID_NAME

ID_PRIORITY

ID_READONLY

ID_CANBEREMOVED

ID_RECEIVEKEYEVENTONHIDDEN

ID_RECEIVEMOUSEEVENTONHIDDEN

PROPERTY_NAME

PROPERTY_PRIORITY

PROPERTY_READONLY

PROPERTY_PERSISTENT

PROPERTY_CANBEREMOVED

PROPERTY_RECEIVEKEYEVENTONHIDDEN

PROPERTY_RECEIVEMOUSEEVENTONHIDDEN

LOD_SMALL

LOD_TINY

Constructor Detail

Overlay

Overlay

Method Detail

createFromXML

getOverlayCount

loadOverlaysFromXML

saveOverlaysToXML

getName

setName

getPriority

setPriority

isAttached

isFixed

setFixed

getCanBeRemoved

setCanBeRemoved

isPersistent

setPersistent

isReadOnly

setReadOnly

getReceiveKeyEventOnHidden

setReceiveKeyEventOnHidden

getReceiveMouseEventOnHidden

setReceiveMouseEventOnHidden

getOptionsPanel

attachTo

detachFrom

remove

getSequences

getAttachedCanvas

beginUpdate

endUpdate

isUpdating

changed

painterChanged

propertyChanged

onChanged

addOverlayListener

removeOverlayListener

paint

mousePressed

mouseReleased

mouseClick

mouseMove

mouseDrag

mouseEntered

mouseExited

mouseWheelMoved

keyPressed

keyReleased

mousePressed

mouseReleased

mouseClick

mouseMove