Spec-Zone.ru › OpenJavaFX 24

Класс FileChooser

java.lang.Object
javafx.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);
 }
С:
JavaFX 2.0

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

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

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

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

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

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

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

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

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

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

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

title

public final StringProperty titleProperty
Название отображаемого диалога файла.
См. также:
  • getTitle()
  • setTitle(String)
  • titleProperty()

initialDirectory

public final ObjectProperty<File> initialDirectoryProperty
Начальный каталог для отображаемого диалога файла.
См. также:
  • getInitialDirectory()
  • setInitialDirectory(File)
  • initialDirectoryProperty()

initialFileName

public final ObjectProperty<String> initialFileNameProperty
Начальное имя файла для отображаемого диалога.

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

С:
JavaFX 2.2.40
См. также:
  • getInitialFileName()
  • setInitialFileName(String)
  • initialFileNameProperty()

selectedExtensionFilter

public final ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty
Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалога и для чтения выбранного пользователем фильтра расширений из закрытого диалога.

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

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

С:
JavaFX 8.0
См. также:
  • getSelectedExtensionFilter()
  • setSelectedExtensionFilter(FileChooser.ExtensionFilter)
  • selectedExtensionFilterProperty()

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

FileChooser

public FileChooser()
Создаёт FileChooser.

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

setTitle

public final void setTitle(String value)
Устанавливает значение свойства title.
Описание свойства:
Название отображаемого диалога файла.
Параметры:
value - значение для свойства title
См. также:
  • getTitle()
  • titleProperty()

getTitle

public final String getTitle()
Получает значение свойства title.
Описание свойства:
Название отображаемого диалога файла.
Возвращает:
значение свойства title
См. также:
  • setTitle(String)
  • titleProperty()

titleProperty

public final StringProperty titleProperty()
Название отображаемого диалога файла.
Возвращает:
свойство title
См. также:
  • getTitle()
  • setTitle(String)

setInitialDirectory

public final void setInitialDirectory(File value)
Устанавливает значение свойства initialDirectory.
Описание свойства:
Начальный каталог для отображаемого диалога файла.
Параметры:
value - значение для свойства initialDirectory
См. также:
  • getInitialDirectory()
  • initialDirectoryProperty()

getInitialDirectory

public final File getInitialDirectory()
Получает значение свойства initialDirectory.
Описание свойства:
Начальный каталог для отображаемого диалога файла.
Возвращает:
значение свойства initialDirectory
См. также:
  • setInitialDirectory(File)
  • initialDirectoryProperty()

initialDirectoryProperty

public final ObjectProperty<File> initialDirectoryProperty()
Начальный каталог для отображаемого диалога файла.
Возвращает:
свойство initialDirectory
См. также:
  • getInitialDirectory()
  • setInitialDirectory(File)

setInitialFileName

public final void setInitialFileName(String value)
Устанавливает значение свойства initialFileName.
Описание свойства:
Начальное имя файла для отображаемого диалога.

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

Параметры:
value - значение для свойства initialFileName
С:
JavaFX 2.2.40
См. также:
  • getInitialFileName()
  • initialFileNameProperty()

getInitialFileName

public final String getInitialFileName()
Получает значение свойства initialFileName.
Описание свойства:
Начальное имя файла для отображаемого диалога.

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

Возвращает:
значение свойства initialFileName
С:
JavaFX 2.2.40
См. также:
  • setInitialFileName(String)
  • initialFileNameProperty()

initialFileNameProperty

public final ObjectProperty<String> initialFileNameProperty()
Начальное имя файла для отображаемого диалога.

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

Возвращает:
свойство initialFileName
С:
JavaFX 2.2.40
См. также:
  • getInitialFileName()
  • setInitialFileName(String)

getExtensionFilters

public ObservableList<FileChooser.ExtensionFilter> getExtensionFilters()
Получает фильтры расширений, используемые в отображаемом диалоге файла. Только один фильтр расширений из списка активен в любое время в отображаемом диалоге, и только файлы, соответствующие этому фильтру расширений, отображаются. Первый фильтр расширений из списка активируется при вызове диалога. Затем пользователь может переключить активный фильтр расширений на любой другой фильтр расширений из списка и таким образом управлять набором отображаемых файлов.
Возвращает:
Наблюдаемый список фильтров расширений, используемых в этом диалоге

Свойство выбранного фильтра расширений

public final ObjectProperty<FileChooser.ExtensionFilter> selectedExtensionFilterProperty()
Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалога и для чтения выбранного пользователем фильтра расширений из закрытого диалога.

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

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

Возвращает:
свойство selectedExtensionFilter
С:
JavaFX 8.0
См. также:
  • getSelectedExtensionFilter()
  • setSelectedExtensionFilter(FileChooser.ExtensionFilter)

Установить выбранный фильтр расширений

public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)
Устанавливает значение свойства selectedExtensionFilter.
Описание свойства:
Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалога и для чтения выбранного пользователем фильтра расширений из закрытого диалога.

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

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

Параметры:
filter - значение для свойства selectedExtensionFilter
С:
JavaFX 8.0
См. также:
  • getSelectedExtensionFilter()
  • selectedExtensionFilterProperty()

Получить выбранный фильтр расширений

public final FileChooser.ExtensionFilter getSelectedExtensionFilter()
Получает значение свойства selectedExtensionFilter.
Описание свойства:
Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалога и для чтения выбранного пользователем фильтра расширений из закрытого диалога.

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

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

Возвращает:
значение свойства selectedExtensionFilter
С:
JavaFX 8.0
См. также:
  • setSelectedExtensionFilter(FileChooser.ExtensionFilter)
  • selectedExtensionFilterProperty()

Показать диалог открытия файла

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 и/или его аффилированные лица. Все права защищены.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API