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

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

All Implemented Interfaces:

Comparable
```
public class ColumnDescriptor
extends Object
implements Comparable
```
This class represents a column of a partition grid structure.
The results of the calculation of the geometry of the column 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 `ColumnDescriptor` instance with a given other `ColumnDescriptor` instance based on the indices of the two instances.
`double`	`getComputedPosition()` Gets the computed position (smallest x-coordinate) of the column after the layout has been calculated.
`double`	`getComputedWidth()` Gets the computed width of the column after the layout has been calculated.
`int`	`getIndex()` Gets the index of the column within the `partition grid`.
`double`	`getLeftInset()` Gets the left column inset in which no element will lie in the resulting layout.
`double`	`getMinimumWidth()` Gets the minimum width of the column.
`double`	`getOriginalPosition()` Gets the original position (smallest x-coordinate) of the column.
`double`	`getOriginalWidth()` Gets the original width of the column.
`double`	`getRightInset()` Gets the right column inset in which no element will lie in the resulting layout.
`double`	`getTightness()` Gets the tightness factor of this column.
`boolean`	`isIndexFixed()` Gets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
`void`	`setComputedPosition(double value)` Sets the computed position (smallest x-coordinate) of the column after the layout has been calculated.
`void`	`setComputedWidth(double value)` Sets the computed width of the column after the layout has been calculated.
`void`	`setIndexFixed(boolean value)` Sets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
`void`	`setLeftInset(double value)` Sets the left column inset in which no element will lie in the resulting layout.
`void`	`setMinimumWidth(double value)` Sets the minimum width of the column.
`void`	`setOriginalPosition(double value)` Sets the original position (smallest x-coordinate) of the column.
`void`	`setOriginalWidth(double value)` Sets the original width of the column.
`void`	`setRightInset(double value)` Sets the right column inset in which no element will lie in the resulting layout.
`void`	`setTightness(double value)` Sets the tightness factor of this column.

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 ColumnDescriptor instance with a given other ColumnDescriptor instance based on the indices of the two instances.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    o - the ColumnDescriptor to compare to
    
    Returns:
    
    -1, 0 or 1 if this ColumnDescriptor is less than, equal to, or greater than the given other ColumnDescriptor
  - getComputedPosition
```
public double getComputedPosition()
```
    Gets the computed position (smallest x-coordinate) of the column after the layout has been calculated.
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the computed position (smallest x-coordinate)
    
    See Also:
    
    setComputedPosition(double)
  - getComputedWidth
```
public double getComputedWidth()
```
    Gets the computed width of the column after the layout has been calculated.
    The computed width needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the computed width is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the computed width
    
    See Also:
    
    setComputedWidth(double)
  - getIndex
```
public int getIndex()
```
    Gets the index of the column within the partition grid.
    
    Returns:
    
    the index of the column
  - getLeftInset
```
public double getLeftInset()
```
    Gets the left column inset in which no element will lie in the resulting layout.
    The column inset must be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the left inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the left column inset
    
    See Also:
    
    setLeftInset(double)
  - getMinimumWidth
```
public double getMinimumWidth()
```
    Gets the minimum width of the column.
    The minimum width is defined to be at least 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum width is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the minimum column width
    
    See Also:
    
    setMinimumWidth(double)
  - getOriginalPosition
```
public double getOriginalPosition()
```
    Gets the original position (smallest x-coordinate) of the column.
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the original position (smallest x-coordinate)
    
    See Also:
    
    setOriginalPosition(double)
  - getOriginalWidth
```
public double getOriginalWidth()
```
    Gets the original width of the column.
    The original width should be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the original width is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the original width
    
    See Also:
    
    setOriginalWidth(double)
  - getRightInset
```
public double getRightInset()
```
    Gets the right column inset in which no element will lie in the resulting layout.
    The column inset must be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the right inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Returns:
    
    the right column inset
    
    See Also:
    
    setRightInset(double)
  - getTightness
```
public double getTightness()
```
    Gets the tightness factor of this column.
    This value must lie within the interval [0,1].
    
    The larger the value, the more the column will be forced to obtain its minimum width:
    - a value of 0.0d will disable the compression of the column.
    - a value of 1.0d will try to force the column to obtain its specified minimum width.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside the interval [0,1]
    
    Default Value:
    The default value is 0.0. The column will not be compressed.
    
    Returns:
    
    a tightness value from the interval [0,1]
    
    See Also:
    
    setTightness(double)
  - isIndexFixed
```
public boolean isIndexFixed()
```
    Gets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
    For all columns where this property is enabled, the relative ordering given by the indices is preserved. The remaining columns may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the column is fixed.
    
    Returns:
    
    true if the column index should be fixed, false if it may be chosen automatically
    
    See Also:
    
    setIndexFixed(boolean)
  - setComputedPosition
```
public void setComputedPosition(double value)
```
    Sets the computed position (smallest x-coordinate) of the column after the layout has been calculated.
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the computed position (smallest x-coordinate)
    
    See Also:
    
    getComputedPosition()
  - setComputedWidth
```
public void setComputedWidth(double value)
```
    Sets the computed width of the column after the layout has been calculated.
    The computed width needs to be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the computed width is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the computed width
    
    See Also:
    
    getComputedWidth()
  - setIndexFixed
```
public void setIndexFixed(boolean value)
```
    Sets whether the index of the column is fixed or it should be chosen automatically in order to minimize edge lengths.
    For all columns where this property is enabled, the relative ordering given by the indices is preserved. The remaining columns may be sorted again so that the overall edge lengths are minimized.
    
    Default Value:
    The default value is true. The index of the column is fixed.
    
    Parameters:
    
    value - true if the column index should be fixed, false if it may be chosen automatically
    
    See Also:
    
    isIndexFixed()
  - setLeftInset
```
public void setLeftInset(double value)
```
    Sets the left column inset in which no element will lie in the resulting layout.
    The column inset must be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the left inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the left column inset
    
    See Also:
    
    getLeftInset()
  - setMinimumWidth
```
public void setMinimumWidth(double value)
```
    Sets the minimum width of the column.
    The minimum width is defined to be at least 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum width is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the minimum column width
    
    See Also:
    
    getMinimumWidth()
  - setOriginalPosition
```
public void setOriginalPosition(double value)
```
    Sets the original position (smallest x-coordinate) of the column.
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the original position (smallest x-coordinate)
    
    See Also:
    
    getOriginalPosition()
  - setOriginalWidth
```
public void setOriginalWidth(double value)
```
    Sets the original width of the column.
    The original width should be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the original width is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the original width
    
    See Also:
    
    getOriginalWidth()
  - setRightInset
```
public void setRightInset(double value)
```
    Sets the right column inset in which no element will lie in the resulting layout.
    The column inset must be greater than or equal to 0.
    
    Throws:
    
    IllegalArgumentException - if the right inset is negative
    
    Default Value:
    The default value is 0.0.
    
    Parameters:
    
    value - the right column inset
    
    See Also:
    
    getRightInset()
  - setTightness
```
public void setTightness(double value)
```
    Sets the tightness factor of this column.
    This value must lie within the interval [0,1].
    
    The larger the value, the more the column will be forced to obtain its minimum width:
    - a value of 0.0d will disable the compression of the column.
    - a value of 1.0d will try to force the column to obtain its specified minimum width.
    Throws:
    
    IllegalArgumentException - if the tightness value is outside the interval [0,1]
    
    Default Value:
    The default value is 0.0. The column will not be compressed.
    
    Parameters:
    
    value - a tightness value from the interval [0,1]
    
    See Also:
    
    getTightness()

Class ColumnDescriptor

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compareTo

getComputedPosition

getComputedWidth

getIndex

getLeftInset

getMinimumWidth

getOriginalPosition

getOriginalWidth

getRightInset

getTightness

isIndexFixed

setComputedPosition

setComputedWidth

setIndexFixed

setLeftInset

setMinimumWidth

setOriginalPosition

setOriginalWidth

setRightInset

setTightness