org.libspark.thread.utils.MultiProgress

	Property	Defined by
		current : Number [read-only] 現在までに完了している仕事量を返します.	MultiProgress
		isCanceled : Boolean [read-only] 仕事がキャンセルされた場合に true、そうでない場合に false を返します.	MultiProgress
		isCompleted : Boolean [read-only] 仕事が完了していれば true、そうでなければ false を返します.	MultiProgress
		isFailed : Boolean [read-only] 仕事が失敗していれば true、そうでなければ false を返します.	MultiProgress
		isStarted : Boolean [read-only] 仕事が開始されていれば true、そうでなければ false を返します.	MultiProgress
		percent : Number [read-only] 仕事量の合計に対する、現在までに完了している仕事量の割合を、0 ～ 1.0 の範囲で返します.	MultiProgress
		total : Number [read-only] 仕事量の合計を返します.	MultiProgress

	Method	Defined by
		addProgress(progress:IProgress, factor:Number = 1.0):void 進捗状況を追加します.	MultiProgress
		removeProgress(progress:IProgress):void 追加された進捗状況を削除します.	MultiProgress

Summary	Defined by
canceled	保持している進捗状況のうち、どれかひとつでも仕事がキャンセルされると送出されます.	MultiProgress
completed	保持している全ての進捗状況の仕事が完了すると送出されます.	MultiProgress
failed	保持している進捗状況のうち、どれかひとつでも仕事が失敗すると送出されます.	MultiProgress
start	保持している進捗状況のうち、どれかひとつでも仕事が開始されると送出されます.	MultiProgress
update	保持している進捗状況のうち、どれかひとつでも仕事が進行し、 `total` プロパティか `current` プロパティか `percent` プロパティのいずれかが更新されると送出されます.	MultiProgress

Property detail

current

property

current:Number [read-only]

現在までに完了している仕事量を返します.

Implementation
public function get current():Number

isCanceled

property

isCanceled:Boolean [read-only]

仕事がキャンセルされた場合に true、そうでない場合に false を返します.

このプロパティが true であるときに、 isCompleted プロパティが true になることはありません。

Implementation
public function get isCanceled():Boolean

isCompleted

property

isCompleted:Boolean [read-only]

仕事が完了していれば true、そうでなければ false を返します.

Implementation
public function get isCompleted():Boolean

isFailed

property

isFailed:Boolean [read-only]

仕事が失敗していれば true、そうでなければ false を返します.

このプロパティが true であるときに、 isCompleted プロパティが true になることはありません。

Implementation
public function get isFailed():Boolean

isStarted

property

isStarted:Boolean [read-only]

仕事が開始されていれば true、そうでなければ false を返します.

このプロパティは、仕事が完了したり、失敗やキャンセルされた場合でも false になることはありません。

Implementation
public function get isStarted():Boolean

percent

property

percent:Number [read-only]

仕事量の合計に対する、現在までに完了している仕事量の割合を、0 ～ 1.0 の範囲で返します.

Implementation
public function get percent():Number

total

property

total:Number [read-only]

仕事量の合計を返します.

仕事量の合計が未知である場合、 0 を返します。

Implementation
public function get total():Number

Method detail

addProgress

()

method

public function addProgress(progress:IProgress, factor:Number = 1.0):void

進捗状況を追加します.

factor 引数によって、この仕事の重み付けを設定することができます。デフォルトは 1.0 で、全ての進捗状況の factor が 1.0 の場合、 MultiProgress クラスの percent プロパティは、全ての進捗状況の合計を、その個数で等分したもになります。

factor 引数が 1.0 以外に設定される場合、たとえばある進捗状況 A の factor が 1.0 で、ある進捗状況 B の factor が 2.0 である場合、 MultiProgress クラスの percent プロパティは、「(進捗状況 A の percent 1.0 + 進捗状況 B の percent 2.0) / (1.0 + 2.0)」という計算式で表されることになります。

total プロパティと current プロパティは factor の影響を受けず、単純に全ての進捗状況の該当するプロパティを合計したものになります。

Parameters

	`progress:IProgress` — 追加する進捗状況

	`factor:Number` (default = `1.0`) — 進捗状況の重み

Throws

— 進捗状況が null の場合

removeProgress

()

method

public function removeProgress(progress:IProgress):void

追加された進捗状況を削除します.

Parameters

progress:IProgress — 削除する進捗状況

Throws

— 指定された progress がこのクラスに追加されたものではない場合

Event detail

canceled

event

Event object type: org.libspark.thread.utils.events.ProgressEvent
ProgressEvent.type property = org.libspark.thread.utils.events.ProgressEvent.CANCELED

保持している進捗状況のうち、どれかひとつでも仕事がキャンセルされると送出されます.

ProgressEvent.CANCELED 定数は、 type プロパティ (canceled イベントオブジェクト)の値を定義します.

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	false
`cancelable`	false。キャンセルデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで `Event` オブジェクトをアクティブに処理しているオブジェクトです。
`target`	仕事がキャンセルされたオブジェクトです。

completed

event

Event object type: org.libspark.thread.utils.events.ProgressEvent
ProgressEvent.type property = org.libspark.thread.utils.events.ProgressEvent.COMPLETED

保持している全ての進捗状況の仕事が完了すると送出されます.

ProgressEvent.COMPLETED 定数は、 type プロパティ (completed イベントオブジェクト)の値を定義します.

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	false
`cancelable`	false。キャンセルデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで `Event` オブジェクトをアクティブに処理しているオブジェクトです。
`target`	仕事が完了したオブジェクトです。

failed

event

Event object type: org.libspark.thread.utils.events.ProgressEvent
ProgressEvent.type property = org.libspark.thread.utils.events.ProgressEvent.FAILED

保持している進捗状況のうち、どれかひとつでも仕事が失敗すると送出されます.

ProgressEvent.FAILED 定数は、 type プロパティ (failed イベントオブジェクト)の値を定義します.

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	false
`cancelable`	false。キャンセルデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで `Event` オブジェクトをアクティブに処理しているオブジェクトです。
`target`	仕事が失敗したオブジェクトです。

start

event

Event object type: org.libspark.thread.utils.events.ProgressEvent
ProgressEvent.type property = org.libspark.thread.utils.events.ProgressEvent.START

保持している進捗状況のうち、どれかひとつでも仕事が開始されると送出されます.

ProgressEvent.START 定数は、 type プロパティ (start イベントオブジェクト)の値を定義します.

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	false
`cancelable`	false。キャンセルデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで `Event` オブジェクトをアクティブに処理しているオブジェクトです。
`target`	仕事が開始されたオブジェクトです。

update

event

Event object type: org.libspark.thread.utils.events.ProgressEvent
ProgressEvent.type property = org.libspark.thread.utils.events.ProgressEvent.UPDATE

保持している進捗状況のうち、どれかひとつでも仕事が進行し、 total プロパティか current プロパティか percent プロパティのいずれかが更新されると送出されます.

ProgressEvent.UPDATE 定数は、 type プロパティ (update イベントオブジェクト)の値を定義します.

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	false
`cancelable`	false。キャンセルデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで `Event` オブジェクトをアクティブに処理しているオブジェクトです。
`target`	値が更新されたオブジェクトです。

ActionScript Thread Library - API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class MultiProgress	Properties \| Methods \| Events

Package	org.libspark.thread.utils
Class	public class MultiProgress
Inheritance	MultiProgress flash.events.EventDispatcher
Implements	IProgress