Spec-Zone.ru › OpenJavaFX 11
Модуль javafx.graphics
Пакет javafx.stage

Класс 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);
 }
    Since:
    JavaFX 2.0

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

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

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

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

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

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

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

    • 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(FileChooser.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