Packageorg.libspark.thread.utils
Interfacepublic interface IProgress extends flash.events.IEventDispatcher
ImplementorsLoaderThread, MultiProgress, Progress, SoundLoaderThread, URLLoaderThread

IProgress インターフェイスは、進捗状況を表現します.


Public Properties
 PropertyDefined by
  current : Number
[read-only] 現在までに完了している仕事量を返します.
IProgress
  isCanceled : Boolean
[read-only] 仕事がキャンセルされた場合に true、そうでない場合に false を返します.
IProgress
  isCompleted : Boolean
[read-only] 仕事が完了していれば true、そうでなければ false を返します.
IProgress
  isFailed : Boolean
[read-only] 仕事が失敗していれば true、そうでなければ false を返します.
IProgress
  isStarted : Boolean
[read-only] 仕事が開始されていれば true、そうでなければ false を返します.
IProgress
  percent : Number
[read-only] 仕事量の合計に対する、現在までに完了している仕事量の割合を、0 ～ 1.0 の範囲で返します.
IProgress
  total : Number
[read-only] 仕事量の合計を返します.
IProgress
Events
 EventSummaryDefined by
  
canceled
仕事がキャンセルされると送出されます.IProgress
  
completed
仕事が完了すると送出されます.IProgress
  
failed
仕事が失敗すると送出されます.IProgress
  
start
仕事が開始されると送出されます.IProgress
  
update
仕事が進行し、 total プロパティか current プロパティか percent プロパティの いずれかが更新されると送出されます.IProgress
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

See also

isCompleted
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

See also

isCompleted
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
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

isCanceled
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

isCompleted
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

isFailed
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

isStarted
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

total
current
percent



Copyright (c) 2008 BeInteractive! (www.be-interactive.org) and Spark project (www.libspark.org).