SwimlaneDescriptor (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.hierarchic.SwimlaneDescriptor

All Implemented Interfaces:

com.yworks.yfiles.algorithms.Comparators.IPartialOrder, Comparable
```
public class SwimlaneDescriptor
extends Object
implements Comparable, com.yworks.yfiles.algorithms.Comparators.IPartialOrder
```
This class is used by HierarchicLayoutCore during the various phases and models a swimlane structure.
For layout orientation LayoutOrientation.TOP_TO_BOTTOM, swimlanes partition the drawing area into vertical stripes. Each node is placed within a user-specified lane. Swimlanes are, for example, often used in flow diagrams to separate logical units.

Each node should be associated with a SwimLaneDescriptor instance; nodes in the same lane may share one instance. The results of the calculation of the swimlanes' geometry will be stored by the instances after the layout.

A SwimlaneDescriptor instance can be bound to the layout algorithm using a IDataProvider registered with the graph using key HierarchicLayoutCore.SWIMLANE_DESCRIPTOR_DPKEY that returns a SwimlaneDescriptor instance for each node of the graph.

Class PartitionGrid offers a newer implementation which supports both horizontal and vertical swimlanes.

See Also:

HierarchicLayoutCore.SWIMLANE_DESCRIPTOR_DPKEY

Constructor Summary

Constructors
Constructor and Description
`SwimlaneDescriptor(Comparable clientObject)` Creates a new `SwimlaneDescriptor` instance with a given `Comparable` object.
`SwimlaneDescriptor(Object clientObject, Comparator<Object> comparator)` Creates a new `SwimlaneDescriptor` instance with a given client `Object` and a given `Comparator`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object o)` Implements the `Comparable` interface using the `Comparator` and `ClientObject` fields.
`Object`	`getClientObject()` Gets the client `object`.
`Comparator<Object>`	`getComparator()` Gets the `Comparator` instance used for sorting the lanes.
`int`	`getComputedLaneIndex()` Gets the computed zero-based index of the swimlane after the layout has been calculated.
`double`	`getComputedLanePosition()` Gets the computed position (smaller coordinate) of the swimlane after the layout has been calculated.
`double`	`getComputedLaneWidth()` Gets the computed width of the swimlane after the layout has been calculated.
`double`	`getLaneTightness()` Gets the tightness factor of the lane.
`double`	`getLeftLaneInset()` Gets the left insets of the swimlane in which no element will lie in the resulting layout.
`double`	`getMinimumLaneWidth()` Gets the minimum width of the swimlane.
`double`	`getRightLaneInset()` Gets the right insets of the swimlane in which no element will lie in the resulting layout.
`boolean`	`isIndexFixed()` Gets whether or not an index of a swimlane is fixed (based on the result of the comparison with the other swimlanes) or whether the index should be chosen automatically in order to minimize edge lengths.
`void`	`setClientObject(Object value)` Sets the client `object`.
`void`	`setComparator(Comparator<Object> value)` Sets the `Comparator` instance used for sorting the lanes.
`void`	`setIndexFixed(boolean value)` Sets whether or not an index of a swimlane is fixed (based on the result of the comparison with the other swimlanes) or whether the index should be chosen automatically in order to minimize edge lengths.
`void`	`setLaneTightness(double value)` Sets the tightness factor of the lane.
`void`	`setLeftLaneInset(double value)` Sets the left insets of the swimlane in which no element will lie in the resulting layout.
`void`	`setMinimumLaneWidth(double value)` Sets the minimum width of the swimlane.
`void`	`setRightLaneInset(double value)` Sets the right insets of the swimlane in which no element will lie in the resulting layout.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SwimlaneDescriptor
```
public SwimlaneDescriptor(Comparable clientObject)
```
    Creates a new SwimlaneDescriptor instance with a given Comparable object.
    
    Throws:
    
    IllegalArgumentException - if the specified client object is null.
    
    Parameters:
    
    clientObject - a Comparable used for determining the order of the lanes
  - SwimlaneDescriptor
```
public SwimlaneDescriptor(Object clientObject,
                          Comparator<Object> comparator)
```
    Creates a new SwimlaneDescriptor instance with a given client Object and a given Comparator.
    The given client Object should be an instance of Comparable if the given Comparator is null.
    
    Throws:
    
    IllegalArgumentException - if the specified client Object is null or the specified Comparator is null but the specified client Object is not an instance of Comparable.
    
    Parameters:
    
    clientObject - a client Object used for sorting the lanes
    
    comparator - a Comparator used for comparing the client objects
- Method Detail
  - compareTo
```
public int compareTo(Object o)
```
    Implements the Comparable interface using the Comparator and ClientObject fields.
    
    Specified by:
    
    compareTo in interface Comparable
  - getClientObject
```
public Object getClientObject()
```
    Gets the client object.
    The given client Object should be an instance of Comparable.
    
    Throws:
    
    IllegalArgumentException - if there is currently no comparator and the specified object is not a Comparable instance
    
    Returns:
    
    the given client Object
    
    See Also:
    
    getComparator(), setComparator(Comparator), setClientObject(Object)
  - getComparator
```
public Comparator<Object> getComparator()
```
    Gets the Comparator instance used for sorting the lanes.
    
    Throws:
    
    IllegalArgumentException - if the specified Comparator is null.
    
    Returns:
    
    the current Comparator instance
    
    See Also:
    
    setComparator(Comparator)
  - getComputedLaneIndex
```
public int getComputedLaneIndex()
```
    Gets the computed zero-based index of the swimlane after the layout has been calculated.
    
    Returns:
    
    the computed lane index or -1 if no index has been computed for this lane.
  - getComputedLanePosition
```
public double getComputedLanePosition()
```
    Gets the computed position (smaller coordinate) of the swimlane after the layout has been calculated.
    
    Returns:
    
    the smaller coordinate of the swimlane
  - getComputedLaneWidth
```
public double getComputedLaneWidth()
```
    Gets the computed width of the swimlane after the layout has been calculated.
    
    Returns:
    
    the computed width of the swimlane
  - getLaneTightness
```
public double getLaneTightness()
```
    Gets the tightness factor of the lane.
    This value should lie within [0,1] interval.
    
    The greater the value, the more will the lane be forced to obtain its minimum possible width.
    - A value of 0.0d will disable compression of the lane.
    - A value of 1.0d will try to force the lane to obtain its minimum width.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside [0,1] interval
    
    Default Value:
    The default value is 0.0d. Swimlane will not be compressed.
    
    Returns:
    
    a tightness value from [0,1] interval
    
    See Also:
    
    setLaneTightness(double)
  - getLeftLaneInset
```
public double getLeftLaneInset()
```
    Gets the left insets of the swimlane in which no element will lie in the resulting layout.
    The inset should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value is less than 0.
    
    Default Value:
    The default value is 0.0d.
    
    Returns:
    
    the current left insets
    
    See Also:
    
    setLeftLaneInset(double)
  - getMinimumLaneWidth
```
public double getMinimumLaneWidth()
```
    Gets the minimum width of the swimlane.
    The minimum width should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value negative
    
    Default Value:
    The default value is 0.0d.
    
    Returns:
    
    the minimum width
    
    See Also:
    
    setMinimumLaneWidth(double)
  - getRightLaneInset
```
public double getRightLaneInset()
```
    Gets the right insets of the swimlane in which no element will lie in the resulting layout.
    The inset should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value is less than 0.
    
    Default Value:
    The default value is 0.0d.
    
    Returns:
    
    the current right insets
    
    See Also:
    
    setRightLaneInset(double)
  - isIndexFixed
```
public boolean isIndexFixed()
```
    Gets whether or not an index of a swimlane is fixed (based on the result of the comparison with the other swimlanes) or whether the index should be chosen automatically in order to minimize edge lengths.
    For all swimlanes where this property is set to true, the relative ordering given by the client objects is preserved. The remaining swimlanes may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the swimlane will not be determined automatically.
    
    Returns:
    
    true if the swimlane index are determined automatically, false otherwise
    
    See Also:
    
    setIndexFixed(boolean)
  - setClientObject
```
public void setClientObject(Object value)
```
    Sets the client object.
    The given client Object should be an instance of Comparable.
    
    Throws:
    
    IllegalArgumentException - if there is currently no comparator and the specified object is not a Comparable instance
    
    Parameters:
    
    value - the given client Object
    
    See Also:
    
    getComparator(), setComparator(Comparator), getClientObject()
  - setComparator
```
public void setComparator(Comparator<Object> value)
```
    Sets the Comparator instance used for sorting the lanes.
    
    Throws:
    
    IllegalArgumentException - if the specified Comparator is null.
    
    Parameters:
    
    value - the current Comparator instance
    
    See Also:
    
    getComparator()
  - setIndexFixed
```
public void setIndexFixed(boolean value)
```
    Sets whether or not an index of a swimlane is fixed (based on the result of the comparison with the other swimlanes) or whether the index should be chosen automatically in order to minimize edge lengths.
    For all swimlanes where this property is set to true, the relative ordering given by the client objects is preserved. The remaining swimlanes may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the swimlane will not be determined automatically.
    
    Parameters:
    
    value - true if the swimlane index are determined automatically, false otherwise
    
    See Also:
    
    isIndexFixed()
  - setLaneTightness
```
public void setLaneTightness(double value)
```
    Sets the tightness factor of the lane.
    This value should lie within [0,1] interval.
    
    The greater the value, the more will the lane be forced to obtain its minimum possible width.
    - A value of 0.0d will disable compression of the lane.
    - A value of 1.0d will try to force the lane to obtain its minimum width.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside [0,1] interval
    
    Default Value:
    The default value is 0.0d. Swimlane will not be compressed.
    
    Parameters:
    
    value - a tightness value from [0,1] interval
    
    See Also:
    
    getLaneTightness()
  - setLeftLaneInset
```
public void setLeftLaneInset(double value)
```
    Sets the left insets of the swimlane in which no element will lie in the resulting layout.
    The inset should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value is less than 0.
    
    Default Value:
    The default value is 0.0d.
    
    Parameters:
    
    value - the current left insets
    
    See Also:
    
    getLeftLaneInset()
  - setMinimumLaneWidth
```
public void setMinimumLaneWidth(double value)
```
    Sets the minimum width of the swimlane.
    The minimum width should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value negative
    
    Default Value:
    The default value is 0.0d.
    
    Parameters:
    
    value - the minimum width
    
    See Also:
    
    getMinimumLaneWidth()
  - setRightLaneInset
```
public void setRightLaneInset(double value)
```
    Sets the right insets of the swimlane in which no element will lie in the resulting layout.
    The inset should be non-negative.
    
    Throws:
    
    IllegalArgumentException - if the specified value is less than 0.
    
    Default Value:
    The default value is 0.0d.
    
    Parameters:
    
    value - the current right insets
    
    See Also:
    
    getRightLaneInset()

Class SwimlaneDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwimlaneDescriptor

SwimlaneDescriptor

Method Detail

compareTo

getClientObject

getComparator

getComputedLaneIndex

getComputedLanePosition

getComputedLaneWidth

getLaneTightness

getLeftLaneInset

getMinimumLaneWidth

getRightLaneInset

isIndexFixed

setClientObject

setComparator

setIndexFixed

setLaneTightness

setLeftLaneInset

setMinimumLaneWidth

setRightLaneInset