javafx.stage

Class FileChooser

java.lang.Object

javafx.stage.FileChooser

public final class FileChooser
extends 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

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.

Constructor Summary

Constructors

Constructor and Description
FileChooser()

Method Summary

Modifier and Type	Method and Description
ObservableList<FileChooser.ExtensionFilter>	getExtensionFilters() Gets the extension filters used in the displayed file dialog.
File	getInitialDirectory()
String	getInitialFileName()
FileChooser.ExtensionFilter	getSelectedExtensionFilter()
String	getTitle()
ObjectProperty<File>	initialDirectoryProperty()
ObjectProperty<String>	initialFileNameProperty()
ObjectProperty<FileChooser.ExtensionFilter>	selectedExtensionFilterProperty()
void	setInitialDirectory(File value)
void	setInitialFileName(String value)
void	setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)
void	setTitle(String value)
File	showOpenDialog(Window ownerWindow) Shows a new file open dialog.
List<File>	showOpenMultipleDialog(Window ownerWindow) Shows a new file open dialog in which multiple files can be selected.
File	showSaveDialog(Window ownerWindow) Shows a new file save dialog.
StringProperty	titleProperty()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileChooser

public FileChooser()

Method Detail

setTitle

public final void setTitle(String value)

getTitle

public final String getTitle()

titleProperty

public final StringProperty titleProperty()

setInitialDirectory

public final void setInitialDirectory(File value)

getInitialDirectory

public final File getInitialDirectory()

initialDirectoryProperty

public final ObjectProperty<File> initialDirectoryProperty()

setInitialFileName

public final void setInitialFileName(String value)

getInitialFileName

public final String getInitialFileName()

initialFileNameProperty

public final ObjectProperty<String> initialFileNameProperty()

getExtensionFilters

public ObservableList<FileChooser.ExtensionFilter> 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 ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty()

setSelectedExtensionFilter

public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)

getSelectedExtensionFilter

public final FileChooser.ExtensionFilter getSelectedExtensionFilter()

showOpenDialog

public 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 List<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 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