パッケージflash.events
public class ProgressEvent
継承ProgressEvent Inheritance Event Inheritance Object
SubclassesRSLEvent

ロード操作が開始するか、ソケットがデータを受信すると、Flash® Player によって ProgressEvent オブジェクトが送出されます。これらのイベントは、通常、SWF ファイル、イメージ、またはデータが Flash Player にロードされるときに生成されます。ProgressEvent.PROGRESS および ProgressEvent.SOCKET_DATA の 2 種類の progress イベントがあります。

例の表示

関連項目

LoaderInfo class
Socket class


パブリックプロパティ
 プロパティ定義
 Inheritedbubbles : Boolean
イベントがバブリングイベントかどうかを示します。
Event
  bytesLoaded : uint
リスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
ProgressEvent
  bytesTotal : uint
ロードプロセスが成功した場合にロードされるアイテムまたはバイトの総数です。
ProgressEvent
 Inheritedcancelable : Boolean
イベントに関連付けられたビヘイビアを回避できるかどうかを示します。
Event
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcurrentTarget : Object
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
イベントフローの現在の段階です。
Event
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedtarget : Object
イベントターゲットです。
Event
 Inheritedtype : String
イベントの型です。
Event
パブリックメソッド
 メソッド定義
  ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0)
progress イベントに関する情報を含む Event オブジェクトを作成します。
ProgressEvent
  clone():Event
ProgressEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
ProgressEvent
 InheritedformatToString(className:String, ... arguments):String
カスタム Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisDefaultPrevented():Boolean
イベントで preventDefault() が呼び出されたかどうかをチェックします。
Event
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpreventDefault():void
イベントのデフォルトビヘイビアをキャンセルできる場合に、そのビヘイビアをキャンセルします。
Event
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedstopImmediatePropagation():void
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 InheritedstopPropagation():void
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
  toString():String
ProgressEvent オブジェクトのすべてのプロパティを含むストリングを返します。
ProgressEvent
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
パブリック定数
 定数定義
 InheritedACTIVATE : String = "activate"
[static] activate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED : String = "added"
[static] added イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[static] cancelイベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCHANGE : String = "change"
[static] change イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCLOSE : String = "close"
[static] close イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCOMPLETE : String = "complete"
[static] complete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCONNECT : String = "connect"
[static] connect イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] deactivate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] enterFrame イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedID3 : String = "id3"
[static] id3 イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedINIT : String = "init"
[static] init イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] mouseLeave イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedOPEN : String = "open"
[static] open イベントオブジェクトの type プロパティの値を定義します。
Event
  PROGRESS : String = "progress"
[static] progress イベントオブジェクトの type プロパティの値を定義します。
ProgressEvent
 InheritedREMOVED : String = "removed"
[static] removed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRENDER : String = "render"
[static] render イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRESIZE : String = "resize"
[static] resize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[static] scroll イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT : String = "select"
[static] select イベントオブジェクトの type プロパティの値を定義します。
Event
  SOCKET_DATA : String = "socketData"
[static] socketData イベントオブジェクトの type プロパティの値を定義します。
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] soundComplete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] tabChildrenChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] tabEnabledChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] tabIndexChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[static] unload イベントオブジェクトの type プロパティの値を定義します。
Event
プロパティの詳細
bytesLoadedプロパティ
bytesLoaded:uint  [read-write]

リスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。

実装
    public function get bytesLoaded():uint
    public function set bytesLoaded(value:uint):void
bytesTotalプロパティ 
bytesTotal:uint  [read-write]

ロードプロセスが成功した場合にロードされるアイテムまたはバイトの総数です。

実装
    public function get bytesTotal():uint
    public function set bytesTotal(value:uint):void
コンストラクタの詳細
ProgressEvent()コンストラクタ
public 関数 ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:uint = 0, bytesTotal:uint = 0)

progress イベントに関する情報を含む Event オブジェクトを作成します。イベントリスナーには Event オブジェクトがパラメータとして渡されます。

パラメータ
type:String — イベントのタイプです。有効な値は、ProgressEvent.PROGRESS および ProgressEvent.SOCKET_DATA です。
 
bubbles:Boolean (default = false) — Event オブジェクトがイベントフローのバブリング段階で処理されるかどうかを判断します。
 
cancelable:Boolean (default = false) — Event オブジェクトがキャンセル可能かどうかを判断します。
 
bytesLoaded:uint (default = 0) — リスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
 
bytesTotal:uint (default = 0) — ロードプロセスが成功した場合にロードされるアイテムまたはバイトの総数です。
メソッドの詳細
clone()メソッド
public override function clone():Event

ProgressEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。

戻り値
Event — 元のオブジェクトと同じプロパティ値を含む新しい ProgressEvent オブジェクトです。
toString()メソッド 
public override function toString():String

ProgressEvent オブジェクトのすべてのプロパティを含むストリングを返します。ストリングは次の形式です。

[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]

戻り値
StringProgressEvent オブジェクトのすべてのプロパティを含むストリングです。
定数の詳細
PROGRESS定数
public static const PROGRESS:String = "progress"

progress イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ
bubblesfalse
bytesLoadedリスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
bytesTotalロードプロセスが成功した場合に最終的にロードされるアイテムまたはバイトの総数です。
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target進行状況をレポートするネットワークオブジェクトです。

関連項目

SOCKET_DATA定数 
public static const SOCKET_DATA:String = "socketData"

socketData イベントオブジェクトの type プロパティの値を定義します。

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

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetEvent をアクティブに処理しているオブジェクトです。
bytesLoadedリスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
bytesTotal0。このプロパティは、socketData イベントオブジェクトによって使用されません。
target進行状況をレポートする Socket オブジェクトです。

関連項目


次の例では、ProgressEventExample クラスを使用して、 ファイルのダウンロード中にさまざまなイベントリスナーを使用する方法を示します。この例では、次の処理を実行します。
  1. プロパティ downloadURLfileName が作成されます。これらは ダウンロードファイルの場所と名前を示します。
  2. ProgressEventExample コンストラクタでは、file という名前の新しい FileReference オブジェクトが 作成されて、configureListeners() メソッドに渡されます。
  3. 次に、downloadURL プロパティおよびfileName プロパティが file.download() に渡されます。 これによって、ファイルをダウンロードする場所の指定が求められます。
  4. configureListeners() メソッドは、7 つのイベントリスナーとそれに関連するサブスクライバ メソッドを追加します。
    1. cancel/cancelHandler() は、ファイルのダウンロードがキャンセルされた場合に送出されます。
    2. complete/complereHandler() は、ファイルのダウンロードプロセスが終了したときに 送出されます。
    3. ioError/ioErrorHandler() は、ダウンロードファイルが使用できない場合、またはアクセスできない場合に 送出されます。
    4. open/openHandler() は、ダウンロード操作が開始したときに送出されます。
    5. progress/progressHandler() は、ダウンロードプロセスが開始したときと終了したときに 送出されます。
    6. securityError/securityErrorHandler は、ローカル再生のセキュリティ設定がダウンロードファイルのデータアクセスの種類と一致しない場合に 送出されます (ローカルとネットワークの違い)。 この後の「説明」を参照してください。
    7. select/selectHandler() は、ダウンロードオブジェクトが選択されたときに送出されます。

メモ :


package {
    import flash.display.Sprite;
    import flash.events.*;
    import flash.net.FileReference;
    import flash.net.URLRequest;

    public class ProgressEventExample extends Sprite {
        private var downloadURL:String = "http://www.[yourDomain].com/SomeFile.pdf";
        private var fileName:String = "SomeFile.pdf";
        private var file:FileReference;

        public function ProgressEventExample() {
            var request:URLRequest = new URLRequest(downloadURL);
            file = new FileReference();
            configureListeners(file);
            file.download(request, fileName);
        }

        private function configureListeners(dispatcher:IEventDispatcher):void {
            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
            dispatcher.addEventListener(Event.OPEN, openHandler);
            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
            dispatcher.addEventListener(Event.SELECT, selectHandler);
        }

        private function cancelHandler(event:Event):void {
            trace("cancelHandler: " + event);
        }

        private function completeHandler(event:Event):void {
            trace("completeHandler: " + event);
        }

        private function ioErrorHandler(event:IOErrorEvent):void {
            trace("ioErrorHandler: " + event);
        }

        private function openHandler(event:Event):void {
            trace("openHandler: " + event);
        }

        private function progressHandler(event:ProgressEvent):void {
            var file:FileReference = FileReference(event.target);
            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
        }

        private function securityErrorHandler(event:SecurityErrorEvent):void {
            trace("securityErrorHandler: " + event);
        }

        private function selectHandler(event:Event):void {
            var file:FileReference = FileReference(event.target);
            trace("selectHandler: name=" + file.name + " URL=" + downloadURL);
        }
    }
}