y.module
Class LayoutModule

java.lang.Object
  |
  +--y.module.YModule
        |
        +--y.module.LayoutModule

Direct Known Subclasses:

CircularLayoutModule, EdgeGroupConstraintModule, GraphTransformerModule, GRIPModule, HierarchicLayoutModule, OrganicEdgeRouterModule, OrganicLayoutModule, OrthogonalEdgeRouterModule, OrthogonalLayoutModule, ParallelEdgeLayoutModule, PortConstraintModule, RandomLayoutModule, ShuffleLayoutModule, SmartOrganicLayoutModule, TreeLayoutModule

public abstract class LayoutModule

extends YModule

Common base class for modules that launch layout algorithms.

Field Summary

Fields inherited from class y.module.YModule

FAILED, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

LayoutModule(String name, String author, String description)

Method Summary

boolean	getBufferedMode() Returns whether or not to perform the layout process in buffered mode.
boolean	isAbortable() LayoutModules are abortable.
boolean	isMorphingEnabled() Getter for property morphingEnabled.
protected void	launchLayouter(Layouter layouter)
protected void	launchLayouter(Layouter layouter, boolean buffered)
void	setBufferedMode(boolean buffered) Whether or not to perform the layout process in buffered mode.
void	setMorphingEnabled(boolean morphingEnabled) Setter for property morphingEnabled.

Methods inherited from class y.module.YModule

createOptionHandler, dispose, fitGraph2DView, getAuthor, getDescription, getExitStatus, getGraph2D, getGraph2DView, getModuleName, getOptionHandler, getTimer, getView, init, mainrun, run, setExitStatus, setGraph2D, setModuleName, setOptionHandler, start, startAsThread

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutModule

public LayoutModule(String name,
                    String author,
                    String description)

Method Detail

launchLayouter

protected void launchLayouter(Layouter layouter)

launchLayouter

protected void launchLayouter(Layouter layouter,
                              boolean buffered)

isAbortable

public boolean isAbortable()

LayoutModules are abortable.

Overrides:

isAbortable in class YModule

setBufferedMode

public void setBufferedMode(boolean buffered)

Whether or not to perform the layout process in buffered mode. When in buffered mode the layout call will be wrapped by an instance of BufferedLayouter. Layout morphing can only be performed when in buffered mode.

By default the layout module will perform in buffered mode.

getBufferedMode

public boolean getBufferedMode()

Returns whether or not to perform the layout process in buffered mode.

isMorphingEnabled

public boolean isMorphingEnabled()

Getter for property morphingEnabled.

Returns:

Value of property morphingEnabled.

setMorphingEnabled

public void setMorphingEnabled(boolean morphingEnabled)

Setter for property morphingEnabled.

Parameters:

morphingEnabled - New value of property morphingEnabled.