Package org.graffiti.plugin
Class GenericPluginAdapter
java.lang.Object
org.graffiti.plugin.GenericPluginAdapter
- All Implemented Interfaces:
GenericPlugin
- Direct Known Subclasses:
ApplyGraphLayoutPlugin
,ConnectedComponentPlugin
,DBE_PluginAdapter
,DOTSerializerPlugin
,EdgeRoutingPlugin
,EditorPluginAdapter
,FishEyeLayoutPlugin
,ForceDirectedEdgeLayoutPlugin
,GMLReaderPlugin
,GMLSerializerPlugin
,GMLXMLSerializerPlugin
,GraffitiAttributesPlugin
,GraphMLReaderPlugin
,GraphMLWriterPlugin
,GraphTreeLayoutPlugin
,HammingDistancePlugin
,IPK_PluginAdapter
,KEGG_XML_ReaderPlugin
,MultilevelFrameworkPlugin
,NaivePatternFinderPlugin
,NoOverlappLayouterPlugin
,NoOverlappLayouterPlugin
,PNTSerializerPlugin
,PrintPlugin
,RadialTreeLayoutPlugin
,RandomLayouterPlugin
,RotatePlugin
,RTTreeLayoutPlugin
,SpringEmbedderPlugin
,XGMMLReaderPlugin
,XWGSerializerPlugin
public abstract class GenericPluginAdapter extends Object implements GenericPlugin
An adapter class for the generic plugin interface.
- Version:
- $Revision: 1.10 $
-
Method Summary
Modifier and Type Method Description void
configure(Preferences p)
Runs configuration routines for the plugin, e.g.void
doBeforeExit()
The routines to perform before the editor will exit.static ImageIcon
getAddonIcon()
Algorithm[]
getAlgorithms()
Returns the array oforg.graffiti.algorithm.Algorithm
s the plugin contains.AttributeDescription[]
getAttributeDescriptions()
Class<? extends Attribute>[]
getAttributes()
Returns the attribute types provided by this plugin.String
getDefaultView()
String[]
getDependencies()
Returns the array containing the names of the plugin classes the current plugin depends on.Extension[]
getExtensions()
Returns an Array of Extensions the plugin provides.GraphPostProcessor[]
getGraphPostProcessors()
ImageIcon
getIcon()
Returns the default icon for a plugin, which does not overwrite this method.InputSerializer[]
getInputSerializers()
Returns the input serializers the plugin provides.OutputSerializer[]
getOutputSerializers()
Returns the output serializers the plugin provides.URLattributeAction[]
getURLattributeActions()
String[]
getViews()
Returns the array oforg.graffiti.plugin.view.View
s the plugin contains.void
interrupt()
Interrupts the running plugin.boolean
isSelectionListener()
States whether this class wants to be registered as aSelectionListener
.boolean
isSessionListener()
States whether this class wants to be registered as aSessionListener
.boolean
isViewListener()
States whether this class wants to be registered as aViewListener
, i.e.boolean
needsEditComponents()
States whether this class needs up-to-date information about the current editcomponents.void
setIsAddon(boolean v)
void
stop()
Stops a running plugin.
-
Method Details
-
getAlgorithms
Returns the array oforg.graffiti.algorithm.Algorithm
s the plugin contains.- Specified by:
getAlgorithms
in interfaceGenericPlugin
- Returns:
- the array of
org.graffiti.algorithm.Algorithm
s the plugin contains.
-
getAttributeDescriptions
- Specified by:
getAttributeDescriptions
in interfaceGenericPlugin
-
getAttributes
Returns the attribute types provided by this plugin.- Specified by:
getAttributes
in interfaceGenericPlugin
- Returns:
- the attribute types provided by this plugin.
-
getDependencies
Returns the array containing the names of the plugin classes the current plugin depends on.- Specified by:
getDependencies
in interfaceGenericPlugin
- Returns:
- the array containing the names of the plugin classes the current plugin depends on.
-
getExtensions
Returns an Array of Extensions the plugin provides.- Specified by:
getExtensions
in interfaceGenericPlugin
- Returns:
- A array of Extensions the plugin contains.
-
setIsAddon
public void setIsAddon(boolean v) -
getIcon
Returns the default icon for a plugin, which does not overwrite this method.- Specified by:
getIcon
in interfaceGenericPlugin
- Returns:
- the default plugin icon for a plugin implementation, which does not overwrite this method.
-
getAddonIcon
-
getInputSerializers
Returns the input serializers the plugin provides.- Specified by:
getInputSerializers
in interfaceGenericPlugin
- Returns:
- the input serializers the plugin provides.
-
getOutputSerializers
Returns the output serializers the plugin provides.- Specified by:
getOutputSerializers
in interfaceGenericPlugin
- Returns:
- the output serializers the plugin provides.
-
getGraphPostProcessors
-
isSelectionListener
public boolean isSelectionListener()States whether this class wants to be registered as aSelectionListener
.- Specified by:
isSelectionListener
in interfaceGenericPlugin
- Returns:
- DOCUMENT ME!
-
isSessionListener
public boolean isSessionListener()States whether this class wants to be registered as aSessionListener
.- Specified by:
isSessionListener
in interfaceGenericPlugin
- Returns:
- DOCUMENT ME!
-
isViewListener
public boolean isViewListener()Description copied from interface:GenericPlugin
States whether this class wants to be registered as aViewListener
, i.e. if it wants to get informed when another view in the same session becomes active. This method is not called when another session is activated. ImplementSessionListener
if you are interested in session changed events.- Specified by:
isViewListener
in interfaceGenericPlugin
- Returns:
- DOCUMENT ME!
- See Also:
GenericPlugin.isViewListener()
-
getViews
Returns the array oforg.graffiti.plugin.view.View
s the plugin contains.- Specified by:
getViews
in interfaceGenericPlugin
- Returns:
- the array of
org.graffiti.plugin.view.View
s the plugin contains.
-
configure
Runs configuration routines for the plugin, e.g. load preferences etc.- Specified by:
configure
in interfaceGenericPlugin
- Parameters:
p
- DOCUMENT ME!
-
doBeforeExit
public void doBeforeExit()The routines to perform before the editor will exit.- Specified by:
doBeforeExit
in interfaceGenericPlugin
-
interrupt
public void interrupt()Interrupts the running plugin.- Specified by:
interrupt
in interfaceGenericPlugin
-
needsEditComponents
public boolean needsEditComponents()States whether this class needs up-to-date information about the current editcomponents. If this method returnstrue
, it must implement interfaceNeedEditComponents
.- Specified by:
needsEditComponents
in interfaceGenericPlugin
- Returns:
- DOCUMENT ME!
-
stop
public void stop()Stops a running plugin. Performs exit routines.- Specified by:
stop
in interfaceGenericPlugin
-
getDefaultView
- Specified by:
getDefaultView
in interfaceGenericPlugin
-
getURLattributeActions
- Specified by:
getURLattributeActions
in interfaceGenericPlugin
-