public class IlpShortLinkLayoutParameters extends IlpAbstractLinkLayoutParameters
To customize per-object properties, the graph layout renderer must be enabled and configured to customize per-object properties.
IlvShortLinkLayout
Constructor and Description |
---|
IlpShortLinkLayoutParameters()
Default constructor
|
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 |
getConnectorStyle()
Returns the connector style of an individual node.
|
int |
getIncrementalModifiedLinkReshapeMode()
Returns the link reshape mode of an individual link used during
incremental layout for modified links.
|
int |
getIncrementalUnmodifiedLinkReshapeMode()
Returns the link reshape mode of an individual link used during incremental
layout for unmodified links, that is links that have been already laid
out in the previous layout execution and for which the
bounding box (see
IlvShortLinkLayout.getNodeBoxInterface() nor the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have not been modified. |
void |
reset()
Resets the configuration in this bean.
|
void |
setConnectorStyle(int style)
Sets the connector style of an individual node.
|
void |
setDestinationPointMode(int mode)
Sets the mode for the connection point on an individual link
on the destination node.
|
void |
setIncrementalModifiedLinkReshapeMode(int mode)
Sets the link reshape mode of an individual link used during incremental
layout for modified links, that is links that have been already laid
out in the previous layout execution and for which the
bounding box (see
IlvShortLinkLayout.getNodeBoxInterface() or the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have been modified. |
void |
setIncrementalUnmodifiedLinkReshapeMode(int mode)
Sets the link reshape mode of an individual link used during incremental
layout for unmodified links, that is links that have been already laid
out in the previous layout execution and for which the
bounding box (see
IlvShortLinkLayout.getNodeBoxInterface() nor the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have not been modified. |
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.
|
getDestinationPointMode, getLinkStyle, getOriginPointMode
isFixed, isLayoutIgnored, setFixed, setLayoutIgnored
public IlpShortLinkLayoutParameters()
public void reset()
reset
in class IlpGraphLayoutParameters
public boolean apply(IlvGraphLayout layout, IlpRepresentationObject ro, IlvGraphic layoutProxy)
apply
in class IlpGraphLayoutParameters
layout
- Graph Layoutro
- Object to which the configuration will be appliedlayoutProxy
- Layout graphic object for a node or linkpublic void setConnectorStyle(int style)
MIXED_STYLE
. Otherwise, all nodes have the connector style that
is specified as the global connector style.
Valid values are:
IlvShortLinkLayout.FIXED_OFFSET_PINS
-
The link connector pins are spaced along the node border at a distance
equal to the link offset (see IlvShortLinkLayout.getLinkOffset()
).
IlvShortLinkLayout.EVENLY_SPACED_PINS
-
The link connector pins are evenly spaced along the node border, preserving
a margin which is determined by IlvShortLinkLayout.getEvenlySpacedPinsMarginRatio()
.
IlvShortLinkLayout.AUTOMATIC_PINS
-
Uses the connector style IlvShortLinkLayout.FIXED_OFFSET_PINS
except if this pushes
a connection point outside the border the link is attached to, in which case
it uses the connector style IlvShortLinkLayout.EVENLY_SPACED_PINS
.
The default value is AUTOMATIC_PINS
.
style
- The connector style.IlvShortLinkLayout.setConnectorStyle(java.lang.Object, int)
public int getConnectorStyle()
public void setDestinationPointMode(int mode)
This mode is used only if the global "from" point mode is set to
IlvShortLinkLayout.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:
IlvShortLinkLayout.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.
IlvShortLinkLayout.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 IlvShortLinkLayout.FREE_MODE
.
mode
- The mode to set.IlvShortLinkLayout.setDestinationPointMode(java.lang.Object, int)
,
IlpAbstractLinkLayoutParameters.getDestinationPointMode()
public void setIncrementalModifiedLinkReshapeMode(int mode)
IlvShortLinkLayout.getNodeBoxInterface()
or the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have been modified.
This link reshape mode is used only if the incremental mode is enabled
and the global link reshape mode is set to MIXED_MODE
.
If the global mode is not MIXED_MODE
, all links
have the mode that is specified as the global link reshape mode.
Valid values are:
FIXED_SHAPE_TYPE_MODE
-
The incremental layout preserves preserves the shape type of the link.
This means that both the number of bends and the node sides to which
the link is connected are preserved.
FIXED_NODE_SIDES_MODE
-
The incremental layout preserves the node sides to which
the links are connected.
FIXED_CONNECTION_POINTS_MODE
-
The incremental layout preserves the connection points of the links.
FIXED_MODE
-
The links are not reshaped at all during incremental layout.
Only newly added links are rerouted.
FREE_MODE
-
The incremental layout is allowed to freely reshape the links. This is
equivalent to a non-incremental behavior for the link
argument.
The default mode is FIXED_SHAPE_TYPE_MODE
.
mode
- The link reshape mode to set.IlvShortLinkLayout.setIncrementalModifiedLinkReshapeMode(java.lang.Object, int)
public int getIncrementalModifiedLinkReshapeMode()
public void setIncrementalUnmodifiedLinkReshapeMode(int mode)
IlvShortLinkLayout.getNodeBoxInterface()
nor the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have not been modified.
This link reshape mode is used only if the incremental mode is enabled
and the global link reshape mode is set to MIXED_MODE
.
If the global mode is not MIXED_MODE
, all links
have the mode that is specified as the global link reshape mode.
Valid values are:
FIXED_SHAPE_TYPE_MODE
-
The incremental layout preserves preserves the shape type of the link.
This means that both the number of bends and the node sides to which
the link is connected are preserved.
FIXED_NODE_SIDES_MODE
-
The incremental layout preserves the node sides to which
the links are connected.
FIXED_CONNECTION_POINTS_MODE
-
The incremental layout preserves the connection points of the links.
FIXED_MODE
-
The links are not reshaped at all during incremental layout.
Only newly added links are rerouted.
FREE_MODE
-
The incremental layout is allowed to freely reshape the links. This is
equivalent to a non-incremental behavior for the link
argument.
The default mode is FIXED_SHAPE_TYPE_MODE
.
mode
- The link reshape mode to set.IlvShortLinkLayout.setIncrementalUnmodifiedLinkReshapeMode(java.lang.Object, int)
public int getIncrementalUnmodifiedLinkReshapeMode()
IlvShortLinkLayout.getNodeBoxInterface()
nor the
"link connection box" (see @link ilog.views.graphlayout.link.shortlink.IlvShortLinkLayout#getLinkConnectionBoxInterface})
of their origin and destination nodes have not been modified.public void setLinkStyle(int style)
IlvShortLinkLayout.MIXED_STYLE
. Otherwise, all links have the style that
is specified as the global link style.
Valid values are:
IlvShortLinkLayout.ORTHOGONAL_STYLE
-
the link has an orthogonal shape, that is, a shape consisting of a
sequence of alternating horizontal and vertical line segments.
IlvShortLinkLayout.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
).
IlvShortLinkLayout.NO_RESHAPE_STYLE
-
the link is not reshaped.
The default value is IlvShortLinkLayout.ORTHOGONAL_STYLE
.
style
- The shape style.IlvShortLinkLayout.setLinkStyle(java.lang.Object, int)
,
IlpAbstractLinkLayoutParameters.getLinkStyle()
public void setOriginPointMode(int mode)
IlvShortLinkLayout.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:
IlvShortLinkLayout.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)
).
IlvShortLinkLayout.FIXED_MODE
-
The layout must keep, for this link, the current position of the
connection point on the origin node.
The default value is IlvShortLinkLayout.FREE_MODE
.
mode
- The mode to set.IlvShortLinkLayout.setOriginPointMode(java.lang.Object, int)
,
IlpAbstractLinkLayoutParameters.getOriginPointMode()
© Copyright 2024 Rogue Wave Software, Inc., a Perforce company.. All Rights Reserved.