Package de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.startlayout

Class StartLayoutAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.gui.startlayout.StartLayoutAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm

public class StartLayoutAlgorithm
extends AbstractAlgorithm

Author:

Christian Klukas

Constructor Summary

Constructors

Constructor	Description
StartLayoutAlgorithm()

Method Summary

Modifier and Type	Method	Description
void	check()	Checks whether all preconditions of the current graph are satisfied.
void	execute()	Performs the layout.
String	getCategory()	Returns the category an algorithm should assigned to.
String	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.

Methods inherited from class org.graffiti.plugin.algorithm.AbstractAlgorithm

addEdit, attach, canRedo, canUndo, die, doesUndo, getAcceleratorKeyStroke, getActionEvent, getDescription, getMenuCategory, getParameters, getPresentationName, getRedoPresentationName, getUndoPresentationName, isAlwaysExecutable, isSignificant, markExecutionDone, markRedoDone, markUndoDone, mayWorkOnMultipleGraphs, redo, replaceEdit, reset, setActionEvent, setParameters, showMenuIcon, undo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StartLayoutAlgorithm

public StartLayoutAlgorithm()

Method Details

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

check

public void check()
           throws PreconditionException

Description copied from interface: Algorithm

Checks whether all preconditions of the current graph are satisfied.

Specified by:

check in interface Algorithm

Overrides:

check in class AbstractAlgorithm

Throws:

PreconditionException - if the preconditions of the current graph are not satisfied.

execute

public void execute()

Performs the layout.

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.

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 interface Algorithm

Overrides:

isLayoutAlgorithm in class AbstractAlgorithm

Returns:

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.