org.libspark.thread.utils.Progress

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

	Method	Defined by
		cancel():void 仕事のキャンセルを通知します.	Progress
		complete():void 仕事の完了を通知します.	Progress
		fail():void 仕事の失敗を通知します.	Progress
		progress(current:Number):void 仕事の進捗を通知します.	Progress
		start(total:Number):void 仕事の開始を通知します.	Progress

Summary	Defined by
canceled	仕事がキャンセルされると送出されます.	Progress
completed	仕事が完了すると送出されます.	Progress
failed	仕事が失敗すると送出されます.	Progress
start	仕事が開始されると送出されます.	Progress
update	仕事が進行し、 `total` プロパティか `current` プロパティか `percent` プロパティのいずれかが更新されると送出されます.	Progress

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

cancel

()

method

public function cancel():void

仕事のキャンセルを通知します.

このメソッドの呼び出しによって、 isCanceled プロパティが true にセットされ、 ProgressEvent.CANCELED イベントが送出されます。

See also

isCanceled

complete

()

method

public function complete():void

仕事の完了を通知します.

このメソッドの呼び出しによって、 isCompleted プロパティが true にセットされ、 ProgressEvent.COMPLETED イベントが送出されます。

ただし、現在の仕事量が変わることはありません。 percent プロパティが完全に 1.0 になるよう、先に progress メソッドを呼び出してください。

See also

isCompleted
progress()

fail

()

method

public function fail():void

仕事の失敗を通知します.

このメソッドの呼び出しによって、 isFailed プロパティが true にセットされ、 ProgressEvent.FAILED イベントが送出されます。

See also

isFailed

progress

()

method

public function progress(current:Number):void

仕事の進捗を通知します.

このメソッドの呼び出しによって、現在の仕事量と、percent プロパティの値が更新され、 ProgressEvent.UPDATE イベントが送出されます。

Parameters

current:Number — 現在までに完了している仕事量。

See also

total
current
percent

start

()

method

public function start(total:Number):void

仕事の開始を通知します.

このメソッドの呼び出しによって、現在の仕事量と、完了またはキャンセルフラグはクリアされた後、開始フラグがセットされ、 ProgressEvent.START イベントが送出されます。

Parameters

total:Number — 仕事量の合計。未知の場合は 0 を渡します。

See also

total

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 Progress	Properties \| Methods \| Events

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