public class javafx.scene.layout.Container

Inherits from: com.sun.javafx.runtime.FXBase > javafx.scene.Node > javafx.scene.Parent > javafx.scene.Group > javafx.scene.layout.Container javafx.scene.Group, javafx.scene.Parent, javafx.scene.Node, javafx.scene.layout.Resizable,

Known subclasses: javafx.scene.layout.Flow, javafx.scene.layout.HBox, javafx.scene.layout.Panel, javafx.scene.layout.Stack, javafx.scene.layout.Tile, javafx.scene.layout.VBox,

• Jump to Section:
• overview
• variables
• functions

Inherited Variables

javafx.scene.Group

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	blendMode	BlendMode				SRC_OVER	The BlendMode used to blend the children with each other. The BlendMode used to blend the children with each other. Children are blended in the order they appear in the content attribute with later children in the sequence blended over the earlier children using the specified mode. SRC_OVER Profile: desktop  
public	content	Node[]				empty	A sequence of child Nodes that will be rendered in order whenever this Group is rendered. A sequence of child Nodes that will be rendered in order whenever this Group is rendered. See the class documentation for Node for scene graph structure restrictions on setting a Group's content sequence. If these restrictions are violated by a change to the content sequence, the change is ignored and the previous value of the content sequence is restored. Throws: AssignToBoundException if the same node appears in two different bound sequences. empty Profile: common  

javafx.scene.Parent

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public-read protected	needsLayout	Boolean		subclass	subclass

javafx.scene.Node

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	blocksMouse	Boolean				false	If true, consumes mouse events in this Node and does not send them to other nodes further up the scene graph. If true, consumes mouse events in this Node and does not send them to other nodes further up the scene graph. If a Node wants to block mouse events from going to nodes which are visually obscured by this Node, then set blocksMouse to true. false Profile: common conditional mouse  
public-read	boundsInLocal	Bounds					The rectangular bounds of this Node in the Node's untransformed local coordinate space. The rectangular bounds of this Node in the Node's untransformed local coordinate space. For nodes that extend javafx.scene.shape.Shape, the local bounds will also include space required for a non-zero stroke that may fall outside the shape's geometry that is defined by position and size attributes. The local bounds will also include any clipping set with clip as well as effects set with effect. Note that this method does not take the node's visibility into account; the test is based on the geometry of this Node only. This variable will always be a non-null value. Note that boundsInLocal is automatically recomputed whenever the geometry of a node changes. For this reason, it is an error to bind any of these values in a node to an expression that depends upon this variable. For example, the "x" or "y" variables of a shape should never be bound to boundsInLocal for the purpose of positioning the node. Profile: common  
public-read	boundsInParent	Bounds					The rectangular bounds of this Node which include its transforms. The rectangular bounds of this Node which include its transforms. boundsInParent is calculated by taking its local bounds (defined by boundsInLocal) and applying the transform created by setting the following additional variables: transforms[] sequence layoutX, layoutY translateX, translateY scaleX, scaleY rotate The resulting bounds will be conceptually in the coordinate space of the Node's parent, however the node need not have a parent to calculate these bounds. Note that this method does not take the node's visibility into account; the test is based on the geometry of this Node only. This variable will always be a non-null value. Note that boundsInParent is automatically recomputed whenever the geometry of a node changes, or when any of the following change: the transforms sequence, the translateX, translateY, layoutX, layoutY, scaleX, scaleY, or rotate variable. For this reason, it is an error to bind any of these values in a node to an expression that depends upon this variable. For example, the "x" or "y" variables of a shape, or translateX, translateY should never be bound to boundsInParent for the purpose of positioning the node. Profile: common  
public	cache	Boolean				false	A performance hint to the system to indicate that this Node should be cached as a bitmap. A performance hint to the system to indicate that this Node should be cached as a bitmap. Rendering a bitmap representation of a node will be faster than rendering primitives in many cases, especially in the case of primitives with effects applied (such as a blur). However, it also increases memory usage. This hint indicates whether that trade-off (increased memory usage for increased performance) is worthwhile. Also note that on some platforms such as GPU accelerated platforms there is little benefit to caching Nodes as bitmaps when blurs and other effects are used since they are very fast to render on the GPU. false Profile: common  
public	clip	Node				null	Specifies a Node to use to define the the clipping shape for this Node. Specifies a Node to use to define the the clipping shape for this Node. This clipping Node is not a child of this Node in the scene graph sense. Rather, it is used to define the clip for this Node. For example, you can use an javafx.scene.image.ImageView Node as a mask to represent the Clip. Or you could use one of the geometric shape Nodes such as javafx.scene.shape.Rectangle or javafx.scene.shape.Circle. Or you could use a javafx.scene.text.Text node to represent the Clip. See the class documentation for Node for scene graph structure restrictions on setting the clip. If these restrictions are violated by a change to the clip variable, the change is ignored and the previous value of the clip variable is restored. null Profile: common conditional clip  
public	cursor	Cursor				null	Defines the mouse cursor for this Node and subnodes. Defines the mouse cursor for this Node and subnodes. If null, then the cursor of the first parent node with a non-null cursor will be used. If no Node in the scene graph defines a cursor, then the cursor of the Scene will be used. null Profile: common conditional cursor  
public	disable	Boolean				false	Sets the individual disabled state of this Node. Sets the individual disabled state of this Node. Setting disable to true will cause this Node and any subnodes to become disabled. This variable should be used only to set the disabled state of a Node. For querying the disabled state of a Node, the disabled variable should instead be used, since it is possible that a Node was disabled as a result of an ancestor being disabled even if the individual disable state on this Node is false. false Profile: common  
public-read	disabled	Boolean				false	Indicates whether or not this Node is disabled. Indicates whether or not this Node is disabled. A Node will become disabled if disable is set to true on either itself or one of its ancestors in the scene graph. A disabled Node should render itself differently to indicate its disabled state to the user. Such disabled rendering is dependent on the implementation of the Node. The shape classes contained in javafx.scene.shape do not implement such rendering by default, therefore applications using shapes for handling input must implement appropriate disabled rendering themselves. The user-interface controls defined in javafx.scene.control will implement disabled-sensitive rendering, however. A disabled Node does not receive mouse or key events. false Profile: common  
public	effect	Effect				null	Specifies an effect to apply to this Node.
public-read protected	focused	Boolean		subclass	subclass	false	Indicates whether this Node is the current input focus owner. Indicates whether this Node is the current input focus owner. Only one node at a time may be the current focus owner. false Profile: common  
public	focusTraversable	Boolean				fase	Specifies whether this Node should be a part of focus traversal cycle. Specifies whether this Node should be a part of focus traversal cycle. When this property is true focus can be moved to this Node and from this Node using regular focus traversal keys. On a desktop such keys are usually TAB for moving focus forward and SHIFT+TAB for moving focus backward. By default the first focus traversable and focusable Node added to a Scene is to receive focus by default. fase Profile: common  
public-read protected	hover	Boolean		subclass	subclass	false	Whether or not this Node is being hovered over. Whether or not this Node is being hovered over. Typically this is due to the mouse being over the node, though it could be due to a pen hovering on a graphics tablet or other form of input. NOTE: the current implementation of hover relies on mouse enter and exit events to determine whether this Node is in the hover state; this means that this feature is currently supported only on systems that have a mouse. Future implementations may provide alternative means of supporting hover. false Profile: common  
public	id	String				empty string	The id of this Node. The id of this Node. This simple string identifier is useful for finding a specific Node within the scene graph. While the id of a Node should be unique within the scene graph, this uniqueness is not enforced. This is much like the "id" attribute of an HTML element. empty string Profile: common  
public-read protected	layoutBounds	Bounds		subclass	subclass		The rectangular bounds that should be used in calculations for both manual and automatic layout of this Node. The rectangular bounds that should be used in calculations for both manual and automatic layout of this Node. By default, layoutBounds will be equal to the geometric bounds of the node and does not include the effect, clip, or transforms. Note that the layoutX, layoutY, translateX, and translateY variables are not included in the layoutBounds. This is important because layout code must first determine the current size and location of the Node (using layoutBounds) and then set layoutX and layoutY to adjust the translation of the Node so that it will have the desired layout position. layoutBounds is automatically recomputed whenever the geometry of a node changes. For this reason, it is an error to bind any of these values in a node to an expression that depends upon this variable. For example, the "x" or "y" variables of a shape should never be bound to layoutBounds for the purpose of positioning the node. Profile: common  
public	layoutInfo	LayoutInfoBase					Hook for node-specific layout information used by layout containers. Hook for node-specific layout information used by layout containers. If the node is not a child of a container which supports layout info, this variable will be ignored. Note that layoutInfo object literals may be shared across nodes, which means altering the vars in layoutInfo will affect all such nodes.  
public	layoutX	Number				0	Defines the X coordinate of the translation that is added to the transformed coordinates of this Node for the purpose of layout. Defines the X coordinate of the translation that is added to the transformed coordinates of this Node for the purpose of layout. Containers or Groups performing layout will set this variable relative to layoutBounds.minX in order to position the node at the desired layout location. For example, if child should have a final location of finalX: child.layoutX = finalX - child.layoutBounds.minX; 0 Profile: common  
public	layoutY	Number				0	Defines the Y coordinate of the translation that is added to the transformed coordinates of this Node for the purpose of layout. Defines the Y coordinate of the translation that is added to the transformed coordinates of this Node for the purpose of layout. Containers or Groups performing layout will set this variable relative to layoutBounds.minY in order to position the node at the desired layout location. For example, if child should have a final location of finalY: child.layoutY = finalY - child.layoutBounds.minY; 0 Profile: common  
public	onKeyPressed	function(:KeyEvent):Void					Defines a function to be called when this Node has input focus and a key has been pressed.
public	onKeyReleased	function(:KeyEvent):Void					Defines a function to be called when this Node has input focus and a key has been released.
public	onKeyTyped	function(:KeyEvent):Void					Defines a function to be called when this Node has input focus and a key has been typed. Defines a function to be called when this Node has input focus and a key has been typed. * Profile: common conditional keyboard  
public	onMouseClicked	function(:MouseEvent):Void					Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.
public	onMouseDragged	function(:MouseEvent):Void					Defines a function to be called when a mouse button is pressed on this Node and then dragged.
public	onMouseEntered	function(:MouseEvent):Void					Defines a function to be called when the mouse enters this Node.
public	onMouseExited	function(:MouseEvent):Void					Defines a function to be called when the mouse exits this Node.
public	onMouseMoved	function(:MouseEvent):Void					Defines a function to be called when mouse cursor moves within this Node but no buttons have been pushed.
public	onMousePressed	function(:MouseEvent):Void					Defines a function to be called when a mouse button has been pressed on this Node.
public	onMouseReleased	function(:MouseEvent):Void					Defines a function to be called when a mouse button has been released on this Node.
public	onMouseWheelMoved	function(:MouseEvent):Void					Defines a function to be called when the mouse scroll wheel has moved.
public	opacity	Number				1.0	Specifies how opaque (that is, solid) the Node appears. Specifies how opaque (that is, solid) the Node appears. A Node with 0% opacity is fully translucent. That is, while it is still visible and rendered, you generally won't be able to see it. The exception to this rule is when the ZNode is combined with a blending mode and blend effect in which case a translucent Node may still have an impact in rendering. An opacity of 50% will render the node as being 50% transparent. A visible node with any opacity setting still receives mouse events and can receive keyboard focus. For example, if you want to have a large invisible rectangle overlay all Nodes in the scene graph in order to intercept mouse events but not be visible to the user, you could create a large Rectangle that had an opacity of 0%. Opacity is specified as a value between 0 and 1. Values less than 0 or greater than 1 are clipped to 0 and 1 respectively. On some platforms ImageView might not support opacity variable. // TODO ROCHELLE: Can we elaborate on this? What determines whether it is supported or not?? 1.0 Profile: common  
public-read package	parent	Parent				null	The parent of this Node. The parent of this Node. If this Node has not been added to a scene graph, then parent will be null. null Profile: common  
public-read protected	pressed	Boolean		subclass	subclass	false	Whether or not the Node is pressed. Whether or not the Node is pressed. Typically this is true when the primary mouse button is down, though subclasses may define other mouse button state or key state to cause the node to be "pressed". false Profile: common  
public	rotate	Number				0.0	Defines the angle of rotation about the Node's center, measured in degrees. Defines the angle of rotation about the Node's center, measured in degrees. This is used to rotate the Node. This rotation factor is not included in layoutBounds by default, which makes it ideal for rotating the entire node after all effects and transforms have been taken into account. The pivot point about which the rotation occurs is the center of the untransformed layoutBounds. Note that because the pivot point is computed as the center of this Node's layout bounds, any change to the layout bounds will cause the pivot point to change, which can move the object. For a leaf node, any change to the geometry will cause the layout bounds to change. For a group node, any change to any of its children, including a change in a child's geometry, clip, effect, position, orientation, or scale, will cause the group's layout bounds to change. If this movement of the pivot point is not desired, applications should instead use the Node's transforms[] sequence, and add a javafx.scene.transform.Rotate transform, which has a user-specifiable pivot point. 0.0 Profile: common  
public	scaleX	Number				1.0	Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node. Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node. This is used to stretch or animate the node either manually or by using an animation. This scale factor is not included in layoutBounds by default, which makes it ideal for scaling the entire node after all effects and transforms have been taken into account. The pivot point about which the scale occurs is the center of the untransformed layoutBounds. 1.0 Profile: common  
public	scaleY	Number				1.0	Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node. Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node. This is used to stretch or animate the node either manually or by using an animation. This scale factor is not included in layoutBounds by default, which makes it ideal for scaling the entire node after all effects and transforms have been taken into account. The pivot point about which the scale occurs is the center of the untransformed layoutBounds. 1.0 Profile: common  
public-read package	scene	Scene				null	The Scene that this Node is part of. The Scene that this Node is part of. If the Node is not part of a scene, then this variable will be null. null Profile: common  
public	style	String				empty string	A string representation of the CSS style associated with this specific Node. A string representation of the CSS style associated with this specific Node. This is exactly analogous to the "style" attribute on an HTML element, but uses the syntax defined in JavaFX CSS. empty string Profile: desktop  
public	styleClass	String				empty string	A String identifier which can be used to logically group Nodes, specifically for an external style engine. A String identifier which can be used to logically group Nodes, specifically for an external style engine. This variable is exactly analogous to the styleClass attribute on an HTML element. empty string Profile: common  
public	transforms	Transform[]				empty	Defines the sequence of javafx.scene.transform.Transform objects to be applied to this Node. Defines the sequence of javafx.scene.transform.Transform objects to be applied to this Node. This sequence of transforms is applied before translateX, translateY, scaleX, and scaleY, rotate transforms. By default, layoutBounds is defined as the local bounds with all the transforms in this sequence applied. empty Profile: common  
public	translateX	Number				0	Defines the X coordinate of the translation that is added to the transformed coordinates of this Node. Defines the X coordinate of the translation that is added to the transformed coordinates of this Node. This value will be added to any translation defined by the transforms sequence and layoutX. This variable can be used to alter the location of a Node without disturbing its layout bounds, which makes it useful for animating a node's location. 0 Profile: common  
public	translateY	Number				0	Defines the Y coordinate of the translation that is added to the transformed coordinates of this Node. Defines the Y coordinate of the translation that is added to the transformed coordinates of this Node. This value will be added to any translation defined by the transforms sequence and layoutY. This variable can be used to alter the location of a Node without disturbing its layout bounds, which makes it useful for animating a node's location. 0 Profile: common  
public	visible	Boolean				true	Specifies whether this Node and any subnodes should be rendered as part of the scene graph. Specifies whether this Node and any subnodes should be rendered as part of the scene graph. A node may be visible and yet not be shown in the rendered scene if, for instance, it is off the screen or obscured by another Node. Invisible nodes never receive mouse events or keyboard focus, and never maintain keyboard focus when they become invisible. true Profile: common  

javafx.scene.layout.Resizable

access	name	type	Can Read	Can Init	Can Write	Default Value	description
public	height	Number					The height of the Resizable. The height of the Resizable. Any javafx.scene.Node subclass which mixes in Resizable should ensure that layoutBounds.height is bound to this value and invokes requestLayout in height's on replace trigger. Profile: common  
public	width	Number					The width of the Resizable. The width of the Resizable. Any javafx.scene.Node subclass which mixes in Resizable should ensure that layoutBounds.width is bound to this value and invokes requestLayout in width's on replace trigger. Profile: common  

public getManaged(content: Node[]) : java.lang.Object[]

Utility function which returns the sequence of nodes within the content whose layout should be managed by its container.

Utility function which returns the sequence of nodes within the content whose layout should be managed by its container. Container subclasses should pass their content sequence into this function to determine their set of managed children.

Parameters

content

Returns

Object[]

 

public getNodeHPos(node: Node, fallback: HPos) : HPos

Utility function which returns the horizontal layout position of the Node which defines how the node should be horizontally aligned within its layout space if the width of the layout space is greater than the layout bounds width of the node.

Utility function which returns the horizontal layout position of the Node which defines how the node should be horizontally aligned within its layout space if the width of the layout space is greater than the layout bounds width of the node.

If the node has a non-null layoutInfo where hpos is set, then that value is returned, else the fallback value is returned.

Parameters

node

fallback

Returns

HPos

 

public getNodeMaxHeight(node: Node) : Number

Utility function which returns the maximum height of the Node.

Utility function which returns the maximum height of the Node. Layout containers should not set the height of the node to a value greater than this value.

If the node is Resizable and it has a non-null layoutInfo where maxHeight is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getMaxHeight function will be returned.

If the node is not Resizable, returns its current layout bounds height.

Parameters

node

Returns

Number

 

public getNodeMaxWidth(node: Node) : Number

Utility function which returns the maximum width of the Node.

Utility function which returns the maximum width of the Node. Layout containers should not set the width of the node to a value greater than this value.

If the node is Resizable and it has a non-null layoutInfo where maxWidth is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getMaxWidth function will be returned.

If the node is not Resizable, returns its current layout bounds width.

Parameters

node

Returns

Number

 

public getNodeMinHeight(node: Node) : Number

Utility function which returns the minimum height of the Node.

Utility function which returns the minimum height of the Node. Layout containers should not set the height of the node to a value less than this value.

If the node is Resizable and it has a non-null layoutInfo where minHeight is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getMinHeight function will be returned.

If the node is not Resizable, then its layout bounds height is returned.

Parameters

node

Returns

Number

 

public getNodeMinWidth(node: Node) : Number

Utility function which returns the minimum width of the Node.

Utility function which returns the minimum width of the Node. Layout containers should not set the width of the node to a value less than this value.

If the node is Resizable and it has a non-null layoutInfo where minWidth is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getMinWidth function will be returned.

If the node is not Resizable, then its layout bounds width is returned.

Parameters

node

Returns

Number

 

public getNodePrefHeight(node: Node) : Number

Utility function which returns the preferred height of the Node.

Utility function which returns the preferred height of the Node. Layout containers should strive to set the height of the node to this value.

If the node is Resizable and it has a non-null layoutInfo where height is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getPrefHeight function will be returned.

If the node is not Resizable, returns its current layout bounds height.

Parameters

node

Returns

Number

 

public getNodePrefHeight(node: Node, width: Number) : Number

Utility function which returns the preferred height of the Node for the given width.

Utility function which returns the preferred height of the Node for the given width. Layout containers should strive to set the height of the node to this value.

If the node is Resizable and it has a non-null layoutInfo where height is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getPrefHeight function will be returned.

If the node is not Resizable, returns its current layout bounds height.

Parameters

node

width

Returns

Number

 

public getNodePrefWidth(node: Node) : Number

Utility function which returns the preferred width of the Node.

Utility function which returns the preferred width of the Node. Layout containers should strive to set the width of the node to this value.

If the node is Resizable and it has a non-null layoutInfo where width is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getPrefWidth function will be returned.

If the node is not Resizable, returns its current layout bounds width.

Parameters

node

Returns

Number

 

public getNodePrefWidth(node: Node, height: Number) : Number

Utility function which returns the preferred width of the Node for the given height.

Utility function which returns the preferred width of the Node for the given height. Layout containers should strive to set the width of the node to this value.

If the node is Resizable and it has a non-null layoutInfo where width is set to a value greater than or equal to 0, then that value will be returned, else the value of the resizable's getPrefWidth function will be returned.

If the node is not Resizable, returns its current layout bounds width.

Parameters

node

height

Returns

Number

 

public getNodeVPos(node: Node, fallback: VPos) : VPos

Utility function which returns the vertical layout position of the Node which defines how the node should be vertically aligned within its layout space if the height of the layout space is greater than the layout bounds height of the node.

Utility function which returns the vertical layout position of the Node which defines how the node should be vertically aligned within its layout space if the height of the layout space is greater than the layout bounds height of the node.

If the node has a non-null layoutInfo where vpos is set, then that value is returned, else the fallback value is returned.

Parameters

node

fallback

Returns

VPos

 

public layoutNode(node: Node, x: Number, y: Number, width: Number, height: Number) : Boolean

Utility function which Lays out the node so that it will be positioned at x,y and if its Resizable, will also set its size to width x height.

Utility function which Lays out the node so that it will be positioned at x,y and if its Resizable, will also set its size to width x height. If the node's width and/or height are bound values then the bound dimension(s) will not be altered. If either the width and/or height were resized, returns true else returns false.

Parameters

node

x

y

width

height

Returns

Boolean

 

public layoutNode(node: Node, areaX: Number, areaY: Number, areaW: Number, areaH: Number, hpos: HPos, vpos: VPos) : Boolean

Utility function which Lays out the node relative to the specified layout area defined by areaX, areaY, areaW x areaH.

Utility function which Lays out the node relative to the specified layout area defined by areaX, areaY, areaW x areaH. If the node has layoutInfo set, then those variables will be used to define the layout as described below.

If the node is Resizable, this function will attempt to resize it to fill the layout area; if the node's maximum width or height is less than the layout area's width or height, then the resizable node's maximum will be used. The node's maximum dimensions are calculated by first looking for maxWidth and/or maxHeight variables set on the node's layoutInfo, and if those are not present then it uses the values returned by getMaxWidth and getMaxHeight on the resizable node.

If the node's size differs from the area's size, then this function will align the node relative to the area using horizontal and vertical position values. These position values are calculated by first looking for set vpos and/or hpos variables on the node's layoutInfo, and if those are not present then it uses the hpos and vpos parameters passed into this function.

Parameters

node

areaX

areaY

areaW

areaH

hpos

vpos

Returns

Boolean

 

public managed(node: Node) : Boolean

Utility function which returns the value of the node's layoutInfo managed variable (if set), otherwise returns true.

Utility function which returns the value of the node's layoutInfo managed variable (if set), otherwise returns true. If the returned value is false, then its container should not manage the layout of the node.

Parameters

node

Returns

Boolean

 

public positionNode(node: Node, x: Number, y: Number) : Void

Utility function which positions the node at x,y by setting layoutX and layoutY to translate the node from it's current layout bounds minX and minY values to x,y.

Utility function which positions the node at x,y by setting layoutX and layoutY to translate the node from it's current layout bounds minX and minY values to x,y.

Parameters

node

x

y

 

public positionNode(node: Node, areaX: Number, areaY: Number, areaW: Number, areaH: Number, hpos: HPos, vpos: VPos) : Void

Utility function which positions the node relative to the specified layout area defined by areaX, areaY, areaW x areaH.

Utility function which positions the node relative to the specified layout area defined by areaX, areaY, areaW x areaH.

This function does not resize the node and uses the node's layout bounds width and height to determine how it should be positioned within the area. If the node's size differs from the area's size, then this function will align the node relative to the area using horizontal and vertical position values. These position values are calculated by first looking for vpos and/or hpos variables set on the node's layoutInfo, and if those are not present then it uses the hpos and vpos parameters passed into this function.

Parameters

node

areaX

areaY

areaW

areaH

hpos

vpos

 

public resizeNode(node: Node, width: Number, height: Number) : Boolean

Utility function which resizes the node if possible.

Utility function which resizes the node if possible. If the node is Resizable and either its width and/or height variables are not bound, then this function sets the width and/or height and returns true. If width and height are bound or the node is not Resizable then this function does nothing and returns false.

Parameters

node

width

height

Returns

Boolean

 

public setNodeHeight(node: Node, height: Number) : Boolean

Utility function which resizes the node's height if possible.

Utility function which resizes the node's height if possible. If the node is Resizable and its height is not bound, sets the height and returns true, else does nothing and returns false.

Parameters

node

height

Returns

Boolean

 

public setNodeWidth(node: Node, width: Number) : Boolean

Utility function which resizes the node's width if possible.

Utility function which resizes the node's width if possible. If the node is Resizable and its width is not bound, sets the width and returns true, else does nothing and returns false.

Parameters

node

width

Returns

Boolean

 

getPrefHeight(width: Number) : Number

Returns the preferred height of this container.

Returns the preferred height of this container. The default implementation of this function returns the height required to encompass the preferred layout bounds of all managed content. The width parameter is ignored.

Parameters

width

Returns

Number

 

getPrefWidth(height: Number) : Number

Returns the preferred width of this container.

Returns the preferred width of this container. The default implementation of this function returns the width required to encompass the preferred layout bounds of all managed content. The height parameter is ignored.

Parameters

height

Returns

Number

 

protected initSize() : Void

Called from postinit to enable the container to set the width and height if they have not already been initialized.

Called from postinit to enable the container to set the width and height if they have not already been initialized. The default implementation will set the width/height to the preferred width/height of the container.

 

Inherited Functions

javafx.scene.Group

protected impl_createPGNode() : com.sun.javafx.sg.PGNode

Returns

PGNode

 

public lookup(id: java.lang.String) : Node

Parameters

id

Returns

Node

 

javafx.scene.Parent

protected doLayout() : Void

The function which lays out the content of this parent.

The function which lays out the content of this parent. This function will be called during the top-down layout pass if this parent's needsLayout flag is true.

 

public layout() : Void

Executes a top-down layout pass on the scene graph under this parent.

Executes a top-down layout pass on the scene graph under this parent.

 

public requestLayout() : Void

 

javafx.scene.Node

public contains(localX: Number, localY: Number) : Boolean

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node. Note that this method does not take visibility into account; the test is based on the geometry of this Node only.

Parameters

localX

localY

Returns

Boolean

Profile: common

 

public contains(localPoint: Point2D) : Boolean

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node. Note that this method does not take visibility into account; the test is based on the geometry of this Node only.

Parameters

localPoint

Returns

Boolean

Profile: common

 

protected impl_boundsChanged() : Void

Invoked by anything which may cause the boundsInLocal to change.

Invoked by anything which may cause the boundsInLocal to change. We do it this way to avoid actually having to recompute the bounds (ie, if I put an on replace trigger on boundsInLocal, then it would force the recomputation of bounds in every case even in situations where we don't need to be computing bounds. This way we don't do that).

Invoking this function will cause the entire chain of parent nodes to this node to be notified that their child bounds have changed, which may cause them to revalidate their bounds if somebody is listening to their bounds, or in the simplest case will just walk up the tree and notify that bounds have changed.

 

protected abstract impl_createPGNode() : com.sun.javafx.sg.PGNode

Returns

PGNode

 

public impl_effectChanged() : Void

Invoked whenever the effect has changed internally.

Invoked whenever the effect has changed internally.

 

public impl_getLeafTransform() : com.sun.javafx.geom.AffineTransform

Currently used only by Toolkit.createAnimationPathHelper().

Currently used only by Toolkit.createAnimationPathHelper().

Returns

AffineTransform

 

public impl_getPGNode() : com.sun.javafx.sg.PGNode

Returns

PGNode

 

public impl_getPivotX() : Number

Returns

Number

 

public impl_getPivotY() : Number

Returns

Number

 

public impl_isInitialized() : Boolean

Note I use a private variable / public function pair to avoid creation of a Location object and to prevent binding to the initialized variable.

Note I use a private variable / public function pair to avoid creation of a Location object and to prevent binding to the initialized variable.

Returns

Boolean

 

protected impl_processKeyEvent(e: KeyEvent) : Void

Parameters

e

 

protected impl_processMouseEvent(e: MouseEvent) : Void

Parameters

e

 

public impl_requestFocusImpl(f: com.sun.javafx.functions.Function0) : Void

Some nodes require a special handling to request focus.

Some nodes require a special handling to request focus.

Parameters

f

 

public impl_transformsChanged() : Void

Invoked whenever the transforms[] sequence changes, or by the transforms in that sequence whenever they are changed.

Invoked whenever the transforms[] sequence changes, or by the transforms in that sequence whenever they are changed.

 

public intersects(localX: Number, localY: Number, localWidth: Number, localHeight: Number) : Boolean

Returns true if the given rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node.

Returns true if the given rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node. Note that this method does not take visibility into account; the test is based on the geometry of this Node only. The default behavior of this function is simply to check if the given coordinates intersect with the local bounds.

Parameters

localX

localY

localWidth

localHeight

Returns

Boolean

Profile: common

 

public intersects(localBounds: Bounds) : Boolean

Returns true if the given bounds (specified in the local coordinate space of this Node) intersects the shape of this Node.

Returns true if the given bounds (specified in the local coordinate space of this Node) intersects the shape of this Node. Note that this method does not take visibility into account; the test is based on the geometry of this Node only. The default behavior of this function is simply to check if the given coordinates intersect with the local bounds.

Parameters

localBounds

Returns

Boolean

Profile: common

 

public localToParent(localX: Number, localY: Number) : Point2D

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Parameters

localX

localY

Returns

Point2D

Profile: common

 

public localToParent(localPoint: Point2D) : Point2D

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Parameters

localPoint

Returns

Point2D

Profile: common

 

public localToParent(localBounds: Bounds) : Bounds

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its parent.

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its parent.

Parameters

localBounds

Returns

Bounds

Profile: common

 

public localToScene(localX: Number, localY: Number) : Point2D

Transforms a point from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Transforms a point from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Parameters

localX

localY

Returns

Point2D

Profile: common

 

public localToScene(localPoint: Point2D) : Point2D

Transforms a point from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Transforms a point from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Parameters

localPoint

Returns

Point2D

Profile: common

 

public localToScene(localBounds: Bounds) : Bounds

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its javafx.scene.Scene.

Parameters

localBounds

Returns

Bounds

Profile: common

 

public lookup(id: java.lang.String) : Node

Finds this Node, or the first subnode, with the given id.

Finds this Node, or the first subnode, with the given id. If multiple subnodes have the same id, this function returns one of them. Which node it returns in that case is unspecified.

Parameters

id

The id of the node to find

Returns

Node

The first node, starting from this Node , which has an id of id .

Profile: common

 

public parentToLocal(parentX: Number, parentY: Number) : Point2D

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Parameters

parentX

parentY

Returns

Point2D

Profile: common

 

public parentToLocal(parentPoint: Point2D) : Point2D

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Parameters

parentPoint

Returns

Point2D

Profile: common

 

public parentToLocal(parentBounds: Bounds) : Bounds

Transforms a rectangle from the coordinate space of the parent into the local coordinate space of this Node.

Transforms a rectangle from the coordinate space of the parent into the local coordinate space of this Node.

Parameters

parentBounds

Returns

Bounds

Profile: common

 

public requestFocus() : Void

Requests that this Node get the input focus, and that this Node's top-level ancestor become the focused Window.

Requests that this Node get the input focus, and that this Node's top-level ancestor become the focused Window. If this node is not part of a scene graph rooted in a stage that is visible and can accept input focus, then calls to request focus will not cause this Node to become focused.

Profile: common

 

public sceneToLocal(sceneX: Number, sceneY: Number) : Point2D

Transforms a point from the coordinate space of the Scene into the local coordinate space of this Node.

Transforms a point from the coordinate space of the Scene into the local coordinate space of this Node.

Parameters

sceneX

sceneY

Returns

Point2D

Profile: common

 

public sceneToLocal(scenePoint: Point2D) : Point2D

Transforms a point from the coordinate space of the javafx.scene.Scene into the local coordinate space of this Node.

Transforms a point from the coordinate space of the javafx.scene.Scene into the local coordinate space of this Node.

Parameters

scenePoint

Returns

Point2D

Profile: common

 

public sceneToLocal(sceneBounds: Bounds) : Bounds

Transforms a rectangle from the coordinate space of the javafx.scene.Scene into the local coordinate space of this Node.

Transforms a rectangle from the coordinate space of the javafx.scene.Scene into the local coordinate space of this Node.

Parameters

sceneBounds

Returns

Bounds

Profile: common

 

public toBack() : Void

Moves this Node to the back of its sibling nodes in terms of z-order.

Moves this Node to the back of its sibling nodes in terms of z-order. This is accomplished by moving this Node to the first position in its parent's content sequence. This function has no effect if this Node is not part of a group.

Profile: common

 

public toFront() : Void

Moves this Node to the front of its sibling nodes in terms of z-order.

Moves this Node to the front of its sibling nodes in terms of z-order. This is accomplished by moving this Node to the last position in its parent's content sequence. This function has no effect if this Node is not part of a group.

Profile: common

 

public toString() : java.lang.String

Returns

String

 

javafx.scene.layout.Resizable

public getMaxHeight() : Number

Returns the maximum height of the Resizable.

Returns the maximum height of the Resizable. Layout containers should strive not to set the Resizable's height larger than this value. This value is computed by the node subclass using applicable state and variable settings and is not directly settable by applications.

Returns

Number

Profile: common

 

public getMaxWidth() : Number

Returns the preferred height of the Resizable.

Returns the preferred height of the Resizable. Layout containers should strive not to set the Resizable's width larger than this value. This value is computed by the node subclass using applicable state and variable settings and is not directly settable by applications.

Returns

Number

Profile: common

 

public getMinHeight() : Number

Returns the minimum height of the Resizable.

Returns the minimum height of the Resizable. Layout containers should strive not to set the Node's height smaller than this value. This value is computed by the node subclass using applicable state and variable settings and is not directly settable by applications.

Returns

Number

Profile: common

 

public getMinWidth() : Number

Returns the minimum width of the Resizable.

Returns the minimum width of the Resizable. Layout containers should strive not to set the Node's width smaller than this value. This value is calculated by the node subclass using applicable state and variable settings and is not directly settable by applications.

Returns

Number

Profile: common

 

public abstract getPrefHeight(width: Number) : Number

Returns the preferred height of the Resizable given the specified width.

Returns the preferred height of the Resizable given the specified width. If a particular width need not be factored into the result, -1 may be passed in as the width parameter. Implementations of this function may also choose to ignore width if it does not impact the result.

Layout containers should set the Resizable's height to this value whenever possible. This value is computed by the node subclass using applicable state and variable settings and is not directly settable by applications.

Parameters

width

Returns

Number

Profile: common

 

public abstract getPrefWidth(height: Number) : Number

Returns the preferred width of the Resizable given the specified height.

Returns the preferred width of the Resizable given the specified height. If a particular height need not be factored into the result, -1 may be passed in as the height parameter. Implementations of this function may also choose to ignore height if it does not impact the result.

Layout containers should set the Resizable's width to this value whenever possible. This value is computed by the node subclass using applicable state and variable settings and is not directly settable by applications.

Parameters

height

Returns

Number

Profile: common