com.mindfusion.diagramming.jlayout
Class SwimlaneLayoutInfo

java.lang.Object
  extended by com.mindfusion.diagramming.jlayout.SwimlaneLayoutInfo

public class SwimlaneLayoutInfo
extends java.lang.Object

Contains settings for the SwimlaneLayout class.


Constructor Summary
SwimlaneLayoutInfo()
          Initializes a new instance of the SwimlaneLayoutInfo class.
 
Method Summary
 boolean getCollapseEmptyLanes()
          Get 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.
 int 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.
 XDimension2D.Double getMargins()
          Gets the distance between the top-left corner of the smallest rectangle containing the arranged diagram and the top-left point of the document bounds.
 float getNodeDistance()
          Gets the spacing between adjacent nodes within a lane in the final layout.
 int getOrientation()
          Gets the overall orientation of the arranged diagram.
 SwimlaneGrid getSwimlaneGrid()
          Gets the object through which the swimlane grid can be manipulated by the layout.
 void setCollapseEmptyLanes(boolean value)
          Set 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(int value)
          Gets the direction of the arranged diagram.
 void setKeepLaneSizes(boolean value)
          Gets 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 setMargins(XDimension2D.Double value)
          Sets the distance between the top-left corner of the smallest rectangle containing the arranged diagram and the top-left point of the document bounds.
 void setNodeDistance(float value)
          Sets the spacing between adjacent nodes within a lane in the final layout.
 void setOrientation(int value)
          Sets the overall orientation of the arranged diagram.
 void setSwimlaneGrid(SwimlaneGrid value)
          Sets the object through which the swimlane grid can be manipulated by the layout.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SwimlaneLayoutInfo

public SwimlaneLayoutInfo()
Initializes a new instance of the SwimlaneLayoutInfo class.

Method Detail

getOrientation

public int getOrientation()
Gets the overall orientation of the arranged diagram.


setOrientation

public void setOrientation(int value)
Sets the overall orientation of the arranged diagram.


getDirection

public int getDirection()
Gets the direction of the arranged diagram.


setDirection

public void setDirection(int value)
Gets the direction of the arranged diagram.


getSwimlaneGrid

public SwimlaneGrid getSwimlaneGrid()
Gets the object through which the swimlane grid can be manipulated by the layout.


setSwimlaneGrid

public void setSwimlaneGrid(SwimlaneGrid value)
Sets the object through which the swimlane grid can be manipulated by the layout.


getMargins

public XDimension2D.Double getMargins()
Gets the distance between the top-left corner of the smallest rectangle containing the arranged diagram and the top-left point of the document bounds.


setMargins

public void setMargins(XDimension2D.Double value)
Sets the distance between the top-left corner of the smallest rectangle containing the arranged diagram and the top-left point of the document bounds.


getLaneDistance

public float getLaneDistance()
Gets the spacing between adjacent lanes in the final layout.


setLaneDistance

public void setLaneDistance(float value)
Sets the spacing between adjacent lanes in the final layout.


getNodeDistance

public float getNodeDistance()
Gets the spacing between adjacent nodes within a lane in the final layout.


setNodeDistance

public void setNodeDistance(float value)
Sets the spacing between adjacent nodes within a lane in the final layout.


getCollapseEmptyLanes

public boolean getCollapseEmptyLanes()
Get a value indicating whether lanes without associated nodes will shrink to zero size. By default, empty lanes will have size equal to LaneDistance.


setCollapseEmptyLanes

public void setCollapseEmptyLanes(boolean value)
Set a value indicating whether lanes without associated nodes will shrink to zero size. By default, empty lanes will have size equal to LaneDistance.


getCompactNodes

public boolean getCompactNodes()
Gets a value indicating whether the nodes within individual lanes are compacted.


setCompactNodes

public void setCompactNodes(boolean value)
Sets a value indicating whether the nodes within individual lanes are compacted.


getKeepLaneSizes

public boolean getKeepLaneSizes()
Gets a value indicating whether the layout will attempt to preserve the original sizes of the lanes in the supplied grid.


setKeepLaneSizes

public void setKeepLaneSizes(boolean value)
Gets a value indicating whether the layout will attempt to preserve the original sizes of the lanes in the supplied grid.