Spec-Zone.ru › OpenJavaFX 21

Класс FileChooser

java.lang.Object
fx.stage.FileChooser
public final class FileChooser extends Object
Обеспечивает поддержку стандартных диалоговых окон выбора файла для платформ. Эти диалоговые окна имеют вид и ощущения компонентов пользовательского интерфейса платформы, которые независимы от JavaFX.

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

Объект 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

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

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

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

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

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

Конструктор Описание
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()
Получает фильтры расширений, используемые в отображаемом диалоге выбора файла. Только один фильтр расширений из списка активен в любом отображаемом диалоге, и отображаются только файлы, соответствующие этому фильтру расширений. Первый фильтр расширений в списке активируется при вызове диалога. Затем пользователь может переключить активный фильтр расширений на любой другой фильтр из списка и таким образом управлять набором отображаемых файлов.
Возвращает:
Наблюдаемый список фильтров расширений, используемых в этом диалоге

selectedExtensionFilterProperty

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

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

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

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

setSelectedExtensionFilter

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

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

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

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

getSelectedExtensionFilter

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

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

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

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

showOpenDialog

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

showOpenMultipleDialog

public List<File> showOpenMultipleDialog(Window ownerWindow)
Отображает новый диалог выбора файла, в котором можно выбрать несколько файлов. Метод не возвращает значение, пока отображаемый диалог выбора файла не будет закрыт. Возвращаемое значение указывает файлы, выбранные пользователем, или null, если выбор не был сделан. Если для диалога выбора файла задано окно-владелец, вход во все окна в цепочке владельцев диалога блокируется, пока диалог выбора файла отображается.

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

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

showSaveDialog

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.

Spec-Zone.ru

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