パッケージflash.net
クラスpublic final class FileFilter
継承FileFilter Inheritance Object

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

FileFilter クラスは、FileReference.browse() メソッド、FileReferenceList.browse() メソッド、または File オブジェクト、FileReference オブジェクト、FileReferenceList オブジェクトの browse メソッドを呼び出したときに表示されるファイル参照ダイアログボックスに、ユーザーのシステム上のどのファイルを表示するかを示すために使用します。 FileFilter インスタンスは、オプションの typeFilter パラメータの値としてメソッドに渡されます。 FileFilter インスタンスを使用する場合、FileFilter インスタンスに指定されていない拡張子およびファイルタイプは除外されます。つまり、ユーザーはそれらを選択できません。 FileFilter オブジェクトをメソッドに渡さないと、すべてのファイルがダイアログボックスに表示されます。

FileFilter インスタンスは次の 2 つの方法で使用できます。

これら 2 つの形式を browse メソッドの 1 回の呼び出しの中に混在させることはできません。 どちらか一方を使用する必要があります。

次の例のように、browse メソッドには 1 つ以上の FileFilter インスタンスを渡すことができます。

var imagesFilter:FileFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
 var docFilter:FileFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt");
 var myFileReference:FileReference = new FileReference();
 myFileReference.browse([imagesFilter, docFilter]);

AIR アプリケーションでは次のようになります。

var imagesFilter:FileFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
 var docFilter:FileFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt");
 var myFile:File = new File();
 myFile.browseForOpen("Open", [imagesFilter, docFilter]);

FileFilter.extension プロパティの拡張子リストを使用して、ファイル参照ダイアログに表示されるファイルをフィルタにかけます。このリストはダイアログボックスに実際に表示されるわけではありません。ファイルタイプをユーザーに表示するには、拡張子リストのほか、説明用ストリングにもファイルタイプをリストする必要があります。説明用ストリングは、Windows および Linux のダイアログボックスに表示されます。Macintosh® では使用されません。 Macintosh では、Macintosh ファイルタイプのリストを指定すると、このリストを使用してファイルがフィルタにかけられます。これを指定しない場合は、拡張子リストが使用されます。



パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  description : String
フィルタの説明用ストリングです。
FileFilter
  extension : String
ファイル拡張子のリストです。
FileFilter
  macType : String
Macintosh ファイルタイプのリストです。
FileFilter
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義元
  
FileFilter(description:String, extension:String, macType:String = null)
新しい FileFilter インスタンスを作成します。
FileFilter
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細
descriptionプロパティ
description:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

フィルタの説明用ストリングです。説明は、FileReference.browse() または FileReferenceList.browse() が呼び出されたときに開くダイアログボックスに表示されます。説明用ストリングには、"Images (*.gif, *.jpg, *.png)" などのストリングが含まれ、ユーザーにアップロードまたはダウンロード可能なファイルタイプを指示できます。FileReference オブジェクトでサポートされる実際のファイルタイプは extension プロパティに格納されます。



実装
    public function get description():String
    public function set description(value:String):void
extensionプロパティ 
extension:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

ファイル拡張子のリストです。このリストは、ファイル参照ダイアログボックスに表示するファイルの種類を示します(リストは表示されません。ユーザーには description プロパティの値のみが表示されます)。extension プロパティには、"*.jpg;*.gif;*.png" のように、セミコロンで区切ったファイル拡張子のリストが含まれ、各拡張子の前にはワイルドカード (*) を付けます。



実装
    public function get extension():String
    public function set extension(value:String):void
macTypeプロパティ 
macType:String  [読み書き可能]

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

Macintosh ファイルタイプのリストです。このリストは、ファイル参照ダイアログボックスに表示するファイルの種類を示します(このリスト自体は表示されません。ユーザーには description プロパティの値のみが表示されます)。macType プロパティには、"JPEG;jp2_;GIFF" のように、Macintosh ファイルタイプをセミコロンで区切ったリストが含まれます。



実装
    public function get macType():String
    public function set macType(value:String):void
コンストラクタの詳細
FileFilter()コンストラクタ
public function FileFilter(description:String, extension:String, macType:String = null)

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

新しい FileFilter インスタンスを作成します。

パラメータ
description:String — ユーザーがアップロードするファイルを選択するときに表示される説明用ストリングです。
 
extension:String — ユーザーがアップロードするファイルを選択するときに表示されるファイル形式を示すファイル拡張子のリストです。
 
macType:String (default = null) — ユーザーがアップロードするファイルを選択したときに表示されるファイルタイプを示す Macintosh ファイルタイプのリストです。値を指定しないと、このパラメータは null に設定されます。