ilog.cpl.graph.graphlayout.css

Class IlpLinkLayoutParameters

java.lang.Object

ilog.cpl.graph.graphlayout.css.IlpGraphLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpAbstractLinkLayoutParameters

ilog.cpl.graph.graphlayout.css.IlpLinkLayoutParameters

public class IlpLinkLayoutParameters
extends IlpAbstractLinkLayoutParameters

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

IlvLinkLayout

Constructor Summary

Constructors

Constructor and Description
IlpLinkLayoutParameters() 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.
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	setLinkStyle(int style) Sets the shape style of an individual link.
void	setOriginPointMode(int mode) Sets the mode for the connection point on an individual link on the origin node.

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

getDestinationPointMode, getLinkStyle, getOriginPointMode

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

IlpLinkLayoutParameters

public IlpLinkLayoutParameters()

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 IlvLinkLayout.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:

• IlvLinkLayout.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.
• IlvLinkLayout.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 IlvLinkLayout.FREE_MODE.

Parameters:

mode - The mode to set.

See Also:

IlvLinkLayout.setDestinationPointMode(java.lang.Object, int), IlpAbstractLinkLayoutParameters.getDestinationPointMode()

setLinkStyle

public void setLinkStyle(int style)

Sets the shape style of an individual link. This link style is used only if the global link style is set to IlvLinkLayout.MIXED_STYLE. Otherwise, all links have the style that is specified as the global link style.

Valid values are:

• IlvLinkLayout.ORTHOGONAL_STYLE - the link has an orthogonal shape, that is, a shape consisting of a sequence of alternating horizontal and vertical line segments.
• IlvLinkLayout.DIRECT_STYLE - the link gets a nearly straight-line shape. The shape of the link is a polyline composed of a straight-line segment between the end nodes with two short horizontal or vertical segments at its ends (their length is controlled by the method setMinFinalSegmentLength and may be 0).
• IlvLinkLayout.NO_RESHAPE_STYLE - the link is not reshaped.

The default value is IlvLinkLayout.ORTHOGONAL_STYLE.

Parameters:

style - The shape style.

See Also:

IlvLinkLayout.setLinkStyle(java.lang.Object, int), IlpAbstractLinkLayoutParameters.getLinkStyle()

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 IlvLinkLayout.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:

• IlvLinkLayout.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)).
• IlvLinkLayout.FIXED_MODE - The layout must keep, for this link, the current position of the connection point on the origin node.

The default value is IlvLinkLayout.FREE_MODE.

Parameters:

mode - The mode to set.

See Also:

IlvLinkLayout.setOriginPointMode(java.lang.Object, int), IlpAbstractLinkLayoutParameters.getOriginPointMode()