Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXComboBox<T>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.TextInputControl

javafx.scene.control.TextField

io.github.palexdev.materialfx.controls.MFXTextField

io.github.palexdev.materialfx.controls.MFXComboBox<T>

All Implemented Interfaces:

MFXCombo<T>, MFXMenuControl, Validated, Styleable, EventTarget, Skinnable

Direct Known Subclasses:

MFXFilterComboBox

public class MFXComboBox<T>
extends MFXTextField
implements MFXCombo<T>

A new, completely remade from scratch ComboBox for JavaFX.

A combo box is basically a text field which shows a menu of items and allows to select them and set the text accordingly.

That's why my implementation extends MFXTextField and implements MFXCombo.

The major features of this new combo are:

- Floating text (inherited from MFXTextField)

- Allows to fully control the popup (offset, alignment)

- Automatically handles selection when the item's list is modified

- Allows to set the combo as editable or not, and in case of changed text to commit the change (pressing enter by default) and specify how to treat the typed text, or cancel the change (pressing Ctrl+Shift+Z by default).

- Also adds a new PseudoClass that activates when the popup opens

Property Summary

Properties

Type	Property	Description
BiFunctionProperty<Node,Boolean,Animation>	animationProvider	Specifies the animation of the trailing icon used to open the popup.
ObjectProperty<Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>>	cellFactory	Specifies the function used to create the items cells in the popup.
ObjectProperty<StringConverter<T>>	converter	Specifies the converter used to convert an object of type T to a String.
ObjectProperty<ObservableList<T>>	items	Specifies the combo box's items list.
ConsumerProperty<String>	onCancel	Specifies the action to perform on MFXCombo.cancel(String).
ConsumerProperty<String>	onCommit	Specifies the action to perform on MFXCombo.commit(String).
EventHandlerProperty<Event>	onHidden	Specifies the action when the popup is hidden.
EventHandlerProperty<Event>	onHiding	Specifies the action when the popup is hiding.
EventHandlerProperty<Event>	onShowing	Specifies the action when the popup is showing.
EventHandlerProperty<Event>	onShown	Specifies the action when the popup is shown.
ObjectProperty<Alignment>	popupAlignment	Specifies the popup's alignment.
DoubleProperty	popupOffsetX	Specifies the popup's x offset.
DoubleProperty	popupOffsetY	Specifies the popup's y offset.
StyleableBooleanProperty	scrollOnOpen	Specifies whether the combo box list should scroll to the current selected value on open.
ReadOnlyIntegerProperty	selectedIndex	Delegate for SingleSelectionModel.selectedIndexProperty().
ReadOnlyObjectProperty<T>	selectedItem	Delegate for SingleSelectionModel.selectedItemProperty().
ReadOnlyBooleanProperty	showing	Specifies whether the popup is showing.
ObjectProperty<T>	value	Specifies the combo box's value, which does not necessarily coincides with the currently selected item.

Properties inherited from class io.github.palexdev.materialfx.controls.MFXTextField

allowEdit, animated, borderGap, caretVisible, delegateAnchor, delegateCaretPosition, delegateFocused, delegateRedoable, delegateSelectedText, delegateSelection, delegateTextFormatter, delegateUndoable, floating, floatingTextGap, floatingText, floatMode, graphicTextGap, leadingIcon, measureUnitGap, measureUnit, scaleOnAbove, selectable, textFill, textLimit, trailingIcon

Properties inherited from class javafx.scene.control.TextField

alignment, onAction, prefColumnCount

Properties inherited from class javafx.scene.control.TextInputControl

anchor, caretPosition, editable, font, length, promptText, redoable, selectedText, selection, textFormatter, text, undoable

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Properties inherited from interface io.github.palexdev.materialfx.controls.base.MFXCombo

editable, onAction, promptText

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl

TextInputControl.Content

Field Summary

Fields

Modifier and Type	Field	Description
static final EventType<Event>	ON_HIDDEN
static final EventType<Event>	ON_HIDING
static final EventType<Event>	ON_SHOWING
static final EventType<Event>	ON_SHOWN
protected static final PseudoClass	POPUP_OPEN_PSEUDO_CLASS

Fields inherited from class io.github.palexdev.materialfx.controls.MFXTextField

boundField, contextMenu, DEFAULT_TEXT_COLOR, floating, validator

Fields inherited from class javafx.scene.control.TextField

DEFAULT_PREF_COLUMN_COUNT

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from interface io.github.palexdev.materialfx.validation.Validated

INVALID_PSEUDO_CLASS

Constructor Summary

Constructors

Constructor	Description
MFXComboBox()
MFXComboBox(ObservableList<T> items)

Method Summary

Modifier and Type	Method	Description
BiFunctionProperty<Node,Boolean,Animation>	animationProviderProperty()	Specifies the animation of the trailing icon used to open the popup.
void	cancel(String text)	If the combo box is editable and the text has been changed, this method is responsible for deciding what to do with the new text on cancel.
ObjectProperty<Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>>	cellFactoryProperty()	Specifies the function used to create the items cells in the popup.
void	clearSelection()	Delegate for SingleSelectionModel.clearSelection().
void	commit(String text)	If the combo box is editable and the text has been changed, this method is responsible for deciding what to do with the new text on confirm.
ObjectProperty<StringConverter<T>>	converterProperty()	Specifies the converter used to convert an object of type T to a String.
protected Skin<?>	createDefaultSkin()
void	defaultContextMenu()
BiFunction<Node,Boolean,Animation>	getAnimationProvider()	Gets the value of the property animationProvider.
Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>	getCellFactory()	Gets the value of the property cellFactory.
static List<CssMetaData<? extends Styleable,?>>	getClassCssMetaData()
List<CssMetaData<? extends Styleable,?>>	getControlCssMetaData()
StringConverter<T>	getConverter()	Gets the value of the property converter.
ObservableList<T>	getItems()	Gets the value of the property items.
Consumer<String>	getOnCancel()	Gets the value of the property onCancel.
Consumer<String>	getOnCommit()	Gets the value of the property onCommit.
EventHandler<Event>	getOnHidden()	Gets the value of the property onHidden.
EventHandler<Event>	getOnHiding()	Gets the value of the property onHiding.
EventHandler<Event>	getOnShowing()	Gets the value of the property onShowing.
EventHandler<Event>	getOnShown()	Gets the value of the property onShown.
Alignment	getPopupAlignment()	Gets the value of the property popupAlignment.
double	getPopupOffsetX()	Gets the value of the property popupOffsetX.
double	getPopupOffsetY()	Gets the value of the property popupOffsetY.
int	getSelectedIndex()	Delegate for SingleSelectionModel.getSelectedIndex().
T	getSelectedItem()	Delegate for SingleSelectionModel.getSelectedItem().
ComboBoxSelectionModel<T>	getSelectionModel()
String	getUserAgentStylesheet()
MFXValidator	getValidator()
T	getValue()	Gets the value of the property value.
void	hide()	Hides the popup.
boolean	isScrollOnOpen()	Gets the value of the property scrollOnOpen.
boolean	isShowing()	Gets the value of the property showing.
protected void	itemsChanged(ListChangeListener.Change<? extends T> change)	Responsible for updating the selection when the items list changes.
ObjectProperty<ObservableList<T>>	itemsProperty()	Specifies the combo box's items list.
ConsumerProperty<String>	onCancelProperty()	Specifies the action to perform on MFXCombo.cancel(String).
ConsumerProperty<String>	onCommitProperty()	Specifies the action to perform on MFXCombo.commit(String).
EventHandlerProperty<Event>	onHiddenProperty()	Specifies the action when the popup is hidden.
EventHandlerProperty<Event>	onHidingProperty()	Specifies the action when the popup is hiding.
EventHandlerProperty<Event>	onShowingProperty()	Specifies the action when the popup is showing.
EventHandlerProperty<Event>	onShownProperty()	Specifies the action when the popup is shown.
ObjectProperty<Alignment>	popupAlignmentProperty()	Specifies the popup's alignment.
DoubleProperty	popupOffsetXProperty()	Specifies the popup's x offset.
DoubleProperty	popupOffsetYProperty()	Specifies the popup's y offset.
StyleableBooleanProperty	scrollOnOpenProperty()	Specifies whether the combo box list should scroll to the current selected value on open.
ReadOnlyIntegerProperty	selectedIndexProperty()	Delegate for SingleSelectionModel.selectedIndexProperty().
ReadOnlyObjectProperty<T>	selectedItemProperty()	Delegate for SingleSelectionModel.selectedItemProperty().
void	selectFirst()	Delegate for ComboBoxSelectionModel.selectFirst().
void	selectIndex(int index)	Delegate for SingleSelectionModel.selectIndex(int).
void	selectItem(T item)	Delegate for SingleSelectionModel.selectItem(Object).
void	selectLast()	Delegate for ComboBoxSelectionModel.selectLast().
void	selectNext()	Delegate for ComboBoxSelectionModel.selectNext().
void	selectPrevious()	Delegate for ComboBoxSelectionModel.selectPrevious().
void	setAnimationProvider(BiFunction<Node,Boolean,Animation> animationProvider)	Sets the value of the property animationProvider.
void	setCellFactory(Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>> cellFactory)	Sets the value of the property cellFactory.
void	setConverter(StringConverter<T> converter)	Sets the value of the property converter.
void	setItems(ObservableList<T> items)	Sets the value of the property items.
void	setOnCancel(Consumer<String> onCancel)	Sets the value of the property onCancel.
void	setOnCommit(Consumer<String> onCommit)	Sets the value of the property onCommit.
void	setOnHidden(EventHandler<Event> onHidden)	Sets the value of the property onHidden.
void	setOnHiding(EventHandler<Event> onHiding)	Sets the value of the property onHiding.
void	setOnShowing(EventHandler<Event> onShowing)	Sets the value of the property onShowing.
void	setOnShown(EventHandler<Event> onShown)	Sets the value of the property onShown.
void	setPopupAlignment(Alignment popupAlignment)	Sets the value of the property popupAlignment.
void	setPopupOffsetX(double popupOffsetX)	Sets the value of the property popupOffsetX.
void	setPopupOffsetY(double popupOffsetY)	Sets the value of the property popupOffsetY.
void	setScrollOnOpen(boolean scrollOnOpen)	Sets the value of the property scrollOnOpen.
void	setValue(T value)	Sets the value of the property value.
void	show()	Shows the popup.
ReadOnlyBooleanProperty	showingProperty()	Specifies whether the popup is showing.
ObjectProperty<T>	valueProperty()	Specifies the combo box's value, which does not necessarily coincides with the currently selected item.

Methods inherited from class io.github.palexdev.materialfx.controls.MFXTextField

allowEditProperty, animatedProperty, asLabel, asLabel, asLabel, asLabel, backward, borderGapProperty, caretVisibleProperty, clear, copy, cut, delegateAnchorProperty, delegateCaretPositionProperty, delegateFocusedProperty, delegateGetAnchor, delegateGetCaretPosition, delegateGetSelectedText, delegateGetSelection, delegateGetTextFormatter, delegateIsFocused, delegateIsRedoable, delegateIsUndoable, delegateRedoableProperty, delegateSelectedTextProperty, delegateSelectionProperty, delegateSetTextFormatter, delegateTextFormatterProperty, delegateUndoableProperty, deselect, end, endOfNextWord, extendSelection, floatingProperty, floatingTextGapProperty, floatingTextProperty, floatModeProperty, forward, getBorderGap, getCaretVisible, getFloatingText, getFloatingTextGap, getFloatMode, getGraphicTextGap, getLeadingIcon, getMeasureUnit, getMeasureUnitGap, getMFXContextMenu, getTextFill, getTextLimit, getTrailingIcon, graphicTextGapProperty, home, isAllowEdit, isAnimated, isFloating, isSelectable, leadingIconProperty, measureUnitGapProperty, measureUnitProperty, nextWord, paste, positionCaret, previousWord, replaceSelection, scaleOnAbove, scaleOnAboveProperty, selectableProperty, selectAll, selectBackward, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setAllowEdit, setAnimated, setBorderGap, setCaretVisible, setFloatingText, setFloatingTextGap, setFloatMode, setGraphicTextGap, setLeadingIcon, setMeasureUnit, setMeasureUnitGap, setScaleOnAbove, setSelectable, setTextFill, setTextLimit, setTrailingIcon, textFillProperty, textLimitProperty, trailingIconProperty

Methods inherited from class javafx.scene.control.TextField

alignmentProperty, getAlignment, getCharacters, getOnAction, getPrefColumnCount, onActionProperty, prefColumnCountProperty, setAlignment, setOnAction, setPrefColumnCount

Methods inherited from class javafx.scene.control.TextInputControl

anchorProperty, appendText, cancelEdit, caretPositionProperty, commitValue, deleteNextChar, deletePreviousChar, deleteText, deleteText, editableProperty, executeAccessibleAction, fontProperty, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, getTextFormatter, insertText, isEditable, isRedoable, isUndoable, lengthProperty, promptTextProperty, queryAccessibleAttribute, redo, redoableProperty, replaceText, replaceText, selectedTextProperty, selectionProperty, setEditable, setFont, setPromptText, setText, setTextFormatter, textFormatterProperty, textProperty, undo, undoableProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.palexdev.materialfx.controls.base.MFXCombo

editableProperty, getOnAction, getPromptText, isEditable, onActionProperty, promptTextProperty, setEditable, setOnAction, setPromptText

Methods inherited from interface io.github.palexdev.materialfx.controls.base.MFXMenuControl

isContextMenuDisabled, setContextMenuDisabled

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Methods inherited from interface io.github.palexdev.materialfx.validation.Validated

isValid, updateInvalid, validate

Property Details

selectedIndex

public ReadOnlyIntegerProperty selectedIndexProperty

Delegate for SingleSelectionModel.selectedIndexProperty().

See Also:

• getSelectedIndex()

selectedItem

public ReadOnlyObjectProperty<T> selectedItemProperty

Delegate for SingleSelectionModel.selectedItemProperty().

See Also:

• getSelectedItem()

scrollOnOpen

public StyleableBooleanProperty scrollOnOpenProperty

Specifies whether the combo box list should scroll to the current selected value on open.

See Also:

• isScrollOnOpen()
• setScrollOnOpen(boolean)

showing

public ReadOnlyBooleanProperty showingProperty

Specifies whether the popup is showing.

See Also:

• isShowing()

popupAlignment

public ObjectProperty<Alignment> popupAlignmentProperty

Specifies the popup's alignment.

See Also:

• getPopupAlignment()
• setPopupAlignment(Alignment)

popupOffsetX

public DoubleProperty popupOffsetXProperty

Specifies the popup's x offset.

See Also:

• getPopupOffsetX()
• setPopupOffsetX(double)

popupOffsetY

public DoubleProperty popupOffsetYProperty

Specifies the popup's y offset.

See Also:

• getPopupOffsetY()
• setPopupOffsetY(double)

animationProvider

public BiFunctionProperty<Node,Boolean,Animation> animationProviderProperty

Specifies the animation of the trailing icon used to open the popup.

See Also:

• getAnimationProvider()
• setAnimationProvider(BiFunction)

value

public ObjectProperty<T> valueProperty

Specified by:

valueProperty in interface MFXCombo<T>

See Also:

• getValue()
• setValue(T)

converter

public ObjectProperty<StringConverter<T>> converterProperty

Specified by:

converterProperty in interface MFXCombo<T>

See Also:

• getConverter()
• setConverter(StringConverter)

onCommit

public ConsumerProperty<String> onCommitProperty

Specified by:

onCommitProperty in interface MFXCombo<T>

See Also:

• getOnCommit()
• setOnCommit(Consumer)

onCancel

public ConsumerProperty<String> onCancelProperty

Specified by:

onCancelProperty in interface MFXCombo<T>

See Also:

• getOnCancel()
• setOnCancel(Consumer)

items

public ObjectProperty<ObservableList<T>> itemsProperty

Specified by:

itemsProperty in interface MFXCombo<T>

See Also:

• getItems()
• setItems(ObservableList)

cellFactory

public ObjectProperty<Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>> cellFactoryProperty

Specified by:

cellFactoryProperty in interface MFXCombo<T>

See Also:

• getCellFactory()
• setCellFactory(Function)

onShowing

public EventHandlerProperty<Event> onShowingProperty

Specified by:

onShowingProperty in interface MFXCombo<T>

See Also:

• getOnShowing()
• setOnShowing(EventHandler)

onShown

public EventHandlerProperty<Event> onShownProperty

Specified by:

onShownProperty in interface MFXCombo<T>

See Also:

• getOnShown()
• setOnShown(EventHandler)

onHiding

public EventHandlerProperty<Event> onHidingProperty

Specified by:

onHidingProperty in interface MFXCombo<T>

See Also:

• getOnHiding()
• setOnHiding(EventHandler)

onHidden

public EventHandlerProperty<Event> onHiddenProperty

Specified by:

onHiddenProperty in interface MFXCombo<T>

See Also:

• getOnHidden()
• setOnHidden(EventHandler)

Field Details

POPUP_OPEN_PSEUDO_CLASS

protected static final PseudoClass POPUP_OPEN_PSEUDO_CLASS

ON_SHOWING

public static final EventType<Event> ON_SHOWING

ON_SHOWN

public static final EventType<Event> ON_SHOWN

ON_HIDING

public static final EventType<Event> ON_HIDING

ON_HIDDEN

public static final EventType<Event> ON_HIDDEN

Constructor Details

MFXComboBox

public MFXComboBox()

MFXComboBox

public MFXComboBox(ObservableList<T> items)

Method Details

defaultContextMenu

public void defaultContextMenu()

Overrides:

defaultContextMenu in class MFXTextField

show

public void show()

Description copied from interface: MFXCombo

Shows the popup.

Specified by:

show in interface MFXCombo<T>

hide

public void hide()

Description copied from interface: MFXCombo

Hides the popup.

Specified by:

hide in interface MFXCombo<T>

commit

public void commit(String text)

If the combo box is editable and the text has been changed, this method is responsible for deciding what to do with the new text on confirm.

By default this implementation calls the specified onCommitProperty() consumer to perform an action on commit. So, instead of overriding the method you can easily modify its behavior by changing the consumer.

Specified by:

commit in interface MFXCombo<T>

cancel

public void cancel(String text)

If the combo box is editable and the text has been changed, this method is responsible for deciding what to do with the new text on cancel.

By default this implementation calls the specified onCancelProperty() consumer to perform an action on cancel. So, instead of overriding the method you can easily modify its behavior by changing the consumer.

Specified by:

cancel in interface MFXCombo<T>

itemsChanged

protected void itemsChanged(ListChangeListener.Change<? extends T> change)

Responsible for updating the selection when the items list changes.

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class MFXTextField

getControlCssMetaData

public List<CssMetaData<? extends Styleable,?>> getControlCssMetaData()

Overrides:

getControlCssMetaData in class MFXTextField

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class MFXTextField

selectFirst

public void selectFirst()

Delegate for ComboBoxSelectionModel.selectFirst().

selectNext

public void selectNext()

Delegate for ComboBoxSelectionModel.selectNext().

selectPrevious

public void selectPrevious()

Delegate for ComboBoxSelectionModel.selectPrevious().

selectLast

public void selectLast()

Delegate for ComboBoxSelectionModel.selectLast().

clearSelection

public void clearSelection()

Delegate for SingleSelectionModel.clearSelection().

selectIndex

public void selectIndex(int index)

Delegate for SingleSelectionModel.selectIndex(int).

selectItem

public void selectItem(T item)

Delegate for SingleSelectionModel.selectItem(Object).

getSelectedIndex

public int getSelectedIndex()

Delegate for SingleSelectionModel.getSelectedIndex().

selectedIndexProperty

public ReadOnlyIntegerProperty selectedIndexProperty()

Delegate for SingleSelectionModel.selectedIndexProperty().

See Also:

• getSelectedIndex()

getSelectedItem

public T getSelectedItem()

Delegate for SingleSelectionModel.getSelectedItem().

selectedItemProperty

public ReadOnlyObjectProperty<T> selectedItemProperty()

Delegate for SingleSelectionModel.selectedItemProperty().

See Also:

• getSelectedItem()

getValidator

public MFXValidator getValidator()

Specified by:

getValidator in interface Validated

Overrides:

getValidator in class MFXTextField

Returns:

the MFXValidator instance of this control

isScrollOnOpen

public boolean isScrollOnOpen()

Gets the value of the property scrollOnOpen.

Property description:

Specifies whether the combo box list should scroll to the current selected value on open.

scrollOnOpenProperty

public StyleableBooleanProperty scrollOnOpenProperty()

Specifies whether the combo box list should scroll to the current selected value on open.

See Also:

• isScrollOnOpen()
• setScrollOnOpen(boolean)

setScrollOnOpen

public void setScrollOnOpen(boolean scrollOnOpen)

Sets the value of the property scrollOnOpen.

Property description:

Specifies whether the combo box list should scroll to the current selected value on open.

getClassCssMetaData

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

isShowing

public boolean isShowing()

Gets the value of the property showing.

Property description:

Specifies whether the popup is showing.

showingProperty

public ReadOnlyBooleanProperty showingProperty()

Specifies whether the popup is showing.

See Also:

• isShowing()

getPopupAlignment

public Alignment getPopupAlignment()

Gets the value of the property popupAlignment.

Property description:

Specifies the popup's alignment.

popupAlignmentProperty

public ObjectProperty<Alignment> popupAlignmentProperty()

Specifies the popup's alignment.

See Also:

• getPopupAlignment()
• setPopupAlignment(Alignment)

setPopupAlignment

public void setPopupAlignment(Alignment popupAlignment)

Sets the value of the property popupAlignment.

Property description:

Specifies the popup's alignment.

getPopupOffsetX

public double getPopupOffsetX()

Gets the value of the property popupOffsetX.

Property description:

Specifies the popup's x offset.

popupOffsetXProperty

public DoubleProperty popupOffsetXProperty()

Specifies the popup's x offset.

See Also:

• getPopupOffsetX()
• setPopupOffsetX(double)

setPopupOffsetX

public void setPopupOffsetX(double popupOffsetX)

Sets the value of the property popupOffsetX.

Property description:

Specifies the popup's x offset.

getPopupOffsetY

public double getPopupOffsetY()

Gets the value of the property popupOffsetY.

Property description:

Specifies the popup's y offset.

popupOffsetYProperty

public DoubleProperty popupOffsetYProperty()

Specifies the popup's y offset.

See Also:

• getPopupOffsetY()
• setPopupOffsetY(double)

setPopupOffsetY

public void setPopupOffsetY(double popupOffsetY)

Sets the value of the property popupOffsetY.

Property description:

Specifies the popup's y offset.

getAnimationProvider

public BiFunction<Node,Boolean,Animation> getAnimationProvider()

Gets the value of the property animationProvider.

Property description:

Specifies the animation of the trailing icon used to open the popup.

animationProviderProperty

public BiFunctionProperty<Node,Boolean,Animation> animationProviderProperty()

Specifies the animation of the trailing icon used to open the popup.

See Also:

• getAnimationProvider()
• setAnimationProvider(BiFunction)

setAnimationProvider

public void setAnimationProvider(BiFunction<Node,Boolean,Animation> animationProvider)

Sets the value of the property animationProvider.

Property description:

Specifies the animation of the trailing icon used to open the popup.

getValue

public T getValue()

Gets the value of the property value.

Specified by:

getValue in interface MFXCombo<T>

Property description:

valueProperty

public ObjectProperty<T> valueProperty()

Description copied from interface: MFXCombo

Specifies the combo box's value, which does not necessarily coincides with the currently selected item.

Specified by:

valueProperty in interface MFXCombo<T>

See Also:

• getValue()
• setValue(T)

setValue

public void setValue(T value)

Sets the value of the property value.

Specified by:

setValue in interface MFXCombo<T>

Property description:

getConverter

public StringConverter<T> getConverter()

Gets the value of the property converter.

Specified by:

getConverter in interface MFXCombo<T>

Property description:

converterProperty

public ObjectProperty<StringConverter<T>> converterProperty()

Description copied from interface: MFXCombo

Specifies the converter used to convert an object of type T to a String. It is used, for example, to set the combo box text when an item is selected.

Specified by:

converterProperty in interface MFXCombo<T>

See Also:

• getConverter()
• setConverter(StringConverter)

setConverter

public void setConverter(StringConverter<T> converter)

Sets the value of the property converter.

Specified by:

setConverter in interface MFXCombo<T>

Property description:

getOnCommit

public Consumer<String> getOnCommit()

Gets the value of the property onCommit.

Specified by:

getOnCommit in interface MFXCombo<T>

Property description:

onCommitProperty

public ConsumerProperty<String> onCommitProperty()

Description copied from interface: MFXCombo

Specifies the action to perform on MFXCombo.commit(String).

Specified by:

onCommitProperty in interface MFXCombo<T>

See Also:

• getOnCommit()
• setOnCommit(Consumer)

setOnCommit

public void setOnCommit(Consumer<String> onCommit)

Sets the value of the property onCommit.

Specified by:

setOnCommit in interface MFXCombo<T>

Property description:

getOnCancel

public Consumer<String> getOnCancel()

Gets the value of the property onCancel.

Specified by:

getOnCancel in interface MFXCombo<T>

Property description:

onCancelProperty

public ConsumerProperty<String> onCancelProperty()

Description copied from interface: MFXCombo

Specifies the action to perform on MFXCombo.cancel(String).

Specified by:

onCancelProperty in interface MFXCombo<T>

See Also:

• getOnCancel()
• setOnCancel(Consumer)

setOnCancel

public void setOnCancel(Consumer<String> onCancel)

Sets the value of the property onCancel.

Specified by:

setOnCancel in interface MFXCombo<T>

Property description:

getItems

public ObservableList<T> getItems()

Gets the value of the property items.

Specified by:

getItems in interface MFXCombo<T>

Property description:

itemsProperty

public ObjectProperty<ObservableList<T>> itemsProperty()

Description copied from interface: MFXCombo

Specifies the combo box's items list.

Specified by:

itemsProperty in interface MFXCombo<T>

See Also:

• getItems()
• setItems(ObservableList)

setItems

public void setItems(ObservableList<T> items)

Sets the value of the property items.

Specified by:

setItems in interface MFXCombo<T>

Property description:

getCellFactory

public Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>> getCellFactory()

Gets the value of the property cellFactory.

Specified by:

getCellFactory in interface MFXCombo<T>

Property description:

cellFactoryProperty

public ObjectProperty<Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>> cellFactoryProperty()

Description copied from interface: MFXCombo

Specifies the function used to create the items cells in the popup.

Specified by:

cellFactoryProperty in interface MFXCombo<T>

See Also:

• getCellFactory()
• setCellFactory(Function)

setCellFactory

public void setCellFactory(Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>> cellFactory)

Sets the value of the property cellFactory.

Specified by:

setCellFactory in interface MFXCombo<T>

Property description:

getSelectionModel

public ComboBoxSelectionModel<T> getSelectionModel()

Specified by:

getSelectionModel in interface MFXCombo<T>

Returns:

the combo box' selection model

getOnShowing

public EventHandler<Event> getOnShowing()

Gets the value of the property onShowing.

Specified by:

getOnShowing in interface MFXCombo<T>

Property description:

onShowingProperty

public EventHandlerProperty<Event> onShowingProperty()

Description copied from interface: MFXCombo

Specifies the action when the popup is showing.

Specified by:

onShowingProperty in interface MFXCombo<T>

See Also:

• getOnShowing()
• setOnShowing(EventHandler)

setOnShowing

public void setOnShowing(EventHandler<Event> onShowing)

Sets the value of the property onShowing.

Specified by:

setOnShowing in interface MFXCombo<T>

Property description:

getOnShown

public EventHandler<Event> getOnShown()

Gets the value of the property onShown.

Specified by:

getOnShown in interface MFXCombo<T>

Property description:

onShownProperty

public EventHandlerProperty<Event> onShownProperty()

Description copied from interface: MFXCombo

Specifies the action when the popup is shown.

Specified by:

onShownProperty in interface MFXCombo<T>

See Also:

• getOnShown()
• setOnShown(EventHandler)

setOnShown

public void setOnShown(EventHandler<Event> onShown)

Sets the value of the property onShown.

Specified by:

setOnShown in interface MFXCombo<T>

Property description:

getOnHiding

public EventHandler<Event> getOnHiding()

Gets the value of the property onHiding.

Specified by:

getOnHiding in interface MFXCombo<T>

Property description:

onHidingProperty

public EventHandlerProperty<Event> onHidingProperty()

Description copied from interface: MFXCombo

Specifies the action when the popup is hiding.

Specified by:

onHidingProperty in interface MFXCombo<T>

See Also:

• getOnHiding()
• setOnHiding(EventHandler)

setOnHiding

public void setOnHiding(EventHandler<Event> onHiding)

Sets the value of the property onHiding.

Specified by:

setOnHiding in interface MFXCombo<T>

Property description:

getOnHidden

public EventHandler<Event> getOnHidden()

Gets the value of the property onHidden.

Specified by:

getOnHidden in interface MFXCombo<T>

Property description:

onHiddenProperty

public EventHandlerProperty<Event> onHiddenProperty()

Description copied from interface: MFXCombo

Specifies the action when the popup is hidden.

Specified by:

onHiddenProperty in interface MFXCombo<T>

See Also:

• getOnHidden()
• setOnHidden(EventHandler)

setOnHidden

public void setOnHidden(EventHandler<Event> onHidden)

Sets the value of the property onHidden.

Specified by:

setOnHidden in interface MFXCombo<T>

Property description: