ilog.cpl.graph.graphlayout.css

Class IlpHierarchicalLayoutParameters

java.lang.Object

ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpHierarchicalLayoutParameters

public class IlpHierarchicalLayoutParameters
extends IlpGraphLayoutParameters

This class models the properties that can be configured for each object when using the Hierarchical 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:

IlvHierarchicalLayout

Constructor Summary

Constructors

Constructor and Description
IlpHierarchicalLayoutParameters() 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	getDestinationPointMode() Returns the mode for the connection point on an individual link on the destination node.
int	getEastNumberOfPorts() Returns the number of relative ports on the east side of a node.
int	getFromPortIndex() Returns the port index of a link at the "from" side.
int	getFromPortSide() Returns the port side of a link at the "from" side.
int	getIncrementalNodeMovementMode() Sets the movement mode of an individual node used during incremental layout.
float	getLinkPriority() Returns the priority of a link.
int	getLinkStyle() Returns the style of the shape of an individual link.
int	getNorthNumberOfPorts() Returns the number of relative ports on the north side of a node.
int	getOriginPointMode() Returns the mode for the connection point on an individual link on the origin node.
int	getSouthNumberOfPorts() Returns the number of relative ports on the south side of a node.
int	getSpecNodeLevelIndex() Returns the index of the specified level for a node.
int	getSpecNodePositionIndex() Returns the index of the specified position of a node within a level.
int	getToPortIndex() Returns the port index of a link at the "to" side.
int	getToPortSide() Returns the port side of a link at the "to" side.
int	getWestNumberOfPorts() Returns the number of relative ports on the west side of a node.
boolean	isMarkedForIncremental() Marks the input node or link to be repositioned with the next call of performLayout if incremental mode is enabled.
void	reset() Resets the configuration in this bean.
void	setDestinationPointMode(int mode) Sets the mode for the connection point on an individual link on the destination node.
void	setEastNumberOfPorts(int numberOfPorts) Sets the number of relative ports on the east side of a node.
void	setFromPortIndex(int portIndex) Sets the port index of a link at the "from" side.
void	setFromPortSide(int side) Sets the port side of a link at the "from" side.
void	setIncrementalNodeMovementMode(int mode) Sets the movement mode of an individual node used during incremental layout.
void	setLinkPriority(float priority) Sets the priority of a link.
void	setLinkStyle(int style) Sets the style of the shape of an individual link.
void	setMarkedForIncremental(boolean flag) Marks the input node or link to be repositioned with the next call of performLayout if incremental mode is enabled.
void	setNorthNumberOfPorts(int numberOfPorts) Sets the number of relative ports on the north side of a node.
void	setOriginPointMode(int mode) Sets the mode for the connection point on an individual link on the origin node.
void	setSouthNumberOfPorts(int numberOfPorts) Sets the number of relative ports on the south side of a node.
void	setSpecNodeLevelIndex(int index) Sets the index of the specified level for a node.
void	setSpecNodePositionIndex(int index) Sets the index of the specified position of a node within a level.
void	setToPortIndex(int portIndex) Sets the port index of a link at the "to" side.
void	setToPortSide(int side) Sets the port side of a link at the "to" side.
void	setWestNumberOfPorts(int numberOfPorts) Sets the number of relative ports on the west side of a 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

IlpHierarchicalLayoutParameters

public IlpHierarchicalLayoutParameters()

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

setDestinationPointMode

public void setDestinationPointMode(int mode)

Sets the mode for the connection point on an individual link on the destination node.

This mode is used only if the global "from" point mode is set to IlvHierarchicalLayout.MIXED_MODE. Otherwise, the connection points on the destination nodes have, for all the links, the mode that is specified as the global destination point mode.

Valid values are:

• IlvHierarchicalLayout.FREE_MODE - The layout is free to choose, for this link, the appropriate position of the connection point on the destination node, except for "pinned" connection points (see IlvGraphModel.hasPinnedConnectionPoint(java.lang.Object, boolean)). The choice can further be influenced by specifying the side and the port index of the links.
• IlvHierarchicalLayout.FIXED_MODE - The layout must keep, for this link, the current position of the connection point on the destination node.

  Note that if the mode is fixed, specifications of the port index of links at the "to" side are ignored.

The default value is IlvHierarchicalLayout.FREE_MODE.

Parameters:

mode - The mode to set.

See Also:

IlvHierarchicalLayout.setDestinationPointMode(java.lang.Object, int), getDestinationPointMode(), setToPortIndex(int)

getDestinationPointMode

public int getDestinationPointMode()

Returns the mode for the connection point on an individual link on the destination node.

See Also:

setDestinationPointMode(int)

setEastNumberOfPorts

public void setEastNumberOfPorts(int numberOfPorts)

Sets the number of relative ports on the east side of a node.

Parameters:

numberOfPorts - The number of relative ports.

See Also:

IlvHierarchicalLayout.setEastNumberOfPorts(java.lang.Object, int), getEastNumberOfPorts()

getEastNumberOfPorts

public int getEastNumberOfPorts()

Returns the number of relative ports on the east side of a node.

Returns:

The number of relative ports

See Also:

setEastNumberOfPorts(int)

setFromPortIndex

public void setFromPortIndex(int portIndex)

Sets the port index of a link at the "from" side.

This allows you to specify the relative ports of the links on the node border. Using relative ports is a way to specify the relative order of how the links connect to the "from" node. The specification is only used if the free origin point mode is used for the link.

Port numbers are between 0 and n - 1, where n is the number of ports at the node side where the link is connected. Links with an unspecified or negative port index are connected on the node border according to the global connector style. A link with a specified port index i is connected at the ith relative port, and the connector pins of ports are evenly spaced on the corresponding node border.

Parameters:

portIndex - The relative port index starting from 0.

See Also:

IlvHierarchicalLayout.setFromPortIndex(java.lang.Object, int), getFromPortIndex(), setToPortIndex(int), setFromPortSide(int), setOriginPointMode(int)

getFromPortIndex

public int getFromPortIndex()

Returns the port index of a link at the "from" side.

Returns:

From port index

See Also:

setFromPortIndex(int)

setFromPortSide

public void setFromPortSide(int side)

Sets the port side of a link at the "from" side. This allows you to specify at which side of the node the starting point of the link is connected.

Possible values for the side parameter are IlvHierarchicalLayout.EAST, IlvHierarchicalLayout.WEST, IlvHierarchicalLayout.NORTH, IlvHierarchicalLayout.SOUTH, and the default IlvHierarchicalLayout.UNSPECIFIED.

If a port side is unspecified, the link can connect to any border side of the node. Otherwise, the link connects only to the specified node border.

Parameters:

side - The side of the node from which the link is connected.

See Also:

IlvHierarchicalLayout.setFromPortSide(java.lang.Object, int), getFromPortSide(), setToPortSide(int), setFromPortIndex(int)

getFromPortSide

public int getFromPortSide()

Returns the port side of a link at the "from" side.

See Also:

setFromPortSide(int)

setIncrementalNodeMovementMode

public void setIncrementalNodeMovementMode(int mode)

Sets the movement mode of an individual node used during incremental layout.

This movement mode is used only if the incremental mode is enabled, the global movement mode is set to MIXED_MODE, and the node is not marked for incremental recalculation. If the global movement mode is not MIXED_MODE, all nodes have the mode that is specified as the global movement mode.

Valid values are:

• FREE_MODE - The incremental layout preserves the relative order of the node with respect to all other nodes (except those that are marked for incremental recalculation). It does not preserve the exact position. It may move the node a little bit to optimize the space usage. The shifting does not change the level structure of the graph. If the crossing reduction is disabled during incremental layout (see IlvHierarchicalLayout.setCrossingReductionDuringIncremental(boolean)), the shifting also does not change the order of the node within the levels with respect to the other nodes.
• FIXED_IN_X_MODE - The incremental layout preserves the relative order of the node with respect to all other nodes (except those that are marked for incremental recalculation), and it keeps the node fixed in the x direction. The node may shift in the y direction.
• FIXED_IN_Y_MODE - The incremental layout preserves the relative order of the node with respect to all other nodes (except those that are marked for incremental recalculation), and it keeps the node fixed in the y direction. The nodes may shift in the x direction.
• FIXED_MODE - The node does not move at all during incremental layout.

The default mode is FREE_MODE.

If the incremental mode is enabled and some nodes are fixed in the x or y direction, it often works well if the graph has a coarsely level structure (for example, if it was created by a previous layout in free mode or in nonincremental mode) but it may create overlaps or a messy arrangement otherwise, in particular if only few nodes are fixed and many nodes are free to move. Fixing nodes has several consequences: The spacing options are obeyed only if there is enough space between the fixed nodes. The specified position of the layout is not obeyed, because it would require shifting the fixed nodes. The crossing reduction during incremental layout has no effect (see IlvHierarchicalLayout.isCrossingReductionDuringIncremental()). However, you can decide whether to enable the crossing reduction of long links (see IlvHierarchicalLayout.isLongLinkCrossingReductionDuringIncremental()). If the long link crossing reduction is enabled, it will rearrange the long links that span several levels to avoid crossings.

Furthermore, note that if the generic connected component layout mechanism of IlvGraphLayout is enabled, it will move nodes even if they are specified as fixed. Therefore it is recommended disabling the generic connected component layout mechanism.

Parameters:

mode - The movement mode to set.

See Also:

IlvHierarchicalLayout.setIncrementalNodeMovementMode(java.lang.Object, int), getIncrementalNodeMovementMode()

getIncrementalNodeMovementMode

public int getIncrementalNodeMovementMode()

Sets the movement mode of an individual node used during incremental layout.

See Also:

setIncrementalNodeMovementMode(int)

setLinkPriority

public void setLinkPriority(float priority)

Sets the priority of a link.

The layout algorithm tries to place the links in such a way that the majority of the links are short and point in the same direction. However, this is not always possible for all links. Low priority links are more likely to be longer or point in the opposite direction than the high priority links. The link priority should be smaller than 10000.

Parameters:

priority - The link priority value, a number up to 10000.

See Also:

IlvHierarchicalLayout.setLinkPriority(java.lang.Object, float), getLinkPriority()

getLinkPriority

public float getLinkPriority()

Returns the priority of a link.

See Also:

setLinkPriority(float)

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. Otherwise, all links have the style that is specified as the global link style.

Valid values are:

• POLYLINE_STYLE - The link gets a polyline shape, that is, a shape consisting of a sequence of line segments.
• ORTHOGONAL_STYLE - The link gets an orthogonal shape, that is, a shape consisting of a sequence of orthogonal line segments.
• STRAIGHT_LINE_STYLE - The link gets a straight-line shape.
• NO_RESHAPE_STYLE - No reshape is performed on the link.

The default value is POLYLINE_STYLE.

Parameters:

style - The shape style.

See Also:

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

getLinkStyle

public int getLinkStyle()

Returns the style of the shape of an individual link.

See Also:

setLinkStyle(int)

setNorthNumberOfPorts

public void setNorthNumberOfPorts(int numberOfPorts)

Sets the number of relative ports on the north side of a node.

Parameters:

numberOfPorts - The number of relative ports.

See Also:

IlvHierarchicalLayout.setNorthNumberOfPorts(java.lang.Object, int), getNorthNumberOfPorts()

getNorthNumberOfPorts

public int getNorthNumberOfPorts()

Returns the number of relative ports on the north side of a node.

See Also:

setNorthNumberOfPorts(int)

setOriginPointMode

public void setOriginPointMode(int mode)

Sets the mode for the connection point on an individual link on the origin node.

This mode is used only if the global "from" point mode is set to IlvHierarchicalLayout.MIXED_MODE. Otherwise, the connection points on the origin nodes have, for all the links, the mode that is specified as the global origin point mode.

Valid values are:

• IlvHierarchicalLayout.FREE_MODE - The layout is free to choose, for this link, the appropriate position of the connection point on the origin node, except for "pinned" connection points (see IlvGraphModel.hasPinnedConnectionPoint(java.lang.Object, boolean)). The choice can further be influenced by specifying the side and the port index of the links.
• IlvHierarchicalLayout.FIXED_MODE - The layout must keep, for this link, the current position of the connection point on the origin node.

  Note that if the mode is fixed, specifications of the port index of links at the "from" side are ignored.

The default value is IlvHierarchicalLayout.FREE_MODE.

Parameters:

mode - The mode to set.

See Also:

IlvHierarchicalLayout.setOriginPointMode(java.lang.Object, int), getOriginPointMode()

getOriginPointMode

public int getOriginPointMode()

Returns the mode for the connection point on an individual link on the origin node.

See Also:

setOriginPointMode(int)

setSouthNumberOfPorts

public void setSouthNumberOfPorts(int numberOfPorts)

Sets the number of relative ports on the south side of a node.

Parameters:

numberOfPorts - The number of relative ports.

See Also:

IlvHierarchicalLayout.setSouthNumberOfPorts(java.lang.Object, int), getSouthNumberOfPorts()

getSouthNumberOfPorts

public int getSouthNumberOfPorts()

Returns the number of relative ports on the south side of a node.

See Also:

setSouthNumberOfPorts(int)

setSpecNodeLevelIndex

public void setSpecNodeLevelIndex(int index)

Sets the index of the specified level for a node.

Nodes are organized in horizontal or vertical levels numbered from 0 to n. If the link flow direction is from top to bottom, the nodes with level index 0 are placed in the topmost level, and the nodes with higher level indices are placed in the levels below.

If the link flow direction is from left to right, the nodes with level index 0 are placed in the leftmost level, and the nodes with higher level indices are placed in the levels farther to the right.

This method allows you to specify the level where a node should be placed. If the level index of a node is set to a negative value, it means that there is no preference for the level of the node. In this case, the layout algorithm calculates an appropriate level index.

The default level index of a node is -1; that is, the layout algorithm determines the appropriate level automatically.

Note that specified level indices can cause conflicts to constraints that are solved depending on the constraint priorities. The index specification or some of the constraints may be ignored in this case. Furthermore, note that if the generic connected component layout mechanism of IlvGraphLayout is enabled, each connected component uses its own level structure. If it is disabled, there is only one global level structure.

Parameters:

index - The level index.

See Also:

IlvHierarchicalLayout.setSpecNodeLevelIndex(java.lang.Object, int)

getSpecNodeLevelIndex

public int getSpecNodeLevelIndex()

Returns the index of the specified level for a node.

See Also:

setSpecNodeLevelIndex(int)

setSpecNodePositionIndex

public void setSpecNodePositionIndex(int index)

Sets the index of the specified position of a node within a level.

Nodes are organized in horizontal or vertical levels. Within each level, the nodes are placed sequentially at relative positions numbered from 0 to n. If the link flow direction is from top to bottom, the node with position index 0 is placed leftmost within its level, and the nodes with higher position indices are placed farther to the right. If the link flow direction is from right to left, the node with position index 0 is placed topmost within its level, and the nodes with higher position indices are placed below.

This method allows you to specify the relative position where a node should be placed within its level. If the position index of a node is set to a negative value, it means that there is no preference for the position of the node. In this case, the layout algorithm calculates an appropriate position index. If the position index is higher than the number of nodes in the level, the position index is ignored. If two nodes of the same level have the same position index, one of the indices is ignored. The layout algorithm calculates an appropriate position index for the nodes that have inappropriate or conflicting position indices.

The default position index of a node is -1; that is, the layout algorithm determines the appropriate position automatically.

Note that specified position indices can cause conflicts to constraints that are solved depending on the constraint priorities. The index specification or some of the constraints may be ignored in this case. Furthermore, note that if the generic connected component layout mechanism of IlvGraphLayout is enabled, each connected component uses its own level structure. If it is disabled, there is only one global level structure.

Parameters:

index - The position index within a level, starting from 0.

See Also:

IlvHierarchicalLayout.setSpecNodePositionIndex(java.lang.Object, int)

getSpecNodePositionIndex

public int getSpecNodePositionIndex()

Returns the index of the specified position of a node within a level.

See Also:

setSpecNodePositionIndex(int)

setToPortIndex

public void setToPortIndex(int portIndex)

Sets the port index of a link at the "to" side. This allows you to specify the relative ports of the links on the node border. Using the relative ports is a way to specify the relative order of how the links connect to the "to" node. The specification is only used if the free destination point mode is used for the link.

Port numbers are between 0 and n - 1, where n is the number of ports at the node side where the link is connected. Links with an unspecified or negative port index are connected on the node border according to the global connector style. A link with specified port index i is connected at the ith relative port, and the connector pins of ports are evenly spaced on the corresponding node border.

Parameters:

portIndex - The relative port index starting from 0.

See Also:

IlvHierarchicalLayout.setToPortIndex(java.lang.Object, int), getToPortIndex(), setFromPortIndex(int), setToPortSide(int)

getToPortIndex

public int getToPortIndex()

Returns the port index of a link at the "to" side.

See Also:

setToPortIndex(int)

setToPortSide

public void setToPortSide(int side)

Sets the port side of a link at the "to" side. This allows you to specify at which side of the node the end point of the link is connected.

Possible values for the side parameter are IlvHierarchicalLayout.EAST, IlvHierarchicalLayout.WEST, IlvHierarchicalLayout.NORTH, IlvHierarchicalLayout.SOUTH, and the default IlvHierarchicalLayout.UNSPECIFIED.

If a port side is unspecified, the link can connect to any border side of the node. Otherwise, the link connects only to the specified node border.

Parameters:

side - The side of the node to which the link is connected.

See Also:

IlvHierarchicalLayout.setToPortSide(java.lang.Object, int), getToPortSide(), setFromPortSide(int)

getToPortSide

public int getToPortSide()

Returns the port side of a link at the "to" side.

See Also:

setToPortSide(int)

setWestNumberOfPorts

public void setWestNumberOfPorts(int numberOfPorts)

Sets the number of relative ports on the west side of a node.

Parameters:

numberOfPorts - The number of relative ports.

See Also:

IlvHierarchicalLayout.setWestNumberOfPorts(java.lang.Object, int), getWestNumberOfPorts()

getWestNumberOfPorts

public int getWestNumberOfPorts()

Returns the number of relative ports on the west side of a node.

See Also:

setWestNumberOfPorts(int)

setMarkedForIncremental

public void setMarkedForIncremental(boolean flag)

Marks the input node or link to be repositioned with the next call of performLayout if incremental mode is enabled. Normally, the incremental layout tries to preserve the relative order of nodes and links. By setting a mark on a node, the level assignment and relative position of this node will be calculated from scratch. By setting a mark on a link, this link will be rerouted completely by the next layout. The mark is transient, that is, it is automatically cleared after an incremental layout is done.

Parameters:

flag - Indicating if this node or link is marked for incremental mode

isMarkedForIncremental

public boolean isMarkedForIncremental()

Marks the input node or link to be repositioned with the next call of performLayout if incremental mode is enabled. Normally, the incremental layout tries to preserve the relative order of nodes and links. By setting a mark on a node, the level assignment and relative position of this node will be calculated from scratch. By setting a mark on a link, this link will be rerouted completely by the next layout. The mark is transient, that is, it is automatically cleared after an incremental layout is done.