Class RotateAlgorithm
java.lang.Object
org.graffiti.plugin.algorithm.ThreadSafeAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.rotate.RotateAlgorithm
- All Implemented Interfaces:
ActionListener
,EventListener
,Algorithm
,ProvidesGeneralContextMenu
public class RotateAlgorithm extends ThreadSafeAlgorithm implements ProvidesGeneralContextMenu, ActionListener
- Author:
- Henning, Christian Klukas
-
Constructor Summary
Constructors Constructor Description RotateAlgorithm()
-
Method Summary
Modifier and Type Method Description void
actionPerformed(ActionEvent e)
void
attach(Graph g, Selection selection)
Attaches the given graph to this algorithm.void
check()
Checks whether all preconditions of the current graph are satisfied.void
disableUndo()
void
execute()
Executes the whole algorithm.void
executeThreadSafe(ThreadSafeOptions options)
ActionEvent
getActionEvent()
String
getCategory()
Returns the category an algorithm should assigned to.JMenuItem[]
getCurrentContextMenuItem()
This method should be implemented, as that it returns the desired Context-MenuItem for the Plugin.String
getDescription()
String
getMenuCategory()
Returns a path to a menu category.String
getName()
Returns the name (ID) of the algorithm.Parameter[]
getParameters()
Returns a list ofParameter
that are set for this algorithm.Set<Category>
getSetCategory()
Returns a set of categories to classify this algorithm .boolean
isLayoutAlgorithm()
A LayoutAlgorithm should return true.void
reset()
Resets the internal state of the algorithm.void
resetDataCache(ThreadSafeOptions options)
void
setActionEvent(ActionEvent a)
boolean
setControlInterface(ThreadSafeOptions options, JComponent jc)
DOCUMENT ME!void
setParameters(Parameter[] params)
Sets the parameters for this algorithm.String
toString()
Methods inherited from class org.graffiti.plugin.algorithm.ThreadSafeAlgorithm
getAcceleratorKeyStroke, mayWorkOnMultipleGraphs, showMenuIcon
-
Constructor Details
-
RotateAlgorithm
public RotateAlgorithm()
-
-
Method Details
-
getName
Description copied from interface:Algorithm
Returns the name (ID) of the algorithm. -
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 interfaceAlgorithm
- Returns:
- The category an algorithm should assigned to.
-
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 interfaceAlgorithm
- Returns:
- Set of Category Enums that classify this algorithm.
-
getMenuCategory
Description copied from interface:Algorithm
Returns a path to a menu category. This is s '.' separated string which reflects the position of this Algorithm in the Menu Hierarchy e.g. "Network.Layout" would put this algorithm in the menu 'Network' and its submenu 'Layout' If this menu is not existent it will be created If this method returns 'null' the algorithm will not appear in the menu- Specified by:
getMenuCategory
in interfaceAlgorithm
- Returns:
-
toString
-
getParameters
Description copied from interface:Algorithm
Returns a list ofParameter
that are set for this algorithm.- Specified by:
getParameters
in interfaceAlgorithm
- Returns:
- a collection of
Parameter
that are needed by theAlgorithm
.
-
getActionEvent
- Specified by:
getActionEvent
in interfaceAlgorithm
-
setActionEvent
- Specified by:
setActionEvent
in interfaceAlgorithm
-
setParameters
Description copied from interface:Algorithm
Sets the parameters for this algorithm. Must have the same types and order as the array returned bygetParameter
.- Specified by:
setParameters
in interfaceAlgorithm
-
check
public void check()Description copied from interface:Algorithm
Checks whether all preconditions of the current graph are satisfied. -
execute
public void execute()Description copied from interface:Algorithm
Executes the whole algorithm. -
getCurrentContextMenuItem
Description copied from interface:ProvidesGeneralContextMenu
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 InterfaceSelectionListener
if the menu item should be variable to the current selection. You could also return a MenuItem that contains a subMenu.- Specified by:
getCurrentContextMenuItem
in interfaceProvidesGeneralContextMenu
- Returns:
MenuItem
the menu item for the context menu
-
actionPerformed
- Specified by:
actionPerformed
in interfaceActionListener
-
setControlInterface
Description copied from class:ThreadSafeAlgorithm
DOCUMENT ME!- Specified by:
setControlInterface
in classThreadSafeAlgorithm
- Returns:
- true, if an GUI was set, false if no interface is needed
-
executeThreadSafe
- Specified by:
executeThreadSafe
in classThreadSafeAlgorithm
-
resetDataCache
- Specified by:
resetDataCache
in classThreadSafeAlgorithm
-
reset
public void reset()Description copied from interface:Algorithm
Resets the internal state of the algorithm. -
attach
Description copied from interface:Algorithm
Attaches the given graph to this algorithm. A ttaches the given Selection information to the algorithm. -
isLayoutAlgorithm
public boolean isLayoutAlgorithm()Description copied from interface:Algorithm
A LayoutAlgorithm should return true. All other types of algorithms should return false.- Specified by:
isLayoutAlgorithm
in interfaceAlgorithm
- Returns:
-
getDescription
- Specified by:
getDescription
in interfaceAlgorithm
-
disableUndo
public void disableUndo()
-