Module javafx.graphics
Package javafx.scene.layout

Class HBox

  • All Implemented Interfaces:
    Styleable, EventTarget

    public class HBox
extends Pane
    HBox lays out its children in a single horizontal row. If the hbox has a border and/or padding set, then the contents will be layed out within those insets.

    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.

    Resizable Range

    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.

    HBox Resize Table
    widthheight
    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_VALUEDouble.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 childrens' bounds may extend outside its own bounds if a child's min size prevents it from being fit within the hbox.

    Optional Layout Constraints

    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.

    HBox Constraint Table
    ConstraintTypeDescription
    hgrowjavafx.scene.layout.PriorityThe horizontal grow priority for the child.
    marginjavafx.geometry.InsetsMargin 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);
    Since:
    JavaFX 2.0

    • Property Detail

      • fillHeight

        public final 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. 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.
        See Also:
        isFillHeight(), setFillHeight(boolean)

    • Constructor Detail

      • HBox

        public HBox​()
        Creates an HBox layout with spacing = 0.

      • HBox

        public HBox​(double spacing)
        Creates an HBox layout with the specified spacing between children.
        Parameters:
        spacing - the amount of horizontal space between each child

      • HBox

        public HBox​(Node... children)
        Creates an HBox layout with spacing = 0.
        Parameters:
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

      • HBox

        public HBox​(double spacing,
            Node... children)
        Creates an HBox layout with the specified spacing between children.
        Parameters:
        spacing - the amount of horizontal space between each child
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

    • Method Detail

      • setHgrow

        public static void setHgrow​(Node child,
                            Priority value)
        Sets the horizontal grow priority for the child when contained by an hbox. If set, the hbox will use the priority to allocate additional space if the hbox is resized larger than it's preferred width. If multiple hbox children have the same horizontal grow priority, then the extra space will be split evening between them. If no horizontal grow priority is set on a child, the hbox will never allocate it additional horizontal space if available. Setting the value to null will remove the constraint.
        Parameters:
        child - the child of an hbox
        value - the horizontal grow priority for the child

      • getHgrow

        public static Priority getHgrow​(Node child)
        Returns the child's hgrow constraint if set.
        Parameters:
        child - the child node of an hbox
        Returns:
        the horizontal grow priority for the child or null if no priority was set

      • setMargin

        public static void setMargin​(Node child,
                             Insets value)
        Sets the margin for the child when contained by an hbox. If set, the hbox will layout the child with the margin space around it. Setting the value to null will remove the constraint.
        Parameters:
        child - the child mode of the hbox
        value - the margin of space around the child

      • getMargin

        public static Insets getMargin​(Node child)
        Returns the child's margin constraint if set.
        Parameters:
        child - the child node of an hbox
        Returns:
        the margin for the child or null if no margin was set

      • clearConstraints

        public static void clearConstraints​(Node child)
        Removes all hbox constraints from the child node.
        Parameters:
        child - the child node

      • setSpacing

        public final void setSpacing​(double value)
        Sets the value of the property spacing.
        Property description:
        The amount of horizontal space between each child in the hbox.

      • getSpacing

        public final double getSpacing​()
        Gets the value of the property spacing.
        Property description:
        The amount of horizontal space between each child in the hbox.

      • setAlignment

        public final void setAlignment​(Pos value)
        Sets the value of the property alignment.
        Property description:
        The overall alignment of children within the hbox's width and height.

      • getAlignment

        public final Pos getAlignment​()
        Gets the value of the property alignment.
        Property description:
        The overall alignment of children within the hbox's width and height.

      • fillHeightProperty

        public final 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. 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.
        See Also:
        isFillHeight(), setFillHeight(boolean)

      • setFillHeight

        public final void setFillHeight​(boolean value)
        Sets the value of the property fillHeight.
        Property description:
        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. 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

        public final boolean isFillHeight​()
        Gets the value of the property fillHeight.
        Property description:
        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. 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.

      • computeMinWidth

        protected double computeMinWidth​(double height)
        Description copied from class: Region
        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.
        Overrides:
        computeMinWidth in class Region
        Parameters:
        height - the height that should be used if min width depends on it
        Returns:
        the computed minimum width of this region

      • computeMinHeight

        protected double computeMinHeight​(double width)
        Description copied from class: Region
        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.
        Overrides:
        computeMinHeight in class Region
        Parameters:
        width - the width that should be used if min height depends on it
        Returns:
        the computed minimum height for this region

      • computePrefWidth

        protected double computePrefWidth​(double height)
        Description copied from class: Region
        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.
        Overrides:
        computePrefWidth in class Region
        Parameters:
        height - the height that should be used if preferred width depends on it
        Returns:
        the computed preferred width for this region

      • computePrefHeight

        protected double computePrefHeight​(double width)
        Description copied from class: Region
        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.
        Overrides:
        computePrefHeight in class Region
        Parameters:
        width - the width that should be used if preferred height depends on it
        Returns:
        the computed preferred height for this region

      • requestLayout

        public void requestLayout​()
        Description copied from class: Parent
        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.

        Overrides:
        requestLayout in class Parent

      • getBaselineOffset

        public double getBaselineOffset​()
        Description copied from class: Parent
        Calculates the baseline offset based on the first managed child. If there is no such child, returns Node.getBaselineOffset().
        Overrides:
        getBaselineOffset in class Parent
        Returns:
        baseline offset

      • layoutChildren

        protected void layoutChildren​()
        Description copied from class: Parent
        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.

        Overrides:
        layoutChildren in class Parent

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData​()
        Returns:
        The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
        Since:
        JavaFX 8.0