モジュール javafx.graphics
パッケージ javafx.stage

クラスFileChooser


  • public final class FileChooser
extends Object
    標準のプラットフォーム・ファイル・ダイアログのサポートを提供します。 これらのダイアログは、JavaFXに関係のないプラットフォームUIコンポーネントのルック・アンド・フィールを持ちます。

    一部のプラットフォームでは、ファイル・アクセスが制限されていたり、ファイル・アクセスがユーザー・モデルに含まれていないことありますが(たとえば、一部のモバイル・デバイス、組込みデバイスなど)、この場合はファイル・ダイアログを開くと常に操作なし(つまり、nullファイルが返される)という結果になることがあります。

    FileChooserを使用して、単一のファイルを選択するためのファイル・オープン・ダイアログを呼び出したり(showOpenDialog)、複数のファイルを選択するためのファイル・オープン・ダイアログを呼び出したり(showOpenMultipleDialog)、ファイル保存ダイアログを呼び出すことができます(showSaveDialog)。 表示されるダイアログの構成は、対応するshow*Dialogメソッドが呼び出される前に設定されたFileChooserプロパティの値によって制御されます。 この構成には、ダイアログのタイトル、ダイアログに表示される初期ディレクトリ、一覧表示されるファイルの拡張子フィルタ(1つまたは複数)が含まれます。 構成プロパティの値が明示的に設定されていない場合、表示されるダイアログではプラットフォームのデフォルト値が使用されます。 ダイアログ表示メソッドの呼出しは、ユーザーが選択を行うか、ダイアログを閉じるまでブロックされます。 戻り値は、選択したディレクトリを指定するか、またはダイアログが取り消された場合は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

    • プロパティの詳細

      • 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の値を取得します。
        プロパティの説明:
        表示されたファイル・ダイアログのタイトル。

      • setInitialDirectory

        public final void setInitialDirectory​(File value)
        プロパティinitialDirectoryの値を設定します。
        プロパティの説明:
        表示されたファイル・ダイアログの初期ディレクトリ。

      • getInitialDirectory

        public final File getInitialDirectory​()
        プロパティinitialDirectoryの値を取得します。
        プロパティの説明:
        表示されたファイル・ダイアログの初期ディレクトリ。

      • 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​()
        表示されるファイル・ダイアログに使用されている拡張子フィルタを取得します。 表示されるダイアログでは、常にリスト内の1つの拡張子フィルタのみがアクティブになり、この拡張子フィルタに一致するファイルのみが表示されます。 ダイアログが呼び出されると、リストの最初の拡張子フィルタがアクティブ化されます。 その後、ユーザーは、アクティブな拡張子フィルタをリストの他の拡張子フィルタに切り替えることができ、このようにして表示されるファイル・セットを制御できます。
        戻り値:
        このダイアログで使用される拡張子フィルタの監視可能リスト

      • 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