javafx.scene.layout

Class AnchorPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.AnchorPane

All Implemented Interfaces:

EventTarget

public class AnchorPane
extends Pane

AnchorPane allows the edges of child nodes to be anchored to an offset from the anchorpane's edges. If the anchorpane has a border and/or padding set, the offsets will be measured from the inside edge of those insets.

AnchorPane lays out each managed child regardless of the child's visible property value; unmanaged children are ignored for all layout calculations.

Anchorpanes may be styled with backgrounds and borders using CSS. See Region superclass for details.

Anchor Constraints

The application sets anchor constraints on each child to configure the anchors on one or more sides. If a child is anchored on opposite sides (and is resizable), the anchorpane will resize it to maintain both offsets, otherwise the anchorpane will resize it to its preferred size. If in the former case (anchored on opposite sides) and the child is not resizable, then only the top/left anchor will be honored. AnchorPane provides a static method for setting each anchor constraint.

Constraint	Type	Description
topAnchor	double	distance from the anchorpane's top insets to the child's top edge.
leftAnchor	double	distance from the anchorpane's left insets to the child's left edge.
bottomAnchor	double	distance from the anchorpane's bottom insets to the child's bottom edge.
rightAnchor	double	distance from the anchorpane's right insets to the child's right edge.

AnchorPane Example:

     AnchorPane anchorpane = new AnchorPane();
     // List should stretch as anchorpane is resized
     ListView list = new ListView();
     AnchorPane.setTopAnchor(list, 10.0);
     AnchorPane.setLeftAnchor(list, 10.0);
     AnchorPane.setRightAnchor(list, 65.0);
     // Button will float on right edge
     Button button = new Button("Add");
     AnchorPane.setTopAnchor(button, 10.0);
     AnchorPane.setRightAnchor(button, 10.0);
     anchorpane.getChildren().addAll(list, button);
 

Resizable Range

An anchorpane's parent will resize the anchorpane within the anchorpane's resizable range during layout. By default the anchorpane computes this range based on its content as outlined in the table below.

	width	height
minimum	left/right insets plus width required to display children anchored at left/right with at least their min widths	top/bottom insets plus height required to display children anchored at top/bottom with at least their min heights
preferred	left/right insets plus width required to display children anchored at left/right with at least their pref widths	top/bottom insets plus height required to display children anchored at top/bottom with at least their pref heights
maximum	Double.MAX_VALUE	Double.MAX_VALUE

An anchorpane'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.

AnchorPane provides properties for setting the size range directly. These properties default to the sentinel value Region.USE_COMPUTED_SIZE, however the application may set them to other values as needed:

     anchorpane.setPrefSize(300, 300);
 

Applications may restore the computed values by setting these properties back to Region.USE_COMPUTED_SIZE.

AnchorPane does not clip its content by default, so it is possible that childrens' bounds may extend outside its own bounds if the anchorpane is resized smaller than its preferred size.

Property Summary

Properties inherited from class javafx.scene.layout.Region

height, maxHeight, maxWidth, minHeight, minWidth, padding, prefHeight, prefWidth, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, 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

Constructor Summary

Constructors

Constructor and Description
AnchorPane() Creates an AnchorPane layout.

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearConstraints(Node child) Removes all anchorpane 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.
static java.lang.Double	getBottomAnchor(Node child) Returns the child's bottom anchor constraint if set.
static java.lang.Double	getLeftAnchor(Node child) Returns the child's left anchor constraint if set.
static java.lang.Double	getRightAnchor(Node child) Returns the child's right anchor constraint if set.
static java.lang.Double	getTopAnchor(Node child) Returns the child's top anchor constraint if set.
protected void	layoutChildren() Invoked during the layout pass to layout the children in this Parent.
static void	setBottomAnchor(Node child, java.lang.Double value) Sets the bottom anchor for the child when contained by an anchorpane.
static void	setLeftAnchor(Node child, java.lang.Double value) Sets the left anchor for the child when contained by an anchorpane.
static void	setRightAnchor(Node child, java.lang.Double value) Sets the bottom anchor for the child when contained by an anchorpane.
static void	setTopAnchor(Node child, java.lang.Double value) Sets the top anchor for the child when contained by an anchorpane.

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

computeMaxHeight, computeMaxWidth, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPadding, getPrefHeight, getPrefWidth, getWidth, heightProperty, isResizable, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setSnapToPixel, setWidth, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, 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, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, 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, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, 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, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

AnchorPane

public AnchorPane()

Creates an AnchorPane layout.

Method Detail

setTopAnchor

public static void setTopAnchor(Node child,
                java.lang.Double value)

Sets the top anchor for the child when contained by an anchorpane. If set, the anchorpane will maintain the child's size and position so that it's top is always offset by that amount from the anchorpane's top content edge. Setting the value to null will remove the constraint.

Parameters:

child - the child node of an anchorpane

value - the offset from the top of the anchorpane

getTopAnchor

public static java.lang.Double getTopAnchor(Node child)

Returns the child's top anchor constraint if set.

Parameters:

child - the child node of an anchorpane

Returns:

the offset from the top of the anchorpane or null if no top anchor was set

setLeftAnchor

public static void setLeftAnchor(Node child,
                 java.lang.Double value)

Sets the left anchor for the child when contained by an anchorpane. If set, the anchorpane will maintain the child's size and position so that it's left is always offset by that amount from the anchorpane's left content edge. Setting the value to null will remove the constraint.

Parameters:

child - the child node of an anchorpane

value - the offset from the left of the anchorpane

getLeftAnchor

public static java.lang.Double getLeftAnchor(Node child)

Returns the child's left anchor constraint if set.

Parameters:

child - the child node of an anchorpane

Returns:

the offset from the left of the anchorpane or null if no left anchor was set

setBottomAnchor

public static void setBottomAnchor(Node child,
                   java.lang.Double value)

Sets the bottom anchor for the child when contained by an anchorpane. If set, the anchorpane will maintain the child's size and position so that it's bottom is always offset by that amount from the anchorpane's bottom content edge. Setting the value to null will remove the constraint.

Parameters:

child - the child node of an anchorpane

value - the offset from the bottom of the anchorpane

getBottomAnchor

public static java.lang.Double getBottomAnchor(Node child)

Returns the child's bottom anchor constraint if set.

Parameters:

child - the child node of an anchorpane

Returns:

the offset from the bottom of the anchorpane or null if no bottom anchor was set

setRightAnchor

public static void setRightAnchor(Node child,
                  java.lang.Double value)

Sets the bottom anchor for the child when contained by an anchorpane. If set, the anchorpane will maintain the child's size and position so that it's right is always offset by that amount from the anchorpane's right content edge. Setting the value to null will remove the constraint.

Parameters:

child - the child node of an anchorpane

value - the offset from the right of the anchorpane

getRightAnchor

public static java.lang.Double getRightAnchor(Node child)

Returns the child's right anchor constraint if set.

Parameters:

child - the child node of an anchorpane

Returns:

the offset from the right of the anchorpane or null if no right anchor was set

clearConstraints

public static void clearConstraints(Node child)

Removes all anchorpane constraints from the child node.

Parameters:

child - the child node

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

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