javafx.scene.control.skin

Class LabeledSkinBase<C extends Labeled>

java.lang.Object

<any>

javafx.scene.control.skin.LabeledSkinBase<C>

Direct Known Subclasses:

ButtonSkin, CellSkinBase, CheckBoxSkin, HyperlinkSkin, LabelSkin, RadioButtonSkin, TitledPaneSkin, ToggleButtonSkin

public abstract class LabeledSkinBase<C extends Labeled>
extends <any>

Default skin implementation for controls extends Labeled.

Since:

9

See Also:

Labeled

Field Summary

Fields

Modifier and Type	Field and Description
private TextBinding	bindings
private boolean	containsMnemonic
(package private) double	ellipsisWidth The cached width of the ellipsis string.
(package private) Node	graphic A reference to the last-known graphic on the Labeled.
(package private) InvalidationListener	graphicPropertyChangedListener A listener which is applied to the graphic whenever the graphic is set and is visible within the labeled.
(package private) boolean	invalidText Indicates that the text content is invalid and needs to be updated.
private Node	labeledNode
private Line	mnemonic_underscore
private KeyCombination	mnemonicCode
private Scene	mnemonicScene
(package private) LabeledText	text The Text node used to display the text.
private Rectangle	textClip
(package private) double	textWidth The cached full width of the non-truncated text.
private double	wrapHeight
private double	wrapWidth

Constructor Summary

Constructors

Constructor and Description
LabeledSkinBase(C labeled) Constructor for LabeledSkinBase.

Method Summary

Modifier and Type	Method and Description
private void	addMnemonic()
(package private) double	bottomLabelPadding()
double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
private double	computeMinLabeledPartHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
private double	computeMinLabeledPartWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) * Private implementation * *
protected double	computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) Compute and return the minimum width of this Labeled.
protected double	computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
private void	invalidateWidths() Marks minWidth as being invalid and in need of recomputation.
(package private) boolean	isIgnoreGraphic() Gets whether for various computations we can ignore the presence of the graphic (or lack thereof).
(package private) boolean	isIgnoreText() Gets whether for various computations we can ignore the presence of the text.
protected void	layoutChildren(double x, double y, double w, double h) The Layout algorithm works like this: - Get the labeled w/h, graphic w/h, text w/h - Compute content w/h based on graphicVPos, graphicHPos, graphicTextGap, and graphic w/h and text w/h - (Note that the text content has been pre-truncated where necessary) - compute content x/y based on content w/h and labeled w/h and the labeled's hpos and vpos - position the graphic and text
protected void	layoutLabelInArea(double x, double y, double w, double h) Performs the actual layout of the label content within the area given.
protected void	layoutLabelInArea(double x, double y, double w, double h, Pos alignment) Performs the actual layout of the label content within the area given.
(package private) double	leftLabelPadding()
(package private) void	mnemonicTargetChanged()
protected java.lang.Object	queryAccessibleAttribute(AccessibleAttribute attribute, java.lang.Object... parameters)
private void	removeMnemonic()
(package private) double	rightLabelPadding()
private void	sceneChanged()
private void	textMetricsChanged() Called whenever some state has changed that affects the text metrics.
(package private) double	topLabelPadding()
protected void	updateChildren() Updates the children managed by LabeledSkinBase, which can be the Labeled graphic and/or a Text node.
(package private) void	updateDisplayedText() Updates the content of the underlying Text node.
private void	updateDisplayedText(double w, double h)
private void	updateWrappingWidth() Updates the wrapping width of the text node.

Methods inherited from class java.lang.Object

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

Field Detail

text

LabeledText text

The Text node used to display the text. This is package only for the sake of testing!

invalidText

boolean invalidText

Indicates that the text content is invalid and needs to be updated. This is package private only for the sake of testing.

graphic

Node graphic

A reference to the last-known graphic on the Labeled. This reference is kept so that we can remove listeners from the old graphic later

textWidth

double textWidth

The cached full width of the non-truncated text. We only want to recompute this if the text has itself changed, or if the font has changed. This is package private ONLY FOR THE SAKE OF TESTING

ellipsisWidth

double ellipsisWidth

The cached width of the ellipsis string. This will be recomputed if the font or the ellipsisString property have changed. This is package private ONLY FOR THE SAKE OF TESTING

graphicPropertyChangedListener

final InvalidationListener graphicPropertyChangedListener

A listener which is applied to the graphic whenever the graphic is set and is visible within the labeled. For example, if there is a graphic defined on the Labeled but the ContentDisplay is set to TEXT_ONLY, then we will not bother installing this listener on the graphic. In all other cases, if the graphic is defined, it will have this listener added to it, which ensures that if the graphic's layout bounds change, we end up performing a layout and potentially update the visible text. This is package private ONLY FOR THE SAKE OF TESTING

textClip

private Rectangle textClip

wrapWidth

private double wrapWidth

wrapHeight

private double wrapHeight

bindings

private TextBinding bindings

mnemonic_underscore

private Line mnemonic_underscore

containsMnemonic

private boolean containsMnemonic

mnemonicScene

private Scene mnemonicScene

mnemonicCode

private KeyCombination mnemonicCode

labeledNode

private Node labeledNode

Constructor Detail

LabeledSkinBase

public LabeledSkinBase(C labeled)

Constructor for LabeledSkinBase. The Labeled must be specified, and cannot be null. At the conclusion of the constructor call, the skin will be marked as needsLayout, and will be fully configured based on the current state of the labeled. Any subsequent changes to the Labeled will be handled via listeners and applied appropriately.

Parameters:

labeled - The labeled that this skin should be installed onto.

Method Detail

updateChildren

protected void updateChildren()

Updates the children managed by LabeledSkinBase, which can be the Labeled graphic and/or a Text node. Only those nodes which actually must be used are used. For example, with a ContentDisplay of GRAPHIC_ONLY the text node is not added, and with a ContentDisplay of TEXT_ONLY, the graphic is not added.

computeMinWidth

protected double computeMinWidth(double height,
                                 double topInset,
                                 double rightInset,
                                 double bottomInset,
                                 double leftInset)

Compute and return the minimum width of this Labeled. The minimum width is the smaller of the width of "..." and the width with the actual text. In this way, if the text width itself is smaller than the ellipsis then we should use that as the min width, otherwise the ellipsis needs to be the min width.

We use the same calculation here regardless of whether we are talking about a single or multiline labeled. So a multiline labeled may find that the width of the "..." is as small as it will ever get.

computeMinHeight

protected double computeMinHeight(double width,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computePrefWidth

protected double computePrefWidth(double height,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computePrefHeight

protected double computePrefHeight(double width,
                                   double topInset,
                                   double rightInset,
                                   double bottomInset,
                                   double leftInset)

computeMaxWidth

protected double computeMaxWidth(double height,
                                 double topInset,
                                 double rightInset,
                                 double bottomInset,
                                 double leftInset)

computeMaxHeight

protected double computeMaxHeight(double width,
                                  double topInset,
                                  double rightInset,
                                  double bottomInset,
                                  double leftInset)

computeBaselineOffset

public double computeBaselineOffset(double topInset,
                                    double rightInset,
                                    double bottomInset,
                                    double leftInset)

layoutChildren

protected void layoutChildren(double x,
                              double y,
                              double w,
                              double h)

The Layout algorithm works like this: - Get the labeled w/h, graphic w/h, text w/h - Compute content w/h based on graphicVPos, graphicHPos, graphicTextGap, and graphic w/h and text w/h - (Note that the text content has been pre-truncated where necessary) - compute content x/y based on content w/h and labeled w/h and the labeled's hpos and vpos - position the graphic and text

layoutLabelInArea

protected void layoutLabelInArea(double x,
                                 double y,
                                 double w,
                                 double h)

Performs the actual layout of the label content within the area given. This method is called by subclasses that override layoutChildren().

Parameters:

x - The x position of the label part of the control, inside padding

y - The y position of the label part of the control, inside padding

w - The width of the label part of the control, not including padding

h - The height of the label part of the control, not including padding

layoutLabelInArea

protected void layoutLabelInArea(double x,
                                 double y,
                                 double w,
                                 double h,
                                 Pos alignment)

Performs the actual layout of the label content within the area given. This method is called by subclasses that override layoutChildren().

Parameters:

x - The x position of the label part of the control, inside padding

y - The y position of the label part of the control, inside padding

w - The width of the label part of the control, not including padding

h - The height of the label part of the control, not including padding

alignment - The alignment of the label part of the control within the given area. If null, then the control's alignment will be used.

queryAccessibleAttribute

protected java.lang.Object queryAccessibleAttribute(AccessibleAttribute attribute,
                                                    java.lang.Object... parameters)

computeMinLabeledPartWidth

private double computeMinLabeledPartWidth(double height,
                                          double topInset,
                                          double rightInset,
                                          double bottomInset,
                                          double leftInset)

* Private implementation * *

computeMinLabeledPartHeight

private double computeMinLabeledPartHeight(double width,
                                           double topInset,
                                           double rightInset,
                                           double bottomInset,
                                           double leftInset)

topLabelPadding

double topLabelPadding()

bottomLabelPadding

double bottomLabelPadding()

leftLabelPadding

double leftLabelPadding()

rightLabelPadding

double rightLabelPadding()

textMetricsChanged

private void textMetricsChanged()

Called whenever some state has changed that affects the text metrics. Changes here will involve invalidating the display text so the next call to updateDisplayedText computes a new value, and call requestLayout.

mnemonicTargetChanged

void mnemonicTargetChanged()

sceneChanged

private void sceneChanged()

invalidateWidths

private void invalidateWidths()

Marks minWidth as being invalid and in need of recomputation.

updateDisplayedText

void updateDisplayedText()

Updates the content of the underlying Text node. This method should only be called when necessary. If the invalidText flag is not set, then the method is a no-op. This care is taken because recomputing the text to display is an expensive operation. Package private ONLY FOR THE SAKE OF TESTING.

updateDisplayedText

private void updateDisplayedText(double w,
                                 double h)

addMnemonic

private void addMnemonic()

removeMnemonic

private void removeMnemonic()

updateWrappingWidth

private void updateWrappingWidth()

Updates the wrapping width of the text node. Although changing the font does affect the metrics used for text layout, this method does not call requestLayout or invalidate the text, since it may be called from the constructor and such work would be duplicative and wasted.

isIgnoreGraphic

boolean isIgnoreGraphic()

Gets whether for various computations we can ignore the presence of the graphic (or lack thereof).

Returns:

isIgnoreText

boolean isIgnoreText()

Gets whether for various computations we can ignore the presence of the text.

Returns: