Class GridPane
- All Implemented Interfaces:
Styleable, EventTarget
A child may be placed anywhere within the grid and may span multiple rows/columns. Children may freely overlap within rows/columns and their stacking order will be defined by the order of the gridpane's children list (0th node in back, last node in front).
GridPane may be styled with backgrounds and borders using CSS. See
Region superclass for details.
Grid Constraints
A child's placement within the grid is defined by it's layout constraints:
| Constraint | Type | Description |
|---|---|---|
| columnIndex | integer | column where child's layout area starts. |
| rowIndex | integer | row where child's layout area starts. |
| columnSpan | integer | the number of columns the child's layout area spans horizontally. |
| rowSpan | integer | the number of rows the child's layout area spans vertically. |
If the row/column indices are not explicitly set, then the child will be placed in the first row/column. If row/column spans are not set, they will default to 1. A child's placement constraints can be changed dynamically and the gridpane will update accordingly.
The total number of rows/columns does not need to be specified up front as the gridpane will automatically expand/contract the grid to accommodate the content.
To use the GridPane, an application needs to set the layout constraints on the children and add those children to the gridpane instance. Constraints are set on the children using static setter methods on the GridPane class:
GridPane gridpane = new GridPane();
// Set one constraint at a time...
// Places the button at the first row and second column
Button button = new Button();
GridPane.setRowIndex(button, 0);
GridPane.setColumnIndex(button, 1);
// or convenience methods set more than one constraint at once...
Label label = new Label();
GridPane.setConstraints(label, 2, 0); // column=2 row=0
// don't forget to add children to gridpane
gridpane.getChildren().addAll(button, label);
Applications may also use convenience methods which combine the steps of
setting the constraints and adding the children:
GridPane gridpane = new GridPane();
gridpane.add(new Button(), 1, 0); // column=1 row=0
gridpane.add(new Label(), 2, 0); // column=2 row=0
Row/Column Sizing
By default, rows and columns will be sized to fit their content; a column will be wide enough to accommodate the widest child, a row tall enough to fit the tallest child. However, if an application needs to explicitly control the size of rows or columns, it may do so by adding RowConstraints and ColumnConstraints objects to specify those metrics. For example, to create a grid with two fixed-width columns: GridPane gridpane = new GridPane();
gridpane.getColumnConstraints().add(new ColumnConstraints(100)); // column 0 is 100 wide
gridpane.getColumnConstraints().add(new ColumnConstraints(200)); // column 1 is 200 wide
By default the gridpane will resize rows/columns to their preferred sizes (either
computed from content or fixed), even if the gridpane is resized larger than
its preferred size. If an application needs a particular row or column to
grow if there is extra space, it may set its grow priority on the RowConstraints
or ColumnConstraints object. For example:
GridPane gridpane = new GridPane();
ColumnConstraints column1 = new ColumnConstraints(100,100,Double.MAX_VALUE);
column1.setHgrow(Priority.ALWAYS);
ColumnConstraints column2 = new ColumnConstraints(100);
gridpane.getColumnConstraints().addAll(column1, column2); // first column gets any extra width
Note: Nodes spanning multiple rows/columns will be also size to the preferred sizes. The affected rows/columns are resized by the following priority: grow priorities, last row. This is with respect to row/column constraints.
Percentage Sizing
Alternatively, RowConstraints and ColumnConstraints allow the size to be specified as a percentage of gridpane's available space: GridPane gridpane = new GridPane();
ColumnConstraints column1 = new ColumnConstraints();
column1.setPercentWidth(50);
ColumnConstraints column2 = new ColumnConstraints();
column2.setPercentWidth(50);
gridpane.getColumnConstraints().addAll(column1, column2); // each get 50% of width
If a percentage value is set on a row/column, then that value takes precedent and the
row/column's min, pref, max, and grow constraints will be ignored.
Note that if the sum of the widthPercent (or heightPercent) values total greater than 100, the values will be treated as weights. e.g. if 3 columns are each given a widthPercent of 50, then each will be allocated 1/3 of the gridpane's available width (50/(50+50+50)).
Mixing Size Types
An application may freely mix the size-types of rows/columns (computed from content, fixed, or percentage). The percentage rows/columns will always be allocated space first based on their percentage of the gridpane's available space (size minus insets and gaps). The remaining space will be allocated to rows/columns given their minimum, preferred, and maximum sizes and grow priorities.Resizable Range
A gridpane's parent will resize the gridpane within the gridpane's resizable range during layout. By default the gridpane computes this range based on its content and row/column constraints as outlined in the table below.
| width | height | |
|---|---|---|
| minimum | left/right insets plus the sum of each column's min width. | top/bottom insets plus the sum of each row's min height. |
| preferred | left/right insets plus the sum of each column's pref width. | top/bottom insets plus the sum of each row's pref height. |
| maximum | Double.MAX_VALUE | Double.MAX_VALUE |
A gridpane'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.
GridPane provides properties for setting the size range directly. These properties default to the sentinel value USE_COMPUTED_SIZE, however the application may set them to other values as needed:
gridpane.setPrefSize(300, 300);
// never size the gridpane larger than its preferred size:
gridpane.setMaxSize(Region.USE_COMPUTED_SIZE, Region.USE_COMPUTED_SIZE);
Applications may restore the computed values by setting these properties back
to USE_COMPUTED_SIZE.
GridPane does not clip its content by default, so it is possible that children's bounds may extend outside its own bounds if a child's min size prevents it from being fit within it space.
Optional Layout Constraints
An application may set additional constraints on children to customize how the child is sized and positioned within the layout area established by it's row/column indices/spans:
| Constraint | Type | Description |
|---|---|---|
| halignment | javafx.geometry.HPos | The horizontal alignment of the child within its layout area. |
| valignment | javafx.geometry.VPos | The vertical alignment of the child within its layout area. |
| hgrow | javafx.scene.layout.Priority | The horizontal grow priority of the child. |
| vgrow | javafx.scene.layout.Priority | The vertical grow priority of the child. |
| margin | javafx.geometry.Insets | Margin space around the outside of the child. |
By default the alignment of a child within its layout area is defined by the alignment set for the row and column. If an individual alignment constraint is set on a child, that alignment will override the row/column alignment only for that child. Alignment of other children in the same row or column will not be affected.
Grow priorities, on the other hand, can only be applied to entire rows or columns. Therefore, if a grow priority constraint is set on a single child, it will be used to compute the default grow priority of the encompassing row/column. If a grow priority is set directly on a RowConstraint or ColumnConstraint object, it will override the value computed from content.
- Since:
- JavaFX 2.0
-
Property Summary
PropertiesTypePropertyDescriptionfinal ObjectProperty<Pos> The alignment of the grid within the gridpane's width and height.final BooleanPropertyFor debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns.final DoublePropertyThe width of the horizontal gaps between columns.final DoublePropertyThe height of the vertical gaps between rows.Properties declared in class Region
background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, widthTypePropertyDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final DoublePropertyProperty for overriding the region's computed maximum height.final DoublePropertyProperty for overriding the region's computed maximum width.final DoublePropertyProperty for overriding the region's computed minimum height.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.final DoublePropertyProperty for overriding the region's computed preferred height.final DoublePropertyProperty for overriding the region's computed preferred width.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Properties declared in class Parent
needsLayoutTypePropertyDescriptionfinal ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.Properties declared in class Node
accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragDone, 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, visibleTypePropertyDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.final StringPropertyA string representation of the CSS style associated with this specificNode.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intSentinel value which may be set on a child's row/column span constraint to indicate that it should span the remaining rows/columns.Fields declared in class Region
USE_COMPUTED_SIZE, USE_PREF_SIZEModifier and TypeFieldDescriptionstatic final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setPrefWidth,setPrefHeight,setMaxWidth,setMaxHeightmethods to reset the region's size constraint back to it's intrinsic size returned bycomputeMinWidth,computeMinHeight,computePrefWidth,computePrefHeight,computeMaxWidth, orcomputeMaxHeight.static final doubleSentinel value which can be passed to a region'ssetMinWidth,setMinHeight,setMaxWidthorsetMaxHeightmethods to indicate that the preferred dimension should be used for that max and/or min constraint.Fields declared in class Node
BASELINE_OFFSET_SAME_AS_HEIGHTModifier and TypeFieldDescriptionstatic final doubleThis is a special value that might be returned byNode.getBaselineOffset(). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a child to the gridpane at the specified [column, row] position.voidAdds a child to the gridpane at the specified [column, row] position and spans.voidConvenience method for placing the specified nodes sequentially in a given column of the gridpane.voidConvenience method for placing the specified nodes sequentially in a given row of the gridpane.final ObjectProperty<Pos> The alignment of the grid within the gridpane's width and height.static voidclearConstraints(Node child) Removes all gridpane constraints from the child node.final PosGets the value of thealignmentproperty.final BoundsgetCellBounds(int columnIndex, int rowIndex) Returns the bounds of the cell at the specified column and row position.static List<CssMetaData<? extends Styleable, ?>> Gets theCssMetaDataassociated with this class, which may include theCssMetaDataof its superclasses.final ObservableList<ColumnConstraints> Returns list of column constraints.final intReturns the number of columns in this GridPane.static IntegergetColumnIndex(Node child) Returns the child's column index constraint if set.static IntegergetColumnSpan(Node child) Returns the child's column-span constraint if set.Returns the orientation of a node's resizing bias for layout purposes.List<CssMetaData<? extends Styleable, ?>> This method should delegate toNode.getClassCssMetaData()so that a Node's CssMetaData can be accessed without the need for reflection.static HPosgetHalignment(Node child) Returns the child's halignment constraint if set.final doublegetHgap()Gets the value of thehgapproperty.static PriorityReturns the child's hgrow constraint if set.static InsetsReturns the child's margin constraint if set.final ObservableList<RowConstraints> Returns list of row constraints.final intReturns the number of rows in this GridPane.static IntegergetRowIndex(Node child) Returns the child's row index constraint if set.static IntegergetRowSpan(Node child) Returns the child's row-span constraint if set.static VPosgetValignment(Node child) Returns the child's valignment constraint if set.final doublegetVgap()Gets the value of thevgapproperty.static PriorityReturns the child's vgrow constraint if set.final BooleanPropertyFor debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns.final DoublePropertyThe width of the horizontal gaps between columns.static BooleanisFillHeight(Node child) Returns the child's vertical fill policy if setstatic BooleanisFillWidth(Node child) Returns the child's horizontal fill policy if setfinal booleanGets the value of thegridLinesVisibleproperty.final voidsetAlignment(Pos value) Sets the value of thealignmentproperty.static voidsetColumnIndex(Node child, Integer value) Sets the column index for the child when contained by a gridpane so that it will be positioned starting in that column of the gridpane.static voidsetColumnSpan(Node child, Integer value) Sets the column span for the child when contained by a gridpane so that it will span that number of columns horizontally.static voidsetConstraints(Node child, int columnIndex, int rowIndex) Sets the column,row indices for the child when contained in a gridpane.static voidsetConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan) Sets the column, row, column-span, and row-span value for the child when contained in a gridpane.static voidsetConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment) Sets the grid position, spans, and alignment for the child when contained in a gridpane.static voidsetConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment, Priority hgrow, Priority vgrow) Sets the grid position, spans, and alignment for the child when contained in a gridpane.static voidsetConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment, Priority hgrow, Priority vgrow, Insets margin) Sets the grid position, spans, alignment, grow priorities, and margin for the child when contained in a gridpane.static voidsetFillHeight(Node child, Boolean value) Sets the vertical fill policy for the child when contained by a gridpane.static voidsetFillWidth(Node child, Boolean value) Sets the horizontal fill policy for the child when contained by a gridpane.final voidsetGridLinesVisible(boolean value) Sets the value of thegridLinesVisibleproperty.static voidsetHalignment(Node child, HPos value) Sets the horizontal alignment for the child when contained by a gridpane.final voidsetHgap(double value) Sets the value of thehgapproperty.static voidSets the horizontal grow priority for the child when contained by a gridpane.static voidSets the margin for the child when contained by a gridpane.static voidsetRowIndex(Node child, Integer value) Sets the row index for the child when contained by a gridpane so that it will be positioned starting in that row of the gridpane.static voidsetRowSpan(Node child, Integer value) Sets the row span for the child when contained by a gridpane so that it will span that number of rows vertically.static voidsetValignment(Node child, VPos value) Sets the vertical alignment for the child when contained by a gridpane.final voidsetVgap(double value) Sets the value of thevgapproperty.static voidSets the vertical grow priority for the child when contained by a gridpane.toString()Returns a string representation of thisGridPaneobject.final DoublePropertyThe height of the vertical gaps between rows.Methods declared in class Pane
getChildrenModifier and TypeMethodDescriptionGets the list of children of thisParent.Methods declared in class Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, 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, widthPropertyModifier and TypeMethodDescriptionfinal ObjectProperty<Background> The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.final ObjectProperty<Border> The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.final BooleanPropertyDefines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.final BooleanPropertyDefines whether the shape is centered within theRegion's width and height.protected doublecomputeMaxHeight(double width) Computes the maximum height of this region for the specified width.protected doublecomputeMaxWidth(double height) Computes the maximum width of this region for the specified height.protected doublecomputeMinHeight(double width) Computes the minimum height of this region for the specified width.protected doublecomputeMinWidth(double height) Computes the minimum width of this region for the specified height.protected doublecomputePrefHeight(double width) Computes the preferred height of this region for the specified width.protected doublecomputePrefWidth(double height) Computes the preferred width of this region for the specified height.final BackgroundGets the value of thebackgroundproperty.final BorderGets the value of theborderproperty.final doubleGets the value of theheightproperty.final InsetsGets the value of theinsetsproperty.final doubleGets the value of themaxHeightproperty.final doubleGets the value of themaxWidthproperty.final doubleGets the value of theminHeightproperty.final doubleGets the value of theminWidthproperty.final InsetsGets the value of theopaqueInsetsproperty.final InsetsGets the value of thepaddingproperty.final doubleGets the value of theprefHeightproperty.final doubleGets the value of theprefWidthproperty.final ShapegetShape()Gets the value of theshapeproperty.An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.final doublegetWidth()Gets the value of thewidthproperty.final ReadOnlyDoublePropertyThe height of this resizable node.final ReadOnlyObjectProperty<Insets> The insets of the Region define the distance from the edge of the region (its layout bounds, or (0, 0, width, height)) to the edge of the content area.final booleanGets the value of thecacheShapeproperty.final booleanGets the value of thecenterShapeproperty.booleanReturnstruesince all Regions are resizable.final booleanGets the value of thescaleShapeproperty.final booleanGets the value of thesnapToPixelproperty.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which lays out the child within an area of it's parent defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.protected voidlayoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment) Utility method which lays out the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doublemaxHeight(double width) Called during layout to determine the maximum height for this node.final DoublePropertyProperty for overriding the region's computed maximum height.final doublemaxWidth(double height) Called during layout to determine the maximum width for this node.final DoublePropertyProperty for overriding the region's computed maximum width.final doubleminHeight(double width) Called during layout to determine the minimum height for this node.final DoublePropertyProperty for overriding the region's computed minimum height.final doubleminWidth(double height) Called during layout to determine the minimum width for this node.final DoublePropertyProperty for overriding the region's computed minimum width.final ObjectProperty<Insets> Defines the area of the region within which completely opaque pixels are drawn.final ObjectProperty<Insets> The top, right, bottom, and left padding around the region's content.protected voidpositionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment) Utility method which positions the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.static voidpositionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment, boolean isSnapToPixel) Utility method which positions the child within an area of this region defined byareaX,areaY,areaWidthxareaHeight, with a baseline offset relative to that area.final doubleprefHeight(double width) Called during layout to determine the preferred height for this node.final DoublePropertyProperty for overriding the region's computed preferred height.final doubleprefWidth(double height) Called during layout to determine the preferred width for this node.final DoublePropertyProperty for overriding the region's computed preferred width.voidresize(double width, double height) Invoked by the region's parent during layout to set the region's width and height.final BooleanPropertySpecifies whether the shape, if defined, is scaled to match the size of the Region.final voidsetBackground(Background value) Sets the value of thebackgroundproperty.final voidSets the value of theborderproperty.final voidsetCacheShape(boolean value) Sets the value of thecacheShapeproperty.final voidsetCenterShape(boolean value) Sets the value of thecenterShapeproperty.protected voidsetHeight(double value) Sets the value of theheightproperty.final voidsetMaxHeight(double value) Sets the value of themaxHeightproperty.voidsetMaxSize(double maxWidth, double maxHeight) Convenience method for overriding the region's computed maximum width and height.final voidsetMaxWidth(double value) Sets the value of themaxWidthproperty.final voidsetMinHeight(double value) Sets the value of theminHeightproperty.voidsetMinSize(double minWidth, double minHeight) Convenience method for overriding the region's computed minimum width and height.final voidsetMinWidth(double value) Sets the value of theminWidthproperty.final voidsetOpaqueInsets(Insets value) Sets the value of theopaqueInsetsproperty.final voidsetPadding(Insets value) Sets the value of thepaddingproperty.final voidsetPrefHeight(double value) Sets the value of theprefHeightproperty.voidsetPrefSize(double prefWidth, double prefHeight) Convenience method for overriding the region's computed preferred width and height.final voidsetPrefWidth(double value) Sets the value of theprefWidthproperty.final voidsetScaleShape(boolean value) Sets the value of thescaleShapeproperty.final voidSets the value of theshapeproperty.final voidsetSnapToPixel(boolean value) Sets the value of thesnapToPixelproperty.protected voidsetWidth(double value) Sets the value of thewidthproperty.final ObjectProperty<Shape> When specified, theShapewill cause the region to be rendered as the specified shape rather than as a rounded rectangle.final doubleUtility method to get the bottom inset which includes padding and border inset.final doubleUtility method to get the left inset which includes padding and border inset.final doubleUtility method to get the right inset which includes padding and border inset.final doubleUtility method to get the top inset which includes padding and border inset.protected doublesnapPosition(double value) Deprecated, for removal: This API element is subject to removal in a future version.doublesnapPositionX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapPositionY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSize(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSizeX()andsnapSizeY()doublesnapSizeX(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSizeY(double value) If this region's snapToPixel property is true, returns a value ceiled to the nearest pixel in the vertical direction, else returns the same value.protected doublesnapSpace(double value) Deprecated, for removal: This API element is subject to removal in a future version.replaced bysnapSpaceX()andsnapSpaceY()doublesnapSpaceX(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the horizontal direction, else returns the same value.doublesnapSpaceY(double value) If this region's snapToPixel property is true, returns a value rounded to the nearest pixel in the vertical direction, else returns the same value.final BooleanPropertyDefines whether this region adjusts position, spacing, and size values of its children to pixel boundaries.final ReadOnlyDoublePropertyThe width of this resizable node.Methods declared in class Parent
getBaselineOffset, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBoundsModifier and TypeMethodDescriptiondoubleCalculates the baseline offset based on the first managed child.Gets the list of children of thisParentas a read-only list.Gets the list of all managed children of thisParent.final ObservableList<String> Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.final booleanGets the value of theneedsLayoutproperty.final voidlayout()Executes a top-down layout pass on the scene graph under this parent.protected voidInvoked byParent.layout()during a layout pass to position and resize the managed children.final ReadOnlyBooleanPropertyIndicates that this Node and its subnodes requires a layout pass on the next pulse.voidRequests a layout pass to be performed before the next scene is rendered.protected final voidRequests a layout pass of the parent to be performed before the next scene is rendered.protected final voidsetNeedsLayout(boolean value) Sets the value of theneedsLayoutproperty.protected voidUpdates the bounds of thisParentand its children.Methods declared in class 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, focusVisibleProperty, focusWithinProperty, 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, getOnMouseDragDone, 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, isFocusVisible, isFocusWithin, 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, lookup, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragDoneProperty, 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, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, requestFocusTraversal, 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, setOnMouseDragDone, 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, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visiblePropertyModifier and TypeMethodDescriptionfinal ObjectProperty<String> The accessible help text for thisNode.final ObjectProperty<String> The role description of thisNode.final ObjectProperty<AccessibleRole> The accessible role for thisNode.final ObjectProperty<String> The accessible text for thisNode.final <T extends Event>
voidaddEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Registers an event filter for this target.final <T extends Event>
voidaddEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Registers an event handler for this target.final voidapplyCss()If required, apply styles to this Node and its children, if any.final voidautosize()If the node is resizable, will set its layout bounds to its current preferred width and height.final ObjectProperty<BlendMode> TheBlendModeused to blend this individual node into the scene behind it.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the node's untransformed local coordinate space.final ReadOnlyObjectProperty<Bounds> The rectangular bounds of thisNodein the parent coordinate system.Construct an event dispatch chain for this target.final ObjectProperty<CacheHint> Additional hint for controlling bitmap caching.final BooleanPropertyA performance hint to the system to indicate that thisNodeshould be cached as a bitmap.final ObjectProperty<Node> Specifies aNodeto use to define the clipping shape for this Node.doubleReturns the area of thisNodeprojected onto the physical screen in pixel units.booleancontains(double localX, double localY) Returnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.booleanReturnstrueif the given point (specified in the local coordinate space of thisNode) is contained within the shape of thisNode.final ObjectProperty<Cursor> Defines the mouse cursor for thisNodeand subnodes.final ObjectProperty<DepthTest> Indicates whether depth testing is used when rendering this node.final ReadOnlyBooleanPropertyIndicates whether or not thisNodeis disabled.final BooleanPropertyDefines the individual disabled state of thisNode.The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.final ObjectProperty<Effect> Specifies an effect to apply to thisNode.final ObjectProperty<EventDispatcher> Specifies the event dispatcher for this node.voidexecuteAccessibleAction(AccessibleAction action, Object... parameters) This method is called by the assistive technology to request the action indicated by the argument should be executed.final voidFires the specified event.final ReadOnlyBooleanPropertyIndicates whether thisNodecurrently has the input focus.final BooleanPropertySpecifies whether thisNodeshould be a part of focus traversal cycle.final ReadOnlyBooleanPropertyIndicates whether thisNodeshould visibly indicate focus.final ReadOnlyBooleanPropertyIndicates whether thisNodeor any of its descendants currently has the input focus.final StringGets the value of theaccessibleHelpproperty.final AccessibleRoleGets the value of theaccessibleRoleproperty.final StringGets the value of theaccessibleRoleDescriptionproperty.final StringGets the value of theaccessibleTextproperty.final BlendModeGets the value of theblendModeproperty.final BoundsGets the value of theboundsInLocalproperty.final BoundsGets the value of theboundsInParentproperty.final CacheHintGets the value of thecacheHintproperty.final NodegetClip()Gets the value of theclipproperty.final CursorGets the value of thecursorproperty.final DepthTestGets the value of thedepthTestproperty.final EffectGets the value of theeffectproperty.final NodeOrientationGets the value of theeffectiveNodeOrientationproperty.final EventDispatcherGets the value of theeventDispatcherproperty.final StringgetId()The id of thisNode.protected CursorReturns the initial cursor state of this node, for use by the JavaFX CSS engine to correctly set its initial value.protected BooleanReturns the initial focus traversable state of this node, for use by the JavaFX CSS engine to correctly set its initial value.final InputMethodRequestsGets the value of theinputMethodRequestsproperty.final BoundsGets the value of thelayoutBoundsproperty.final doubleGets the value of thelayoutXproperty.final doubleGets the value of thelayoutYproperty.final TransformGets the value of thelocalToParentTransformproperty.final TransformGets the value of thelocalToSceneTransformproperty.final NodeOrientationGets the value of thenodeOrientationproperty.final EventHandler<? super ContextMenuEvent> Gets the value of theonContextMenuRequestedproperty.final EventHandler<? super MouseEvent> Gets the value of theonDragDetectedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDoneproperty.final EventHandler<? super DragEvent> Gets the value of theonDragDroppedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragEnteredproperty.final EventHandler<? super DragEvent> Gets the value of theonDragExitedproperty.final EventHandler<? super DragEvent> Gets the value of theonDragOverproperty.final EventHandler<? super InputMethodEvent> Gets the value of theonInputMethodTextChangedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyPressedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyReleasedproperty.final EventHandler<? super KeyEvent> Gets the value of theonKeyTypedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseClickedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragDoneproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragEnteredproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseDraggedproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragOverproperty.final EventHandler<? super MouseDragEvent> Gets the value of theonMouseDragReleasedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseEnteredproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseExitedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseMovedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMousePressedproperty.final EventHandler<? super MouseEvent> Gets the value of theonMouseReleasedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotateproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationFinishedproperty.final EventHandler<? super RotateEvent> Gets the value of theonRotationStartedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollFinishedproperty.final EventHandler<? super ScrollEvent> Gets the value of theonScrollStartedproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeDownproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeLeftproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeRightproperty.final EventHandler<? super SwipeEvent> Gets the value of theonSwipeUpproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchMovedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchPressedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchReleasedproperty.final EventHandler<? super TouchEvent> Gets the value of theonTouchStationaryproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomFinishedproperty.final EventHandler<? super ZoomEvent> Gets the value of theonZoomStartedproperty.final doubleGets the value of theopacityproperty.final ParentGets the value of theparentproperty.final ObservableMap<Object, Object> Returns an observable map of properties on this node for use primarily by application developers.final ObservableSet<PseudoClass> Return the pseudo-class state of this Styleable.final doubleGets the value of therotateproperty.final Point3DGets the value of therotationAxisproperty.final doubleGets the value of thescaleXproperty.final doubleGets the value of thescaleYproperty.final doubleGets the value of thescaleZproperty.final ScenegetScene()Gets the value of thesceneproperty.final StringgetStyle()A string representation of the CSS style associated with this specificNode.Return the parent of this Styleable, or null if there is no parent.final ObservableList<String> A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.final ObservableList<Transform> final doubleGets the value of thetranslateXproperty.final doubleGets the value of thetranslateYproperty.final doubleGets the value of thetranslateZproperty.The type of thisStyleablethat is to be used in selector matching.Returns a previously set Object property, or null if no such property has been set using theNode.setUserData(java.lang.Object)method.final doubleGets the value of theviewOrderproperty.booleanTests if Node has properties.final ReadOnlyBooleanPropertyWhether or not thisNodeis being hovered over.final StringPropertyThe id of thisNode.Property holding InputMethodRequests.booleanintersects(double localX, double localY, double localWidth, double localHeight) Returnstrueif the given rectangle (specified in the local coordinate space of thisNode) intersects the shape of thisNode.booleanintersects(Bounds localBounds) Returnstrueif the given bounds (specified in the local coordinate space of thisNode) intersects the shape of thisNode.final booleanisCache()Gets the value of thecacheproperty.final booleanGets the value of thedisableproperty.final booleanGets the value of thedisabledproperty.final booleanGets the value of thefocusedproperty.final booleanGets the value of thefocusTraversableproperty.final booleanGets the value of thefocusVisibleproperty.final booleanGets the value of thefocusWithinproperty.final booleanisHover()Gets the value of thehoverproperty.final booleanGets the value of themanagedproperty.final booleanGets the value of themouseTransparentproperty.final booleanGets the value of thepickOnBoundsproperty.final booleanGets the value of thepressedproperty.final booleanGets the value of thevisibleproperty.final ReadOnlyObjectProperty<Bounds> The rectangular bounds that should be used for layout calculations for this node.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform for the purpose of layout.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform for the purpose of layout.localToParent(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.localToParent(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its parent.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-parent transform.localToScene(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(double x, double y, double z, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Bounds localBounds, boolean rootScene) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point2D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.localToScene(Point3D localPoint, boolean rootScene) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of its scene.final ReadOnlyObjectProperty<Transform> An affine transform that holds the computed local-to-scene transform.localToScreen(double localX, double localY) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(double localX, double localY, double localZ) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Bounds localBounds) Transforms a bounds from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point2D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.localToScreen(Point3D localPoint) Transforms a point from the local coordinate space of thisNodeinto the coordinate space of itsScreen.Finds thisNode, or the first sub-node, based on the given CSS selector.Finds allNodes, including this one and any children, which match the given CSS selector.final BooleanPropertyDefines whether or not this node's layout will be managed by its parent.final BooleanPropertyIftrue, this node (together with all its children) is completely transparent to mouse events.final ObjectProperty<NodeOrientation> Node orientation describes the flow of visual data within a node.final voidnotifyAccessibleAttributeChanged(AccessibleAttribute attributes) This method is called by the application to notify the assistive technology that the value for an attribute has changed.final ObjectProperty<EventHandler<? super ContextMenuEvent>> Defines a function to be called when a context menu has been requested on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when drag gesture has been detected.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when thisNodeis a drag and drop gesture source after its data has been dropped on a drop target.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when the mouse button is released on thisNodeduring drag and drop gesture.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture enters thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture exits thisNode.final ObjectProperty<EventHandler<? super DragEvent>> Defines a function to be called when drag gesture progresses within thisNode.final ObjectProperty<EventHandler<? super InputMethodEvent>> Defines a function to be called when thisNodehas input focus and the input method text has changed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been pressed.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been released.final ObjectProperty<EventHandler<? super KeyEvent>> Defines a function to be called when thisNodeor its childNodehas input focus and a key has been typed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been clicked (pressed and released) on thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends with this node as its source.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture enters thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture leaves thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button is pressed on thisNodeand then dragged.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture progresses within thisNode.final ObjectProperty<EventHandler<? super MouseDragEvent>> Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse enters thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when the mouse exits thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when mouse cursor moves within thisNodebut no buttons have been pushed.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been pressed on thisNode.final ObjectProperty<EventHandler<? super MouseEvent>> Defines a function to be called when a mouse button has been released on thisNode.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when user performs a rotation action.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture ends.final ObjectProperty<EventHandler<? super RotateEvent>> Defines a function to be called when a rotation gesture is detected.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture ends.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when user performs a scrolling action.final ObjectProperty<EventHandler<? super ScrollEvent>> Defines a function to be called when a scrolling gesture is detected.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a downward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when a leftward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an rightward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super SwipeEvent>> Defines a function to be called when an upward swipe gesture centered over this node happens.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is moved.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a new touch point is pressed.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point is released.final ObjectProperty<EventHandler<? super TouchEvent>> Defines a function to be called when a touch point stays pressed and still.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture ends.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when user performs a zooming action.final ObjectProperty<EventHandler<? super ZoomEvent>> Defines a function to be called when a zooming gesture is detected.final DoublePropertySpecifies how opaque (that is, solid) theNodeappears.final ReadOnlyObjectProperty<Parent> The parent of thisNode.parentToLocal(double parentX, double parentY) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(double parentX, double parentY, double parentZ) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Bounds parentBounds) Transforms a rectangle from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point2D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.parentToLocal(Point3D parentPoint) Transforms a point from the coordinate space of the parent into the local coordinate space of thisNode.final BooleanPropertyDefines how the picking computation is done for this node when triggered by aMouseEventor acontainsfunction call.final ReadOnlyBooleanPropertyWhether or not theNodeis pressed.final voidpseudoClassStateChanged(PseudoClass pseudoClass, boolean active) Used to specify that a pseudo-class of this Node has changed.queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) This method is called by the assistive technology to request the value for an attribute.voidrelocate(double x, double y) Sets the node's layoutX and layoutY translation properties in order to relocate this node to the x,y location in the parent.final <T extends Event>
voidremoveEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Unregisters a previously registered event filter from this target.final <T extends Event>
voidremoveEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Unregisters a previously registered event handler from this target.voidRequests that thisNodeget the input focus, and that thisNode's top-level ancestor become the focused window.final booleanrequestFocusTraversal(TraversalDirection direction) Requests to move the focus from thisNodein the specified direction.voidresizeRelocate(double x, double y, double width, double height) If the node is resizable, will set its layout bounds to the specified width and height.final DoublePropertyDefines the angle of rotation about theNode's center, measured in degrees.final ObjectProperty<Point3D> Defines the axis of rotation of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the X axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Y axis of thisNode.final DoublePropertyDefines the factor by which coordinates are scaled about the center of the object along the Z axis of thisNode.final ReadOnlyObjectProperty<Scene> TheScenethat thisNodeis part of.sceneToLocal(double sceneX, double sceneY) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double x, double y, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(double sceneX, double sceneY, double sceneZ) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds sceneBounds) Transforms a rectangle from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Bounds bounds, boolean rootScene) Transforms a bounds from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point2D point, boolean rootScene) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.sceneToLocal(Point3D scenePoint) Transforms a point from the coordinate space of the scene into the local coordinate space of thisNode.screenToLocal(double screenX, double screenY) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Bounds screenBounds) Transforms a rectangle from the coordinate space of theScreeninto the local coordinate space of thisNode.screenToLocal(Point2D screenPoint) Transforms a point from the coordinate space of theScreeninto the local coordinate space of thisNode.final voidsetAccessibleHelp(String value) Sets the value of theaccessibleHelpproperty.final voidsetAccessibleRole(AccessibleRole value) Sets the value of theaccessibleRoleproperty.final voidSets the value of theaccessibleRoleDescriptionproperty.final voidsetAccessibleText(String value) Sets the value of theaccessibleTextproperty.final voidsetBlendMode(BlendMode value) Sets the value of theblendModeproperty.final voidsetCache(boolean value) Sets the value of thecacheproperty.final voidsetCacheHint(CacheHint value) Sets the value of thecacheHintproperty.final voidSets the value of theclipproperty.final voidSets the value of thecursorproperty.final voidsetDepthTest(DepthTest value) Sets the value of thedepthTestproperty.final voidsetDisable(boolean value) Sets the value of thedisableproperty.protected final voidsetDisabled(boolean value) Sets the value of thedisabledproperty.final voidSets the value of theeffectproperty.final voidSets the value of theeventDispatcherproperty.protected final <T extends Event>
voidsetEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Sets the handler to use for this event type.protected final voidsetFocused(boolean value) Sets the value of thefocusedproperty.final voidsetFocusTraversable(boolean value) Sets the value of thefocusTraversableproperty.protected final voidsetHover(boolean value) Sets the value of thehoverproperty.final voidSets the value of theidproperty.final voidSets the value of theinputMethodRequestsproperty.final voidsetLayoutX(double value) Sets the value of thelayoutXproperty.final voidsetLayoutY(double value) Sets the value of thelayoutYproperty.final voidsetManaged(boolean value) Sets the value of themanagedproperty.final voidsetMouseTransparent(boolean value) Sets the value of themouseTransparentproperty.final voidsetNodeOrientation(NodeOrientation orientation) Sets the value of thenodeOrientationproperty.final voidsetOnContextMenuRequested(EventHandler<? super ContextMenuEvent> value) Sets the value of theonContextMenuRequestedproperty.final voidsetOnDragDetected(EventHandler<? super MouseEvent> value) Sets the value of theonDragDetectedproperty.final voidsetOnDragDone(EventHandler<? super DragEvent> value) Sets the value of theonDragDoneproperty.final voidsetOnDragDropped(EventHandler<? super DragEvent> value) Sets the value of theonDragDroppedproperty.final voidsetOnDragEntered(EventHandler<? super DragEvent> value) Sets the value of theonDragEnteredproperty.final voidsetOnDragExited(EventHandler<? super DragEvent> value) Sets the value of theonDragExitedproperty.final voidsetOnDragOver(EventHandler<? super DragEvent> value) Sets the value of theonDragOverproperty.final voidsetOnInputMethodTextChanged(EventHandler<? super InputMethodEvent> value) Sets the value of theonInputMethodTextChangedproperty.final voidsetOnKeyPressed(EventHandler<? super KeyEvent> value) Sets the value of theonKeyPressedproperty.final voidsetOnKeyReleased(EventHandler<? super KeyEvent> value) Sets the value of theonKeyReleasedproperty.final voidsetOnKeyTyped(EventHandler<? super KeyEvent> value) Sets the value of theonKeyTypedproperty.final voidsetOnMouseClicked(EventHandler<? super MouseEvent> value) Sets the value of theonMouseClickedproperty.final voidsetOnMouseDragDone(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragDoneproperty.final voidsetOnMouseDragEntered(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragEnteredproperty.final voidsetOnMouseDragExited(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragExitedproperty.final voidsetOnMouseDragged(EventHandler<? super MouseEvent> value) Sets the value of theonMouseDraggedproperty.final voidsetOnMouseDragOver(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragOverproperty.final voidsetOnMouseDragReleased(EventHandler<? super MouseDragEvent> value) Sets the value of theonMouseDragReleasedproperty.final voidsetOnMouseEntered(EventHandler<? super MouseEvent> value) Sets the value of theonMouseEnteredproperty.final voidsetOnMouseExited(EventHandler<? super MouseEvent> value) Sets the value of theonMouseExitedproperty.final voidsetOnMouseMoved(EventHandler<? super MouseEvent> value) Sets the value of theonMouseMovedproperty.final voidsetOnMousePressed(EventHandler<? super MouseEvent> value) Sets the value of theonMousePressedproperty.final voidsetOnMouseReleased(EventHandler<? super MouseEvent> value) Sets the value of theonMouseReleasedproperty.final voidsetOnRotate(EventHandler<? super RotateEvent> value) Sets the value of theonRotateproperty.final voidsetOnRotationFinished(EventHandler<? super RotateEvent> value) Sets the value of theonRotationFinishedproperty.final voidsetOnRotationStarted(EventHandler<? super RotateEvent> value) Sets the value of theonRotationStartedproperty.final voidsetOnScroll(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollproperty.final voidsetOnScrollFinished(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollFinishedproperty.final voidsetOnScrollStarted(EventHandler<? super ScrollEvent> value) Sets the value of theonScrollStartedproperty.final voidsetOnSwipeDown(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeDownproperty.final voidsetOnSwipeLeft(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeLeftproperty.final voidsetOnSwipeRight(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeRightproperty.final voidsetOnSwipeUp(EventHandler<? super SwipeEvent> value) Sets the value of theonSwipeUpproperty.final voidsetOnTouchMoved(EventHandler<? super TouchEvent> value) Sets the value of theonTouchMovedproperty.final voidsetOnTouchPressed(EventHandler<? super TouchEvent> value) Sets the value of theonTouchPressedproperty.final voidsetOnTouchReleased(EventHandler<? super TouchEvent> value) Sets the value of theonTouchReleasedproperty.final voidsetOnTouchStationary(EventHandler<? super TouchEvent> value) Sets the value of theonTouchStationaryproperty.final voidsetOnZoom(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomproperty.final voidsetOnZoomFinished(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomFinishedproperty.final voidsetOnZoomStarted(EventHandler<? super ZoomEvent> value) Sets the value of theonZoomStartedproperty.final voidsetOpacity(double value) Sets the value of theopacityproperty.final voidsetPickOnBounds(boolean value) Sets the value of thepickOnBoundsproperty.protected final voidsetPressed(boolean value) Sets the value of thepressedproperty.final voidsetRotate(double value) Sets the value of therotateproperty.final voidsetRotationAxis(Point3D value) Sets the value of therotationAxisproperty.final voidsetScaleX(double value) Sets the value of thescaleXproperty.final voidsetScaleY(double value) Sets the value of thescaleYproperty.final voidsetScaleZ(double value) Sets the value of thescaleZproperty.final voidA string representation of the CSS style associated with this specificNode.final voidsetTranslateX(double value) Sets the value of thetranslateXproperty.final voidsetTranslateY(double value) Sets the value of thetranslateYproperty.final voidsetTranslateZ(double value) Sets the value of thetranslateZproperty.voidsetUserData(Object value) Convenience method for setting a single Object property that can be retrieved at a later date.final voidsetViewOrder(double value) Sets the value of theviewOrderproperty.final voidsetVisible(boolean value) Sets the value of thevisibleproperty.snapshot(SnapshotParameters params, WritableImage image) Takes a snapshot of this node and returns the rendered image when it is ready.voidsnapshot(Callback<SnapshotResult, Void> callback, SnapshotParameters params, WritableImage image) Takes a snapshot of this node at the next frame and calls the specified callback method when the image is ready.startDragAndDrop(TransferMode... transferModes) Confirms a potential drag and drop gesture that is recognized over thisNode.voidStarts a full press-drag-release gesture with this node as gesture source.final StringPropertyA string representation of the CSS style associated with this specificNode.voidtoBack()Moves thisNodeto the back of its sibling nodes in terms of z-order.voidtoFront()Moves thisNodeto the front of its sibling nodes in terms of z-order.final DoublePropertyDefines the x coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the y coordinate of the translation that is added to thisNode's transform.final DoublePropertyDefines the Z coordinate of the translation that is added to the transformed coordinates of thisNode.booleanDetermines whether a node should be mirrored when node orientation is right-to-left.final DoublePropertyDefines the rendering and picking order of thisNodewithin its parent.final BooleanPropertySpecifies whether thisNodeand any subnodes should be rendered as part of the scene graph.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface Styleable
getStyleableNodeModifier and TypeMethodDescriptiondefault NodeReturns the Node that represents this Styleable object.
-
Property Details
-
hgap
The width of the horizontal gaps between columns.- See Also:
-
vgap
-
alignment
The alignment of the grid within the gridpane's width and height.- See Also:
-
gridLinesVisible
For debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns. Default isfalse.- See Also:
-
-
Field Details
-
REMAINING
public static final int REMAININGSentinel value which may be set on a child's row/column span constraint to indicate that it should span the remaining rows/columns.- See Also:
-
-
Constructor Details
-
GridPane
public GridPane()Creates a GridPane layout with hgap/vgap = 0 and TOP_LEFT alignment. -
GridPane
-
-
Method Details
-
setRowIndex
Sets the row index for the child when contained by a gridpane so that it will be positioned starting in that row of the gridpane. If a gridpane child has no row index set, it will be positioned in the first row. Setting the value to null will remove the constraint.- Parameters:
child- the child node of a gridpanevalue- the row index of the child
-
getRowIndex
-
setColumnIndex
Sets the column index for the child when contained by a gridpane so that it will be positioned starting in that column of the gridpane. If a gridpane child has no column index set, it will be positioned in the first column. Setting the value to null will remove the constraint.- Parameters:
child- the child node of a gridpanevalue- the column index of the child
-
getColumnIndex
-
setRowSpan
Sets the row span for the child when contained by a gridpane so that it will span that number of rows vertically. This may be set to REMAINING, which will cause the span to extend across all the remaining rows.If a gridpane child has no row span set, it will default to spanning one row. Setting the value to null will remove the constraint.
- Parameters:
child- the child node of a gridpanevalue- the row span of the child
-
getRowSpan
-
setColumnSpan
Sets the column span for the child when contained by a gridpane so that it will span that number of columns horizontally. This may be set to REMAINING, which will cause the span to extend across all the remaining columns.If a gridpane child has no column span set, it will default to spanning one column. Setting the value to null will remove the constraint.
- Parameters:
child- the child node of a gridpanevalue- the column span of the child
-
getColumnSpan
-
setMargin
Sets the margin for the child when contained by a gridpane. If set, the gridpane will lay it out with the margin space around it. Setting the value to null will remove the constraint.- Parameters:
child- the child node of a gridpanevalue- the margin of space around the child
-
getMargin
-
setHalignment
Sets the horizontal alignment for the child when contained by a gridpane. If set, will override the gridpane's default horizontal alignment. Setting the value to null will remove the constraint.- Parameters:
child- the child node of a gridpanevalue- the horizontal alignment for the child
-
getHalignment
-
setValignment
Sets the vertical alignment for the child when contained by a gridpane. If set, will override the gridpane's default vertical alignment. Setting the value to null will remove the constraint.- Parameters:
child- the child node of a gridpanevalue- the vertical alignment for the child
-
getValignment
-
setHgrow
Sets the horizontal grow priority for the child when contained by a gridpane. If set, the gridpane will use the priority to allocate the child additional horizontal space if the gridpane is resized larger than it's preferred width. Setting the value to null will remove the constraint.- Parameters:
child- the child of a gridpanevalue- the horizontal grow priority for the child
-
getHgrow
-
setVgrow
Sets the vertical grow priority for the child when contained by a gridpane. If set, the gridpane will use the priority to allocate the child additional vertical space if the gridpane is resized larger than it's preferred height. Setting the value to null will remove the constraint.- Parameters:
child- the child of a gridpanevalue- the vertical grow priority for the child
-
getVgrow
-
setFillWidth
Sets the horizontal fill policy for the child when contained by a gridpane. If set, the gridpane will use the policy to determine whether node should be expanded to fill the column or resized to its preferred width. Setting the value to null will remove the constraint. If not value is specified for the node nor for the column, the default value is true.- Parameters:
child- the child node of a gridpanevalue- the horizontal fill policy or null for unset- Since:
- JavaFX 8.0
-
isFillWidth
-
setFillHeight
Sets the vertical fill policy for the child when contained by a gridpane. If set, the gridpane will use the policy to determine whether node should be expanded to fill the row or resized to its preferred height. Setting the value to null will remove the constraint. If not value is specified for the node nor for the row, the default value is true.- Parameters:
child- the child node of a gridpanevalue- the vertical fill policy or null for unset- Since:
- JavaFX 8.0
-
isFillHeight
-
setConstraints
Sets the column,row indices for the child when contained in a gridpane.- Parameters:
child- the child node of a gridpanecolumnIndex- the column index position for the childrowIndex- the row index position for the child
-
setConstraints
public static void setConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan) Sets the column, row, column-span, and row-span value for the child when contained in a gridpane.- Parameters:
child- the child node of a gridpanecolumnIndex- the column index position for the childrowIndex- the row index position for the childcolumnspan- the number of columns the child should spanrowspan- the number of rows the child should span
-
setConstraints
public static void setConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment) Sets the grid position, spans, and alignment for the child when contained in a gridpane.- Parameters:
child- the child node of a gridpanecolumnIndex- the column index position for the childrowIndex- the row index position for the childcolumnspan- the number of columns the child should spanrowspan- the number of rows the child should spanhalignment- the horizontal alignment of the childvalignment- the vertical alignment of the child
-
setConstraints
public static void setConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment, Priority hgrow, Priority vgrow) Sets the grid position, spans, and alignment for the child when contained in a gridpane.- Parameters:
child- the child node of a gridpanecolumnIndex- the column index position for the childrowIndex- the row index position for the childcolumnspan- the number of columns the child should spanrowspan- the number of rows the child should spanhalignment- the horizontal alignment of the childvalignment- the vertical alignment of the childhgrow- the horizontal grow priority of the childvgrow- the vertical grow priority of the child
-
setConstraints
public static void setConstraints(Node child, int columnIndex, int rowIndex, int columnspan, int rowspan, HPos halignment, VPos valignment, Priority hgrow, Priority vgrow, Insets margin) Sets the grid position, spans, alignment, grow priorities, and margin for the child when contained in a gridpane.- Parameters:
child- the child node of a gridpanecolumnIndex- the column index position for the childrowIndex- the row index position for the childcolumnspan- the number of columns the child should spanrowspan- the number of rows the child should spanhalignment- the horizontal alignment of the childvalignment- the vertical alignment of the childhgrow- the horizontal grow priority of the childvgrow- the vertical grow priority of the childmargin- the margin of space around the child
-
clearConstraints
Removes all gridpane constraints from the child node.- Parameters:
child- the child node
-
hgapProperty
The width of the horizontal gaps between columns.- Returns:
- the width of the horizontal gaps between columns
- See Also:
-
setHgap
public final void setHgap(double value) Sets the value of thehgapproperty.- Property description:
- The width of the horizontal gaps between columns.
- Parameters:
value- the value for thehgapproperty- See Also:
-
getHgap
public final double getHgap()Gets the value of thehgapproperty.- Property description:
- The width of the horizontal gaps between columns.
- Returns:
- the value of the
hgapproperty - See Also:
-
vgapProperty
The height of the vertical gaps between rows.- Returns:
- the height of the vertical gaps between rows
- See Also:
-
setVgap
public final void setVgap(double value) Sets the value of thevgapproperty.- Property description:
- The height of the vertical gaps between rows.
- Parameters:
value- the value for thevgapproperty- See Also:
-
getVgap
public final double getVgap()Gets the value of thevgapproperty.- Property description:
- The height of the vertical gaps between rows.
- Returns:
- the value of the
vgapproperty - See Also:
-
alignmentProperty
The alignment of the grid within the gridpane's width and height.- Returns:
- the alignment of the grid within the gridpane's width and height
- See Also:
-
setAlignment
Sets the value of thealignmentproperty.- Property description:
- The alignment of the grid within the gridpane's width and height.
- Parameters:
value- the value for thealignmentproperty- See Also:
-
getAlignment
Gets the value of thealignmentproperty.- Property description:
- The alignment of the grid within the gridpane's width and height.
- Returns:
- the value of the
alignmentproperty - See Also:
-
gridLinesVisibleProperty
For debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns. Default isfalse.- Returns:
- true if lines are displayed to show the gridpane's rows and columns
- See Also:
-
setGridLinesVisible
public final void setGridLinesVisible(boolean value) Sets the value of thegridLinesVisibleproperty.- Property description:
- For debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns.
Default is
false. - Parameters:
value- the value for thegridLinesVisibleproperty- See Also:
-
isGridLinesVisible
public final boolean isGridLinesVisible()Gets the value of thegridLinesVisibleproperty.- Property description:
- For debug purposes only: controls whether lines are displayed to show the gridpane's rows and columns.
Default is
false. - Returns:
- the value of the
gridLinesVisibleproperty - See Also:
-
getRowConstraints
Returns list of row constraints. Row constraints can be added to explicitly control individual row sizing and layout behavior. If not set, row sizing and layout behavior is computed based on content. Index in the ObservableList denotes the row number, so the row constraint for the first row is at the position of 0.- Returns:
- the list of row constraints
-
getColumnConstraints
Returns list of column constraints. Column constraints can be added to explicitly control individual column sizing and layout behavior. If not set, column sizing and layout behavior is computed based on content. Index in the ObservableList denotes the column number, so the column constraint for the first column is at the position of 0.- Returns:
- the list of column constraints
-
add
Adds a child to the gridpane at the specified [column, row] position. This convenience method will set the gridpane column and row constraints on the child.- Parameters:
child- the node being added to the gridpanecolumnIndex- the column index position for the child within the gridpane, counting from 0rowIndex- the row index position for the child within the gridpane, counting from 0
-
add
Adds a child to the gridpane at the specified [column, row] position and spans. This convenience method will set the gridpane column, row, and span constraints on the child.- Parameters:
child- the node being added to the gridpanecolumnIndex- the column index position for the child within the gridpane, counting from 0rowIndex- the row index position for the child within the gridpane, counting from 0colspan- the number of columns the child's layout area should spanrowspan- the number of rows the child's layout area should span
-
addRow
Convenience method for placing the specified nodes sequentially in a given row of the gridpane. If the row already contains nodes the specified nodes will be appended to the row. For example, the first node will be positioned at [column,row], the second at [column+1,row], etc. This method will set the appropriate gridpane row/column constraints on the nodes as well as add the nodes to the gridpane's children sequence.- Parameters:
rowIndex- the row index position for the children within the gridpanechildren- the nodes to be added as a row in the gridpane
-
addColumn
Convenience method for placing the specified nodes sequentially in a given column of the gridpane. If the column already contains nodes the specified nodes will be appended to the column. For example, the first node will be positioned at [column, row], the second at [column, row+1], etc. This method will set the appropriate gridpane row/column constraints on the nodes as well as add the nodes to the gridpane's children sequence.- Parameters:
columnIndex- the column index position for the children within the gridpanechildren- the nodes to be added as a column in the gridpane
-
getContentBias
Description copied from class:NodeReturns 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:
getContentBiasin classNode- Returns:
- null unless one of its children has a content bias.
- See Also:
-
toString
-
getClassCssMetaData
Gets theCssMetaDataassociated with this class, which may include theCssMetaDataof its superclasses.- Returns:
- the
CssMetaData - 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:
getCssMetaDatain interfaceStyleable- Overrides:
getCssMetaDatain classRegion- Returns:
- The CssMetaData associated with this node, which may include the CssMetaData of its superclasses.
- Since:
- JavaFX 8.0
-
getRowCount
public final int getRowCount()Returns the number of rows in this GridPane.- Returns:
- the row count
- Since:
- 9
-
getColumnCount
public final int getColumnCount()Returns the number of columns in this GridPane.- Returns:
- the column count
- Since:
- 9
-
getCellBounds
Returns the bounds of the cell at the specified column and row position.- Parameters:
columnIndex- the column index position for the cell within this GridPane, counting from 0rowIndex- the row index position for the cell within this GridPane, counting from 0- Returns:
- the bounds of the cell at columnIndex and rowIndex.
- Since:
- 9
-
snapPositionX()andsnapPositionY()