fl.controls.ProgressBar - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	fl.controls
Class	public class ProgressBar
Inheritance	ProgressBar UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

The ProgressBar component displays the progress of content that is being loaded. The ProgressBar is typically used to display the status of images, as well as portions of applications, while they are loading. The loading process can be determinate or indeterminate. A determinate progress bar is a linear representation of the progress of a task over time and is used when the amount of content to load is known. An indeterminate progress bar has a striped fill and a loading source of unknown size.

View the examples

Related API Elements

ProgressBarDirection
ProgressBarMode

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		direction : String Indicates the fill direction for the progress bar.	ProgressBar
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number [override] Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		indeterminate : Boolean Gets or sets a value that indicates the type of fill that the progress bar uses and whether the loading source is known or unknown.	ProgressBar
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		maximum : Number Gets or sets the maximum value for the progress bar when the ProgressBar.mode property is set to ProgressBarMode.MANUAL.	ProgressBar
		minimum : Number Gets or sets the minimum value for the progress bar when the ProgressBar.mode property is set to ProgressBarMode.MANUAL.	ProgressBar
		mode : String Gets or sets the method to be used to update the progress bar.	ProgressBar
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		percentComplete : Number [read-only] Gets a number between 0 and 100 that indicates the percentage of the content has already loaded.	ProgressBar
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number [override] Multiplies the current height of the component by a scale factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed.	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		source : Object Gets or sets a reference to the content that is being loaded and for which the ProgressBar is measuring the progress of the load operation.	ProgressBar
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.	Sprite
		value : Number Gets or sets a value that indicates the amount of progress that has been made in the load operation.	ProgressBar
		visible : Boolean [override] Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number [override] Gets or sets the width of the component, in pixels.	UIComponent
		x : Number [override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number [override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ProgressBar() Creates a new ProgressBar component instance.	ProgressBar
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	ProgressBar
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes one or more child DisplayObject instances from the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		reset():void Resets the progress bar for a new load operation.	ProgressBar
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setProgress(value:Number, maximum:Number):void Sets the state of the bar to reflect the amount of progress made when using manual mode.	ProgressBar
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSize(width:Number, height:Number):void Sets the component to the specified width and height.	UIComponent
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level.	UIComponent

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
complete	Dispatched when the load operation completes.	ProgressBar
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gesturePan	Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gesturePressAndTap	Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureRotate	Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureSwipe	Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureTwoFingerTap	Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
gestureZoom	Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
move	Dispatched after the component is moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
progress	Dispatched as content loads in event mode or polled mode.	ProgressBar
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOver	Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched after the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
selectAll	Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
touchBegin	Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).	InteractiveObject
touchEnd	Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).	InteractiveObject
touchMove	Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).	InteractiveObject
touchOut	Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).	InteractiveObject
touchOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOut	Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchRollOver	Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject
touchTap	Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).	InteractiveObject

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
barPadding	Type: Number Format: Length The padding that separates the progress bar indicator from the track, in pixels. The default value is `0`.	ProgressBar
barSkin	Type: Class Name of the class to use as the determinate progress bar. The default value is `ProgressBar_barSkin`.	ProgressBar
disabledTextFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled.	UIComponent
focusRectPadding	Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.	UIComponent
focusRectSkin	Type: Class The skin to be used to display focus indicators.	UIComponent
icon	Type: Class Name of the class to use as the default icon. Setting any other icon style overrides this setting. The default value is `null`.	ProgressBar
indeterminateBar	Type: Class The class to use as a renderer for the indeterminate bar animation. This is an advanced style. The default value is `fl.controls.progressBarClasses.IndeterminateBar`.	ProgressBar
indeterminateSkin	Type: Class Name of the class to use as the indeterminate progress bar. This is passed to the indeterminate bar renderer, which is specified by the `indeterminateBar` style. The default value is `ProgressBar_indeterminateSkin`.	ProgressBar
textFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label.	UIComponent
trackSkin	Type: Class Name of the class to use as the progress indicator track. The default value is `ProgressBar_trackSkin`.	ProgressBar

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		version : String = "3.0.3.1" The version number of the components.	UIComponent

Property Detail

direction

property

direction:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Indicates the fill direction for the progress bar. A value of ProgressBarDirection.RIGHT indicates that the progress bar is filled from left to right. A value of ProgressBarDirection.LEFT indicates that the progress bar is filled from right to left.

The default value is ProgressBarDirection.RIGHT.

Implementation
public function get direction():String
public function set direction(value:String):void

Related API Elements

ProgressBarDirection

Example ( How to use this example )

The following example displays the difference between a progress bar that loads from the left and a progress bar that loads from the right. Replace testPath with a large file in order to test locally:

 
import fl.controls.ProgressBar;
import fl.controls.ProgressBarDirection;

var testPath:String = "largeVideo.flv";
var loader:URLLoader = new URLLoader();
loader.load(new URLRequest(testPath));

var leftProgressBar:ProgressBar = new ProgressBar();
leftProgressBar.move(10,10);
leftProgressBar.direction = ProgressBarDirection.LEFT;
leftProgressBar.source = loader;
addChild(leftProgressBar);

var rightProgressBar:ProgressBar = new ProgressBar();
rightProgressBar.move(10,40);
rightProgressBar.source = loader;
rightProgressBar.direction = ProgressBarDirection.RIGHT;
addChild(rightProgressBar);

indeterminate

property

indeterminate:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that indicates the type of fill that the progress bar uses and whether the loading source is known or unknown. A value of true indicates that the progress bar has a striped fill and a loading source of unknown size. A value of false indicates that the progress bar has a solid fill and a loading source of known size.

This property can only be set when the progress bar mode is set to ProgressBarMode.MANUAL.

The default value is true.

Implementation
public function get indeterminate():Boolean
public function set indeterminate(value:Boolean):void

Related API Elements

mode
ProgressBarMode
IndeterminateBar

maximum

property

maximum:Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the maximum value for the progress bar when the ProgressBar.mode property is set to ProgressBarMode.MANUAL.

The default value is 0.

Implementation
public function get maximum():Number
public function set maximum(value:Number):void

Related API Elements

minimum
percentComplete
value
ProgressBarMode.MANUAL

minimum

property

minimum:Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the minimum value for the progress bar when the ProgressBar.mode property is set to ProgressBarMode.MANUAL.

The default value is 0.

Implementation
public function get minimum():Number
public function set minimum(value:Number):void

Related API Elements

maximum
percentComplete
value
ProgressBarMode.MANUAL

mode

property

mode:String

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets the method to be used to update the progress bar.

The following values are valid for this property:

ProgressBarMode.EVENT
ProgressBarMode.POLLED
ProgressBarMode.MANUAL

Event mode and polled mode are the most common modes. In event mode, the source property specifies loading content that generates progress and complete events; you should use a UILoader object in this mode. In polled mode, the source property specifies loading content, such as a custom class, that exposes bytesLoaded and bytesTotal properties. Any object that exposes these properties can be used as a source in polled mode.

You can also use the ProgressBar component in manual mode by manually setting the maximum and minimum properties and making calls to the ProgressBar.setProgress() method.

The default value is ProgressBarMode.EVENT.

Implementation
public function get mode():String
public function set mode(value:String):void

Related API Elements

ProgressBarMode

percentComplete

property

percentComplete:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets a number between 0 and 100 that indicates the percentage of the content has already loaded.

To change the percentage value, use the setProgress() method.

The default value is 0.

Implementation
public function get percentComplete():Number

Related API Elements

maximum
minimum
setProgress()
value

Example ( How to use this example )

The following example creates ProgressBar and Label component instances to display the progress bar's status:


import fl.controls.Label;
import fl.controls.ProgressBar;
import fl.controls.ProgressBarMode;

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.indeterminate = false;
myProgressBar.mode = ProgressBarMode.MANUAL;
myProgressBar.maximum = 256;
myProgressBar.setSize(320, 16);
myProgressBar.move(10, 10)
addChild(myProgressBar);

var myLabel:Label = new Label();
myLabel.text = "";
myLabel.autoSize = TextFieldAutoSize.LEFT;
myLabel.move(myProgressBar.x, myProgressBar.y + myProgressBar.height);
addChild(myLabel);

var t:Timer = new Timer(150);
t.addEventListener(TimerEvent.TIMER, timerHandler);
t.start();

function timerHandler(event:TimerEvent):void {
    myProgressBar.setProgress(myProgressBar.value + 1, myProgressBar.maximum);
    if (myProgressBar.percentComplete == 100) {
        myProgressBar.setProgress(0, myProgressBar.maximum);
    }
    myLabel.text = int(myProgressBar.value) + " of " + int(myProgressBar.maximum) + " (" + int(myProgressBar.percentComplete) + "%)";
}

The following example demonstrates how to monitor load progress by accessing the percentLoaded property. The dataPath variable must first be set to a remote file:

import fl.controls.ProgressBar;
import fl.controls.Label

var dataPath:String = "test.txt";
var loader:URLLoader = new URLLoader();
loader.load(new URLRequest(dataPath));

var progressReport:Label = new Label();
progressReport.move(10,30);
progressReport.autoSize = TextFieldAutoSize.LEFT;
addChild(progressReport);

var pb:ProgressBar = new ProgressBar();
pb.move(10,10);
pb.source = loader;
pb.addEventListener(ProgressEvent.PROGRESS,updateProgressReport);
addChild(pb);

function updateProgressReport(e:ProgressEvent):void {
    progressReport.text = Math.round(pb.percentComplete) + "% Loaded";
}

source

property

source:Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a reference to the content that is being loaded and for which the ProgressBar is measuring the progress of the load operation. A typical usage of this property is to set it to a UILoader component.

Use this property only in event mode and polled mode.

The default value is null.

Implementation
public function get source():Object
public function set source(value:Object):void

Example ( How to use this example )

The following example demonstrates how to link a progress bar to a loader by setting the source property. In order for the the progress bar to show loading progress, the dataPath variable must first be set to a remote file:

import fl.controls.ProgressBar;

var dataPath:String = "test.txt";
var loader:URLLoader = new URLLoader();
loader.load(new URLRequest(dataPath));

var pb:ProgressBar = new ProgressBar();
pb.source = loader;
addChild(pb);

The following example sets the source property for a progress bar to a scroll pane:


import fl.containers.ScrollPane;
import fl.controls.ProgressBar;

var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.setSize(320, 240);
myScrollPane.move(10, 10);
myScrollPane.source = "http://www.helpexamples.com/flash/images/image3.jpg";
addChild(myScrollPane);

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.width = myScrollPane.width;
myProgressBar.move(myScrollPane.x, myScrollPane.y - myProgressBar.height);
myProgressBar.source = myScrollPane;
addChild(myProgressBar);

value

property

value:Number

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that indicates the amount of progress that has been made in the load operation. This value is a number between the minimum and maximum values.

The default value is 0.

Implementation
public function get value():Number
public function set value(value:Number):void

Related API Elements

maximum
minimum
percentComplete

Constructor Detail

ProgressBar

()

Constructor

public function ProgressBar()

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates a new ProgressBar component instance.

Method Detail

getStyleDefinition

()

method

public static function getStyleDefinition():Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns

Object — Default styles object.

Related API Elements

fl.core.UIComponent.getStyle()
fl.core.UIComponent.setStyle()
fl.managers.StyleManager

Example ( How to use this example )

The following example creates a style browser for several component classes:

import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}

reset

()

method

public function reset():void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Resets the progress bar for a new load operation.

setProgress

()

method

public function setProgress(value:Number, maximum:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Sets the state of the bar to reflect the amount of progress made when using manual mode. The value argument is assigned to the value property and the maximum argument is assigned to the maximum property. The minimum property is not altered.

Parameters

	`value:Number` — A value describing the progress that has been made.

	`maximum:Number` — The maximum progress value of the progress bar.

Related API Elements

maximum
value
ProgressBarMode.manual

Event Detail

complete

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event.COMPLETE

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Dispatched when the load operation completes.

The Event.COMPLETE constant defines the value of the type property of a complete event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The network object that has completed loading.

Example ( How to use this example )

The following example loads an external image using a UILoader component and when the image has finished loading hides a ProgressBar and Label component:


import fl.containers.UILoader;
import fl.controls.Label;
import fl.controls.ProgressBar;

var url:String = "http://www.helpexamples.com/flash/images/image1.jpg";

var myUILoader:UILoader = new UILoader();
myUILoader.autoLoad = false;
myUILoader.source = url;
myUILoader.move(10, 10);
myUILoader.scaleContent = false;
myUILoader.load();

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.source = myUILoader;
myProgressBar.move(myUILoader.x, myUILoader.y);
myProgressBar.addEventListener(ProgressEvent.PROGRESS, progressHandler);
myProgressBar.addEventListener(Event.COMPLETE, completeHandler);
addChild(myProgressBar)

var myLabel:Label = new Label();
myLabel.text = "xx";
myLabel.autoSize = TextFieldAutoSize.LEFT;
myLabel.move(myProgressBar.x, myProgressBar.y + myProgressBar.height);
addChild(myLabel);

function progressHandler(event:ProgressEvent):void {
    trace("progress:", event.bytesLoaded, event.bytesTotal, int(event.currentTarget.percentComplete) + "%");
    myLabel.text = event.bytesLoaded + " of " + event.bytesTotal + " bytes loaded.";
}

function completeHandler(event:Event):void {
    trace("complete:");
    myProgressBar.removeEventListener(ProgressEvent.PROGRESS, progressHandler);
    myProgressBar.removeEventListener(Event.COMPLETE, completeHandler);
    removeChild(myProgressBar);
    removeChild(myLabel);
    
    addChild(myUILoader);
}

progress

Event

Event Object Type: flash.events.ProgressEvent
property ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Dispatched as content loads in event mode or polled mode.

Defines the value of the type property of a progress event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`bytesLoaded`	The number of items or bytes loaded at the time the listener processes the event.
`bytesTotal`	The total number of items or bytes that ultimately will be loaded if the loading process succeeds.
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object reporting progress.

Example ( How to use this example )

The following example loads an external image using a UILoader component and when the image has finished loading hides a ProgressBar and Label component:


import fl.containers.UILoader;
import fl.controls.Label;
import fl.controls.ProgressBar;

var url:String = "http://www.helpexamples.com/flash/images/image1.jpg";

var myUILoader:UILoader = new UILoader();
myUILoader.autoLoad = false;
myUILoader.source = url;
myUILoader.move(10, 10);
myUILoader.scaleContent = false;
myUILoader.load();

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.source = myUILoader;
myProgressBar.move(myUILoader.x, myUILoader.y);
myProgressBar.addEventListener(ProgressEvent.PROGRESS, progressHandler);
myProgressBar.addEventListener(Event.COMPLETE, completeHandler);
addChild(myProgressBar)

var myLabel:Label = new Label();
myLabel.text = "xx";
myLabel.autoSize = TextFieldAutoSize.LEFT;
myLabel.move(myProgressBar.x, myProgressBar.y + myProgressBar.height);
addChild(myLabel);

function progressHandler(event:ProgressEvent):void {
    trace("progress:", event.bytesLoaded, event.bytesTotal, int(event.currentTarget.percentComplete) + "%");
    myLabel.text = event.bytesLoaded + " of " + event.bytesTotal + " bytes loaded.";
}

function completeHandler(event:Event):void {
    trace("complete:");
    myProgressBar.removeEventListener(ProgressEvent.PROGRESS, progressHandler);
    myProgressBar.removeEventListener(Event.COMPLETE, completeHandler);
    removeChild(myProgressBar);
    removeChild(myLabel);
    
    addChild(myUILoader);
}

Related API Elements

ProgressBarMode.EVENT
ProgressBarMode.POLLED

Examples How to use this example

ProgressBarExample.as

This example demonstrates how to manually increment a ProgressBar

Add the ProgressBar, Label, and Button components to your library.
Save this code as ProgressBarExample.as in the same directory as your FLA.
Set the DocumentClass in the FLA to ProgressBarExample.

package
{
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import fl.controls.ProgressBar;
    import fl.controls.ProgressBarMode;
    import fl.controls.Button;
    
    public class ProgressBarExample extends Sprite
    {
        private var j:uint;
        private var pb:ProgressBar;
        private var fakeProgressCount:uint;
        
        public function ProgressBarExample() {
            setupProgressBar();    
            setupButton();
        }
        private function advancePreloader(e:MouseEvent):void {
            fakeProgressCount = fakeProgressCount == 100 ? 0 : fakeProgressCount + 10;
            pb.setProgress(fakeProgressCount, 100);
        }
        private function setupButton():void {
            var b:Button = new Button();
            b.move(10,30);
            b.setSize(120,20);
            b.label = "Increment Progress";
            b.addEventListener(MouseEvent.CLICK,advancePreloader);
            addChild(b);
        }
        private function setupProgressBar():void {
            fakeProgressCount = 0;
            pb = new ProgressBar();
            pb.mode = ProgressBarMode.MANUAL;
            pb.move(10,10);
            addChild(pb);
        }
    }
}

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

direction

indeterminate

maximum

minimum

mode

percentComplete

source

value

ProgressBar

getStyleDefinition

reset

setProgress

complete

progress