Label
Inherits from: Control > Labeled > Parent > Resizable > TextOffsets > Node
Overview
Label is a non-editable text control. A Label is useful for displaying text that is required to fit within a specific space, and thus may need to use ellipses or truncation to size the string to fit. Labels also are useful in that they can have mnemonics which, if used, will send focus to the Control listed as the target of the labelFor property.
Profile: common
Variable Summary
| name | type | Default Value | description |
|---|---|---|---|
| textFill | Paint |
Specifies the default fill to use for the text of the Label. If the Label contains rich text, then it may specify a more particular fill paint. |
Inherited Variables
Control
| name | type | Default Value | description |
|---|---|---|---|
| skin | Skin |
Skin responsible for rendering this There is a one-to-one relationship between a A skin may be null. |
Labeled
| name | type | Default Value | description |
|---|---|---|---|
| text | String |
The text to display in the label. |
|
| hpos | HPos |
Specifies how the text and graphic within the Labeled should be positioned horizontally when there is empty space within the Labeled. |
|
| vpos | VPos |
Specifies how the text and graphic within the Labeled should be positioned vertically when there is empty space within the Labeled. |
|
| textAlignment | TextAlignment |
Specifies the behavior for lines of text when text is multiline Unlike vpos which affects the graphic and text, this setting only affects multiple lines of text relative to the text bounds. |
|
| textOverrun | OverrunStyle |
Specifies the behavior to use if the text of the |
|
| textWrap | Boolean |
If a run of text exceeds the width of the Labeled, then this variable indicates whether the text should wrap onto another line. |
|
| font | Font |
The default font to use for text in the Labeled. If the Label's text is rich text then this font may or may not be used depending on the font information embedded in the rich text, but in any case where a default font is required, this font will be used. |
|
| graphic | Node |
An optional icon for the Labeled. This can be positioned relative to the text by using the graphicHPos and graphicVPos variables. The node specified for this variable cannot appear elsewhere in the scene graph, otherwise the |
|
| graphicHPos | HPos |
Specifies the horizontal positioning of the graphic relative to the text. |
|
| graphicVPos | VPos |
Specifies the vertical positioning of the graphic relative to the text. |
|
| graphicTextGap | Number |
The amount of space between the graphic and text |
Resizable
| name | type | Default Value | description |
|---|---|---|---|
| width | Number |
The width of the Any javafx.scene.Node subclass which mixes in |
|
| height | Number |
The height of the Any javafx.scene.Node subclass which mixes in |
Node
| name | type | Default Value | description |
|---|---|---|---|
| id | String |
The id of this |
|
| styleClass | String |
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. |
|
| style | String |
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. |
|
| visible | Boolean | true |
Specifies whether this |
| cursor | Cursor | null |
Defines the mouse cursor for this |
| opacity | Number | 1.0 |
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. |
| clip | Node | null |
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 javafx.runtime.ConditionalFeature#SHAPE_CLIP ConditionalFeature.SHAPE_CLIP for more information. |
| cache | Boolean | false |
A performance hint to the system to indicate that this |
| cacheHint | CacheHint | CacheHint.DEFAULT |
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 |
| effect | Effect | null |
Specifies an effect to apply to this Note: this is a conditional feature. See javafx.runtime.ConditionalFeature#EFFECT ConditionalFeature.EFFECT for more information. |
| disable | Boolean | false |
Sets the individual disabled state of this |
| pickOnBounds | Boolean | false |
Defines how the picking computation is done for this node when triggered by a |
| managed | Boolean | true |
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 |
| layoutX | Number | 0 |
Defines the X coordinate of the translation that is added to the transformed coordinates of this For example, if
|
| layoutY | Number | 0 |
Defines the Y coordinate of the translation that is added to the transformed coordinates of this For example, if
|
| layoutInfo | LayoutInfoBase |
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. |
|
| transforms | Transform | [] |
Defines the sequence of javafx.scene.transform.Transform objects to be applied to this By default, #layoutBounds is defined as the local bounds with all the transforms in this sequence applied. |
| translateX | Number | 0 |
Defines the X 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. |
| translateY | Number | 0 |
Defines the Y 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. |
| translateZ | Number | 0 |
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 javafx.runtime.ConditionalFeature#SCENE3D ConditionalFeature.SCENE3D for more information. |
| scaleX | Number | 1.0 |
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. |
| scaleY | Number | 1.0 |
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. |
| scaleZ | Number | 1.0 |
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 javafx.runtime.ConditionalFeature#SCENE3D ConditionalFeature.SCENE3D for more information. |
| rotate | Number | 0.0 |
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 |
| rotationAxis | Point3D | Rotate.Z_AXIS |
Defines the axis of rotation of this Note: this is a conditional feature. See javafx.runtime.ConditionalFeature#SCENE3D ConditionalFeature.SCENE3D for more information. |
| blocksMouse | Boolean | false |
If |
| focusTraversable | Boolean | false |
Specifies whether this |
