IcyCanvas

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - icy.canvas.IcyCanvas

All Implemented Interfaces:

Layer.LayerListener, ChangeListener, ViewerListener, LUTListener, SequenceListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

IcyCanvas2D, IcyCanvas3D
```
public abstract class IcyCanvas
extends javax.swing.JPanel
implements java.awt.event.KeyListener, ViewerListener, SequenceListener, LUTListener, ChangeListener, Layer.LayerListener
```
Author:

Fabrice de Chaumont & Stephane Dallongeville

An IcyCanvas is a basic Canvas used into the viewer. It contains a visual representation of the sequence and provides some facilities as basic transformation and view synchronization.
Also IcyCanvas receives key events from Viewer when they are not consumed.

By default transformations are applied in following order :
Rotation, Translation then Scaling.
The rotation transformation is relative to canvas center.

Free feel to implement and override this design or not.

(Canvas2D and Canvas3D derives from IcyCanvas)

See Also:
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
Modifier and Type Field and Description

static java.lang.String PROPERTY_LAYERS_VISIBLE
- 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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROPERTY_LAYERS_VISIBLE`

Constructor Summary

Constructors
Constructor and Description

IcyCanvas(Viewer viewer)
Constructor

Constructors
Constructor and Description
`IcyCanvas(Viewer viewer)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCanvasListener(IcyCanvasListener listener)` Add a IcyCanvas listener
`Layer`	`addLayer(Overlay overlay)`
`void`	`addLayer(Painter painter)` Deprecated. Use `addLayer(Overlay)` instead.
`void`	`addLayerListener(CanvasLayerListener listener)` Add a layer listener
`void`	`addLayersListener(CanvasLayerListener listener)` Deprecated. Use `addLayerListener(CanvasLayerListener)` instead.
`void`	`addViewerToolbarComponents(javax.swing.JToolBar toolBar)` Deprecated. Use `customizeToolbar(JToolBar)` instead.
`static void`	`addVisibleLayerToList(Layer layer, java.util.ArrayList<Layer> list)`
`void`	`beginUpdate()`
`double`	`canvasToImageC(int value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
`double`	`canvasToImageDeltaC(int value)` Convert specified canvas delta C to image delta C.
`double`	`canvasToImageDeltaT(int value)` Convert specified canvas delta T to image delta T.
`double`	`canvasToImageDeltaX(int value)` Convert specified canvas delta X to image delta X.
`double`	`canvasToImageDeltaY(int value)` Convert specified canvas delta Y to image delta Y.
`double`	`canvasToImageDeltaZ(int value)` Convert specified canvas delta Z to image delta Z.
`double`	`canvasToImageLogDeltaX(int value)` Convert specified canvas delta X to log image delta X.
`double`	`canvasToImageLogDeltaX(int value, double logFactor)` Convert specified canvas delta X to log image delta X.
`double`	`canvasToImageLogDeltaY(int value)` Convert specified canvas delta Y to log image delta Y.
`double`	`canvasToImageLogDeltaY(int value, double logFactor)` Convert specified canvas delta Y to log image delta Y.
`double`	`canvasToImageLogDeltaZ(int value)` Convert specified canvas delta Z to log image delta Z.
`double`	`canvasToImageLogDeltaZ(int value, double logFactor)` Convert specified canvas delta Z to log image delta Z.
`double`	`canvasToImageT(int value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
`double`	`canvasToImageX(int value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
`double`	`canvasToImageY(int value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
`double`	`canvasToImageZ(int value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
`void`	`changed(IcyCanvasEvent event)` canvas changed (packed event).
`static IcyCanvas`	`create(java.lang.String className, Viewer viewer)` Create a `IcyCanvas` object from its class name or `PluginCanvas` class name.
`void`	`customizeToolbar(javax.swing.JToolBar toolBar)` Called by the parent viewer when building the toolbar.
`void`	`endUpdate()`
`int`	`getC()` Deprecated. uses getPositionC() instead
`static java.lang.String`	`getCanvasClassName(PluginDescriptor plugin)` Returns the canvas class name corresponding to the specified `PluginCanvas` plugin.
`static java.lang.String`	`getCanvasClassName(java.lang.String pluginClassName)` Returns the canvas class name corresponding to the specified `PluginCanvas` class name.
`int`	`getCanvasOffsetC()` Deprecated. use getOffsetC() instead
`int`	`getCanvasOffsetT()` Deprecated. use getOffsetT() instead
`int`	`getCanvasOffsetX()` Deprecated. use getOffsetX() instead
`int`	`getCanvasOffsetY()` Deprecated. use getOffsetY() instead
`int`	`getCanvasOffsetZ()` Deprecated. use getOffsetZ() instead
`static java.util.List<java.lang.String>`	`getCanvasPluginNames()` Returns all `PluginCanvas` plugins class name (kernel plugin are returned first).
`static java.util.List<PluginDescriptor>`	`getCanvasPlugins()` Returns all `PluginCanvas` plugins (kernel plugin are returned first).
`int`	`getCanvasSize(DimensionId dim)` Get canvas view size for specified Dimension
`int`	`getCanvasSizeC()` Returns the canvas view size C.
`int`	`getCanvasSizeT()` Returns the canvas view size T.
`int`	`getCanvasSizeX()` Returns the canvas view size X.
`int`	`getCanvasSizeY()` Returns the canvas view size Y.
`int`	`getCanvasSizeZ()` Returns the canvas view size Z.
`IcyBufferedImage`	`getCurrentImage()` Get the current image.
`boolean`	`getDrawLayers()` Deprecated. Use `isLayersVisible()` instead.
`int`	`getFrameRate()` Returns the frame rate (given in frame per second) for play command (T navigation panel).
`IcyBufferedImage`	`getImage(int t, int z)` Deprecated. Use `getImage(int, int, int)` with C = -1 instead.
`IcyBufferedImage`	`getImage(int t, int z, int c)` Gets the image at position (t, z, c).
`int`	`getImageCanvasSize(DimensionId dim)` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`int`	`getImageCanvasSizeC()` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`int`	`getImageCanvasSizeT()` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`int`	`getImageCanvasSizeX()` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`int`	`getImageCanvasSizeY()` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`int`	`getImageCanvasSizeZ()` Deprecated. doesn't take rotation transformation in account. Use IcyCanvasXD.getImageCanvasSize(..) instead
`Layer`	`getImageLayer()` Returns the `Layer` object used to display the current sequence image
`int`	`getImageOffsetC()` Deprecated. use getOffsetC() instead
`int`	`getImageOffsetT()` Deprecated. use getOffsetT() instead
`int`	`getImageOffsetX()` Deprecated. use getOffsetX() instead
`int`	`getImageOffsetY()` Deprecated. use getOffsetY() instead
`int`	`getImageOffsetZ()` Deprecated. use getOffsetZ() instead
`Overlay`	`getImageOverlay()` Returns the `Overlay` used to display the current sequence image
`int`	`getImageSize(DimensionId dim)` Get image size for specified Dimension
`int`	`getImageSizeC()` Get image size C
`int`	`getImageSizeT()` Get image size T
`int`	`getImageSizeX()` Get image size X
`int`	`getImageSizeY()` Get image size Y
`int`	`getImageSizeZ()` Get image size Z
`Layer`	`getLayer(Overlay overlay)` Find the layer corresponding to the specified Overlay
`Layer`	`getLayer(Painter painter)` Deprecated. Use `getLayer(Overlay)` instead.
`Layer`	`getLayer(ROI roi)` Find the layer corresponding to the specified ROI (use the ROI overlay internally).
`java.util.List<Layer>`	`getLayers()` Returns all layers attached to this canvas.
`java.util.List<Layer>`	`getLayers(boolean sorted)` Returns all layers attached to this canvas.
`java.util.List<Painter>`	`getLayersPainter()` Deprecated. Use `getOverlays()` instead.
`LUT`	`getLut()`
`double`	`getMax(DimensionId dim)` Deprecated. Use `getMaxPosition(DimensionId)` instead
`int`	`getMaxC()` Deprecated. Use `getMaxPositionC()` instead
`double`	`getMaxPosition(DimensionId dim)` Get maximum position for specified dimension
`Point5D.Integer`	`getMaxPosition5D()` Get the maximum 5D position for the canvas.
`int`	`getMaxPositionC()` Get maximum C value
`int`	`getMaxPositionT()` Get maximum T value
`int`	`getMaxPositionX()` Get maximum X value
`int`	`getMaxPositionY()` Get maximum Y value
`int`	`getMaxPositionZ()` Get maximum Z value
`int`	`getMaxT()` Deprecated. Use `getMaxPositionT()` instead
`int`	`getMaxX()` Deprecated. Use `getMaxPositionX()` instead
`int`	`getMaxY()` Deprecated. Use `getMaxPositionY()` instead
`int`	`getMaxZ()` Deprecated. Use `getMaxPositionZ()` instead
`MouseImageInfosPanel`	`getMouseImageInfosPanel()`
`double`	`getMouseImagePos(DimensionId dim)` Get mouse image position for specified Dimension
`Point5D.Double`	`getMouseImagePos5D()` Returns the 5D mouse image position
`double`	`getMouseImagePosC()` mouse C image position
`double`	`getMouseImagePosT()` mouse T image position
`double`	`getMouseImagePosX()` mouse X image position
`double`	`getMouseImagePosY()` mouse Y image position
`double`	`getMouseImagePosZ()` mouse Z image position
`java.awt.Point`	`getMousePos()` Returns the mouse position (in canvas coordinate space).
`int`	`getNumSelectedSamples()` Return the number of "selected" samples
`int`	`getOffset(DimensionId dim)` Get offset for specified Dimension
`Point5D.Integer`	`getOffset5D()` Returns the 5D offset.
`int`	`getOffsetC()` C offset
`int`	`getOffsetT()` T offset
`int`	`getOffsetX()` X offset
`int`	`getOffsetY()` Y offset
`int`	`getOffsetZ()` Z offset
`java.util.List<Layer>`	`getOrderedLayersForEvent()` Deprecated. Use `getLayers()` instead (sorted on Layer priority).
`java.util.Set<Overlay>`	`getOverlays()` Directly returns a `Set` of all Overlay displayed by this canvas.
`javax.swing.JPanel`	`getPanel()` Returns the setting panel of this canvas.
`static java.lang.String`	`getPluginClassName(java.lang.String canvasClassName)` Returns the plugin class name corresponding to the specified Canvas class name.
`int`	`getPosition(DimensionId dim)` Get position for specified dimension
`Point5D.Integer`	`getPosition5D()` Returns the 5D canvas position (-1 mean that the complete dimension is selected)
`int`	`getPositionC()`
`int`	`getPositionT()`
`int`	`getPositionX()`
`int`	`getPositionY()`
`int`	`getPositionZ()`
`java.awt.image.BufferedImage`	`getRenderedImage(int t, int z, int c)` Deprecated. Use `getRenderedImage(int, int, int, boolean)` instead.
`abstract java.awt.image.BufferedImage`	`getRenderedImage(int t, int z, int c, boolean canvasView)` Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
`java.awt.image.BufferedImage`	`getRenderedImage(int t, int z, int c, int imageType, boolean canvasView)` Deprecated. use `getRenderedImage(int, int, int, boolean)` instead
`Sequence`	`getRenderedSequence()` Deprecated. Use `getRenderedSequence(boolean, ProgressListener)` instead.
`Sequence`	`getRenderedSequence(boolean canvasView)` Deprecated. Use `getRenderedSequence(boolean, ProgressListener)` instead.
`Sequence`	`getRenderedSequence(boolean canvasView, ProgressListener progressListener)` Return a sequence which contains rendered images.
`Sequence`	`getRenderedSequence(int imageType, boolean canvasView)` Deprecated. use `getRenderedSequence(boolean)` instead
`double`	`getRotation(DimensionId dim)` Get rotation angle (radian) for specified Dimension
`double`	`getRotationC()` C rotation angle (radian)
`double`	`getRotationT()` T rotation angle (radian)
`double`	`getRotationX()` X rotation angle (radian)
`double`	`getRotationY()` Y rotation angle (radian)
`double`	`getRotationZ()` Z rotation angle (radian)
`double`	`getScale(DimensionId dim)` Get scale factor for specified Dimension
`double`	`getScaleC()` C scale factor
`double`	`getScaleFactorC()` Deprecated. use getScaleC() instead
`double`	`getScaleFactorT()` Deprecated. use getScaleT() instead
`double`	`getScaleFactorX()` Deprecated. use getScaleX() instead
`double`	`getScaleFactorY()` Deprecated. use getScaleY() instead
`double`	`getScaleFactorZ()` Deprecated. use getScaleZ() instead
`double`	`getScaleT()` T scale factor
`double`	`getScaleX()` X scale factor
`double`	`getScaleY()` Y scale factor
`double`	`getScaleZ()` Z scale factor
`Sequence`	`getSequence()`
`int`	`getSyncId()`
`int`	`getT()` Deprecated. uses getPositionT() instead
`TNavigationPanel`	`getTNavigationPanel()`
`abstract java.awt.Component`	`getViewComponent()`
`Viewer`	`getViewer()`
`java.util.ArrayList<Layer>`	`getVisibleLayers()` Returns all visible layers (visible property set to `true`) attached to this canvas.
`java.util.List<Layer>`	`getVisibleLayers(boolean sorted)` Returns all visible layers (visible property set to `true`) attached to this canvas.
`java.util.List<Layer>`	`getVisibleOrderedLayersForEvent()` Deprecated. Use `getVisibleLayers()` instead (sorted on Layer priority).
`int`	`getZ()` Deprecated. uses getPositionZ() instead
`ZNavigationPanel`	`getZNavigationPanel()`
`boolean`	`hasLayer(Layer layer)`
`boolean`	`hasLayer(Overlay overlay)` Returns true if the canvas contains a layer for the specified `Overlay`.
`boolean`	`hasLayer(Painter painter)` Deprecated. Use `hasLayer(Overlay)` instead.
`int`	`imageToCanvasC(double value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
`int`	`imageToCanvasDeltaC(double value)` Convert specified image delta C to canvas delta C.
`int`	`imageToCanvasDeltaT(double value)` Convert specified image delta T to canvas delta T.
`int`	`imageToCanvasDeltaX(double value)` Convert specified image delta X to canvas delta X.
`int`	`imageToCanvasDeltaY(double value)` Convert specified image delta Y to canvas delta Y.
`int`	`imageToCanvasDeltaZ(double value)` Convert specified image delta Z to canvas delta Z.
`int`	`imageToCanvasT(double value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
`int`	`imageToCanvasX(double value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
`int`	`imageToCanvasY(double value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
`int`	`imageToCanvasZ(double value)` Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
`boolean`	`isLayersVisible()` Return true if layers are visible on the canvas.
`boolean`	`isSynchHeader()` Deprecated. Use `isSynchMaster()` instead.
`boolean`	`isSynchMaster()` Return true if current canvas is synchronized and is currently the synchronize leader.
`boolean`	`isSynchOnCursor()` Return true if this canvas is synchronized on cursor (mouse cursor)
`boolean`	`isSynchOnSlice()` Return true if this canvas is synchronized on slice (T and Z position)
`boolean`	`isSynchOnView()` Return true if this canvas is synchronized on view (offset, zoom and rotation).
`boolean`	`isSynchronizationSupported()` Return true if this canvas support synchronization
`boolean`	`isSynchronized()` Return true if this canvas is synchronized
`boolean`	`isSynchSlave()` Return true if current canvas is synchronized and it's not the synchronize master
`boolean`	`isUpdating()`
`boolean`	`isVisible(Overlay overlay)` Returns `true` if the specified overlay is visible in the canvas.
`void`	`keyPressed(java.awt.event.KeyEvent e)`
`void`	`keyReleased(java.awt.event.KeyEvent e)`
`void`	`keyTyped(java.awt.event.KeyEvent e)`
`void`	`layerChanged(Layer layer, java.lang.String propertyName)` layer has changed
`void`	`lutChanged(LUTEvent event)`
`void`	`mouseClick(java.awt.event.MouseEvent event)` Helper to forward mouse click event to the overlays.
`void`	`mouseClick(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse click event to the overlays.
`void`	`mouseDrag(java.awt.event.MouseEvent event)` Helper to forward mouse drag event to the overlays.
`void`	`mouseDrag(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse drag event to the overlays.
`void`	`mouseEntered(java.awt.event.MouseEvent event)` Helper to forward mouse entered event to the overlays.
`void`	`mouseEntered(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse enter event to the overlays.
`void`	`mouseExited(java.awt.event.MouseEvent event)` Helper to forward mouse exited event to the overlays.
`void`	`mouseExited(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse exit event to the overlays.
`void`	`mouseImagePositionChanged(DimensionId dim)` Called when mouse image position changed
`void`	`mouseMove(java.awt.event.MouseEvent event)` Helper to forward mouse mouse event to the overlays.
`void`	`mouseMove(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse move event to the overlays.
`void`	`mousePressed(java.awt.event.MouseEvent event)` Helper to forward mouse press event to the overlays.
`void`	`mousePressed(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse press event to the overlays.
`void`	`mouseReleased(java.awt.event.MouseEvent event)` Helper to forward mouse release event to the overlays.
`void`	`mouseReleased(java.awt.event.MouseEvent event, Point5D.Double pt)` Helper to forward mouse release event to the overlays.
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent event)` Helper to forward mouse wheel event to the overlays.
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent event, Point5D.Double pt)` Helper to forward mouse wheel event to the overlays.
`void`	`offsetChanged(DimensionId dim)` Called when canvas offset changed
`void`	`onChanged(CollapsibleEvent event)` fire changed event
`abstract void`	`refresh()` Force canvas refresh
`void`	`removeCanvasListener(IcyCanvasListener listener)` Remove a IcyCanvas listener
`void`	`removeLayer(Layer layer)` Remove the specified layer from the canvas.
`boolean`	`removeLayer(Overlay overlay)` Remove the layer for the specified `Overlay` from the canvas.
`void`	`removeLayer(Painter painter)` Deprecated. Use `removeLayer(Overlay)` instead.
`void`	`removeLayerListener(CanvasLayerListener listener)` Remove a layer listener
`void`	`removeLayersListener(CanvasLayerListener listener)` Deprecated. Use `removeLayerListener(CanvasLayerListener)` instead.
`void`	`rotationChanged(DimensionId dim)` Called when rotation angle changed
`void`	`scaleChanged(DimensionId dim)` Called when scale factor changed
`void`	`sequenceChanged(SequenceEvent event)` Called when sequence has changed (type, data, metadata or property).
`void`	`sequenceClosed(Sequence sequence)` Called when sequence has been closed (all viewers displaying it closed).
`void`	`setC(int c)` Deprecated. uses setPositionC(int) instead
`void`	`setDrawLayers(boolean value)` Deprecated. Use `setLayersVisible(boolean)` instead.
`void`	`setFrameRate(int fps)` Sets the frame rate (given in frame per second) for play command (T navigation panel).
`void`	`setLayersVisible(boolean value)` Make layers visible on this canvas (default = true).
`void`	`setMouseImagePos(DimensionId dim, double value)` Set mouse image position for specified dimension (required for synchronization)
`void`	`setMouseImagePosC(double value)` Set mouse C image position
`void`	`setMouseImagePosT(double value)` Set mouse T image position
`void`	`setMouseImagePosX(double value)` Set mouse X image position
`void`	`setMouseImagePosY(double value)` Set mouse Y image position
`void`	`setMouseImagePosZ(double value)` Set mouse Z image position
`boolean`	`setMousePos(int x, int y)` Set mouse position (in canvas coordinate space).
`void`	`setMousePos(java.awt.Point point)` Set mouse position (in canvas coordinate space)
`void`	`setOffset(DimensionId dim, int value)` Set offset for specified dimension
`void`	`setOffsetC(int value)` Set offset C
`void`	`setOffsetT(int value)` Set offset T
`void`	`setOffsetX(int value)` Set offset X
`void`	`setOffsetY(int value)` Set offset Y
`void`	`setOffsetZ(int value)` Set offset Z
`void`	`setPosition(DimensionId dim, int value)` Set position for specified dimension
`void`	`setPositionC(int c)` Set C position
`void`	`setPositionT(int t)` Set T position
`void`	`setPositionX(int x)` Set X position
`void`	`setPositionY(int y)` Set Y position
`void`	`setPositionZ(int z)` Set Z position
`void`	`setRotation(DimensionId dim, double value)` Set rotation angle (radian) for specified dimension
`void`	`setRotationC(double value)` Set C rotation angle (radian)
`void`	`setRotationT(double value)` Set T rotation angle (radian)
`void`	`setRotationX(double value)` Set X rotation angle (radian)
`void`	`setRotationY(double value)` Set Y rotation angle (radian)
`void`	`setRotationZ(double value)` Set Z rotation angle (radian)
`void`	`setScale(DimensionId dim, double value)` Set scale factor for specified dimension
`void`	`setScaleC(double value)` Set scale factor C
`void`	`setScaleT(double value)` Set scale factor T
`void`	`setScaleX(double value)` Set scale factor X
`void`	`setScaleY(double value)` Set scale factor Y
`void`	`setScaleZ(double value)` Set scale factor Z
`boolean`	`setSyncId(int id)` Set the synchronization group id (0 means unsynchronized).
`void`	`setT(int t)` Deprecated. uses setPositionT(int) instead
`void`	`setZ(int z)` Deprecated. uses setPositionZ(int) instead
`void`	`shutDown()` Called by the viewer when canvas is closed to release some resources.
`void`	`viewerChanged(ViewerEvent event)`
`void`	`viewerClosed(Viewer viewer)`

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

- Field Detail
  - PROPERTY_LAYERS_VISIBLE
```
public static final java.lang.String PROPERTY_LAYERS_VISIBLE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - IcyCanvas
```
public IcyCanvas(Viewer viewer)
```
    Constructor
    
    Parameters:
    viewer -
- Method Detail
  - getCanvasPlugins
```
public static java.util.List<PluginDescriptor> getCanvasPlugins()
```
    Returns all PluginCanvas plugins (kernel plugin are returned first).
  - getCanvasPluginNames
```
public static java.util.List<java.lang.String> getCanvasPluginNames()
```
    Returns all PluginCanvas plugins class name (kernel plugin are returned first).
  - getPluginClassName
```
public static java.lang.String getPluginClassName(java.lang.String canvasClassName)
```
    Returns the plugin class name corresponding to the specified Canvas class name.
    Returns null if we can't find a corresponding plugin.
  - getCanvasClassName
```
public static java.lang.String getCanvasClassName(PluginDescriptor plugin)
```
    Returns the canvas class name corresponding to the specified PluginCanvas plugin.
    Returns null if we can't retrieve the corresponding canvas class name.
  - getCanvasClassName
```
public static java.lang.String getCanvasClassName(java.lang.String pluginClassName)
```
    Returns the canvas class name corresponding to the specified PluginCanvas class name.
    Returns null if we can't find retrieve the corresponding canvas class name.
  - create
```
public static IcyCanvas create(java.lang.String className,
               Viewer viewer)
                        throws java.lang.ClassCastException,
                               java.lang.Exception
```
    Create a IcyCanvas object from its class name or PluginCanvas class name.
    Throws an exception if an error occurred (canvas class was not found or it could not be creatd).
    
    Parameters:
    viewer - Viewer to which to canvas is attached.
    
    Throws:
    
    java.lang.ClassCastException - if the specified class name is not a canvas plugin or canvas class name
    
    java.lang.Exception - if the specified canvas cannot be created for some reasons
  - addVisibleLayerToList
```
public static void addVisibleLayerToList(Layer layer,
                         java.util.ArrayList<Layer> list)
```
  - shutDown
```
public void shutDown()
```
    Called by the viewer when canvas is closed to release some resources.
    Be careful to not restore previous state here (as the colormap) because generally shutdown is called after the creation of the other canvas.
  - refresh
```
public abstract void refresh()
```
    Force canvas refresh
  - getImageOverlay
```
public Overlay getImageOverlay()
```
    Returns the Overlay used to display the current sequence image
  - getImageLayer
```
public Layer getImageLayer()
```
    Returns the Layer object used to display the current sequence image
  - getDrawLayers
```
@Deprecated
public boolean getDrawLayers()
```
    Deprecated. Use isLayersVisible() instead.
  - setDrawLayers
```
@Deprecated
public void setDrawLayers(boolean value)
```
    Deprecated. Use setLayersVisible(boolean) instead.
  - isLayersVisible
```
public boolean isLayersVisible()
```
    Return true if layers are visible on the canvas.
  - setLayersVisible
```
public void setLayersVisible(boolean value)
```
    Make layers visible on this canvas (default = true).
  - getViewer
```
public Viewer getViewer()
```
    Returns:
    the viewer
  - getSequence
```
public Sequence getSequence()
```
    Returns:
    the sequence
  - getViewComponent
```
public abstract java.awt.Component getViewComponent()
```
    Returns:
    the main view component
  - getZNavigationPanel
```
public ZNavigationPanel getZNavigationPanel()
```
    Returns:
    the Z navigation bar panel
  - getTNavigationPanel
```
public TNavigationPanel getTNavigationPanel()
```
    Returns:
    the T navigation bar panel
  - getMouseImageInfosPanel
```
public MouseImageInfosPanel getMouseImageInfosPanel()
```
    Returns:
    the mouse image informations panel
  - getLut
```
public LUT getLut()
```
    Returns:
    the LUT
  - addViewerToolbarComponents
```
@Deprecated
public void addViewerToolbarComponents(javax.swing.JToolBar toolBar)
```
    Deprecated. Use customizeToolbar(JToolBar) instead.
  - customizeToolbar
```
public void customizeToolbar(javax.swing.JToolBar toolBar)
```
    Called by the parent viewer when building the toolbar.
    This way the canvas can customize it by adding specific command for instance.
    
    Parameters:
    toolBar - the parent toolbar to customize
  - getPanel
```
public javax.swing.JPanel getPanel()
```
    Returns the setting panel of this canvas.
    The setting panel is displayed in the inspector so user can change canvas parameters.
  - getLayers
```
public java.util.List<Layer> getLayers(boolean sorted)
```
    Returns all layers attached to this canvas.
    
    Parameters:
    sorted - If true the returned list is sorted on the layer priority.
    Sort operation is cached so the method could take sometime when sort cache need to be rebuild.
  - getLayers
```
public java.util.List<Layer> getLayers()
```
    Returns all layers attached to this canvas.
    The returned list is sorted on the layer priority.
    Sort operation is cached so the method could take sometime when cache need to be rebuild.
  - getVisibleLayers
```
public java.util.List<Layer> getVisibleLayers(boolean sorted)
```
    Returns all visible layers (visible property set to true) attached to this canvas.
    
    Parameters:
    sorted - If true the returned list is sorted on the layer priority.
    Sort operation is cached so the method could take sometime when sort cache need to be rebuild.
  - getVisibleLayers
```
public java.util.ArrayList<Layer> getVisibleLayers()
```
    Returns all visible layers (visible property set to true) attached to this canvas.
    The list is sorted on the layer priority.
  - getOrderedLayersForEvent
```
@Deprecated
public java.util.List<Layer> getOrderedLayersForEvent()
```
    Deprecated. Use getLayers() instead (sorted on Layer priority).
  - getVisibleOrderedLayersForEvent
```
@Deprecated
public java.util.List<Layer> getVisibleOrderedLayersForEvent()
```
    Deprecated. Use getVisibleLayers() instead (sorted on Layer priority).
  - getLayersPainter
```
@Deprecated
public java.util.List<Painter> getLayersPainter()
```
    Deprecated. Use getOverlays() instead.
  - getOverlays
```
public java.util.Set<Overlay> getOverlays()
```
    Directly returns a Set of all Overlay displayed by this canvas.
  - getSyncId
```
public int getSyncId()
```
    Returns:
    the SyncId
  - setSyncId
```
public boolean setSyncId(int id)
```
    Set the synchronization group id (0 means unsynchronized).
    
    Parameters:
    id - the syncId to set
    
    Returns:
    false if the canvas do not support synchronization group.
  - isSynchronizationSupported
```
public boolean isSynchronizationSupported()
```
    Return true if this canvas support synchronization
  - isSynchronized
```
public boolean isSynchronized()
```
    Return true if this canvas is synchronized
  - isSynchMaster
```
public boolean isSynchMaster()
```
    Return true if current canvas is synchronized and is currently the synchronize leader.
  - isSynchHeader
```
@Deprecated
public boolean isSynchHeader()
```
    Deprecated. Use isSynchMaster() instead.
  - isSynchSlave
```
public boolean isSynchSlave()
```
    Return true if current canvas is synchronized and it's not the synchronize master
  - isSynchOnView
```
public boolean isSynchOnView()
```
    Return true if this canvas is synchronized on view (offset, zoom and rotation).
  - isSynchOnSlice
```
public boolean isSynchOnSlice()
```
    Return true if this canvas is synchronized on slice (T and Z position)
  - isSynchOnCursor
```
public boolean isSynchOnCursor()
```
    Return true if this canvas is synchronized on cursor (mouse cursor)
  - getPosition
```
public int getPosition(DimensionId dim)
```
    Get position for specified dimension
  - getPositionX
```
public int getPositionX()
```
    Returns:
    current X (-1 if all selected)
  - getPositionY
```
public int getPositionY()
```
    Returns:
    current Y (-1 if all selected)
  - getPositionZ
```
public int getPositionZ()
```
    Returns:
    current Z (-1 if all selected)
  - getPositionT
```
public int getPositionT()
```
    Returns:
    current T (-1 if all selected)
  - getPositionC
```
public int getPositionC()
```
    Returns:
    current C (-1 if all selected)
  - getPosition5D
```
public Point5D.Integer getPosition5D()
```
    Returns the 5D canvas position (-1 mean that the complete dimension is selected)
  - getZ
```
@Deprecated
public int getZ()
```
    Deprecated. uses getPositionZ() instead
    
    Returns:
    current Z (-1 if all selected)
  - getT
```
@Deprecated
public int getT()
```
    Deprecated. uses getPositionT() instead
    
    Returns:
    current T (-1 if all selected)
  - getC
```
@Deprecated
public int getC()
```
    Deprecated. uses getPositionC() instead
    
    Returns:
    current C (-1 if all selected)
  - getMaxPosition
```
public double getMaxPosition(DimensionId dim)
```
    Get maximum position for specified dimension
  - getMaxPositionX
```
public int getMaxPositionX()
```
    Get maximum X value
  - getMaxPositionY
```
public int getMaxPositionY()
```
    Get maximum Y value
  - getMaxPositionZ
```
public int getMaxPositionZ()
```
    Get maximum Z value
  - getMaxPositionT
```
public int getMaxPositionT()
```
    Get maximum T value
  - getMaxPositionC
```
public int getMaxPositionC()
```
    Get maximum C value
  - getMaxPosition5D
```
public Point5D.Integer getMaxPosition5D()
```
    Get the maximum 5D position for the canvas.
    
    See Also:
    getPosition5D()
  - getMax
```
@Deprecated
public double getMax(DimensionId dim)
```
    Deprecated. Use getMaxPosition(DimensionId) instead
  - getMaxX
```
@Deprecated
public int getMaxX()
```
    Deprecated. Use getMaxPositionX() instead
  - getMaxY
```
@Deprecated
public int getMaxY()
```
    Deprecated. Use getMaxPositionY() instead
  - getMaxZ
```
@Deprecated
public int getMaxZ()
```
    Deprecated. Use getMaxPositionZ() instead
  - getMaxT
```
@Deprecated
public int getMaxT()
```
    Deprecated. Use getMaxPositionT() instead
  - getMaxC
```
@Deprecated
public int getMaxC()
```
    Deprecated. Use getMaxPositionC() instead
  - getCanvasSize
```
public int getCanvasSize(DimensionId dim)
```
    Get canvas view size for specified Dimension
  - getCanvasSizeX
```
public int getCanvasSizeX()
```
    Returns the canvas view size X.
  - getCanvasSizeY
```
public int getCanvasSizeY()
```
    Returns the canvas view size Y.
  - getCanvasSizeZ
```
public int getCanvasSizeZ()
```
    Returns the canvas view size Z.
  - getCanvasSizeT
```
public int getCanvasSizeT()
```
    Returns the canvas view size T.
  - getCanvasSizeC
```
public int getCanvasSizeC()
```
    Returns the canvas view size C.
  - getMousePos
```
public java.awt.Point getMousePos()
```
    Returns the mouse position (in canvas coordinate space).
  - getMouseImagePos
```
public double getMouseImagePos(DimensionId dim)
```
    Get mouse image position for specified Dimension
  - getMouseImagePosX
```
public double getMouseImagePosX()
```
    mouse X image position
  - getMouseImagePosY
```
public double getMouseImagePosY()
```
    mouse Y image position
  - getMouseImagePosZ
```
public double getMouseImagePosZ()
```
    mouse Z image position
  - getMouseImagePosT
```
public double getMouseImagePosT()
```
    mouse T image position
  - getMouseImagePosC
```
public double getMouseImagePosC()
```
    mouse C image position
  - getMouseImagePos5D
```
public Point5D.Double getMouseImagePos5D()
```
    Returns the 5D mouse image position
  - getOffset
```
public int getOffset(DimensionId dim)
```
    Get offset for specified Dimension
  - getOffsetX
```
public int getOffsetX()
```
    X offset
  - getOffsetY
```
public int getOffsetY()
```
    Y offset
  - getOffsetZ
```
public int getOffsetZ()
```
    Z offset
  - getOffsetT
```
public int getOffsetT()
```
    T offset
  - getOffsetC
```
public int getOffsetC()
```
    C offset
  - getOffset5D
```
public Point5D.Integer getOffset5D()
```
    Returns the 5D offset.
  - getImageOffsetX
```
@Deprecated
public int getImageOffsetX()
```
    Deprecated. use getOffsetX() instead
    
    X image offset
  - getImageOffsetY
```
@Deprecated
public int getImageOffsetY()
```
    Deprecated. use getOffsetY() instead
    
    Y image offset
  - getImageOffsetZ
```
@Deprecated
public int getImageOffsetZ()
```
    Deprecated. use getOffsetZ() instead
    
    Z image offset
  - getImageOffsetT
```
@Deprecated
public int getImageOffsetT()
```
    Deprecated. use getOffsetT() instead
    
    T image offset
  - getImageOffsetC
```
@Deprecated
public int getImageOffsetC()
```
    Deprecated. use getOffsetC() instead
    
    C image offset
  - getCanvasOffsetX
```
@Deprecated
public int getCanvasOffsetX()
```
    Deprecated. use getOffsetX() instead
    
    X canvas offset
  - getCanvasOffsetY
```
@Deprecated
public int getCanvasOffsetY()
```
    Deprecated. use getOffsetY() instead
    
    Y canvas offset
  - getCanvasOffsetZ
```
@Deprecated
public int getCanvasOffsetZ()
```
    Deprecated. use getOffsetZ() instead
    
    Z canvas offset
  - getCanvasOffsetT
```
@Deprecated
public int getCanvasOffsetT()
```
    Deprecated. use getOffsetT() instead
    
    T canvas offset
  - getCanvasOffsetC
```
@Deprecated
public int getCanvasOffsetC()
```
    Deprecated. use getOffsetC() instead
    
    C canvas offset
  - getScaleFactorX
```
@Deprecated
public double getScaleFactorX()
```
    Deprecated. use getScaleX() instead
    
    X scale factor
  - getScaleFactorY
```
@Deprecated
public double getScaleFactorY()
```
    Deprecated. use getScaleY() instead
    
    Y scale factor
  - getScaleFactorZ
```
@Deprecated
public double getScaleFactorZ()
```
    Deprecated. use getScaleZ() instead
    
    Z scale factor
  - getScaleFactorT
```
@Deprecated
public double getScaleFactorT()
```
    Deprecated. use getScaleT() instead
    
    T scale factor
  - getScaleFactorC
```
@Deprecated
public double getScaleFactorC()
```
    Deprecated. use getScaleC() instead
    
    C scale factor
  - getScale
```
public double getScale(DimensionId dim)
```
    Get scale factor for specified Dimension
  - getScaleX
```
public double getScaleX()
```
    X scale factor
  - getScaleY
```
public double getScaleY()
```
    Y scale factor
  - getScaleZ
```
public double getScaleZ()
```
    Z scale factor
  - getScaleT
```
public double getScaleT()
```
    T scale factor
  - getScaleC
```
public double getScaleC()
```
    C scale factor
  - getRotation
```
public double getRotation(DimensionId dim)
```
    Get rotation angle (radian) for specified Dimension
  - getRotationX
```
public double getRotationX()
```
    X rotation angle (radian)
  - getRotationY
```
public double getRotationY()
```
    Y rotation angle (radian)
  - getRotationZ
```
public double getRotationZ()
```
    Z rotation angle (radian)
  - getRotationT
```
public double getRotationT()
```
    T rotation angle (radian)
  - getRotationC
```
public double getRotationC()
```
    C rotation angle (radian)
  - getImageSize
```
public int getImageSize(DimensionId dim)
```
    Get image size for specified Dimension
  - getImageSizeX
```
public int getImageSizeX()
```
    Get image size X
  - getImageSizeY
```
public int getImageSizeY()
```
    Get image size Y
  - getImageSizeZ
```
public int getImageSizeZ()
```
    Get image size Z
  - getImageSizeT
```
public int getImageSizeT()
```
    Get image size T
  - getImageSizeC
```
public int getImageSizeC()
```
    Get image size C
  - getImageCanvasSize
```
@Deprecated
public int getImageCanvasSize(DimensionId dim)
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size in canvas pixel coordinate for specified Dimension
  - getImageCanvasSizeX
```
@Deprecated
public int getImageCanvasSizeX()
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size X in canvas pixel coordinate
  - getImageCanvasSizeY
```
@Deprecated
public int getImageCanvasSizeY()
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size Y in canvas pixel coordinate
  - getImageCanvasSizeZ
```
@Deprecated
public int getImageCanvasSizeZ()
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size Z in canvas pixel coordinate
  - getImageCanvasSizeT
```
@Deprecated
public int getImageCanvasSizeT()
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size T in canvas pixel coordinate
  - getImageCanvasSizeC
```
@Deprecated
public int getImageCanvasSizeC()
```
    Deprecated. doesn't take rotation transformation in account.
    Use IcyCanvasXD.getImageCanvasSize(..) instead
    
    Get image size C in canvas pixel coordinate
  - setPosition
```
public void setPosition(DimensionId dim,
               int value)
```
    Set position for specified dimension
  - setZ
```
@Deprecated
public void setZ(int z)
```
    Deprecated. uses setPositionZ(int) instead
    
    Set Z position
  - setT
```
@Deprecated
public void setT(int t)
```
    Deprecated. uses setPositionT(int) instead
    
    Set T position
  - setC
```
@Deprecated
public void setC(int c)
```
    Deprecated. uses setPositionC(int) instead
    
    Set C position
  - setPositionX
```
public void setPositionX(int x)
```
    Set X position
  - setPositionY
```
public void setPositionY(int y)
```
    Set Y position
  - setPositionZ
```
public void setPositionZ(int z)
```
    Set Z position
  - setPositionT
```
public void setPositionT(int t)
```
    Set T position
  - setPositionC
```
public void setPositionC(int c)
```
    Set C position
  - setMousePos
```
public boolean setMousePos(int x,
                  int y)
```
    Set mouse position (in canvas coordinate space).
    The method returns true if the mouse position actually changed.
  - setMousePos
```
public void setMousePos(java.awt.Point point)
```
    Set mouse position (in canvas coordinate space)
  - setMouseImagePos
```
public void setMouseImagePos(DimensionId dim,
                    double value)
```
    Set mouse image position for specified dimension (required for synchronization)
  - setMouseImagePosX
```
public void setMouseImagePosX(double value)
```
    Set mouse X image position
  - setMouseImagePosY
```
public void setMouseImagePosY(double value)
```
    Set mouse Y image position
  - setMouseImagePosZ
```
public void setMouseImagePosZ(double value)
```
    Set mouse Z image position
  - setMouseImagePosT
```
public void setMouseImagePosT(double value)
```
    Set mouse T image position
  - setMouseImagePosC
```
public void setMouseImagePosC(double value)
```
    Set mouse C image position
  - setOffset
```
public void setOffset(DimensionId dim,
             int value)
```
    Set offset for specified dimension
  - setOffsetX
```
public void setOffsetX(int value)
```
    Set offset X
  - setOffsetY
```
public void setOffsetY(int value)
```
    Set offset Y
  - setOffsetZ
```
public void setOffsetZ(int value)
```
    Set offset Z
  - setOffsetT
```
public void setOffsetT(int value)
```
    Set offset T
  - setOffsetC
```
public void setOffsetC(int value)
```
    Set offset C
  - setScale
```
public void setScale(DimensionId dim,
            double value)
```
    Set scale factor for specified dimension
  - setScaleX
```
public void setScaleX(double value)
```
    Set scale factor X
  - setScaleY
```
public void setScaleY(double value)
```
    Set scale factor Y
  - setScaleZ
```
public void setScaleZ(double value)
```
    Set scale factor Z
  - setScaleT
```
public void setScaleT(double value)
```
    Set scale factor T
  - setScaleC
```
public void setScaleC(double value)
```
    Set scale factor C
  - setRotation
```
public void setRotation(DimensionId dim,
               double value)
```
    Set rotation angle (radian) for specified dimension
  - setRotationX
```
public void setRotationX(double value)
```
    Set X rotation angle (radian)
  - setRotationY
```
public void setRotationY(double value)
```
    Set Y rotation angle (radian)
  - setRotationZ
```
public void setRotationZ(double value)
```
    Set Z rotation angle (radian)
  - setRotationT
```
public void setRotationT(double value)
```
    Set T rotation angle (radian)
  - setRotationC
```
public void setRotationC(double value)
```
    Set C rotation angle (radian)
  - mouseImagePositionChanged
```
public void mouseImagePositionChanged(DimensionId dim)
```
    Called when mouse image position changed
  - offsetChanged
```
public void offsetChanged(DimensionId dim)
```
    Called when canvas offset changed
  - scaleChanged
```
public void scaleChanged(DimensionId dim)
```
    Called when scale factor changed
  - rotationChanged
```
public void rotationChanged(DimensionId dim)
```
    Called when rotation angle changed
  - canvasToImageDeltaX
```
public double canvasToImageDeltaX(int value)
```
    Convert specified canvas delta X to image delta X.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageDelta(...) method instead for rotation transformed delta.
  - canvasToImageDeltaY
```
public double canvasToImageDeltaY(int value)
```
    Convert specified canvas delta Y to image delta Y.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageDelta(...) method instead for rotation transformed delta.
  - canvasToImageDeltaZ
```
public double canvasToImageDeltaZ(int value)
```
    Convert specified canvas delta Z to image delta Z.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageDelta(...) method instead for rotation transformed delta.
  - canvasToImageDeltaT
```
public double canvasToImageDeltaT(int value)
```
    Convert specified canvas delta T to image delta T.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageDelta(...) method instead for rotation transformed delta.
  - canvasToImageDeltaC
```
public double canvasToImageDeltaC(int value)
```
    Convert specified canvas delta C to image delta C.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaX
```
public double canvasToImageLogDeltaX(int value,
                            double logFactor)
```
    Convert specified canvas delta X to log image delta X.
    The conversion is still affected by zoom ratio but with specified logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaX
```
public double canvasToImageLogDeltaX(int value)
```
    Convert specified canvas delta X to log image delta X.
    The conversion is still affected by zoom ratio but with logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaY
```
public double canvasToImageLogDeltaY(int value,
                            double logFactor)
```
    Convert specified canvas delta Y to log image delta Y.
    The conversion is still affected by zoom ratio but with specified logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaY
```
public double canvasToImageLogDeltaY(int value)
```
    Convert specified canvas delta Y to log image delta Y.
    The conversion is still affected by zoom ratio but with logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaZ
```
public double canvasToImageLogDeltaZ(int value,
                            double logFactor)
```
    Convert specified canvas delta Z to log image delta Z.
    The conversion is still affected by zoom ratio but with specified logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageLogDeltaZ
```
public double canvasToImageLogDeltaZ(int value)
```
    Convert specified canvas delta Z to log image delta Z.
    The conversion is still affected by zoom ratio but with logarithm form.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.canvasToImageLogDelta(...) method instead for rotation transformed delta.
  - canvasToImageX
```
@Deprecated
public double canvasToImageX(int value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
    
    Convert specified canvas X coordinate to image X coordinate
  - canvasToImageY
```
@Deprecated
public double canvasToImageY(int value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
    
    Convert specified canvas Y coordinate to image Y coordinate
  - canvasToImageZ
```
@Deprecated
public double canvasToImageZ(int value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
    
    Convert specified canvas Z coordinate to image Z coordinate
  - canvasToImageT
```
@Deprecated
public double canvasToImageT(int value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
    
    Convert specified canvas T coordinate to image T coordinate
  - canvasToImageC
```
@Deprecated
public double canvasToImageC(int value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.canvasToImage(...) instead
    
    Convert specified canvas C coordinate to image C coordinate
  - imageToCanvasDeltaX
```
public int imageToCanvasDeltaX(double value)
```
    Convert specified image delta X to canvas delta X.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.imageToCanvasDelta(...) method instead for rotation transformed delta.
  - imageToCanvasDeltaY
```
public int imageToCanvasDeltaY(double value)
```
    Convert specified image delta Y to canvas delta Y.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.imageToCanvasDelta(...) method instead for rotation transformed delta.
  - imageToCanvasDeltaZ
```
public int imageToCanvasDeltaZ(double value)
```
    Convert specified image delta Z to canvas delta Z.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.imageToCanvasDelta(...) method instead for rotation transformed delta.
  - imageToCanvasDeltaT
```
public int imageToCanvasDeltaT(double value)
```
    Convert specified image delta T to canvas delta T.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.imageToCanvasDelta(...) method instead for rotation transformed delta.
  - imageToCanvasDeltaC
```
public int imageToCanvasDeltaC(double value)
```
    Convert specified image delta C to canvas delta C.
    WARNING: Does not take in account the rotation transformation.
    Use the IcyCanvasXD.imageToCanvasDelta(...) method instead for rotation transformed delta.
  - imageToCanvasX
```
@Deprecated
public int imageToCanvasX(double value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
    
    Convert specified image X coordinate to canvas X coordinate
  - imageToCanvasY
```
@Deprecated
public int imageToCanvasY(double value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
    
    Convert specified image Y coordinate to canvas Y coordinate
  - imageToCanvasZ
```
@Deprecated
public int imageToCanvasZ(double value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
    
    Convert specified image Z coordinate to canvas Z coordinate
  - imageToCanvasT
```
@Deprecated
public int imageToCanvasT(double value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
    
    Convert specified image T coordinate to canvas T coordinate
  - imageToCanvasC
```
@Deprecated
public int imageToCanvasC(double value)
```
    Deprecated. Cannot give correct result if rotation is applied so use IcyCanvasXD.imageToCanvas(...) instead
    
    Convert specified image C coordinate to canvas C coordinate
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent event,
                Point5D.Double pt)
```
    Helper to forward mouse press event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent event)
```
    Helper to forward mouse press event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent event,
                 Point5D.Double pt)
```
    Helper to forward mouse release event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent event)
```
    Helper to forward mouse release event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseClick
```
public void mouseClick(java.awt.event.MouseEvent event,
              Point5D.Double pt)
```
    Helper to forward mouse click event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseClick
```
public void mouseClick(java.awt.event.MouseEvent event)
```
    Helper to forward mouse click event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseMove
```
public void mouseMove(java.awt.event.MouseEvent event,
             Point5D.Double pt)
```
    Helper to forward mouse move event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseMove
```
public void mouseMove(java.awt.event.MouseEvent event)
```
    Helper to forward mouse mouse event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseDrag
```
public void mouseDrag(java.awt.event.MouseEvent event,
             Point5D.Double pt)
```
    Helper to forward mouse drag event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseDrag
```
public void mouseDrag(java.awt.event.MouseEvent event)
```
    Helper to forward mouse drag event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent event,
                Point5D.Double pt)
```
    Helper to forward mouse enter event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent event)
```
    Helper to forward mouse entered event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent event,
               Point5D.Double pt)
```
    Helper to forward mouse exit event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent event)
```
    Helper to forward mouse exited event to the overlays.
    
    Parameters:
    event - original mouse event
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent event,
                   Point5D.Double pt)
```
    Helper to forward mouse wheel event to the overlays.
    
    Parameters:
    event - original mouse event
    pt - mouse image position
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent event)
```
    Helper to forward mouse wheel event to the overlays.
    
    Parameters:
    event - original mouse event
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyPressed in interface java.awt.event.KeyListener
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyReleased in interface java.awt.event.KeyListener
  - keyTyped
```
public void keyTyped(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyTyped in interface java.awt.event.KeyListener
  - getImage
```
public IcyBufferedImage getImage(int t,
                        int z,
                        int c)
```
    Gets the image at position (t, z, c).
  - getImage
```
@Deprecated
public IcyBufferedImage getImage(int t,
                                   int z)
```
    Deprecated. Use getImage(int, int, int) with C = -1 instead.
  - getCurrentImage
```
public IcyBufferedImage getCurrentImage()
```
    Get the current image.
  - getRenderedImage
```
@Deprecated
public final java.awt.image.BufferedImage getRenderedImage(int t,
                                                       int z,
                                                       int c,
                                                       int imageType,
                                                       boolean canvasView)
```
    Deprecated. use getRenderedImage(int, int, int, boolean) instead
  - getRenderedSequence
```
@Deprecated
public final Sequence getRenderedSequence(int imageType,
                                      boolean canvasView)
```
    Deprecated. use getRenderedSequence(boolean) instead
  - getRenderedImage
```
public abstract java.awt.image.BufferedImage getRenderedImage(int t,
                                            int z,
                                            int c,
                                            boolean canvasView)
```
    Returns a RGB or ARGB (depending support) BufferedImage representing the canvas view for image at position (t, z, c).
    Free feel to the canvas to handle or not a specific dimension.
    
    Parameters:
    t - T position of wanted image (-1 for complete sequence)
    z - Z position of wanted image (-1 for complete stack)
    c - C position of wanted image (-1 for all channels)
    canvasView - render with canvas view if true else use default sequence dimension
  - getRenderedImage
```
@Deprecated
public java.awt.image.BufferedImage getRenderedImage(int t,
                                                       int z,
                                                       int c)
```
    Deprecated. Use getRenderedImage(int, int, int, boolean) instead.
  - getRenderedSequence
```
public Sequence getRenderedSequence(boolean canvasView,
                           ProgressListener progressListener)
```
    Return a sequence which contains rendered images.
    Default implementation, override it if needed in your canvas.
    
    Parameters:
    canvasView - render with canvas view if true else use default sequence dimension
    progressListener - progress listener which receive notifications about progression
  - getRenderedSequence
```
@Deprecated
public Sequence getRenderedSequence(boolean canvasView)
```
    Deprecated. Use getRenderedSequence(boolean, ProgressListener) instead.
  - getRenderedSequence
```
@Deprecated
public Sequence getRenderedSequence()
```
    Deprecated. Use getRenderedSequence(boolean, ProgressListener) instead.
  - getNumSelectedSamples
```
public int getNumSelectedSamples()
```
    Return the number of "selected" samples
  - getFrameRate
```
public int getFrameRate()
```
    Returns the frame rate (given in frame per second) for play command (T navigation panel).
  - setFrameRate
```
public void setFrameRate(int fps)
```
    Sets the frame rate (given in frame per second) for play command (T navigation panel).
  - getLayer
```
@Deprecated
public Layer getLayer(Painter painter)
```
    Deprecated. Use getLayer(Overlay) instead.
  - getLayer
```
public Layer getLayer(Overlay overlay)
```
    Find the layer corresponding to the specified Overlay
  - getLayer
```
public Layer getLayer(ROI roi)
```
    Find the layer corresponding to the specified ROI (use the ROI overlay internally).
  - hasLayer
```
@Deprecated
public boolean hasLayer(Painter painter)
```
    Deprecated. Use hasLayer(Overlay) instead.
  - hasLayer
```
public boolean hasLayer(Overlay overlay)
```
    Returns true if the canvas contains a layer for the specified Overlay.
  - hasLayer
```
public boolean hasLayer(Layer layer)
```
  - addLayer
```
@Deprecated
public void addLayer(Painter painter)
```
    Deprecated. Use addLayer(Overlay) instead.
  - addLayer
```
public Layer addLayer(Overlay overlay)
```
  - removeLayer
```
@Deprecated
public void removeLayer(Painter painter)
```
    Deprecated. Use removeLayer(Overlay) instead.
  - removeLayer
```
public boolean removeLayer(Overlay overlay)
```
    Remove the layer for the specified Overlay from the canvas.
    Returns true if the method succeed.
  - removeLayer
```
public void removeLayer(Layer layer)
```
    Remove the specified layer from the canvas.
  - isVisible
```
public boolean isVisible(Overlay overlay)
```
    Returns true if the specified overlay is visible in the canvas.
  - addLayersListener
```
@Deprecated
public void addLayersListener(CanvasLayerListener listener)
```
    Deprecated. Use addLayerListener(CanvasLayerListener) instead.
  - removeLayersListener
```
@Deprecated
public void removeLayersListener(CanvasLayerListener listener)
```
    Deprecated. Use removeLayerListener(CanvasLayerListener) instead.
  - addLayerListener
```
public void addLayerListener(CanvasLayerListener listener)
```
    Add a layer listener
    
    Parameters:
    listener -
  - removeLayerListener
```
public void removeLayerListener(CanvasLayerListener listener)
```
    Remove a layer listener
    
    Parameters:
    listener -
  - addCanvasListener
```
public void addCanvasListener(IcyCanvasListener listener)
```
    Add a IcyCanvas listener
    
    Parameters:
    listener -
  - removeCanvasListener
```
public void removeCanvasListener(IcyCanvasListener listener)
```
    Remove a IcyCanvas listener
    
    Parameters:
    listener -
  - beginUpdate
```
public void beginUpdate()
```
  - endUpdate
```
public void endUpdate()
```
  - isUpdating
```
public boolean isUpdating()
```
  - layerChanged
```
public void layerChanged(Layer layer,
                java.lang.String propertyName)
```
    layer has changed
    
    Specified by:
    
    layerChanged in interface Layer.LayerListener
  - changed
```
public void changed(IcyCanvasEvent event)
```
    canvas changed (packed event).
    do global changes processing here
  - lutChanged
```
public void lutChanged(LUTEvent event)
```
    Specified by:
    
    lutChanged in interface LUTListener
  - viewerChanged
```
public void viewerChanged(ViewerEvent event)
```
    Specified by:
    
    viewerChanged in interface ViewerListener
  - viewerClosed
```
public void viewerClosed(Viewer viewer)
```
    Specified by:
    
    viewerClosed in interface ViewerListener
  - sequenceChanged
```
public final void sequenceChanged(SequenceEvent event)
```
    Description copied from interface: SequenceListener
    
    Called when sequence has changed (type, data, metadata or property).
    
    Specified by:
    
    sequenceChanged in interface SequenceListener
  - sequenceClosed
```
public void sequenceClosed(Sequence sequence)
```
    Description copied from interface: SequenceListener
    
    Called when sequence has been closed (all viewers displaying it closed).
    
    Specified by:
    
    sequenceClosed in interface SequenceListener
  - onChanged
```
public void onChanged(CollapsibleEvent event)
```
    Description copied from interface: ChangeListener
    
    fire changed event
    
    Specified by:
    
    onChanged in interface ChangeListener

Icy Developer Documentation

Class IcyCanvas

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

Field Detail

PROPERTY_LAYERS_VISIBLE

Constructor Detail

IcyCanvas

Method Detail

getCanvasPlugins

getCanvasPluginNames

getPluginClassName

getCanvasClassName

getCanvasClassName

create

addVisibleLayerToList

shutDown

refresh

getImageOverlay

getImageLayer

getDrawLayers

setDrawLayers

isLayersVisible

setLayersVisible

getViewer

getSequence

getViewComponent

getZNavigationPanel

getTNavigationPanel

getMouseImageInfosPanel

getLut

addViewerToolbarComponents

customizeToolbar

getPanel

getLayers

getLayers

getVisibleLayers

getVisibleLayers

getOrderedLayersForEvent

getVisibleOrderedLayersForEvent

getLayersPainter

getOverlays

getSyncId

setSyncId

isSynchronizationSupported

isSynchronized

isSynchMaster

isSynchHeader

isSynchSlave

isSynchOnView

isSynchOnSlice

isSynchOnCursor

getPosition

getPositionX

getPositionY

getPositionZ

getPositionT

getPositionC

getPosition5D

getZ

getT

getC

getMaxPosition

getMaxPositionX

getMaxPositionY

getMaxPositionZ

getMaxPositionT

getMaxPositionC