public class VBox extends Pane
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.
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.
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.
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.
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.Type | Property and Description |
---|---|
<any> |
alignment
The overall alignment of children within the vbox's width and height.
|
BooleanProperty |
fillWidth
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. |
DoubleProperty |
spacing
The amount of vertical space between each child in the vbox.
|
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty
Modifier and Type | Class and Description |
---|---|
private static class |
VBox.StyleableProperties
*
Stylesheet Handling *
*
|
Modifier and Type | Field and Description |
---|---|
private <any> |
alignment |
private Orientation |
bias |
private boolean |
biasDirty |
private BooleanProperty |
fillWidth |
private static java.lang.String |
MARGIN_CONSTRAINT
BEGIN static methods
|
private static <any> |
marginAccessor |
private DoubleProperty |
spacing |
private double[][] |
tempArray |
private static java.lang.String |
VGROW_CONSTRAINT |
TEMP_VEC2D, USE_COMPUTED_SIZE, USE_PREF_SIZE
Constructor and Description |
---|
VBox()
Creates a VBox layout with spacing = 0 and alignment at TOP_LEFT.
|
VBox(double spacing)
Creates a VBox layout with the specified spacing between children.
|
VBox(double spacing,
Node... children)
Creates an VBox layout with the specified spacing between children.
|
VBox(Node... children)
Creates an VBox layout with spacing = 0.
|
Modifier and Type | Method and Description |
---|---|
private double |
adjustAreaHeights(java.util.List<Node> managed,
double[][] areaHeights,
double height,
double width) |
<any> |
alignmentProperty()
The overall alignment of children within the vbox's width and height.
|
static void |
clearConstraints(Node child)
Removes all vbox constraints from the child node.
|
private double |
computeContentHeight(java.util.List<Node> managedChildren,
double width,
boolean minimum) |
protected double |
computeMinHeight(double width)
Computes the minimum height of this region.
|
protected double |
computeMinWidth(double height)
Computes the minimum width of this region.
|
protected double |
computePrefHeight(double width)
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 height)
Computes the preferred width of this region for the given height.
|
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. |
Pos |
getAlignment()
Gets the value of the property alignment.
|
private Pos |
getAlignmentInternal() |
private double[][] |
getAreaHeights(java.util.List<Node> managed,
double width,
boolean minimum) |
static java.util.List<<any>> |
getClassCssMetaData() |
Orientation |
getContentBias() |
java.util.List<<any>> |
getCssMetaData() |
static Insets |
getMargin(Node child)
Returns the child's margin property if set.
|
double |
getSpacing()
Gets the value of the property spacing.
|
private double[][] |
getTempArray(int size) |
static Priority |
getVgrow(Node child)
Returns the child's vgrow property if set.
|
private double |
growOrShrinkAreaHeights(java.util.List<Node> managed,
double[][] areaHeights,
Priority priority,
double extraHeight,
double width) |
boolean |
isFillWidth()
Gets the value of the property fillWidth.
|
protected void |
layoutChildren() |
void |
requestLayout() |
void |
setAlignment(Pos value)
Sets the value of the property alignment.
|
void |
setFillWidth(boolean value)
Sets the value of the property fillWidth.
|
static void |
setMargin(Node child,
Insets value)
Sets the margin for the child when contained by a vbox.
|
void |
setSpacing(double value)
Sets the value of the property spacing.
|
static void |
setVgrow(Node child,
Priority value)
Sets the vertical grow priority for the child when contained by an vbox.
|
DoubleProperty |
spacingProperty()
The amount of vertical space between each child in the vbox.
|
private static double |
sum(double[] array,
int size) |
getChildren, getConstraint, setConstraint
addImageListener, adjustHeightByMargin, adjustWidthByMargin, backgroundProperty, borderProperty, boundedNodeSizeWithBias, boundedSize, cacheShapeProperty, centerShapeProperty, computeChildMaxAreaHeight, computeChildMaxAreaWidth, computeChildMinAreaHeight, computeChildMinAreaHeight, computeChildMinAreaWidth, computeChildMinAreaWidth, computeChildPrefAreaHeight, computeChildPrefAreaHeight, computeChildPrefAreaWidth, computeChildPrefAreaWidth, computeMaxHeight, computeMaxMinAreaHeight, computeMaxMinAreaHeight, computeMaxMinAreaHeight, computeMaxMinAreaWidth, computeMaxMinAreaWidth, computeMaxMinAreaWidth, computeMaxPrefAreaHeight, computeMaxPrefAreaHeight, computeMaxPrefAreaHeight, computeMaxPrefAreaWidth, computeMaxPrefAreaWidth, computeMaxPrefAreaWidth, computeMaxWidth, computeXOffset, computeYOffset, createDoubleArray, getAreaBaselineOffset, getAreaBaselineOffset, getAreaBaselineOffset, getAreaBaselineOffset, getAreaBaselineOffset, getAreaBaselineOffset, getBackground, getBorder, getHeight, getInsets, getMaxBaselineComplement, getMaxHeight, getMaxWidth, getMinBaselineComplement, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefBaselineComplement, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, removeImageListener, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPortionX, snapPortionY, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
public final DoubleProperty spacingProperty
getSpacing()
,
setSpacing(double)
public final <any> alignmentProperty
getAlignment()
,
setAlignment(Pos)
public final BooleanProperty fillWidthProperty
alignment
hpos value.isFillWidth()
,
setFillWidth(boolean)
private boolean biasDirty
private Orientation bias
private double[][] tempArray
private static final java.lang.String MARGIN_CONSTRAINT
private static final java.lang.String VGROW_CONSTRAINT
private static final <any> marginAccessor
private DoubleProperty spacing
private <any> alignment
private BooleanProperty fillWidth
public VBox()
public VBox(double spacing)
spacing
- the amount of vertical space between each childpublic VBox(Node... children)
children
- The initial set of children for this pane.public VBox(double spacing, Node... children)
spacing
- the amount of horizontal space between each childchildren
- The initial set of children for this pane.public static void setVgrow(Node child, Priority value)
child
- the child of a vboxvalue
- the horizontal grow priority for the childpublic static Priority getVgrow(Node child)
child
- the child node of a vboxpublic static void setMargin(Node child, Insets value)
child
- the child mode of a vboxvalue
- the margin of space around the childpublic static Insets getMargin(Node child)
child
- the child node of a vboxpublic static void clearConstraints(Node child)
child
- the child nodepublic final DoubleProperty spacingProperty()
getSpacing()
,
setSpacing(double)
public final void setSpacing(double value)
public final double getSpacing()
public final <any> alignmentProperty()
getAlignment()
,
setAlignment(Pos)
public final void setAlignment(Pos value)
public final Pos getAlignment()
private Pos getAlignmentInternal()
public final BooleanProperty fillWidthProperty()
alignment
hpos value.isFillWidth()
,
setFillWidth(boolean)
public final void setFillWidth(boolean value)
public final boolean isFillWidth()
public Orientation getContentBias()
protected double computeMinWidth(double height)
Region
computeMinWidth
in class Region
protected double computeMinHeight(double width)
Region
computeMinHeight
in class Region
protected double computePrefWidth(double height)
Region
computePrefWidth
in class Region
protected double computePrefHeight(double width)
Region
computePrefHeight
in class Region
private double[][] getAreaHeights(java.util.List<Node> managed, double width, boolean minimum)
private double adjustAreaHeights(java.util.List<Node> managed, double[][] areaHeights, double height, double width)
private double growOrShrinkAreaHeights(java.util.List<Node> managed, double[][] areaHeights, Priority priority, double extraHeight, double width)
private double computeContentHeight(java.util.List<Node> managedChildren, double width, boolean minimum)
private static double sum(double[] array, int size)
public void requestLayout()
protected void layoutChildren()
private double[][] getTempArray(int size)
public static java.util.List<<any>> getClassCssMetaData()
public java.util.List<<any>> getCssMetaData()
getCssMetaData
in class Region