Package de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.hierarchy

Class HierarchyAlgorithm

java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.misc.hierarchy.HierarchyAlgorithm
All Implemented Interfaces:
ActionListener, EventListener, UndoableEdit, Algorithm, ProvidesNodeContextMenu
public class HierarchyAlgorithm
extends AbstractAlgorithm
implements ActionListener, ProvidesNodeContextMenu
Author:
Christian Klukas

  • Constructor Details

    • HierarchyAlgorithm

      public HierarchyAlgorithm()
      Constructs a new instance.

  • Method Details

    • execute

      public void execute()
      Description copied from interface: Algorithm
      Executes the whole algorithm.
      Specified by:
      execute in interface Algorithm
      See Also:
      Algorithm.execute()

    • reset

      public void reset()
      Description copied from interface: Algorithm
      Resets the internal state of the algorithm.
      Specified by:
      reset in interface Algorithm
      Overrides:
      reset in class AbstractAlgorithm
      See Also:
      Algorithm.reset()

    • getName

      public String getName()
      Description copied from interface: Algorithm
      Returns the name (ID) of the algorithm.
      Specified by:
      getName in interface Algorithm
      Returns:
      DOCUMENT ME!
      See Also:
      Algorithm.getName()

    • getCategory

      public String getCategory()
      Description copied from interface: Algorithm
      Returns the category an algorithm should assigned to. Return NULL if the algorithm should be sorted directly in the plugin menu.
      Specified by:
      getCategory in interface Algorithm
      Overrides:
      getCategory in class AbstractAlgorithm
      Returns:
      The category an algorithm should assigned to.

    • getSetCategory

      public Set<Category> getSetCategory()
      Description copied from interface: Algorithm
      Returns a set of categories to classify this algorithm . e.g. return new HashSet(Arrays.asList( Category.GRAPH, Category.NODE )); is an algorithm, working on graphs and more specific on nodes
      Specified by:
      getSetCategory in interface Algorithm
      Overrides:
      getSetCategory in class AbstractAlgorithm
      Returns:
      Set of Category Enums that classify this algorithm.

    • setSelection

      public void setSelection​(Selection selection)
      Sets the selection on which the algorithm works.
      Parameters:
      selection - the selection

    • actionPerformed

      public void actionPerformed​(ActionEvent e)
      Specified by:
      actionPerformed in interface ActionListener

    • getCurrentNodeContextMenuItem

      public JMenuItem[] getCurrentNodeContextMenuItem​(Collection<Node> selectedNodes)
      Description copied from interface: ProvidesNodeContextMenu
      This method should be implemented, as that it returns the desired Context-MenuItem for the Plugin. It will be added on the fly to a newly created context menu, when the user right-clicks an EditorFrame. The plugin should implement the Interface SelectionListener if the menu item should be variable to the current selection. You could also return a MenuItem that contains a subMenu.
      Specified by:
      getCurrentNodeContextMenuItem in interface ProvidesNodeContextMenu
      Returns:
      MenuItem the menu item for the context menu