Packageorg.libspark.thread.utils
Classpublic class Progress
InheritanceProgress Inheritance flash.events.EventDispatcher
ImplementsIProgress

Progress クラスは、 IProgress インターフェイスの最も単純な実装クラスです.

start メソッド、 progress メソッドそして complete または failed または cancel メソッドを順番に呼び出すことで、進捗状況を通知することができます。

See also

start()
progress()
complete()
cancel()


Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined by
  
cancel():void
仕事のキャンセルを通知します.
Progress
  
complete():void
仕事の完了を通知します.
Progress
  
fail():void
仕事の失敗を通知します.
Progress
  
progress(current:Number):void
仕事の進捗を通知します.
Progress
  
start(total:Number):void
仕事の開始を通知します.
Progress
Events
 EventSummaryDefined by
   仕事がキャンセルされると送出されます.Progress
   仕事が完了すると送出されます.Progress
   仕事が失敗すると送出されます.Progress
   仕事が開始されると送出されます.Progress
   仕事が進行し、 total プロパティか current プロパティか percent プロパティの いずれかが更新されると送出されます.Progress
Property detail
currentproperty
current:Number  [read-only]

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

Implementation
    public function get current():Number
isCanceledproperty 
isCanceled:Boolean  [read-only]

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

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

Implementation
    public function get isCanceled():Boolean
isCompletedproperty 
isCompleted:Boolean  [read-only]

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

Implementation
    public function get isCompleted():Boolean
isFailedproperty 
isFailed:Boolean  [read-only]

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

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

Implementation
    public function get isFailed():Boolean
isStartedproperty 
isStarted:Boolean  [read-only]

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

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

Implementation
    public function get isStarted():Boolean
percentproperty 
percent:Number  [read-only]

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

Implementation
    public function get percent():Number
totalproperty 
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

complete()method 
public function complete():void

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

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

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

See also

fail()method 
public function fail():void

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

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

See also

progress()method 
public function progress(current:Number):void

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

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

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

See also

start()method 
public function start(total:Number):void

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

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

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

See also

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

仕事がキャンセルされると送出されます.

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

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

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

See also

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

仕事が完了すると送出されます.

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

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

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

See also

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

仕事が失敗すると送出されます.

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

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

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

See also

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

仕事が開始されると送出されます.

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

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

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

See also

updateevent  
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 イベントオブジェクト)の値を定義します.

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

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

See also