ibm_ilog.graphlayout.RecursiveLayoutProvider (version 1.1-SNAPSHOT)
The internal layout provider used by the Recursive Layout in internal provider mode.
The provider behaves like the
ibm_ilog.graphlayout.DefaultLayoutProvider
except that
RecursiveLayoutProvider.getGraphLayout()
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 RecursiveLayoutProvider
explicitly, you must call the method
ibm_ilog.graphlayout.DefaultLayoutProvider.detachLayouts()
when you no longer need the layout provider instance; otherwise,
some objects may not be garbage collected. However
ibm_ilog.graphlayout.DefaultLayoutProvider.detachLayouts()
is
automatically called for the internal layout provider of the
Recursive Layout when the Recursive Layout is detached.
Method Summary
- constructor()
- getGraphLayout(graphModel) returns ibm_ilog.graphlayout.GraphLayout Returns the layout instance to be used to lay out 'graphModel'.
Methods
Returns the layout instance to be used to lay out
graphModel
.
It returns the preferred layout specified using
ibm_ilog.graphlayout.DefaultLayoutProvider.setPreferredLayout()
.
If no preferred layout was specified, the method returns
null
.
Parameter | Type | Description |
---|---|---|
graphModel | ibm_ilog.graphlayout.AbstractGraphLayoutModel | The graph model (the graph model that encapsulates the topmost grapher , or a subgraph). |