Package de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.circle

Class NullLayoutAlgorithm

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

de.ipk_gatersleben.ag_nw.graffiti.plugins.layouters.circle.NullLayoutAlgorithm

All Implemented Interfaces:

UndoableEdit, Algorithm

public class NullLayoutAlgorithm
extends AbstractAlgorithm

Author:

Christian Klukas

Constructor Summary

Constructors

Constructor	Description
NullLayoutAlgorithm()	Creates a new CircleLayouterAlgorithm object.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the whole algorithm.
String	getCategory()	Returns the category an algorithm should assigned to.
String	getDescription()	The algorithm description.
String	getName()	Returns the name 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.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

NullLayoutAlgorithm

public NullLayoutAlgorithm()

Creates a new CircleLayouterAlgorithm object.

Method Details

reset

public void reset()

Description copied from interface: Algorithm

Resets the internal state of the algorithm.

Specified by:

reset in interface Algorithm

Overrides:

reset in class AbstractAlgorithm

getName

public String getName()

Returns the name of the algorithm.

Returns:

the name of the algorithm

execute

public void execute()

Description copied from interface: Algorithm

Executes the whole algorithm.

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.

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.

getDescription

public String getDescription()

Description copied from class: AbstractAlgorithm

The algorithm description.

Specified by:

getDescription in interface Algorithm

Overrides:

getDescription in class AbstractAlgorithm

Returns:

String, could be HTML-styled.

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: