Packagejp.progression.commands.net
Classpublic class DownloadFileRef
InheritanceDownloadFileRef Inheritance LoadCommand Inheritance Command Inheritance flash.events.EventDispatcher

DownloadFileRef クラスは、リモートサーバーからファイルをダウンロードするためのコマンドクラスです。


Example
  // DownloadFileRef インスタンスを作成する
  var com:DownloadFileRef = new DownloadFileRef();
  
  // コマンドを実行する
  com.execute();
  



Public Properties
 PropertyDefined by
 Inheritedbytes : ByteArray
読み込まれたデータを ByteArray 形式で取得します。
LoadCommand
 InheritedbytesLoaded : uint
コマンドの読み込み済みのバイト数です。 The number of bytes that are loaded for the command.
LoadCommand
 InheritedbytesTotal : uint
コマンド全体の圧縮後のバイト数です。 The number of compressed bytes in the entire command.
LoadCommand
  cacheAsResource : Boolean
DownloadFileRef
 InheritedcatchError : Function
コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。
Command
 InheritedclassName : String
インスタンスのクラス名を取得します。 Indicates the instance className of the Command.
Command
  data : *
DownloadFileRef
 InheriteddefaultCacheAsResource : Boolean
[static] cacheAsResource プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
LoadCommand
  defaultFileName : String
ダウンロードするファイルとしてダイアログボックスに表示するデフォルトファイル名です。 コマンド実行中に値を変更しても、処理に対して反映されません。 The default filename displayed in the dialog box for the file to be downloaded.
DownloadFileRef
 InheriteddefaultInterruptType : int
[static] interruptType プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 InheriteddefaultPreventCache : Boolean
[static] preventCache プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
LoadCommand
 InheriteddefaultTimeout : Number
[static] timeout プロパティの初期値を取得または設定します。 すでに生成済みのコマンドに対しては適用されません。
Command
 Inheriteddelay : Number
コマンドが実際に実行されるまでの遅延時間を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 Inheriteddepth : int
コマンドツリー構造上での自身の深度を取得します。
Command
 Inheritedextra : Object
コマンドの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。 このコマンドが親の CommandList インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。
Command
 Inheritedfactor : Number
percent プロパティの算出時の自身の重要性を取得または設定します。
LoadCommand
  fileReference : FileReference
ユーザーのコンピュータとサーバーとの通信に使用する FileReference インスタンスを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
DownloadFileRef
 Inheritedgroup : String
インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Command.
Command
 Inheritedid : String
インスタンスを表すユニークな識別子を取得または設定します。
Command
 InheritedinterruptType : int
中断処理時の処理方法を取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。
Command
 InheritedlatestData : *
自身から見て最後に関連付けられた読み込みデータを取得または設定します。 このコマンドインスタンスが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。
LoadCommand
 Inheritedloaded : uint
登録されている ILoadable を実装したインスタンスの内、すでに読み込み処理が完了した数を取得します。
LoadCommand
 Inheritedname : String
インスタンスの名前を取得または設定します。 Indicates the instance name of the Command.
Command
 Inheritednext : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、次に位置する Command インスタンスを取得します。
Command
 InheritedonComplete : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonError : Function
コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonInterrupt : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 InheritedonProgress : Function
コマンドオブジェクトが ProgressEvent.PROGRESS イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
LoadCommand
 InheritedonStart : Function
コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。
Command
 Inheritedparent : CommandList
この Command オブジェクトを含む CommandList オブジェクトを示します。 Indicates the CommandList object that contains this Command object.
Command
 Inheritedpercent : Number
loaded プロパティと total プロパティから算出される読み込み状態をパーセントで取得します。
LoadCommand
  preventCache : Boolean
DownloadFileRef
 Inheritedprevious : Command
このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。
Command
 Inheritedrequest : URLRequest
リクエストされる URL です。 コマンド実行中に値を変更しても、処理に対して反映されません。 The URL to be requested.
LoadCommand
 InheritedresGroup : String
読み込んだデータを Resource として登録する際に使用したいグループ名を取得または設定します。
LoadCommand
 InheritedresId : String
読み込んだデータを Resource として登録する際に使用したい識別子を取得または設定します。 cacheAsResource プロパティが true で、かつこの値が設定されていなければ、自動的に URL を識別子として登録します。
LoadCommand
 Inheritedroot : Command
コマンドツリー構造の一番上に位置する Command インスタンスを取得します。
Command
 Inheritedscope : Object
コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。
Command
 Inheritedstate : int
コマンドの実行状態を取得します。
Command
 Inheritedtarget : ILoadable
現在の読み込み対象を取得します。
LoadCommand
 InheritedthresholdLength : int
[static] 同一プロセス上で実行可能な最大コマンド数を取得または設定します。 設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。 この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。
Command
 Inheritedtimeout : Number
コマンドの実行中のタイムアウト時間を取得または設定します。 指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。 この値が 0 に設定されている場合、タイムアウト処理は発生しません。
Command
 Inheritedtotal : uint
登録されている ILoadable を実装したインスタンスの総数を取得します。
LoadCommand
 Inheritedurl : String
リクエストされる URL を示すストリングを取得します。
LoadCommand
Public Methods
 MethodDefined by
  
DownloadFileRef(request:URLRequest, fileReference:FileReference = null, defaultFileName:String = null, initObject:Object = null)
新しい DownloadFileRef インスタンスを作成します。 Creates a new DownloadFileRef object.
DownloadFileRef
  
DownloadFileRef インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an DownloadFileRef subclass.
DownloadFileRef
  
dispose():void
保持しているデータを解放します。
DownloadFileRef
 Inherited
execute(extra:Object = null):void
コマンド処理を実行します。
Command
 Inherited
実行中のコマンド処理が完了したことを通知します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
LoadCommand
 Inherited
interrupt(enforced:Boolean = false):void
コマンド処理を中断します。 このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。
Command
 Inherited
setProperties(parameters:Object):Command
インスタンスに対して、複数のプロパティを一括設定します。
Command
  
toString():String
指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.
DownloadFileRef
Protected Methods
 MethodDefined by
 Inherited
throwError(target:Command, error:Error):void
コマンド処理中に例外が発生したことを通知します。 エラー処理が発生すると、コマンド処理が停止します。 問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。 関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteErrorEvent.EXECUTE_ERROR イベントが送出されます。
Command
Events
 EventSummaryDefined by
 Inherited 処理が完了した場合に送出されます。 Command
 Inherited 処理の途中でエラーが発生した場合に送出されます。 Command
 Inherited 処理が中断された場合に送出されます。 Command
 Inherited 処理が開始された場合に送出されます。 Command
 Inherited ダウンロード処理を実行中にデータを受信したときに送出されます。 LoadCommand
Property detail
cacheAsResourceproperty
cacheAsResource:Boolean  [read-write]Implementation
    public function get cacheAsResource():Boolean
    public function set cacheAsResource(value:Boolean):void
dataproperty 
data:*  [read-write]Implementation
    public function get data():*
    public function set data(value:*):void
defaultFileNameproperty 
defaultFileName:String  [read-write]

ダウンロードするファイルとしてダイアログボックスに表示するデフォルトファイル名です。 コマンド実行中に値を変更しても、処理に対して反映されません。 The default filename displayed in the dialog box for the file to be downloaded.

Implementation
    public function get defaultFileName():String
    public function set defaultFileName(value:String):void
fileReferenceproperty 
fileReference:FileReference  [read-write]

ユーザーのコンピュータとサーバーとの通信に使用する FileReference インスタンスを取得または設定します。 コマンド実行中に値を変更しても、処理に対して反映されません。

Implementation
    public function get fileReference():FileReference
    public function set fileReference(value:FileReference):void
preventCacheproperty 
preventCache:Boolean  [read-write]Implementation
    public function get preventCache():Boolean
    public function set preventCache(value:Boolean):void
Constructor detail
DownloadFileRef()constructor
public function DownloadFileRef(request:URLRequest, fileReference:FileReference = null, defaultFileName:String = null, initObject:Object = null)

新しい DownloadFileRef インスタンスを作成します。 Creates a new DownloadFileRef object.

Parameters
request:URLRequestURLRequest オブジェクトです。 The URLRequest object.
 
fileReference:FileReference (default = null)ユーザーのコンピュータとサーバーとの通信に使用する FileReference インスタンスです。
 
defaultFileName:String (default = null)ダウンロードするファイルとしてダイアログボックスに表示するデフォルトファイル名です。
 
initObject:Object (default = null)設定したいプロパティを含んだオブジェクトです。
Method detail
clone()method
public override function clone():Command

DownloadFileRef インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an DownloadFileRef subclass.

Returns
Command元のオブジェクトと同じプロパティ値を含む新しい DownloadFileRef インスタンスです。 A new DownloadFileRef object that is identical to the original.
dispose()method 
public override function dispose():void

保持しているデータを解放します。

toString()method 
public override function toString():String

指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.

Returns
Stringオブジェクトのストリング表現です。 A string representation of the object.