Class ChoiceDialog<T>

java.lang.Object

javafx.scene.control.Dialog<T>

javafx.scene.control.ChoiceDialog<T>

Type Parameters:

T - The type of the items to show to the user, and the type that is returned via Dialog.getResult() when the dialog is dismissed.

All Implemented Interfaces:

EventTarget

public class ChoiceDialog<T>
extends Dialog<T>

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();

Since:

JavaFX 8u40

See Also:

• Dialog

Property Summary

Properties

Type	Property	Description
final ReadOnlyObjectProperty<T>	selectedItem	Returns the property representing the currently selected item in the dialog.

Properties declared in class Dialog

contentText, dialogPane, graphic, headerText, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, resizable, resultConverter, result, showing, title, width, x, y

Type	Property	Description
final StringProperty	contentText	A property representing the content text for the dialog pane.
final ObjectProperty<DialogPane>	dialogPane	The root node of the dialog, the DialogPane contains all visual elements shown in the dialog.
final ObjectProperty<Node>	graphic	The dialog graphic, presented either in the header, if one is showing, or to the left of the content.
final StringProperty	headerText	A property representing the header text for the dialog pane.
final ReadOnlyDoubleProperty	height	Property representing the height of the dialog.
final ObjectProperty<EventHandler<DialogEvent>>	onCloseRequest	Called when there is an external request to close this Dialog.
final ObjectProperty<EventHandler<DialogEvent>>	onHidden	Called just after the Dialog has been hidden.
final ObjectProperty<EventHandler<DialogEvent>>	onHiding	Called just prior to the Dialog being hidden.
final ObjectProperty<EventHandler<DialogEvent>>	onShowing	Called just prior to the Dialog being shown.
final ObjectProperty<EventHandler<DialogEvent>>	onShown	Called just after the Dialog is shown.
final BooleanProperty	resizable	Represents whether the dialog is resizable.
final ObjectProperty<Callback<ButtonType, T>>	resultConverter	API to convert the ButtonType that the user clicked on into a result that can be returned via the result property.
final ObjectProperty<T>	result	A property representing what has been returned from the dialog.
final ReadOnlyBooleanProperty	showing	Represents whether the dialog is currently showing.
final StringProperty	title	Return the titleProperty of the dialog.
final ReadOnlyDoubleProperty	width	Property representing the width of the dialog.
final ReadOnlyDoubleProperty	x	The horizontal location of this Dialog.
final ReadOnlyDoubleProperty	y	The vertical location of this Dialog.

Constructor Summary

Constructors

Constructor	Description
ChoiceDialog()	Creates a default, empty instance of ChoiceDialog with no set items and a null default choice.
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.
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.

Method Summary

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

Methods declared in class 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, setResultConverter, setTitle, setWidth, setX, setY, show, showAndWait, showingProperty, titleProperty, widthProperty, xProperty, yProperty

Modifier and Type	Method	Description
final <E extends Event> void	addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)	Registers an event filter for this target.
final <E extends Event> void	addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)	Registers an event handler for this target.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
final void	close()	Closes this Dialog.
final StringProperty	contentTextProperty()	A property representing the content text for the dialog pane.
final ObjectProperty<DialogPane>	dialogPaneProperty()	The root node of the dialog, the DialogPane contains all visual elements shown in the dialog.
final String	getContentText()	Returns the currently-set content text for this DialogPane.
final DialogPane	getDialogPane()	Gets the value of the dialogPane property.
final Node	getGraphic()	Gets the value of the graphic property.
final String	getHeaderText()	Returns the currently-set header text for this DialogPane.
final double	getHeight()	Returns the height of the dialog.
final Modality	getModality()	Retrieves the modality attribute for this dialog.
final EventHandler<DialogEvent>	getOnCloseRequest()	Gets the value of the onCloseRequest property.
final EventHandler<DialogEvent>	getOnHidden()	Gets the value of the onHidden property.
final EventHandler<DialogEvent>	getOnHiding()	Gets the value of the onHiding property.
final EventHandler<DialogEvent>	getOnShowing()	Gets the value of the onShowing property.
final EventHandler<DialogEvent>	getOnShown()	Gets the value of the onShown property.
final Window	getOwner()	Retrieves the owner Window for this dialog, or null for an unowned dialog.
final T	getResult()	Gets the value of the result property.
final Callback<ButtonType, T>	getResultConverter()	Gets the value of the resultConverter property.
final String	getTitle()	Return the title of the dialog.
final double	getWidth()	Returns the width of the dialog.
final double	getX()	Gets the value of the x property.
final double	getY()	Gets the value of the y property.
final ObjectProperty<Node>	graphicProperty()	The dialog graphic, presented either in the header, if one is showing, or to the left of the content.
final StringProperty	headerTextProperty()	A property representing the header text for the dialog pane.
final ReadOnlyDoubleProperty	heightProperty()	Property representing the height of the dialog.
final void	hide()	Hides this Dialog.
final void	initModality(Modality modality)	Specifies the modality for this dialog.
final void	initOwner(Window window)	Specifies the owner Window for this dialog, or null for a top-level, unowned dialog.
final void	initStyle(StageStyle style)	Specifies the style for this dialog.
final boolean	isResizable()	Returns whether or not the dialog is resizable.
final boolean	isShowing()	Returns whether or not the dialog is showing.
final ObjectProperty<EventHandler<DialogEvent>>	onCloseRequestProperty()	Called when there is an external request to close this Dialog.
final ObjectProperty<EventHandler<DialogEvent>>	onHiddenProperty()	Called just after the Dialog has been hidden.
final ObjectProperty<EventHandler<DialogEvent>>	onHidingProperty()	Called just prior to the Dialog being hidden.
final ObjectProperty<EventHandler<DialogEvent>>	onShowingProperty()	Called just prior to the Dialog being shown.
final ObjectProperty<EventHandler<DialogEvent>>	onShownProperty()	Called just after the Dialog is shown.
final <E extends Event> void	removeEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)	Unregisters a previously registered event filter from this target.
final <E extends Event> void	removeEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)	Unregisters a previously registered event handler from this target.
final BooleanProperty	resizableProperty()	Represents whether the dialog is resizable.
final ObjectProperty<Callback<ButtonType, T>>	resultConverterProperty()	API to convert the ButtonType that the user clicked on into a result that can be returned via the result property.
final ObjectProperty<T>	resultProperty()	A property representing what has been returned from the dialog.
final void	setContentText(String contentText)	Sets the string to show in the dialog content area.
final void	setDialogPane(DialogPane value)	Sets the value of the dialogPane property.
final void	setGraphic(Node graphic)	Sets the dialog graphic, which will be displayed either in the header, if one is showing, or to the left of the content.
final void	setHeaderText(String headerText)	Sets the string to show in the dialog header area.
final void	setHeight(double height)	Sets the height of the dialog.
final void	setOnCloseRequest(EventHandler<DialogEvent> value)	Sets the value of the onCloseRequest property.
final void	setOnHidden(EventHandler<DialogEvent> value)	Sets the value of the onHidden property.
final void	setOnHiding(EventHandler<DialogEvent> value)	Sets the value of the onHiding property.
final void	setOnShowing(EventHandler<DialogEvent> value)	Sets the value of the onShowing property.
final void	setOnShown(EventHandler<DialogEvent> value)	Sets the value of the onShown property.
final void	setResizable(boolean resizable)	Sets whether the dialog can be resized by the user.
final void	setResult(T value)	Sets the value of the result property.
final void	setResultConverter(Callback<ButtonType, T> value)	Sets the value of the resultConverter property.
final void	setTitle(String title)	Change the Title of the dialog.
final void	setWidth(double width)	Sets the width of the dialog.
final void	setX(double x)	Sets the value of the x property.
final void	setY(double y)	Sets the value of the y property.
final void	show()	Shows the dialog but does not wait for a user response (in other words, this brings up a non-blocking dialog).
final Optional<T>	showAndWait()	Shows the dialog and waits for the user response (in other words, brings up a blocking dialog, with the returned value the users input).
final ReadOnlyBooleanProperty	showingProperty()	Represents whether the dialog is currently showing.
final StringProperty	titleProperty()	Return the titleProperty of the dialog.
final ReadOnlyDoubleProperty	widthProperty()	Property representing the width of the dialog.
final ReadOnlyDoubleProperty	xProperty()	The horizontal location of this Dialog.
final ReadOnlyDoubleProperty	yProperty()	The vertical location of this Dialog.

Methods declared in class Object

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

Property Details

selectedItem

public final ReadOnlyObjectProperty<T> selectedItemProperty

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

See Also:

• getSelectedItem()
• setSelectedItem(T)
• selectedItemProperty()

Constructor Details

ChoiceDialog

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

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 - The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array.

choices - All possible choices to present to the user.

ChoiceDialog

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 - The item to display as the pre-selected choice in the dialog. This item must be contained within the choices varargs array.

choices - All possible choices to present to the user.

Method Details

getSelectedItem

public final T getSelectedItem()

Returns the currently selected item in the dialog.

Returns:

the currently selected item

selectedItemProperty

public final ReadOnlyObjectProperty<T> selectedItemProperty()

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

Returns:

the currently selected item property

See Also:

• getSelectedItem()
• setSelectedItem(T)

setSelectedItem

public final void setSelectedItem(T item)

Sets the currently selected item in the dialog.

Parameters:

item - The item to select in the dialog.

getItems

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:

the list of all items that will be displayed to users

getDefaultChoice

public final T getDefaultChoice()

Returns the default choice that was specified in the constructor.

Returns:

the default choice