javafx.stage

Class FileChooser

java.lang.Object

javafx.stage.FileChooser

public final class FileChooser
extends java.lang.Object

Provides support for standard platform file dialogs. These dialogs have look and feel of the platform UI components which is independent of JavaFX.

On some platforms where file access may be restricted or not part of the user model (for example, on some mobile or embedded devices), opening a file dialog may always result in a no-op (that is, null file(s) being returned).

A FileChooser can be used to invoke file open dialogs for selecting single file (showOpenDialog), file open dialogs for selecting multiple files (showOpenMultipleDialog) and file save dialogs (showSaveDialog). The configuration of the displayed dialog is controlled by the values of the FileChooser properties set before the corresponding show*Dialog method is called. This configuration includes the dialog's title, the initial directory displayed in the dialog and the extension filter(s) for the listed files. For configuration properties which values haven't been set explicitly, the displayed dialog uses their platform default values. A call to a show dialog method is blocked until the user makes a choice or cancels the dialog. The return value specifies the selected file(s) or equals to null if the dialog has been canceled.

Example:

 FileChooser fileChooser = new FileChooser();
 fileChooser.setTitle("Open Resource File");
 fileChooser.getExtensionFilters().addAll(
         new ExtensionFilter("Text Files", "*.txt"),
         new ExtensionFilter("Image Files", "*.png", "*.jpg", "*.gif"),
         new ExtensionFilter("Audio Files", "*.wav", "*.mp3", "*.aac"),
         new ExtensionFilter("All Files", "*.*"));
 File selectedFile = fileChooser.showOpenDialog(mainStage);
 if (selectedFile != null) {
    mainStage.display(selectedFile);
 }
 

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	initialDirectory The initial directory for the displayed file dialog.
<any>	initialFileName The initial file name for the displayed dialog.
<any>	selectedExtensionFilter This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.
StringProperty	title The title of the displayed file dialog.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileChooser.ExtensionFilter Defines an extension filter, used for filtering which files can be chosen in a FileDialog based on the file name extensions.

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	extensionFilters Specifies the extension filters used in the displayed file dialog.
private <any>	initialDirectory The initial directory for the displayed file dialog.
private <any>	initialFileName The initial file name for the displayed dialog.
private <any>	selectedExtensionFilter This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.
private StringProperty	title The title of the displayed file dialog.

Constructor Summary

Constructors

Constructor and Description
FileChooser()

Method Summary

Modifier and Type	Method and Description
private FileChooser.ExtensionFilter	findSelectedFilter(CommonDialogs.ExtensionFilter filter)
<any>	getExtensionFilters() Gets the extension filters used in the displayed file dialog.
java.io.File	getInitialDirectory() Gets the value of the property initialDirectory.
java.lang.String	getInitialFileName() Gets the value of the property initialFileName.
FileChooser.ExtensionFilter	getSelectedExtensionFilter() Gets the value of the property selectedExtensionFilter.
java.lang.String	getTitle() Gets the value of the property title.
<any>	initialDirectoryProperty() The initial directory for the displayed file dialog.
<any>	initialFileNameProperty() The initial file name for the displayed dialog.
<any>	selectedExtensionFilterProperty() This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.
void	setInitialDirectory(java.io.File value) Sets the value of the property initialDirectory.
void	setInitialFileName(java.lang.String value) Sets the value of the property initialFileName.
void	setSelectedExtensionFilter(FileChooser.ExtensionFilter filter) Sets the value of the property selectedExtensionFilter.
void	setTitle(java.lang.String value) Sets the value of the property title.
private java.util.List<java.io.File>	showDialog(Window ownerWindow, FileChooserType fileChooserType)
java.io.File	showOpenDialog(Window ownerWindow) Shows a new file open dialog.
java.util.List<java.io.File>	showOpenMultipleDialog(Window ownerWindow) Shows a new file open dialog in which multiple files can be selected.
java.io.File	showSaveDialog(Window ownerWindow) Shows a new file save dialog.
StringProperty	titleProperty() The title of the displayed file dialog.

Methods inherited from class java.lang.Object

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

Property Detail

title

public final StringProperty titleProperty

The title of the displayed file dialog.

See Also:

getTitle(), setTitle(String)

initialDirectory

public final <any> initialDirectoryProperty

The initial directory for the displayed file dialog.

See Also:

getInitialDirectory(), setInitialDirectory(File)

initialFileName

public final <any> initialFileNameProperty

The initial file name for the displayed dialog.

This property is used mostly in the displayed file save dialogs as the initial file name for the file being saved. If set for a file open dialog it will have any impact on the displayed dialog only if the corresponding platform provides support for such property in its file open dialogs.

Since:

JavaFX 2.2.40

See Also:

getInitialFileName(), setInitialFileName(String)

selectedExtensionFilter

public final <any> selectedExtensionFilterProperty

This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.

When the file dialog is shown, the selectedExtensionFilter will be checked. If the value of selectedExtensionFilter is null or is not contained in the list of extension filters, then the first extension filter in the list of extension filters will be selected instead. Otherwise, the specified selectedExtensionFilter will be activated.

After the dialog is dismissed the value of this property is updated to match the user-selected extension filter from the dialog.

Since:

JavaFX 8.0

See Also:

getSelectedExtensionFilter(), setSelectedExtensionFilter(ExtensionFilter)

Field Detail

title

private StringProperty title

The title of the displayed file dialog.

initialDirectory

private <any> initialDirectory

The initial directory for the displayed file dialog.

initialFileName

private <any> initialFileName

The initial file name for the displayed dialog.

This property is used mostly in the displayed file save dialogs as the initial file name for the file being saved. If set for a file open dialog it will have any impact on the displayed dialog only if the corresponding platform provides support for such property in its file open dialogs.

Since:

JavaFX 2.2.40

extensionFilters

private <any> extensionFilters

Specifies the extension filters used in the displayed file dialog.

selectedExtensionFilter

private <any> selectedExtensionFilter

This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.

When the file dialog is shown, the selectedExtensionFilter will be checked. If the value of selectedExtensionFilter is null or is not contained in the list of extension filters, then the first extension filter in the list of extension filters will be selected instead. Otherwise, the specified selectedExtensionFilter will be activated.

After the dialog is dismissed the value of this property is updated to match the user-selected extension filter from the dialog.

Since:

JavaFX 8.0

Constructor Detail

FileChooser

public FileChooser()

Method Detail

setTitle

public final void setTitle(java.lang.String value)

Sets the value of the property title.

getTitle

public final java.lang.String getTitle()

Gets the value of the property title.

titleProperty

public final StringProperty titleProperty()

The title of the displayed file dialog.

See Also:

getTitle(), setTitle(String)

setInitialDirectory

public final void setInitialDirectory(java.io.File value)

Sets the value of the property initialDirectory.

getInitialDirectory

public final java.io.File getInitialDirectory()

Gets the value of the property initialDirectory.

initialDirectoryProperty

public final <any> initialDirectoryProperty()

The initial directory for the displayed file dialog.

See Also:

getInitialDirectory(), setInitialDirectory(File)

setInitialFileName

public final void setInitialFileName(java.lang.String value)

Sets the value of the property initialFileName.

Since:

JavaFX 2.2.40

getInitialFileName

public final java.lang.String getInitialFileName()

Gets the value of the property initialFileName.

Since:

JavaFX 2.2.40

initialFileNameProperty

public final <any> initialFileNameProperty()

The initial file name for the displayed dialog.

This property is used mostly in the displayed file save dialogs as the initial file name for the file being saved. If set for a file open dialog it will have any impact on the displayed dialog only if the corresponding platform provides support for such property in its file open dialogs.

Since:

JavaFX 2.2.40

See Also:

getInitialFileName(), setInitialFileName(String)

getExtensionFilters

public <any> getExtensionFilters()

Gets the extension filters used in the displayed file dialog. Only one extension filter from the list is active at any time in the displayed dialog and only files which correspond to this extension filter are shown. The first extension filter from the list is activated when the dialog is invoked. Then the user can switch the active extension filter to any other extension filter from the list and in this way control the set of displayed files.

Returns:

An observable list of the extension filters used in this dialog

selectedExtensionFilterProperty

public final <any> selectedExtensionFilterProperty()

This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.

When the file dialog is shown, the selectedExtensionFilter will be checked. If the value of selectedExtensionFilter is null or is not contained in the list of extension filters, then the first extension filter in the list of extension filters will be selected instead. Otherwise, the specified selectedExtensionFilter will be activated.

After the dialog is dismissed the value of this property is updated to match the user-selected extension filter from the dialog.

Since:

JavaFX 8.0

See Also:

getSelectedExtensionFilter(), setSelectedExtensionFilter(ExtensionFilter)

setSelectedExtensionFilter

public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)

Sets the value of the property selectedExtensionFilter.

Since:

JavaFX 8.0

getSelectedExtensionFilter

public final FileChooser.ExtensionFilter getSelectedExtensionFilter()

Gets the value of the property selectedExtensionFilter.

Since:

JavaFX 8.0

showOpenDialog

public java.io.File showOpenDialog(Window ownerWindow)

Shows a new file open dialog. The method doesn't return until the displayed open dialog is dismissed. The return value specifies the file chosen by the user or null if no selection has been made. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

Parameters:

ownerWindow - the owner window of the displayed file dialog

Returns:

the selected file or null if no file has been selected

showOpenMultipleDialog

public java.util.List<java.io.File> showOpenMultipleDialog(Window ownerWindow)

Shows a new file open dialog in which multiple files can be selected. The method doesn't return until the displayed open dialog is dismissed. The return value specifies the files chosen by the user or null if no selection has been made. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

The returned list is unmodifiable and will throw UnsupportedOperationException on each modification attempt.

Parameters:

ownerWindow - the owner window of the displayed file dialog

Returns:

the selected files or null if no file has been selected

showSaveDialog

public java.io.File showSaveDialog(Window ownerWindow)

Shows a new file save dialog. The method doesn't return until the displayed file save dialog is dismissed. The return value specifies the file chosen by the user or null if no selection has been made. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

Parameters:

ownerWindow - the owner window of the displayed file dialog

Returns:

the selected file or null if no file has been selected

findSelectedFilter

private FileChooser.ExtensionFilter findSelectedFilter(CommonDialogs.ExtensionFilter filter)

showDialog

private java.util.List<java.io.File> showDialog(Window ownerWindow,
                                                FileChooserType fileChooserType)