包 | mx.preloaders |
类 | public class DownloadProgressBar |
继承 | DownloadProgressBar Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
实现 | IPreloaderDisplay |
子类 | WorkspacePreloader |
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
下载进度栏显示关于两个应用程序阶段的信息:下载阶段和例示阶段。
在 Application 容器中,使用 preloader
属性可以指定子类的名称。
您可以通过创建 DownloadProgressBar 类的子类来实现自定义下载进度栏组件。不要将下载进度栏实现为 MXML 组件,因为这样下载速度太慢。
相关 API 元素
属性 | 由以下参数定义 | ||
---|---|---|---|
accessibilityImplementation : AccessibilityImplementation
InteractiveObject 实例的当前辅助功能实现 (AccessibilityImplementation)。 | InteractiveObject | ||
accessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。 | DisplayObject | ||
alpha : Number
表示指定对象的 Alpha 透明度值。 | DisplayObject | ||
backgroundAlpha : Number
backgroundImage 属性定义的 SWF 文件或图像的 Alpha 级别,或者 backgroundColor 属性定义的颜色。 | DownloadProgressBar | ||
backgroundColor : uint
下载进度栏的背景颜色。 | DownloadProgressBar | ||
backgroundImage : Object
由 Preloader 传入的应用程序的背景图像。 | DownloadProgressBar | ||
backgroundSize : String
将 backgroundImage 指定的图像缩放到不同的百分比大小。 | DownloadProgressBar | ||
blendMode : String
BlendMode 类中的一个值,用于指定要使用的混合模式。 | DisplayObject | ||
blendShader : Shader [只写]
设置用于混合前景和背景的着色器。 | DisplayObject | ||
buttonMode : Boolean
指定此 sprite 的按钮模式。 | Sprite | ||
cacheAsBitmap : Boolean
如果设置为 true,则 Flash 运行时将缓存显示对象的内部位图表示形式。 | DisplayObject | ||
cacheAsBitmapMatrix : Matrix
如果为非 null,则 Matrix 对象会定义显示对象在 cacheAsBitmap 设置为 true 时的呈现方式。 | DisplayObject | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
contextMenu : NativeMenu
指定与此对象相关联的上下文菜单。 | InteractiveObject | ||
doubleClickEnabled : Boolean
指定此对象是否接收 doubleClick 事件。 | InteractiveObject | ||
dropTarget : DisplayObject [只读]
指定拖动 sprite 时经过的显示对象,或放置 sprite 的显示对象。 | Sprite | ||
filters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。 | DisplayObject | ||
focusRect : Object
指定此对象是否显示焦点矩形。 | InteractiveObject | ||
graphics : Graphics [只读]
指定属于此 sprite 的 Graphics 对象,在此 sprite 中可执行矢量绘图命令。 | Sprite | ||
height : Number
表示显示对象的高度,以像素为单位。 | DisplayObject | ||
hitArea : Sprite
指定一个 sprite 用作另一个 sprite 的点击区域。 | Sprite | ||
initializingLabel : String [静态]
初始化阶段要显示为标签的字符串。 | DownloadProgressBar | ||
loaderInfo : LoaderInfo [只读]
返回一个 LoaderInfo 对象,其中包含加载此显示对象所属的文件的相关信息。 | DisplayObject | ||
mask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。 | DisplayObject | ||
metaData : Object
如果元数据是通过 PlaceObject4 标记与此 DisplayObject 的实例一起存储在 SWF 文件中的,则获取 DisplayObject 实例的元数据对象。 | DisplayObject | ||
mouseChildren : Boolean
确定对象的子级是否支持鼠标或用户输入设备。 | DisplayObjectContainer | ||
mouseEnabled : Boolean
指定此对象是否接收鼠标或其他用户输入、消息。 | InteractiveObject | ||
mouseX : Number [只读]
表示此鼠标或用户输入设备位置的 x 坐标,以像素为单位。 | DisplayObject | ||
mouseY : Number [只读]
表示此鼠标或用户输入设备位置的 y 坐标,以像素为单位。 | DisplayObject | ||
name : String
表示 DisplayObject 的实例名称。 | DisplayObject | ||
needsSoftKeyboard : Boolean
指定当该 InteractiveObject 实例获得焦点时,是否显示虚拟键盘(显示在屏幕上的软键盘)。 | InteractiveObject | ||
numChildren : int [只读]
返回此对象的子项数目。 | DisplayObjectContainer | ||
opaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。 | DisplayObject | ||
parent : DisplayObjectContainer [只读]
表示包含此显示对象的 DisplayObjectContainer 对象。 | DisplayObject | ||
preloader : Sprite [只写]
Preloader 类会将到自身的引用传入显示类,以侦听来自 Preloader 的事件。 | DownloadProgressBar | ||
root : DisplayObject [只读]
对于加载的 SWF 文件中的显示对象,root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。 | DisplayObject | ||
rotation : Number
表示 DisplayObject 实例距其原始方向的旋转程度,以度为单位。 | DisplayObject | ||
rotationX : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 x 轴旋转(以度为单位)。 | DisplayObject | ||
rotationY : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 y 轴旋转(以度为单位)。 | DisplayObject | ||
rotationZ : Number
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 z 轴旋转(以度为单位)。 | DisplayObject | ||
scale9Grid : Rectangle
当前有效的缩放网格。 | DisplayObject | ||
scaleX : Number
表示从注册点开始应用的对象的水平缩放比例(百分比)。 | DisplayObject | ||
scaleY : Number
表示从对象注册点开始应用的对象的垂直缩放比例(百分比)。 | DisplayObject | ||
scaleZ : Number
表示从对象的注册点开始应用的对象的深度缩放比例(百分比)。 | DisplayObject | ||
scrollRect : Rectangle
显示对象的滚动矩形范围。 | DisplayObject | ||
softKeyboard : String
控制软键盘的外观。 | InteractiveObject | ||
softKeyboardInputAreaOfInterest : Rectangle
定义当显示软键盘时应在屏幕上保留的区域(在 iOS 上不支持)。 | InteractiveObject | ||
soundTransform : flash.media:SoundTransform
控制此 sprite 中的声音。 | Sprite | ||
stage : Stage [只读]
显示对象的舞台。 | DisplayObject | ||
stageHeight : Number
舞台的高度,由 Preloader 类传入。 | DownloadProgressBar | ||
stageWidth : Number
舞台的宽度,由 Preloader 类传入。 | DownloadProgressBar | ||
tabChildren : Boolean
确定对象的子项是否支持 Tab 键。 | DisplayObjectContainer | ||
tabEnabled : Boolean
指定此对象是否遵循 Tab 键顺序。 | InteractiveObject | ||
tabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。 | InteractiveObject | ||
textSnapshot : flash.text:TextSnapshot [只读]
返回此 DisplayObjectContainer 实例的 TextSnapshot 对象。 | DisplayObjectContainer | ||
transform : flash.geom:Transform
一个对象,具有与显示对象的矩阵、颜色转换和像素范围有关的属性。 | DisplayObject | ||
useHandCursor : Boolean
布尔值,表示当指针滑过 buttonMode 属性设置为 true 的 sprite 时是否显示指针手形(手形光标)。 | Sprite | ||
visible : Boolean [覆盖]
指定下载进度栏是否可见。 | DownloadProgressBar | ||
width : Number
表示显示对象的宽度,以像素为单位。 | DisplayObject | ||
x : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 x 坐标。 | DisplayObject | ||
y : Number
表示 DisplayObject 实例相对于父级 DisplayObjectContainer 本地坐标的 y 坐标。 | DisplayObject | ||
z : Number
表示 DisplayObject 实例相对于 3D 父容器沿 z 轴的 z 坐标位置。 | DisplayObject |
属性 | 由以下参数定义 | ||
---|---|---|---|
barFrameRect : RoundedRectangle [只读]
进度栏边框的尺寸。 | DownloadProgressBar | ||
barRect : RoundedRectangle [只读]
进度栏的尺寸。 | DownloadProgressBar | ||
borderRect : RoundedRectangle [只读]
显示边框的尺寸。 | DownloadProgressBar | ||
downloadingLabel : String
下载阶段要显示为标签的字符串。 | DownloadProgressBar | ||
DOWNLOAD_PERCENTAGE : uint = 60
完全下载 SWF 文件时下载阶段填充的进度栏的百分比。 | DownloadProgressBar | ||
initProgressTotal : uint = 6
希望在初始化阶段获得的验证事件总数。 | DownloadProgressBar | ||
label : String
进度栏活动时要显示的文本。 | DownloadProgressBar | ||
labelFormat : flash.text:TextFormat [只读]
标签的 TextField 组件的 TextFormat 对象。 | DownloadProgressBar | ||
labelRect : Rectangle [只读]
标签 TextField 组件的尺寸。 | DownloadProgressBar | ||
MINIMUM_DISPLAY_TIME : uint = 0
显示应该可见的最小毫秒数。 | DownloadProgressBar | ||
percentFormat : flash.text:TextFormat [只读]
显示百分比的 TextField 组件的 TextFormat。 | DownloadProgressBar | ||
percentRect : Rectangle [只读]
显示百分比的 TextField 组件的尺寸。 | DownloadProgressBar | ||
showLabel : Boolean
控制是否要显示标签。是,则为 true;或者否,则为 false。 | DownloadProgressBar | ||
showPercentage : Boolean
控制是否显示百分比。是,则为 true;或者否,则为 false。 | DownloadProgressBar |
方法 | 由以下参数定义 | ||
---|---|---|---|
构造函数。 | DownloadProgressBar | ||
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | ||
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。 | EventDispatcher | ||
表示安全限制是否会导致出现以下情况:在列表中忽略了使用指定 point 点调用 DisplayObjectContainer.getObjectsUnderPoint() 方法时返回的所有显示对象。 | DisplayObjectContainer | ||
确定指定显示对象是 DisplayObjectContainer 实例的子项还是该实例本身。 | DisplayObjectContainer | ||
将事件调度到事件流中。 | EventDispatcher | ||
返回一个矩形,该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。 | DisplayObject | ||
返回位于指定索引处的子显示对象实例。 | DisplayObjectContainer | ||
返回具有指定名称的子显示对象。 | DisplayObjectContainer | ||
返回 DisplayObject 的 child 实例的索引位置。 | DisplayObjectContainer | ||
返回对象的数组,这些对象位于指定点下,并且是该 DisplayObjectContainer 实例的子项(或孙子项,依此类推)。 | DisplayObjectContainer | ||
返回一个矩形,该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界,但不包括形状上的任何笔触。 | DisplayObject | ||
将 point 对象从舞台(全局)坐标转换为显示对象的(本地)坐标。 | DisplayObject | ||
将二维点从舞台(全局)坐标转换为三维显示对象的(本地)坐标。 | DisplayObject | ||
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | ||
表示对象是否已经定义了指定的属性。 | Object | ||
计算显示对象的边框,以确定它是否与 obj 显示对象的边框重叠或相交。 | DisplayObject | ||
计算显示对象,以确定它是否与 x 和 y 参数指定的点重叠或相交。 | DisplayObject | ||
将下载进度栏添加为 Preloader 的子级后,由 Preloader 调用。 | DownloadProgressBar | ||
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
将三维显示对象的(本地)坐标的三维点转换为舞台(全局)坐标中的二维点。 | DisplayObject | ||
将 point 对象从显示对象的(本地)坐标转换为舞台(全局)坐标。 | DisplayObject | ||
表示指定的属性是否存在、是否可枚举。 | Object | ||
从 DisplayObjectContainer 实例的子列表中删除指定的 child DisplayObject 实例。 | DisplayObjectContainer | ||
从 DisplayObjectContainer 的子列表中指定的 index 位置删除子 DisplayObject。 | DisplayObjectContainer | ||
从 DisplayObjectContainer 实例的子级列表中删除所有子 DisplayObject 实例。 | DisplayObjectContainer | ||
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | ||
显示虚拟键盘。 | InteractiveObject | ||
更改现有子项在显示对象容器中的位置。 | DisplayObjectContainer | ||
设置循环操作动态属性的可用性。 | Object | ||
允许用户拖动指定的 Sprite。 | Sprite | ||
使用户可以在启用触摸的设备上拖动指定的 Sprite。 | Sprite | ||
对源起于此对象的所有 MovieClip 递归停止时间轴执行。 | DisplayObjectContainer | ||
结束 startDrag() 方法。 | Sprite | ||
结束 startTouchDrag() 方法,用于启用触摸的设备。 | Sprite | ||
交换两个指定子对象的 Z 轴顺序(从前到后顺序)。 | DisplayObjectContainer | ||
在子级列表中两个指定的索引位置,交换子对象的 Z 轴顺序(前后顺序)。 | DisplayObjectContainer | ||
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。 | Object | ||
返回指定对象的字符串表示形式。 | Object | ||
返回指定对象的原始值。 | Object | ||
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher |
方法 | 由以下参数定义 | ||
---|---|---|---|
根据传入的维度居中放置下载进度栏。 | DownloadProgressBar | ||
用于 Event.COMPLETE 事件的事件侦听器。 | DownloadProgressBar | ||
创建显示的子组件。 | DownloadProgressBar | ||
返回已下载应用程序的百分比值。 | DownloadProgressBar | ||
用于 FlexEvent.INIT_COMPLETE 事件的事件侦听器。 | DownloadProgressBar | ||
用于 FlexEvent.INIT_PROGRESS 事件的事件侦听器。 | DownloadProgressBar | ||
用于 ProgressEvent.PROGRESS 事件的事件侦听器。 | DownloadProgressBar | ||
用于 RSLEvent.RSL_COMPLETE 事件的事件侦听器。 | DownloadProgressBar | ||
用于 RSLEvent.RSL_ERROR 事件的事件侦听器。 | DownloadProgressBar | ||
用于 RSLEvent.RSL_PROGRESS 事件的事件侦听器。 | DownloadProgressBar | ||
使用当前下载信息更新下载进度栏的显示。 | DownloadProgressBar | ||
定义是否在下载阶段显示下载进度栏的算法。 | DownloadProgressBar | ||
定义确定是否在初始化阶段显示下载进度栏的算法,假设显示当前不可见。 | DownloadProgressBar |
backgroundAlpha | 属性 |
backgroundAlpha:Number
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
backgroundImage
属性定义的 SWF 文件或图像的 Alpha 级别,或者 backgroundColor
属性定义的颜色。有效值范围是 0 到 1.0。
您可以指定 backgroundColor
或 backgroundImage
,但是不能同时指定两者。
默认值为 1.0。
实现
public function get backgroundAlpha():Number
public function set backgroundAlpha(value:Number):void
backgroundColor | 属性 |
backgroundImage | 属性 |
backgroundImage:Object
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
由 Preloader 传入的应用程序的背景图像。您可以指定 backgroundColor
或 backgroundImage
,但是不能同时指定两者。
值 null 表示“未设置”。如果此样式和 backgroundColor
样式都未定义,则控件将采用透明背景。
preloader 不显示嵌入的图像。您只能使用在运行时加载的图像。
默认值为 null。
实现
public function get backgroundImage():Object
public function set backgroundImage(value:Object):void
backgroundSize | 属性 |
barFrameRect | 属性 |
barFrameRect:RoundedRectangle
[只读] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
进度栏边框的尺寸。此为只读属性,如果您需要更改,则必须覆盖该属性。
实现
protected function get barFrameRect():RoundedRectangle
barRect | 属性 |
barRect:RoundedRectangle
[只读] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
进度栏的尺寸。此为只读属性,如果您需要更改,则必须覆盖该属性。
实现
protected function get barRect():RoundedRectangle
borderRect | 属性 |
borderRect:RoundedRectangle
[只读] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示边框的尺寸。此为只读属性,如果您需要更改,则必须覆盖该属性。
实现
protected function get borderRect():RoundedRectangle
DOWNLOAD_PERCENTAGE | 属性 |
protected var DOWNLOAD_PERCENTAGE:uint = 60
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
完全下载 SWF 文件时下载阶段填充的进度栏的百分比。初始化阶段期间填充进度栏的剩余部分。此值应该介于 0 和 100 之间。
默认值为 60。
downloadingLabel | 属性 |
initializingLabel | 属性 |
initProgressTotal | 属性 |
protected var initProgressTotal:uint = 6
语言版本: | ActionScript 3.0 |
产品版本: | Flex 4 |
运行时版本: | Flash Player 9, AIR 1.1 |
希望在初始化阶段获得的验证事件总数。它应该是一个大于或等于 4 的整数(请注意,如果该数值大于 4,初始化代码中可能有无效部分)
默认值为 6。
label | 属性 |
labelFormat | 属性 |
labelFormat:flash.text:TextFormat
[只读] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
标签的 TextField 组件的 TextFormat 对象。此为只读属性,如果您需要更改,则必须覆盖该属性。
实现
protected function get labelFormat():flash.text:TextFormat
labelRect | 属性 |
MINIMUM_DISPLAY_TIME | 属性 |
protected var MINIMUM_DISPLAY_TIME:uint = 0
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示应该可见的最小毫秒数。如果应用程序的下载和初始化时间低于此值,则 Flex 在调度 complete
事件前暂停此时间总额。
默认值为 0。
percentFormat | 属性 |
percentFormat:flash.text:TextFormat
[只读] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
显示百分比的 TextField 组件的 TextFormat。此为只读属性,如果您需要更改,则必须覆盖该属性。
实现
protected function get percentFormat():flash.text:TextFormat
percentRect | 属性 |
preloader | 属性 |
showLabel | 属性 |
showPercentage | 属性 |
stageHeight | 属性 |
stageWidth | 属性 |
visible | 属性 |
visible:Boolean
[覆盖] 语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
指定下载进度栏是否可见。
当 Preloader 控件决定应该显示进度栏时,它将此值设置为 true
。当 Preloader 控件决定应该隐藏进度栏时,它将该值设置为 false
。
DownloadProgressBar 类的子类绝不应该修改此属性。相反,您可以覆盖 setter 方法来识别 Preloader 控件修改此属性的时间,并且执行任何必要的动作。
默认值为 false。
实现
override public function get visible():Boolean
override public function set visible(value:Boolean):void
DownloadProgressBar | () | 构造函数 |
public function DownloadProgressBar()
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
构造函数。
center | () | 方法 |
completeHandler | () | 方法 |
createChildren | () | 方法 |
protected function createChildren():void
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
创建显示的子组件。
getPercentLoaded | () | 方法 |
initCompleteHandler | () | 方法 |
initialize | () | 方法 |
public function initialize():void
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
将下载进度栏添加为 Preloader 的子级后,由 Preloader 调用。这应该是配置下载进度栏的起始点。
initProgressHandler | () | 方法 |
progressHandler | () | 方法 |
protected function progressHandler(event:ProgressEvent):void
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
用于 ProgressEvent.PROGRESS
事件的事件侦听器。此实现使用下载的字节百分比更新进度栏。
参数
event:ProgressEvent — 事件对象。
|
rslCompleteHandler | () | 方法 |
rslErrorHandler | () | 方法 |
rslProgressHandler | () | 方法 |
setProgress | () | 方法 |
protected function setProgress(completed:Number, total:Number):void
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
使用当前下载信息更新下载进度栏的显示。典型实现会根据总值划分加载值,并显示百分比。如果不实现此方法,则应创建显示动画的进度栏来向用户表明正在下载。
只有在从远程服务器下载应用程序并且该应用程序不在浏览器缓存中时才调用 setProgress()
方法。
参数
completed:Number — 已下载的应用程序 SWF 文件的字节数。
| |
total:Number — 应用程序 SWF 文件的大小(以字节为单位)。
|
showDisplayForDownloading | () | 方法 |
protected function showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean
语言版本: | ActionScript 3.0 |
产品版本: | Flex 3 |
运行时版本: | Flash Player 9, AIR 1.1 |
定义是否在下载阶段显示下载进度栏的算法。
参数
elapsedTime:int — 下载阶段开始后已经过的毫秒数。
| |
event:ProgressEvent — ProgressEvent 对象,包含 bytesLoaded 和 bytesTotal 属性。
|
Boolean — 如果返回值为 true ,则显示下载进度栏。默认行为是,如果已经过 700 毫秒但 Flex 已下载的 SWF 文件字节数尚未过半,则显示下载进度栏。
|
showDisplayForInit | () | 方法 |
Tue Jun 12 2018, 11:04 AM Z