Spec-Zone.ru › OpenJavaFX 8
javafx.stage

Класс FileChooser

java.lang.Object
  • javafx.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

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

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

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

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

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

    Конструкторы
    Конструктор и описание
    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(ExtensionFilter)

  • Подробное описание конструкторов

    • FileChooser

      public 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()
      Это свойство используется для предварительного выбора фильтра расширений для следующего отображаемого диалогового окна и для чтения выбранного пользователем фильтра расширений из закрытого диалогового окна.

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

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

      С версии:

      JavaFX 8.0

      См. также:

      getSelectedExtensionFilter(), setSelectedExtensionFilter(ExtensionFilter)

    • setSelectedExtensionFilter

      public final void setSelectedExtensionFilter(FileChooser.ExtensionFilter filter)
      Устанавливает значение свойства selectedExtensionFilter.

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

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

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

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

      С версии:

      JavaFX 8.0

    • getSelectedExtensionFilter

      public final FileChooser.ExtensionFilter getSelectedExtensionFilter()
      Получает значение свойства selectedExtensionFilter.

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

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

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

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

      С версии:

      JavaFX 8.0

    • 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