icy.gui.main

Class MainInterfaceBatch

java.lang.Object

icy.gui.main.MainInterfaceBatch

All Implemented Interfaces:

MainInterface

public class MainInterfaceBatch
extends java.lang.Object
implements MainInterface

MainInterfaceBatch Default implementation used when Icy is launched in batch mode, without any GUI

Author:

Nicolas HERVE & Stephane

See Also:

MainInterfaceGui

Constructor Summary

Constructors

Constructor and Description
MainInterfaceBatch()

Method Summary

Methods

Modifier and Type	Method and Description
void	addActiveSequenceListener(ActiveSequenceListener listener) Add active sequence listener.
void	addActiveViewerListener(ActiveViewerListener listener) Add active viewer listener.
void	addCanExitListener(AcceptListener listener) Add "can exit" listener.
void	addFocusedSequenceListener(FocusedSequenceListener listener) Deprecated.
void	addFocusedViewerListener(FocusedViewerListener listener) Deprecated.
void	addGlobalOverlayListener(GlobalOverlayListener listener) Add global Overlay listener
void	addGlobalPluginListener(GlobalPluginListener listener) Add global Plugin listener
void	addGlobalROIListener(GlobalROIListener listener) Add global ROI listener
void	addGlobalSequenceListener(GlobalSequenceListener listener) Add global Sequence listener
void	addGlobalViewerListener(GlobalViewerListener listener) Add global Viewer listener
void	addListener(MainListener listener) Deprecated.
void	addSequence(Sequence sequence) Open a viewer for the specified sequence.
void	addToDesktopPane(javax.swing.JInternalFrame internalFrame) Add the frame to the Desktop pane and change its layer value to make it over the other internal frames.
void	beginUpdate() Deprecated.
boolean	canExitExternal() Check if exit is allowed from registered listeners
void	closeAllViewers() Close all viewers
void	closeSequence(Sequence sequence) Close all viewers displaying the specified sequence.
void	closeViewersOfSequence(Sequence sequence) Deprecated.
void	endUpdate() Deprecated.
IcyBufferedImage	getActiveImage() Returns the current active image.
LUT	getActiveLUT() Returns the LUT from the active viewer window.
java.util.ArrayList<Plugin>	getActivePlugins() Returns the currently active plugins
Sequence	getActiveSequence() Returns the current active sequence.
Viewer	getActiveViewer() Returns the active viewer window.
ApplicationMenu	getApplicationMenu()
IcyDesktopPane	getDesktopPane()
java.util.ArrayList<javax.swing.JFrame>	getExternalFrames() Returns all external frames
Sequence	getFirstSequenceContaining(Overlay overlay) Returns the first active sequence containing the specified Overlay
Sequence	getFirstSequenceContaining(Painter painter) Deprecated.
Sequence	getFirstSequenceContaining(ROI roi) Returns the first active sequence containing the specified ROI
Sequence	getFirstSequencesContaining(Painter painter) Deprecated.
Sequence	getFirstSequencesContaining(ROI roi) Use MainInterface.getFirstSequenceContaining(ROI) instead
Viewer	getFirstViewer(Sequence sequence) Returns first viewer attached to specified sequence
Viewer	getFirstViewerContaining(Overlay overlay) Returns first viewer for the sequence containing specified Overlay
Viewer	getFirstViewerContaining(Painter painter) Deprecated.
Viewer	getFirstViewerContaining(ROI roi) Returns first viewer for the sequence containing specified ROI
IcyBufferedImage	getFocusedImage()
Sequence	getFocusedSequence()
Viewer	getFocusedViewer()
MainFrame	getFrame() Deprecated.
ImageJWrapper	getImageJ() Returns the ImageJ object instance
InspectorPanel	getInspector() Returns the inspector object (right informations panel)
java.util.ArrayList<javax.swing.JInternalFrame>	getInternalFrames() Returns all internal frames
LayersPanel	getLayersPanel() Returns the Layer manager panel
MainFrame	getMainFrame() Get Icy main frame
java.util.List<Overlay>	getOverlays() Returns all active Overlay.
java.util.ArrayList<Painter>	getPainters() Deprecated.
XMLPreferences	getPreferences()
ROI	getROI(Overlay overlay) Returns the ROI containing the specified overlay (if any)
ROI	getROI(Painter painter) Deprecated.
ROITask	getROIRibbonTask() Returns the ROI task of the Ribbon menu.
java.util.ArrayList<ROI>	getROIs() Returns all active ROI
RoisPanel	getRoisPanel() Returns the ROI manager panel
SearchEngine	getSearchEngine() Get Icy main searh engine.
java.lang.String	getSelectedTool() Returns current selected tool (ROI / Selection)
java.util.ArrayList<Sequence>	getSequences() Returns the list of opened sequence (sequence actually displayed in a viewer)
java.util.ArrayList<Sequence>	getSequences(java.lang.String name) Returns the list of opened sequence (sequence actually displayed in a viewer) matching the specified name.
java.util.ArrayList<Sequence>	getSequencesContaining(Overlay overlay) Returns all active sequence containing the specified Overlay
java.util.ArrayList<Sequence>	getSequencesContaining(Painter painter) Deprecated.
java.util.ArrayList<Sequence>	getSequencesContaining(ROI roi) Returns all active sequence containing the specified ROI
SwimmingPool	getSwimmingPool() Returns the SwimmingPool object
TaskFrameManager	getTaskWindowManager()
ToolRibbonTask	getToolRibbon() Deprecated.
IcyUndoManager	getUndoManager() Returns the current active UndoManager (UndoManager from active sequence).
java.util.ArrayList<Viewer>	getViewers() Returns all active viewers
java.util.ArrayList<Viewer>	getViewers(Sequence sequence) Returns viewers attached to specified sequence
void	init() Creates the windows in the Icy.getMainInterface()
boolean	isAlwaysOnTop() Returns true if the main frame is set as "always on top"
boolean	isDetachedMode() Returns true if the application is in "detached" mode
boolean	isHeadLess() Return true is the application is running in headless mode (no screen device).
boolean	isOpened(Sequence sequence) Returns true if specified sequence is currently opened (displayed in a viewer)
boolean	isUniqueViewer(Viewer viewer) Returns true if specified viewer is the unique viewer for its attached sequence
boolean	isUpdating() Deprecated.
boolean	isVirtualMode() Return true is the virtual mode is enabled.
boolean	redo() Redo the next Undoable change set in the active Sequence UndoManager
void	registerExternalFrame(javax.swing.JFrame frame) Deprecated.
void	registerPlugin(Plugin plugin)
void	registerViewer(Viewer viewer)
void	removeActiveSequenceListener(ActiveSequenceListener listener) Remove focused sequence listener.
void	removeActiveViewerListener(ActiveViewerListener listener) Remove active viewer listener.
void	removeCanExitListener(AcceptListener listener) Remove "can exit" listener
void	removeFocusedSequenceListener(FocusedSequenceListener listener) Deprecated.
void	removeFocusedViewerListener(FocusedViewerListener listener) Deprecated.
void	removeGlobalOverlayListener(GlobalOverlayListener listener) Remove global Overlay listener
void	removeGlobalPluginListener(GlobalPluginListener listener) Remove global Plugin listener
void	removeGlobalROIListener(GlobalROIListener listener) Remove global ROI listener
void	removeGlobalSequenceListener(GlobalSequenceListener listener) Remove global Sequence listener
void	removeGlobalViewerListener(GlobalViewerListener listener) Remove global Viewer listener
void	removeListener(MainListener listener) Deprecated.
void	setActiveViewer(Viewer viewer) Set the current active viewer.
void	setAlwaysOnTop(boolean value) Set the main frame as "always on top"
void	setDetachedMode(boolean value) Set the the application is in "detached" mode
void	setFocusedViewer(Viewer viewer)
void	setGlobalViewSyncId(int id) Set all active viewers to specified synchronization group id (0 means unsynchronized).
void	setSelectedTool(java.lang.String command) Set current selected tool (ROI / Selection).
void	setVirtualMode(boolean value) Sets the virtual mode.
boolean	undo() Undo to the last Undoable change set in the active Sequence UndoManager
void	unRegisterExternalFrame(javax.swing.JFrame frame) Deprecated.
void	unRegisterPlugin(Plugin plugin)
void	unRegisterViewer(Viewer viewer)

Methods inherited from class java.lang.Object

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

Constructor Detail

MainInterfaceBatch

public MainInterfaceBatch()

Method Detail

init

public void init()

Description copied from interface: MainInterface

Creates the windows in the Icy.getMainInterface()

Specified by:

init in interface MainInterface

isHeadLess

public boolean isHeadLess()

Description copied from interface: MainInterface

Return true is the application is running in headless mode (no screen device).

Specified by:

isHeadLess in interface MainInterface

getExternalFrames

public java.util.ArrayList<javax.swing.JFrame> getExternalFrames()

Description copied from interface: MainInterface

Returns all external frames

Specified by:

getExternalFrames in interface MainInterface

getInternalFrames

public java.util.ArrayList<javax.swing.JInternalFrame> getInternalFrames()

Description copied from interface: MainInterface

Returns all internal frames

Specified by:

getInternalFrames in interface MainInterface

getPreferences

public XMLPreferences getPreferences()

Specified by:

getPreferences in interface MainInterface

getInspector

public InspectorPanel getInspector()

Description copied from interface: MainInterface

Returns the inspector object (right informations panel)

Specified by:

getInspector in interface MainInterface

getRoisPanel

public RoisPanel getRoisPanel()

Description copied from interface: MainInterface

Returns the ROI manager panel

Specified by:

getRoisPanel in interface MainInterface

getLayersPanel

public LayersPanel getLayersPanel()

Description copied from interface: MainInterface

Returns the Layer manager panel

Specified by:

getLayersPanel in interface MainInterface

getActivePlugins

public java.util.ArrayList<Plugin> getActivePlugins()

Description copied from interface: MainInterface

Returns the currently active plugins

Specified by:

getActivePlugins in interface MainInterface

getActiveLUT

public LUT getActiveLUT()

Description copied from interface: MainInterface

Returns the LUT from the active viewer window. Returns null if there is no sequence opened.

Specified by:

getActiveLUT in interface MainInterface

getActiveViewer

public Viewer getActiveViewer()

Description copied from interface: MainInterface

Returns the active viewer window. Returns null if there is no sequence opened.

Specified by:

getActiveViewer in interface MainInterface

getActiveSequence

public Sequence getActiveSequence()

Description copied from interface: MainInterface

Returns the current active sequence.
Returns null if there is no sequence opened.

Specified by:

getActiveSequence in interface MainInterface

getActiveImage

public IcyBufferedImage getActiveImage()

Description copied from interface: MainInterface

Returns the current active image.
It can return null if the active viewer is null or if it uses 3D display so prefer MainInterface.getActiveSequence() instead.

Specified by:

getActiveImage in interface MainInterface

getUndoManager

public IcyUndoManager getUndoManager()

Description copied from interface: MainInterface

Returns the current active UndoManager (UndoManager from active sequence). It returns null if the active sequence is null.

Specified by:

getUndoManager in interface MainInterface

See Also:

Sequence.getUndoManager()

undo

public boolean undo()

Description copied from interface: MainInterface

Undo to the last Undoable change set in the active Sequence UndoManager

Specified by:

undo in interface MainInterface

Returns:

true if the operation succeed

See Also:

Sequence.undo()

redo

public boolean redo()

Description copied from interface: MainInterface

Redo the next Undoable change set in the active Sequence UndoManager

Specified by:

redo in interface MainInterface

Returns:

true if the operation succeed

See Also:

Sequence.redo()

getFocusedViewer

public Viewer getFocusedViewer()

Specified by:

getFocusedViewer in interface MainInterface

getFocusedSequence

public Sequence getFocusedSequence()

Specified by:

getFocusedSequence in interface MainInterface

getFocusedImage

public IcyBufferedImage getFocusedImage()

Specified by:

getFocusedImage in interface MainInterface

getViewers

public java.util.ArrayList<Viewer> getViewers()

Description copied from interface: MainInterface

Returns all active viewers

Specified by:

getViewers in interface MainInterface

setFocusedViewer

public void setFocusedViewer(Viewer viewer)

Specified by:

setFocusedViewer in interface MainInterface

setActiveViewer

public void setActiveViewer(Viewer viewer)

Description copied from interface: MainInterface

Set the current active viewer.

Specified by:

setActiveViewer in interface MainInterface

Parameters:

viewer - viewer which received activation

addToDesktopPane

public void addToDesktopPane(javax.swing.JInternalFrame internalFrame)

Description copied from interface: MainInterface

Add the frame to the Desktop pane and change its layer value to make it over the other internal frames.

Specified by:

addToDesktopPane in interface MainInterface

getDesktopPane

public IcyDesktopPane getDesktopPane()

Specified by:

getDesktopPane in interface MainInterface

getApplicationMenu

public ApplicationMenu getApplicationMenu()

Specified by:

getApplicationMenu in interface MainInterface

getTaskWindowManager

public TaskFrameManager getTaskWindowManager()

Specified by:

getTaskWindowManager in interface MainInterface

registerPlugin

public void registerPlugin(Plugin plugin)

Specified by:

registerPlugin in interface MainInterface

unRegisterPlugin

public void unRegisterPlugin(Plugin plugin)

Specified by:

unRegisterPlugin in interface MainInterface

registerViewer

public void registerViewer(Viewer viewer)

Specified by:

registerViewer in interface MainInterface

unRegisterViewer

public void unRegisterViewer(Viewer viewer)

Specified by:

unRegisterViewer in interface MainInterface

getFrame

@Deprecated
public MainFrame getFrame()

Deprecated.

Specified by:

getFrame in interface MainInterface

getMainFrame

public MainFrame getMainFrame()

Description copied from interface: MainInterface

Get Icy main frame

Specified by:

getMainFrame in interface MainInterface

closeSequence

public void closeSequence(Sequence sequence)

Description copied from interface: MainInterface

Close all viewers displaying the specified sequence.

Specified by:

closeSequence in interface MainInterface

closeViewersOfSequence

@Deprecated
public void closeViewersOfSequence(Sequence sequence)

Deprecated.

Specified by:

closeViewersOfSequence in interface MainInterface

closeAllViewers

public void closeAllViewers()

Description copied from interface: MainInterface

Close all viewers

Specified by:

closeAllViewers in interface MainInterface

getFirstViewer

public Viewer getFirstViewer(Sequence sequence)

Description copied from interface: MainInterface

Returns first viewer attached to specified sequence

Specified by:

getFirstViewer in interface MainInterface

getViewers

public java.util.ArrayList<Viewer> getViewers(Sequence sequence)

Description copied from interface: MainInterface

Returns viewers attached to specified sequence

Specified by:

getViewers in interface MainInterface

isUniqueViewer

public boolean isUniqueViewer(Viewer viewer)

Description copied from interface: MainInterface

Returns true if specified viewer is the unique viewer for its attached sequence

Specified by:

isUniqueViewer in interface MainInterface

getSequences

public java.util.ArrayList<Sequence> getSequences()

Description copied from interface: MainInterface

Returns the list of opened sequence (sequence actually displayed in a viewer)

Specified by:

getSequences in interface MainInterface

getSequences

public java.util.ArrayList<Sequence> getSequences(java.lang.String name)

Description copied from interface: MainInterface

Returns the list of opened sequence (sequence actually displayed in a viewer) matching the specified name.

Specified by:

getSequences in interface MainInterface

getFirstSequencesContaining

public Sequence getFirstSequencesContaining(ROI roi)

Description copied from interface: MainInterface

Use MainInterface.getFirstSequenceContaining(ROI) instead

Specified by:

getFirstSequencesContaining in interface MainInterface

getFirstSequencesContaining

@Deprecated
public Sequence getFirstSequencesContaining(Painter painter)

Deprecated.

Description copied from interface: MainInterface

Use MainInterface.getFirstSequenceContaining(Overlay) instead

Specified by:

getFirstSequencesContaining in interface MainInterface

getSequencesContaining

public java.util.ArrayList<Sequence> getSequencesContaining(ROI roi)

Description copied from interface: MainInterface

Returns all active sequence containing the specified ROI

Specified by:

getSequencesContaining in interface MainInterface

getSequencesContaining

@Deprecated
public java.util.ArrayList<Sequence> getSequencesContaining(Painter painter)

Deprecated.

Description copied from interface: MainInterface

Returns all active sequence containing the specified Painter

Specified by:

getSequencesContaining in interface MainInterface

getSequencesContaining

public java.util.ArrayList<Sequence> getSequencesContaining(Overlay overlay)

Description copied from interface: MainInterface

Returns all active sequence containing the specified Overlay

Specified by:

getSequencesContaining in interface MainInterface

getROIs

public java.util.ArrayList<ROI> getROIs()

Description copied from interface: MainInterface

Returns all active ROI

Specified by:

getROIs in interface MainInterface

getROI

@Deprecated
public ROI getROI(Painter painter)

Deprecated.

Description copied from interface: MainInterface

Returns the ROI containing the specified painter (if any).

Specified by:

getROI in interface MainInterface

getROI

public ROI getROI(Overlay overlay)

Description copied from interface: MainInterface

Returns the ROI containing the specified overlay (if any)

Specified by:

getROI in interface MainInterface

getPainters

@Deprecated
public java.util.ArrayList<Painter> getPainters()

Deprecated.

Description copied from interface: MainInterface

Returns all active Painter.

Specified by:

getPainters in interface MainInterface

getOverlays

public java.util.List<Overlay> getOverlays()

Description copied from interface: MainInterface

Returns all active Overlay.

Specified by:

getOverlays in interface MainInterface

getSwimmingPool

public SwimmingPool getSwimmingPool()

Description copied from interface: MainInterface

Returns the SwimmingPool object

Specified by:

getSwimmingPool in interface MainInterface

getSelectedTool

public java.lang.String getSelectedTool()

Description copied from interface: MainInterface

Returns current selected tool (ROI / Selection)

Specified by:

getSelectedTool in interface MainInterface

setSelectedTool

public void setSelectedTool(java.lang.String command)

Description copied from interface: MainInterface

Set current selected tool (ROI / Selection).

Specified by:

setSelectedTool in interface MainInterface

getROIRibbonTask

public ROITask getROIRibbonTask()

Description copied from interface: MainInterface

Returns the ROI task of the Ribbon menu.

Specified by:

getROIRibbonTask in interface MainInterface

getToolRibbon

@Deprecated
public ToolRibbonTask getToolRibbon()

Deprecated.

Specified by:

getToolRibbon in interface MainInterface

isAlwaysOnTop

public boolean isAlwaysOnTop()

Description copied from interface: MainInterface

Returns true if the main frame is set as "always on top"

Specified by:

isAlwaysOnTop in interface MainInterface

isDetachedMode

public boolean isDetachedMode()

Description copied from interface: MainInterface

Returns true if the application is in "detached" mode

Specified by:

isDetachedMode in interface MainInterface

setAlwaysOnTop

public void setAlwaysOnTop(boolean value)

Description copied from interface: MainInterface

Set the main frame as "always on top"

Specified by:

setAlwaysOnTop in interface MainInterface

setDetachedMode

public void setDetachedMode(boolean value)

Description copied from interface: MainInterface

Set the the application is in "detached" mode

Specified by:

setDetachedMode in interface MainInterface

addListener

@Deprecated
public void addListener(MainListener listener)

Deprecated.

Specified by:

addListener in interface MainInterface

removeListener

@Deprecated
public void removeListener(MainListener listener)

Deprecated.

Specified by:

removeListener in interface MainInterface

addCanExitListener

public void addCanExitListener(AcceptListener listener)

Description copied from interface: MainInterface

Add "can exit" listener.

CAUTION : A weak reference is used to reference the listener for easier release
so you should have a hard reference to your listener to keep it alive.

Specified by:

addCanExitListener in interface MainInterface

removeCanExitListener

public void removeCanExitListener(AcceptListener listener)

Description copied from interface: MainInterface

Remove "can exit" listener

Specified by:

removeCanExitListener in interface MainInterface

beginUpdate

@Deprecated
public void beginUpdate()

Deprecated.

Specified by:

beginUpdate in interface MainInterface

endUpdate

@Deprecated
public void endUpdate()

Deprecated.

Specified by:

endUpdate in interface MainInterface

isUpdating

@Deprecated
public boolean isUpdating()

Deprecated.

Specified by:

isUpdating in interface MainInterface

registerExternalFrame

@Deprecated
public void registerExternalFrame(javax.swing.JFrame frame)

Deprecated.

Specified by:

registerExternalFrame in interface MainInterface

unRegisterExternalFrame

@Deprecated
public void unRegisterExternalFrame(javax.swing.JFrame frame)

Deprecated.

Specified by:

unRegisterExternalFrame in interface MainInterface

isOpened

public boolean isOpened(Sequence sequence)

Description copied from interface: MainInterface

Returns true if specified sequence is currently opened (displayed in a viewer)

Specified by:

isOpened in interface MainInterface

getFirstSequenceContaining

public Sequence getFirstSequenceContaining(ROI roi)

Description copied from interface: MainInterface

Returns the first active sequence containing the specified ROI

Specified by:

getFirstSequenceContaining in interface MainInterface

getFirstSequenceContaining

@Deprecated
public Sequence getFirstSequenceContaining(Painter painter)

Deprecated.

Description copied from interface: MainInterface

Returns the first active sequence containing the specified Painter

Specified by:

getFirstSequenceContaining in interface MainInterface

getFirstSequenceContaining

public Sequence getFirstSequenceContaining(Overlay overlay)

Description copied from interface: MainInterface

Returns the first active sequence containing the specified Overlay

Specified by:

getFirstSequenceContaining in interface MainInterface

getFirstViewerContaining

public Viewer getFirstViewerContaining(ROI roi)

Description copied from interface: MainInterface

Returns first viewer for the sequence containing specified ROI

Specified by:

getFirstViewerContaining in interface MainInterface

getFirstViewerContaining

@Deprecated
public Viewer getFirstViewerContaining(Painter painter)

Deprecated.

Description copied from interface: MainInterface

Returns first viewer for the sequence containing specified Painter.

Specified by:

getFirstViewerContaining in interface MainInterface

getFirstViewerContaining

public Viewer getFirstViewerContaining(Overlay overlay)

Description copied from interface: MainInterface

Returns first viewer for the sequence containing specified Overlay

Specified by:

getFirstViewerContaining in interface MainInterface

canExitExternal

public boolean canExitExternal()

Description copied from interface: MainInterface

Check if exit is allowed from registered listeners

Specified by:

canExitExternal in interface MainInterface

getImageJ

public ImageJWrapper getImageJ()

Description copied from interface: MainInterface

Returns the ImageJ object instance

Specified by:

getImageJ in interface MainInterface

addFocusedViewerListener

@Deprecated
public void addFocusedViewerListener(FocusedViewerListener listener)

Deprecated.

Specified by:

addFocusedViewerListener in interface MainInterface

removeFocusedViewerListener

@Deprecated
public void removeFocusedViewerListener(FocusedViewerListener listener)

Deprecated.

Specified by:

removeFocusedViewerListener in interface MainInterface

addFocusedSequenceListener

@Deprecated
public void addFocusedSequenceListener(FocusedSequenceListener listener)

Deprecated.

Specified by:

addFocusedSequenceListener in interface MainInterface

removeFocusedSequenceListener

@Deprecated
public void removeFocusedSequenceListener(FocusedSequenceListener listener)

Deprecated.

Specified by:

removeFocusedSequenceListener in interface MainInterface

addGlobalViewerListener

public void addGlobalViewerListener(GlobalViewerListener listener)

Description copied from interface: MainInterface

Add global Viewer listener

Specified by:

addGlobalViewerListener in interface MainInterface

removeGlobalViewerListener

public void removeGlobalViewerListener(GlobalViewerListener listener)

Description copied from interface: MainInterface

Remove global Viewer listener

Specified by:

removeGlobalViewerListener in interface MainInterface

addGlobalSequenceListener

public void addGlobalSequenceListener(GlobalSequenceListener listener)

Description copied from interface: MainInterface

Add global Sequence listener

Specified by:

addGlobalSequenceListener in interface MainInterface

removeGlobalSequenceListener

public void removeGlobalSequenceListener(GlobalSequenceListener listener)

Description copied from interface: MainInterface

Remove global Sequence listener

Specified by:

removeGlobalSequenceListener in interface MainInterface

addGlobalROIListener

public void addGlobalROIListener(GlobalROIListener listener)

Description copied from interface: MainInterface

Add global ROI listener

Specified by:

addGlobalROIListener in interface MainInterface

removeGlobalROIListener

public void removeGlobalROIListener(GlobalROIListener listener)

Description copied from interface: MainInterface

Remove global ROI listener

Specified by:

removeGlobalROIListener in interface MainInterface

addGlobalOverlayListener

public void addGlobalOverlayListener(GlobalOverlayListener listener)

Description copied from interface: MainInterface

Add global Overlay listener

Specified by:

addGlobalOverlayListener in interface MainInterface

removeGlobalOverlayListener

public void removeGlobalOverlayListener(GlobalOverlayListener listener)

Description copied from interface: MainInterface

Remove global Overlay listener

Specified by:

removeGlobalOverlayListener in interface MainInterface

addGlobalPluginListener

public void addGlobalPluginListener(GlobalPluginListener listener)

Description copied from interface: MainInterface

Add global Plugin listener

Specified by:

addGlobalPluginListener in interface MainInterface

removeGlobalPluginListener

public void removeGlobalPluginListener(GlobalPluginListener listener)

Description copied from interface: MainInterface

Remove global Plugin listener

Specified by:

removeGlobalPluginListener in interface MainInterface

addActiveViewerListener

public void addActiveViewerListener(ActiveViewerListener listener)

Description copied from interface: MainInterface

Add active viewer listener.
This permit to receive events of activated viewer only.
It can also be used to detect viewer activation change.

Specified by:

addActiveViewerListener in interface MainInterface

removeActiveViewerListener

public void removeActiveViewerListener(ActiveViewerListener listener)

Description copied from interface: MainInterface

Remove active viewer listener.

Specified by:

removeActiveViewerListener in interface MainInterface

addActiveSequenceListener

public void addActiveSequenceListener(ActiveSequenceListener listener)

Description copied from interface: MainInterface

Add active sequence listener.
This permit to receive events of activated sequence only.
It can also be used to detect sequence activation change.

Specified by:

addActiveSequenceListener in interface MainInterface

removeActiveSequenceListener

public void removeActiveSequenceListener(ActiveSequenceListener listener)

Description copied from interface: MainInterface

Remove focused sequence listener.

Specified by:

removeActiveSequenceListener in interface MainInterface

addSequence

public void addSequence(Sequence sequence)

Description copied from interface: MainInterface

Open a viewer for the specified sequence.

Specified by:

addSequence in interface MainInterface

setGlobalViewSyncId

public void setGlobalViewSyncId(int id)

Description copied from interface: MainInterface

Set all active viewers to specified synchronization group id (0 means unsynchronized).

Specified by:

setGlobalViewSyncId in interface MainInterface

getSearchEngine

public SearchEngine getSearchEngine()

Description copied from interface: MainInterface

Get Icy main searh engine.

Specified by:

getSearchEngine in interface MainInterface

isVirtualMode

public boolean isVirtualMode()

Description copied from interface: MainInterface

Return true is the virtual mode is enabled.
When virtual mode is enabled all Sequence are made virtual (same as volatile) so data is streamed from hard drive on demand. This is useful when you manipulate large Sequence which don't fit in memory but this can make process much slower. Also some plugins won't work correctly on virtual Sequence (modified data can be lost) so use it carefully.

Specified by:

isVirtualMode in interface MainInterface

See Also:

IcyBufferedImage.setVolatile(boolean)

setVirtualMode

public void setVirtualMode(boolean value)

Description copied from interface: MainInterface

Sets the virtual mode.
When virtual mode is enabled all Sequence are made virtual (same as volatile) so data is streamed from hard drive on demand. This is useful when you manipulate large Sequence which don't fit in memory but this can make process much slower. Also some plugins won't work correctly on virtual Sequence (modified data can be lost) so use it carefully.

Specified by:

setVirtualMode in interface MainInterface

See Also:

IcyBufferedImage.setVolatile(boolean)