Class ComboBoxPopupControl<T>

java.lang.Object

javafx.scene.control.SkinBase<ComboBoxBase<T>>

javafx.scene.control.skin.ComboBoxBaseSkin<T>

javafx.scene.control.skin.ComboBoxPopupControl<T>

Type Parameters:

T - The type of the ComboBox-like control.

All Implemented Interfaces:

Skin<ComboBoxBase<T>>

Direct Known Subclasses:

ColorPickerSkin, ComboBoxListViewSkin, DatePickerSkin

public abstract class ComboBoxPopupControl<T>
extends ComboBoxBaseSkin<T>

An abstract class that extends the functionality of ComboBoxBaseSkin to include API related to showing ComboBox-like controls as popups.

Since:

9

Constructor Summary

Constructors

Constructor	Description
ComboBoxPopupControl(ComboBoxBase<T> control)	Creates a new instance of ComboBoxPopupControl, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract StringConverter<T>	getConverter()	Subclasses are responsible for getting the converter.
protected abstract TextField	getEditor()	Subclasses are responsible for getting the editor.
protected abstract Node	getPopupContent()	This method should return the Node that will be displayed when the user clicks on the ComboBox 'button' area.
void	hide()	This method will be called when the ComboBox popup should be hidden.
void	show()	This method will be called when the ComboBox popup should be displayed.

Methods declared in class ComboBoxBaseSkin

getDisplayNode

Modifier and Type	Method	Description
abstract Node	getDisplayNode()	This method should return a Node that will be positioned within the ComboBox 'button' area.

Methods declared in class SkinBase

computeBaselineOffset, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, consumeMouseEvents, dispose, executeAccessibleAction, getChildren, getClassCssMetaData, getCssMetaData, getNode, getSkinnable, layoutChildren, layoutInArea, layoutInArea, layoutInArea, positionInArea, positionInArea, pseudoClassStateChanged, queryAccessibleAttribute, registerChangeListener, registerInvalidationListener, registerListChangeListener, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, unregisterChangeListeners, unregisterInvalidationListeners, unregisterListChangeListeners

Modifier and Type	Method	Description
protected double	computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the baseline offset based on the first managed child.
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 this SkinBase.
protected double	computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)	Calculates the preferred width of this SkinBase.
protected final void	consumeMouseEvents(boolean value)	Determines whether all mouse events should be automatically consumed.
void	dispose()	Called when a previously installed skin is about to be removed from its associated control.
protected void	executeAccessibleAction(AccessibleAction action, Object... parameters)	This method is called by the assistive technology to request the action indicated by the argument should be executed.
final ObservableList<Node>	getChildren()	Returns the children of the skin.
static List<CssMetaData<? extends Styleable, ?>>	getClassCssMetaData()	Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.
List<CssMetaData<? extends Styleable, ?>>	getCssMetaData()	This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.
final Node	getNode()	Gets the Node which represents this Skin.
final ComboBoxBase<T>	getSkinnable()	Gets the Skinnable to which this Skin is assigned.
protected void	layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)	Called during the layout pass of the scenegraph.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
protected void	positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)	Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.
final void	pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)	Used to specify that a pseudo-class of this Node has changed.
protected Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)	This method is called by the assistive technology to request the value for an attribute.
protected final void	registerChangeListener(ObservableValue<?> observable, Consumer<ObservableValue<?>> operation)	Registers an operation to perform when the given observable sends a change event.
protected final void	registerInvalidationListener(Observable observable, Consumer<Observable> operation)	Registers an operation to perform when the given observable sends an invalidation event.
protected final void	registerListChangeListener(ObservableList<?> observableList, Consumer<ListChangeListener.Change<?>> operation)	Registers an operation to perform when the given observableList sends a list change event.
protected double	snappedBottomInset()	Utility method to get the bottom inset which includes padding and border inset.
protected double	snappedLeftInset()	Utility method to get the left inset which includes padding and border inset.
protected double	snappedRightInset()	Utility method to get the right inset which includes padding and border inset.
protected double	snappedTopInset()	Utility method to get the top inset which includes padding and border inset.
protected double	snapPosition(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapPositionX() and snapPositionY()
protected double	snapPositionX(double value)	Convenience method for accessing the snapPositionX() method on the skinnable.
protected double	snapPositionY(double value)	Convenience method for accessing the snapPositionY() method on the skinnable.
protected double	snapSize(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSizeX() and snapSizeY()
protected double	snapSizeX(double value)	Convenience method for accessing the snapSizeX() method on the skinnable.
protected double	snapSizeY(double value)	Convenience method for accessing the snapSizeY() method on the skinnable.
protected double	snapSpace(double value)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by snapSpaceX() and snapSpaceY()
protected double	snapSpaceX(double value)	Convenience method for accessing the snapSpaceX() method on the skinnable.
protected double	snapSpaceY(double value)	Convenience method for accessing the snapSpaceY() method on the skinnable.
protected final Consumer<ObservableValue<?>>	unregisterChangeListeners(ObservableValue<?> observable)	Unregisters all operations that have been registered using SkinBase.registerChangeListener(ObservableValue, Consumer) for the given observable.
protected final Consumer<Observable>	unregisterInvalidationListeners(Observable observable)	Unregisters all operations that have been registered using SkinBase.registerInvalidationListener(Observable, Consumer) for the given observable.
protected final Consumer<ListChangeListener.Change<?>>	unregisterListChangeListeners(ObservableList<?> observableList)	Unregisters all operations that have been registered using SkinBase.registerListChangeListener(ObservableList, Consumer) for the given observableList.

Methods declared in class Object

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

Methods declared in interface Skin

install

Modifier and Type	Method	Description
default void	install()	Called once when Skin is set.

Constructor Details

ComboBoxPopupControl

public ComboBoxPopupControl(ComboBoxBase<T> control)

Creates a new instance of ComboBoxPopupControl, although note that this instance does not handle any behavior / input mappings - this needs to be handled appropriately by subclasses.

Parameters:

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

Method Details

getPopupContent

protected abstract Node getPopupContent()

This method should return the Node that will be displayed when the user clicks on the ComboBox 'button' area.

Returns:

the Node that will be displayed when the user clicks on the ComboBox 'button' area

getEditor

protected abstract TextField 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.

Returns:

the editor

getConverter

protected abstract StringConverter<T> 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.

Returns:

the string converter

show

public void show()

This method will be called when the ComboBox popup should be displayed. It is up to specific skin implementations to determine how this is handled.

Specified by:

show in class ComboBoxBaseSkin<T>

hide

public void hide()

This method will be called when the ComboBox popup should be hidden. It is up to specific skin implementations to determine how this is handled.

Specified by:

hide in class ComboBoxBaseSkin<T>