モジュール java.desktop
パッケージ java.awt

クラスFileDialog

  • すべての実装されたインタフェース:
    ImageObserver, MenuContainer, Serializable, Accessible

    public class FileDialog
extends Dialog
    FileDialogクラスは、ユーザーがファイルを選択できるダイアログ・ウィンドウを表示します。

    このダイアログはモーダルであるため、アプリケーションがそのshowメソッドを呼び出してこのダイアログを表示すると、ユーザーがファイルを選択するまでアプリケーションのほかの部分は使用できません。

    導入されたバージョン:
    1.0
    関連項目:
    Window.show(), 直列化された形式

    • フィールドの詳細

      • LOAD

        public static final int LOAD
        この定数値は、ファイル・ダイアログ・ウィンドウの目的が読込み用ファイルの検索であることを示します。
        関連項目:
        定数フィールド値

      • SAVE

        public static final int SAVE
        この定数値は、ファイル・ダイアログ・ウィンドウの目的が書込み用ファイルの検索であることを示します。
        関連項目:
        定数フィールド値

    • コンストラクタの詳細

      • FileDialog

        public FileDialog​(Frame parent)
        ファイルをロードするためのファイル・ダイアログを生成します。 ファイル・ダイアログのタイトルは最初は空です。 これはFileDialog(parent, "", LOAD)の簡易メソッドです。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        導入されたバージョン:
        1.1

      • FileDialog

        public FileDialog​(Frame parent,
                  String title)
        指定されたタイトルを使用して、ファイルをロードするためのファイル・ダイアログ・ウィンドウを生成します。 現在のディレクトリのファイルが表示されます。 これはFileDialog(parent, title, LOAD)の簡易メソッドです。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        title - ダイアログのタイトル

      • FileDialog

        public FileDialog​(Frame parent,
                  String title,
                  int mode)
        指定されたタイトルを使用して、ファイルをロードまたは保存するためのファイル・ダイアログ・ウィンドウを生成します。

        modeの値がLOADである場合、ファイル・ダイアログは読み取るファイルを検索し、表示されるファイルは現在のディレクトリ内のファイルです。 modeの値がSAVEである場合、ファイル・ダイアログはファイルを書き込む場所を検索します。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        title - ダイアログのタイトル
        mode - ダイアログのモードであり、FileDialog.LOADまたはFileDialog.SAVEのどちらか
        例外:
        IllegalArgumentException - 不正なファイル・ダイアログのモードが指定された場合
        関連項目:
        LOAD, SAVE

      • FileDialog

        public FileDialog​(Dialog parent)
        ファイルをロードするためのファイル・ダイアログを生成します。 ファイル・ダイアログのタイトルは最初は空です。 これはFileDialog(parent, "", LOAD)の簡易メソッドです。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        例外:
        IllegalArgumentException - parentのGraphicsConfigurationが画面デバイスのものでない場合
        IllegalArgumentException - parentがnullである場合。GraphicsEnvironment.isHeadlessがtrueを返した場合は、この例外が常にスローされる
        導入されたバージョン:
        1.5
        関連項目:
        GraphicsEnvironment.isHeadless()

      • FileDialog

        public FileDialog​(Dialog parent,
                  String title)
        指定されたタイトルを使用して、ファイルをロードするためのファイル・ダイアログ・ウィンドウを生成します。 現在のディレクトリのファイルが表示されます。 これはFileDialog(parent, title, LOAD)の簡易メソッドです。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        title - ダイアログのタイトル。null値は、NullPointerExceptionがスローされることなく受け入れられる
        例外:
        IllegalArgumentException - parentのGraphicsConfigurationが画面デバイスのものでない場合
        IllegalArgumentException - parentがnullである場合。GraphicsEnvironment.isHeadlessがtrueを返した場合は、この例外が常にスローされる
        導入されたバージョン:
        1.5
        関連項目:
        GraphicsEnvironment.isHeadless()

      • FileDialog

        public FileDialog​(Dialog parent,
                  String title,
                  int mode)
        指定されたタイトルを使用して、ファイルをロードまたは保存するためのファイル・ダイアログ・ウィンドウを生成します。

        modeの値がLOADである場合、ファイル・ダイアログは読み取るファイルを検索し、表示されるファイルは現在のディレクトリ内のファイルです。 modeの値がSAVEである場合、ファイル・ダイアログはファイルを書き込む場所を検索します。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        パラメータ:
        parent - ダイアログの所有者
        title - ダイアログのタイトル。null値は、NullPointerExceptionがスローされることなく受け入れられる
        mode - ダイアログのモードであり、FileDialog.LOADまたはFileDialog.SAVEのどちらか
        例外:
        IllegalArgumentException - 不正なファイル・ダイアログのモードが指定された場合
        IllegalArgumentException - parentのGraphicsConfigurationが画面デバイスのものでない場合
        IllegalArgumentException - parentがnullである場合。GraphicsEnvironment.isHeadlessがtrueを返した場合は、この例外が常にスローされる
        導入されたバージョン:
        1.5
        関連項目:
        GraphicsEnvironment.isHeadless(), LOAD, SAVE

    • メソッドの詳細

      • setTitle

        public void setTitle​(String title)
        Dialogのタイトルを設定します。

        ノート: 一部のプラットフォームでは、ファイル・ダイアログでユーザー指定のタイトルを表示できない場合があります。 この状況では、タイトルはファイル・ダイアログ・タイトル・バーに表示されないか、または一部のシステムではファイル・ダイアログ・タイトル・バーが表示されません。

        オーバーライド:
        クラスDialogのsetTitle
        パラメータ:
        title - ダイアログのボーダーに表示されるタイトル。nullの場合、空のタイトルが表示される
        関連項目:
        Dialog.getTitle()

      • addNotify

        public void addNotify​()
        ファイル・ダイアログのピアを作成します。 ファイル・ダイアログの機能を変更せずに、その外観の変更を可能にします。
        オーバーライド:
        addNotify、クラス: Dialog
        関連項目:
        Component.isDisplayable(), Window.removeNotify()

      • getMode

        public int getMode​()
        このファイル・ダイアログ・ボックスがファイルからロードするためのものか、ファイルに保存するためのものかを示します。
        戻り値:
        このファイル・ダイアログ・ウィンドウのモード。FileDialog.LOADまたはFileDialog.SAVE
        関連項目:
        LOAD, SAVE, setMode(int)

      • setMode

        public void setMode​(int mode)
        ファイル・ダイアログのモードを設定します。 modeが不当な値の場合は例外がスローされ、modeは設定されません。
        パラメータ:
        mode - このファイル・ダイアログのモード。FileDialog.LOADまたはFileDialog.SAVE
        例外:
        IllegalArgumentException - 不正なファイル・ダイアログのモードが指定された場合
        導入されたバージョン:
        1.1
        関連項目:
        LOAD, SAVE, getMode()

      • getDirectory

        public String getDirectory​()
        このファイル・ダイアログのディレクトリを取得します。
        戻り値:
        このFileDialogのディレクトリ。nullの場合や無効なディレクトリの場合もある
        関連項目:
        setDirectory(java.lang.String)

      • setDirectory

        public void setDirectory​(String dir)
        このファイル・ダイアログ・ウィンドウのディレクトリを指定されたディレクトリに設定します。 nullまたは無効なディレクトリを指定すると、実装で定義されているデフォルトに設定されます。 ただし、このデフォルトはユーザーがファイルを選択したときに設定されます。 そのときまでは、getDirectory()はこのメソッドに渡された値を返します。

        ディレクトリとして""を指定すると、nullに設定されます。

        パラメータ:
        dir - 指定されたディレクトリ
        関連項目:
        getDirectory()

      • getFile

        public String getFile​()
        このファイル・ダイアログの選択されているファイルを取得します。 CANCELを選択するとnullが返されます。
        戻り値:
        このファイル・ダイアログ・ウィンドウの現在選択されているファイル。ファイルが選択されていない場合はnull
        関連項目:
        setFile(java.lang.String)

      • getFiles

        public File[] getFiles​()
        ユーザーが選択するファイルを返します。

        ユーザーがファイル・ダイアログを取り消した場合、このメソッドは空の配列を返します。

        戻り値:
        ユーザーが選択したファイル。ユーザーがファイル・ダイアログを取り消した場合は空の配列。
        導入されたバージョン:
        1.7
        関連項目:
        setFile(String), getFile()

      • setFile

        public void setFile​(String file)
        このファイル・ダイアログ・ウィンドウの選択されているファイルを、指定されたファイルに設定します。 このファイルは、ファイル・ダイアログ・ウィンドウが最初に表示される前に設定されている場合はデフォルト・ファイルになります。

        ダイアログを表示したときに、指定されたファイルが選択されます。 選択の種類は、ファイルの有無、ダイアログ型およびネイティブ・プラットフォームによって異なります。 たとえば、ファイル・リスト内でファイルが強調表示されたり、ファイル名の編集ボックスにファイル名が設定されたりします。

        このメソッドはファイルのフル・パスを受け入れます。setDirectoryメソッドを組み合わせて使用した場合は、拡張子付きのファイル名を受け入れます。

        ファイルとして""を指定すると、nullに設定されます。

        パラメータ:
        file - 設定されるファイル
        関連項目:
        getFile(), getFiles()

      • setMultipleMode

        public void setMultipleMode​(boolean enable)
        ファイル・ダイアログでの複数ファイル選択を有効または無効にします。
        パラメータ:
        enable - trueの場合は複数ファイル選択が有効、falseの場合は無効。
        導入されたバージョン:
        1.7
        関連項目:
        isMultipleMode()

      • isMultipleMode

        public boolean isMultipleMode​()
        ファイル・ダイアログで複数ファイル選択が許可されるかどうかを返します。
        戻り値:
        ファイル・ダイアログで複数ファイル選択が許可される場合はtrue、そうでない場合はfalse。
        導入されたバージョン:
        1.7
        関連項目:
        setMultipleMode(boolean)

      • getFilenameFilter

        public FilenameFilter getFilenameFilter​()
        このファイル・ダイアログのファイル名フィルタを調べます。 ファイル名フィルタを使用すると、ユーザーはファイル・ダイアログに表示されるファイルを指定できます。 ファイル名フィルタは、Microsoft Windows用のSunの参照実装では機能しません。
        戻り値:
        このファイル・ダイアログのファイル名フィルタ
        関連項目:
        FilenameFilter, setFilenameFilter(java.io.FilenameFilter)

      • setFilenameFilter

        public void setFilenameFilter​(FilenameFilter filter)
        ファイル・ダイアログ・ウィンドウのファイル名フィルタを指定されたフィルタに設定します。 ファイル名フィルタは、Microsoft Windows用のSunの参照実装では機能しません。
        パラメータ:
        filter - 指定されたフィルタ
        関連項目:
        FilenameFilter, getFilenameFilter()

      • paramString

        protected String paramString​()
        このFileDialogウィンドウの状態を表す文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる場合があります。 返される文字列は空の場合がありますが、nullにはなりません。
        オーバーライド:
        paramString、クラス: Dialog
        戻り値:
        このファイル・ダイアログ・ウィンドウのパラメータ文字列