Depending on the support of its sublayouts, Multiple Layout can
support the following generic parameters and features defined in
the IlvGraphLayout class.
Extra feature for JViews
Diagrammer:
The following paragraphs describe the
particular way in which these parameters are used by this subclass.
Allowed time
A Multiple Layout instance supports this
feature if all of its sublayouts support the feature. If the
allowed time setting has elapsed, the Multiple Layout stops; that
means it stops the currently running sublayout and skips the
subsequent sublayouts that have not yet been started. If the
layout stops early because the allowed time has elapsed, the
result code in the layout report is:
IlvGraphLayoutReport.STOPPED_AND_INVALID
Layout of connected components
The Multiple Layout instance can use the generic mechanism to
lay out connected components if the sublayouts of type IlvGraphLayout support this feature.
The sublayout of type IlvLabelLayout
does not need special handling of connected components.
For more information about this mechanism, see Layout of connected components.
Percentage completion calculation
The Multiple Layout calculates the percentage of completion. This
value can be obtained from the layout report during the run of
the layout. The value is, however, a very rough estimation. If
the sublayouts do not support the calculation of the percentage
completion, the Multiple Layout can report the percentage based
only on the information that the sublayout has already finished.
For example, if there are three sublayouts, the mechanism reports
33% after the first sublayout has finished, 66%after the second
sublayout has finished, and 100% after all three sublayouts have
finished. If the sublayouts support the calculation of the
percentage completion, the Multiple Layout calculates a more
detailed percentage. For a detailed description of this feature,
see Percentage of completion calculation and Graph layout event listeners.
Save parameters to named properties
The Multiple Layout instance can save its layout parameters to
named properties if all its sublayouts support this feature. This
can be used to save layout parameters to
.ivl
files. (For a detailed description of this feature, see Save parameters to named propertiesand Saving layout parameters and preferred
layouts.)
Stop immediately
The Multiple Layout instance supports this
feature if all its sublayouts support this feature.
It stops the currently running sublayout after cleanup if the
method stopImmediately is called and skips the
subsequent sublayouts that have not yet been started. For a
description of this method in the IlvGraphLayout class, see Stop immediately. If the layout stops
before completion, the result code in the layout report is
IlvGraphLayoutReport.STOPPED_AND_INVALID
.