包 | flash.events |
类 | public class ProgressEvent |
继承 | ProgressEvent Event Object |
子类 | ModuleEvent, ResourceEvent, RSLEvent, StyleEvent |
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0 Flash Player 9 |
ProgressEvent.PROGRESS
和 ProgressEvent.SOCKET_DATA
。
另请参见
属性 | 定义方 | ||
---|---|---|---|
bubbles : Boolean [只读 (read-only)] 指示事件是否为冒泡事件。 | Event | ||
bytesLoaded : Number 在侦听器处理事件时加载的项数或字节数。 | ProgressEvent | ||
bytesTotal : Number 如果加载过程成功,将加载的总项数或总字节数。 | ProgressEvent | ||
cancelable : Boolean [只读 (read-only)] 指示是否可以阻止与事件相关联的行为。 | Event | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
currentTarget : Object [只读 (read-only)] 当前正在使用某个事件侦听器处理 Event 对象的对象。 | Event | ||
eventPhase : uint [只读 (read-only)] 事件流中的当前阶段。 | Event | ||
prototype : Object [静态]
对类或函数对象的原型对象的引用。 | Object | ||
target : Object [只读 (read-only)] 事件目标。 | Event | ||
type : String [只读 (read-only)] 事件的类型。 | Event |
方法 | 定义方 | ||
---|---|---|---|
ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0) 创建一个 Event 对象,其中包含有关进度事件的信息。 | ProgressEvent | ||
创建 ProgressEvent 对象的副本,并设置每个属性的值以匹配原始属性值。 | ProgressEvent | ||
用于在自定义 ActionScript 3.0 Event 类中实现 toString() 方法的实用程序函数。 | Event | ||
指示对象是否已经定义了指定的属性。 | Object | ||
检查是否已对事件调用 preventDefault() 方法。 | Event | ||
指示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
如果可以取消事件的默认行为,则取消该行为。 | Event | ||
指示指定的属性是否存在、是否可枚举。 | Object | ||
设置循环操作动态属性的可用性。 | Object | ||
防止对事件流中当前节点中和所有后续节点中的事件侦听器进行处理。 | Event | ||
防止对事件流中当前节点的后续节点中的所有事件侦听器进行处理。 | Event | ||
返回一个字符串,其中包含 ProgressEvent 对象的所有属性。 | ProgressEvent | ||
返回指定对象的原始值。 | Object |
常量 | 定义方 | ||
---|---|---|---|
ACTIVATE : String = "activate" [静态] ACTIVATE 常量定义 activate 事件对象的 type 属性的值。 | Event | ||
ADDED : String = "added" [静态] Event.ADDED 常量定义 added 事件对象的 type 属性值。 | Event | ||
ADDED_TO_STAGE : String = "addedToStage" [静态] Event.ADDED_TO_STAGE 常量定义 addedToStage 事件对象的 type 属性值。 | Event | ||
CANCEL : String = "cancel" [静态] Event.CANCEL 常量定义 cancel 事件对象的 type 属性的值。 | Event | ||
CHANGE : String = "change" [静态] Event.CHANGE 常量定义 change 事件对象的 type 属性值。 | Event | ||
CLEAR : String = "clear" [静态] Event.CLEAR 常量定义 clear 事件对象的 type 属性的值。 | Event | ||
CLOSE : String = "close" [静态] Event.CLOSE 常量定义 close 事件对象的 type 属性的值。 | Event | ||
CLOSING : String = "closing" [静态] Event.CLOSING 常量定义 closing 事件对象的 type 属性值。 | Event | ||
COMPLETE : String = "complete" [静态] Event.COMPLETE 常量定义 complete 事件对象的 type 属性值。 | Event | ||
CONNECT : String = "connect" [静态] Event.CONNECT 常量定义 connect 事件对象的 type 属性值。 | Event | ||
COPY : String = "copy" [静态] 定义 copy 事件对象的 type 属性值。 | Event | ||
CUT : String = "cut" [静态] 定义 cut 事件对象的 type 属性值。 | Event | ||
DEACTIVATE : String = "deactivate" [静态] Event.DEACTIVATE 常量定义 deactivate 事件对象的 type 属性值。 | Event | ||
DISPLAYING : String = "displaying" [静态] Event.DISPLAYING 常量定义 displaying 事件对象的 type 属性值。 | Event | ||
ENTER_FRAME : String = "enterFrame" [静态] Event.ENTER_FRAME 常量定义 enterFrame 事件对象的 type 属性值。 | Event | ||
EXIT_FRAME : String = "exitFrame" [静态] Event.EXIT_FRAME 常量定义 exitFrame 事件对象的 type 属性的值。 | Event | ||
EXITING : String = "exiting" [静态] Event.EXITING 常量定义 exiting 事件对象的 type 属性值。 | Event | ||
FRAME_CONSTRUCTED : String = "frameConstructed" [静态] Event.FRAME_CONSTRUCTED 常量定义 frameConstructed 事件对象的 type 属性的值。 | Event | ||
FULLSCREEN : String = "fullScreen" [静态] Event.FULL_SCREEN 常量定义 fullScreen 事件对象的 type 属性值。 | Event | ||
HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [静态] Event.HTML_BOUNDS_CHANGE 常量定义 htmlBoundsChange 事件对象的 type 属性值。 | Event | ||
HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [静态] Event.HTML_DOM_INITIALIZE 常量定义 htmlDOMInitialize 事件对象的 type 属性值。 | Event | ||
HTML_RENDER : String = "htmlRender" [静态] Event.HTML_RENDER 常量定义 htmlRender 事件对象的 type 属性值。 | Event | ||
ID3 : String = "id3" [静态] Event.ID3 常量定义 id3 事件对象的 type 属性值。 | Event | ||
INIT : String = "init" [静态] Event.INIT 常量定义 init 事件对象的 type 属性值。 | Event | ||
LOCATION_CHANGE : String = "locationChange" [静态] Event.LOCATION_CHANGE 常量定义 locationChange 事件对象的 type 属性值。 | Event | ||
MOUSE_LEAVE : String = "mouseLeave" [静态] Event.MOUSE_LEAVE 常量定义 mouseLeave 事件对象的 type 属性值。 | Event | ||
NETWORK_CHANGE : String = "networkChange" [静态] Event.NETWORK_CHANGE 常量定义 networkChange 事件对象的 type 属性值。 | Event | ||
OPEN : String = "open" [静态] Event.OPEN 常量用于定义 open 事件对象的 type 属性值。 | Event | ||
PASTE : String = "paste" [静态] Event.PASTE 常量定义 paste 事件对象的 type 属性的值。 | Event | ||
PROGRESS : String = "progress" [静态] 定义 progress 事件对象的 type 属性值。 | ProgressEvent | ||
REMOVED : String = "removed" [静态] Event.REMOVED 常量定义 removed 事件对象的 type 属性值。 | Event | ||
REMOVED_FROM_STAGE : String = "removedFromStage" [静态] Event.REMOVED_FROM_STAGE 常量定义 removedFromStage 事件对象的 type 属性值。 | Event | ||
RENDER : String = "render" [静态] Event.RENDER 常量定义 render 事件对象的 type 属性的值。 | Event | ||
RESIZE : String = "resize" [静态] Event.RESIZE 常量定义 resize 事件对象的 type 属性的值。 | Event | ||
SCROLL : String = "scroll" [静态] Event.SCROLL 常量定义 scroll 事件对象的 type 属性值。 | Event | ||
SELECT : String = "select" [静态] Event.SELECT 常量定义 select 事件对象的 type 属性的值。 | Event | ||
SELECT_ALL : String = "selectAll" [静态] Event.SELECT_ALL 常量定义 selectAll 事件对象的 type 属性的值。 | Event | ||
SOCKET_DATA : String = "socketData" [静态] 定义 socketData 事件对象的 type 属性值。 | ProgressEvent | ||
SOUND_COMPLETE : String = "soundComplete" [静态] Event.SOUND_COMPLETE 常量定义 soundComplete 事件对象的 type 属性值。 | Event | ||
TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [静态] Event.TAB_CHILDREN_CHANGE 常量定义 tabChildrenChange 事件对象的 type 属性值。 | Event | ||
TAB_ENABLED_CHANGE : String = "tabEnabledChange" [静态] Event.TAB_ENABLED_CHANGE 常量定义 tabEnabledChange 事件对象的 type 属性值。 | Event | ||
TAB_INDEX_CHANGE : String = "tabIndexChange" [静态] Event.TAB_INDEX_CHANGE 常量定义 tabIndexChange 事件对象的 type 属性值。 | Event | ||
UNLOAD : String = "unload" [静态] Event.UNLOAD 常量定义 unload 事件对象的 type 属性值。 | Event | ||
USER_IDLE : String = "userIdle" [静态] Event.USER_IDLE 常量定义 userIdle 事件对象的 type 属性值。 | Event | ||
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 |
如果加载过程成功,将加载的总项数或总字节数。如果将进度事件调度/附加到某个 Socket 对象,则 bytesTotal 将始终为 0,除非在构造函数的 bytesTotal 参数中指定一个值。未设置来回发送的实际字节数,该字节数将由应用程序开发人员决定。
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 |
创建一个 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 ]
String —
一个字符串,其中包含 ProgressEvent 对象的所有属性。
|
PROGRESS | 常量 |
public static const PROGRESS:String = "progress"
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0 Flash Player 9 |
定义 progress
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles
|
false
|
bytesLoaded
| 在侦听器处理事件时加载的项数或字节数。 |
bytesTotal
| 如果加载进程成功,最终将加载的项目或字节总数。 |
cancelable
|
false ;没有要取消的默认行为。
|
currentTarget
| 当前正在使用某个事件侦听器处理 Event 对象的对象。 |
target
| 报告进度的 对象。 |
另请参见
SOCKET_DATA | 常量 |
public static const SOCKET_DATA:String = "socketData"
语言版本: | ActionScript 3.0 |
运行时版本: | AIR 1.0 Flash Player 9 |
定义 socketData
事件对象的 type
属性值。
此事件具有以下属性:
属性 | 值 |
---|---|
bubbles
|
false
|
cancelable
|
false ;没有要取消的默认行为。
|
currentTarget
| 当前正在处理此事件的对象。 |
bytesLoaded
| 在侦听器处理事件时加载的项数或字节数。 |
bytesTotal
|
0;socketData 事件对象不使用此属性。
|
target
| 报告进度的 Socket 对象。 |
另请参见
ProgressEventExample
类来说明如何在下载文件时使用各种事件侦听器。该示例执行下列任务:
downloadURL
和 fileName
属性,这些属性指示下载文件的位置和名称。
ProgressEventExample
构造函数中,创建名为 file
的新 FileReference 对象,再将其传递给 configureListeners()
方法。
downloadURL
和 fileName
属性传递给 file.download()
,它提示要下载文件的位置。
configureListeners()
方法添加七个事件侦听器及其关联的订阅者方法:
注意:
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); } } }