java.lang.Object
javafx.scene.control.SkinBase<ComboBoxBase<T>>
javafx.scene.control.skin.ComboBoxBaseSkin<T>
javafx.scene.control.skin.ComboBoxPopupControl<T>
javafx.scene.control.skin.ComboBoxListViewSkin<T>
- All Implemented Interfaces:
Skin<ComboBoxBase<T>>
public class ComboBoxListViewSkin<T> extends ComboBoxPopupControl<T>
Default skin implementation for the
ComboBox
control.- Since:
- 9
- See Also:
ComboBox
-
Property Summary
Properties Type Property Description BooleanProperty
hideOnClick
By default this skin hides the popup whenever the ListView is clicked in. -
Constructor Summary
Constructors Constructor Description ComboBoxListViewSkin(ComboBox<T> control)
Creates a new ComboBoxListViewSkin instance, installing the necessary child nodes into the Controlchildren
list, as well as the necessary input mappings for handling key, mouse, etc events. -
Method Summary
Modifier and Type Method Description protected double
computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
Computes the maximum allowable height of the Skin, based on the provided width.protected double
computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
Computes the maximum allowable width of the Skin, based on the provided height.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)
Computes the minimum allowable width of the Skin, based on the provided height.protected double
computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)
Calculates the preferred height of thisSkinBase
.protected double
computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)
Calculates the preferred width of thisSkinBase
.void
dispose()
Called by a Skinnable when the Skin is replaced on the Skinnable.protected StringConverter<T>
getConverter()
Subclasses are responsible for getting the converter.Node
getDisplayNode()
This method should return a Node that will be positioned within the ComboBox 'button' area.protected TextField
getEditor()
Subclasses are responsible for getting the editor.Node
getPopupContent()
This method should return the Node that will be displayed when the user clicks on the ComboBox 'button' area.BooleanProperty
hideOnClickProperty()
By default this skin hides the popup whenever the ListView is clicked in.boolean
isHideOnClick()
Gets the value of the property hideOnClick.protected void
layoutChildren(double x, double y, double w, double h)
Called during the layout pass of the scenegraph.Object
queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)
This method is called by the assistive technology to request the value for an attribute.void
setHideOnClick(boolean value)
Sets the value of the property hideOnClick.Methods inherited from class javafx.scene.control.skin.ComboBoxPopupControl
hide, show
Methods inherited from class javafx.scene.control.skin.ComboBoxBaseSkin
computeBaselineOffset
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
-
Property Details
-
hideOnClick
By default this skin hides the popup whenever the ListView is clicked in. By setting hideOnClick to false, the popup will not be hidden when the ListView is clicked in. This is beneficial in some scenarios (for example, when the ListView cells have checkboxes).- See Also:
isHideOnClick()
,setHideOnClick(boolean)
-
-
Constructor Details
-
ComboBoxListViewSkin
Creates a new ComboBoxListViewSkin instance, installing the necessary child nodes into the Controlchildren
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 Details
-
hideOnClickProperty
By default this skin hides the popup whenever the ListView is clicked in. By setting hideOnClick to false, the popup will not be hidden when the ListView is clicked in. This is beneficial in some scenarios (for example, when the ListView cells have checkboxes).- See Also:
isHideOnClick()
,setHideOnClick(boolean)
-
isHideOnClick
public final boolean isHideOnClick()Gets the value of the property hideOnClick.- Property description:
- By default this skin hides the popup whenever the ListView is clicked in. By setting hideOnClick to false, the popup will not be hidden when the ListView is clicked in. This is beneficial in some scenarios (for example, when the ListView cells have checkboxes).
-
setHideOnClick
public final void setHideOnClick(boolean value)Sets the value of the property hideOnClick.- Property description:
- By default this skin hides the popup whenever the ListView is clicked in. By setting hideOnClick to false, the popup will not be hidden when the ListView is clicked in. This is beneficial in some scenarios (for example, when the ListView cells have checkboxes).
-
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 methodsSkin.getSkinnable()
andSkin.getNode()
should return null following a call to dispose. Calling dispose twice has no effect. -
getEditor
Subclasses are responsible for getting the editor. This will be removed in FX 9 when the editor property is moved up to ComboBoxBase with JDK-8130354 Note: ComboBoxListViewSkin should return null if editable is false, even if the ComboBox does have an editor set.- Specified by:
getEditor
in classComboBoxPopupControl<T>
- Returns:
- the editor
-
getConverter
Subclasses are responsible for getting the converter. This will be removed in FX 9 when the converter property is moved up to ComboBoxBase with JDK-8130354.- Specified by:
getConverter
in classComboBoxPopupControl<T>
- Returns:
- the string converter
-
getDisplayNode
This method should return a Node that will be positioned within the ComboBox 'button' area.- Specified by:
getDisplayNode
in classComboBoxBaseSkin<T>
- Returns:
- the node that will be positioned within the ComboBox 'button' area
-
getPopupContent
This method should return the Node that will be displayed when the user clicks on the ComboBox 'button' area.- Specified by:
getPopupContent
in classComboBoxPopupControl<T>
- Returns:
- the Node that will be displayed when the user clicks on the ComboBox 'button' area
-
computeMinWidth
protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)Computes the minimum allowable width of the Skin, based on the provided height.- Overrides:
computeMinWidth
in classSkinBase<ComboBoxBase<T>>
- Parameters:
height
- The height of the Skin, in case this value might dictate the minimum width.topInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- A double representing the minimum width of this Skin.
-
computePrefWidth
protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)Calculates the preferred width of thisSkinBase
. 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 classComboBoxBaseSkin<T>
- Parameters:
height
- the height that should be used if preferred width depends on ittopInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- the calculated preferred width
-
computeMaxWidth
protected double computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)Computes the maximum allowable width of the Skin, based on the provided height.- Overrides:
computeMaxWidth
in classComboBoxBaseSkin<T>
- Parameters:
height
- The height of the Skin, in case this value might dictate the maximum width.topInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- A double representing the maximum 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 classSkinBase<ComboBoxBase<T>>
- Parameters:
width
- The width of the Skin, in case this value might dictate the minimum height.topInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- A double representing the minimum height of this Skin.
-
computePrefHeight
protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)Calculates the preferred height of thisSkinBase
. 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 classComboBoxBaseSkin<T>
- Parameters:
width
- the width that should be used if preferred height depends on ittopInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- the calculated preferred height
-
computeMaxHeight
protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)Computes the maximum allowable height of the Skin, based on the provided width.- Overrides:
computeMaxHeight
in classComboBoxBaseSkin<T>
- Parameters:
width
- The width of the Skin, in case this value might dictate the maximum height.topInset
- the pixel snapped top insetrightInset
- the pixel snapped right insetbottomInset
- the pixel snapped bottom insetleftInset
- the pixel snapped left inset- Returns:
- A double representing the maximum height of this Skin.
-
layoutChildren
protected void layoutChildren(double x, double y, double w, double h)Called during the layout pass of the scenegraph.- Overrides:
layoutChildren
in classComboBoxBaseSkin<T>
- Parameters:
x
- the x positiony
- the y positionw
- the widthh
- the height
-
queryAccessibleAttribute
This method is called by the assistive technology to request the value for an attribute.This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.- Overrides:
queryAccessibleAttribute
in classSkinBase<ComboBoxBase<T>>
- Parameters:
attribute
- the requested attributeparameters
- optional list of parameters- Returns:
- the value for the requested attribute
- See Also:
AccessibleAttribute
,Node.queryAccessibleAttribute(javafx.scene.AccessibleAttribute, java.lang.Object...)
-