Module javafx.controls

Package javafx.scene.control.skin

Class CheckBoxSkin

java.lang.Object

javafx.scene.control.SkinBase<C>

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

javafx.scene.control.skin.CheckBoxSkin

All Implemented Interfaces:

Skin<CheckBox>

public class CheckBoxSkin
extends LabeledSkinBase<CheckBox>

Default skin implementation for the tri-state CheckBox control.

Since:

9

See Also:

CheckBox

Constructor Summary

Constructors

Constructor	Description
CheckBoxSkin(CheckBox control)	Creates a new CheckBoxSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Method Summary

Modifier and Type	Method	Description
protected double	computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)	Computes the minimum allowable height of the Skin, based on the provided width.
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)	Calculates the preferred height of this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
void	dispose()	Called by a Skinnable when the Skin is replaced on the Skinnable.
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	updateChildren()	Updates the children managed by LabeledSkinBase, which can be the Labeled graphic and/or a Text node.

Methods inherited from class javafx.scene.control.skin.LabeledSkinBase

computeBaselineOffset, computeMaxHeight, computeMaxWidth, layoutLabelInArea, layoutLabelInArea, queryAccessibleAttribute

Methods inherited from class javafx.scene.control.SkinBase

consumeMouseEvents, executeAccessibleAction, getChildren, getClassCssMetaData, getCssMetaData, getNode, getSkinnable, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, registerChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckBoxSkin

public CheckBoxSkin(CheckBox control)

Creates a new CheckBoxSkin instance, installing the necessary child nodes into the Control children list, as well as the necessary input mappings for handling key, mouse, etc events.

Parameters:

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

Method Detail

dispose

public void dispose()

Called by a Skinnable when the Skin is replaced on the Skinnable. This method allows a Skin to implement any logic necessary to clean up itself after the Skin is no longer needed. It may be used to release native resources. The methods Skin.getSkinnable() and Skin.getNode() should return null following a call to dispose. Calling dispose twice has no effect.

Specified by:

dispose in interface Skin<CheckBox>

Overrides:

dispose in class SkinBase<CheckBox>

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.

Overrides:

updateChildren in class LabeledSkinBase<CheckBox>

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.

Overrides:

computeMinWidth in class LabeledSkinBase<CheckBox>

Parameters:

height - The height of the Skin, in case this value might dictate the minimum width.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the minimum width of this Skin.

computeMinHeight

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

Computes the minimum allowable height of the Skin, based on the provided width.

Overrides:

computeMinHeight in class LabeledSkinBase<CheckBox>

Parameters:

width - The width of the Skin, in case this value might dictate the minimum height.

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

A double representing the minimum height of this Skin.

computePrefWidth

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

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

Overrides:

computePrefWidth in class LabeledSkinBase<CheckBox>

Parameters:

height - the height that should be used if preferred width depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred width

computePrefHeight

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

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

Overrides:

computePrefHeight in class LabeledSkinBase<CheckBox>

Parameters:

width - the width that should be used if preferred height depends on it

topInset - the pixel snapped top inset

rightInset - the pixel snapped right inset

bottomInset - the pixel snapped bottom inset

leftInset - the pixel snapped left inset

Returns:

the calculated preferred height

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

Overrides:

layoutChildren in class LabeledSkinBase<CheckBox>

Parameters:

x - the x position

y - the y position

w - the width

h - the height