Class RemoveBendsAlgorithm
java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.pattern_springembedder.clusterCommands.RemoveBendsAlgorithm
- All Implemented Interfaces:
UndoableEdit
,Algorithm
public class RemoveBendsAlgorithm extends AbstractAlgorithm
-
Constructor Summary
Constructors Constructor Description RemoveBendsAlgorithm()
-
Method Summary
Modifier and Type Method Description void
attach(Graph graph, Selection selection, boolean attachUndo)
void
check()
Checks whether all preconditions of the current graph are satisfied.boolean
doesUndo()
Must returntrue
to allow Undo/Redo edits.void
execute()
Executes the whole algorithm.String
getCategory()
Returns the category an algorithm should assigned to.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
mayWorkOnMultipleGraphs()
void
setParameters(Parameter[] params)
Sets the parameters for this algorithm.Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm
addEdit, attach, canRedo, canUndo, die, getAcceleratorKeyStroke, getActionEvent, getDescription, getMenuCategory, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isLayoutAlgorithm, isSignificant, markExecutionDone, markRedoDone, markUndoDone, redo, replaceEdit, reset, setActionEvent, showMenuIcon, undo
-
Constructor Details
-
RemoveBendsAlgorithm
public RemoveBendsAlgorithm()
-
-
Method Details
-
getName
Description copied from interface:Algorithm
Returns the name (ID) of the algorithm.- Returns:
- DOCUMENT ME!
-
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.
-
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
-
check
Description copied from interface:Algorithm
Checks whether all preconditions of the current graph are satisfied.- Specified by:
check
in interfaceAlgorithm
- Overrides:
check
in classAbstractAlgorithm
- Throws:
PreconditionException
- if the preconditions of the current graph are not satisfied.
-
execute
public void execute()Description copied from interface:Algorithm
Executes the whole algorithm. -
mayWorkOnMultipleGraphs
public boolean mayWorkOnMultipleGraphs()- Specified by:
mayWorkOnMultipleGraphs
in interfaceAlgorithm
- Overrides:
mayWorkOnMultipleGraphs
in classAbstractAlgorithm
-
doesUndo
public boolean doesUndo()Description copied from class:AbstractAlgorithm
Must return
Important: If you use GraphHelper for undoable edits or any other UndoableEdit tools, do NOT returntrue
to allow Undo/Redo edits.true
, as those are handled in that given class.- Overrides:
doesUndo
in classAbstractAlgorithm
- Returns:
false
by default, meaning the algorithm is not undoable
-
attach
See AbstractAlgorithm.attach(Graph, Selection). This extends with optional setting of undo support.- Parameters:
graph
-selection
-attachUndo
- default is true
-