BorderPane lays out children in top, left, right, bottom, and center positions.

A diagram that shows the position
of each child

The top and bottom children will be resized to their preferred heights and extend the width of the border pane. The left and right children will be resized to their preferred widths and extend the length between the top and bottom nodes. And the center node will be resized to fill the available space in the middle. Any of the positions may be null. Example:

     BorderPane borderPane = new BorderPane();
    ToolBar toolbar = new ToolBar();
    HBox statusbar = new HBox();
    Node appContent = new AppContentNode();
    borderPane.setTop(toolbar);
    borderPane.setCenter(appContent);
    borderPane.setBottom(statusbar);

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

BorderPane honors the minimum, preferred, and maximum sizes of its children. If the child's resizable range prevents it from be resized to fit within its position, it will be aligned relative to the space using a default alignment as follows:

top: Pos.TOP_LEFT
bottom: Pos.BOTTOM_LEFT
left: Pos.TOP_LEFT
right: Pos.TOP_RIGHT
center: Pos.CENTER

See "Optional Layout Constraints" on how to customize these alignments.

BorderPane lays out each child set in the five positions regardless of the child's visible property value; unmanaged children are ignored.

Resizable Range

BorderPane is commonly used as the root of a Scene, in which case its size will track the size of the scene. If the scene or stage size has not been directly set by the application, the scene size will be initialized to the border pane's preferred size. However, if a border pane has a parent other than the scene, that parent will resize the border pane within the border pane's resizable range during layout. By default the border pane computes this range based on its content as outlined in the table below.

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

A border pane'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.

BorderPane 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:


    borderPane.setPrefSize(500,400);

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

BorderPane 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 it space.

Optional Layout Constraints

An application may set constraints on individual children to customize BorderPane's layout. For each constraint, BorderPane provides a static method for setting it on the child.

BorderPane Constraint Table
Constraint	Type	Description
alignment	javafx.geometry.Pos	The alignment of the child within its area of the border pane.
margin	javafx.geometry.Insets	Margin space around the outside of the child.

Example:

     ListView list = new ListView();
    BorderPane.setAlignment(list, Pos.TOP_LEFT);
    BorderPane.setMargin(list, new Insets(12,12,12,12));
    borderPane.setCenter(list);

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	BorderPane.BorderPositionProperty

Field Summary

Modifier and Type	Field and Description
private static final String	ALIGNMENT
private ObjectProperty<Node>	bottom Hides javafx.scene.Parent.bottom.
private ObjectProperty<Node>	center
private ObjectProperty<Node>	left Hides javafx.scene.Parent.left.
private static final String	MARGIN
private ObjectProperty<Node>	right Hides javafx.scene.Parent.right.
private ObjectProperty<Node>	top Hides javafx.scene.Parent.top.

Constructor Summary

Access	Constructor and Description
public	BorderPane() Creates a BorderPane layout.
public	BorderPane(Node The node to set as the center of the BorderPane. center) Creates an BorderPane layout with the given Node as the center of the BorderPane.
public	BorderPane(Node The node to set as the center of the BorderPane. center, Node The node to set as the top of the BorderPane. top, Node The node to set as the right of the BorderPane. right, Node The node to set as the bottom of the BorderPane. bottom, Node The node to set as the left of the BorderPane. left) Creates an BorderPane layout with the given Nodes to use for each of the main layout areas of the Border Pane.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Node>	Returns: the node placed on the bottom edge of this border pane bottomProperty() The node placed on the bottom edge of this border pane.
public final ObjectProperty<Node>	Returns: the node placed in the center of this border pane centerProperty() The node placed in the center of this border pane.
private boolean	childHasContentBias(Node child, Orientation orientation)
public static void	clearConstraints(Node the child node child) Removes all border pane 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 border pane child) Returns the child's alignment constraint if set.
private double	getAreaHeight(Node child, double width, boolean minimum)
private double	getAreaWidth(Node child, double height, boolean minimum)
public final Node	getBottom()
public final Node	getCenter()
public Orientation	Returns: null unless the center, right, bottom, left or top has a content bias. getContentBias() Overrides javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes.
public final Node	getLeft()
public static Insets	Returns: the margin for the child or null if no margin was set getMargin(Node the child node of a border pane child) Returns the child's margin constraint if set.
private static Insets	getNodeMargin(Node child)
public final Node	getRight()
public final Node	getTop()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObjectProperty<Node>	Returns: the node placed on the left edge of this border pane leftProperty() The node placed on the left edge of this border pane.
public final ObjectProperty<Node>	Returns: the node placed on the right edge of this border pane rightProperty() The node placed on the right edge of this border pane.
public static void	setAlignment(Node the child node of a border pane child, Pos the alignment position for the child value) Sets the alignment for the child when contained by a border pane.
public final void	setBottom(Node value)
public final void	setCenter(Node value)
public final void	setLeft(Node value)
public static void	setMargin(Node the child node of a border pane child, Insets the margin of space around the child value) Sets the margin for the child when contained by a border pane.
public final void	setRight(Node value)
public final void	setTop(Node value)
public final ObjectProperty<Node>	Returns: the node placed on the top edge of this border pane topProperty() The node placed on the top edge of this border pane.

Inherited from javafx.scene.layout.Pane:: getChildren getConstraint setConstraint

Field Detail

ALIGNMENT	back to summary
private static final String ALIGNMENT

bottom	back to summary
private ObjectProperty<Node> bottom Hides javafx.scene.Parent.bottom.

center	back to summary
private ObjectProperty<Node> center

left	back to summary
private ObjectProperty<Node> left Hides javafx.scene.Parent.left.

MARGIN	back to summary
private static final String MARGIN

right	back to summary
private ObjectProperty<Node> right Hides javafx.scene.Parent.right.

top	back to summary
private ObjectProperty<Node> top Hides javafx.scene.Parent.top.

Constructor Detail

BorderPane	back to summary
public BorderPane() Creates a BorderPane layout.

BorderPane	back to summary
public BorderPane(Node center) Creates an BorderPane layout with the given Node as the center of the BorderPane. Parameters center:Node The node to set as the center of the BorderPane. Since JavaFX 8.0

BorderPane

Modifier and Type	Field and Description
private boolean	isBeingInvalidated
private Node	oldValue
private final String	propertyName

Modifier and Type	Method and Description
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
protected void	invalidated() Overrides javafx.beans.property.ObjectPropertyBase.invalidated. The method `invalidated()` can be overridden to receive invalidation notifications.

public Class BorderPane

Resizable Range

Optional Layout Constraints

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class BorderPane.BorderPositionProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail