TilePane lays out its children in a grid of uniformly sized "tiles".

A horizontal tilepane (the default) will tile nodes in rows, wrapping at the tilepane's width. A vertical tilepane will tile nodes in columns, wrapping at the tilepane's height.

The size of each "tile" defaults to the size needed to encompass the largest preferred width and height of the tilepane's children and the tilepane will recompute the size of the tiles as needed to accommodate the largest preferred size of its children as it changes. The application may also control the size of the tiles directly by setting prefTileWidth/prefTileHeight properties to a value other than USE_COMPUTED_SIZE (the default).

Applications should initialize either prefColumns (for horizontal) or prefRows (for vertical) to establish the tilepane's preferred size (the arbitrary default is 5). Note that prefColumns/prefRows is used only for calculating the preferred size and may not reflect the actual number of rows or columns, which may change as the tilepane is resized and the tiles are wrapped at its actual boundaries.

The alignment property controls how the rows and columns are aligned within the bounds of the tilepane and defaults to Pos.TOP_LEFT. It is also possible to control the alignment of nodes within the individual tiles by setting tileAlignment, which defaults to Pos.CENTER.

A horizontal tilepane example:

TilePane tile = new TilePane();
   tile.setHgap(8);
   tile.setPrefColumns(4);
   for (int i = 0; i < 20; i++) {
       tile.getChildren().add(new ImageView(...));
   }

A vertical TilePane example:

TilePane tile = new TilePane(Orientation.VERTICAL);
   tile.setTileAlignment(Pos.CENTER_LEFT);
   tile.setPrefRows(10);
   for (int i = 0; i < 50; i++) {
       tile.getChildren().add(new ImageView(...));
   }

The TilePane will attempt to resize each child to fill its tile. If the child could not be sized to fill the tile (either because it was not resizable or its size limits prevented it) then it will be aligned within the tile using tileAlignment.

Resizable Range

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

Horizontal
	width	height
minimum	left/right insets plus the tile width.	top/bottom insets plus height required to display all tiles when wrapped at a specified width with a vgap between each row.
preferred	left/right insets plus prefColumns multiplied by the tile width.	top/bottom insets plus height required to display all tiles when wrapped at a specified width with a vgap between each row.
maximum	Double.MAX_VALUE	Double.MAX_VALUE

Vertical
	width	height
minimum	left/right insets plus width required to display all tiles when wrapped at a specified height with an hgap between each column.	top/bottom insets plus the tile height.
preferred	left/right insets plus width required to display all tiles when wrapped at the specified height with an hgap between each column.	top/bottom insets plus prefRows multiplied by the tile height.
maximum	Double.MAX_VALUE	Double.MAX_VALUE

A tilepane'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.

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


    tilePane.setMaxWidth(500);

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

TilePane does not clip its content by default, so it is possible that children's' bounds may extend outside the tiles (and possibly the tilepane bounds) if a child's pref size prevents it from being fit within its tile. Also, if the tilepane is resized smaller than its preferred size, it may not be able to fit all the tiles within its bounds and the content will extend outside.

Optional Layout Constraints

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

TilePane Constraint Table
Constraint	Type	Description
alignment	javafx.geometry.Pos	The alignment of the child within its tile.
margin	javafx.geometry.Insets	Margin space around the outside of the child.

Example:

TilePane tilepane = new TilePane();
    for (int i = 0; i < 20; i++) {
       Label title = new Label(imageTitle[i]):
       Imageview imageview = new ImageView(new Image(imageName[i]));
       TilePane.setAlignment(label, Pos.BOTTOM_RIGHT);
       tilepane.getChildren().addAll(title, imageview);
    }

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	TilePane.StyleableProperties
private abstract class	TilePane.TileSizeProperty

Field Summary

Modifier and Type	Field and Description
private double	_tileHeight
private double	_tileWidth
private int	actualColumns
private int	actualRows
private ObjectProperty<Pos>	alignment
private static final String	ALIGNMENT_CONSTRAINT
private DoubleProperty	hgap
private static final String	MARGIN_CONSTRAINT
private static final Callback<Node, Insets>	marginAccessor
private ObjectProperty<Orientation>	orientation
private IntegerProperty	prefColumns
private IntegerProperty	prefRows
private DoubleProperty	prefTileHeight
private DoubleProperty	prefTileWidth
private ObjectProperty<Pos>	tileAlignment
private TilePane.TileSizeProperty	tileHeight
private TilePane.TileSizeProperty	tileWidth
private DoubleProperty	vgap

Constructor Summary

Access	Constructor and Description
public	TilePane() Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0.
public	TilePane(Orientation the direction the tiles should flow & wrap orientation) Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.
public	TilePane(double the amount of horizontal space between each tile hgap, double the amount of vertical space between each tile vgap) Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.
public	TilePane(Orientation the direction the tiles should flow & wrap orientation, double the amount of horizontal space between each tile hgap, double the amount of vertical space between each tile vgap) Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.
public	TilePane(Node... The initial set of children for this pane. children) Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0.
public	TilePane(Orientation the direction the tiles should flow & wrap orientation, Node... The initial set of children for this pane. children) Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.
public	TilePane(double the amount of horizontal space between each tile hgap, double the amount of vertical space between each tile vgap, Node... The initial set of children for this pane. children) Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.
public	TilePane(Orientation the direction the tiles should flow & wrap orientation, double the amount of horizontal space between each tile hgap, double the amount of vertical space between each tile vgap, Node... The initial set of children for this pane. children) Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Pos>	Returns: the overall alignment of the tilepane's content within its width and height alignmentProperty() The overall alignment of the tilepane's content within its width and height.
public static void	clearConstraints(Node the child node child) Removes all tilepane constraints from the child node.
private int	computeColumns(double width, double tilewidth)
private double	computeContentHeight(int rows, double tileheight)
private double	computeContentWidth(int columns, double tilewidth)
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.
private int	computeOther(int numNodes, int numCells)
protected double	computePrefHeight(double forWidth) 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 forHeight) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
private int	computeRows(double height, double tileheight)
private double	computeTileHeight()
private double	computeTileWidth()
public static Pos	Returns: the alignment position for the child or null if no alignment was set getAlignment(Node the child node of a tilepane node) Returns the child's alignment constraint if set.
public final Pos	getAlignment()
private Pos	getAlignmentInternal()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.layout.Region.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public Orientation	getContentBias() Overrides javafx.scene.Node.getContentBias. Returns the orientation of a node's resizing bias for layout purposes.
public List<CssMetaData<? extends Styleable, ?>>	getCssMetaData() Overrides javafx.scene.layout.Region.getCssMetaData. Implements javafx.css.Styleable.getCssMetaData. This method should delegate to `Node#getClassCssMetaData()` so that a Node's CssMetaData can be accessed without the need for reflection.
public final double	getHgap()
public static Insets	Returns: the margin for the child or null if no margin was set getMargin(Node the child node of a tilepane node) Returns the child's margin constraint if set.
public final Orientation	getOrientation()
public final int	getPrefColumns()
public final int	getPrefRows()
public final double	getPrefTileHeight()
public final double	getPrefTileWidth()
public final Pos	getTileAlignment()
private Pos	getTileAlignmentInternal()
public final double	getTileHeight()
public final double	getTileWidth()
public final double	getVgap()
public final DoubleProperty	Returns: the amount of horizontal space between each tile in a row hgapProperty() The amount of horizontal space between each tile in a row.
private void	invalidateTileHeight()
private void	invalidateTileWidth()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
public final ObjectProperty<Orientation>	Returns: the orientation of this tilepane orientationProperty() The orientation of this tilepane.
public final IntegerProperty	Returns: the preferred number of columns for a horizontal tilepane prefColumnsProperty() The preferred number of columns for a horizontal tilepane.
public final IntegerProperty	Returns: the preferred number of rows for a vertical tilepane prefRowsProperty() The preferred number of rows for a vertical tilepane.
public final DoubleProperty	Returns: the preferred height of each tile prefTileHeightProperty() The preferred height of each tile.
public final DoubleProperty	Returns: the preferred width of each tile prefTileWidthProperty() The preferred width of each tile.
public void	requestLayout() Overrides javafx.scene.Parent.requestLayout. Requests a layout pass to be performed before the next scene is rendered.
public static void	setAlignment(Node the child node of a tilepane node, Pos the alignment position for the child value) Sets the alignment for the child when contained by a tilepane.
public final void	setAlignment(Pos value)
public final void	setHgap(double value)
public static void	setMargin(Node the child node of a tilepane node, Insets the margin of space around the child value) Sets the margin for the child when contained by a tilepane.
public final void	setOrientation(Orientation value)
public final void	setPrefColumns(int value)
public final void	setPrefRows(int value)
public final void	setPrefTileHeight(double value)
public final void	setPrefTileWidth(double value)
public final void	setTileAlignment(Pos value)
public final void	setVgap(double value)
public final ObjectProperty<Pos>	Returns: the default alignment of each child within its tile tileAlignmentProperty() The default alignment of each child within its tile.
public final ReadOnlyDoubleProperty	Returns: the actual height of each tile tileHeightProperty() The actual height of each tile.
public final ReadOnlyDoubleProperty	Returns: the actual width of each tile tileWidthProperty() The actual width of each tile.
public final DoubleProperty	Returns: the amount of vertical space between each tile in a column vgapProperty() The amount of vertical space between each tile in a column.

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

Field Detail

_tileHeight	back to summary
private double _tileHeight

_tileWidth	back to summary
private double _tileWidth

actualColumns	back to summary
private int actualColumns

actualRows	back to summary
private int actualRows

alignment	back to summary
private ObjectProperty<Pos> alignment

ALIGNMENT_CONSTRAINT	back to summary
private static final String ALIGNMENT_CONSTRAINT

hgap	back to summary
private DoubleProperty hgap

MARGIN_CONSTRAINT	back to summary
private static final String MARGIN_CONSTRAINT

marginAccessor	back to summary
private static final Callback<Node, Insets> marginAccessor

orientation	back to summary
private ObjectProperty<Orientation> orientation

prefColumns	back to summary
private IntegerProperty prefColumns

prefRows	back to summary
private IntegerProperty prefRows

prefTileHeight	back to summary
private DoubleProperty prefTileHeight

prefTileWidth	back to summary
private DoubleProperty prefTileWidth

tileAlignment	back to summary
private ObjectProperty<Pos> tileAlignment

tileHeight	back to summary
private TilePane.TileSizeProperty tileHeight

tileWidth	back to summary
private TilePane.TileSizeProperty tileWidth

vgap	back to summary
private DoubleProperty vgap

Constructor Detail

TilePane	back to summary
public TilePane() Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0.

TilePane	back to summary
public TilePane(Orientation orientation) Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0. Parameters orientation:Orientation the direction the tiles should flow & wrap

TilePane

Modifier and Type	Field and Description
private static final CssMetaData<TilePane, Pos>	ALIGNMENT
private static final CssMetaData<TilePane, Number>	HGAP
private static final CssMetaData<TilePane, Orientation>	ORIENTATION
private static final CssMetaData<TilePane, Number>	PREF_COLUMNS
private static final CssMetaData<TilePane, Number>	PREF_ROWS
private static final CssMetaData<TilePane, Number>	PREF_TILE_HEIGHT
private static final CssMetaData<TilePane, Number>	PREF_TILE_WIDTH
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES
private static final CssMetaData<TilePane, Pos>	TILE_ALIGNMENT
private static final CssMetaData<TilePane, Number>	VGAP

Modifier and Type	Field and Description
private final String	name
private boolean	valid
private double	value

Modifier and Type	Method and Description
public abstract double	compute()
public double	get() Implements javafx.beans.value.ObservableDoubleValue.get. Returns the current value of this `ObservableDoubleValue`.
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.
public void	invalidate()

public Class TilePane

Resizable Range

Optional Layout Constraints

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class TilePane.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private abstract Class TilePane.TileSizeProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail