The z-order of the children is defined by the order of the children list with the 0th child being the bottom and last child on top. If a border and/or padding have been set, the children will be laid out within those insets.
The stackpane will attempt to resize each child to fill its content area. If the child could not be sized to fill the stackpane (either because it was not resizable or its max size prevented it) then it will be aligned within the area using the alignment property, which defaults to Pos.CENTER.
StackPane example:
StackPane stack = new StackPane();
stack.getChildren().addAll(new Rectangle(100,100,Color.BLUE), new Label("Go!"));
StackPane lays out each managed child regardless of the child's visible property value; unmanaged children are ignored.
StackPane may be styled with backgrounds and borders using CSS. See
Region for details.
A stackpane's parent will resize the stackpane within the stackpane's resizable range during layout. By default the stackpane 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 largest of the children's min heights. |
| preferred | left/right insets plus the largest of the children's pref widths. | top/bottom insets plus the largest of the children's pref heights. |
| maximum | Double.MAX_VALUE | Double.MAX_VALUE |
A stackpane'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.
StackPane 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:
// ensure stackpane is never resized beyond it's preferred size
stackpane.setMaxSize(Region.USE_PREF_SIZE, Region.USE_PREF_SIZE);
Applications may restore the computed values by setting these properties back
to USE_COMPUTED_SIZE.
StackPane 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 stackpane.
An application may set constraints on individual children to customize StackPane's layout. For each constraint, StackPane provides a static method for setting it on the child.
| Constraint | Type | Description |
|---|---|---|
| alignment | javafx.geometry.Pos | The alignment of the child within the stackpane. |
| margin | javafx.geometry.Insets | Margin space around the outside of the child. |
Examples:
// Align the title Label at the bottom-center of the stackpane
Label title = new Label();
StackPane.setAlignment(title, Pos.BOTTOM_CENTER);
stackpane.getChildren.addAll(new ImageView(...), title);
// Create an 8 pixel margin around a listview in the stackpane
ListView list = new ListView();
StackPane.setMargin(list, new Insets(8,8,8,8);
stackpane.getChildren().add(list);
| Modifier and Type | Class and Description |
|---|---|
| private static class |
| Modifier and Type | Field and Description |
|---|---|
| private ObjectProperty | |
| private static final String | |
| private Orientation | |
| private boolean | |
| private static final String | |
| private static final Callback |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public final ObjectProperty | Returns: the alignment of children within this stackpaneThe default alignment of children within the stackpane's width and height. |
| public static void | |
| protected double | computeMinHeight(double width)
Overrides javafx. Computes the minimum height of this region. |
| protected double | computeMinWidth(double height)
Overrides javafx. Computes the minimum width of this region. |
| protected double | computePrefHeight(double width)
Overrides javafx. 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)
Overrides javafx. Computes the preferred width of this region for the given height. |
| public static Pos | Returns: the alignment position for the child or null if no alignment was setthe child node of a stackpane child)Returns the child's alignment constraint if set. |
| public final Pos | |
| private Pos | |
| public static List | Returns: theCssMetaDataHides javafx. Gets the |
| public Orientation | Returns: the first non-null contentBias of its managed children or null if no managed children have a content bias.Overrides javafx. Returns the orientation of a node's resizing bias for layout purposes. |
| public List | getCssMetaData()
Overrides javafx. Implements javafx. This method should delegate to |
| public static Insets | |
| protected void | layoutChildren()
Overrides javafx. Invoked during the layout pass to layout the children in this
|
| public void | requestLayout()
Overrides javafx. Requests a layout pass to be performed before the next scene is rendered. |
| public static void | setAlignment(Node
the child node of a stackpane child, Pos the alignment position for the child value)Sets the alignment for the child when contained by a stackpane. |
| public final void | |
| public static void |
| alignment | back to summary |
|---|---|
| private ObjectProperty<Pos> alignment | |
| ALIGNMENT_CONSTRAINT | back to summary |
|---|---|
| private static final String ALIGNMENT_CONSTRAINT | |
| bias | back to summary |
|---|---|
| private Orientation bias | |
| biasDirty | back to summary |
|---|---|
| private boolean biasDirty | |
| MARGIN_CONSTRAINT | back to summary |
|---|---|
| private static final String MARGIN_CONSTRAINT | |
| marginAccessor | back to summary |
|---|---|
| private static final Callback<Node, Insets> marginAccessor | |
| StackPane | back to summary |
|---|---|
| public StackPane() Creates a StackPane layout with default CENTER alignment. | |
| StackPane | back to summary |
|---|---|
| public StackPane(Node... children) Creates a StackPane layout with default CENTER alignment.
| |
| alignmentProperty | back to summary |
|---|---|
| public final ObjectProperty The default alignment of children within the stackpane's width and height. This may be overridden on individual children by setting the child's alignment constraint.
| |
| clearConstraints | back to summary |
|---|---|
| public static void clearConstraints(Node child) Removes all stackpane constraints from the child node.
| |
| computeMinHeight | back to summary |
|---|---|
| protected double computeMinHeight(double width) Overrides javafx. Doc from javafx. 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.
| |
| computeMinWidth | back to summary |
|---|---|
| protected double computeMinWidth(double height) Overrides javafx. Doc from javafx. 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.
| |
| computePrefHeight | back to summary |
|---|---|
| protected double computePrefHeight(double width) Overrides javafx. Doc from javafx. 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.
| |
| computePrefWidth | back to summary |
|---|---|
| protected double computePrefWidth(double height) Overrides javafx. Doc from javafx. 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.
| |
| getAlignment | back to summary |
|---|---|
| public static Pos getAlignment(Node child) Returns the child's alignment constraint if set. | |
| getAlignment | back to summary |
|---|---|
| public final Pos getAlignment() | |
| getAlignmentInternal | back to summary |
|---|---|
| private Pos getAlignmentInternal() | |
| getClassCssMetaData | back to summary |
|---|---|
| public static List Hides javafx. Gets the
| |
| getContentBias | back to summary |
|---|---|
| public Orientation getContentBias() Overrides javafx. Doc from javafx. 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.
| |
| getCssMetaData | back to summary |
|---|---|
| public List Overrides javafx. Implements javafx. Doc from javafx. This method should delegate to
| |
| getMargin | back to summary |
|---|---|
| public static Insets getMargin(Node child) Returns the child's margin constraints if set. | |
| layoutChildren | back to summary |
|---|---|
| protected void layoutChildren() Overrides javafx. Doc from javafx. Invoked during the layout pass to layout the children in this
Subclasses should override this function to layout content as needed.
| |
| requestLayout | back to summary |
|---|---|
| public void requestLayout() Overrides javafx. Doc from javafx. 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 scene root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked.
| |
| setAlignment | back to summary |
|---|---|
| public static void setAlignment(Node child, Pos value) Sets the alignment for the child when contained by a stackpane. If set, will override the stackpane's default alignment. Setting the value to null will remove the constraint. | |
| setAlignment | back to summary |
|---|---|
| public final void setAlignment(Pos value) | |
| setMargin | back to summary |
|---|---|
| public static void setMargin(Node child, Insets value) Sets the margin for the child when contained by a stackpane. If set, the stackpane will layout the child with the margin space around it. Setting the value to null will remove the constraint. | |
| Modifier and Type | Field and Description |
|---|---|
| private static final CssMetaData | |
| private static final List |
| Access | Constructor and Description |
|---|---|
| private |
| ALIGNMENT | back to summary |
|---|---|
| private static final CssMetaData<StackPane, Pos> ALIGNMENT | |
| STYLEABLES | back to summary |
|---|---|
| private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES | |
| StyleableProperties | back to summary |
|---|---|
| private StyleableProperties() | |