Package org.graffiti.plugin

Interface GenericPlugin

All Known Subinterfaces:
EditorPlugin, InspectorPlugin
All Known Implementing Classes:
AddonAdapter, AddonManagerPlugin, AlternativeIdentifiersPlugin, ApplyGraphLayoutPlugin, AttributeAndDataMappingEvaluation, BeanShellDesktopPlugin, BiomodelsDBAccessPlugin, BioPAX_OWL_ReaderPlugin, BioPAX_OWL_WriterPlugin, CenterLayouterPlugin, ChartAttributePlugin, ChartAttributePlugin, CircleLayouterPlugin, ClusterColorAttributePlugin, CompoundImageAttributePlugin, ConnectedComponentPlugin, DavidTestPlugin, DBE_EditorPluginAdapter, DBE_PluginAdapter, DBEplugin, DefaultEditModePlugin, DefaultView, DeleteNodesPlugin, DOTSerializerPlugin, EdgeRoutingPlugin, EditorPluginAdapter, ExpandReduceLayouterPlugin, FastViewPlugin, FishEyeLayoutPlugin, FontAttributePlugin, ForceDirectedEdgeLayoutPlugin, GenericPluginAdapter, GMLReaderPlugin, GMLSerializerPlugin, GMLXMLSerializerPlugin, GraffitiAttributesPlugin, GraffitiValueEditComponents, GraphGenerationPlugin, GraphMLReaderPlugin, GraphMLWriterPlugin, GraphTreeLayoutPlugin, GridLayouterPlugin, GridPlacementPlugin, HammingDistancePlugin, Inspector, InverseGraphPlugin, InvertSelectionPlugin, IPK_EditorPluginAdapter, IPK_PluginAdapter, IPK_StandardTools, IPKDefaultView, IPKeditComponents, KEGG_XML_ReaderPlugin, KEGG_XML_ReaderPlugin, KeggAttributePlugin, KeggToolbarPlugin, LabelAlignmentAttributePlugin, LabelColorAttributePlugin, LabelFontAttributePlugin, LabelStyleAttributePlugin, LinesSubstancesPlugin, LinkVisualizationLegendPlugin, MatrixViewPlugin, MetatoolIOPlugin, MultilevelFrameworkPlugin, NaivePatternFinderPlugin, NoOverlappLayouterPlugin, NoOverlappLayouterPlugin, PajekReaderPlugin, PatternTabsForClusterAnalysis, PatternTabsForInspector, PluginCopyPatternLayout, PluginFeatureClusterCommands, PluginFeatureDataMapping, PluginFeatureExtendedFileFormatSupport, PluginFeatureHierarchyCommands, PluginFeatureMacroRecording, PluginFeatureMetaCropAccess, PluginFeatureNetworkAnalysisCommands, PluginFeatureStatistics, PluginInfoMenu, PluginInfoMenu, PluginPatternSpringembedder, PluginPatternSpringembedderNoCache, PNTSerializerPlugin, PrintPlugin, RadialTreeLayoutPlugin, RandomLayouterPlugin, RatioViewPlugin, ReferencesPlugin, ReplaceLabelPlugin, ResizeAndGridLayoutPlugin, RotatePlugin, RTTreeLayoutPlugin, SBML_XML_ReaderPlugin, SBML_XML_ReaderWriterPlugin, SBML_XML_WriterPlugin, SetBackgroundColorPlugin, SOMplugin, SpringEmbedderPlugin, StandardAttributeComponents, StandardTools, StartLayoutPlugin, StressMinimizationPlugin, SVGPlugin, SwitchSelectionsPlugin, TextListReaderPlugin, URLattributeContextMenuCommandPlugin, URLAttributePlugin, XGMMLReaderPlugin, XMLAttributePlugin, XWGSerializerPlugin, ZoomFitPlugin, ZoomPlugin, ZoomPlugin
public interface GenericPlugin
An interface for a generic plugin for the graffiti graph editor. Any plugin which shall be able to be plugged into the editor must implement this interface.
Implementation note
: The getter-Methods of this interface may not return null. If you want to prevent yourself from implementing every such method you can also extend the abstract class GenericPluginAdapter.

  • Method Details

    • getAlgorithms

      Algorithm[] getAlgorithms()
      Returns the array of org.graffiti.algorithm.Algorithms the plugin contains.
      Returns:
      the array of org.graffiti.algorithm.Algorithms the plugin contains.

    • getExtensions

      Extension[] getExtensions()
      Returns an array of Extensions the plugin contains.
      Returns:
      A array of Extensions the plugin contains.

    • getAttributes

      Class<? extends Attribute>[] getAttributes()
      Returns the attribute types provided by this plugin.
      Returns:
      the attribute types provided by this plugin.

    • getAttributeDescriptions

      AttributeDescription[] getAttributeDescriptions()

    • getDependencies

      String[] getDependencies()
      Returns the array containing the names of the plugin classes the current plugin depends on.
      Returns:
      the array containing the names of the plugin classes the current plugin depends on.

    • getIcon

      ImageIcon getIcon()
      Returns the icon of the plugin.
      Returns:
      the icon of the plugin.

    • getInputSerializers

      InputSerializer[] getInputSerializers()
      Returns the input serializers the plugin provides.
      Returns:
      the input serializers the plugin provides.

    • getOutputSerializers

      OutputSerializer[] getOutputSerializers()
      Returns the output serializers the plugin provides.
      Returns:
      the output serializers the plugin provides.

    • isSelectionListener

      boolean isSelectionListener()
      States whether this class wants to be registered as a SelectionListener.
      Returns:
      DOCUMENT ME!

    • isSessionListener

      boolean isSessionListener()
      States whether this class wants to be registered as a SessionListener.
      Returns:
      DOCUMENT ME!

    • isViewListener

      boolean isViewListener()
      States whether this class wants to be registered as a ViewListener, 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. Implement SessionListener if you are interested in session changed events.
      Returns:
      DOCUMENT ME!

    • getViews

      String[] getViews()
      Returns the array of class names of the views, this plugin contains.
      Returns:
      the array of class names this plugin contains.

    • configure

      void configure​(Preferences prefs)
      Runs configuration routines for the plugin, e.g. load preferences etc.
      Parameters:
      prefs - the 'plugins' preferences node.

    • doBeforeExit

      void doBeforeExit()
      The routines to perform before the editor will exit.

    • interrupt

      void interrupt()
      Interrupts the running plugin.

    • needsEditComponents

      boolean needsEditComponents()
      States whether this class needs up-to-date information about the current editcomponents. If this method returns true, it must implement interface NeedEditComponents.
      Returns:
      DOCUMENT ME!

    • stop

      void stop()
      Stops a running plugin. Performs exit routines.

    • getDefaultView

      String getDefaultView()

    • getURLattributeActions

      URLattributeAction[] getURLattributeActions()