JavaFX 25 · javafx.scene.control.ChoiceDialog · APIdia, the JavaDoc alternative

A dialog that shows a list of choices to the user, from which they can pick one item at most.

Example:

 List<String> colors = List.of("Red", "Yellow", "Green");
ChoiceDialog choiceDialog = new ChoiceDialog<>("Yellow", colors);
choiceDialog.showAndWait();

Modifier and Type	Field and Description
private final ComboBox<T>	comboBox
private final T	defaultChoice
private final GridPane	grid
private final Label	label

Constructor Summary

Access	Constructor and Description
public	ChoiceDialog() Creates a default, empty instance of ChoiceDialog with no set items and a null default choice.
public	ChoiceDialog(T The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array. defaultChoice, T... All possible choices to present to the user. choices) Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and all following arguments considered a varargs array of all available choices for the user.
public	ChoiceDialog(T The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array. defaultChoice, Collection<T> All possible choices to present to the user. choices) Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and the second argument specifying a collection of all available choices for the user.

Method Summary

Modifier and Type	Method and Description
public final T	Returns: the default choice getDefaultChoice() Returns the default choice that was specified in the constructor.
public final ObservableList<T>	Returns: the list of all items that will be displayed to users getItems() Returns the list of all items that will be displayed to users.
public final T	Returns: the currently selected item getSelectedItem() Returns the currently selected item in the dialog.
public final ReadOnlyObjectProperty<T>	Returns: the currently selected item property selectedItemProperty() Returns the property representing the currently selected item in the dialog.
public final void	setSelectedItem(T The item to select in the dialog. item) Sets the currently selected item in the dialog.
private void	updateGrid()

Inherited from javafx.scene.control.Dialog:: addEventFilter addEventHandler buildEventDispatchChain close contentTextProperty dialogPaneProperty getContentText getDialogPane getGraphic getHeaderText getHeight getModality getOnCloseRequest getOnHidden getOnHiding getOnShowing getOnShown getOwner getResult getResultConverter getTitle getWidth getX getY graphicProperty headerTextProperty heightProperty hide initModality initOwner initStyle isResizable isShowing onCloseRequestProperty onHiddenProperty onHidingProperty onShowingProperty onShownProperty removeEventFilter removeEventHandler resizableProperty resultConverterProperty resultProperty setContentText setDialogPane setGraphic setHeaderText setHeight setOnCloseRequest setOnHidden setOnHiding setOnShowing setOnShown setResizable setResult setResultAndClose setResultConverter setTitle setWidth setX setY show showAndWait showingProperty titleProperty widthProperty xProperty yProperty

Field Detail

comboBox	back to summary
private final ComboBox<T> comboBox

defaultChoice	back to summary
private final T defaultChoice

grid	back to summary
private final GridPane grid

grid

back to summary

private final GridPane grid

label	back to summary
private final Label label

Constructor Detail

ChoiceDialog	back to summary
public ChoiceDialog() Creates a default, empty instance of ChoiceDialog with no set items and a null default choice. Users of this constructor will subsequently need to call `getItems()` to specify which items to show to the user.

ChoiceDialog	back to summary
public ChoiceDialog(T defaultChoice, T... choices) Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and all following arguments considered a varargs array of all available choices for the user. It is expected that the defaultChoice be one of the elements in the choices varargs array. If this is not true, then defaultChoice will be set to null and the dialog will show with the initial choice set to the first item in the list of choices. Parameters defaultChoice:T The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array. choices:T[] All possible choices to present to the user.

ChoiceDialog

back to summary

public ChoiceDialog(T defaultChoice, T... choices)

Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and all following arguments considered a varargs array of all available choices for the user. It is expected that the defaultChoice be one of the elements in the choices varargs array. If this is not true, then defaultChoice will be set to null and the dialog will show with the initial choice set to the first item in the list of choices.

Parameters

defaultChoice:T: The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array.
choices:T[]: All possible choices to present to the user.

ChoiceDialog	back to summary
public ChoiceDialog(T defaultChoice, Collection<T> choices) Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and the second argument specifying a collection of all available choices for the user. It is expected that the defaultChoice be one of the elements in the choices collection. If this is not true, then defaultChoice will be set to null and the dialog will show with the initial choice set to the first item in the list of choices. Parameters defaultChoice:T The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array. choices:Collection<T> All possible choices to present to the user.

ChoiceDialog

back to summary

public ChoiceDialog(T defaultChoice, Collection<T> choices)

Creates a new ChoiceDialog instance with the first argument specifying the default choice that should be shown to the user, and the second argument specifying a collection of all available choices for the user. It is expected that the defaultChoice be one of the elements in the choices collection. If this is not true, then defaultChoice will be set to null and the dialog will show with the initial choice set to the first item in the list of choices.

Parameters

defaultChoice:T: The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array.
choices:Collection<T>: All possible choices to present to the user.

Method Detail

getDefaultChoice	back to summary
public final T getDefaultChoice() Returns the default choice that was specified in the constructor. Returns:T the default choice

getDefaultChoice

back to summary

public final T getDefaultChoice()

Returns the default choice that was specified in the constructor.

Returns:T: the default choice

getItems	back to summary
public final ObservableList<T> getItems() Returns the list of all items that will be displayed to users. This list can be modified by the developer to add, remove, or reorder the items to present to the user. Returns:ObservableList<T> the list of all items that will be displayed to users

getItems

back to summary

public final ObservableList<T> getItems()

Returns the list of all items that will be displayed to users. This list can be modified by the developer to add, remove, or reorder the items to present to the user.

Returns:ObservableList<T>: the list of all items that will be displayed to users

getSelectedItem	back to summary
public final T getSelectedItem() Returns the currently selected item in the dialog. Returns:T the currently selected item

getSelectedItem

back to summary

public final T getSelectedItem()

Returns the currently selected item in the dialog.

Returns:T: the currently selected item

selectedItemProperty	back to summary
public final ReadOnlyObjectProperty<T> selectedItemProperty() Returns the property representing the currently selected item in the dialog. Returns:ReadOnlyObjectProperty<T> the currently selected item property

selectedItemProperty

back to summary

public final ReadOnlyObjectProperty<T> selectedItemProperty()

Returns the property representing the currently selected item in the dialog.

Returns:ReadOnlyObjectProperty<T>: the currently selected item property

setSelectedItem	back to summary
public final void setSelectedItem(T item) Sets the currently selected item in the dialog. Parameters item:T The item to select in the dialog.

setSelectedItem

back to summary

public final void setSelectedItem(T item)

Sets the currently selected item in the dialog.

Parameters

item:T: The item to select in the dialog.

updateGrid	back to summary
private void updateGrid()

public Class ChoiceDialog<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail