Class GridPlacementAlgorithm
java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.grid_placement.GridPlacementAlgorithm
- All Implemented Interfaces:
ActionListener
,EventListener
,UndoableEdit
,Algorithm
,ProvidesNodeContextMenu
public class GridPlacementAlgorithm extends AbstractAlgorithm implements ProvidesNodeContextMenu, ActionListener
- Author:
- Christian Klukas
- Recent revisions:
- 2.6.5
-
Constructor Summary
Constructors Constructor Description GridPlacementAlgorithm()
-
Method Summary
Modifier and Type Method Description void
actionPerformed(ActionEvent e)
void
check()
Checks, if a graph was given.void
execute()
Performs the layout.String
getCategory()
Returns the category an algorithm should assigned to.JMenuItem[]
getCurrentNodeContextMenuItem(Collection selectedNodes)
This method should be implemented, as that it returns the desired Context-MenuItem for the Plugin.String
getName()
Returns the name 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
setParameters(Parameter[] params)
Sets the parameters for this algorithm.Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm
addEdit, attach, canRedo, canUndo, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getDescription, getMenuCategory, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, reset, setActionEvent, showMenuIcon, undo
-
Constructor Details
-
GridPlacementAlgorithm
public GridPlacementAlgorithm()
-
-
Method Details
-
getName
Returns the name 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
- Overrides:
getCategory
in classAbstractAlgorithm
- 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
- Overrides:
getSetCategory
in classAbstractAlgorithm
- Returns:
- Set of Category Enums that classify this 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
- Overrides:
isLayoutAlgorithm
in classAbstractAlgorithm
- Returns:
-
check
Checks, if a graph was given.- Specified by:
check
in interfaceAlgorithm
- Overrides:
check
in classAbstractAlgorithm
- Throws:
PreconditionException
- if no graph was given during algorithm invocation
-
execute
public void execute()Performs the layout. -
getParameters
Description copied from interface:Algorithm
Returns a list ofParameter
that are set for this algorithm.- Specified by:
getParameters
in interfaceAlgorithm
- Overrides:
getParameters
in classAbstractAlgorithm
- Returns:
- a collection of
Parameter
that are needed by theAlgorithm
.
-
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
- Overrides:
setParameters
in classAbstractAlgorithm
- Parameters:
params
- Parameter array
-
getCurrentNodeContextMenuItem
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 InterfaceSelectionListener
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 interfaceProvidesNodeContextMenu
- Returns:
MenuItem
the menu item for the context menu
-
actionPerformed
- Specified by:
actionPerformed
in interfaceActionListener
-