ilog.views.graphlayout.recursive

Class IlvRecursiveLayoutProvider

java.lang.Object

ilog.views.graphlayout.IlvDefaultLayoutProvider

ilog.views.graphlayout.recursive.IlvRecursiveLayoutProvider

All Implemented Interfaces:

IlvLayoutProvider

public class IlvRecursiveLayoutProvider
extends IlvDefaultLayoutProvider

The internal layout provider used by the Recursive Layout in internal provider mode.

The provider behaves like the IlvDefaultLayoutProvider except that getGraphLayout(IlvGraphModel) returns null for a graph model that has no preferred layout. It does not clone the layout instance of the closest parent graph for which a layout has been set. This allows you to specify null as the preferred layout for those subgraphs that should not be laid out at all.

If you allocate an instance of IlvRecursiveLayoutProvider explicitly, you must call the method IlvDefaultLayoutProvider.detachLayouts(IlvGraphModel, boolean) when you no longer need the layout provider instance; otherwise, some objects may not be garbage collected. However IlvDefaultLayoutProvider.detachLayouts(IlvGraphModel, boolean) is automatically called for the internal layout provider of the Recursive Layout when the Recursive Layout is detached.

Since:

JViews 5.5

See Also:

IlvLayoutProvider, IlvRecursiveLayout.getLayoutMode()

Constructor Summary

Constructors

Constructor and Description
IlvRecursiveLayoutProvider() Creates a new IlvRecursiveLayoutProvider.

Method Summary

Modifier and Type	Method and Description
IlvGraphLayout	getGraphLayout(IlvGraphModel graphModel) Returns the layout instance to be used to lay out graphModel.

Methods inherited from class ilog.views.graphlayout.IlvDefaultLayoutProvider

copy, createGraphLayout, detachLayouts, getInstanceId, getPreferredLayout, setPreferredLayout, setPreferredLayout, setPreferredLayout, storePreferredLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvRecursiveLayoutProvider

public IlvRecursiveLayoutProvider()

Creates a new IlvRecursiveLayoutProvider.

Use the method IlvDefaultLayoutProvider.setPreferredLayout(IlvGraphModel, IlvGraphLayout) to specify preferred layouts.

Method Detail

getGraphLayout

public IlvGraphLayout getGraphLayout(IlvGraphModel graphModel)

Returns the layout instance to be used to lay out graphModel.

It returns the preferred layout specified using IlvDefaultLayoutProvider.setPreferredLayout(IlvGraphModel, IlvGraphLayout). If no preferred layout was specified, the method returns null.

Specified by:

getGraphLayout in interface IlvLayoutProvider

Overrides:

getGraphLayout in class IlvDefaultLayoutProvider

Parameters:

graphModel - The graph model (the graph model that encapsulates the topmost grapher , or a subgraph).

Returns:

The layout instance to be used for graphModel, or null if no layout is required for graphModel.

See Also:

IlvDefaultLayoutProvider.setPreferredLayout(IlvGraphModel, IlvGraphLayout, boolean, boolean)