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

java.lang.Object
- com.yworks.yfiles.layout.RowDescriptor

All Implemented Interfaces:

Comparable
```
public class RowDescriptor
extends Object
implements Comparable
```
This class represents a row of a partition grid structure.
The results of the calculation of the geometry of the row will be placed into the instances of this class after the layout.

See Also:

PartitionGrid

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Object o)` Compares this `RowDescriptor` instance with a given other `RowDescriptor` instance based on the indices of the two instances.
`double`	`getBottomInset()` Gets the bottom inset in which no element will lie in the resulting layout.
`double`	`getComputedHeight()` Gets the computed height of the row after the layout has been calculated.
`double`	`getComputedPosition()` Gets the computed position (smallest y-coordinate) of the row after the layout has been calculated.
`int`	`getIndex()` Gets the index of the row within the `partition grid`.
`double`	`getMinimumHeight()` Gets the minimum height of the row.
`double`	`getOriginalHeight()` Gets the original height of the row.
`double`	`getOriginalPosition()` Gets the original position (smallest y-coordinate) of the row.
`double`	`getTightness()` Gets the tightness factor of this row.
`double`	`getTopInset()` Gets the top inset in which no element will lie in the resulting layout.
`boolean`	`isIndexFixed()` Gets whether the index of the row is fixed or it should be chosen automatically in order to minimize edge lengths.
`void`	`setBottomInset(double value)` Sets the bottom inset in which no element will lie in the resulting layout.
`void`	`setComputedHeight(double value)` Sets the computed height of the row after the layout has been calculated.
`void`	`setComputedPosition(double value)` Sets the computed position (smallest y-coordinate) of the row after the layout has been calculated.
`void`	`setIndexFixed(boolean value)` Sets whether the index of the row is fixed or it should be chosen automatically in order to minimize edge lengths.
`void`	`setMinimumHeight(double value)` Sets the minimum height of the row.
`void`	`setOriginalHeight(double value)` Sets the original height of the row.
`void`	`setOriginalPosition(double value)` Sets the original position (smallest y-coordinate) of the row.
`void`	`setTightness(double value)` Sets the tightness factor of this row.
`void`	`setTopInset(double value)` Sets the top inset 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

- Method Detail
  - compareTo
```
public int compareTo(Object o)
```
    Compares this RowDescriptor instance with a given other RowDescriptor instance based on the indices of the two instances.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    o - the RowDescriptor to compare to
    
    Returns:
    
    -1, 0 or 1 if this RowDescriptor is less than, equal to, or greater than the given other RowDescriptor
  - getBottomInset
```
public double getBottomInset()
```
    Gets the bottom inset in which no element will lie in the resulting layout.
    The inset value needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the given bottom inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the bottom inset
    
    See Also:
    
    setBottomInset(double)
  - getComputedHeight
```
public double getComputedHeight()
```
    Gets the computed height of the row after the layout has been calculated.
    The computed height needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the computed height is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the current computed height
    
    See Also:
    
    setComputedHeight(double)
  - getComputedPosition
```
public double getComputedPosition()
```
    Gets the computed position (smallest y-coordinate) of the row after the layout has been calculated.
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the computed position (smallest y-coordinate)
    
    See Also:
    
    setComputedPosition(double)
  - getIndex
```
public int getIndex()
```
    Gets the index of the row within the partition grid.
    
    Returns:
    
    the index of the row
  - getMinimumHeight
```
public double getMinimumHeight()
```
    Gets the minimum height of the row.
    The minimum height is defined to be at least 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum height is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the current row height
    
    See Also:
    
    setMinimumHeight(double)
  - getOriginalHeight
```
public double getOriginalHeight()
```
    Gets the original height of the row.
    The original height needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the original height is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the original height
    
    See Also:
    
    setOriginalHeight(double)
  - getOriginalPosition
```
public double getOriginalPosition()
```
    Gets the original position (smallest y-coordinate) of the row.
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the original position (smallest y-coordinate)
    
    See Also:
    
    setOriginalPosition(double)
  - getTightness
```
public double getTightness()
```
    Gets the tightness factor of this row.
    This value must lie within the interval [0,1].
    
    The larger the value, the more the row will be forced to obtain its minimum height:
    - a value of 0.0d will disable the compression of the row.
    - a value of 1.0d will try to force the row to obtain its specified minimum height.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside the interval [0,1]
    
    Default Value:
    The default value is 0.0. The row will not be compressed.
    
    Returns:
    
    a tightness value from the interval [0,1]
    
    See Also:
    
    setTightness(double)
  - getTopInset
```
public double getTopInset()
```
    Gets the top inset in which no element will lie in the resulting layout.
    The inset value needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the given top inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the top inset
    
    See Also:
    
    setTopInset(double)
  - isIndexFixed
```
public boolean isIndexFixed()
```
    Gets whether the index of the row is fixed or it should be chosen automatically in order to minimize edge lengths.
    For all rows where this property is enabled, the relative ordering given by the indices is preserved. The remaining rows may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the row is fixed.
    
    Returns:
    
    true if the row index is fixed, false if it may be chosen automatically
    
    See Also:
    
    setIndexFixed(boolean)
  - setBottomInset
```
public void setBottomInset(double value)
```
    Sets the bottom inset in which no element will lie in the resulting layout.
    The inset value needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the given bottom inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the bottom inset
    
    See Also:
    
    getBottomInset()
  - setComputedHeight
```
public void setComputedHeight(double value)
```
    Sets the computed height of the row after the layout has been calculated.
    The computed height needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the computed height is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the current computed height
    
    See Also:
    
    getComputedHeight()
  - setComputedPosition
```
public void setComputedPosition(double value)
```
    Sets the computed position (smallest y-coordinate) of the row after the layout has been calculated.
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the computed position (smallest y-coordinate)
    
    See Also:
    
    getComputedPosition()
  - setIndexFixed
```
public void setIndexFixed(boolean value)
```
    Sets whether the index of the row is fixed or it should be chosen automatically in order to minimize edge lengths.
    For all rows where this property is enabled, the relative ordering given by the indices is preserved. The remaining rows may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the row is fixed.
    
    Parameters:
    
    value - true if the row index is fixed, false if it may be chosen automatically
    
    See Also:
    
    isIndexFixed()
  - setMinimumHeight
```
public void setMinimumHeight(double value)
```
    Sets the minimum height of the row.
    The minimum height is defined to be at least 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum height is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the current row height
    
    See Also:
    
    getMinimumHeight()
  - setOriginalHeight
```
public void setOriginalHeight(double value)
```
    Sets the original height of the row.
    The original height needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the original height is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the original height
    
    See Also:
    
    getOriginalHeight()
  - setOriginalPosition
```
public void setOriginalPosition(double value)
```
    Sets the original position (smallest y-coordinate) of the row.
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the original position (smallest y-coordinate)
    
    See Also:
    
    getOriginalPosition()
  - setTightness
```
public void setTightness(double value)
```
    Sets the tightness factor of this row.
    This value must lie within the interval [0,1].
    
    The larger the value, the more the row will be forced to obtain its minimum height:
    - a value of 0.0d will disable the compression of the row.
    - a value of 1.0d will try to force the row to obtain its specified minimum height.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside the interval [0,1]
    
    Default Value:
    The default value is 0.0. The row will not be compressed.
    
    Parameters:
    
    value - a tightness value from the interval [0,1]
    
    See Also:
    
    getTightness()
  - setTopInset
```
public void setTopInset(double value)
```
    Sets the top inset in which no element will lie in the resulting layout.
    The inset value needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the given top inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the top inset
    
    See Also:
    
    getTopInset()

Class RowDescriptor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

getBottomInset

getComputedHeight

getComputedPosition

getIndex

getMinimumHeight

getOriginalHeight

getOriginalPosition

getTightness

getTopInset

isIndexFixed

setBottomInset

setComputedHeight

setComputedPosition

setIndexFixed

setMinimumHeight

setOriginalHeight

setOriginalPosition

setTightness

setTopInset