パッケージflash.events
クラスpublic class ProgressEvent
継承ProgressEvent Inheritance Event Inheritance Object
サブクラス ModuleEvent, ResourceEvent, RSLEvent, StyleEvent

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

ProgressEvent オブジェクトは、ロード処理が開始されたとき、またはソケットがデータを受信したときに送出されます。 これらのイベントは通常、SWF ファイル、イメージまたはデータがアプリケーションにロードされるときに生成されます。 次の 2 種類のキーボードイベントがあります。ProgressEvent.PROGRESS および ProgressEvent.SOCKET_DATA

例を表示

関連項目

FileStream クラス
LoaderInfo クラス
Socket クラス


パブリックプロパティ
 プロパティ定義元
 Inheritedbubbles : Boolean
[読み取り専用] イベントがバブリングイベントかどうかを示します。
Event
  bytesLoaded : Number
リスナーがイベントを処理しているときにロードされたアイテム数またはバイト数です。
ProgressEvent
  bytesTotal : Number
ロードプロセスが成功した場合にロードされるアイテムまたはバイトの総数です。
ProgressEvent
 Inheritedcancelable : Boolean
[読み取り専用] イベントに関連付けられた動作を回避できるかどうかを示します。
Event
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcurrentTarget : Object
[読み取り専用] イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
[読み取り専用] イベントフローの現在の段階です。
Event
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedtarget : Object
[読み取り専用] イベントターゲットです。
Event
 Inheritedtype : String
[読み取り専用] イベントのタイプです。
Event
パブリックメソッド
 メソッド定義元
  
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
progress イベントに関する情報を含む Event オブジェクトを作成します。
ProgressEvent
  
[override] ProgressEvent オブジェクトのコピーを作成して、各プロパティの値を元のプロパティの値と一致するように設定します。
ProgressEvent
 Inherited
formatToString(className:String, ... arguments):String
カスタム ActionScript 3.0 Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
イベントで preventDefault() メソッドが呼び出されたかどうかを確認します。
Event
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
イベントのデフォルト動作をキャンセルできる場合に、その動作をキャンセルします。
Event
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
  
[override] ProgressEvent オブジェクトのすべてのプロパティを含むストリングを返します。
ProgressEvent
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック定数
 定数定義元
 InheritedACTIVATE : String = "activate"
[静的] ACTIVATE 定数は、type プロパティ(activate イベントオブジェクト)の値を定義します。
Event
 InheritedADDED : String = "added"
[静的] Event.ADDED 定数は、added イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[静的] Event.ADDED_TO_STAGE 定数は、type プロパティ (addedToStage イベントオブジェクト) の値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[静的] Event.CANCEL 定数は、cancel イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCHANGE : String = "change"
[静的] Event.CHANGE 定数は、type プロパティ (change イベントオブジェクト) の値を定義します。
Event
 InheritedCLEAR : String = "clear"
[静的] Event.CLEAR 定数は、clear イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCLOSE : String = "close"
[静的] Event.CLOSE 定数は、close イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only CLOSING : String = "closing"
[静的] Event.CLOSING 定数は、closing イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCOMPLETE : String = "complete"
[静的] Event.COMPLETE 定数は、complete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCONNECT : String = "connect"
[静的] Event.CONNECT 定数は、connect イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCOPY : String = "copy"
[静的] copy イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedCUT : String = "cut"
[静的] cut イベントオブジェクトの type プロパティ値を定義します。
Event
 InheritedDEACTIVATE : String = "deactivate"
[静的] Event.DEACTIVATE 定数は、deactivate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedDISPLAYING : String = "displaying"
[静的] Event.DISPLAYING 定数は、displaying イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[静的] Event.ENTER_FRAME 定数は、enterFrame イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[静的] Event.EXIT_FRAME 定数は、exitFrame イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only EXITING : String = "exiting"
[静的] Event.EXITING 定数は、type プロパティ (exiting イベントオブジェクト) の値を定義します。
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[静的] Event.FRAME_CONSTRUCTED 定数は、frameConstructed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedFULLSCREEN : String = "fullScreen"
[静的] Event.FULL_SCREEN 定数は、fullScreen イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[静的] Event.HTML_BOUNDS_CHANGE 定数は、htmlBoundsChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[静的] Event.HTML_DOM_INITIALIZE 定数は、htmlDOMInitialize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[静的] Event.HTML_RENDER 定数は、htmlRender イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedID3 : String = "id3"
[静的] Event.ID3 定数は、id3 イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedINIT : String = "init"
[静的] Event.INIT 定数は、init イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[静的] Event.LOCATION_CHANGE 定数は、locationChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[静的] Event.MOUSE_LEAVE 定数は、mouseLeave イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[静的] Event.NETWORK_CHANGE 定数は、networkChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedOPEN : String = "open"
[静的] Event.OPEN 定数は、open イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedPASTE : String = "paste"
[静的] Event.PASTE 定数は、paste イベントオブジェクトの type プロパティの値を定義します。
Event
  PROGRESS : String = "progress"
[静的] progress イベントオブジェクトの type プロパティ値を定義します。
ProgressEvent
 InheritedREMOVED : String = "removed"
[静的] Event.REMOVED 定数は、removed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[静的] Event.REMOVED_FROM_STAGE 定数は、removedFromStage イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRENDER : String = "render"
[静的] Event.RENDER 定数は、render イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRESIZE : String = "resize"
[静的] Event.RESIZE 定数は、resize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[静的] Event.SCROLL 定数は、scroll イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT : String = "select"
[静的] Event.SELECT 定数は、select イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT_ALL : String = "selectAll"
[静的] Event.SELECT_ALL 定数は、selectAll イベントオブジェクトの type プロパティの値を定義します。
Event
  SOCKET_DATA : String = "socketData"
[静的] socketData イベントオブジェクトの type プロパティ値を定義します。
ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[静的] Event.SOUND_COMPLETE 定数は、soundComplete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[静的] Event.TAB_CHILDREN_CHANGE 定数は、tabChildrenChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[静的] Event.TAB_ENABLED_CHANGE 定数は、tabEnabledChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[静的] Event.TAB_INDEX_CHANGE 定数は、tabIndexChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[静的] Event.UNLOAD 定数は、unload イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[静的] Event.USER_IDLE 定数は、userIdle イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[静的] Event.USER_PRESENT 定数は、userPresent イベントオブジェクトの type プロパティの値を定義します。
Event
プロパティの詳細
bytesLoadedプロパティ
bytesLoaded:Number

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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



実装
    public function get bytesLoaded():Number
    public function set bytesLoaded(value:Number):void
bytesTotalプロパティ 
bytesTotal:Number

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

ロードプロセスが成功した場合にロードされるアイテムまたはバイトの総数です。progress イベントが Socket オブジェクトに送出または関連付けられる場合は、コンストラクタの bytesTotal パラメータに値が指定されない限り、bytesTotal は常に 0 になります。実際に送受信されたバイト数は設定されず、アプリケーション開発者に任されます。



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

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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

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

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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

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

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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

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

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

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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

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

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

関連項目

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

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0 Flash Player 9

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

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

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

関連項目

例の使用法
ProgressEventExample.as

次の例では、ProgressEventExample クラスを使用して、ファイルのダウンロード中にさまざまなイベントリスナーを使用する方法を示します。この例では、次の処理を実行します。
  1. downloadURLfileName という 2 つのプロパティが作成されます。このプロパティは、ダウンロードされたファイルの場所と名前を示します。
  2. ProgressEventExample コンストラクタでは、file という名前の新しい FileReference オブジェクトが作成され、configureListeners() メソッドに渡されます。
  3. 次に、downloadURL プロパティと fileName プロパティが file.download() に渡されます。これによって、ファイルをダウンロードする場所の指定が求められます。
  4. configureListeners() メソッドは、7 つのイベントリスナーとそれに関連するサブスクライバメソッドを追加します。

メモ :


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);
        }
    }
}




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/flash/events/ProgressEvent.html