ilog.views.graphlayout.random

Class IlvRandomLayout

java.lang.Object

ilog.views.graphlayout.IlvGraphLayout

ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout

ilog.views.graphlayout.random.IlvRandomLayout

All Implemented Interfaces:

GraphModelListener, Serializable, EventListener

public class IlvRandomLayout
extends IlvBasicLinkStyleLayout

The main class for the Random Layout algorithm.

This is the simplest layout algorithm. The nodes are moved at randomly-computed positions inside a user-defined region which can be specified using the method IlvGraphLayout.setLayoutRegion(IlvRect).

Sample drawing produced by the Random Layout algorithm:

See the corresponding chapter of the User Manual for details on the algorithm, the types of graphs for which this algorithm can be used, features and limitations, code samples, and so on.

Note that the initial position of the nodes (at the moment you start the layout) does not affect the resulting layout. However, nodes specified as fixed are not moved if you call the method IlvGraphLayout.setPreserveFixedNodes(boolean) with a true argument.

Since:

JViews 2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_RESHAPE_STYLE No links reshape option.
static int	STRAIGHT_LINE_STYLE Straight-line links shape option.

Fields inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout

ALL_CORNERS, BOTTOM_LEFT, BOTTOM_RIGHT, CENTERED, CLOCK_WISE, CONNECTED_ONE_BEND_BUNDLE, CONNECTED_RECTANGULAR, CONNECTED_SQUARE, COUNTER_CLOCK_WISE, FREE_ONE_BEND_BUNDLE, FREE_RECTANGULAR, FREE_SQUARE, HORIZONTAL_TO_VERTICAL, INNER, NARROW_CONNECTED_RECTANGULAR, NARROW_CONNECTED_SQUARE, NARROW_FREE_RECTANGULAR, NARROW_FREE_SQUARE, NARROW_STRAIGHT_LINE_BUNDLE, NO_BENDS, NO_BUNDLE, OUTER, STRAIGHT_LINE_BUNDLE, TOP_LEFT, TOP_RIGHT, VERTICAL_TO_HORIZONTAL

Fields inherited from class ilog.views.graphlayout.IlvGraphLayout

INVERSE_VIEW_COORDINATES, MANAGER_COORDINATES, VIEW_COORDINATES

Constructor Summary

Constructors

Constructor and Description
IlvRandomLayout() Creates a new instance of the Random Layout algorithm.
IlvRandomLayout(IlvRandomLayout source) Creates a new layout instance by copying an existing one.

Method Summary

Modifier and Type	Method and Description
IlvGraphLayout	copy() Copies the layout instance.
void	copyParameters(IlvGraphLayout source) Copies the parameters from a given layout instance.
protected IlvGraphLayoutGrapherProperty	createLayoutGrapherProperty(String name, boolean withDefaults) Returns a new instance of IlvRandomLayoutGrapherProperty that stores the parameter settings of this layout class.
protected int[]	getPercentagesOfCompletion() Returns an array of 4 integer numbers, denoting the percentage of completion: After collecting multilinks and self-links.
protected void	init() Initializes instance variables.
protected void	internalLayout(boolean redraw) Computes the layout using the Random Layout algorithm.
boolean	supportsLayoutRegion() Indicates that this layout class can control the size of the drawing of the graph to fit (exactly or approximately) a user-defined region (a rectangle) or a user-defined manager view.
boolean	supportsRandomGenerator() Indicates that this layout class uses randomly generated numbers that can be initialized with a user-defined seed value.

Methods inherited from class ilog.views.graphlayout.basic.IlvBasicLinkStyleLayout

checkAppropriateLink, checkAppropriateLinks, getLayoutCodeOnInterrupt, getLinkStyle, getMovingNodes, getMultiLinkMaxSpread, getMultiLinkMode, getMultiLinkOffset, getMultiLinksCount, getMultiSelfLinkDistribution, getMultiSelfLinkMaxSpread, getMultiSelfLinkOffset, getSelfLinkAbsoluteAttachPosition, getSelfLinkAllowedCorners, getSelfLinkMode, getSelfLinkOrientation, getSelfLinkRelativeAttachPosition, getSelfLinksCount, getSelfLinkSpacing, increasePercentageComplete, isConnectLinksToNodeCenters, isInterrupted, isSelfLinkConnectToNodeCenter, layout, setConnectLinksToNodeCenters, setLinkStyle, setMultiLinkMaxSpread, setMultiLinkMode, setMultiLinkOffset, setMultiSelfLinkDistribution, setMultiSelfLinkMaxSpread, setMultiSelfLinkOffset, setSelfLinkAbsoluteAttachPosition, setSelfLinkAllowedCorners, setSelfLinkConnectToNodeCenter, setSelfLinkMode, setSelfLinkOrientation, setSelfLinkRelativeAttachPosition, setSelfLinkSpacing, supportsAllowedTime, supportsLayoutOfConnectedComponents, supportsLinkClipping, supportsLinkConnectionBox, supportsPercentageComplete, supportsPreserveFixedLinks, supportsPreserveFixedNodes, supportsSaveParametersToNamedProperties, supportsStopImmediately

Methods inherited from class ilog.views.graphlayout.IlvGraphLayout

addGraphLayoutEventListener, addGraphLayoutParameterEventListener, afterLayoutOfSubgraph, attach, attach, beforeLayout, beforeLayoutOfSubgraph, callLayoutStepPerformedIfNeeded, cleanGraphModel, cleanLink, cleanNode, clipAllLinks, clipLink, connectAllLinksToCenter, connectLinkToCenter, contentsChanged, createLayoutLinkProperty, createLayoutNodeProperty, createLayoutReport, detach, getAllowedTime, getAutoLayoutHandler, getBalanceSplineCurveThreshold, getCalcLayoutRegion, getCoordinatesMode, getGrapher, getGraphModel, getInstanceId, getLayout, getLayoutOfConnectedComponents, getLayoutOfConnectedComponentsReport, getLayoutRegion, getLayoutReport, getLayouts, getLinkClipInterface, getLinkConnectionBoxInterface, getMaxSplineCurveSize, getMinBusyTime, getMinSplineCurveSize, getParentLayout, getProperty, getProperty, getRecursiveLayout, getRemainingAllowedTime, getSeedValueForRandomGenerator, getSpecLayoutRegion, getSplineLinkFilter, isAnimate, isAutoLayout, isFitToView, isFixed, isGeometryUpToDate, isInputCheckEnabled, isLayoutNeeded, isLayoutOfConnectedComponentsEnabled, isLayoutOfConnectedComponentsEnabledByDefault, isLayoutRunning, isLayoutRunning, isLayoutTimeElapsed, isLocalRecursiveLayoutNeeded, isMemorySavings, isParametersUpToDate, isPreserveFixedLinks, isPreserveFixedNodes, isSplineRoutingEnabled, isStoppedImmediately, isStructureUpToDate, isUseDefaultParameters, isUseSeedValueForRandomGenerator, layoutStepPerformed, onParameterChanged, onParameterChanged, performAutoLayout, performLayout, performLayout, performLayout, PerformLayout, performSublayout, removeGraphLayoutEventListener, removeGraphLayoutParameterEventListener, setAllowedTime, setAnimate, setAutoCheckAppropriateLinksEnabled, setAutoLayout, setAutoLayoutHandler, setBalanceSplineCurveThreshold, setCoordinatesMode, setFixed, setGeometryUpToDate, setGrapher, setGraphModel, setInputCheckEnabled, setLayoutOfConnectedComponents, setLayoutOfConnectedComponentsEnabled, setLayoutRegion, setLayoutRegion, setLayoutRegion, setLayoutReport, setLayoutRunning, setLinkClipInterface, setLinkConnectionBoxInterface, setMaxSplineCurveSize, setMemorySavings, setMinBusyTime, setMinSplineCurveSize, setParametersUpToDate, setParentLayout, setPreserveFixedLinks, setPreserveFixedNodes, setProperty, setProperty, setSeedValueForRandomGenerator, setSplineLinkFilter, setSplineRoutingEnabled, setStructureUpToDate, setUseDefaultParameters, setUseSeedValueForRandomGenerator, stopImmediately, supportsAnimation, supportsMemorySavings, supportsSplineRouting, unfixAllLinks, unfixAllNodes, useAnimateRedraw

Methods inherited from class java.lang.Object

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

Field Detail

STRAIGHT_LINE_STYLE

public static final int STRAIGHT_LINE_STYLE

Straight-line links shape option. When used as an argument of IlvBasicLinkStyleLayout.setLinkStyle(int), the links are given a straight-line shape.

See Also:

IlvBasicLinkStyleLayout.setLinkStyle(int), Constant Field Values

NO_RESHAPE_STYLE

public static final int NO_RESHAPE_STYLE

No links reshape option. When used as an argument of IlvBasicLinkStyleLayout.setLinkStyle(int), the links are not reshaped.

See Also:

IlvBasicLinkStyleLayout.setLinkStyle(int), Constant Field Values

Constructor Detail

IlvRandomLayout

public IlvRandomLayout()

Creates a new instance of the Random Layout algorithm.
To indicate the grapher you want to lay out, use the method IlvGraphLayout.attach(IlvGrapher).
To indicate the graph model you want to lay out, use the method IlvGraphLayout.attach(IlvGraphModel).
To perform the layout, use the method IlvGraphLayout.performLayout().
To modify the layout parameters, use the different methods provided in this class and its superclass.

See Also:

IlvGraphLayout.attach(ilog.views.IlvGrapher), IlvGraphLayout.attach(ilog.views.graphlayout.IlvGraphModel), IlvGraphLayout.performLayout(), IlvGrapherAdapter.addLayer(ilog.views.IlvManagerLayer), IlvGrapherAdapter.setFilter(ilog.views.graphlayout.IlvLayoutGraphicFilter)

IlvRandomLayout

public IlvRandomLayout(IlvRandomLayout source)

Creates a new layout instance by copying an existing one. This constructor is used by the copy() method. Any subclass should provide a copy constructor.

The parameters of the source layout are copied using the method copyParameters(IlvGraphLayout).

Parameters:

source - The layout instance that is copied.

Since:

JViews 5.0

Method Detail

init

protected void init()

Initializes instance variables.

You should not call this method directly. The method is called internally by the constructor without arguments and by the copy constructor. The method must be overridden by subclasses that need to initialize additional instance variables.

Overrides:

init in class IlvBasicLinkStyleLayout

Since:

JViews 5.0

copy

public IlvGraphLayout copy()

Copies the layout instance.

This method copies the layout instance by calling the copy constructor.

When performing a recursive layout on a nested graph, this method is used by IlvLayoutProvider to "clone" the layout instance of a parent graph.

Note that the parameters which are specific to a node or a link are not copied. The other parameters, including the layout region specification and the link clip and link connection box interfaces, are also copied.

If a method of the type supportsXXX is associated with a parameter, the parameter is copied only if the corresponding method returns true.

Overrides:

copy in class IlvBasicLinkStyleLayout

Returns:

A copy of the layout instance.

Since:

JViews 5.0

See Also:

copyParameters(IlvGraphLayout)

copyParameters

public void copyParameters(IlvGraphLayout source)

Copies the parameters from a given layout instance.

Note that the parameters which are specific to a node or a link are not copied. The other parameters, including the layout region specification and the customization interfaces, are also copied.

If a method of the type supportsXXX is associated with a parameter, the parameter is copied only if the corresponding method returns true.

Overrides:

copyParameters in class IlvBasicLinkStyleLayout

Parameters:

source - The layout instance from which the parameters are copied.

Since:

JViews 5.0

See Also:

copy()

internalLayout

protected void internalLayout(boolean redraw)
                       throws IlvGraphLayoutException

Computes the layout using the Random Layout algorithm. To start the layout, call the method IlvGraphLayout.performLayout().

Overrides:

internalLayout in class IlvBasicLinkStyleLayout

Throws:

IlvInappropriateLinkException - if the grapher contains links that cannot be reshaped to a straight line and the link style is STRAIGHT_LINE_STYLE. (For details, see IlvInappropriateLinkException).

IlvGraphLayoutException

See Also:

IlvGraphLayout.performLayout()

getPercentagesOfCompletion

protected int[] getPercentagesOfCompletion()

Returns an array of 4 integer numbers, denoting the percentage of completion:

1. After collecting multilinks and self-links.
2. After calling internalLayout(boolean).
3. After treating all multilinks.
4. After treating all self-links.

Overrides:

getPercentagesOfCompletion in class IlvBasicLinkStyleLayout

Returns:

An array of 4 integer numbers, denoting the percentage of completion.

See Also:

IlvBasicLinkStyleLayout.supportsPercentageComplete(), IlvGraphLayoutReport.getPercentageComplete()

supportsLayoutRegion

public final boolean supportsLayoutRegion()

Indicates that this layout class can control the size of the drawing of the graph to fit (exactly or approximately) a user-defined region (a rectangle) or a user-defined manager view.

Overrides:

supportsLayoutRegion in class IlvGraphLayout

Returns:

Always true.

See Also:

IlvGraphLayout.setLayoutRegion(ilog.views.IlvManagerView), IlvGraphLayout.setLayoutRegion(ilog.views.IlvManagerView, ilog.views.IlvRect), IlvGraphLayout.setLayoutRegion(ilog.views.IlvRect), IlvGraphLayout.getSpecLayoutRegion(), IlvGraphLayout.getCalcLayoutRegion(), IlvGraphLayout

supportsRandomGenerator

public final boolean supportsRandomGenerator()

Indicates that this layout class uses randomly generated numbers that can be initialized with a user-defined seed value. When you perform the layout several times on the same graph and use the same user-defined seed value, you obtain the same drawing of the graph. If you want different drawings each time you perform the layout, you should modify the seed value and call the method IlvGraphLayout.setUseSeedValueForRandomGenerator(boolean) with a true argument.

Overrides:

supportsRandomGenerator in class IlvGraphLayout

Returns:

Always true.

See Also:

IlvGraphLayout.setSeedValueForRandomGenerator(long), IlvGraphLayout.getSeedValueForRandomGenerator(), IlvGraphLayout.setUseSeedValueForRandomGenerator(boolean), IlvGraphLayout.isUseSeedValueForRandomGenerator()

createLayoutGrapherProperty

protected IlvGraphLayoutGrapherProperty createLayoutGrapherProperty(String name,
                                                                    boolean withDefaults)

Returns a new instance of IlvRandomLayoutGrapherProperty that stores the parameter settings of this layout class.

The method is used by IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean) to create a named property that contains parameter settings of this layout instance.

Overrides:

createLayoutGrapherProperty in class IlvBasicLinkStyleLayout

Since:

JViews 3.5

See Also:

IlvGraphLayoutGrapherProperty, IlvGrapherAdapter.saveParametersToNamedProperties(IlvGraphLayout, boolean), IlvGrapherAdapter.loadParametersFromNamedProperties(IlvGraphLayout), IlvGrapherAdapter.removeParametersFromNamedProperties()