Module MaterialFX

Package io.github.palexdev.materialfx.controls.base

Interface MFXCombo<T>

All Known Implementing Classes:

MFXComboBox, MFXFilterComboBox

public interface MFXCombo<T>

Public API every combo box must implement.

Property Summary

Properties

Type	Property	Description
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.
BooleanProperty	editable	Specifies whether the combo box is editable or not.
ObjectProperty<ObservableList<T>>	items	Specifies the combo box's items list.
ObjectProperty<EventHandler<ActionEvent>>	onAction	Specifies the combo box's action when the value property changes.
ConsumerProperty<String>	onCancel	Specifies the action to perform on cancel(String).
ConsumerProperty<String>	onCommit	Specifies the action to perform on 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.
StringProperty	promptText	Specifies the combo box's prompt text.
ObjectProperty<T>	value	Specifies the combo box's value, which does not necessarily coincides with the currently selected item.

Method Summary

Modifier and Type	Method	Description
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	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.
BooleanProperty	editableProperty()	Specifies whether the combo box is editable or not.
Function<T,io.github.palexdev.virtualizedfx.cell.Cell<T>>	getCellFactory()	Gets the value of the property cellFactory.
StringConverter<T>	getConverter()	Gets the value of the property converter.
ObservableList<T>	getItems()	Gets the value of the property items.
EventHandler<ActionEvent>	getOnAction()	Gets the value of the property onAction.
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.
String	getPromptText()	Gets the value of the property promptText.
ISingleSelectionModel<T>	getSelectionModel()
T	getValue()	Gets the value of the property value.
void	hide()	Hides the popup.
boolean	isEditable()	Gets the value of the property editable.
ObjectProperty<ObservableList<T>>	itemsProperty()	Specifies the combo box's items list.
ObjectProperty<EventHandler<ActionEvent>>	onActionProperty()	Specifies the combo box's action when the value property changes.
ConsumerProperty<String>	onCancelProperty()	Specifies the action to perform on cancel(String).
ConsumerProperty<String>	onCommitProperty()	Specifies the action to perform on 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.
StringProperty	promptTextProperty()	Specifies the combo box's prompt text.
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	setEditable(boolean editable)	Sets the value of the property editable.
void	setItems(ObservableList<T> items)	Sets the value of the property items.
void	setOnAction(EventHandler<ActionEvent> onAction)	Sets the value of the property onAction.
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	setPromptText(String promptText)	Sets the value of the property promptText.
void	setValue(T value)	Sets the value of the property value.
void	show()	Shows the popup.
ObjectProperty<T>	valueProperty()	Specifies the combo box's value, which does not necessarily coincides with the currently selected item.

Property Details

value

ObjectProperty<T> valueProperty

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

See Also:

• getValue()
• setValue(T)

converter

ObjectProperty<StringConverter<T>> converterProperty

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.

See Also:

• getConverter()
• setConverter(StringConverter)

editable

BooleanProperty editableProperty

Specifies whether the combo box is editable or not.

See Also:

• isEditable()
• setEditable(boolean)

onCommit

ConsumerProperty<String> onCommitProperty

Specifies the action to perform on commit(String).

See Also:

• getOnCommit()
• setOnCommit(Consumer)

onCancel

ConsumerProperty<String> onCancelProperty

Specifies the action to perform on cancel(String).

See Also:

• getOnCancel()
• setOnCancel(Consumer)

promptText

StringProperty promptTextProperty

Specifies the combo box's prompt text.

See Also:

• getPromptText()
• setPromptText(String)

items

ObjectProperty<ObservableList<T>> itemsProperty

Specifies the combo box's items list.

See Also:

• getItems()
• setItems(ObservableList)

cellFactory

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

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

See Also:

• getCellFactory()
• setCellFactory(Function)

onAction

ObjectProperty<EventHandler<ActionEvent>> onActionProperty

Specifies the combo box's action when the value property changes.

See Also:

• getOnAction()
• setOnAction(EventHandler)

onShowing

EventHandlerProperty<Event> onShowingProperty

Specifies the action when the popup is showing.

See Also:

• getOnShowing()
• setOnShowing(EventHandler)

onShown

EventHandlerProperty<Event> onShownProperty

Specifies the action when the popup is shown.

See Also:

• getOnShown()
• setOnShown(EventHandler)

onHiding

EventHandlerProperty<Event> onHidingProperty

Specifies the action when the popup is hiding.

See Also:

• getOnHiding()
• setOnHiding(EventHandler)

onHidden

EventHandlerProperty<Event> onHiddenProperty

Specifies the action when the popup is hidden.

See Also:

• getOnHidden()
• setOnHidden(EventHandler)

Method Details

show

void show()

Shows the popup.

hide

void hide()

Hides the popup.

getValue

T getValue()

Gets the value of the property value.

Property description:

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

valueProperty

ObjectProperty<T> valueProperty()

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

See Also:

• getValue()
• setValue(T)

setValue

void setValue(T value)

Sets the value of the property value.

Property description:

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

getConverter

StringConverter<T> getConverter()

Gets the value of the property converter.

Property description:

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.

converterProperty

ObjectProperty<StringConverter<T>> converterProperty()

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.

See Also:

• getConverter()
• setConverter(StringConverter)

setConverter

void setConverter(StringConverter<T> converter)

Sets the value of the property converter.

Property description:

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.

isEditable

boolean isEditable()

Gets the value of the property editable.

Property description:

Specifies whether the combo box is editable or not.

editableProperty

BooleanProperty editableProperty()

Specifies whether the combo box is editable or not.

See Also:

• isEditable()
• setEditable(boolean)

setEditable

void setEditable(boolean editable)

Sets the value of the property editable.

Property description:

Specifies whether the combo box is editable or not.

commit

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.

cancel

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.

getOnCommit

Consumer<String> getOnCommit()

Gets the value of the property onCommit.

Property description:

Specifies the action to perform on commit(String).

onCommitProperty

ConsumerProperty<String> onCommitProperty()

Specifies the action to perform on commit(String).

See Also:

• getOnCommit()
• setOnCommit(Consumer)

setOnCommit

void setOnCommit(Consumer<String> onCommit)

Sets the value of the property onCommit.

Property description:

Specifies the action to perform on commit(String).

getOnCancel

Consumer<String> getOnCancel()

Gets the value of the property onCancel.

Property description:

Specifies the action to perform on cancel(String).

onCancelProperty

ConsumerProperty<String> onCancelProperty()

Specifies the action to perform on cancel(String).

See Also:

• getOnCancel()
• setOnCancel(Consumer)

setOnCancel

void setOnCancel(Consumer<String> onCancel)

Sets the value of the property onCancel.

Property description:

Specifies the action to perform on cancel(String).

getPromptText

String getPromptText()

Gets the value of the property promptText.

Property description:

Specifies the combo box's prompt text.

promptTextProperty

StringProperty promptTextProperty()

Specifies the combo box's prompt text.

See Also:

• getPromptText()
• setPromptText(String)

setPromptText

void setPromptText(String promptText)

Sets the value of the property promptText.

Property description:

Specifies the combo box's prompt text.

getItems

ObservableList<T> getItems()

Gets the value of the property items.

Property description:

Specifies the combo box's items list.

itemsProperty

ObjectProperty<ObservableList<T>> itemsProperty()

Specifies the combo box's items list.

See Also:

• getItems()
• setItems(ObservableList)

setItems

void setItems(ObservableList<T> items)

Sets the value of the property items.

Property description:

Specifies the combo box's items list.

getCellFactory

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

Gets the value of the property cellFactory.

Property description:

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

cellFactoryProperty

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

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

See Also:

• getCellFactory()
• setCellFactory(Function)

setCellFactory

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

Sets the value of the property cellFactory.

Property description:

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

getSelectionModel

ISingleSelectionModel<T> getSelectionModel()

Returns:

the combo box' selection model

getOnAction

EventHandler<ActionEvent> getOnAction()

Gets the value of the property onAction.

Property description:

Specifies the combo box's action when the value property changes.

onActionProperty

ObjectProperty<EventHandler<ActionEvent>> onActionProperty()

Specifies the combo box's action when the value property changes.

See Also:

• getOnAction()
• setOnAction(EventHandler)

setOnAction

void setOnAction(EventHandler<ActionEvent> onAction)

Sets the value of the property onAction.

Property description:

Specifies the combo box's action when the value property changes.

getOnShowing

EventHandler<Event> getOnShowing()

Gets the value of the property onShowing.

Property description:

Specifies the action when the popup is showing.

onShowingProperty

EventHandlerProperty<Event> onShowingProperty()

Specifies the action when the popup is showing.

See Also:

• getOnShowing()
• setOnShowing(EventHandler)

setOnShowing

void setOnShowing(EventHandler<Event> onShowing)

Sets the value of the property onShowing.

Property description:

Specifies the action when the popup is showing.

getOnShown

EventHandler<Event> getOnShown()

Gets the value of the property onShown.

Property description:

Specifies the action when the popup is shown.

onShownProperty

EventHandlerProperty<Event> onShownProperty()

Specifies the action when the popup is shown.

See Also:

• getOnShown()
• setOnShown(EventHandler)

setOnShown

void setOnShown(EventHandler<Event> onShown)

Sets the value of the property onShown.

Property description:

Specifies the action when the popup is shown.

getOnHiding

EventHandler<Event> getOnHiding()

Gets the value of the property onHiding.

Property description:

Specifies the action when the popup is hiding.

onHidingProperty

EventHandlerProperty<Event> onHidingProperty()

Specifies the action when the popup is hiding.

See Also:

• getOnHiding()
• setOnHiding(EventHandler)

setOnHiding

void setOnHiding(EventHandler<Event> onHiding)

Sets the value of the property onHiding.

Property description:

Specifies the action when the popup is hiding.

getOnHidden

EventHandler<Event> getOnHidden()

Gets the value of the property onHidden.

Property description:

Specifies the action when the popup is hidden.

onHiddenProperty

EventHandlerProperty<Event> onHiddenProperty()

Specifies the action when the popup is hidden.

See Also:

• getOnHidden()
• setOnHidden(EventHandler)

setOnHidden

void setOnHidden(EventHandler<Event> onHidden)

Sets the value of the property onHidden.

Property description:

Specifies the action when the popup is hidden.