Класс FileChooser

java.lang.Object

fx.stage.FileChooser

public final class FileChooser
extends Object

Обеспечивает поддержку стандартных диалоговых окон для выбора файлов на платформе. Эти диалоговые окна имеют вид и поведение компонентов пользовательского интерфейса платформы, независимого от JavaFX.

На некоторых платформах, где доступ к файлам может быть ограничен или не входит в модель пользователя (например, на некоторых мобильных или встроенных устройствах), открытие диалогового окна для выбора файла может всегда быть бесполезным (то есть возвращаются нулевые файлы).

Класс FileChooser можно использовать для вызова диалоговых окон для открытия одного файла (showOpenDialog), диалоговых окон для выбора нескольких файлов (showOpenMultipleDialog) и диалоговых окон для сохранения файлов (showSaveDialog). Настройка отображаемого диалогового окна контролируется значениями свойств FileChooser, заданных перед вызовом соответствующего метода show*Dialog. Эта настройка включает в себя заголовок диалогового окна, начальную папку, отображаемую в диалоговом окне, и фильтр(ы) расширений для перечисленных файлов. Для свойств конфигурации, значения которых не были явно заданы, отображаемое диалоговое окно использует значения по умолчанию платформы. Вызов метода отображения диалогового окна блокируется до тех пор, пока пользователь не выберет файл или не отменит диалоговое окно. Значение возвращаемого значения указывает выбранный(ые) файл(ы) или равно null, если диалоговое окно было отменено.

Пример:


 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

Краткое описание свойств

Свойства
Тип	Свойство	Описание
`ObjectProperty<File>`	`initialDirectory`	Начальный каталог для отображаемого диалогового окна выбора файла.
`ObjectProperty<String>`	`initialFileName`	Начальное имя файла для отображаемого диалогового окна.
`ObjectProperty<FileChooser.ExtensionFilter>`	`selectedExtensionFilter`	Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалогового окна и для считывания выбранного пользователем фильтра расширений из закрытого диалогового окна.
`StringProperty`	`title`	Заголовок отображаемого диалогового окна выбора файла.

Краткое описание вложенных классов

Вложенные классы
Модификатор и тип	Класс	Описание
`static class`	`FileChooser.ExtensionFilter`	Определяет фильтр расширений, используемый для фильтрации файлов, которые могут быть выбраны в диалоговом окне выбора файла на основе расширений имен файлов.

Краткое описание конструкторов

Конструкторы
Конструктор	Описание
`FileChooser()`	Создаёт FileChooser.

Краткое описание методов

Модификатор и тип	Метод	Описание
`ObservableList<FileChooser.ExtensionFilter>`	`getExtensionFilters()`	Возвращает фильтры расширений, используемые в отображаемом диалоговом окне выбора файла.
`File`	`getInitialDirectory()`	Возвращает значение свойства initialDirectory.
`String`	`getInitialFileName()`	Возвращает значение свойства initialFileName.
`FileChooser.ExtensionFilter`	`getSelectedExtensionFilter()`	Возвращает значение свойства selectedExtensionFilter.
`String`	`getTitle()`	Возвращает значение свойства title.
`ObjectProperty<File>`	`initialDirectoryProperty()`	Начальный каталог для отображаемого диалогового окна выбора файла.
`ObjectProperty<String>`	`initialFileNameProperty()`	Начальное имя файла для отображаемого диалогового окна.
`ObjectProperty<FileChooser.ExtensionFilter>`	`selectedExtensionFilterProperty()`	Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалогового окна и для считывания выбранного пользователем фильтра расширений из закрытого диалогового окна.
`void`	`setInitialDirectory(File value)`	Устанавливает значение свойства initialDirectory.
`void`	`setInitialFileName(String value)`	Устанавливает значение свойства initialFileName.
`void`	`setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)`	Устанавливает значение свойства selectedExtensionFilter.
`void`	`setTitle(String value)`	Устанавливает значение свойства title.
`File`	`showOpenDialog(Window ownerWindow)`	Отображает новое диалоговое окно открытия файла.
`List<File>`	`showOpenMultipleDialog(Window ownerWindow)`	Отображает новое диалоговое окно открытия файла, в котором можно выбрать несколько файлов.
`File`	`showSaveDialog(Window ownerWindow)`	Отображает новое диалоговое окно сохранения файла.
`StringProperty`	`titleProperty()`	Заголовок отображаемого диалогового окна выбора файла.

Методы, объявленные в классе java.lang.Object

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

Подробности свойств

title

public final StringProperty titleProperty

Заголовок отображаемого диалога выбора файла.

См. также:: getTitle(), setTitle(String)

initialDirectory

public final ObjectProperty<File> initialDirectoryProperty

Начальный каталог для отображаемого диалога выбора файла.

См. также:: getInitialDirectory(), setInitialDirectory(File)

initialFileName

public final ObjectProperty<String> initialFileNameProperty

Начальное имя файла для отображаемого диалога.

Это свойство в основном используется в отображаемых диалогах сохранения файла в качестве начального имени файла, который необходимо сохранить. Если оно задано для диалога открытия файла, оно будет влиять на отображаемый диалог только в том случае, если соответствующая платформа поддерживает такое свойство в своих диалогах открытия файла.

С момента:: JavaFX 2.2.40
См. также:: getInitialFileName(), setInitialFileName(String)

selectedExtensionFilter

public final ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty

Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалога и для чтения выбранного пользователем фильтра расширений из закрытого диалога.

При отображении диалога выбора файла будет проверен selectedExtensionFilter. Если значение selectedExtensionFilter равно null или не содержится в списке фильтров расширений, вместо него будет выбран первый фильтр расширений в списке фильтров расширений. В противном случае будет активирован указанный selectedExtensionFilter.

После закрытия диалога значение этого свойства обновляется для соответствия выбранному пользователем фильтру расширений из диалога.

С момента:: JavaFX 8.0
См. также:: getSelectedExtensionFilter(), setSelectedExtensionFilter(FileChooser.ExtensionFilter)

Подробности конструкторов

FileChooser

public FileChooser()

Создаёт FileChooser.

Подробности методов

setTitle

public final void setTitle(String value)

Устанавливает значение свойства title.

Описание свойства:: Заголовок отображаемого диалога выбора файла.

getTitle

public final String getTitle()

Получает значение свойства title.

Описание свойства:: Заголовок отображаемого диалога выбора файла.

titleProperty

public final StringProperty titleProperty()

Заголовок отображаемого диалога выбора файла.

См. также:: getTitle(), setTitle(String)

setInitialDirectory

public final void setInitialDirectory(File value)

Устанавливает значение свойства initialDirectory.

Описание свойства:: Начальный каталог для отображаемого диалога выбора файла.

getInitialDirectory

public final File getInitialDirectory()

Получает значение свойства initialDirectory.

Описание свойства:: Начальный каталог для отображаемого диалога выбора файла.

initialDirectoryProperty

public final ObjectProperty<File> initialDirectoryProperty()

Начальный каталог для отображаемого диалога выбора файла.

См. также:: getInitialDirectory(), setInitialDirectory(File)

setInitialFileName

public final void setInitialFileName(String value)

Устанавливает значение свойства initialFileName.

Описание свойства:: Начальное имя файла для отображаемого диалога.
Это свойство в основном используется в отображаемых диалогах сохранения файла в качестве начального имени файла, который необходимо сохранить. Если оно задано для диалога открытия файла, оно будет влиять на отображаемый диалог только в том случае, если соответствующая платформа поддерживает такое свойство в своих диалогах открытия файла.
С момента:: JavaFX 2.2.40

getInitialFileName

public final String getInitialFileName()

Получает значение свойства initialFileName.

Описание свойства:: Начальное имя файла для отображаемого диалога.
Это свойство в основном используется в отображаемых диалогах сохранения файла в качестве начального имени файла, который необходимо сохранить. Если оно задано для диалога открытия файла, оно будет влиять на отображаемый диалог только в том случае, если соответствующая платформа поддерживает такое свойство в своих диалогах открытия файла.
С момента:: JavaFX 2.2.40

initialFileNameProperty

public final ObjectProperty<String> initialFileNameProperty()

Начальное имя файла для отображаемого диалога.

С момента:: JavaFX 2.2.40
См. также:: getInitialFileName(), setInitialFileName(String)

getExtensionFilters

public ObservableList<FileChooser.ExtensionFilter> getExtensionFilters()

Получает фильтры расширений, используемые в отображаемом диалоге выбора файла. Только один фильтр расширений из списка активен в отображаемом диалоге в любой момент времени, и только файлы, соответствующие этому фильтру расширений, отображаются. Первый фильтр расширений из списка активируется при вызове диалога. Затем пользователь может переключить активный фильтр расширений на любой другой фильтр расширений из списка и таким образом управлять набором отображаемых файлов.

Возвращает:: Наблюдаемый список фильтров расширений, используемых в этом диалоге

selectedExtensionFilterProperty

public final ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty()

С момента:: JavaFX 8.0
См. также:: getSelectedExtensionFilter(), setSelectedExtensionFilter(FileChooser.ExtensionFilter)

setSelectedExtensionFilter

public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)

Устанавливает значение свойства selectedExtensionFilter.

Описание свойства:

С момента:

JavaFX 8.0

getSelectedExtensionFilter

public final FileChooser.ExtensionFilter getSelectedExtensionFilter()

Получает значение свойства selectedExtensionFilter.

Описание свойства:

С момента:

JavaFX 8.0

showOpenDialog

public File showOpenDialog(Window ownerWindow)

Отображает новый диалог выбора файла. Метод не возвращается, пока отображаемый диалог выбора файла не будет закрыт. Возвращаемое значение указывает файл, выбранный пользователем, или null, если выбор не был сделан. Если для диалога выбора файла задано окно владельца, ввод во всех окнах в цепочке владельцев диалога блокируется, пока диалог выбора файла отображается.

Параметры:: ownerWindow - окно владельца отображаемого диалога выбора файла
Возвращает:: выбранный файл или null, если файл не был выбран

Открытие нескольких файлов

public List<File> showOpenMultipleDialog(Window ownerWindow)

Отображает диалог открытия файлов, в котором можно выбрать несколько файлов. Метод не возвращает значение, пока не будет закрыт отображаемый диалог открытия. Возвращаемое значение указывает выбранные пользователем файлы или null, если выбор не был сделан. Если для диалога открытия файлов задано окно-владелец, ввод во все окна в цепочке владельцев диалога блокируется во время отображения диалога.

Возвращаемый список является неизменяемым и будет вызывать UnsupportedOperationException при каждой попытке изменения.

Параметры:: ownerWindow - окно-владелец отображаемого диалога открытия файлов
Возвращает:: выбранные файлы или null, если файл не был выбран

Сохранение файла

public File showSaveDialog(Window ownerWindow)

Отображает диалог сохранения файла. Метод не возвращает значение, пока не будет закрыт отображаемый диалог сохранения файла. Возвращаемое значение указывает выбранный пользователем файл или null, если выбор не был сделан. Если для диалога открытия файлов задано окно-владелец, ввод во все окна в цепочке владельцев диалога блокируется во время отображения диалога.

Параметры:: ownerWindow - окно-владелец отображаемого диалога сохранения файла
Возвращает:: выбранный файл или null, если файл не был выбран

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.