jp.progression.commands.net.LoadCommand

Public Properties

	Property		Defined by
		bytes : ByteArray 読み込まれたデータを ByteArray 形式で取得します。	LoadCommand
		bytesLoaded : uint [read-only] コマンドの読み込み済みのバイト数です。 The number of bytes that are loaded for the command.	LoadCommand
		bytesTotal : uint [read-only] コマンド全体の圧縮後のバイト数です。 The number of compressed bytes in the entire command.	LoadCommand
		cacheAsResource : Boolean 読み込まれたデータを自動的に Resource として管理するかどうかを取得または設定します。	LoadCommand
		catchError : Function コマンドの実行中に例外が発生した際に実行するエラー処理関数を取得または設定します。	Command
		className : String インスタンスのクラス名を取得します。 Indicates the instance className of the Command.	Command
		data : * 読み込み操作によって受信したデータです。 The data received from the load operation.	LoadCommand
		defaultCacheAsResource : Boolean [static] cacheAsResource プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。	LoadCommand
		defaultInterruptType : int [static] interruptType プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。	Command
		defaultPreventCache : Boolean [static] preventCache プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。	LoadCommand
		defaultTimeout : Number [static] timeout プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。	Command
		delay : Number コマンドが実際に実行されるまでの遅延時間を取得または設定します。コマンド実行中に値を変更しても、処理に対して反映されません。	Command
		depth : int コマンドツリー構造上での自身の深度を取得します。	Command
		extra : Object コマンドの実行処理、または中断処理の開始時に指定されているリレーオブジェクトを取得または設定します。このコマンドが親の CommandList インスタンスによって実行されている場合には、親のリレーオブジェクトを順々に引き継ぎます。	Command
		factor : Number percent プロパティの算出時の自身の重要性を取得または設定します。	LoadCommand
		group : String インスタンスのグループ名を取得または設定します。 Indicates the instance group of the Command.	Command
		id : String インスタンスを表すユニークな識別子を取得または設定します。	Command
		interruptType : int 中断処理時の処理方法を取得または設定します。コマンド実行中に値を変更しても、処理に対して反映されません。	Command
		latestData : * 自身から見て最後に関連付けられた読み込みデータを取得または設定します。このコマンドインスタンスが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。	LoadCommand
		loaded : uint [read-only] 登録されている ILoadable を実装したインスタンスの内、すでに読み込み処理が完了した数を取得します。	LoadCommand
		name : String インスタンスの名前を取得または設定します。 Indicates the instance name of the Command.	Command
		next : Command このコマンドが関連付けられている親の CommandList インスタンス内で、次に位置する Command インスタンスを取得します。	Command
		onComplete : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_COMPLETE イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onError : Function コマンドオブジェクトが ExecuteErrorEvent.EXECUTE_ERROR イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onInterrupt : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_INTERRUPT イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		onProgress : Function コマンドオブジェクトが ProgressEvent.PROGRESS イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	LoadCommand
		onStart : Function コマンドオブジェクトが ExecuteEvent.EXECUTE_START イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。	Command
		parent : CommandList この Command オブジェクトを含む CommandList オブジェクトを示します。 Indicates the CommandList object that contains this Command object.	Command
		percent : Number [read-only] loaded プロパティと total プロパティから算出される読み込み状態をパーセントで取得します。	LoadCommand
		preventCache : Boolean すでに Resource として登録されているデータを読み込む際に、既存のデータを破棄し、新たなリクエストを行う場合にランダムな引数を付加するかどうかを取得または設定します。	LoadCommand
		previous : Command このコマンドが関連付けられている親の CommandList インスタンス内で、一つ前に位置する Command インスタンスを取得します。	Command
		request : URLRequest リクエストされる URL です。コマンド実行中に値を変更しても、処理に対して反映されません。 The URL to be requested.	LoadCommand
		resGroup : String 読み込んだデータを Resource として登録する際に使用したいグループ名を取得または設定します。	LoadCommand
		resId : String 読み込んだデータを Resource として登録する際に使用したい識別子を取得または設定します。 cacheAsResource プロパティが true で、かつこの値が設定されていなければ、自動的に URL を識別子として登録します。	LoadCommand
		root : Command コマンドツリー構造の一番上に位置する Command インスタンスを取得します。	Command
		scope : Object コマンドの実行処理、または中断処理に指定されている関数内でのスコープ対象を取得または設定します。	Command
		state : int コマンドの実行状態を取得します。	Command
		target : ILoadable [read-only] 現在の読み込み対象を取得します。	LoadCommand
		thresholdLength : int [static] 同一プロセス上で実行可能な最大コマンド数を取得または設定します。設定された閾値を超えて実行された場合には、強制的に 1 ミリ秒の遅延を発生させます。この値が大きすぎる場合、スタックオーバーフローが発生する可能性があります。	Command
		timeout : Number コマンドの実行中のタイムアウト時間を取得または設定します。指定された時間中に executeComplete() メソッド、または interrupt() メソッドが実行されなかった場合にはエラーが送出されます。この値が 0 に設定されている場合、タイムアウト処理は発生しません。	Command
		total : uint [read-only] 登録されている ILoadable を実装したインスタンスの総数を取得します。	LoadCommand
		url : String [read-only] リクエストされる URL を示すストリングを取得します。	LoadCommand

	Method	Defined by
		LoadCommand(request:URLRequest, initObject:Object = null) 新しい LoadCommand インスタンスを作成します。 Creates a new LoadCommand object.	LoadCommand
		clone():Command LoadCommand インスタンスのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。 Duplicates an instance of an LoadCommand subclass.	LoadCommand
		dispose():void 保持しているデータを解放します。	LoadCommand
		execute(extra:Object = null):void コマンド処理を実行します。	Command
		executeComplete():void 実行中のコマンド処理が完了したことを通知します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	LoadCommand
		interrupt(enforced:Boolean = false):void コマンド処理を中断します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。	Command
		setProperties(parameters:Object):Command インスタンスに対して、複数のプロパティを一括設定します。	Command
		toString():String 指定されたオブジェクトのストリング表現を返します。 Returns the string representation of the specified object.	LoadCommand

	Method	Defined by
		throwError(target:Command, error:Error):void コマンド処理中に例外が発生したことを通知します。エラー処理が発生すると、コマンド処理が停止します。問題を解決し、通常フローに戻す場合には executeComplete() メソッドを、問題が解決されず中断処理を行いたい場合には interrupt() メソッドを実行してください。関数内で問題が解決、または中断処理に移行しなかった場合には ExecuteErrorEvent.EXECUTE_ERROR イベントが送出されます。	Command

Summary	Defined by
executeComplete	処理が完了した場合に送出されます。	Command
executeError	処理の途中でエラーが発生した場合に送出されます。	Command
executeInterrupt	処理が中断された場合に送出されます。	Command
executeStart	処理が開始された場合に送出されます。	Command
progress	ダウンロード処理を実行中にデータを受信したときに送出されます。	LoadCommand

Property detail

bytes

property

bytes:ByteArray [read-write]

読み込まれたデータを ByteArray 形式で取得します。

Implementation
public function get bytes():ByteArray
public function set bytes(value:ByteArray):void

bytesLoaded

property

bytesLoaded:uint [read-only]

コマンドの読み込み済みのバイト数です。 The number of bytes that are loaded for the command.

Implementation
public function get bytesLoaded():uint

See also

bytesTotal

property

bytesTotal:uint [read-only]

コマンド全体の圧縮後のバイト数です。 The number of compressed bytes in the entire command.

Implementation
public function get bytesTotal():uint

See also

bytesLoaded

cacheAsResource

property

cacheAsResource:Boolean [read-write]

読み込まれたデータを自動的に Resource として管理するかどうかを取得または設定します。

Implementation
public function get cacheAsResource():Boolean
public function set cacheAsResource(value:Boolean):void

See also

defaultCacheAsResource

data

property

data:* [read-write]

読み込み操作によって受信したデータです。 The data received from the load operation.

Implementation
public function get data():*
public function set data(value:*):void

defaultCacheAsResource

property

defaultCacheAsResource:Boolean [read-write]

cacheAsResource プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。

Implementation
public static function get defaultCacheAsResource():Boolean
public function set defaultCacheAsResource(value:Boolean):void

See also

cacheAsResource

defaultPreventCache

property

defaultPreventCache:Boolean [read-write]

preventCache プロパティの初期値を取得または設定します。すでに生成済みのコマンドに対しては適用されません。

Implementation
public static function get defaultPreventCache():Boolean
public function set defaultPreventCache(value:Boolean):void

See also

preventCache

factor

property

factor:Number [read-write]

percent プロパティの算出時の自身の重要性を取得または設定します。

Implementation
public function get factor():Number
public function set factor(value:Number):void

See also

percent

latestData

property

latestData:* [read-write]

自身から見て最後に関連付けられた読み込みデータを取得または設定します。このコマンドインスタンスが CommandList インスタンス上に存在する場合には、自身より前、または自身の親のデータを取得します。

Implementation
public function get latestData():*
public function set latestData(value:*):void

loaded

property

loaded:uint [read-only]

登録されている ILoadable を実装したインスタンスの内、すでに読み込み処理が完了した数を取得します。

Implementation
public function get loaded():uint

See also

total

onProgress

property

onProgress:Function [read-write]

コマンドオブジェクトが ProgressEvent.PROGRESS イベントを受け取った場合に呼び出されるイベントハンドラメソッドを取得または設定します。

Implementation
public function get onProgress():Function
public function set onProgress(value:Function):void

See also

scope
flash.events.ProgressEvent.PROGRESS

percent

property

percent:Number [read-only]

loaded プロパティと total プロパティから算出される読み込み状態をパーセントで取得します。

Implementation
public function get percent():Number

See also

factor
loaded
total

preventCache

property

preventCache:Boolean [read-write]

すでに Resource として登録されているデータを読み込む際に、既存のデータを破棄し、新たなリクエストを行う場合にランダムな引数を付加するかどうかを取得または設定します。

Implementation
public function get preventCache():Boolean
public function set preventCache(value:Boolean):void

See also

defaultPreventCache

request

property

request:URLRequest [read-write]

リクエストされる URL です。コマンド実行中に値を変更しても、処理に対して反映されません。 The URL to be requested.

Implementation
public function get request():URLRequest
public function set request(value:URLRequest):void

resGroup

property

resGroup:String [read-write]

読み込んだデータを Resource として登録する際に使用したいグループ名を取得または設定します。

Implementation
public function get resGroup():String
public function set resGroup(value:String):void

resId

property

resId:String [read-write]

読み込んだデータを Resource として登録する際に使用したい識別子を取得または設定します。 cacheAsResource プロパティが true で、かつこの値が設定されていなければ、自動的に URL を識別子として登録します。

Implementation
public function get resId():String
public function set resId(value:String):void

target

property

target:ILoadable [read-only]

現在の読み込み対象を取得します。

Implementation
public function get target():ILoadable

total

property

total:uint [read-only]

登録されている ILoadable を実装したインスタンスの総数を取得します。

Implementation
public function get total():uint

See also

loaded

url

property

url:String [read-only]

リクエストされる URL を示すストリングを取得します。

Implementation
public function get url():String

Constructor detail

LoadCommand

()

constructor

public function LoadCommand(request:URLRequest, initObject:Object = null)

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

Parameters

	`request:URLRequest` — ダウンロードする URL を指定する URLRequest オブジェクトです。 A URLRequest object specifying the URL to download.

	`initObject:Object` (default = `null`) — 設定したいプロパティを含んだオブジェクトです。

Method detail

clone

()

method

public override function clone():Command

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

Returns

Command — 元のオブジェクトと同じプロパティ値を含む新しい LoadCommand インスタンスです。 A new LoadCommand object that is identical to the original.

dispose

()

method

public override function dispose():void

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

executeComplete

()

method

public override function executeComplete():void

実行中のコマンド処理が完了したことを通知します。このメソッドを実行するためには、事前に execute() メソッドが実行されている必要があります。

See also

state
interrupt()

toString

()

method

public override function toString():String

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

Returns

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

Event detail

progress

event

Event object type: flash.events.ProgressEvent

ダウンロード処理を実行中にデータを受信したときに送出されます。

Progression 4.0 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class LoadCommand	Properties \| Methods \| Events

Package	jp.progression.commands.net
Class	public class LoadCommand
Inheritance	LoadCommand Command flash.events.EventDispatcher
Implements	ILoadable
Subclasses	DownloadFileRef, LoadBitmapData, LoadScene, LoadSound, LoadSWF, LoadURL, UploadFileRef