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 voidconfigure(Preferences p)Runs configuration routines for the plugin, e.g.voiddoBeforeExit()The routines to perform before the editor will exit.static ImageIcongetAddonIcon()Algorithm[]getAlgorithms()Returns the array oforg.graffiti.algorithm.Algorithms the plugin contains.AttributeDescription[]getAttributeDescriptions()Class<? extends Attribute>[]getAttributes()Returns the attribute types provided by this plugin.StringgetDefaultView()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()ImageIcongetIcon()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.Views the plugin contains.voidinterrupt()Interrupts the running plugin.booleanisSelectionListener()States whether this class wants to be registered as aSelectionListener.booleanisSessionListener()States whether this class wants to be registered as aSessionListener.booleanisViewListener()States whether this class wants to be registered as aViewListener, i.e.booleanneedsEditComponents()States whether this class needs up-to-date information about the current editcomponents.voidsetIsAddon(boolean v)voidstop()Stops a running plugin.
-
Method Details
-
getAlgorithms
Returns the array oforg.graffiti.algorithm.Algorithms the plugin contains.- Specified by:
getAlgorithmsin interfaceGenericPlugin- Returns:
- the array of
org.graffiti.algorithm.Algorithms the plugin contains.
-
getAttributeDescriptions
- Specified by:
getAttributeDescriptionsin interfaceGenericPlugin
-
getAttributes
Returns the attribute types provided by this plugin.- Specified by:
getAttributesin 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:
getDependenciesin 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:
getExtensionsin 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:
getIconin 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:
getInputSerializersin interfaceGenericPlugin- Returns:
- the input serializers the plugin provides.
-
getOutputSerializers
Returns the output serializers the plugin provides.- Specified by:
getOutputSerializersin 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:
isSelectionListenerin interfaceGenericPlugin- Returns:
- DOCUMENT ME!
-
isSessionListener
public boolean isSessionListener()States whether this class wants to be registered as aSessionListener.- Specified by:
isSessionListenerin interfaceGenericPlugin- Returns:
- DOCUMENT ME!
-
isViewListener
public boolean isViewListener()Description copied from interface:GenericPluginStates 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. ImplementSessionListenerif you are interested in session changed events.- Specified by:
isViewListenerin interfaceGenericPlugin- Returns:
- DOCUMENT ME!
- See Also:
GenericPlugin.isViewListener()
-
getViews
Returns the array oforg.graffiti.plugin.view.Views the plugin contains.- Specified by:
getViewsin interfaceGenericPlugin- Returns:
- the array of
org.graffiti.plugin.view.Views the plugin contains.
-
configure
Runs configuration routines for the plugin, e.g. load preferences etc.- Specified by:
configurein interfaceGenericPlugin- Parameters:
p- DOCUMENT ME!
-
doBeforeExit
public void doBeforeExit()The routines to perform before the editor will exit.- Specified by:
doBeforeExitin interfaceGenericPlugin
-
interrupt
public void interrupt()Interrupts the running plugin.- Specified by:
interruptin 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:
needsEditComponentsin interfaceGenericPlugin- Returns:
- DOCUMENT ME!
-
stop
public void stop()Stops a running plugin. Performs exit routines.- Specified by:
stopin interfaceGenericPlugin
-
getDefaultView
- Specified by:
getDefaultViewin interfaceGenericPlugin
-
getURLattributeActions
- Specified by:
getURLattributeActionsin interfaceGenericPlugin
-