BorderPane

java.lang.Object
- Parent
- - javafx.scene.layout.Region
  - - javafx.scene.layout.Pane
    - - javafx.scene.layout.BorderPane

public class BorderPane
extends Pane

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

Since:: JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`bottom` The node placed on the bottom edge of this border pane.
`<any>`	`center` The node placed in the center of this border pane.
`<any>`	`left` The node placed on the left edge of this border pane.
`<any>`	`right` The node placed on the right edge of this border pane.
`<any>`	`top` The node placed on the top edge of this border pane.

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`BorderPane.BorderPositionProperty` * Private Inner Class * *

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`ALIGNMENT`
`private <any>`	`bottom`
`private <any>`	`center`
`private <any>`	`left`
`private static java.lang.String`	`MARGIN` BEGIN static methods
`private <any>`	`right`
`private <any>`	`top`

Fields inherited from class javafx.scene.layout.Region
TEMP_VEC2D, USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`bottomProperty()` The node placed on the bottom edge of this border pane.
`<any>`	`centerProperty()` The node placed in the center of this border pane.
`private boolean`	`childHasContentBias(Node child, Orientation orientation)`
`static void`	`clearConstraints(Node child)` Removes all border pane 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 Pos`	`getAlignment(Node 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)`
`Node`	`getBottom()` Gets the value of the property bottom.
`Node`	`getCenter()` Gets the value of the property center.
`Orientation`	`getContentBias()`
`Node`	`getLeft()` Gets the value of the property left.
`static Insets`	`getMargin(Node child)` Returns the child's margin constraint if set.
`private static Insets`	`getNodeMargin(Node child)`
`Node`	`getRight()` Gets the value of the property right.
`Node`	`getTop()` Gets the value of the property top.
`protected void`	`layoutChildren()`
`<any>`	`leftProperty()` The node placed on the left edge of this border pane.
`<any>`	`rightProperty()` The node placed on the right edge of this border pane.
`static void`	`setAlignment(Node child, Pos value)` Sets the alignment for the child when contained by a border pane.
`void`	`setBottom(Node value)` Sets the value of the property bottom.
`void`	`setCenter(Node value)` Sets the value of the property center.
`void`	`setLeft(Node value)` Sets the value of the property left.
`static void`	`setMargin(Node child, Insets value)` Sets the margin for the child when contained by a border pane.
`void`	`setRight(Node value)` Sets the value of the property right.
`void`	`setTop(Node value)` Sets the value of the property top.
`<any>`	`topProperty()` The node placed on the top edge of this border pane.

Methods inherited from class javafx.scene.layout.Pane
getChildren, getConstraint, setConstraint

Methods inherited from class javafx.scene.layout.Region
addImageListener, 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, getClassCssMetaData, getCssMetaData, 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, widthProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - center
```
public final <any> centerProperty
```
    The node placed in the center of this border pane. If resizable, it will be resized fill the center of the border pane between the top, bottom, left, and right nodes. If the node cannot be resized to fill the center space (it's not resizable or its max size prevents it) then it will be center aligned unless the child's alignment constraint has been set.
    
    See Also:
    
    getCenter(), setCenter(Node)
  - top
```
public final <any> topProperty
```
    The node placed on the top edge of this border pane. If resizable, it will be resized to its preferred height and it's width will span the width of the border pane. If the node cannot be resized to fill the top space (it's not resizable or its max size prevents it) then it will be aligned top-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getTop(), setTop(Node)
  - bottom
```
public final <any> bottomProperty
```
    The node placed on the bottom edge of this border pane. If resizable, it will be resized to its preferred height and it's width will span the width of the border pane. If the node cannot be resized to fill the bottom space (it's not resizable or its max size prevents it) then it will be aligned bottom-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getBottom(), setBottom(Node)
  - left
```
public final <any> leftProperty
```
    The node placed on the left edge of this border pane. If resizable, it will be resized to its preferred width and it's height will span the height of the border pane between the top and bottom nodes. If the node cannot be resized to fill the left space (it's not resizable or its max size prevents it) then it will be aligned top-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getLeft(), setLeft(Node)
  - right
```
public final <any> rightProperty
```
    The node placed on the right edge of this border pane. If resizable, it will be resized to its preferred width and it's height will span the height of the border pane between the top and bottom nodes. If the node cannot be resized to fill the right space (it's not resizable or its max size prevents it) then it will be aligned top-right within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getRight(), setRight(Node)
- Field Detail
  - MARGIN
```
private static final java.lang.String MARGIN
```
    BEGIN static methods
    
    See Also:
    
    Constant Field Values
  - ALIGNMENT
```
private static final java.lang.String ALIGNMENT
```
    See Also:
    
    Constant Field Values
  - center
```
private <any> center
```
  - top
```
private <any> top
```
  - bottom
```
private <any> bottom
```
  - left
```
private <any> left
```
  - right
```
private <any> right
```
- Constructor Detail
  - BorderPane
```
public BorderPane()
```
    Creates a BorderPane layout.
  - BorderPane
```
public BorderPane(Node center)
```
    Creates an BorderPane layout with the given Node as the center of the BorderPane.
    
    Parameters:
    
    center - The node to set as the center of the BorderPane.
    
    Since:
    
    JavaFX 8.0
  - BorderPane
```
public BorderPane(Node center,
                  Node top,
                  Node right,
                  Node bottom,
                  Node left)
```
    Creates an BorderPane layout with the given Nodes to use for each of the main layout areas of the Border Pane. The top, right, bottom, and left nodes are listed in clockwise order.
    
    Parameters:
    
    center - The node to set as the center of the BorderPane.
    
    top - The node to set as the top of the BorderPane.
    
    right - The node to set as the right of the BorderPane.
    
    bottom - The node to set as the bottom of the BorderPane.
    
    left - The node to set as the left of the BorderPane.
    
    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 border pane. If set, will override the border pane's default alignment for the child's position. Setting the value to null will remove the constraint.
    
    Parameters:
    
    child - the child node of a border pane
    
    value - the alignment position for the child
  - getAlignment
```
public static Pos getAlignment(Node child)
```
    Returns the child's alignment constraint if set.
    
    Parameters:
    
    child - the child node of a border pane
    
    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 border pane. If set, the border pane will lay it out with the margin space around it. Setting the value to null will remove the constraint.
    
    Parameters:
    
    child - the child node of a border pane
    
    value - the margin of space around the child
  - getMargin
```
public static Insets getMargin(Node child)
```
    Returns the child's margin constraint if set.
    
    Parameters:
    
    child - the child node of a border pane
    
    Returns:
    
    the margin for the child or null if no margin was set
  - getNodeMargin
```
private static Insets getNodeMargin(Node child)
```
  - clearConstraints
```
public static void clearConstraints(Node child)
```
    Removes all border pane constraints from the child node.
    
    Parameters:
    
    child - the child node
  - centerProperty
```
public final <any> centerProperty()
```
    The node placed in the center of this border pane. If resizable, it will be resized fill the center of the border pane between the top, bottom, left, and right nodes. If the node cannot be resized to fill the center space (it's not resizable or its max size prevents it) then it will be center aligned unless the child's alignment constraint has been set.
    
    See Also:
    
    getCenter(), setCenter(Node)
  - setCenter
```
public final void setCenter(Node value)
```
    Sets the value of the property center.
  - getCenter
```
public final Node getCenter()
```
    Gets the value of the property center.
  - topProperty
```
public final <any> topProperty()
```
    The node placed on the top edge of this border pane. If resizable, it will be resized to its preferred height and it's width will span the width of the border pane. If the node cannot be resized to fill the top space (it's not resizable or its max size prevents it) then it will be aligned top-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getTop(), setTop(Node)
  - setTop
```
public final void setTop(Node value)
```
    Sets the value of the property top.
  - getTop
```
public final Node getTop()
```
    Gets the value of the property top.
  - bottomProperty
```
public final <any> bottomProperty()
```
    The node placed on the bottom edge of this border pane. If resizable, it will be resized to its preferred height and it's width will span the width of the border pane. If the node cannot be resized to fill the bottom space (it's not resizable or its max size prevents it) then it will be aligned bottom-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getBottom(), setBottom(Node)
  - setBottom
```
public final void setBottom(Node value)
```
    Sets the value of the property bottom.
  - getBottom
```
public final Node getBottom()
```
    Gets the value of the property bottom.
  - leftProperty
```
public final <any> leftProperty()
```
    The node placed on the left edge of this border pane. If resizable, it will be resized to its preferred width and it's height will span the height of the border pane between the top and bottom nodes. If the node cannot be resized to fill the left space (it's not resizable or its max size prevents it) then it will be aligned top-left within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getLeft(), setLeft(Node)
  - setLeft
```
public final void setLeft(Node value)
```
    Sets the value of the property left.
  - getLeft
```
public final Node getLeft()
```
    Gets the value of the property left.
  - rightProperty
```
public final <any> rightProperty()
```
    The node placed on the right edge of this border pane. If resizable, it will be resized to its preferred width and it's height will span the height of the border pane between the top and bottom nodes. If the node cannot be resized to fill the right space (it's not resizable or its max size prevents it) then it will be aligned top-right within the space unless the child's alignment constraint has been set.
    
    See Also:
    
    getRight(), setRight(Node)
  - setRight
```
public final void setRight(Node value)
```
    Sets the value of the property right.
  - getRight
```
public final Node getRight()
```
    Gets the value of the property right.
  - getContentBias
```
public Orientation getContentBias()
```
    Returns:
    
    null unless the center, right, bottom, left or top has a content bias.
  - 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
    
    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
    
    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
    
    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
    
    Returns:
    
    the computed preferred height for this region
  - layoutChildren
```
protected void layoutChildren()
```
  - getAreaWidth
```
private double getAreaWidth(Node child,
                            double height,
                            boolean minimum)
```
  - getAreaHeight
```
private double getAreaHeight(Node child,
                             double width,
                             boolean minimum)
```
  - childHasContentBias
```
private boolean childHasContentBias(Node child,
                                    Orientation orientation)
```

Class BorderPane

Resizable Range

Optional Layout Constraints

Property Summary

Properties inherited from class javafx.scene.layout.Region

Nested Class Summary

Field Summary

Fields inherited from class javafx.scene.layout.Region

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.layout.Pane

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class java.lang.Object

Property Detail

center

top

bottom

left

right

Field Detail

MARGIN

ALIGNMENT

center

top

bottom

left

right

Constructor Detail

BorderPane

BorderPane

BorderPane

Method Detail

setAlignment

getAlignment

setMargin

getMargin

getNodeMargin

clearConstraints

centerProperty

setCenter

getCenter

topProperty

setTop

getTop

bottomProperty

setBottom

getBottom

leftProperty

setLeft

getLeft

rightProperty

setRight

getRight

getContentBias

computeMinWidth

computeMinHeight

computePrefWidth

computePrefHeight

layoutChildren

getAreaWidth

getAreaHeight

childHasContentBias