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

VBox lays out its children in a single vertical column. If the vbox has a border and/or padding set, then the contents will be laid out within those insets.

VBox example:

VBox vbox = new VBox(8); // spacing = 8
    vbox.getChildren().addAll(new Button("Cut"), new Button("Copy"), new Button("Paste"));

VBox will resize children (if resizable) to their preferred heights and uses its fillWidth property to determine whether to resize their widths to fill its own width or keep their widths to their preferred (fillWidth defaults to true). The alignment of the content is controlled by the alignment property, which defaults to Pos.TOP_LEFT.

If a vbox is resized larger than its preferred height, by default it will keep children to their preferred heights, leaving the extra space unused. If an application wishes to have one or more children be allocated that extra space it may optionally set a vgrow constraint on the child. See "Optional Layout Constraints" for details.

VBox lays out each managed child regardless of the child's visible property value; unmanaged children are ignored.

Resizable Range

A vbox's parent will resize the vbox within the vbox's resizable range during layout. By default the vbox computes this range based on its content as outlined in the table below.

VBox Resize Table
	width	height
minimum	left/right insets plus the largest of the children's min widths.	top/bottom insets plus the sum of each child's min height plus spacing between each child.
preferred	left/right insets plus the largest of the children's pref widths.	top/bottom insets plus the sum of each child's pref height plus spacing between each child.
maximum	Double.MAX_VALUE	Double.MAX_VALUE

A vbox's unbounded maximum width and height are an indication to the parent that it may be resized beyond its preferred size to fill whatever space is assigned to it.

VBox provides properties for setting the size range directly. These properties default to the sentinel value USE_COMPUTED_SIZE, however the application may set them to other values as needed:


    vbox.setPrefWidth(400);

Applications may restore the computed values by setting these properties back to USE_COMPUTED_SIZE.

VBox does not clip its content by default, so it is possible that children's bounds may extend outside its own bounds if a child's min size prevents it from being fit within the vbox.

Optional Layout Constraints

An application may set constraints on individual children to customize VBox's layout. For each constraint, VBox provides a static method for setting it on the child.

VBox Constraint Table
Constraint	Type	Description
vgrow	javafx.scene.layout.Priority	The vertical grow priority for the child.
margin	javafx.geometry.Insets	Margin space around the outside of the child.

For example, if a vbox needs the ListView to be allocated all extra space:


    VBox vbox = new VBox();
    ListView list = new ListView();
    VBox.setVgrow(list, Priority.ALWAYS);
    vbox.getChildren().addAll(new Label("Names:"), list);

If more than one child has the same grow priority set, then the vbox will allocate equal amounts of space to each. VBox will only grow a child up to its maximum height, so if the child has a max height other than Double.MAX_VALUE, the application may need to override the max to allow it to grow.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	VBox.StyleableProperties

Field Summary

Modifier and Type	Field and Description
private ObjectProperty<Pos>	alignment
private Orientation	bias
private boolean	biasDirty
private BooleanProperty	fillWidth
private static final String	MARGIN_CONSTRAINT
private static final Callback<Node, Insets>	marginAccessor
private DoubleProperty	spacing
private double[][]	tempArray
private static final String	VGROW_CONSTRAINT

Constructor Summary

Access	Constructor and Description
public	VBox() Creates a `VBox` layout with `spacing = 0` and alignment at `TOP_LEFT`.
public	VBox(double the amount of vertical space between each child spacing) Creates a `VBox` layout with the specified spacing between children.
public	VBox(Node... the initial set of children for this pane children) Creates a `VBox` layout with `spacing = 0`.
public	VBox(double the amount of vertical space between each child spacing, Node... the initial set of children for this pane children) Creates a `VBox` layout with the specified spacing between children.

Method Summary

Modifier and Type	Method and Description
private double	adjustAreaHeights(List<Node> managed, double[][] areaHeights, double height, double width)
public final ObjectProperty<Pos>	Returns: the overall alignment of children within the vbox's width and height alignmentProperty() The overall alignment of children within the vbox's width and height.
public static void	clearConstraints(Node the child node child) Removes all vbox constraints from the child node.
private double	computeContentHeight(List<Node> managedChildren, double width, boolean minimum)
protected double	computeMinHeight(double the width that should be used if min height depends on it width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computeMinWidth(double the height that should be used if min width depends on it height) Overrides javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region.
protected double	computePrefHeight(double the width that should be used if preferred height depends on it width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double the height that should be used if preferred width depends on it height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
public final BooleanProperty	Returns: true if resizable children will be resized to fill the full width of the vbox fillWidthProperty() Whether or not resizable children will be resized to fill the full width of the vbox or be resized to their preferred width and aligned according to the `alignment` hpos value.
public final Pos	getAlignment()
private Pos	getAlignmentInternal()
private double[][]	getAreaHeights(List<Node> managed, double width, boolean minimum)
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public Orientation	Returns: null unless one of its children has a content bias. getContentBias() Overrides javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public static Insets	Returns: the margin for the child or null if no margin was set getMargin(Node the child node of a vbox child) Returns the child's margin property if set.
public final double	getSpacing()
private double[][]	getTempArray(int size)
public static Priority	Returns: the vertical grow priority for the child or null if no priority was set getVgrow(Node the child node of a vbox child) Returns the child's vgrow property if set.
private double	growOrShrinkAreaHeights(List<Node> managed, double[][] areaHeights, Priority priority, double extraHeight, double width)
public final boolean	isFillWidth()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public void	requestLayout() Overrides javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered.
public final void	setAlignment(Pos value)
public final void	setFillWidth(boolean value)
public static void	setMargin(Node the child mode of a vbox child, Insets the margin of space around the child value) Sets the margin for the child when contained by a vbox.
public final void	setSpacing(double value)
public static void	setVgrow(Node the child of a vbox child, Priority the vertical grow priority for the child value) Sets the vertical grow priority for the child when contained by a vbox.
public final DoubleProperty	Returns: the amount of vertical space between each child in the vbox spacingProperty() The amount of vertical space between each child in the vbox.
private static double	sum(double[] array, int size)

Inherited from javafx.scene.layout.Pane:: getChildren getConstraint setConstraint

Field Detail

alignment	back to summary
private ObjectProperty<Pos> alignment

bias	back to summary
private Orientation bias

biasDirty	back to summary
private boolean biasDirty

fillWidth	back to summary
private BooleanProperty fillWidth

MARGIN_CONSTRAINT	back to summary
private static final String MARGIN_CONSTRAINT

marginAccessor	back to summary
private static final Callback<Node, Insets> marginAccessor

spacing	back to summary
private DoubleProperty spacing

tempArray	back to summary
private double[][] tempArray

VGROW_CONSTRAINT	back to summary
private static final String VGROW_CONSTRAINT

Constructor Detail

VBox	back to summary
public VBox() Creates a `VBox` layout with `spacing = 0` and alignment at `TOP_LEFT`.

VBox back to summary

VBox	back to summary
public VBox(double spacing) Creates a `VBox` layout with the specified spacing between children. Parameters spacing:double the amount of vertical space between each child

public VBox(double spacing)

Creates a VBox layout with the specified spacing between children.

Parameters

spacing:double: the amount of vertical space between each child

VBox back to summary

VBox	back to summary
public VBox(Node... children) Creates a `VBox` layout with `spacing = 0`. Parameters children:Node[] the initial set of children for this pane Since JavaFX 8.0

public VBox(Node... children)

Creates a VBox layout with spacing = 0.

Parameters

children:Node[]: the initial set of children for this pane

Since

JavaFX 8.0

VBox back to summary

VBox	back to summary
public VBox(double spacing, Node... children) Creates a `VBox` layout with the specified spacing between children. Parameters spacing:double the amount of vertical space between each child children:Node[] the initial set of children for this pane Since JavaFX 8.0

public VBox(double spacing, Node... children)

Creates a VBox layout with the specified spacing between children.

Parameters

spacing:double: the amount of vertical space between each child
children:Node[]: the initial set of children for this pane

Since

JavaFX 8.0

Method Detail

adjustAreaHeights	back to summary
private double adjustAreaHeights(List<Node> managed, double[][] areaHeights, double height, double width)

alignmentProperty	back to summary
public final ObjectProperty<Pos> alignmentProperty() The overall alignment of children within the vbox's width and height. Returns:ObjectProperty<Pos> the overall alignment of children within the vbox's width and height

alignmentProperty

back to summary

public final ObjectProperty<Pos> alignmentProperty()

The overall alignment of children within the vbox's width and height.

Returns:ObjectProperty<Pos>: the overall alignment of children within the vbox's width and height

clearConstraints	back to summary
public static void clearConstraints(Node child) Removes all vbox constraints from the child node. Parameters child:Node the child node

clearConstraints

back to summary

public static void clearConstraints(Node child)

Removes all vbox constraints from the child node.

Parameters

child:Node: the child node

computeContentHeight	back to summary
private double computeContentHeight(List<Node> managedChildren, double width, boolean minimum)

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Parameters width:double Doc from javafx.scene.Parent.computeMinHeight. the width that should be used if min height depends on it Returns:double the computed minimum height for this region Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Parameters

width:double

Doc from javafx.scene.Parent.computeMinHeight.

the width that should be used if min height depends on it

Returns:double

the computed minimum height for this region

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Doc from javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Parameters height:double Doc from javafx.scene.Parent.computeMinWidth. the height that should be used if min width depends on it Returns:double the computed minimum width of this region Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Parameters

height:double

Doc from javafx.scene.Parent.computeMinWidth.

the height that should be used if min width depends on it

Returns:double

the computed minimum width of this region

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Parameters width:double Doc from javafx.scene.Parent.computePrefHeight. the width that should be used if preferred height depends on it Returns:double the computed preferred height for this region Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Parameters

width:double

Doc from javafx.scene.Parent.computePrefHeight.

the width that should be used if preferred height depends on it

Returns:double

the computed preferred height for this region

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Parameters height:double Doc from javafx.scene.Parent.computePrefWidth. the height that should be used if preferred width depends on it Returns:double the computed preferred width for this region Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Parameters

height:double

Doc from javafx.scene.Parent.computePrefWidth.

the height that should be used if preferred width depends on it

Returns:double

the computed preferred width for this region

Annotations

@Override

fillWidthProperty back to summary

fillWidthProperty	back to summary
public final BooleanProperty fillWidthProperty() Whether or not resizable children will be resized to fill the full width of the vbox or be resized to their preferred width and aligned according to the `alignment` hpos value. Returns:BooleanProperty true if resizable children will be resized to fill the full width of the vbox

public final BooleanProperty fillWidthProperty()

Whether or not resizable children will be resized to fill the full width of the vbox or be resized to their preferred width and aligned according to the alignment hpos value.

Returns:BooleanProperty: true if resizable children will be resized to fill the full width of the vbox

getAlignment	back to summary
public final Pos getAlignment()

getAlignmentInternal	back to summary
private Pos getAlignmentInternal()

getAreaHeights	back to summary
private double[][] getAreaHeights(List<Node> managed, double width, boolean minimum)

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getContentBias	back to summary
public Orientation getContentBias() Overrides javafx.scene.Node.getContentBias. Doc from javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL. Resizable subclasses should override this method to return an appropriate value. Returns:Orientation null unless one of its children has a content bias. Annotations @Override

getContentBias

back to summary

public Orientation getContentBias()

Overrides javafx.scene.Node.getContentBias.

Doc from javafx.scene.Node.getContentBias.

Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL.

Resizable subclasses should override this method to return an appropriate value.

Returns:Orientation

null unless one of its children has a content bias.

Annotations

@Override

getCssMetaData back to summary

public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Returns:List<CssMetaData<? extends Styleable, ?>>

Doc from javafx.scene.Node.getCssMetaData.

The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.

Annotations

@Override

Since

JavaFX 8.0

getMargin	back to summary
public static Insets getMargin(Node child) Returns the child's margin property if set. Parameters child:Node the child node of a vbox Returns:Insets the margin for the child or null if no margin was set

getMargin

back to summary

public static Insets getMargin(Node child)

Returns the child's margin property if set.

Parameters

child:Node: the child node of a vbox

Returns:Insets

the margin for the child or null if no margin was set

getSpacing	back to summary
public final double getSpacing()

getTempArray	back to summary
private double[][] getTempArray(int size)

getVgrow	back to summary
public static Priority getVgrow(Node child) Returns the child's vgrow property if set. Parameters child:Node the child node of a vbox Returns:Priority the vertical grow priority for the child or null if no priority was set

getVgrow

back to summary

public static Priority getVgrow(Node child)

Returns the child's vgrow property if set.

Parameters

child:Node: the child node of a vbox

Returns:Priority

the vertical grow priority for the child or null if no priority was set

growOrShrinkAreaHeights	back to summary
private double growOrShrinkAreaHeights(List<Node> managed, double[][] areaHeights, Priority priority, double extraHeight, double width)

isFillWidth	back to summary
public final boolean isFillWidth()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Doc from javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning. Subclasses should override this function to layout content as needed. Annotations @Override

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

requestLayout	back to summary
public void requestLayout() Overrides javafx.scene.Parent.requestLayout. Doc from javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation. If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked. Annotations @Override

requestLayout

back to summary

public void requestLayout()

Overrides javafx.scene.Parent.requestLayout.

Doc from javafx.scene.Parent.requestLayout.

Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation.

If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked.

Annotations

@Override

setAlignment	back to summary
public final void setAlignment(Pos value)

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

setMargin	back to summary
public static void setMargin(Node child, Insets value) Sets the margin for the child when contained by a vbox. If set, the vbox will layout the child so that it has the margin space around it. Setting the value to null will remove the constraint. Parameters child:Node the child mode of a vbox value:Insets the margin of space around the child

setMargin

back to summary

public static void setMargin(Node child, Insets value)

Sets the margin for the child when contained by a vbox. If set, the vbox will layout the child so that it has the margin space around it. Setting the value to null will remove the constraint.

Parameters

child:Node: the child mode of a vbox
value:Insets: the margin of space around the child

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

setVgrow back to summary

setVgrow	back to summary
public static void setVgrow(Node child, Priority value) Sets the vertical grow priority for the child when contained by a vbox. If set, the vbox will use the priority value to allocate additional space if the vbox is resized larger than its preferred height. If multiple vbox children have the same vertical grow priority, then the extra space will be split evenly between them. If no vertical grow priority is set on a child, the vbox will never allocate any additional vertical space for that child. Setting the value to `null` will remove the constraint. Parameters child:Node the child of a vbox value:Priority the vertical grow priority for the child

public static void setVgrow(Node child, Priority value)

Sets the vertical grow priority for the child when contained by a vbox. If set, the vbox will use the priority value to allocate additional space if the vbox is resized larger than its preferred height. If multiple vbox children have the same vertical grow priority, then the extra space will be split evenly between them. If no vertical grow priority is set on a child, the vbox will never allocate any additional vertical space for that child.

Setting the value to null will remove the constraint.

Parameters

child:Node: the child of a vbox
value:Priority: the vertical grow priority for the child

spacingProperty	back to summary
public final DoubleProperty spacingProperty() The amount of vertical space between each child in the vbox. Returns:DoubleProperty the amount of vertical space between each child in the vbox

spacingProperty

back to summary

public final DoubleProperty spacingProperty()

The amount of vertical space between each child in the vbox.

Returns:DoubleProperty: the amount of vertical space between each child in the vbox

sum	back to summary
private static double sum(double[] array, int size)

Modifier and Type	Field and Description
private static final CssMetaData<VBox, Pos>	ALIGNMENT
private static final CssMetaData<VBox, Boolean>	FILL_WIDTH
private static final CssMetaData<VBox, Number>	SPACING
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public Class VBox

Resizable Range

Optional Layout Constraints

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class VBox.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail