public final class FileChooser extends Object
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);
}
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 and Description |
---|
FileChooser() |
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() |
public final void setTitle(String value)
public final String getTitle()
public final StringProperty titleProperty()
public final void setInitialDirectory(File value)
public final File getInitialDirectory()
public final ObjectProperty<File> initialDirectoryProperty()
public final void setInitialFileName(String value)
public final String getInitialFileName()
public final ObjectProperty<String> initialFileNameProperty()
public ObservableList<FileChooser.ExtensionFilter> getExtensionFilters()
public final ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty()
public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)
public final FileChooser.ExtensionFilter getSelectedExtensionFilter()
public File showOpenDialog(Window ownerWindow)
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.ownerWindow
- the owner window of the displayed file dialognull
if no file has been selectedpublic List<File> showOpenMultipleDialog(Window ownerWindow)
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.
ownerWindow
- the owner window of the displayed file dialognull
if no file has been selectedpublic File showSaveDialog(Window ownerWindow)
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.ownerWindow
- the owner window of the displayed file dialognull
if no file has been selectedCopyright © 2020. All rights reserved.