Class ClusterGraphLayout
java.lang.Object
org.graffiti.plugin.algorithm.AbstractAlgorithm
de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.pattern_springembedder.clusterCommands.ClusterGraphLayout
- All Implemented Interfaces:
UndoableEdit
,Algorithm
,AlgorithmWithComponentDescription
public class ClusterGraphLayout extends AbstractAlgorithm implements AlgorithmWithComponentDescription
- Author:
- Christian Klukas (c) 2006 IPK-Gatersleben
- Recent revisions:
- 2.7.0 Layout G from GO too.
-
Constructor Summary
Constructors Constructor Description ClusterGraphLayout()
-
Method Summary
Modifier and Type Method Description void
check()
Checks whether all preconditions of the current graph are satisfied.void
execute()
Executes the whole algorithm.String
getCategory()
Returns the category an algorithm should assigned to.String
getDescription()
The algorithm description.JComponent
getDescriptionComponent()
String
getMenuCategory()
For backwards compatibility the standard implementation will return the CategoryString
getName()
Returns the name (ID) of the 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
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, getParameters, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, setActionEvent, showMenuIcon, undo
-
Constructor Details
-
ClusterGraphLayout
public ClusterGraphLayout()
-
-
Method Details
-
getName
Description copied from interface:Algorithm
Returns the name (ID) of the algorithm. -
getDescription
Description copied from class:AbstractAlgorithm
The algorithm description.- Specified by:
getDescription
in interfaceAlgorithm
- Overrides:
getDescription
in classAbstractAlgorithm
- Returns:
- String, could be HTML-styled.
-
getDescriptionComponent
- Specified by:
getDescriptionComponent
in interfaceAlgorithmWithComponentDescription
-
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:
-
reset
public void reset()Description copied from interface:Algorithm
Resets the internal state of the algorithm.- Specified by:
reset
in interfaceAlgorithm
- Overrides:
reset
in classAbstractAlgorithm
-
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
-
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.
-
getMenuCategory
Description copied from class:AbstractAlgorithm
For backwards compatibility the standard implementation will return the Category- Specified by:
getMenuCategory
in interfaceAlgorithm
- Overrides:
getMenuCategory
in classAbstractAlgorithm
- Returns:
-
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.
-
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.
-