icy.plugin.abstract_

Class Plugin

java.lang.Object

icy.plugin.abstract_.Plugin

Direct Known Subclasses:

Canvas2DPlugin, PluginActionable, PluginFileImporter, PluginImporter, PluginKernelSearchProvider, PluginLocalPluginProvider, PluginOnlinePluginProvider, PluginSequenceExporter, PluginSequenceFileExporter, PluginSequenceFileImporter, PluginSequenceIdImporter, PluginSequenceImporter, ROI2DAreaPlugin, ROI2DEllipsePlugin, ROI2DLinePlugin, ROI2DPointPlugin, ROI2DPolygonPlugin, ROI2DPolyLinePlugin, ROI2DRectanglePlugin, ROI3DLinePlugin, ROI3DPointPlugin, ROI3DPolyLinePlugin, ROIBasicMeasureDescriptorsPlugin, ROIIntensityDescriptorsPlugin, ROILineCutterPlugin, ROIMassCenterDescriptorsPlugin, ROIPositionDescriptorsPlugin, ROIPropertyDescriptorsPlugin, ROISizeDescriptorsPlugin, VtkCanvasPlugin

public abstract class Plugin
extends java.lang.Object

Base class for Plugin, provide some helper methods.
By default the constructor of a Plugin class is called in the EDT (Event Dispatch Thread).
If the plugin implements the PluginThreaded there is no more guarantee that is the case.

Author:

Fabrice de Chaumont & Stephane

Constructor Summary

Constructors

Constructor and Description
Plugin() Default Plugin constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIcyFrame(IcyFrame frame)
void	addSequence(Sequence sequence)
IcyBufferedImage	getActiveImage()
Sequence	getActiveSequence()
Viewer	getActiveViewer()
PluginDescriptor	getDescriptor()
IcyBufferedImage	getFocusedImage() Deprecated. Use getActiveImage() instead
Sequence	getFocusedSequence() Deprecated. Use getActiveSequence() instead
Viewer	getFocusedViewer() Deprecated. Use getActiveViewer() instead
javax.swing.ImageIcon	getIconResource(java.lang.String resourceName) Return the icon resource from given resource name Ex: getResourceAsStream("plugins/author/resources/icon.png");
java.awt.image.BufferedImage	getImageResource(java.lang.String resourceName) Return the image resource from given resource name Ex: getResourceAsStream("plugins/author/resources/image.png");
java.lang.String	getInstallFolder()
java.lang.String	getName()
java.lang.String	getOwnerClassName()
static Plugin	getPlugin(java.util.List<Plugin> list, java.lang.String className)
XMLPreferences	getPreferences(java.lang.String name) Retrieve the plugin preferences node for specified name.
XMLPreferences	getPreferencesRoot() Retrieve the preferences root for this plugin.
java.net.URL	getResource(java.lang.String name) Return the resource URL from given resource name.
java.io.InputStream	getResourceAsStream(java.lang.String name) Return the resource as data stream from given resource name.
java.util.Enumeration<java.net.URL>	getResources(java.lang.String name) Return resources corresponding to given resource name.
java.util.ArrayList<Sequence>	getSequences()
boolean	isBundled()
boolean	loadLibrary(java.lang.String libName) Load a packed native library from the JAR file.
java.io.File	prepareLibrary(java.lang.String libName) Extract a packed native library from the JAR file to a temporary native library folder so it can be easily loaded later.
void	removeSequence(Sequence sequence)
void	report(java.lang.String errorLog) Report an error log for this plugin (reported to Icy web site which report then to the author of the plugin).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Default Plugin constructor.
The PluginLauncher is normally responsible of Plugin class instantiation.

Method Detail

getPlugin

public static Plugin getPlugin(java.util.List<Plugin> list,
               java.lang.String className)

getDescriptor

public PluginDescriptor getDescriptor()

Returns:

the descriptor

getName

public java.lang.String getName()

Returns:

the plugin name (from its descriptor)

isBundled

public boolean isBundled()

Returns:

true if this is a bundled plugin (see PluginBundled).

getOwnerClassName

public java.lang.String getOwnerClassName()

Returns:

the class name of the plugin owner.
If this Plugin is not bundled (see PluginBundled) then it just returns the current class name otherwise it will returns the plugin owner class name.

getInstallFolder

public java.lang.String getInstallFolder()

Returns:

the folder where the plugin is installed (or should be installed).

getActiveViewer

public Viewer getActiveViewer()

getActiveSequence

public Sequence getActiveSequence()

getActiveImage

public IcyBufferedImage getActiveImage()

getFocusedViewer

@Deprecated
public Viewer getFocusedViewer()

Deprecated. Use getActiveViewer() instead

getFocusedSequence

@Deprecated
public Sequence getFocusedSequence()

Deprecated. Use getActiveSequence() instead

getFocusedImage

@Deprecated
public IcyBufferedImage getFocusedImage()

Deprecated. Use getActiveImage() instead

addIcyFrame

public void addIcyFrame(IcyFrame frame)

addSequence

public void addSequence(Sequence sequence)

removeSequence

public void removeSequence(Sequence sequence)

getSequences

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

getResource

public java.net.URL getResource(java.lang.String name)

Return the resource URL from given resource name.
Ex: getResource("plugins/author/resources/def.xml");

Parameters:

name - resource name

getResources

public java.util.Enumeration<java.net.URL> getResources(java.lang.String name)
                                                 throws java.io.IOException

Return resources corresponding to given resource name.
Ex: getResources("plugins/author/resources/def.xml");

Parameters:

name - resource name

Throws:

java.io.IOException

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String name)

Return the resource as data stream from given resource name.
Ex: getResourceAsStream("plugins/author/resources/def.xml");

Parameters:

name - resource name

getImageResource

public java.awt.image.BufferedImage getImageResource(java.lang.String resourceName)

Return the image resource from given resource name Ex: getResourceAsStream("plugins/author/resources/image.png");

Parameters:

resourceName - resource name

getIconResource

public javax.swing.ImageIcon getIconResource(java.lang.String resourceName)

Return the icon resource from given resource name Ex: getResourceAsStream("plugins/author/resources/icon.png");

Parameters:

resourceName - resource name

getPreferencesRoot

public XMLPreferences getPreferencesRoot()

Retrieve the preferences root for this plugin.

getPreferences

public XMLPreferences getPreferences(java.lang.String name)

Retrieve the plugin preferences node for specified name.
i.e : getPreferences("window") will return node "plugins.[authorPackage].[pluginClass].window"

loadLibrary

public boolean loadLibrary(java.lang.String libName)

Load a packed native library from the JAR file.
Native libraries should be packaged with the following directory & file structure:

 /lib/unix32
   libxxx.so
 /lib/unix64
   libxxx.so
 /lib/mac32
   libxxx.dylib
 /lib/mac64
   libxxx.dylib
 /lib/win32
   xxx.dll
 /lib/win64
   xxx.dll
 /plugins/myname/mypackage    
   MyPlugin.class
   ....
 

Here "xxx" is the name of the native library.
Current approach is to unpack the native library into a temporary file and load from there.

Parameters:

libName -

Returns:

true if the library was correctly loaded.

See Also:

prepareLibrary(String)

prepareLibrary

public java.io.File prepareLibrary(java.lang.String libName)

Extract a packed native library from the JAR file to a temporary native library folder so it can be easily loaded later.
Native libraries should be packaged with the following directory & file structure:

 /lib/unix32
   libxxx.so
 /lib/unix64
   libxxx.so
 /lib/mac32
   libxxx.dylib
 /lib/mac64
   libxxx.dylib
 /lib/win32
   xxx.dll
 /lib/win64
   xxx.dll
 /plugins/myname/mypackage    
   MyPlugin.class
   ....
 

Here "xxx" is the name of the native library.

Parameters:

libName -

Returns:

the extracted native library file.

See Also:

loadLibrary(String)

report

public void report(java.lang.String errorLog)

Report an error log for this plugin (reported to Icy web site which report then to the author of the plugin).

See Also:

IcyExceptionHandler.report(PluginDescriptor, String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object