ilog.views.graphlayout.recursive

Class IlvSubgraphCorrectionBoundsFixed

java.lang.Object

ilog.views.graphlayout.recursive.IlvSubgraphCorrectionBarycenterFixed

ilog.views.graphlayout.recursive.IlvSubgraphCorrectionBoundsFixed

All Implemented Interfaces:

IlvSubgraphCorrectionInterface, IlvPersistentObject

public class IlvSubgraphCorrectionBoundsFixed
extends IlvSubgraphCorrectionBarycenterFixed

This subgraph correction strategy keeps the bounds of a subgraph fixed during recursive layout. This works only if the graph model is an instance of IlvGrapherAdapter and the subgraph is an instance of IlvGraphic. Otherwise it behaves like IlvSubgraphCorrectionBarycenterFixed.

While the strategy IlvSubgraphCorrectionBarycenterFixed only affects the position of the subgraph, this strategy potentially affects the zoom level of the subgraph as well.

If you use a Recursive Layout (see IlvRecursiveLayout) on a nested graph and all subgraphs are laid out completely, and the layout mode of all layouts is not incremental, then you do not need to install any subgraph correction at the Recursive Layout. However, in the following situations, it is useful to install this subgraph correction strategy:

• The subgraph is laid out, but its parent graph is not laid out (because no layout is specified for the parent graph).
• The subgraph is laid out, but the subgraph is specified as fixed inside the parent graph (for instance by IlvGraphLayout.isFixed(Object)).
• The subgraph and its parent graph are laid out, but the layout of the parent graph uses an incremental mode that analyzes the old position of the subgraph (see for instance IlvTreeLayout.setIncrementalMode(boolean) or IlvHierarchicalLayout.setIncrementalMode(boolean)).

If subgraphs of type IlvGrapher are used, the layout of the subgraph affects the bounding box of the subgraph. The subgraph may appear at a completely different position after layout, even though no layout of the parent graph was performed that contains the subgraph as a node, and even though IlvManager.moveObject(IlvGraphic, double, double, boolean) was never called for the subgraph. The reason for this effect is simply the internal bounding box mechanism of IlvGrapher. This effect is very unfortunate in the situations that were described above. By installing this subgraph correction strategy, this effect is eliminated because the subgraphs are moved back to their bounds after layout.

Since:

JViews 5.5

See Also:

IlvRecursiveLayout.setSubgraphCorrectionInterface(IlvSubgraphCorrectionInterface)

Constructor Summary

Constructors

Constructor and Description
IlvSubgraphCorrectionBoundsFixed() Creates a new IlvSubgraphCorrectionBoundsFixed.
IlvSubgraphCorrectionBoundsFixed(IlvInputStream stream) Creates a new IlvSubgraphCorrectionBoundsFixed from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
void	correct(Object subgraph, IlvGraphLayout layout, IlvRect boundingBox, boolean redraw) Corrects the subgraph bounds by trying to reshape the subgraph to the input bounding box.
void	write(IlvOutputStream stream) Writes the object to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSubgraphCorrectionBoundsFixed

public IlvSubgraphCorrectionBoundsFixed()

Creates a new IlvSubgraphCorrectionBoundsFixed.

IlvSubgraphCorrectionBoundsFixed

public IlvSubgraphCorrectionBoundsFixed(IlvInputStream stream)
                                 throws IlvReadFileException

Creates a new IlvSubgraphCorrectionBoundsFixed from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if an error occurs while reading.

IlvReadFileException

Method Detail

correct

public void correct(Object subgraph,
                    IlvGraphLayout layout,
                    IlvRect boundingBox,
                    boolean redraw)

Corrects the subgraph bounds by trying to reshape the subgraph to the input bounding box. The success depends on various modes of IlvGrapher that permit or forbid movements or zoom level changes. This is called by the Recursive Layout (see IlvRecursiveLayout) immediately after the layout of the subgraph has finished.

Specified by:

correct in interface IlvSubgraphCorrectionInterface

Overrides:

correct in class IlvSubgraphCorrectionBarycenterFixed

Parameters:

subgraph - The subgraph that has been laid out.

layout - The layout that has been performed on the subgraph.

boundingBox - The former bounding box of the subgraph at the point in time before the layout.

redraw - The redraw flag passed to the layout.

See Also:

IlvRecursiveLayout.setSubgraphCorrectionInterface(IlvSubgraphCorrectionInterface)

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to the output stream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvSubgraphCorrectionBarycenterFixed

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

IOException - thrown when an exception occurs during the write operation for this object.