public class SwimlaneLayout extends AbstractLayout
Constructor and Description |
---|
SwimlaneLayout()
Initializes a new instance of the
SwimlaneLayout class
with the default settings. |
Modifier and Type | Method and Description |
---|---|
boolean |
arrange(Diagram diagram,
DiagramItemList items)
Applies the layout on the specified subset of items from the
specified Diagram instance.
|
boolean |
getCollapseEmptyLanes()
Get or sets a value indicating whether lanes without associated nodes will
shrink to zero size.
|
boolean |
getCompactNodes()
Gets a value indicating whether the nodes within individual lanes are compacted.
|
Direction |
getDirection()
Gets the direction of the arranged diagram.
|
boolean |
getKeepLaneSizes()
Gets a value indicating whether the layout will attempt to preserve the
original sizes of the lanes in the supplied grid.
|
float |
getLaneDistance()
Gets the spacing between adjacent lanes in the final layout.
|
float |
getNodeDistance()
Gets the spacing between adjacent nodes within a lane in the final layout.
|
Orientation |
getOrientation()
Gets a the orientation of the arranged graph.
|
SwimlaneGrid |
getSwimlaneGrid()
Gets the object through which the layout can manipulate the swimlane grid.
|
com.mindfusion.diagramming.builders.SwimlaneLayoutBuilder |
init()
Returns a SwimlaneLayoutBuilder object used to configure this SwimlaneLayout instance.
|
void |
setCollapseEmptyLanes(boolean value)
Set or sets a value indicating whether lanes without associated nodes will
shrink to zero size.
|
void |
setCompactNodes(boolean value)
Sets a value indicating whether the nodes within individual lanes are compacted.
|
void |
setDirection(Direction value)
Sets the direction of the arranged diagram.
|
void |
setKeepLaneSizes(boolean value)
Sets a value indicating whether the layout will attempt to preserve the
original sizes of the lanes in the supplied grid.
|
void |
setLaneDistance(float value)
Sets the spacing between adjacent lanes in the final layout.
|
void |
setNodeDistance(float value)
Sets the spacing between adjacent nodes within a lane in the final layout.
|
void |
setOrientation(Orientation value)
Sets a the orientation of the arranged graph.
|
void |
setSwimlaneGrid(SwimlaneGrid value)
Sets the object through which the layout can manipulate the swimlane grid.
|
static com.mindfusion.diagramming.builders.SwimlaneLayoutBuilder |
with()
Returns a SwimlaneLayoutBuilder object used to configure and create new SwimlaneLayout instances.
|
arrange, getAnchoring, getGrowToFit, getKeepGroupLayout, getLayoutLink, getLayoutNode, getMargins, getMultipleGraphsPlacement, getProgress, removeMidleSegmentPoint, setAnchoring, setGrowToFit, setKeepGroupLayout, setLayoutLink, setLayoutNode, setMargins, setMultipleGraphsPlacement, setProgress
public SwimlaneLayout()
SwimlaneLayout
class
with the default settings.public boolean arrange(Diagram diagram, DiagramItemList items)
arrange
in class AbstractLayout
diagram
- The Diagram that should be arranged.items
- A collection of nodes and links from diagram that define
the subgraph to arrange.public Direction getDirection()
public void setDirection(Direction value)
Orientation.Horizontal
,
Direction.Straight
stands
for "left to right" and Direction.Reversed
for "right to left". If the orientation is set to
Orientation.Vertical
,
Direction.Straight
stands
for "top to bottom" and Direction.Reversed
for "bottom to top".public Orientation getOrientation()
Orientation
enumeration.public void setOrientation(Orientation value)
value
- A member of the Orientation
enumeration.public SwimlaneGrid getSwimlaneGrid()
public void setSwimlaneGrid(SwimlaneGrid value)
public float getLaneDistance()
public void setLaneDistance(float value)
public float getNodeDistance()
public void setNodeDistance(float value)
public boolean getCollapseEmptyLanes()
setLaneDistance(float)
.public void setCollapseEmptyLanes(boolean value)
setLaneDistance(float)
.
To be able to shrink the lanes of a lane grid to zero size, the MinHeaderSize
property of the lane grid must be set to an appropriate value.public boolean getCompactNodes()
public void setCompactNodes(boolean value)
public boolean getKeepLaneSizes()
public void setKeepLaneSizes(boolean value)
public static com.mindfusion.diagramming.builders.SwimlaneLayoutBuilder with()
SwimlaneLayoutBuilder
instance.public com.mindfusion.diagramming.builders.SwimlaneLayoutBuilder init()
SwimlaneLayoutBuilder
instance.