JavaFX 24 · javafx.scene.layout.RowConstraints · APIdia, the JavaDoc alternative

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

For example, to create a GridPane with 10 rows 50 pixels tall:

GridPane gridpane = new GridPane();
    for (int i = 0; i < 10; i++) {
        RowConstraints row = new RowConstraints(50);
        gridpane.getRowConstraints().add(row);
    }

Or, to create a GridPane where rows take 25%, 50%, 25% of its height:

GridPane gridpane = new GridPane();
    RowConstraints row1 = new RowConstraints();
    row1.setPercentHeight(25);
    RowConstraints row2 = new RowConstraints();
    row2.setPercentHeight(50);
    RowConstraints row3 = new RowConstraints();
    row3.setPercentHeight(25);
    gridpane.getRowConstraints().addAll(row1,row2,row3);

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

Field Summary

Modifier and Type	Field and Description
private BooleanProperty	fillHeight The vertical fill policy for the row.
private DoubleProperty	maxHeight The maximum height for the row.
private DoubleProperty	minHeight The minimum height for the row.
private DoubleProperty	percentHeight The height percentage of the row.
private DoubleProperty	prefHeight The preferred height for the row.
private ObjectProperty<VPos>	valignment The vertical alignment for the row.
private ObjectProperty<Priority>	vgrow The vertical grow priority for the row.

Inherited from javafx.scene.layout.ConstraintsBase:: CONSTRAIN_TO_PREF

Constructor Summary

Access	Constructor and Description
public	RowConstraints() Creates a row constraints object with no properties set.
public	RowConstraints(double the height of the row height) Creates a row constraint object with a fixed height.
public	RowConstraints(double the minimum height minHeight, double the preferred height prefHeight, double the maximum height maxHeight) Creates a row constraint object with a fixed size range.
public	RowConstraints(double the minimum height minHeight, double the preferred height prefHeight, double the maximum height maxHeight, Priority the vertical grow priority vgrow, VPos the vertical alignment valignment, boolean the vertical fill behavior fillHeight) Creates a row constraint object with a fixed size range, vertical grow priority, vertical alignment, and vertical fill behavior.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	fillHeightProperty()
public final double	getMaxHeight()
public final double	getMinHeight()
public final double	getPercentHeight()
public final double	getPrefHeight()
public final VPos	getValignment()
public final Priority	getVgrow()
public final boolean	isFillHeight()
public final DoubleProperty	maxHeightProperty()
public final DoubleProperty	minHeightProperty()
public final DoubleProperty	percentHeightProperty()
public final DoubleProperty	prefHeightProperty()
public final void	setFillHeight(boolean value)
public final void	setMaxHeight(double value)
public final void	setMinHeight(double value)
public final void	setPercentHeight(double value)
public final void	setPrefHeight(double value)
public final void	setValignment(VPos value)
public final void	setVgrow(Priority value)
public String	Returns: a string representation of this `RowConstraints` object. toString() Overrides java.lang.Object.toString. Returns a string representation of this `RowConstraints` object.
public final ObjectProperty<VPos>	valignmentProperty()
public final ObjectProperty<Priority>	vgrowProperty()

Inherited from javafx.scene.layout.ConstraintsBase:: add remove requestLayout

Field Detail

fillHeight	back to summary
private BooleanProperty fillHeight The vertical fill policy for the row. The gridpane will use this property to determine whether nodes contained within the row should be expanded to fill the row's height or kept to their preferred heights. The default value is true.

fillHeight

back to summary

private BooleanProperty fillHeight

The vertical fill policy for the row. The gridpane will use this property to determine whether nodes contained within the row should be expanded to fill the row's height or kept to their preferred heights.

The default value is true.

maxHeight	back to summary
private DoubleProperty maxHeight The maximum height for the row. This property is ignored if percentHeight is set. The default value is USE_COMPUTED_SIZE, which means the maximum height will be computed to be the smallest maximum height of the row's content.

maxHeight

back to summary

private DoubleProperty maxHeight

The maximum height for the row. This property is ignored if percentHeight is set.

The default value is USE_COMPUTED_SIZE, which means the maximum height will be computed to be the smallest maximum height of the row's content.

minHeight	back to summary
private DoubleProperty minHeight The minimum height for the row. This property is ignored if percentHeight is set. The default value is USE_COMPUTED_SIZE, which means the minimum height will be computed to be the largest minimum height of the row's content.

minHeight

back to summary

private DoubleProperty minHeight

The minimum height for the row. This property is ignored if percentHeight is set.

The default value is USE_COMPUTED_SIZE, which means the minimum height will be computed to be the largest minimum height of the row's content.

percentHeight	back to summary
private DoubleProperty percentHeight The height percentage of the row. If set to a value greater than 0, the row will be resized to that percentage of the available gridpane height and the other size constraints (minHeight, prefHeight, maxHeight, vgrow) will be ignored. The default value is -1, which means the percentage will be ignored.

prefHeight	back to summary
private DoubleProperty prefHeight The preferred height for the row. This property is ignored if percentHeight is set. The default value is USE_COMPUTED_SIZE, which means the preferred height will be computed to be the largest preferred height of the row's content.

prefHeight

back to summary

private DoubleProperty prefHeight

The preferred height for the row. This property is ignored if percentHeight is set.

The default value is USE_COMPUTED_SIZE, which means the preferred height will be computed to be the largest preferred height of the row's content.

valignment	back to summary
private ObjectProperty<VPos> valignment The vertical alignment for the row. If set, will be the default vertical alignment for nodes contained within the row. If this property is set to VPos.BASELINE, then the fillHeight property will be ignored and nodes will always be resized to their preferred heights.

vgrow	back to summary
private ObjectProperty<Priority> vgrow The vertical grow priority for the row. If set, the gridpane will use this priority to determine whether the row should be given any additional height if the gridpane is resized larger than its preferred height. This property is ignored if percentHeight is set. This default value is null, which means that the row's grow priority will be derived from largest grow priority set on a content node.

vgrow

back to summary

private ObjectProperty<Priority> vgrow

The vertical grow priority for the row. If set, the gridpane will use this priority to determine whether the row should be given any additional height if the gridpane is resized larger than its preferred height. This property is ignored if percentHeight is set.

This default value is null, which means that the row's grow priority will be derived from largest grow priority set on a content node.

Constructor Detail

RowConstraints	back to summary
public RowConstraints() Creates a row constraints object with no properties set.

RowConstraints	back to summary
public RowConstraints(double height) Creates a row constraint object with a fixed height. This is a convenience for setting the preferred height constraint to the fixed value and the minHeight and maxHeight constraints to the USE_PREF_SIZE flag to ensure the row is always that height. Parameters height:double the height of the row

RowConstraints

back to summary

public RowConstraints(double height)

Creates a row constraint object with a fixed height. This is a convenience for setting the preferred height constraint to the fixed value and the minHeight and maxHeight constraints to the USE_PREF_SIZE flag to ensure the row is always that height.

Parameters

height:double: the height of the row

RowConstraints	back to summary
public RowConstraints(double minHeight, double prefHeight, double maxHeight) Creates a row constraint object with a fixed size range. This is a convenience for setting the minimum, preferred, and maximum height constraints. Parameters minHeight:double the minimum height prefHeight:double the preferred height maxHeight:double the maximum height

RowConstraints

back to summary

public RowConstraints(double minHeight, double prefHeight, double maxHeight)

Creates a row constraint object with a fixed size range. This is a convenience for setting the minimum, preferred, and maximum height constraints.

Parameters

minHeight:double: the minimum height
prefHeight:double: the preferred height
maxHeight:double: the maximum height

RowConstraints	back to summary
public RowConstraints(double minHeight, double prefHeight, double maxHeight, Priority vgrow, VPos valignment, boolean fillHeight) Creates a row constraint object with a fixed size range, vertical grow priority, vertical alignment, and vertical fill behavior. Parameters minHeight:double the minimum height prefHeight:double the preferred height maxHeight:double the maximum height vgrow:Priority the vertical grow priority valignment:VPos the vertical alignment fillHeight:boolean the vertical fill behavior

RowConstraints

back to summary

public RowConstraints(double minHeight, double prefHeight, double maxHeight, Priority vgrow, VPos valignment, boolean fillHeight)

Creates a row constraint object with a fixed size range, vertical grow priority, vertical alignment, and vertical fill behavior.

Parameters

minHeight:double: the minimum height
prefHeight:double: the preferred height
maxHeight:double: the maximum height
vgrow:Priority: the vertical grow priority
valignment:VPos: the vertical alignment
fillHeight:boolean: the vertical fill behavior

Method Detail

fillHeightProperty	back to summary
public final BooleanProperty fillHeightProperty()

getMaxHeight	back to summary
public final double getMaxHeight()

getMinHeight	back to summary
public final double getMinHeight()

getPercentHeight	back to summary
public final double getPercentHeight()

getPrefHeight	back to summary
public final double getPrefHeight()

getValignment	back to summary
public final VPos getValignment()

getVgrow	back to summary
public final Priority getVgrow()

isFillHeight	back to summary
public final boolean isFillHeight()

maxHeightProperty	back to summary
public final DoubleProperty maxHeightProperty()

minHeightProperty	back to summary
public final DoubleProperty minHeightProperty()

percentHeightProperty	back to summary
public final DoubleProperty percentHeightProperty()

prefHeightProperty	back to summary
public final DoubleProperty prefHeightProperty()

setFillHeight	back to summary
public final void setFillHeight(boolean value)

setMaxHeight	back to summary
public final void setMaxHeight(double value)

setMinHeight	back to summary
public final void setMinHeight(double value)

setPercentHeight	back to summary
public final void setPercentHeight(double value)

setPrefHeight	back to summary
public final void setPrefHeight(double value)

setValignment	back to summary
public final void setValignment(VPos value)

setVgrow	back to summary
public final void setVgrow(Priority value)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this `RowConstraints` object. Returns:String a string representation of this `RowConstraints` object. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this RowConstraints object.

Returns:String

a string representation of this RowConstraints object.

Annotations

@Override

valignmentProperty	back to summary
public final ObjectProperty<VPos> valignmentProperty()

vgrowProperty	back to summary
public final ObjectProperty<Priority> vgrowProperty()

public Class RowConstraints

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail