javafx.scene.control

Class Label

java.lang.Object

Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.Label

All Implemented Interfaces:

Skinnable

public class Label
extends Labeled

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 an ellipsis 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.

Label sets focusTraversable to false.

Example:

Label label = new Label("a label");

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	labelFor A Label can act as a label for a different Control or Node.

Properties inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, graphicProperty, graphicTextGapProperty, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	labelFor
private <any>	mnemonicStateListener * Properties * *

Constructor Summary

Constructors

Constructor and Description
Label() Creates an empty label
Label(java.lang.String text) Creates Label with supplied text.
Label(java.lang.String text, Node graphic) Creates a Label with the supplied text and graphic.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Create a new instance of the default skin for this control.
protected java.lang.Boolean	getInitialFocusTraversable() Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
Node	getLabelFor() Gets the value of the property labelFor.
private void	initialize()
<any>	labelForProperty() A Label can act as a label for a different Control or Node.
void	setLabelFor(Node value) Sets the value of the property labelFor.

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getInitialAlignment, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getControlChildren, getCssMetaData, getSkin, getTooltip, isResizable, layoutChildren, loadSkinClass, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

labelFor

public <any> labelForProperty

A Label can act as a label for a different Control or Node. This is used for Mnemonics and Accelerator parsing. This allows setting of the target Node.

See Also:

getLabelFor(), setLabelFor(Node)

Field Detail

mnemonicStateListener

private <any> mnemonicStateListener

* Properties * *

labelFor

private <any> labelFor

Constructor Detail

Label

public Label()

Creates an empty label

Label

public Label(java.lang.String text)

Creates Label with supplied text.

Parameters:

text - null text is treated as the empty string

Label

public Label(java.lang.String text,
             Node graphic)

Creates a Label with the supplied text and graphic.

Parameters:

text - null text is treated as the empty string

graphic - a null graphic is acceptable

Method Detail

initialize

private void initialize()

labelForProperty

public <any> labelForProperty()

A Label can act as a label for a different Control or Node. This is used for Mnemonics and Accelerator parsing. This allows setting of the target Node.

See Also:

getLabelFor(), setLabelFor(Node)

setLabelFor

public final void setLabelFor(Node value)

Sets the value of the property labelFor.

getLabelFor

public final Node getLabelFor()

Gets the value of the property labelFor.

createDefaultSkin

protected Skin<?> createDefaultSkin()

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Overrides:

createDefaultSkin in class Control

Returns:

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

getInitialFocusTraversable

protected java.lang.Boolean getInitialFocusTraversable()

Returns the initial focus traversable state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden as by default UI controls have focus traversable set to true, but that is not appropriate for this control.

Overrides:

getInitialFocusTraversable in class Control

Returns:

the initial focus traversable state of this control

Since:

9