public class StackPane extends Pane
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);
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);
| Type | Property and Description |
|---|---|
<any> |
alignment
The default alignment of children within the stackpane's width and height.
|
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 |
StackPane.StyleableProperties
*
Stylesheet Handling *
*
|
| Modifier and Type | Field and Description |
|---|---|
private <any> |
alignment |
private static java.lang.String |
ALIGNMENT_CONSTRAINT |
private Orientation |
bias |
private boolean |
biasDirty |
private static java.lang.String |
MARGIN_CONSTRAINT
BEGIN static methods
|
private static <any> |
marginAccessor |
TEMP_VEC2D, USE_COMPUTED_SIZE, USE_PREF_SIZE| Constructor and Description |
|---|
StackPane()
Creates a StackPane layout with default CENTER alignment.
|
StackPane(Node... children)
Creates a StackPane layout with default CENTER alignment.
|
| Modifier and Type | Method and Description |
|---|---|
<any> |
alignmentProperty()
The default alignment of children within the stackpane's width and height.
|
static void |
clearConstraints(Node child)
Removes all stackpane 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.
|
Pos |
getAlignment()
Gets the value of the property alignment.
|
static Pos |
getAlignment(Node child)
Returns the child's alignment constraint if set.
|
private Pos |
getAlignmentInternal() |
static java.util.List<<any>> |
getClassCssMetaData() |
Orientation |
getContentBias() |
java.util.List<<any>> |
getCssMetaData() |
static Insets |
getMargin(Node child)
Returns the child's margin constraints if set.
|
protected void |
layoutChildren() |
void |
requestLayout() |
static void |
setAlignment(Node child,
Pos value)
Sets the alignment for the child when contained by a stackpane.
|
void |
setAlignment(Pos value)
Sets the value of the property alignment.
|
static void |
setMargin(Node child,
Insets value)
Sets the margin for the child when contained by a stackpane.
|
getChildren, getConstraint, setConstraintaddImageListener, 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, widthPropertypublic final <any> alignmentProperty
getAlignment(),
setAlignment(Pos)private boolean biasDirty
private Orientation bias
private static final java.lang.String MARGIN_CONSTRAINT
private static final java.lang.String ALIGNMENT_CONSTRAINT
private static final <any> marginAccessor
private <any> alignment
public StackPane()
public StackPane(Node... children)
children - The initial set of children for this pane.public static void setAlignment(Node child,
Pos value)
child - the child node of a stackpanevalue - the alignment position for the childpublic static Pos getAlignment(Node child)
child - the child node of a stackpanepublic static void setMargin(Node child,
Insets value)
child - the child node of a stackpanevalue - the margin of space around the childpublic static Insets getMargin(Node child)
child - the child node of a stackpanepublic static void clearConstraints(Node child)
child - the child nodepublic final <any> alignmentProperty()
getAlignment(),
setAlignment(Pos)public final void setAlignment(Pos value)
public final Pos getAlignment()
private Pos getAlignmentInternal()
public Orientation getContentBias()
protected double computeMinWidth(double height)
RegioncomputeMinWidth in class Regionprotected double computeMinHeight(double width)
RegioncomputeMinHeight in class Regionprotected double computePrefWidth(double height)
RegioncomputePrefWidth in class Regionprotected double computePrefHeight(double width)
RegioncomputePrefHeight in class Regionpublic void requestLayout()
protected void layoutChildren()
public static java.util.List<<any>> getClassCssMetaData()
public java.util.List<<any>> getCssMetaData()
getCssMetaData in class Region