Package org.vanted.plugins.layout.stressminimization

Class StressMinimizationLayout

java.lang.Object

org.graffiti.plugin.algorithm.AbstractAlgorithm

org.graffiti.plugin.algorithm.AbstractEditorAlgorithm

org.vanted.plugins.layout.stressminimization.BackgroundAlgorithm

org.vanted.plugins.layout.stressminimization.StressMinimizationLayout

All Implemented Interfaces:

UndoableEdit, Algorithm, EditorAlgorithm

public class StressMinimizationLayout
extends BackgroundAlgorithm

Layout algorithm performing a stress minimization layout process.

Constructor Summary

Constructors

Constructor	Description
StressMinimizationLayout()	Creates a new StressMinimizationLayout instance.

Method Summary

Modifier and Type	Method	Description
boolean	activeForView(View v)
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.
String	getName()	Returns the name (ID) of the algorithm.
Parameter[]	getParameters()	Deprecated.
JComponent	getParameterUI()
boolean	isLayoutAlgorithm()	A LayoutAlgorithm should return true.
void	reset()	Resets the internal state of the algorithm.
void	resume()	Resumes execution of this algorithm, if the algorithm has been paused.
void	setParameters(Parameter[] params)	Deprecated.
void	stop()	Stops the execution of the algorithm.

Methods inherited from class org.vanted.plugins.layout.stressminimization.BackgroundAlgorithm

addPropertyChangeListener, addPropertyChangeListeners, getLayout, getProgress, getPropertyChangeListener, getStatus, getStatusDescription, isPaused, isStopped, pause, removePropertyChangeListener

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

getIcon, getParameterDialog, getShortName

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graffiti.plugin.algorithm.Algorithm

attach, getAcceleratorKeyStroke, getActionEvent, getMenuCategory, getSetCategory, mayWorkOnMultipleGraphs, setActionEvent, showMenuIcon

Constructor Details

StressMinimizationLayout

public StressMinimizationLayout()

Creates a new StressMinimizationLayout instance.

Method Details

getName

public String getName()

Description copied from interface: Algorithm

Returns the name (ID) of the algorithm.

Returns:

DOCUMENT ME!

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.

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:

activeForView

public boolean activeForView(View v)

check

public void check()
           throws PreconditionException

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.

getParameterUI

public JComponent getParameterUI()

Specified by:

getParameterUI in class BackgroundAlgorithm

getParameters

@Deprecated
public Parameter[] getParameters()

Deprecated.

Returns a list of Parameter that are set for this algorithm.

Specified by:

getParameters in interface Algorithm

Overrides:

getParameters in class AbstractAlgorithm

Returns:

a collection of Parameter that are needed by the Algorithm.

setParameters

@Deprecated
public void setParameters(Parameter[] params)

Deprecated.

Sets the parameters for this algorithm. Must have the same types and order as the array returned by getParameter.

Specified by:

setParameters in interface Algorithm

Overrides:

setParameters in class AbstractAlgorithm

Parameters:

params - Parameter array

reset

public void reset()

Resets the internal state of the algorithm.

Specified by:

reset in interface Algorithm

Overrides:

reset in class BackgroundAlgorithm

execute

public void execute()

Executes the whole algorithm.

resume

public void resume()

Description copied from class: BackgroundAlgorithm

Resumes execution of this algorithm, if the algorithm has been paused.

Overrides:

resume in class BackgroundAlgorithm

stop

public void stop()

Description copied from class: BackgroundAlgorithm

Stops the execution of the algorithm. In contrast to pause the algorithm will terminate. reset has to be called before the next execution of the algorithm.

Overrides:

stop in class BackgroundAlgorithm