APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javafx.scene.layout

public Class StackPane

extends Pane
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, javafx.beans.property.ObjectProperty, javafx.css.CssMetaData, .StyleableObjectProperty, .StyleableProperty, .Styleable, javafx.geometry.Insets, .Orientation, .Pos, .VPos, .HPos, javafx.scene.Node, javafx.css.converter.EnumConverter, javafx.util.Callback

StackPane lays out its children in a back-to-front stack.

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.

Resizable Range

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.

StackPane Resize Table
widthheight
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_VALUEDouble.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.

Optional Layout Constraints

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.

StackPane Constraint Table
ConstraintTypeDescription
alignmentjavafx.geometry.PosThe alignment of the child within the stackpane.
marginjavafx.geometry.InsetsMargin 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);
Since
JavaFX 2.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private ObjectProperty<Pos>
private static final String
private Orientation
private boolean
private static final String
private static final Callback<Node, Insets>

Constructor Summary

AccessConstructor and Description
public
StackPane()

Creates a StackPane layout with default CENTER alignment.

public
StackPane(Node...
The initial set of children for this pane.
children
)

Creates a StackPane layout with default CENTER alignment.

Method Summary

Modifier and TypeMethod and Description
public final ObjectProperty<Pos>

Returns:

the alignment of children within this stackpane
alignmentProperty
()

The default alignment of children within the stackpane's width and height.

public static void
clearConstraints(Node
the child node
child
)

Removes all stackpane constraints from the child node.

protected double
computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region.

protected double
computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region.

protected double
computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

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.scene.layout.Region.computePrefWidth.

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 set
getAlignment
(Node
the child node of a stackpane
child
)

Returns the child's alignment constraint if set.

public final Pos
private Pos
public static List<CssMetaData<? extends Styleable, ?>>

Returns:

the CssMetaData
getClassCssMetaData
()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

public Orientation

Returns:

the first non-null contentBias of its managed children or null if no managed children have a content bias.
getContentBias
()

Overrides javafx.scene.Node.getContentBias.

Returns the orientation of a node's resizing bias for layout purposes.

public List<CssMetaData<? extends Styleable, ?>>
getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

public static Insets

Returns:

the margin for the child or null if no margin was set
getMargin
(Node
the child node of a stackpane
child
)

Returns the child's margin constraints if set.

protected void
layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent.

public void
requestLayout()

Overrides javafx.scene.Parent.requestLayout.

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
setMargin(Node
the child node of a stackpane
child
,
Insets
the margin of space around the child
value
)

Sets the margin for the child when contained by a stackpane.

Inherited from javafx.scene.layout.Pane:
getChildrengetConstraintsetConstraint

Field Detail

alignmentback to summary
private ObjectProperty<Pos> alignment
ALIGNMENT_CONSTRAINTback to summary
private static final String ALIGNMENT_CONSTRAINT
biasback to summary
private Orientation bias
biasDirtyback to summary
private boolean biasDirty
MARGIN_CONSTRAINTback to summary
private static final String MARGIN_CONSTRAINT
marginAccessorback to summary
private static final Callback<Node, Insets> marginAccessor

Constructor Detail

StackPaneback to summary
public StackPane()

Creates a StackPane layout with default CENTER alignment.

StackPaneback to summary
public StackPane(Node... children)

Creates a StackPane layout with default CENTER alignment.

Parameters
children:Node[]

The initial set of children for this pane.

Since
JavaFX 8.0

Method Detail

alignmentPropertyback to summary
public final ObjectProperty<Pos> alignmentProperty()

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.

Returns:ObjectProperty<Pos>

the alignment of children within this stackpane

clearConstraintsback to summary
public static void clearConstraints(Node child)

Removes all stackpane constraints from the child node.

Parameters
child:Node

the child node

computeMinHeightback to summary
protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

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.

Annotations
@Override
computeMinWidthback to summary
protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

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.

Annotations
@Override
computePrefHeightback to summary
protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

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.

Annotations
@Override
computePrefWidthback to summary
protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

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.

Annotations
@Override
getAlignmentback to summary
public static Pos getAlignment(Node child)

Returns the child's alignment constraint if set.

Parameters
child:Node

the child node of a stackpane

Returns:Pos

the alignment position for the child or null if no alignment was set

getAlignmentback to summary
public final Pos getAlignment()
getAlignmentInternalback to summary
private Pos getAlignmentInternal()
getClassCssMetaDataback to summary
public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.layout.Region.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>

the CssMetaData

Since
JavaFX 8.0
getContentBiasback to summary
public Orientation getContentBias()

Overrides javafx.scene.Node.getContentBias.

Doc from javafx.scene.Node.getContentBias.

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.

Returns:Orientation

the first non-null contentBias of its managed children or null if no managed children have a content bias.

Annotations
@Override
getCssMetaDataback to summary
public List<CssMetaData<? extends Styleable, ?>> getCssMetaData()

Overrides javafx.scene.layout.Region.getCssMetaData.

Implements javafx.css.Styleable.getCssMetaData.

Doc from javafx.scene.layout.Region.getCssMetaData.

This method should delegate to Node#getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

Annotations
@Override
Since
JavaFX 8.0
getMarginback to summary
public static Insets getMargin(Node child)

Returns the child's margin constraints if set.

Parameters
child:Node

the child node of a stackpane

Returns:Insets

the margin for the child or null if no margin was set

layoutChildrenback to summary
protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

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.

Annotations
@Override
requestLayoutback to summary
public void requestLayout()

Overrides javafx.scene.Parent.requestLayout.

Doc from javafx.scene.Parent.requestLayout.

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.

Annotations
@Override
setAlignmentback 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.

Parameters
child:Node

the child node of a stackpane

value:Pos

the alignment position for the child

setAlignmentback to summary
public final void setAlignment(Pos value)
setMarginback 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.

Parameters
child:Node

the child node of a stackpane

value:Insets

the margin of space around the child

javafx.scene.layout back to summary

private Class StackPane.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<StackPane, Pos>
private static final List<CssMetaData<? extends Styleable, ?>>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALIGNMENTback to summary
private static final CssMetaData<StackPane, Pos> ALIGNMENT
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()