javafx.stage

Class FileChooser

java.lang.Object

javafx.stage.FileChooser

public final class FileChooser
extends java.lang.Object

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

Property Summary

Properties

Type	Property and Description
ObjectProperty<java.io.File>	initialDirectory The initial directory for the displayed file 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.

Constructor Summary

Constructors

Constructor and Description
FileChooser()

Method Summary

Methods

Modifier and Type	Method and Description
ObservableList<FileChooser.ExtensionFilter>	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	getTitle() Gets the value of the property title.
ObjectProperty<java.io.File>	initialDirectoryProperty() The initial directory for the displayed file dialog.
void	setInitialDirectory(java.io.File value) Sets the value of the property initialDirectory.
void	setTitle(java.lang.String value) Sets the value of the property title.
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 ObjectProperty<java.io.File> initialDirectoryProperty

The initial directory for the displayed file dialog.

See Also:

getInitialDirectory(), setInitialDirectory(File)

Constructor Detail

FileChooser

public FileChooser()

Method Detail

setTitle

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

Sets the value of the property title.

Property description:

The title of the displayed file dialog.

getTitle

public final java.lang.String getTitle()

Gets the value of the property title.

Property description:

The title of the displayed file dialog.

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.

Property description:

The initial directory for the displayed file dialog.

getInitialDirectory

public final java.io.File getInitialDirectory()

Gets the value of the property initialDirectory.

Property description:

The initial directory for the displayed file dialog.

initialDirectoryProperty

public final ObjectProperty<java.io.File> initialDirectoryProperty()

The initial directory for the displayed file dialog.

See Also:

getInitialDirectory(), setInitialDirectory(File)

getExtensionFilters

public ObservableList<FileChooser.ExtensionFilter> getExtensionFilters()

Gets the extension filters used in the displayed file dialog.

Returns:

An observable list of the extension filters used in this dialog

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