Class StackPane

public class StackPane
extends Pane

StackPane stack = new StackPane();
     stack.getChildren().addAll(new Rectangle(100,100,Color.BLUE), new Label("Go!));

// ensure stackpane is never resized beyond it's preferred size
     stackpane.setMaxSize(Region.USE_PREF_SIZE, Region.USE_PREF_SIZE);

// 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);

• Property Summary

  All MethodsInstance MethodsConcrete Methods

  Type	Property and Description
  ObjectProperty<Pos>	alignment The default alignment of children within the stackpane's width and height.

  • Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

  • Properties inherited from class javafx.scene.Parent

    needsLayout

  • Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

• Field Summary

  • Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

  • Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

• Constructor Summary

  Constructors

  Constructor and Description
  StackPane() Creates a StackPane layout with default CENTER alignment.
  StackPane(Node... children) Creates a StackPane layout with default CENTER alignment.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type	Method and Description
  ObjectProperty<Pos>	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.
  static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
  Orientation	getContentBias() Returns the orientation of a node's resizing bias for layout purposes.
  List<CssMetaData<? extends Styleable,?>>	getCssMetaData() This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
  static Insets	getMargin(Node child) Returns the child's margin constraints if set.
  protected void	layoutChildren() Invoked during the layout pass to layout the children in this Parent.
  void	requestLayout() Requests a layout pass to be performed before the next scene is rendered.
  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.

  • Methods inherited from class javafx.scene.layout.Pane

    getChildren

  • Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, 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, 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, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

  • Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBounds

  • Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• Property Detail

  • alignment

    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.

    See Also:

    getAlignment(), setAlignment(Pos)

• Constructor Detail

  • StackPane

    public StackPane()

    Creates a StackPane layout with default CENTER alignment.

  • StackPane

    public StackPane(Node... children)

    Creates a StackPane layout with default CENTER alignment.

    Parameters:

    children - The initial set of children for this pane.

    Since:

    JavaFX 8.0

• Method Detail

  • setAlignment

    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 - the child node of a stackpane

  • getAlignment

    public static Pos getAlignment(Node child)

    Returns the child's alignment constraint if set.

    Parameters:

    child - the child node of a stackpane

    Returns:

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

  • setMargin

    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 - the child node of a stackpane

  • getMargin

    public static Insets getMargin(Node child)

    Returns the child's margin constraints if set.

    Parameters:

    child - the child node of a stackpane

    Returns:

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

  • clearConstraints

    public static void clearConstraints(Node child)

    Removes all stackpane constraints from the child node.

    Parameters:

    child - the child node

  • alignmentProperty

    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.

    See Also:

    getAlignment(), setAlignment(Pos)

  • setAlignment

    public final void setAlignment(Pos value)

    Sets the value of the property alignment.

    Property description:

    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.

  • getAlignment

    public final Pos getAlignment()

    Gets the value of the property alignment.

    Property description:

    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.

  • getContentBias

    public Orientation getContentBias()

    Description copied from class: Node
    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.

    Overrides:

    getContentBias in class Node

    Returns:

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

    See Also:

    Node.isResizable(), Node.minWidth(double), Node.minHeight(double), Node.prefWidth(double), Node.prefHeight(double), Node.maxWidth(double), Node.maxHeight(double)

  • 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

  • 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 super classes.

    Since:

    JavaFX 8.0

  • getCssMetaData

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

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

    Specified by:

    getCssMetaData in interface Styleable

    Overrides:

    getCssMetaData in class Region

    Returns:

    The CssMetaData associated with this node, which may include the CssMetaData of its super classes.

    Since:

    JavaFX 8.0