Overview
AreaChart - Plots the area between the line that connects the data points and the 0 line on the Y axis.
Profile: common
Variable Summary
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | data | Series[] |
The chart data series |
||||
public | dataOpacity | Number |
The opacity of all data symbols, this is applied to each indervidual area so they are layered |
||||
public-init | xAxis | ValueAxis |
The X axis, by default it is along the bottom of the plot |
||||
public-init | yAxis | ValueAxis |
The Y axis, by default it is on the left side of the plot |
Inherited Variables
javafx.scene.chart.XYChart
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | customBackgroundContent | Node |
Custom content that is drawn under the data and over the top of plot background and gridlines |
||||
public | horizontalAlternateRowFill | Paint |
The fill for horizontal alternative painting |
||||
public | horizontalGridLineStroke | Paint |
The stroke paint for horizontal grid lines |
||||
public | horizontalGridLineStrokeDashArray | Number[] |
The stroke dash array for horizontal grid lines |
||||
public | horizontalGridLineStrokeWidth | Number |
The stroke width for horizontal grid lines |
||||
public | horizontalGridLineVisible | Boolean |
True if horizontal grid lines should be drawn |
||||
public | horizontalZeroLineVisible | Boolean | true |
If this is true and the horizontal axis has both positive and negative values then a aditional axis line will be drawn at the zero point |
|||
protected | plot | Container | subclass | subclass | subclass |
This is the panel that contains the plot, any subclasses need to set this to the panel that contains their graphics. This is the panel that contains the plot, any subclasses need to set this to the panel that contains their graphics. It is layed out to be the rectangular area between the two axis by this class stting its layoutX, layoutY, width and height. |
|
public | plotBackgroundFill | Paint |
The fill used for plot background rectangle defined by the two axis |
||||
public | plotBackgroundStroke | Paint |
The stroke used for plot background rectangle defined by the two axis |
||||
public | plotBackgroundStrokeWidth | Number |
The stroke width used for plot background rectangle defined by the two axis |
||||
public | verticalAlternateRowFill | Paint |
The fill for vertical alternative painting |
||||
public | verticalGridLineStroke | Paint |
The stroke paint for vertical grid lines |
||||
public | verticalGridLineStrokeDashArray | Number[] |
The stroke dash array for vertical grid lines |
||||
public | verticalGridLineStrokeWidth | Number |
The stroke width for vertical grid lines |
||||
public | verticalGridLineVisible | Boolean |
True if vertical grid lines should be drawn |
||||
public | verticalZeroLineVisible | Boolean | true |
If this is true and the vertical axis has both positive and negative values then a aditional axis line will be drawn at the zero point |
|||
protected | xyAxisX | Axis | subclass | subclass | subclass |
The X axis, by default it is along the bottom of the plot |
|
protected | xyAxisY | Axis | subclass | subclass | subclass |
The Y axis, by default it is on the left side of the plot |
|
protected | xyData | Series[] | subclass | subclass | subclass |
XYCharts data |
javafx.scene.chart.Chart
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | chartBackgroundFill | Paint |
Fill for the chart background which is the complete area of chart (width x height) |
||||
public | chartBackgroundStroke | Paint |
Stroke for the chart background which is the complete area of chart (width x height) |
||||
public | chartBackgroundStrokeWidth | Number |
Stroke width for the chart background which is the complete area of chart (width x height) |
||||
protected | chartContent | Node | subclass | subclass | subclass |
This is the container that Chart subclasses provide that contains the chart content, It is sized to be inside the chart area leaving space for the title and legend. |
|
public | hoverStroke | Paint |
The stroke paint of the outline of a data item that has a action attached |
||||
public | hoverStrokeWidth | Number |
The stroke width of the outline of a data item that has a action attached |
||||
public | insets | Insets |
The insets between the charts available space (width x height) and the content(title and plot) |
||||
public-read protected | legend | Legend | subclass | subclass |
Legend |
||
public | legendGap | Number |
The gap between the chart legend and the chart plot area |
||||
public | legendSide | Side | Side.BOTTOM |
The side of the chart where the legend should be displayed |
|||
public | legendVisible | Boolean | true |
True if the legend should be visible |
|||
public | title | String |
The chart title |
||||
public | titleFill | Paint | |||||
public | titleFont | Font | |||||
public | titleGap | Number |
The gap between the chart title and the chart plot area |
||||
public | titleSide | Side |
The side of the chart where the title is displayed |
javafx.scene.Parent
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
protected | children | Node[] | subclass | subclass | subclass | empty |
A sequence of child A sequence of child See the class documentation for Node for scene graph structure restrictions on setting a Parent's children sequence. If these restrictions are violated by a change to the children sequence, the change is ignored and the previous value of the child sequence is restored. Throws: Profile: common |
public-read protected | needsLayout | Boolean | subclass | subclass |
Indicates that this Node and its subnodes requires a layout pass on the next pulse. |
javafx.scene.Node
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | blocksMouse | Boolean | false |
If If Profile: common |
|||
public-read | boundsInLocal | Bounds |
The rectangular bounds of this The rectangular bounds of this
Note that this method does not take the node's visibility into account;
the test is based on the geometry of this 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 The rectangular bounds of this
The resulting bounds will be conceptually in the coordinate space of the
Note that this method does not take the node's visibility into account;
the test is based on the geometry of this 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 A performance hint to the system to indicate that this
See Also:
Profile: common |
|||
public | cacheHint | CacheHint | CacheHint.DEFAULT |
Additional hint for controlling bitmap caching. Additional hint for controlling bitmap caching. Under certain circumstances, such as animating nodes that are very expensive to render, it is desirable to be able to perform transformations on the node without having to regenerate the cached bitmap. An option in such cases is to perform the transforms on the cached bitmap itself.
This technique can provide a dramatic improvement to animation
performance, though may also result in a reduction in visual quality.
The It is possible to enable the cacheHint only at times when your node is animating. In this way, expensive nodes can appear on screen with full visual quality, yet still animate smoothly. Example:
Note that cacheHint is only a hint to the system. Depending on
the details of the node or the transform, this hint may be ignored.
If
See Also:
Profile: common |
|||
public | clip | Node | null |
Specifies a Specifies a 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. Note: this is a conditional feature. See ConditionalFeature.SHAPE_CLIP for more information. nullProfile: common conditional shape_clip |
|||
public | cursor | Cursor | null |
Defines the mouse cursor for this Defines the mouse cursor for this Profile: common |
|||
public | disable | Boolean | false |
Sets the individual disabled state of this Sets the individual disabled state of this Profile: common |
|||
public-read | disabled | Boolean | false |
Indicates whether or not this Indicates whether or not this
A disabled
A disabled Profile: common |
|||
public | effect | Effect | null |
Specifies an effect to apply to this Specifies an effect to apply to this Note: this is a conditional feature. See ConditionalFeature.EFFECT for more information. nullProfile: common conditional effect |
|||
public-read protected | focused | Boolean | subclass | subclass | false |
Indicates whether this Indicates whether this Profile: common |
|
public | focusTraversable | Boolean | false |
Specifies whether this Specifies whether this Profile: common |
|||
public-read protected | hover | Boolean | subclass | subclass | false |
Whether or not this Whether or not this 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. falseProfile: common |
|
public | id | String | empty string |
The id of this The id of this Profile: common |
|||
public-read protected | layoutBounds | Bounds | subclass | subclass |
The rectangular bounds that should be used for layout calculations on
this The rectangular bounds that should be used for layout calculations on
this
See javafx.scene.shape.Shape, javafx.scene.text.Text,
Group, and javafx.scene.layout.Resizable for detailed
descriptions on how
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
Because the computation of layoutBounds is often tied to a node's
geometric variables, it is an error to bind any such variables to an
expression that depends upon 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 on a |
||||
public | layoutX | Number | 0 |
Defines the x coordinate of the translation that is added to this Defines the x coordinate of the translation that is added to this For example, if
Failure to subtract
The node's final translation will be computed as
If the node is managed and has a javafx.scene.layout.Container
as its parent, then the container will set Profile: common |
|||
public | layoutY | Number | 0 |
Defines the y coordinate of the translation that is added to this Defines the y coordinate of the translation that is added to this For example, if
Failure to subtract
The node's final translation will be computed as
If the node is managed and has a javafx.scene.layout.Container
as its parent, then the container will set Profile: common |
|||
public | managed | Boolean | true |
Defines whether or not this node's layout will be managed by it's parent. Defines whether or not this node's layout will be managed by it's parent. Each parent class follows a strategy for laying out managed children during the scene's layout pass:
If a Parent node is unmanaged, then it will act as a root for layout, which means that layout requests beneath it will cause only the branch rooted by the parent node to be relayed out. true |
|||
public | onKeyPressed | function(:KeyEvent):Void |
Defines a function to be called when this |
||||
public | onKeyReleased | function(:KeyEvent):Void |
Defines a function to be called when this |
||||
public | onKeyTyped | function(:KeyEvent):Void |
Defines a function to be called when this |
||||
public | onMouseClicked | function(:MouseEvent):Void |
Defines a function to be called when a mouse button has been clicked
(pressed and released) on this |
||||
public | onMouseDragged | function(:MouseEvent):Void |
Defines a function to be called when a mouse button is pressed
on this |
||||
public | onMouseEntered | function(:MouseEvent):Void |
Defines a function to be called when the mouse enters this |
||||
public | onMouseExited | function(:MouseEvent):Void |
Defines a function to be called when the mouse exits this |
||||
public | onMouseMoved | function(:MouseEvent):Void |
Defines a function to be called when mouse cursor moves within
this |
||||
public | onMousePressed | function(:MouseEvent):Void |
Defines a function to be called when a mouse button
has been pressed on this |
||||
public | onMouseReleased | function(:MouseEvent):Void |
Defines a function to be called when a mouse button
has been released on this |
||||
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 Specifies how opaque (that is, solid) the 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. 1.0Profile: common |
|||
public-read package | parent | Parent | null |
The parent of this The parent of this Profile: common |
|||
public | pickOnBounds | Boolean | false |
Defines how the picking computation is done for this node when
triggered by a Defines how the picking computation is done for this node when
triggered by a Profile: common |
|||
public-read protected | pressed | Boolean | subclass | subclass | false |
Whether or not the Whether or not the Profile: common |
|
public | rotate | Number | 0.0 |
Defines the angle of rotation about the Defines the angle of rotation about the 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
Profile: common |
|||
public | rotationAxis | Point3D | Rotate.Z_AXIS |
Defines the axis of rotation of this Defines the axis of rotation of this Note: this is a conditional feature. See ConditionalFeature.SCENE3D for more information. Rotate.Z_AXISProfile: common conditional scene3d |
|||
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 Defines the factor by which coordinates are scaled about the center of the
object along the X axis of this 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.0Profile: 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 Defines the factor by which coordinates are scaled about the center of the
object along the Y axis of this 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.0Profile: common |
|||
public | scaleZ | Number | 1.0 |
Defines the factor by which coordinates are scaled about the center of the
object along the Z axis of this Defines the factor by which coordinates are scaled about the center of the
object along the Z axis of this 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 rectangular bounds formed by taking boundsInLocal and applying all the transforms in the transforms[] sequence. Note: this is a conditional feature. See ConditionalFeature.SCENE3D for more information. 1.0Profile: common conditional scene3d |
|||
public-read package | scene | Scene | null |
The Scene that this The Scene that this 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 analogous to the "style" attribute of an HTML element. Note that, like the HTML style attribute, this variable contains style properties and values and not the selector portion of a style rule. Parsing this style might not be supported on some limited platforms. It is recommended to use a standalone CSS file instead. empty stringProfile: common |
|||
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 analogous to the "class" attribute on an HTML element. empty stringProfile: common |
|||
public | transforms | Transform[] | empty |
Defines the sequence of javafx.scene.transform.Transform objects
to be applied to this Defines the sequence of javafx.scene.transform.Transform objects
to be applied to this Profile: common |
|||
public | translateX | Number | 0 |
Defines the x coordinate of the translation that is added to this Defines the x coordinate of the translation that is added to this
The node's final translation will be computed as layoutX + This variable can be used to alter the location of a node without disturbing its layoutBounds, which makes it useful for animating a node's location. 0Profile: common |
|||
public | translateY | Number | 0 |
Defines the y coordinate of the translation that is added to this Defines the y coordinate of the translation that is added to this
The node's final translation will be computed as layoutY + This variable can be used to alter the location of a node without disturbing its layoutBounds, which makes it useful for animating a node's location. 0Profile: common |
|||
public | translateZ | Number | 0 |
Defines the Z coordinate of the translation that is added to the
transformed coordinates of this Defines the Z coordinate of the translation that is added to the
transformed coordinates of this 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. Note: this is a conditional feature. See ConditionalFeature.SCENE3D for more information. 0Profile: common conditional scene3d |
|||
public | visible | Boolean | true |
Specifies whether this Specifies whether this Profile: common |
javafx.scene.layout.Resizable
access | name | type | Can Read | Can Init | Can Write | Default Value | description |
---|---|---|---|---|---|---|---|
public | height | Number |
The The
If an application needs to control the height of a Resizable node, it
should override its preferred height using
Profile: common |
||||
public | width | Number |
The The
If an application needs to control the width of a Resizable node, it
should override its preferred width using
Profile: common |
Function Summary
Inherited Functions
javafx.scene.chart.XYChart
- protected dataChanged() : Void
- protected getItemFill(series: Series, seriesIndex: Integer, item: Data, itemIndex: Integer) : Paint
-
Get the fill for a given item, first the item's fill is checked and if that is null then the result of getSeriesFill is returned.
Get the fill for a given item, first the item's fill is checked and if that is null then the result of getSeriesFill is returned.
-
Parameters
- series
- The series the item is in
- seriesIndex
- The index of the items series within the chart data
- item
- The data item we are getting the fill for
- itemIndex
- The index of the data item within its series
-
Returns
- Paint
- protected getSeriesFill(series: Series, seriesIndex: Integer) : Paint
-
Get the fill for a given series, first the series's fill is checked and if that is null then a color from the default pallet is returned.
Get the fill for a given series, first the series's fill is checked and if that is null then a color from the default pallet is returned.
-
Parameters
- series
- The series we are getting the fill before
- seriesIndex
- The index of the series within the chart data
-
Returns
- Paint
- protected visualsChanged() : Void
javafx.scene.chart.Chart
javafx.scene.Parent
- public layout() : Void
- public lookup(id: java.lang.String) : Node
- public requestLayout() : Void
-
Requests a layout pass to be performed before the next scene is rendered.
Requests a layout pass to be performed before the next scene is rendered. This is batched up asynchronously to happen once per "pulse", or frame of animation.
If this parent is either a layout root or unmanaged, then it will be added directly to the scene's dirty layout list, otherwise requestLayout will be invoked on its parent.
javafx.scene.Node
- public contains(localX: Number, localY: Number) : Boolean
-
Returns
true
if the given point (specified in the local coordinate space of thisNode
) is contained within the shape of thisNode
.Returns
true
if the given point (specified in the local coordinate space of thisNode
) is contained within the shape of thisNode
. Note that this method does not take visibility into account; the test is based on the geometry of thisNode
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 thisNode
) is contained within the shape of thisNode
.Returns
true
if the given point (specified in the local coordinate space of thisNode
) is contained within the shape of thisNode
. Note that this method does not take visibility into account; the test is based on the geometry of thisNode
only.-
Parameters
- localPoint
-
Returns
- Boolean
Profile: common
- public intersects(localX: Number, localY: Number, localWidth: Number, localHeight: Number) : Boolean
-
Returns
true
if the given rectangle (specified in the local coordinate space of thisNode
) intersects the shape of thisNode
.Returns
true
if the given rectangle (specified in the local coordinate space of thisNode
) intersects the shape of thisNode
. Note that this method does not take visibility into account; the test is based on the geometry of thisNode
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 thisNode
) intersects the shape of thisNode
.Returns
true
if the given bounds (specified in the local coordinate space of thisNode
) intersects the shape of thisNode
. Note that this method does not take visibility into account; the test is based on the geometry of thisNode
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
- public localToParent(localPoint: Point2D) : Point2D
- public localToParent(localBounds: Bounds) : Bounds
- 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 this node is aParent
, then this function will traverse down into the branch until it finds a match. If more than one subnode has the specified 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 ofid
.
Profile: common
- public parentToLocal(parentX: Number, parentY: Number) : Point2D
- public parentToLocal(parentPoint: Point2D) : Point2D
- public parentToLocal(parentBounds: Bounds) : Bounds
- public requestFocus() : Void
-
Requests that this
Node
get the input focus, and that thisNode
's top-level ancestor become the focused window.Requests that this
Node
get the input focus, and that thisNode
's top-level ancestor become the focused window. To be eligible to receive the focus, the node must be part of a scene, it and all of its ancestors must be visible, and it must not be disabled. If this node is eligible, this function will cause it to become thisScene
's "focus owner". Each scene has at most one focus owner node. The focus owner will not actually have the input focus, however, unless the scene belongs to aStage
that is both visible and active.Profile: common
- public sceneToLocal(sceneX: Number, sceneY: Number) : Point2D
- 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 thisNode
to the first position in its parent'scontent
sequence. This function has no effect if thisNode
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 thisNode
to the last position in its parent'scontent
sequence. This function has no effect if thisNode
is not part of a group.Profile: common
- public toString() : java.lang.String
javafx.scene.layout.Resizable
- public getHFill() : Boolean
-
Returns the
Resizable
's horizontal fill preference, which indicates whether or not the Resizable's width should be resized beyond its preferred width (up to its maximum) to fill it's allocated layout area.Returns the
Resizable
's horizontal fill preference, which indicates whether or not the Resizable's width should be resized beyond its preferred width (up to its maximum) to fill it's allocated layout area.All container classes (HBox, VBox, Stack, Flow(vertical), Tile) consult this preference when resizing Resizable children.
An application may override the horizontal fill of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { hfill: true } }
This function returns
false
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Boolean
- public getHGrow() : Priority
-
Returns the
Resizable
's horizontal grow priority which determines whether it's layout area is given more horizontal space if its available.Returns the
Resizable
's horizontal grow priority which determines whether it's layout area is given more horizontal space if its available.The horizontal grow priority is only used if the parent container is resized larger than its preferred width and multiple nodes are competing for extra horizontal space, which for the concrete containers is only applicable to HBox. Note that growing applies only to the layout area assigned to the Resizable; how the Resizable is sized with respect to that area is determined separately by its size and fill preferences (see getPrefWidth and getHFill).
If
ALWAYS
, the Resizable's layout area will always grow horizontally if there is additional space, sharing the increase with other nodes that have an hgrow of ALWAYS. The Resizable's layout area will never be grown beyond the Resizable's maximum width.If
SOMETIMES
, the Resizable's layout area will only grow horizontally if either no other node has specified ALWAYS, or the additional space was not completely allocated to nodes specifying ALWAYS because of their maximum size limits.If
NEVER
, the Resizable's layout area will never be grown horizontally if there is additional space.If the Resizable returns ALWAYS or SOMETIMES, then getHFill should typically return
true
to ensure the node will be resized beyond its preferred to take advantage of its larger layout area.An application may override the horizontal grow priority of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { hgrow: Priority.ALWAYS } }
This function returns
Priority.NEVER
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Priority
- public getHShrink() : Priority
-
Returns the
Resizable
's horizontal shrink priority, which determines whether it's layout area is given less horizontal space if its parent is resized smaller than its preferred width.Returns the
Resizable
's horizontal shrink priority, which determines whether it's layout area is given less horizontal space if its parent is resized smaller than its preferred width.The horizontal shrink priority is only used if the parent container is resized smaller than its preferred width and multiple nodes are competing for horizontal space, which for the concrete containers is only applicable to HBox.
If
ALWAYS
, the Resizable's layout area will always shrink horizontally if there is less space, sharing the decrease with other nodes that have an hshrink of ALWAYS. The Resizable's layout area will never be sized smaller than the node's minimum width.If
SOMETIMES
, the Resizable's layout area will only shrink horizontally if either no other node has specified ALWAYS, or the reduced space was not completely distributed to nodes specifying ALWAYS because of their minimum size limits.If
NEVER
, the Resizable's layout area will never be shrunken horizontally if there is reduced space.An application may override the horizontal shrink priority of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { hshrink: Priority.ALWAYS } }
This function returns
Priority.NEVER
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Priority
- public getMaxHeight() : Number
-
Returns the
Resizable
's maximum height.Returns the
Resizable
's maximum height. Layout containers should strive not to set the Resizable'sheight
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.An application may override the maximum height of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { maxHeight: 30 } }
This function returns
Integer.MAX_VALUE
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Number
Profile: common
- public getMaxWidth() : Number
-
Returns the
Resizable
's maximum width.Returns the
Resizable
's maximum width. Layout containers should strive not to set the Resizable'swidth
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.An application may override the maximum width of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { maxWidth: 30 } }
This function returns
Integer.MAX_VALUE
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Number
Profile: common
- public getMinHeight() : Number
-
Returns the
Resizable
's minimum height.Returns the
Resizable
's minimum height. Layout containers should strive not to set the Resizable'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.An application may override the minimum height of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { minHeight: 30 } }
This function returns 0 by default; Resizable subclasses should override this function to return an appropriate value.
-
Returns
- Number
Profile: common
- public getMinWidth() : Number
-
Returns the
Resizable
's minimum width.Returns the
Resizable
's minimum width. Layout containers should strive not to set the Resizable'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.An application may override the minimum width of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { minWidth: 50 } }
This function returns 0 by default; Resizable subclasses should override this function to return an appropriate value.
-
Returns
- Number
Profile: common
- public abstract getPrefHeight(width: Number) : Number
-
Returns the
Resizable
's preferred height, given the specified width.Returns the
Resizable
's preferred height, given the specified width. If a particular width need not be factored into the result, -1 may be passed in as thewidth
parameter. Implementations of this function may also choose to ignorewidth
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.An application may override the preferred height of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { height: 80 } }
Resizable subclasses must override this function to return an appropriate value.
-
Parameters
- width
-
Returns
- Number
Profile: common
- public abstract getPrefWidth(height: Number) : Number
-
Returns the
Resizable
's preferred width, given the specified height.Returns the
Resizable
's preferred width, given the specified height. If a particular height need not be factored into the result, -1 may be passed in as theheight
parameter. Implementations of this function may also choose to ignoreheight
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.An application may override the preferred width of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { width: 50 } }
Resizable subclasses must override this function to return an appropriate value.
-
Parameters
- height
-
Returns
- Number
Profile: common
- public getVFill() : Boolean
-
Returns the
Resizable
's vertical fill preference, which indicates whether or not the Resizable's height should be resized beyond its preferred height (up to its maximum) to fill it's allocated layout area.Returns the
Resizable
's vertical fill preference, which indicates whether or not the Resizable's height should be resized beyond its preferred height (up to its maximum) to fill it's allocated layout area.All container classes (HBox, VBox, Stack, Flow(horizontal), Tile) consult this preference when resizing Resizable children.
An application may override the vertical fill of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { vfill: true } }
This function returns
false
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Boolean
- public getVGrow() : Priority
-
Returns the
Resizable
's vertical grow priority, which determines whether it's layout area is given more vertical space if its available.Returns the
Resizable
's vertical grow priority, which determines whether it's layout area is given more vertical space if its available.The vertical grow priority is only used if the parent container is resized larger than its preferred height and multiple nodes are competing for extra vertical space, which for the concrete containers is only applicable to VBox. Note that growing applies only to the layout area assigned to the Resizable; how the Resizable is sized with respect to that area is determined separately by its size and fill preferences (see getPrefHeight and getVFill).
If
ALWAYS
, the Resizable's layout area will always grow vertically if there is additional space, sharing the increase with other nodes that have an vgrow of ALWAYS. The Resizable's layout area will never be grown beyond the Resizable's maximum height.If
SOMETIMES
, the Resizable's layout area will only grow vertically if either no other node has specified ALWAYS, or the additional space was not completely allocated to nodes specifying ALWAYS because of their maximum size limits.If
NEVER
, the Resizable's layout area will never be grown vertically if there is additional space.If the Resizable returns ALWAYS or SOMETIMES, then getVFill should typically return
true
to ensure the node will be resized beyond its preferred to take advantage of its larger layout area.An application may override the vertical grow priority of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { vgrow: Priority.ALWAYS } }
This function returns
Priority.NEVER
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Priority
- public getVShrink() : Priority
-
Returns the
Resizable
's vertical shrink priority, which determines whether it's layout area is given less vertical space if its parent is resized smaller than its preferred height.Returns the
Resizable
's vertical shrink priority, which determines whether it's layout area is given less vertical space if its parent is resized smaller than its preferred height.The vertical shrink priority is only used if the parent container is resized smaller than its preferred height and multiple nodes are competing for vertical space, which for the concrete containers is only applicable to VBox.
If
ALWAYS
, the Resizable's layout area will always shrink vertically if there is less space, sharing the decrease with other nodes that have an vshrink of ALWAYS. The Resizable's layout area will never be sized smaller than the node's minimum height.If
SOMETIMES
, the Resizable's layout area will only shrink vertically if either no other node has specified ALWAYS, or the reduced space was not completely distributed to nodes specifying ALWAYS because of their minimum size limits.If
NEVER
, the Resizable's layout area will never be shrunken vertically if there is reduced space.An application may override the vertical shrink priority of a Resizable node using LayoutInfo:
Label { layoutInfo: LayoutInfo { vshrink: Priority.ALWAYS } }
This function returns
Priority.NEVER
by default; Resizable subclasses should override this function to return an appropriate value.-
Returns
- Priority