ProgressBar class

Inheritance MovieClip > UIObject class > ProgressBar

ActionScript Class Name mx.controls.ProgressBar

Setting a property of the ProgressBar class with ActionScript overrides the parameter of the same name set in the Property inspector or Component inspector.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.ProgressBar.version);

NOTE

The code trace(myProgressBarInstance.version); returns undefined.

Method summary for the ProgressBar class

The following table lists the method of the ProgressBar class.

Method	Description
ProgressBar.setProgress()	Sets the state of the progress bar to reflect the amount of progress made when the progress bar is in manual mode

Methods inherited from the UIObject class

The following table lists the methods the ProgressBar class inherits from the UIObject class. When calling these methods from the ProgressBar object, use the form ProgressBar.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Property summary for the ProgressBar class

The following table lists properties of the ProgressBar class.

Property	Description
ProgressBar.conversion	A number used to convert the current bytes loaded value and the total bytes loaded values.
ProgressBar.direction	The direction in which the progress bar fills.
ProgressBar.indeterminate	Indicates whether the size of the loading source is unknown.
ProgressBar.label	The text that accompanies the progress bar.
ProgressBar.labelPlacement	The location of the label in relation to the progress bar.
ProgressBar.maximum	The maximum value of the progress bar in manual mode.
ProgressBar.minimum	The minimum value of the progress bar in manual mode.
ProgressBar.mode	The mode in which the progress bar loads content.
ProgressBar.percentComplete	Read-only; a number indicating the percent loaded.
ProgressBar.source	The content to load.
ProgressBar.value	Read-only; indicates the amount of progress that has been made.

Properties inherited from the UIObject class

The following table lists the properties the ProgressBar class inherits from the UIObject class. When calling these properties from the ProgressBar object, use the form ProgressBar.propertyName.

Property	Description
UIObject.bottom	The position of the bottom edge of the object, relative to the bottom edge of its parent. Read-only.
UIObject.height	The height of the object, in pixels. Read-only.
UIObject.left	The left edge of the object, in pixels. Read-only.
UIObject.right	The position of the right edge of the object, relative to the right edge of its parent. Read-only.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	The position of the top edge of the object, relative to its parent. Read-only.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	The width of the object, in pixels. Read-only.
UIObject.x	The left edge of the object, in pixels. Read-only.
UIObject.y	The top edge of the object, in pixels. Read-only.

Event summary for the ProgressBar class

The following table lists events of the ProgressBar class.

Event	Description
ProgressBar.complete	Triggered when loading is complete.
ProgressBar.progress	Triggered as content loads in manual or polled mode.

Events inherited from the UIObject class

The following table lists the events the ProgressBar class inherits from the UIObject class. When calling these events from the ProgressBar object, use the form ProgressBar.eventName.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Version 8

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00003900.html