icy.gui.viewer

Class Viewer

java.lang.Object

icy.gui.frame.IcyFrame

icy.gui.viewer.Viewer

All Implemented Interfaces:

IcyCanvasListener, PluginLoader.PluginLoaderListener, SequenceListener, java.awt.event.KeyListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.event.InternalFrameListener

public class Viewer
extends IcyFrame
implements java.awt.event.KeyListener, SequenceListener, IcyCanvasListener, PluginLoader.PluginLoaderListener

Viewer send an event if the IcyCanvas change.

Author:

Fabrice de Chaumont & Stephane

Nested Class Summary

Nested classes/interfaces inherited from class icy.gui.frame.IcyFrame

IcyFrame.IcyFrameState

Field Summary

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Viewer(Sequence sequence)
Viewer(Sequence sequence, boolean visible)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ViewerListener listener) Add a listener
void	canvasChanged(IcyCanvasEvent event)
int	getC() Deprecated. Use getPositionZ() instead.
IcyCanvas	getCanvas() Return the viewer Canvas object
javax.swing.JPanel	getCanvasPanel() Return the viewer Canvas panel
IcyBufferedImage	getCurrentImage() Get the current image
int	getFrameRate() Returns the frame rate (given in frame per second) for play command.
IcyBufferedImage	getImage(int t, int z) Deprecated. Use getImage(int, int, int) with C = -1 instead.
IcyBufferedImage	getImage(int t, int z, int c) Delegation for IcyCanvas.getImage(int, int, int)
LUT	getLut() Returns the viewer LUT
IcyLutViewer	getLutPanel() Deprecated. Use getLutViewer() instead
LUTViewer	getLutViewer() Return the viewer Lut panel
int	getMaxC() Get maximum C value
int	getMaxT() Get maximum T value
int	getMaxZ() Get maximum Z value
int	getNumSelectedSamples() Return the number of "selected" samples
int	getPositionC()
int	getPositionT()
int	getPositionZ()
java.awt.image.BufferedImage	getRenderedImage(int t, int z, int c, boolean canvasView)
Sequence	getRenderedSequence(boolean canvasView, ProgressListener progressListener)
Sequence	getSequence()
int	getT() Deprecated. Use getPositionT() instead.
javax.swing.JToolBar	getToolBar() Return the viewer ToolBar object
int	getViewSyncId()
int	getZ() Deprecated. Use getPositionZ() instead.
boolean	isInitialized() Returns true if the viewer initialization (correct image resizing) is completed.
boolean	isPlaying() Returns true if currently playing.
boolean	isRepeat() Returns true if repeat is enabled for play command.
boolean	isSynchronizedViewSupported() return true if current canvas's viewer does support synchronized view
boolean	isUnique() Return true if only this viewer is currently displaying its attached sequence
boolean	isViewSynchronized() Return true if this viewer has its view synchronized
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
void	onClosed() Called when viewer is closed.
void	pluginLoaderChanged(PluginLoader.PluginLoaderEvent e)
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	removeListener(ViewerListener listener) Remove a listener
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. Use setPositionZ(int) instead.
void	setCanvas(IcyCanvas value) Deprecated. Use setCanvas(String) instead.
void	setCanvas(java.lang.String pluginClassName) Set the specified canvas for the viewer (from the PluginCanvas class name).
void	setFrameRate(int fps) Sets the frame rate (given in frame per second) for play command.
void	setLut(LUT value) Set the specified LUT for the viewer.
void	setLutPanel(IcyLutViewer lutViewer) Deprecated. Use setLutViewer(LUTViewer) instead.
void	setLutViewer(LUTViewer value) Set the LUTViewer for this viewer.
void	setPositionC(int c) Set the current C (channel) position (multi channel sequence)
void	setPositionT(int t) Set the current T position (for multi frame sequence).
void	setPositionZ(int z) Set the current Z position (for stack sequence).
void	setRepeat(boolean value) Set repeat mode for play command.
void	setT(int t) Deprecated. Use setPositionT(int) instead.
boolean	setViewSyncId(int id) Set the view synchronization group id (0 means unsynchronized).
void	setZ(int z) Deprecated. Use setPositionZ(int) instead.
void	startPlay() Start sequence play.
void	stopPlay() Stop sequence play.

Methods inherited from class icy.gui.frame.IcyFrame

add, add, add, addComponentListener, addFrameListener, addKeyListener, addTo, addTo, addTo, addToDesktopPane, addToDesktopPane, addToMainDesktopPane, attach, center, close, detach, dispose, externalize, findIcyFrame, frameClosed, getActionMap, getAllFrames, getAllFrames, getBorder, getBounds, getBoundsExternal, getBoundsInternal, getContentPane, getDefaultSystemMenu, getExternalFrame, getFrame, getHeight, getHeightExternal, getHeightInternal, getIcyExternalFrame, getIcyInternalFrame, getInputMap, getInternalFrame, getJMenuBar, getLocation, getLocationExternal, getLocationInternal, getMaximumSize, getMaximumSizeExternal, getMaximumSizeInternal, getMinimumSize, getMinimumSizeExternal, getMinimumSizeInternal, getMousePosition, getParent, getPreferredSize, getPreferredSizeExternal, getPreferredSizeInternal, getRootPane, getSize, getSizeExternal, getSizeInternal, getSwitchStateAction, getSystemMenuCallback, getTitle, getTitleBarVisible, getToolkit, getVisibleRect, getWidth, getWidthExternal, getWidthInternal, getX, getXExternal, getXInternal, getY, getYExternal, getYInternal, hasFocus, imageUpdate, internalFrameActivated, internalFrameClosed, internalFrameClosing, internalFrameDeactivated, internalFrameDeiconified, internalFrameIconified, internalFrameOpened, internalize, isActive, isAlwaysOnTop, isClosable, isExternalized, isInternalized, isMaximized, isMaximizedExternal, isMaximizedInternal, isMinimized, isMinimizedExternal, isMinimizedInternal, isResizable, isSwitchStateItemVisible, isSyncProcess, isVisible, pack, remove, removeAll, removeComponentListener, removeFrameListener, removeFrom, removeFromMainDesktopPane, removeKeyListener, repaint, requestFocus, revalidate, setAlwaysOnTop, setBackground, setBorder, setBounds, setClosable, setContentPane, setDefaultCloseOperation, setFocusable, setForeground, setJMenuBar, setLayout, setLocation, setLocation, setLocationExternal, setLocationExternal, setLocationInternal, setLocationInternal, setMaximisable, setMaximized, setMaximizedExternal, setMaximizedInternal, setMaximumSize, setMaximumSizeExternal, setMaximumSizeInternal, setMinimized, setMinimizedExternal, setMinimizedInternal, setMinimumSize, setMinimumSizeExternal, setMinimumSizeInternal, setPreferredSize, setPreferredSizeExternal, setPreferredSizeInternal, setResizable, setSize, setSize, setSizeExternal, setSizeExternal, setSizeInternal, setSizeInternal, setSwitchStateItemVisible, setSyncProcess, setSystemMenuCallback, setTitle, setTitleBarVisible, setToolTipText, setVisible, stateChanged, switchState, toBack, toFront, updateSystemMenu, updateUI, validate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.lang.Object

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

Constructor Detail

Viewer

public Viewer(Sequence sequence,
      boolean visible)

Viewer

public Viewer(Sequence sequence)

Method Detail

onClosed

public void onClosed()

Called when viewer is closed.
Release as much references we can here because of the JInternalFrame bug.

Overrides:

onClosed in class IcyFrame

getSequence

public Sequence getSequence()

Returns:

the sequence

setLut

public void setLut(LUT value)

Set the specified LUT for the viewer.

getLut

public LUT getLut()

Returns the viewer LUT

setCanvas

public void setCanvas(java.lang.String pluginClassName)

Set the specified canvas for the viewer (from the PluginCanvas class name).

See Also:

IcyCanvas.getCanvasPluginNames()

setCanvas

@Deprecated
public void setCanvas(IcyCanvas value)

Deprecated. Use setCanvas(String) instead.

isInitialized

public boolean isInitialized()

Returns true if the viewer initialization (correct image resizing) is completed.

getCanvas

public IcyCanvas getCanvas()

Return the viewer Canvas object

getCanvasPanel

public javax.swing.JPanel getCanvasPanel()

Return the viewer Canvas panel

getLutViewer

public LUTViewer getLutViewer()

Return the viewer Lut panel

setLutViewer

public void setLutViewer(LUTViewer value)

Set the LUTViewer for this viewer.

getLutPanel

@Deprecated
public IcyLutViewer getLutPanel()

Deprecated. Use getLutViewer() instead

setLutPanel

@Deprecated
public void setLutPanel(IcyLutViewer lutViewer)

Deprecated. Use setLutViewer(LUTViewer) instead.

getToolBar

public javax.swing.JToolBar getToolBar()

Return the viewer ToolBar object

getPositionT

public int getPositionT()

Returns:

current T (-1 if all selected/displayed)

setPositionT

public void setPositionT(int t)

Set the current T position (for multi frame sequence).

getPositionZ

public int getPositionZ()

Returns:

current Z (-1 if all selected/displayed)

setPositionZ

public void setPositionZ(int z)

Set the current Z position (for stack sequence).

getPositionC

public int getPositionC()

Returns:

current C (-1 if all selected/displayed)

setPositionC

public void setPositionC(int c)

Set the current C (channel) position (multi channel sequence)

getT

@Deprecated
public int getT()

Deprecated. Use getPositionT() instead.

setT

@Deprecated
public void setT(int t)

Deprecated. Use setPositionT(int) instead.

getZ

@Deprecated
public int getZ()

Deprecated. Use getPositionZ() instead.

setZ

@Deprecated
public void setZ(int z)

Deprecated. Use setPositionZ(int) instead.

getC

@Deprecated
public int getC()

Deprecated. Use getPositionZ() instead.

setC

@Deprecated
public void setC(int c)

Deprecated. Use setPositionZ(int) instead.

getMaxT

public int getMaxT()

Get maximum T value

getMaxZ

public int getMaxZ()

Get maximum Z value

getMaxC

public int getMaxC()

Get maximum C value

isSynchronizedViewSupported

public boolean isSynchronizedViewSupported()

return true if current canvas's viewer does support synchronized view

getViewSyncId

public int getViewSyncId()

Returns:

the viewSyncId

setViewSyncId

public boolean setViewSyncId(int id)

Set the view synchronization group id (0 means unsynchronized).

Parameters:

id - the view synchronization id to set

See Also:

IcyCanvas.setSyncId(int)

isViewSynchronized

public boolean isViewSynchronized()

Return true if this viewer has its view synchronized

getImage

public IcyBufferedImage getImage(int t,
                        int z,
                        int c)

Delegation for IcyCanvas.getImage(int, int, int)

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

Returns:

current image

getNumSelectedSamples

public int getNumSelectedSamples()

Return the number of "selected" samples

getRenderedImage

public java.awt.image.BufferedImage getRenderedImage(int t,
                                            int z,
                                            int c,
                                            boolean canvasView)

See Also:

IcyCanvas.getRenderedImage(int, int, int, boolean)

getRenderedSequence

public Sequence getRenderedSequence(boolean canvasView,
                           ProgressListener progressListener)

See Also:

IcyCanvas.getRenderedSequence(boolean, icy.common.listener.ProgressListener)

getFrameRate

public int getFrameRate()

Returns the frame rate (given in frame per second) for play command.

setFrameRate

public void setFrameRate(int fps)

Sets the frame rate (given in frame per second) for play command.

isRepeat

public boolean isRepeat()

Returns true if repeat is enabled for play command.

setRepeat

public void setRepeat(boolean value)

Set repeat mode for play command.

isPlaying

public boolean isPlaying()

Returns true if currently playing.

startPlay

public void startPlay()

Start sequence play.

See Also:

stopPlay(), setRepeat(boolean)

stopPlay

public void stopPlay()

Stop sequence play.

See Also:

startPlay()

isUnique

public boolean isUnique()

Return true if only this viewer is currently displaying its attached sequence

addListener

public void addListener(ViewerListener listener)

Add a listener

Parameters:

listener -

removeListener

public void removeListener(ViewerListener listener)

Remove a listener

Parameters:

listener -

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

sequenceChanged

public 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

canvasChanged

public void canvasChanged(IcyCanvasEvent event)

Specified by:

canvasChanged in interface IcyCanvasListener

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Overrides:

propertyChange in class IcyFrame

pluginLoaderChanged

public void pluginLoaderChanged(PluginLoader.PluginLoaderEvent e)

Specified by:

pluginLoaderChanged in interface PluginLoader.PluginLoaderListener