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"));
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.
| 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);
VBox does not clip its content by default, so it is possible that childrens' bounds may extend outside its own bounds if a child's min size prevents it from being fit within the vbox.
| 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);
| Type | Property and Description |
|---|---|
ObjectProperty<Pos> |
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.
|
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthneedsLayoutaccessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visibleUSE_COMPUTED_SIZE, USE_PREF_SIZEBASELINE_OFFSET_SAME_AS_HEIGHT| 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 |
|---|---|
ObjectProperty<Pos> |
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.
|
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.
|
static List<CssMetaData<? extends Styleable,?>> |
getClassCssMetaData() |
Orientation |
getContentBias()
Returns the orientation of a node's resizing bias for layout purposes.
|
List<CssMetaData<? extends Styleable,?>> |
getCssMetaData()
This method should delegate to
Node.getClassCssMetaData() so that
a Node's CssMetaData can be accessed without the need for reflection. |
static Insets |
getMargin(Node child)
Returns the child's margin property if set.
|
double |
getSpacing()
Gets the value of the property spacing.
|
static Priority |
getVgrow(Node child)
Returns the child's vgrow property if set.
|
boolean |
isFillWidth()
Gets the value of the property fillWidth.
|
protected void |
layoutChildren()
Invoked during the layout pass to layout the children in this
Parent. |
void |
requestLayout()
Requests a layout pass to be performed before the next scene is
rendered.
|
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.
|
getChildrenbackgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, 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, 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, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthPropertygetBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBoundsaccessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visiblePropertypublic final DoubleProperty spacingProperty
getSpacing(),
setSpacing(double)public final ObjectProperty<Pos> alignmentProperty
getAlignment(),
setAlignment(Pos)public final BooleanProperty fillWidthProperty
alignment
hpos value.isFillWidth(),
setFillWidth(boolean)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 ObjectProperty<Pos> alignmentProperty()
getAlignment(),
setAlignment(Pos)public final void setAlignment(Pos value)
public final Pos getAlignment()
public final BooleanProperty fillWidthProperty()
alignment
hpos value.isFillWidth(),
setFillWidth(boolean)public final void setFillWidth(boolean value)
alignment
hpos value.public final boolean isFillWidth()
alignment
hpos value.public Orientation getContentBias()
NodeResizable subclasses should override this method to return an appropriate value.
getContentBias in class NodeNode.isResizable(),
Node.minWidth(double),
Node.minHeight(double),
Node.prefWidth(double),
Node.prefHeight(double),
Node.maxWidth(double),
Node.maxHeight(double)protected double computeMinWidth(double height)
RegioncomputeMinWidth in class Regionheight - the height that should be used if min width depends
on itprotected double computeMinHeight(double width)
RegioncomputeMinHeight in class Regionwidth - the width that should be used if min height depends
on itprotected double computePrefWidth(double height)
RegioncomputePrefWidth in class Regionheight - the height that should be used if preferred width depends
on itprotected double computePrefHeight(double width)
RegioncomputePrefHeight in class Regionwidth - the width that should be used if preferred height depends
on itpublic void requestLayout()
ParentIf 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.
requestLayout in class Parentprotected void layoutChildren()
ParentParent. 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.
layoutChildren in class Parentpublic static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()
public List<CssMetaData<? extends Styleable,?>> getCssMetaData()
Node.getClassCssMetaData() so that
a Node's CssMetaData can be accessed without the need for reflection.getCssMetaData in interface StyleablegetCssMetaData in class RegionSubmit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.