A JavaFX application can manually lay out the UI by setting the position and size properties for each UI element. However, an easier option is to make use of layout panes. The JavaFX SDK provides several layout container classes, called panes, for the easy setup and management of classic layouts such as rows, columns, stacks, tiles, and others. As a window is resized, the layout pane automatically repositions and resizes the nodes that it contains according to the properties for the nodes.
This topic provides an overview and a simple example of each of the layout panes provided by the JavaFX layout package. The LayoutSample.java file contains the source code for the UI built in this topic. The LayoutSample.zip
file contains the NetBeans IDE project for the sample application.
The BorderPane
layout pane provides five regions in which to place nodes: top, bottom, left, right, and center. Figure 1-1 shows the type of layout that you can create with a border pane. The regions can be any size. If your application does not need one of the regions, you do not need to define it and no space is allocated for it.
A border pane is useful for the classic look of a tool bar at the top, a status bar at the bottom, a navigation panel on the left, additional information on the right, and a working area in the center.
If the window is larger than the space needed for the contents of each region, the extra space is given to the center region by default. If the window is smaller than the space needed for the contents of each region, the regions might overlap. The overlap is determined by the order in which the regions are set. For example, if the regions are set in the order of left, bottom, and right, when the window is made smaller, the bottom region overlaps the left region and the right region overlaps the bottom region. If set in the order of left, right, and bottom, when the window is made smaller, the bottom region overlaps both the left and right regions.
Example 1-1 shows the code for creating the border pane that is used for the UI that is built by the Layout Sample application. The methods that create the layout panes used in each region are described in the remaining sections of this topic.
Example 1-1 Create a Border Pane
BorderPane border = new BorderPane(); HBox hbox = addHBox() border.setTop(hbox); border.setLeft(addVBox()); addStackPane(hbox); // Add stack to HBox in top region border.setCenter(addGridPane()); border.setRight(addFlowPane());
Note that the bottom region of the border pane is not used in this sample. If you want to add something to the bottom region, use the following statement and replace node with the control of your choice:
border.setBottom(node);
The HBox
layout pane provides an easy way for arranging a series of nodes in a single row.Figure 1-2 shows an example of an HBox
pane.
The padding property can be set to manage the distance between the nodes and the edges of the HBox
pane. Spacing can be set to manage the distance between the nodes. The style can be set to change the background color.
Example 1-2 creates an HBox
pane for a tool bar that contains two buttons.
Example 1-2 Create an HBox Pane
public HBox addHBox() { HBox hbox = new HBox(); hbox.setPadding(new Insets(15, 12, 15, 12)); hbox.setSpacing(10); hbox.setStyle("-fx-background-color: #336699;"); Button buttonCurrent = new Button("Current"); buttonCurrent.setPrefSize(100, 20); Button buttonProjected = new Button("Projected"); buttonProjected.setPrefSize(100, 20); hbox.getChildren().addAll(buttonCurrent, buttonProjected); return hbox; }
The setTop()
method in Example 1-1 adds the HBox
pane to the top region of the border pane. The result is shown in Figure 1-3.
The VBox
layout pane is similar to the HBox
layout pane, except that the nodes are arranged in a single column. Figure 1-4 shows an example of a VBox
pane.
The padding property can be set to manage the distance between the nodes and the edges of the VBox
pane. Spacing can be set to manage the distance between the nodes. Margins can be set to add additional space around individual controls.
Example 1-3 creates a VBox
pane for a list of options.
Example 1-3 Create a VBox Pane
public VBox addVBox(); { VBox vbox = new VBox(); vbox.setPadding(new Insets(10)); vbox.setSpacing(8); Text title = new Text("Data"); title.setFont(Font.font("Arial", FontWeight.BOLD, 14)); vbox.getChildren().add(title); Hyperlink options[] = new Hyperlink[] { new Hyperlink("Sales"), new Hyperlink("Marketing"), new Hyperlink("Distribution"), new Hyperlink("Costs")}; for (int i=0; i<4; i++) { VBox.setMargin(options[i], new Insets(0, 0, 0, 8)); vbox.getChildren().add(options[i]); } return vbox; }
The setLeft()
method in Example 1-1 adds the VBox
pane to the left region of the border pane. The result is shown in Figure 1-5.
The StackPane
layout pane places all of the nodes within a single stack with each new node added on top of the previous node. This layout model provides an easy way to overlay text on a shape or image or to overlap common shapes to create a complex shape. Figure 1-6 shows a help icon that is created by stacking a question mark on top of a rectangle with a gradient background.
The alignment property can be set to manage how children are positioned in the stack pane. This property affects all children, so margins can be set to adjust the position of individual children in the stack.
Example 1-4 creates a stack pane for a help icon.
Example 1-4 Create a Stack Pane
public void addStackPane(HBox hb) { StackPane stack = new StackPane(); Rectangle helpIcon = new Rectangle(30.0, 25.0); helpIcon.setFill(new LinearGradient(0,0,0,1, true, CycleMethod.NO_CYCLE, new Stop[]{ new Stop(0,Color.web("#4977A3")), new Stop(0.5, Color.web("#B0C6DA")), new Stop(1,Color.web("#9CB6CF")),})); helpIcon.setStroke(Color.web("#D0E6FA")); helpIcon.setArcHeight(3.5); helpIcon.setArcWidth(3.5); Text helpText = new Text("?"); helpText.setFont(Font.font("Verdana", FontWeight.BOLD, 18)); helpText.setFill(Color.WHITE); helpText.setStroke(Color.web("#7080A0")); stack.getChildren().addAll(helpIcon, helpText); stack.setAlignment(Pos.CENTER_RIGHT); // Right-justify nodes in stack StackPane.setMargin(helpText, new Insets(0, 10, 0, 0)); // Center "?" hb.getChildren().add(stack); // Add to HBox from Example 1-2 HBox.setHgrow(stack, Priority.ALWAYS); // Give stack any extra space }
The last lines of code in Example 1-4 add the stack pane to the HBox
pane created in Example 1-2 and position it to always be at the right-most edge of the pane. The result is shown inFigure 1-7.
The GridPane
layout pane enables you to create a flexible grid of rows and columns in which to lay out nodes. Nodes can be placed in any cell in the grid and can span cells as needed. A grid pane is useful for creating forms or any layout that is organized in rows and columns. Figure 1-8 shows a grid pane that contains an icon, title, subtitle, text and a pie chart. In this figure, thegridLinesVisible
property is set to display grid lines, which show the rows and columns and the gaps between the rows and columns. This property is useful for visually debugging yourGridPane
layouts.
Gap properties can be set to manage the spacing between the rows and columns. The padding property can be set to manage the distance between the nodes and the edges of the grid pane. The vertical and horizontal alignment properties can be set to manage the alignment of individual controls in a cell.
Example 1-5 creates the grid pane shown in Figure 1-8.
Example 1-5 Create a Grid Pane
public GridPane addGridPane() { GridPane grid = new GridPane(); grid.setHgap(10); grid.setVgap(10); grid.setPadding(new Insets(0, 10, 0, 10)); // Category in column 2, row 1 Text category = new Text("Sales:"); category.setFont(Font.font("Arial", FontWeight.BOLD, 20)); grid.add(category, 1, 0); // Title in column 3, row 1 Text chartTitle = new Text("Current Year"); chartTitle.setFont(Font.font("Arial", FontWeight.BOLD, 20)); grid.add(chartTitle, 2, 0); // Subtitle in columns 2-3, row 2 Text chartSubtitle = new Text("Goods and Services"); grid.add(chartSubtitle, 1, 1, 2, 1); // House icon in column 1, rows 1-2 ImageView imageHouse = new ImageView( new Image(LayoutSample.class.getResourceAsStream("graphics/house.png"))); grid.add(imageHouse, 0, 0, 1, 2); // Left label in column 1 (bottom), row 3 Text goodsPercent = new Text("Goods\n80%"); GridPane.setValignment(goodsPercent, VPos.BOTTOM); grid.add(goodsPercent, 0, 2); // Chart in columns 2-3, row 3 ImageView imageChart = new ImageView( new Image(LayoutSample.class.getResourceAsStream("graphics/piechart.png"))); grid.add(imageChart, 1, 2, 2, 1); // Right label in column 4 (top), row 3 Text servicesPercent = new Text("Services\n20%"); GridPane.setValignment(servicesPercent, VPos.TOP); grid.add(servicesPercent, 3, 2); return grid; }
The setCenter()
method in Example 1-1 adds the grid pane to the center region of the border pane. The result is shown in Figure 1-9.
As the window is resized, the nodes within the grid pane are resized according to their layout constraints.
The nodes within a FlowPane
layout pane are laid out consecutively and wrap at the boundary set for the pane. Nodes can flow vertically (in columns) or horizontally (in rows). A vertical flow pane wraps at the height boundary for the pane. A horizontal flow pane wraps at the width boundary for the pane. Figure 1-10 shows a sample horizontal flow pane using numbered icons. By contrast, in a vertical flow pane, column one would contain pages one through four and column two would contain pages five through eight.
Gap properties can be set to manage the spacing between the rows and columns. The padding property can be set to manage the distance between the nodes and the edges of the pane.Example 1-6 creates a horizontal flow pane for a series of page icons.
Example 1-6 Create a Flow Pane
public FlowPane addFlowPane() { FlowPane flow = new FlowPane(); flow.setPadding(new Insets(5, 0, 5, 0)); flow.setVgap(4); flow.setHgap(4); flow.setPrefWrapLength(170); // preferred width allows for two columns flow.setStyle("-fx-background-color: DAE6F3;"); ImageView pages[] = new ImageView[8]; for (int i=0; i<8; i++) { pages[i] = new ImageView( new Image(LayoutSample.class.getResourceAsStream( "graphics/chart_"+(i+1)+".png"))); flow.getChildren().add(pages[i]); } return flow; }
The setRight()
method in Example 1-1 adds the flow pane to the right region of the border pane. The result is shown in Figure 1-11.
A tile pane is similar to a flow pane. The TilePane
layout pane places all of the nodes in a grid in which each cell, or tile, is the same size. Nodes can be laid out horizontally (in rows) or vertically (in columns). Horizontal tiling wraps the tiles at the tile pane's width boundary and vertical tiling wraps them at the height boundary. Use the prefColumns
and prefRows
properties to establish the preferred size of the tile pane.
Gap properties can be set to manage the spacing between the rows and columns. The padding property can be set to manage the distance between the nodes and the edges of the pane.
Example 1-7 creates a horizontal tile pane that produces the same layout shown in Figure 1-10.
Example 1-7 Create a Tile Pane
TilePane tile = new TilePane(); tile.setPadding(new Insets(5, 0, 5, 0)); tile.setVgap(4); tile.setHgap(4); tile.setPrefColumns(2); tile.setStyle("-fx-background-color: DAE6F3;"); ImageView pages[] = new ImageView[8]; for (int i=0; i<8; i++) { pages[i] = new ImageView( new Image(LayoutSample.class.getResourceAsStream( "graphics/chart_"+(i+1)+".png"))); tile.getChildren().add(pages[i]); }
The AnchorPane
layout pane enables you to anchor nodes to the top, bottom, left side, right side, or center of the pane. As the window is resized, the nodes maintain their position relative to their anchor point. Nodes can be anchored to more than one position and more than one node can be anchored to the same position. Figure 1-12 shows an anchor pane with the grid pane from GridPane anchored to the top and an HBox
pane with two buttons anchored to the bottom and the right side.
Example 1-8 creates an anchor pane with a node anchored to the top of the pane and a node anchored to the bottom right of the pane. The grid that was created in Example 1-5 is used for the top node.
Example 1-8 Create an Anchor Pane
public AnchorPane addAnchorPane(GridPane grid) { AnchorPane anchorpane = new AnchorPane(); Button buttonSave = new Button("Save"); Button buttonCancel = new Button("Cancel"); HBox hb = new HBox(); hb.setPadding(new Insets(0, 10, 10, 10)); hb.setSpacing(10); hb.getChildren().addAll(buttonSave, buttonCancel); anchorpane.getChildren().addAll(grid,hb); // Add grid from Example 1-5 AnchorPane.setBottomAnchor(hb, 8.0); AnchorPane.setRightAnchor(hb, 5.0); AnchorPane.setTopAnchor(grid, 10.0); return anchorpane; }
The following statement replaces the center region of the border pane with the anchor pane:
border.setCenter(addAnchorPane(addGridPane()));
The result is shown in Figure 1-13.
As the window is resized, the nodes maintain their position in the pane according to their anchor points. Figure 1-14 shows how the buttons, which are anchored to the bottom of the pane, move closer to the sales information as the window is made smaller.
Figure 1-14 Resized Anchor Pane
Description of "Figure 1-14 Resized Anchor Pane"
A main advantage of using the built-in JavaFX layout panes is that the size and alignment of nodes is handled by the pane. As the pane is resized, the nodes are resized according to their preferred size range preferences. Note that not all node classes are resizable. UI controls and layout panes are resizable, but shapes, Text
objects, and Group
objects are not resizable and are treated as rigid objects in a layout.
If you want more control over the size of controls in your UI, you can set their preferred size range directly. The layout pane then uses your settings to determine the size of the control. To manage the position of the controls, you can use the alignment properties for the layout panes.
This topic provides simple examples for sizing and aligning nodes in a pane. TheLayoutSizingAligning.java file contains the source code for the samples described in this topic. The LayoutSizingAligning.zip
file contains the NetBeans IDE project for the sample.
Layouts query the preferred size of their nodes by invoking the prefWidth(height)
andprefHeight(width)
methods. By default, UI controls compute default values for their preferred size that is based on the content of the control. For example, the computed size of a Button
object is determined by the length of the text and the size of the font used for the label, plus the size of any image. Typically, the computed size is just big enough for the control and the label to be fully visible.
UI controls also provide default minimum and maximum sizes that are based on the typical usage of the control. For example, the maximum size of a Button
object defaults to its preferred size because you don't usually want buttons to grow arbitrarily large. However, the maximum size of a ScrollPane
object is unbounded because typically you do want them to grow to fill their spaces.
You can use the default size constraints of nodes, or you can set them to provide the look that you want. For example, Figure 2-1 shows the default size of several buttons and a list view in a border pane.
Suppose that the look that you want is the screen shown in Figure 2-2, which shows the UI controls sized according to desired constraints.
Applications often need to directly set the minimum, preferred, and maximum size constraints on controls. The following sections provide tips for overriding the computed sizes to get the look that you want.
You can go through the trouble of determining the height and width of each button and then setting the preferred size of each button to the greatest height and width of the buttons in the set. An easier option is to let the layout panes do the work. The layout pane that you want to use is determined by the effect that you want to achieve.
The scene in Figure 2-1 uses a VBox
layout pane for the buttons on the right and uses the computed sizes for the buttons. The buttons already have the same height, so only the width needs to be changed.
The scene in Figure 2-2 uses a VBox
pane to take advantage of the default behavior that makes the width of the VBox
pane the same as the preferred width of its widest element. To enable all of the buttons to be resized to the width of the VBox
pane, the maximum width of each button is set to the Double.MAX_VALUE
constant, which enables a control to grow without limit. An alternative to using the maximum value constant is to set the maximum width to a specific value, such as 80.0.
Example 2-1 shows how to make a column of buttons the same width using a VBox
pane.
Example 2-1 Set a Column of Buttons to the Same Width
BorderPane border = new BorderPane(); border.setPadding(new Insets(20, 0, 20, 20)); Button btnAdd = new Button("Add"); Button btnDelete = new Button("Delete"); Button btnMoveUp = new Button("Move Up"); Button btnMoveDown = new Button("Move Down"); btnAdd.setMaxWidth(Double.MAX_VALUE); btnDelete.setMaxWidth(Double.MAX_VALUE); btnMoveUp.setMaxWidth(Double.MAX_VALUE); btnMoveDown.setMaxWidth(Double.MAX_VALUE); VBox vbButtons = new VBox(); vbButtons.setSpacing(10); vbButtons.setPadding(new Insets(0, 20, 10, 20)); vbButtons.getChildren().addAll(btnAdd, btnDelete, btnMoveUp, btnMoveDown);
In the Layout Sizing and Aligning sample, the elements of the UI are laid out using a border pane. The column of buttons is put in the right region of the border pane to limit the size of the buttons to the preferred width of the widest button. The center region of a border pane expands to fill any space available so if you put the VBox
pane in the center region, the VBox
pane and the buttons also expand.
The scene in Figure 2-1 uses an HBox
layout pane for the buttons on the bottom and uses the computed sizes for those buttons. The buttons have different widths and heights.
The scene in Figure 2-2 uses a horizontal TilePane
layout pane to take advantage of the default behavior that makes each cell (tile) the same size. The size of each tile is the size needed to hold the preferred size of the largest node in the tile pane.
To enable the buttons to be resized to the size of the tile, set the maximum width and height to the Double.MAX_VALUE
constant. Example 2-2 shows how make a row of buttons the same width and height using a tile pane.
Example 2-2 Set a Row of Buttons to the Same Size
Button btnApply = new Button("Apply"); Button btnContinue = new Button("Continue"); Button btnExit = new Button("Exit"); btnExit.setStyle("-fx-font-size: 15pt;"); btnApply.setMaxSize(Double.MAX_VALUE, Double.MAX_VALUE); btnContinue.setMaxSize(Double.MAX_VALUE, Double.MAX_VALUE); btnExit.setMaxSize(Double.MAX_VALUE, Double.MAX_VALUE); TilePane tileButtons = new TilePane(Orientation.HORIZONTAL); tileButtons.setPadding(new Insets(20, 10, 20, 0)); tileButtons.setHgap(10.0); tileButtons.setVGap(8.0); tileButtons.getChildren().addAll(btnApply, btnContinue, btnExit);
Tiles are not resized as the window size changes so the buttons don't change size when set in a tile pane. Note that if the width of the window is reduced, the buttons in the tile pane change position, but do not get smaller.
As a stage is resized, layout panes within the stage might have more or less space to allocate to the controls that they contain. Each layout pane has its own rules for allocating space according to the minimum, preferred, and maximum size ranges of the controls.In general, controls that have a default maximum size of Double.MAX_VALUE
expand to fill their space while controls with constrained maximum sizes do not expand. For example, a ListView
object has an unbounded maximum. If you want to limit the height to its preferred size, you can set the maximum size to the Control.USE_PREF_SIZE
constant, as shown in Example 2-3.
Example 2-3 Set Maximum Height to Preferred Height
ListView<String> lvList = new ListView<String>(); ObservableList<String> items = FXCollections.observableArrayList ( "Hot dog", "Hamburger", "French fries", "Carrot sticks", "Chicken salad"); lvList.setItems(items); lvList.setMaxHeight(Control.USE_PREF_SIZE);
By default, buttons grow only to their preferred size. However, buttons shrink to where the label is shown as three dots (...) if the minimum width is not overridden. To prevent a button from becoming smaller than its preferred width, set its minimum width to its preferred width as shown in Example 2-4.
Example 2-4 Set Minimum Width to Preferred Width
Button btnMoveDown = new Button("Move Down"); btnMoveDown.setMinWidth(Control.USE_PREF_SIZE);
The preferred size of a control is initially based on the computed size. You can override the default preferred size by setting the preferred size constraint to the size of your choice. The following statement overrides the preferred width of a list view:
lvList.setPrefWidth(150.0);
If you do not want the size of a node to change, set the minimum, maximum, and preferred sizes to the same size. To prevent only the width or height from changing, set the width or height constraints to the same value. In Example 2-5, a list is created with all size constraints set to the same width and height values so that the size of the list doesn't change as the size of the window changes. A button is created with all width constraints set to the same value.
Example 2-5 Set Size Constraints to Prevent Resizing
ListView<String> lvList = new ListView<String>(); lvList.setMinSize(150.0, Control.USE_PREF_SIZE); lvList.setMaxSize(150.0, Control.USE_PREF_SIZE); Button btnDelete = new Button("Delete"); btnDelete.setMinWidth(80.0); btnDelete.setPrefWidth(80.0); btnDelete.setMaxWidth(80.0);
Each layout pane has a default way of aligning the nodes within the pane. For example, in HBox
and VBox
layout panes, nodes are top-justified and left-justified. In TilePane
and FlowPane
layout panes, nodes are centered. The panes themselves by default are typically top-justified and left-justified.
You can manage the alignment of nodes and panes by using the setAlignment()
method for the panes. Alignment constants are available in the following enum
types in thejavafx.geometry
package:
HPos
- Values for specifying horizontal alignment.
Pos
- Values for specifying vertical and horizontal alignment. The value to the left of the underscore specifies the vertical alignment, the value to the right of the underscore specifies the horizontal alignment. For example, Pos.BOTTOM_LEFT
aligns a node at the bottom of the space vertically and at the left edge of the space horizontally.
VPos
- Values for specifying vertical alignment.
Figure 2-3 is created by the code shown in Example 2-6. Without any alignment constraints specified, the layout pane is placed in the top left corner.
Example 2-6 Create a UI with Default Alignment
GridPane grid = new GridPane(); grid.setHgap(10); grid.setVgap(12); HBox hbButtons = new HBox(); hbButtons.setSpacing(10.0); Button btnSubmit = new Button("Submit"); Button btnClear = new Button("Clear"); Button btnExit = new Button("Exit"); btnSubmit.setStyle("-fx-font-size: 15pt;"); Label lblName = new Label("User name:"); TextField tfName = new TextField(); Label lblPwd = new Label("Password:"); PasswordField pfPwd = new PasswordField(); hbButtons.getChildren().addAll(btnSubmit, btnClear, btnExit); grid.add(lblName, 0, 0); grid.add(tfName, 1, 0); grid.add(lblPwd, 0, 1); grid.add(pfPwd, 1, 1); grid.add(hbButtons, 0, 2, 2, 1); }
Suppose the look that you want is the screen shown in Figure 2-4, which centers the layout pane in the screen and changes the default alignment of the controls.
The following sections provide tips for overriding the default positions.
To center the grid from Example 2-6 in the scene, use the following statement:
grid.setAlignment(Pos.CENTER);
In the desired layout, the labels are right-justified and the fields are left-justified. To achieve this in a grid, define each column using the ColumnConstraints
class and set the horizontal alignment constraint. Example 2-7 defines the columns for the grid from Example 2-6.
Example 2-7 Define the Columns in the Grid
GridPane grid = new GridPane(); grid.setAlignment(Pos.CENTER); grid.setHgap(10); grid.setVgap(12); ColumnConstraints column1 = new ColumnConstraints(); column1.setHalignment(HPos.RIGHT); grid.getColumnConstraints().add(column1); ColumnConstraints column2 = new ColumnConstraints(); column2.setHalignment(HPos.LEFT); grid.getColumnConstraints().add(column2);
An alternative for right-justifying controls in a column is to use a VBox
layout pane. Use thesetAlignment()
method as shown in the following statements:
VBox vbox = new VBox; vbox.setAlignment(Pos.CENTER_RIGHT);
The buttons are laid out in an HBox
layout pane that spans both columns in the grid. The following statement centers the buttons in the grid from Example 2-6:
hbButtons.setAlignment(Pos.CENTER);
The setAlignment()
method for the HBox
pane centers the HBox
pane within its layout area and also centers the nodes within the HBox
pane. You might prefer to center the HBox
pane within the row but bottom-justify the buttons within the HBox
pane as shown in Figure 2-5.
Figure 2-5 Override Positions and Bottom-Justify the Buttons
For this arrangement, place the HBox
pane in an inner grid with a single cell and place that grid in the third row of the outer grid. Set the alignment constraint for the inner grid to center the grid and set the alignment constraint for the HBox
pane to bottom-justify the contents as shown in Example 2-8.
Example 2-8 Center and Bottom-Justify the Buttons
hbButtons.setAlignment(Pos.BOTTOM_CENTER); hbButtons.getChildren().addAll(btnSubmit, btnClear, btnExit); GridPane innergrid = new GridPane(); innergrid.setAlignment(Pos.CENTER); innergrid.add(hbButtons, 0, 0); grid.add(innergrid, 0, 2, 2, 1);