- All Implemented Interfaces:
Styleable
,EventTarget
public class TilePane extends Pane
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.
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 |
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.
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);
}
- Since:
- JavaFX 2.0
-
Property Summary
Properties Type Property Description ObjectProperty<Pos>
alignment
The overall alignment of the tilepane's content within its width and height.DoubleProperty
hgap
The amount of horizontal space between each tile in a row.ObjectProperty<Orientation>
orientation
The orientation of this tilepane.IntegerProperty
prefColumns
The preferred number of columns for a horizontal tilepane.IntegerProperty
prefRows
The preferred number of rows for a vertical tilepane.DoubleProperty
prefTileHeight
The preferred height of each tile.DoubleProperty
prefTileWidth
The preferred width of each tile.ObjectProperty<Pos>
tileAlignment
The default alignment of each child within its tile.ReadOnlyDoubleProperty
tileHeight
The actual height of each tile.ReadOnlyDoubleProperty
tileWidth
The actual width of each tile.DoubleProperty
vgap
The amount of vertical space between each tile in a column.Properties inherited from class javafx.scene.layout.Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width
Properties inherited from class javafx.scene.Parent
needsLayout
Properties inherited from class javafx.scene.Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible
-
Field Summary
Fields inherited from class javafx.scene.layout.Region
USE_COMPUTED_SIZE, USE_PREF_SIZE
Fields inherited from class javafx.scene.Node
BASELINE_OFFSET_SAME_AS_HEIGHT
-
Constructor Summary
Constructors Constructor Description TilePane()
Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0.TilePane(double hgap, double vgap)
Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.TilePane(double hgap, double vgap, Node... children)
Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.TilePane(Orientation orientation)
Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.TilePane(Orientation orientation, double hgap, double vgap)
Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.TilePane(Orientation orientation, double hgap, double vgap, Node... children)
Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.TilePane(Orientation orientation, Node... children)
Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.TilePane(Node... children)
Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0. -
Method Summary
Modifier and Type Method Description ObjectProperty<Pos>
alignmentProperty()
The overall alignment of the tilepane's content within its width and height.static void
clearConstraints(Node child)
Removes all tilepane 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 forWidth)
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)
Computes the preferred width of this region for the given height.Pos
getAlignment()
Gets the value of the property alignment.static Pos
getAlignment(Node node)
Returns the child's alignment constraint if set.static List<CssMetaData<? extends Styleable,?>>
getClassCssMetaData()
Orientation
getContentBias()
Returns the orientation of a node's resizing bias for layout purposes.List<CssMetaData<? extends Styleable,?>>
getCssMetaData()
This method should delegate toNode.getClassCssMetaData()
so that a Node's CssMetaData can be accessed without the need for reflection.double
getHgap()
Gets the value of the property hgap.static Insets
getMargin(Node node)
Returns the child's margin constraint if set.Orientation
getOrientation()
Gets the value of the property orientation.int
getPrefColumns()
Gets the value of the property prefColumns.int
getPrefRows()
Gets the value of the property prefRows.double
getPrefTileHeight()
Gets the value of the property prefTileHeight.double
getPrefTileWidth()
Gets the value of the property prefTileWidth.Pos
getTileAlignment()
Gets the value of the property tileAlignment.double
getTileHeight()
Gets the value of the property tileHeight.double
getTileWidth()
Gets the value of the property tileWidth.double
getVgap()
Gets the value of the property vgap.DoubleProperty
hgapProperty()
The amount of horizontal space between each tile in a row.protected void
layoutChildren()
Invoked during the layout pass to layout the children in thisParent
.ObjectProperty<Orientation>
orientationProperty()
The orientation of this tilepane.IntegerProperty
prefColumnsProperty()
The preferred number of columns for a horizontal tilepane.IntegerProperty
prefRowsProperty()
The preferred number of rows for a vertical tilepane.DoubleProperty
prefTileHeightProperty()
The preferred height of each tile.DoubleProperty
prefTileWidthProperty()
The preferred width of each tile.void
requestLayout()
Requests a layout pass to be performed before the next scene is rendered.void
setAlignment(Pos value)
Sets the value of the property alignment.static void
setAlignment(Node node, Pos value)
Sets the alignment for the child when contained by a tilepane.void
setHgap(double value)
Sets the value of the property hgap.static void
setMargin(Node node, Insets value)
Sets the margin for the child when contained by a tilepane.void
setOrientation(Orientation value)
Sets the value of the property orientation.void
setPrefColumns(int value)
Sets the value of the property prefColumns.void
setPrefRows(int value)
Sets the value of the property prefRows.void
setPrefTileHeight(double value)
Sets the value of the property prefTileHeight.void
setPrefTileWidth(double value)
Sets the value of the property prefTileWidth.void
setTileAlignment(Pos value)
Sets the value of the property tileAlignment.void
setVgap(double value)
Sets the value of the property vgap.ObjectProperty<Pos>
tileAlignmentProperty()
The default alignment of each child within its tile.ReadOnlyDoubleProperty
tileHeightProperty()
The actual height of each tile.ReadOnlyDoubleProperty
tileWidthProperty()
The actual width of each tile.DoubleProperty
vgapProperty()
The amount of vertical space between each tile in a column.Methods inherited from class javafx.scene.layout.Pane
getChildren
Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, 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, 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, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty
Methods inherited from class javafx.scene.Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setNeedsLayout, updateBounds
Methods inherited from class javafx.scene.Node
accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface javafx.css.Styleable
getStyleableNode
-
Property Details
-
orientation
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
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
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
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
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)
-
tileWidth
The actual width of each tile. This property is read-only.- See Also:
getTileWidth()
-
tileHeight
The actual height of each tile. This property is read-only.- See Also:
getTileHeight()
-
hgap
The amount of horizontal space between each tile in a row.- See Also:
getHgap()
,setHgap(double)
-
vgap
The amount of vertical space between each tile in a column.- See Also:
getVgap()
,setVgap(double)
-
alignment
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)
-
tileAlignment
The default alignment of each child within its tile. This may be overridden on individual children by setting the child's alignment constraint.- See Also:
getTileAlignment()
,setTileAlignment(Pos)
-
-
Constructor Details
-
TilePane
public TilePane()Creates a horizontal TilePane layout with prefColumn = 5 and hgap/vgap = 0. -
TilePane
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 tilevgap
- the amount of vertical space between each tile
-
TilePane
Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.- Parameters:
orientation
- the direction the tiles should flow & wraphgap
- the amount of horizontal space between each tilevgap
- the amount of vertical space between each tile
-
TilePane
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
Creates a TilePane layout with the specified orientation, prefColumn/prefRows = 5 and hgap/vgap = 0.- Parameters:
orientation
- the direction the tiles should flow & wrapchildren
- The initial set of children for this pane.- Since:
- JavaFX 8.0
-
TilePane
Creates a horizontal TilePane layout with prefColumn = 5 and the specified hgap/vgap.- Parameters:
hgap
- the amount of horizontal space between each tilevgap
- the amount of vertical space between each tilechildren
- The initial set of children for this pane.- Since:
- JavaFX 8.0
-
TilePane
Creates a TilePane layout with the specified orientation, hgap/vgap, and prefRows/prefColumns = 5.- Parameters:
orientation
- the direction the tiles should flow & wraphgap
- the amount of horizontal space between each tilevgap
- the amount of vertical space between each tilechildren
- The initial set of children for this pane.- Since:
- JavaFX 8.0
-
-
Method Details
-
setAlignment
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 tilepanevalue
- the alignment position for the child
-
getAlignment
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
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 tilepanevalue
- the margin of space around the child
-
getMargin
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
Removes all tilepane constraints from the child node.- Parameters:
child
- the child node
-
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
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
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
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
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
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
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).
-
tileWidthProperty
The actual width of each tile. This property is read-only.- See Also:
getTileWidth()
-
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.
-
tileHeightProperty
The actual height of each tile. This property is read-only.- See Also:
getTileHeight()
-
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.
-
hgapProperty
The amount of horizontal space between each tile in a row.- See Also:
getHgap()
,setHgap(double)
-
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.
-
vgapProperty
The amount of vertical space between each tile in a column.- See Also:
getVgap()
,setVgap(double)
-
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
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
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
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.
-
tileAlignmentProperty
The default alignment of each child within its tile. This may be overridden on individual children by setting the child's alignment constraint.- See Also:
getTileAlignment()
,setTileAlignment(Pos)
-
setTileAlignment
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
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.
-
getContentBias
Description copied from class:Node
Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL.Resizable subclasses should override this method to return an appropriate value.
- Overrides:
getContentBias
in classNode
- Returns:
- orientation of width/height dependency or null if there is none
- See Also:
Node.isResizable()
,Node.minWidth(double)
,Node.minHeight(double)
,Node.prefWidth(double)
,Node.prefHeight(double)
,Node.maxWidth(double)
,Node.maxHeight(double)
-
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 classParent
-
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 classRegion
- 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 classRegion
- 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 classRegion
- 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 classRegion
- 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 thisParent
. 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 classParent
-
getClassCssMetaData
- Returns:
- The CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
- Since:
- JavaFX 8.0
-
getCssMetaData
This method should delegate toNode.getClassCssMetaData()
so that a Node's CssMetaData can be accessed without the need for reflection.- Specified by:
getCssMetaData
in interfaceStyleable
- Overrides:
getCssMetaData
in classRegion
- Returns:
- The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.
- Since:
- JavaFX 8.0
-