ilog.views.sdm.renderer.graphlayout

Class IlvGraphLayoutParameters

java.lang.Object

ilog.views.sdm.renderer.graphlayout.IlvGraphLayoutParameters

public class IlvGraphLayoutParameters
extends Object

The base class for classes that are loaded dynamically to add custom setters for graph layout parameters.

Since:

JViews 8.8

Constructor Summary

Constructors

Constructor and Description
IlvGraphLayoutParameters() Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterLayout(IlvGraphLayout layout) Postprocesses the layout.
void	beforeLayout(IlvGraphLayout layout) Preprocesses the layout.
void	cleanup(IlvGraphLayout layout) Cleans up the layout.
void	evaluateConstraints(IlvSDMEngine engine, Vector<? extends ilog.views.sdm.renderer.graphlayout.IlvHierarchicalLayoutParameters.ConstraintHolder> constraints) Evaluate the constraint information that was read from a reader.
void	prepare(IlvGraphLayout layout) Prepares the layout.
Vector<? extends ilog.views.sdm.renderer.graphlayout.IlvHierarchicalLayoutParameters.ConstraintHolder>	readConstraints(Reader reader) Reads the constraints from a reader.
void	writeConstraints(IlvSDMEngine engine, PrintWriter stream) Writes the constraints to a writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGraphLayoutParameters

public IlvGraphLayoutParameters()

Constructor.

Method Detail

prepare

public void prepare(IlvGraphLayout layout)

Prepares the layout. This method is called when a new instance of graph layout parameters is allocated, and inside IlvGraphLayoutRenderer.prepareRendering(ilog.views.sdm.IlvSDMEngine), that is, before the SDM engine renders a new data model and creates new node and link graphics.

beforeLayout

public void beforeLayout(IlvGraphLayout layout)

Preprocesses the layout. This method is called inside IlvGraphLayoutRenderer.renderingDone(ilog.views.sdm.IlvSDMEngine), just before layout is actually performed.

afterLayout

public void afterLayout(IlvGraphLayout layout)

Postprocesses the layout. This method is called inside IlvGraphLayoutRenderer.renderingDone(ilog.views.sdm.IlvSDMEngine), just after layout was actually performed.

cleanup

public void cleanup(IlvGraphLayout layout)

Cleans up the layout. This method is called when the internal state of the renderer is cleaned. This method is called inside IlvGraphLayoutRenderer.removeAll(ilog.views.sdm.IlvSDMEngine), that is, before a data model is loaded (and before the SDM engine clears the grapher's contents), and when the graph layout renderer is detached from the SDM engine.

writeConstraints

public void writeConstraints(IlvSDMEngine engine,
                             PrintWriter stream)

Writes the constraints to a writer.

Parameters:

engine - The SDM engine

stream - The output stream

readConstraints

public Vector<? extends ilog.views.sdm.renderer.graphlayout.IlvHierarchicalLayoutParameters.ConstraintHolder> readConstraints(Reader reader)
                                                                                                                       throws IOException

Reads the constraints from a reader.

Parameters:

reader - The input reader

Returns:

A vector containing the constraint info. The detailed contents of this vector are unspecified: they depend on the layout style. This vector can be evaluated by evaluateConstraints(ilog.views.sdm.IlvSDMEngine, java.util.Vector<? extends ilog.views.sdm.renderer.graphlayout.IlvHierarchicalLayoutParameters.ConstraintHolder>). Returns null when there are no constraints.

Throws:

IOException

evaluateConstraints

public void evaluateConstraints(IlvSDMEngine engine,
                                Vector<? extends ilog.views.sdm.renderer.graphlayout.IlvHierarchicalLayoutParameters.ConstraintHolder> constraints)
                         throws IOException

Evaluate the constraint information that was read from a reader. This method transfers the constraint information to the layout.

Parameters:

engine - The SDM engine.

constraints - A vector containing the constraint information. This is the vector retrieved by readConstraints(java.io.Reader).

Throws:

IOException