Module javafx.graphics
Package javafx.scene.layout

Class TilePane

  • All Implemented Interfaces:
    Styleable, EventTarget
    public class TilePane
extends Pane
    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
    widthheight
    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_VALUEDouble.MAX_VALUE

    Vertical
    widthheight
    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_VALUEDouble.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
    ConstraintTypeDescription
    alignmentjavafx.geometry.PosThe alignment of the child within its tile.
    marginjavafx.geometry.InsetsMargin 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);
     }
    Since:
    JavaFX 2.0

    • Property Detail

      • orientation

        public final ObjectProperty<Orientation> orientationProperty
        The orientation of this tilepane. A horizontal tilepane lays out children in tiles, left to right, wrapping tiles at the tilepane's width boundary. A vertical tilepane lays out children in tiles, top to bottom, wrapping at the tilepane's height. The default is horizontal.
        See Also:
        getOrientation(), setOrientation(Orientation)

      • prefRows

        public final IntegerProperty prefRowsProperty
        The preferred number of rows for a vertical tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a horizontal tilepane.

        It is recommended that the application initialize this value for a vertical tilepane.

        See Also:
        getPrefRows(), setPrefRows(int)

      • prefColumns

        public final IntegerProperty prefColumnsProperty
        The preferred number of columns for a horizontal tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a vertical tilepane.

        It is recommended that the application initialize this value for a horizontal tilepane.

        See Also:
        getPrefColumns(), setPrefColumns(int)

      • prefTileWidth

        public final DoubleProperty prefTileWidthProperty
        The preferred width of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile width wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the widest child. If the application sets this property to value greater than 0, then tiles will be set to that width and the tilepane will attempt to resize children to fit within that width (if they are resizable and their min-max width range allows it).
        See Also:
        getPrefTileWidth(), setPrefTileWidth(double)

      • prefTileHeight

        public final DoubleProperty prefTileHeightProperty
        The preferred height of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile height wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the tallest child. If the application sets this property to value greater than 0, then tiles will be set to that height and the tilepane will attempt to resize children to fit within that height (if they are resizable and their min-max height range allows it).
        See Also:
        getPrefTileHeight(), setPrefTileHeight(double)

      • alignment

        public final ObjectProperty<Pos> alignmentProperty
        The overall alignment of the tilepane's content within its width and height.

        For a horizontal tilepane, each row will be aligned within the tilepane's width using the alignment's hpos value, and the rows will be aligned within the tilepane's height using the alignment's vpos value.

        For a vertical tilepane, each column will be aligned within the tilepane's height using the alignment's vpos value, and the columns will be aligned within the tilepane's width using the alignment's hpos value.

        See Also:
        getAlignment(), setAlignment(Pos)

    • Constructor Detail

      • TilePane

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

      • TilePane

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

      • TilePane

        public TilePane​(double hgap,
                double vgap)
        Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.
        Parameters:
        hgap - the amount of horizontal space between each tile
        vgap - the amount of vertical space between each tile

      • TilePane

        public TilePane​(Orientation orientation,
                double hgap,
                double vgap)
        Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.
        Parameters:
        orientation - the direction the tiles should flow & wrap
        hgap - the amount of horizontal space between each tile
        vgap - the amount of vertical space between each tile

      • TilePane

        public TilePane​(Node... children)
        Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0.
        Parameters:
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

      • TilePane

        public TilePane​(Orientation orientation,
                Node... children)
        Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.
        Parameters:
        orientation - the direction the tiles should flow & wrap
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

      • TilePane

        public TilePane​(double hgap,
                double vgap,
                Node... children)
        Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.
        Parameters:
        hgap - the amount of horizontal space between each tile
        vgap - the amount of vertical space between each tile
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

      • TilePane

        public TilePane​(Orientation orientation,
                double hgap,
                double vgap,
                Node... children)
        Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.
        Parameters:
        orientation - the direction the tiles should flow & wrap
        hgap - the amount of horizontal space between each tile
        vgap - the amount of vertical space between each tile
        children - The initial set of children for this pane.
        Since:
        JavaFX 8.0

    • Method Detail

      • setAlignment

        public static void setAlignment​(Node node,
                                Pos value)
        Sets the alignment for the child when contained by a tilepane. If set, will override the tilepane's default alignment for children within their 'tiles'. Setting the value to null will remove the constraint.
        Parameters:
        node - the child node of a tilepane
        value - the alignment position for the child

      • getAlignment

        public static Pos getAlignment​(Node node)
        Returns the child's alignment constraint if set.
        Parameters:
        node - the child node of a tilepane
        Returns:
        the alignment position for the child or null if no alignment was set

      • setMargin

        public static void setMargin​(Node node,
                             Insets value)
        Sets the margin for the child when contained by a tilepane. If set, the tilepane will layout the child with the margin space around it. Setting the value to null will remove the constraint.
        Parameters:
        node - the child node of a tilepane
        value - the margin of space around the child

      • getMargin

        public static Insets getMargin​(Node node)
        Returns the child's margin constraint if set.
        Parameters:
        node - the child node of a tilepane
        Returns:
        the margin for the child or null if no margin was set

      • clearConstraints

        public static void clearConstraints​(Node child)
        Removes all tilepane constraints from the child node.
        Parameters:
        child - the child node

      • orientationProperty

        public final ObjectProperty<Orientation> orientationProperty()
        The orientation of this tilepane. A horizontal tilepane lays out children in tiles, left to right, wrapping tiles at the tilepane's width boundary. A vertical tilepane lays out children in tiles, top to bottom, wrapping at the tilepane's height. The default is horizontal.
        See Also:
        getOrientation(), setOrientation(Orientation)

      • setOrientation

        public final void setOrientation​(Orientation value)
        Sets the value of the property orientation.
        Property description:
        The orientation of this tilepane. A horizontal tilepane lays out children in tiles, left to right, wrapping tiles at the tilepane's width boundary. A vertical tilepane lays out children in tiles, top to bottom, wrapping at the tilepane's height. The default is horizontal.

      • getOrientation

        public final Orientation getOrientation()
        Gets the value of the property orientation.
        Property description:
        The orientation of this tilepane. A horizontal tilepane lays out children in tiles, left to right, wrapping tiles at the tilepane's width boundary. A vertical tilepane lays out children in tiles, top to bottom, wrapping at the tilepane's height. The default is horizontal.

      • prefRowsProperty

        public final IntegerProperty prefRowsProperty()
        The preferred number of rows for a vertical tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a horizontal tilepane.

        It is recommended that the application initialize this value for a vertical tilepane.

        See Also:
        getPrefRows(), setPrefRows(int)

      • setPrefRows

        public final void setPrefRows​(int value)
        Sets the value of the property prefRows.
        Property description:
        The preferred number of rows for a vertical tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a horizontal tilepane.

        It is recommended that the application initialize this value for a vertical tilepane.

      • getPrefRows

        public final int getPrefRows()
        Gets the value of the property prefRows.
        Property description:
        The preferred number of rows for a vertical tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a horizontal tilepane.

        It is recommended that the application initialize this value for a vertical tilepane.

      • prefColumnsProperty

        public final IntegerProperty prefColumnsProperty()
        The preferred number of columns for a horizontal tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a vertical tilepane.

        It is recommended that the application initialize this value for a horizontal tilepane.

        See Also:
        getPrefColumns(), setPrefColumns(int)

      • setPrefColumns

        public final void setPrefColumns​(int value)
        Sets the value of the property prefColumns.
        Property description:
        The preferred number of columns for a horizontal tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a vertical tilepane.

        It is recommended that the application initialize this value for a horizontal tilepane.

      • getPrefColumns

        public final int getPrefColumns()
        Gets the value of the property prefColumns.
        Property description:
        The preferred number of columns for a horizontal tilepane. This value is used only to compute the preferred size of the tilepane and may not reflect the actual number of rows, which may change if the tilepane is resized to something other than its preferred height. This property is ignored for a vertical tilepane.

        It is recommended that the application initialize this value for a horizontal tilepane.

      • prefTileWidthProperty

        public final DoubleProperty prefTileWidthProperty()
        The preferred width of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile width wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the widest child. If the application sets this property to value greater than 0, then tiles will be set to that width and the tilepane will attempt to resize children to fit within that width (if they are resizable and their min-max width range allows it).
        See Also:
        getPrefTileWidth(), setPrefTileWidth(double)

      • setPrefTileWidth

        public final void setPrefTileWidth​(double value)
        Sets the value of the property prefTileWidth.
        Property description:
        The preferred width of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile width wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the widest child. If the application sets this property to value greater than 0, then tiles will be set to that width and the tilepane will attempt to resize children to fit within that width (if they are resizable and their min-max width range allows it).

      • getPrefTileWidth

        public final double getPrefTileWidth()
        Gets the value of the property prefTileWidth.
        Property description:
        The preferred width of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile width wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the widest child. If the application sets this property to value greater than 0, then tiles will be set to that width and the tilepane will attempt to resize children to fit within that width (if they are resizable and their min-max width range allows it).

      • prefTileHeightProperty

        public final DoubleProperty prefTileHeightProperty()
        The preferred height of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile height wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the tallest child. If the application sets this property to value greater than 0, then tiles will be set to that height and the tilepane will attempt to resize children to fit within that height (if they are resizable and their min-max height range allows it).
        See Also:
        getPrefTileHeight(), setPrefTileHeight(double)

      • setPrefTileHeight

        public final void setPrefTileHeight​(double value)
        Sets the value of the property prefTileHeight.
        Property description:
        The preferred height of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile height wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the tallest child. If the application sets this property to value greater than 0, then tiles will be set to that height and the tilepane will attempt to resize children to fit within that height (if they are resizable and their min-max height range allows it).

      • getPrefTileHeight

        public final double getPrefTileHeight()
        Gets the value of the property prefTileHeight.
        Property description:
        The preferred height of each tile. If equal to USE_COMPUTED_SIZE (the default) the tile height wlll be automatically recomputed by the tilepane when the preferred size of children changes to accommodate the tallest child. If the application sets this property to value greater than 0, then tiles will be set to that height and the tilepane will attempt to resize children to fit within that height (if they are resizable and their min-max height range allows it).

      • getTileWidth

        public final double getTileWidth()
        Gets the value of the property tileWidth.
        Property description:
        The actual width of each tile. This property is read-only.

      • getTileHeight

        public final double getTileHeight()
        Gets the value of the property tileHeight.
        Property description:
        The actual height of each tile. This property is read-only.

      • setHgap

        public final void setHgap​(double value)
        Sets the value of the property hgap.
        Property description:
        The amount of horizontal space between each tile in a row.

      • getHgap

        public final double getHgap()
        Gets the value of the property hgap.
        Property description:
        The amount of horizontal space between each tile in a row.

      • setVgap

        public final void setVgap​(double value)
        Sets the value of the property vgap.
        Property description:
        The amount of vertical space between each tile in a column.

      • getVgap

        public final double getVgap()
        Gets the value of the property vgap.
        Property description:
        The amount of vertical space between each tile in a column.

      • alignmentProperty

        public final ObjectProperty<Pos> alignmentProperty()
        The overall alignment of the tilepane's content within its width and height.

        For a horizontal tilepane, each row will be aligned within the tilepane's width using the alignment's hpos value, and the rows will be aligned within the tilepane's height using the alignment's vpos value.

        For a vertical tilepane, each column will be aligned within the tilepane's height using the alignment's vpos value, and the columns will be aligned within the tilepane's width using the alignment's hpos value.

        See Also:
        getAlignment(), setAlignment(Pos)

      • setAlignment

        public final void setAlignment​(Pos value)
        Sets the value of the property alignment.
        Property description:
        The overall alignment of the tilepane's content within its width and height.

        For a horizontal tilepane, each row will be aligned within the tilepane's width using the alignment's hpos value, and the rows will be aligned within the tilepane's height using the alignment's vpos value.

        For a vertical tilepane, each column will be aligned within the tilepane's height using the alignment's vpos value, and the columns will be aligned within the tilepane's width using the alignment's hpos value.

      • getAlignment

        public final Pos getAlignment()
        Gets the value of the property alignment.
        Property description:
        The overall alignment of the tilepane's content within its width and height.

        For a horizontal tilepane, each row will be aligned within the tilepane's width using the alignment's hpos value, and the rows will be aligned within the tilepane's height using the alignment's vpos value.

        For a vertical tilepane, each column will be aligned within the tilepane's height using the alignment's vpos value, and the columns will be aligned within the tilepane's width using the alignment's hpos value.

      • setTileAlignment

        public final void setTileAlignment​(Pos value)
        Sets the value of the property tileAlignment.
        Property description:
        The default alignment of each child within its tile. This may be overridden on individual children by setting the child's alignment constraint.

      • getTileAlignment

        public final Pos getTileAlignment()
        Gets the value of the property tileAlignment.
        Property description:
        The default alignment of each child within its tile. This may be overridden on individual children by setting the child's alignment constraint.

      • requestLayout

        public void requestLayout()
        Description copied from class: Parent
        Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation.

        If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestParentLayout will be invoked.

        Overrides:
        requestLayout in class Parent

      • 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 forHeight)
        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:
        forHeight - 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 forWidth)
        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:
        forWidth - 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

      • getClassCssMetaData

        public static List<CssMetaData<? extends Styleable,​?>> getClassCssMetaData()
        Returns:
        The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
        Since:
        JavaFX 8.0