public class HBox extends Pane
HBox example:
HBox hbox = new HBox(8); // spacing = 8
hbox.getChildren().addAll(new Label("Name:), new TextBox());
HBox will resize children (if resizable) to their preferred widths and uses its
fillHeight property to determine whether to resize their heights to
fill its own height or keep their heights to their preferred (fillHeight defaults to true).
The alignment of the content is controlled by the alignment property,
which defaults to Pos.TOP_LEFT.
If an hbox is resized larger than its preferred width, by default it will keep children to their preferred widths, leaving the extra space unused. If an application wishes to have one or more children be allocated that extra space it may optionally set an hgrow constraint on the child. See "Optional Layout Constraints" for details.
HBox lays out each managed child regardless of the child's visible property value; unmanaged children are ignored.
An hbox's parent will resize the hbox within the hbox's resizable range during layout. By default the hbox computes this range based on its content as outlined in the table below.
width | height | |
---|---|---|
minimum | left/right insets plus the sum of each child's min width plus spacing between each child. | top/bottom insets plus the largest of the children's min heights. |
preferred | left/right insets plus the sum of each child's pref width plus spacing between each child. | top/bottom insets plus the largest of the children's pref heights. |
maximum | Double.MAX_VALUE | Double.MAX_VALUE |
An hbox'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.
HBox 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:
hbox.setPrefWidth(400);
Applications may restore the computed values by setting these properties back
to USE_COMPUTED_SIZE.
HBox 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 hbox.
An application may set constraints on individual children to customize HBox's layout. For each constraint, HBox provides a static method for setting it on the child.
Constraint | Type | Description |
---|---|---|
hgrow | javafx.scene.layout.Priority | The horizontal grow priority for the child. |
margin | javafx.geometry.Insets | Margin space around the outside of the child. |
For example, if an hbox needs the TextField to be allocated all extra space:
HBox hbox = new HBox();
TextField field = new TextField();
HBox.setHgrow(field, Priority.ALWAYS);
hbox.getChildren().addAll(new Label("Search:"), field, new Button("Go"));
If more than one child has the same grow priority set, then the hbox will
allocate equal amounts of space to each. HBox will only grow a child up to
its maximum width, so if the child has a max width other than Double.MAX_VALUE,
the application may need to override the max to allow it to grow.
For example:
HBox hbox = new HBox();
Button button1 = new Button("Add");
Button button2 = new Button("Remove");
HBox.setHgrow(button1, Priority.ALWAYS);
HBox.setHgrow(button2, Priority.ALWAYS);
button1.setMaxWidth(Double.MAX_VALUE);
button2.setMaxWidth(Double.MAX_VALUE);
hbox.getChildren().addAll(button1, button2);
Type | Property and Description |
---|---|
<any> |
alignment
The overall alignment of children within the hbox's width and height.
|
BooleanProperty |
fillHeight
Whether or not resizable children will be resized to fill the full height of the hbox
or be resized to their preferred height and aligned according to the
alignment
vpos value. |
DoubleProperty |
spacing
The amount of horizontal space between each child in the hbox.
|
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 |
HBox.StyleableProperties
*
Stylesheet Handling *
*
|
Modifier and Type | Field and Description |
---|---|
private <any> |
alignment |
private double |
baselineOffset |
private Orientation |
bias |
private boolean |
biasDirty |
private BooleanProperty |
fillHeight |
private static java.lang.String |
HGROW_CONSTRAINT |
private static java.lang.String |
MARGIN_CONSTRAINT
BEGIN static methods
|
private static <any> |
marginAccessor |
private double |
minBaselineComplement |
private double |
prefBaselineComplement |
private DoubleProperty |
spacing |
private double[][] |
tempArray |
TEMP_VEC2D, USE_COMPUTED_SIZE, USE_PREF_SIZE
Constructor and Description |
---|
HBox()
Creates an HBox layout with spacing = 0.
|
HBox(double spacing)
Creates an HBox layout with the specified spacing between children.
|
HBox(double spacing,
Node... children)
Creates an HBox layout with the specified spacing between children.
|
HBox(Node... children)
Creates an HBox layout with spacing = 0.
|
Modifier and Type | Method and Description |
---|---|
private double |
adjustAreaWidths(java.util.List<Node> managed,
double[][] areaWidths,
double width,
double height) |
<any> |
alignmentProperty()
The overall alignment of children within the hbox's width and height.
|
static void |
clearConstraints(Node child)
Removes all hbox constraints from the child node.
|
private double |
computeContentWidth(java.util.List<Node> managedChildren,
double height,
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 |
fillHeightProperty()
Whether or not resizable children will be resized to fill the full height of the hbox
or be resized to their preferred height and aligned according to the
alignment
vpos value. |
Pos |
getAlignment()
Gets the value of the property alignment.
|
private Pos |
getAlignmentInternal() |
private double[][] |
getAreaWidths(java.util.List<Node> managed,
double height,
boolean minimum) |
double |
getBaselineOffset() |
static java.util.List<<any>> |
getClassCssMetaData() |
Orientation |
getContentBias() |
java.util.List<<any>> |
getCssMetaData() |
static Priority |
getHgrow(Node child)
Returns the child's hgrow constraint if set.
|
static Insets |
getMargin(Node child)
Returns the child's margin constraint if set.
|
private double |
getMinBaselineComplement() |
private double |
getPrefBaselineComplement() |
double |
getSpacing()
Gets the value of the property spacing.
|
private double[][] |
getTempArray(int size) |
private double |
growOrShrinkAreaWidths(java.util.List<Node> managed,
double[][] areaWidths,
Priority priority,
double extraWidth,
double height) |
boolean |
isFillHeight()
Gets the value of the property fillHeight.
|
protected void |
layoutChildren() |
void |
requestLayout() |
void |
setAlignment(Pos value)
Sets the value of the property alignment.
|
void |
setFillHeight(boolean value)
Sets the value of the property fillHeight.
|
static void |
setHgrow(Node child,
Priority value)
Sets the horizontal grow priority for the child when contained by an hbox.
|
static void |
setMargin(Node child,
Insets value)
Sets the margin for the child when contained by an hbox.
|
void |
setSpacing(double value)
Sets the value of the property spacing.
|
private boolean |
shouldFillHeight() |
DoubleProperty |
spacingProperty()
The amount of horizontal space between each child in the hbox.
|
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 fillHeightProperty
alignment
vpos value. Note that if the hbox vertical alignment is set to BASELINE, then this
property will be ignored and children will be resized to their preferred heights.isFillHeight()
,
setFillHeight(boolean)
private boolean biasDirty
private double minBaselineComplement
private double prefBaselineComplement
private Orientation bias
private double[][] tempArray
private static final java.lang.String MARGIN_CONSTRAINT
private static final java.lang.String HGROW_CONSTRAINT
private static final <any> marginAccessor
private DoubleProperty spacing
private <any> alignment
private BooleanProperty fillHeight
private double baselineOffset
public HBox()
public HBox(double spacing)
spacing
- the amount of horizontal space between each childpublic HBox(Node... children)
children
- The initial set of children for this pane.public HBox(double spacing, Node... children)
spacing
- the amount of horizontal space between each childchildren
- The initial set of children for this pane.public static void setHgrow(Node child, Priority value)
child
- the child of an hboxvalue
- the horizontal grow priority for the childpublic static Priority getHgrow(Node child)
child
- the child node of an hboxpublic static void setMargin(Node child, Insets value)
child
- the child mode of the hboxvalue
- the margin of space around the childpublic static Insets getMargin(Node child)
child
- the child node of an hboxpublic 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 fillHeightProperty()
alignment
vpos value. Note that if the hbox vertical alignment is set to BASELINE, then this
property will be ignored and children will be resized to their preferred heights.isFillHeight()
,
setFillHeight(boolean)
public final void setFillHeight(boolean value)
public final boolean isFillHeight()
private boolean shouldFillHeight()
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[][] getAreaWidths(java.util.List<Node> managed, double height, boolean minimum)
private double adjustAreaWidths(java.util.List<Node> managed, double[][] areaWidths, double width, double height)
private double growOrShrinkAreaWidths(java.util.List<Node> managed, double[][] areaWidths, Priority priority, double extraWidth, double height)
private double computeContentWidth(java.util.List<Node> managedChildren, double height, boolean minimum)
private static double sum(double[] array, int size)
public void requestLayout()
private double getMinBaselineComplement()
private double getPrefBaselineComplement()
public double getBaselineOffset()
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