ColumnConstraints

java.lang.Object
- javafx.scene.layout.ConstraintsBase
- - javafx.scene.layout.ColumnConstraints

public class ColumnConstraints
extends ConstraintsBase

Defines optional layout constraints for a column in a GridPane. If a ColumnConstraints object is added for a column in a gridpane, the gridpane will use those constraint values when computing the column's width and layout.

For example, to create a GridPane with 5 columns 100 pixels wide:


     GridPane gridpane = new GridPane();
     for (int i = 0; i < 5; i++) {
         ColumnConstraints column = new ColumnConstraints(100);
         gridpane.getColumnConstraints().add(column);
     }

Or, to create a GridPane where columns take 25%, 50%, 25% of its width:


     GridPane gridpane = new GridPane();
     ColumnConstraints col1 = new ColumnConstraints();
     col1.setPercentWidth(25);
     ColumnConstraints col2 = new ColumnConstraints();
     col2.setPercentWidth(50);
     ColumnConstraints col3 = new ColumnConstraints();
     col3.setPercentWidth(25);
     gridpane.getColumnConstraints().addAll(col1,col2,col3);

Note that adding an empty ColumnConstraints object has the effect of not setting any constraints, leaving the GridPane to compute the column's layout based solely on its content's size preferences and constraints.

Since:: JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`BooleanProperty`	`fillWidth` The horizontal fill policy for the column.
`<any>`	`halignment` The horizontal alignment for the column.
`<any>`	`hgrow` The horizontal grow priority for the column.
`DoubleProperty`	`maxWidth` The maximum width for the column.
`DoubleProperty`	`minWidth` The minimum width for the column.
`DoubleProperty`	`percentWidth` The width percentage of the column.
`DoubleProperty`	`prefWidth` The preferred width for the column.

Field Summary

Fields
Modifier and Type	Field and Description
`private BooleanProperty`	`fillWidth` The horizontal fill policy for the column.
`private <any>`	`halignment` The horizontal alignment for the column.
`private <any>`	`hgrow` The horizontal grow priority for the column.
`private DoubleProperty`	`maxWidth` The maximum width for the column.
`private DoubleProperty`	`minWidth` The minimum width for the column.
`private DoubleProperty`	`percentWidth` The width percentage of the column.
`private DoubleProperty`	`prefWidth` The preferred width for the column.

Fields inherited from class javafx.scene.layout.ConstraintsBase
CONSTRAIN_TO_PREF

Constructor Summary

Constructors
Constructor and Description
`ColumnConstraints()` Create a column constraint object with no properties set.
`ColumnConstraints(double width)` Creates a column constraint object with a fixed width.
`ColumnConstraints(double minWidth, double prefWidth, double maxWidth)` Creates a column constraint object with a fixed size range.
`ColumnConstraints(double minWidth, double prefWidth, double maxWidth, Priority hgrow, HPos halignment, boolean fillWidth)` Creates a column constraint object with a fixed size range, horizontal grow priority, horizonal alignment, and horizontal fill behavior.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BooleanProperty`	`fillWidthProperty()` The horizontal fill policy for the column.
`HPos`	`getHalignment()` Gets the value of the property halignment.
`Priority`	`getHgrow()` Gets the value of the property hgrow.
`double`	`getMaxWidth()` Gets the value of the property maxWidth.
`double`	`getMinWidth()` Gets the value of the property minWidth.
`double`	`getPercentWidth()` Gets the value of the property percentWidth.
`double`	`getPrefWidth()` Gets the value of the property prefWidth.
`<any>`	`halignmentProperty()` The horizontal alignment for the column.
`<any>`	`hgrowProperty()` The horizontal grow priority for the column.
`boolean`	`isFillWidth()` Gets the value of the property fillWidth.
`DoubleProperty`	`maxWidthProperty()` The maximum width for the column.
`DoubleProperty`	`minWidthProperty()` The minimum width for the column.
`DoubleProperty`	`percentWidthProperty()` The width percentage of the column.
`DoubleProperty`	`prefWidthProperty()` The preferred width for the column.
`void`	`setFillWidth(boolean value)` Sets the value of the property fillWidth.
`void`	`setHalignment(HPos value)` Sets the value of the property halignment.
`void`	`setHgrow(Priority value)` Sets the value of the property hgrow.
`void`	`setMaxWidth(double value)` Sets the value of the property maxWidth.
`void`	`setMinWidth(double value)` Sets the value of the property minWidth.
`void`	`setPercentWidth(double value)` Sets the value of the property percentWidth.
`void`	`setPrefWidth(double value)` Sets the value of the property prefWidth.
`java.lang.String`	`toString()` Returns a string representation of this `ColumnConstraints` object.

Methods inherited from class javafx.scene.layout.ConstraintsBase
add, remove, requestLayout

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

- Property Detail
  - minWidth
```
public final DoubleProperty minWidthProperty
```
    The minimum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the minimum width will be computed to be the largest minimum width of the column's content.
    
    See Also:
    
    getMinWidth(), setMinWidth(double)
  - prefWidth
```
public final DoubleProperty prefWidthProperty
```
    The preferred width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the preferred width will be computed to be the largest preferred width of the column's content.
    
    See Also:
    
    getPrefWidth(), setPrefWidth(double)
  - maxWidth
```
public final DoubleProperty maxWidthProperty
```
    The maximum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the maximum width will be computed to be the smallest maximum width of the column's content.
    
    See Also:
    
    getMaxWidth(), setMaxWidth(double)
  - percentWidth
```
public final DoubleProperty percentWidthProperty
```
    The width percentage of the column. If set to a value greater than 0, the column will be resized to this percentage of the gridpane's available width and the other size constraints (minWidth, prefWidth, maxWidth, hgrow) will be ignored. The default value is -1, which means the percentage will be ignored.
    
    See Also:
    
    getPercentWidth(), setPercentWidth(double)
  - hgrow
```
public final <any> hgrowProperty
```
    The horizontal grow priority for the column. If set, the gridpane will use this priority to determine whether the column should be given any additional width if the gridpane is resized larger than its preferred width. This property is ignored if percentWidth is set.
    This default value is null, which means that the column's grow priority will be derived from largest grow priority set on a content node.
    
    See Also:
    
    getHgrow(), setHgrow(Priority)
  - halignment
```
public final <any> halignmentProperty
```
    The horizontal alignment for the column. If set, will be the default horizontal alignment for nodes contained within the column.
    The default value is null, which means the column alignment will fall back to the default halignment set on the gridpane.
    
    See Also:
    
    getHalignment(), setHalignment(HPos)
  - fillWidth
```
public final BooleanProperty fillWidthProperty
```
    The horizontal fill policy for the column. The gridpane will use this property to determine whether nodes contained within the column should be expanded to fill the column or kept to their preferred widths.
    The default value is true.
    
    See Also:
    
    isFillWidth(), setFillWidth(boolean)
- Field Detail
  - minWidth
```
private DoubleProperty minWidth
```
    The minimum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the minimum width will be computed to be the largest minimum width of the column's content.
  - prefWidth
```
private DoubleProperty prefWidth
```
    The preferred width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the preferred width will be computed to be the largest preferred width of the column's content.
  - maxWidth
```
private DoubleProperty maxWidth
```
    The maximum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the maximum width will be computed to be the smallest maximum width of the column's content.
  - percentWidth
```
private DoubleProperty percentWidth
```
    The width percentage of the column. If set to a value greater than 0, the column will be resized to this percentage of the gridpane's available width and the other size constraints (minWidth, prefWidth, maxWidth, hgrow) will be ignored. The default value is -1, which means the percentage will be ignored.
  - hgrow
```
private <any> hgrow
```
    The horizontal grow priority for the column. If set, the gridpane will use this priority to determine whether the column should be given any additional width if the gridpane is resized larger than its preferred width. This property is ignored if percentWidth is set.
    This default value is null, which means that the column's grow priority will be derived from largest grow priority set on a content node.
  - halignment
```
private <any> halignment
```
    The horizontal alignment for the column. If set, will be the default horizontal alignment for nodes contained within the column.
    The default value is null, which means the column alignment will fall back to the default halignment set on the gridpane.
  - fillWidth
```
private BooleanProperty fillWidth
```
    The horizontal fill policy for the column. The gridpane will use this property to determine whether nodes contained within the column should be expanded to fill the column or kept to their preferred widths.
    The default value is true.
- Constructor Detail
  - ColumnConstraints
```
public ColumnConstraints()
```
    Create a column constraint object with no properties set.
  - ColumnConstraints
```
public ColumnConstraints(double width)
```
    Creates a column constraint object with a fixed width. This is a convenience for setting the preferred width constraint to the fixed value and the minWidth and maxWidth constraints to the USE_PREF_SIZE flag to ensure the column is always that width.
    
    Parameters:
    
    width - the width of the column
  - ColumnConstraints
```
public ColumnConstraints(double minWidth,
                         double prefWidth,
                         double maxWidth)
```
    Creates a column constraint object with a fixed size range. This is a convenience for setting the minimum, preferred, and maximum width constraints.
    
    Parameters:
    
    minWidth - the minimum width
    
    prefWidth - the preferred width
    
    maxWidth - the maximum width
  - ColumnConstraints
```
public ColumnConstraints(double minWidth,
                         double prefWidth,
                         double maxWidth,
                         Priority hgrow,
                         HPos halignment,
                         boolean fillWidth)
```
    Creates a column constraint object with a fixed size range, horizontal grow priority, horizonal alignment, and horizontal fill behavior.
    
    Parameters:
    
    minWidth - the minimum width
    
    prefWidth - the preferred width
    
    maxWidth - the maximum width
    
    hgrow - the horizontal grow priority
    
    halignment - the horizonal alignment
    
    fillWidth - the horizontal fill behavior
- Method Detail
  - setMinWidth
```
public final void setMinWidth(double value)
```
    Sets the value of the property minWidth.
  - getMinWidth
```
public final double getMinWidth()
```
    Gets the value of the property minWidth.
  - minWidthProperty
```
public final DoubleProperty minWidthProperty()
```
    The minimum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the minimum width will be computed to be the largest minimum width of the column's content.
    
    See Also:
    
    getMinWidth(), setMinWidth(double)
  - setPrefWidth
```
public final void setPrefWidth(double value)
```
    Sets the value of the property prefWidth.
  - getPrefWidth
```
public final double getPrefWidth()
```
    Gets the value of the property prefWidth.
  - prefWidthProperty
```
public final DoubleProperty prefWidthProperty()
```
    The preferred width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the preferred width will be computed to be the largest preferred width of the column's content.
    
    See Also:
    
    getPrefWidth(), setPrefWidth(double)
  - setMaxWidth
```
public final void setMaxWidth(double value)
```
    Sets the value of the property maxWidth.
  - getMaxWidth
```
public final double getMaxWidth()
```
    Gets the value of the property maxWidth.
  - maxWidthProperty
```
public final DoubleProperty maxWidthProperty()
```
    The maximum width for the column. This property is ignored if percentWidth is set.
    The default value is USE_COMPUTED_SIZE, which means the maximum width will be computed to be the smallest maximum width of the column's content.
    
    See Also:
    
    getMaxWidth(), setMaxWidth(double)
  - setPercentWidth
```
public final void setPercentWidth(double value)
```
    Sets the value of the property percentWidth.
  - getPercentWidth
```
public final double getPercentWidth()
```
    Gets the value of the property percentWidth.
  - percentWidthProperty
```
public final DoubleProperty percentWidthProperty()
```
    The width percentage of the column. If set to a value greater than 0, the column will be resized to this percentage of the gridpane's available width and the other size constraints (minWidth, prefWidth, maxWidth, hgrow) will be ignored. The default value is -1, which means the percentage will be ignored.
    
    See Also:
    
    getPercentWidth(), setPercentWidth(double)
  - setHgrow
```
public final void setHgrow(Priority value)
```
    Sets the value of the property hgrow.
  - getHgrow
```
public final Priority getHgrow()
```
    Gets the value of the property hgrow.
  - hgrowProperty
```
public final <any> hgrowProperty()
```
    The horizontal grow priority for the column. If set, the gridpane will use this priority to determine whether the column should be given any additional width if the gridpane is resized larger than its preferred width. This property is ignored if percentWidth is set.
    This default value is null, which means that the column's grow priority will be derived from largest grow priority set on a content node.
    
    See Also:
    
    getHgrow(), setHgrow(Priority)
  - setHalignment
```
public final void setHalignment(HPos value)
```
    Sets the value of the property halignment.
  - getHalignment
```
public final HPos getHalignment()
```
    Gets the value of the property halignment.
  - halignmentProperty
```
public final <any> halignmentProperty()
```
    The horizontal alignment for the column. If set, will be the default horizontal alignment for nodes contained within the column.
    The default value is null, which means the column alignment will fall back to the default halignment set on the gridpane.
    
    See Also:
    
    getHalignment(), setHalignment(HPos)
  - setFillWidth
```
public final void setFillWidth(boolean value)
```
    Sets the value of the property fillWidth.
  - isFillWidth
```
public final boolean isFillWidth()
```
    Gets the value of the property fillWidth.
  - fillWidthProperty
```
public final BooleanProperty fillWidthProperty()
```
    The horizontal fill policy for the column. The gridpane will use this property to determine whether nodes contained within the column should be expanded to fill the column or kept to their preferred widths.
    The default value is true.
    
    See Also:
    
    isFillWidth(), setFillWidth(boolean)
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this ColumnConstraints object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this ColumnConstraints object.

Class ColumnConstraints

Property Summary

Field Summary

Fields inherited from class javafx.scene.layout.ConstraintsBase

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.layout.ConstraintsBase

Methods inherited from class java.lang.Object

Property Detail

minWidth

prefWidth

maxWidth

percentWidth

hgrow

halignment

fillWidth

Field Detail

minWidth

prefWidth

maxWidth

percentWidth

hgrow

halignment

fillWidth

Constructor Detail

ColumnConstraints

ColumnConstraints

ColumnConstraints

ColumnConstraints

Method Detail

setMinWidth

getMinWidth

minWidthProperty

setPrefWidth

getPrefWidth

prefWidthProperty

setMaxWidth

getMaxWidth

maxWidthProperty

setPercentWidth

getPercentWidth

percentWidthProperty

setHgrow

getHgrow

hgrowProperty

setHalignment

getHalignment

halignmentProperty

setFillWidth

isFillWidth

fillWidthProperty

toString