ilog.cpl.graph.graphlayout.css

Class IlpTreeLayoutParameters

java.lang.Object

ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpTreeLayoutParameters

public class IlpTreeLayoutParameters
extends IlpGraphLayoutParameters

This class models the properties that can be configured for each object when using the Tree layout.

To customize per-object properties, the graph layout renderer must be enabled and configured to customize per-object properties.

Since:

JViews 7.5

See Also:

IlvTreeLayout

Constructor Summary

Constructors

Constructor and Description
IlpTreeLayoutParameters() Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	apply(IlvGraphLayout layout, IlpRepresentationObject ro, IlvGraphic layoutProxy) Applies the configuration that is stored in this bean into the given layout for the given node.
int	getAlignment() Returns the alignment option of an individual node.
int	getLinkStyle() Returns the style of the shape of an individual link.
int	getRootPreference() Specifies the preference of the node to become root node.
boolean	isRoot() Returns if this configuration is for a root node.
void	reset() Resets the configuration in this bean.
void	setAlignment(int align) Sets the alignment option of an individual node.
void	setLinkStyle(int style) Sets the style of the shape of an individual link.
void	setRoot(boolean flag) Allows you to specify the root(s) of the tree.
void	setRootPreference(int preference) Specifies the preference of the node to become root node.

Methods inherited from class ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

isFixed, isLayoutIgnored, setFixed, setLayoutIgnored

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpTreeLayoutParameters

public IlpTreeLayoutParameters()

Default constructor

Method Detail

reset

public void reset()

Resets the configuration in this bean.

Overrides:

reset in class IlpGraphLayoutParameters

apply

public boolean apply(IlvGraphLayout layout,
                     IlpRepresentationObject ro,
                     IlvGraphic layoutProxy)

Applies the configuration that is stored in this bean into the given layout for the given node.

Overrides:

apply in class IlpGraphLayoutParameters

Parameters:

layout - Graph Layout

ro - Object to which the configuration will be applied

layoutProxy - Layout graphic object for a node or link

setAlignment

public void setAlignment(int align)

Sets the alignment option of an individual node. This alignment option is used only if the global alignment is set to MIXED. Otherwise, all nodes have the alignment that is specified as the global alignment.

Valid values are:

• CENTER - the node is centered with respect to the centers of its children.
• BORDER_CENTER - the node is centered with respect to the border of its children.
• EAST - the node is aligned to the border of its easternmost child.
• WEST - the node is aligned to the border of its westernmost child.
• TIP_OVER - a parent is outside the border of the children, while the children are placed sequentially instead of in parallel.
• TIP_OVER_BOTH_SIDES - similar to TIP_OVER but the children are arranged in pairs at both sides of the link segment that starts at the parent node. This alignment option is not possible in the radial or level layout modes.

The default value is CENTER.

See Also:

IlvTreeLayout.getAlignment(java.lang.Object), getAlignment()

getAlignment

public int getAlignment()

Returns the alignment option of an individual node.

See Also:

setAlignment(int)

setLinkStyle

public void setLinkStyle(int style)

Sets the style of the shape of an individual link. This link style is used only if the global link style is set to MIXED_STYLE and the link is part of the spanning tree. If the global link style is not MIXED_STYLE, all links of the spanning tree have the style that is specified as the global link style. Links that are not part of the spanning tree have the link style NO_RESHAPE_STYLE.

Valid values are:

• ORTHOGONAL_STYLE - the link has an orthogonal shape, that is, a shape consisting of a sequence of orthogonal line segments. This option is not available for the radial layout modes.
• STRAIGHT_LINE_STYLE - the link has a straight-line shape.
• NO_RESHAPE_STYLE - no reshape is performed on the link.

The default value is STRAIGHT_LINE_STYLE.

Parameters:

style - The shape style.

See Also:

getLinkStyle(), IlvTreeLayout.setLinkStyle(java.lang.Object, int)

getLinkStyle

public int getLinkStyle()

Returns the style of the shape of an individual link.

See Also:

setLinkStyle(int)

setRoot

public void setRoot(boolean flag)

Allows you to specify the root(s) of the tree. If more than one connected component exists, it is possible to select a root for each component. If no root is specified, an appropriate node is automatically selected as root. For a directed tree, the canonical root node with degree 0 is selected unless otherwise specified.

Setting the root node by this method is identical to setting the root preference of this node to 10000.

See Also:

IlvTreeLayout.setRoot(java.lang.Object)

isRoot

public boolean isRoot()

Returns if this configuration is for a root node.

Returns:

true if this configuration applies to a root node.

See Also:

setRoot(boolean)

setRootPreference

public void setRootPreference(int preference)

Specifies the preference of the node to become root node. The higher the preference, the more likely the node will be selected as root node.

If a negative value is passed as input, the preference of the node is unspecified. In this case, the algorithm calculates a preference so that for directed trees the canonical root nodes with degree 0 have the highest preference.

See Also:

IlvTreeLayout.setRootPreference(java.lang.Object, int)

getRootPreference

public int getRootPreference()

Specifies the preference of the node to become root node.

See Also:

setRootPreference(int)