Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
mx.controls

class ProgressBar

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.controls.ProgressBar

class ProgressBar
extends UIObject

The class for handling ProgressBar functionality.


Field Summary

static
mergedClipParameters: Boolean
space in the end is required for replace() to work properly.

static
symbolName: String


static
symbolOwner: Object


static
version: String
name of this class Version string Copyright (C) 2003 Macromedia, Inc.

Fields inherited from class mx.core.UIObject

__height, __width, _color, _topmost, addEventListener, buildDepthTable, changeColorStyleInChildren, changeTextStyleInChildren, childrenCreated, className, clipParameters, color, createAccessibilityImplementation, createChildAtDepth, createEvent, ction, dispatchEvent, embedFonts, findNextAvailableDepth, fontFamily, fontSize, fontStyle, fontWeight, handleEvent, idNames, ignoreClassStyleDeclaration, initProperties, marginLeft, marginRight, methodTable, notifyStyleChangeInChildren, removeEventListener, setStyle, stylecache, styleName, symbolName, symbolOwner, textAlign, textColorList, textDecoration, textIndent, validateNow, version

Fields inherited from class MovieClip

_alpha, _currentframe, _droptarget, _focusrect, _framesloaded, _height, _lockroot, _name, _parent, _quality, _rotation, _soundbuftime, _target, _totalframes, _url, _visible, _width, _x, _xmouse, _xscale, _y, _ymouse, _yscale, enabled, focusEnabled, hitArea, tabChildren, tabEnabled, tabIndex, tooltipText, trackAsMenu, useHandCursor

Fields inherited from class Object

__proto__, constructor, prototype

Property Summary


conversion: Number (read, write)
conversion factor


direction: String (read, write)
direction of fill


indeterminate: Boolean (read, write)
indeterminate status


label: String (read, write)
important to keep space in the end, else replace() method has problemslabel text


labelPlacement: String (read, write)
label placement


maximum: Number (read, write)
maximum value.


minimum: Number (read, write)
minimum value.


mode: String (read, write)
mode of operation


percentComplete: Number (read-only)
percentage of progress Read-Only: use setProgress() to change.


source (read, write)
ProgressBar source object


value: Number (read-only)
current value.

Properties inherited from class mx.core.UIObject

bottom, height, left, minHeight, minWidth, right, scaleX, scaleY, top, visible, width, x, y

Constructor


ProgressBar ( )
Constructor

Method Summary


_setProgress ( completed: Number, total: Number ): Void



complete ( pEvent ): Void



createChildren ( Void ): Void



draw ( Void ): Void



getConversion ( Void ): Number



getDirection ( Void ): String



getIndeterminate ( Void ): Boolean



getLabel ( Void ): String



getLabelPlacement ( Void ): String



getMaximum ( Void ): Number



getMinimum ( Void ): Number



getMode ( Void ): String



getPercentComplete ( Void ): Number



getSource ( Void )



getVal ( Void ): Number



init ( Void ): Void



progress ( pEvent ): Void



replace ( str: String, from: String, to: String ): String
replaces the from string to to string and returns the modified


setConversion ( val: Number ): Void



setDirection ( val: String ): Void



setIndeterminate ( val: Boolean ): Void



setLabel ( val: String ): Void



setLabelPlacement ( val: String ): Void



setMaximum ( val: Number ): Void



setMinimum ( val: Number ): Void



setMode ( val: String ): Void



setProgress ( completed: Number, total: Number ): Void



setSource ( val ): Void



size ( Void ): Void



update ( Void ): Void


Methods inherited from class mx.core.UIObject

__getTextFormat, _createChildren, _getTextFormat, cancelAllDoLaters, constructObject, createChildren, createClassObject, createEmptyObject, createLabel, createObject, createSkin, destroyObject, doLater, doLaterDispatcher, draw, drawRect, getClassStyleDeclaration, getMinHeight, getMinWidth, getSkinIDName, getStyle, getStyleName, init, initFromClipParameters, invalidate, invalidateStyle, mergeClipParameters, move, redraw, setColor, setMinHeight, setMinWidth, setSize, setSkin, setVisible, size

Methods inherited from class MovieClip

attachAudio, attachMovie, beginFill, beginGradientFill, clear, createEmptyMovieClip, createTextField, curveTo, duplicateMovieClip, endFill, getBounds, getBytesLoaded, getBytesTotal, getDepth, getInstanceAtDepth, getNextHighestDepth, getSWFVersion, getTextSnapshot, getURL, globalToLocal, gotoAndPlay, gotoAndStop, hitTest, lineStyle, lineTo, loadMovie, loadVariables, localToGlobal, moveTo, nextFrame, onData, onDragOut, onDragOver, onEnterFrame, onKeyDown, onKeyUp, onKillFocus, onLoad, onMouseDown, onMouseMove, onMouseUp, onPress, onRelease, onReleaseOutside, onRollOut, onRollOver, onSetFocus, onUnload, play, prevFrame, removeMovieClip, setMask, startDrag, stop, stopDrag, swapDepths, unloadMovie, valueOf

Methods inherited from class Object

addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toLocaleString, toString, unwatch, valueOf, watch


Field Documentation

mergedClipParameters

static var mergedClipParameters: Boolean
space in the end is required for replace() to work properly.

symbolName

static var symbolName: String

symbolOwner

static var symbolOwner: Object

version

static var version: String
name of this class Version string Copyright (C) 2003 Macromedia, Inc.

All Rights Reserved. The following is Sample Code and is subject to all restrictions on such code as contained in the End User License Agreement accompanying this product.

Property Documentation

conversion

conversion: Number (read, write)
conversion factor

direction

direction: String (read, write)
direction of fill

indeterminate

indeterminate: Boolean (read, write)
indeterminate status

label

label: String (read, write)
important to keep space in the end, else replace() method has problemslabel text

labelPlacement

labelPlacement: String (read, write)
label placement

maximum

maximum: Number (read, write)
maximum value.

minimum

minimum: Number (read, write)
minimum value.

mode

mode: String (read, write)
mode of operation

percentComplete

percentComplete: Number (read-only)
percentage of progress Read-Only: use setProgress() to change.

source

source (read, write)
ProgressBar source object

value

value: Number (read-only)
current value.

Constructor Documentation

ProgressBar

function ProgressBar()
Constructor

Method Documentation

_setProgress

function _setProgress(completed: Number,
 total: Number): Void
Parameters:
completed
Number current value
total
Number total value private method to change the value and the maximum properties

complete

function complete(pEvent): Void
Parameters:
pEvent
Untyped complete Event object complete event handler for event mode

createChildren

function createChildren(Void): Void
Overrides:
mx.core.UIObject.createChildren in class mx.core.UIObject

draw

function draw(Void): Void
Overrides:
mx.core.UIObject.draw in class mx.core.UIObject

getConversion

function getConversion(Void): Number
Returns:
Number conversion factor

getDirection

function getDirection(Void): String
Returns:
String direction of fill

getIndeterminate

function getIndeterminate(Void): Boolean
Returns:
Boolean indeterminate status

getLabel

function getLabel(Void): String
Returns:
String label

getLabelPlacement

function getLabelPlacement(Void): String
Returns:
String label placement

getMaximum

function getMaximum(Void): Number
Returns:
Number maximum value

getMinimum

function getMinimum(Void): Number
Returns:
Number minimum value

getMode

function getMode(Void): String
Returns:
String The mode of operation

getPercentComplete

function getPercentComplete(Void): Number
Returns:
Number percentage of progress made

getSource

function getSource(Void)
Returns:
source

getVal

function getVal(Void): Number
Returns:
Number current value

init

function init(Void): Void
Overrides:
mx.core.UIObject.init in class mx.core.UIObject

progress

function progress(pEvent): Void
Parameters:
pEvent
Untyped progress Event object progress event handler for event mode

replace

function replace(str: String,
 from: String,
 to: String): String
replaces the from string to to string and returns the modified

setConversion

function setConversion(val: Number): Void
Parameters:
val
Number new value for conversion property This is called whenever the component's conversion factor changes.

setDirection

function setDirection(val: String): Void
Parameters:
val
String new ProgressBar direction This is called whenever the component's direction of fill changes.

setIndeterminate

function setIndeterminate(val: Boolean): Void
Parameters:
val
Boolean new value for indeterminate flag This is called whenever the component's indeterminate status changes.

setLabel

function setLabel(val: String): Void
Parameters:
val
String new value for ProgressBar Label This is called whenever the component's label changes.

setLabelPlacement

function setLabelPlacement(val: String): Void
Parameters:
val
String new label placement for ProgressBar This is called whenever the component's placement of label changes.

setMaximum

function setMaximum(val: Number): Void
Parameters:
val
Number new maximum value This is called whenever the maximum value changes.

setMinimum

function setMinimum(val: Number): Void
Parameters:
val
Number new minimum value This is called whenever the minimum value changes.

setMode

function setMode(val: String): Void
Parameters:
val
String new mode of operation This is called whenever the component's mode of operation changes.

setProgress

function setProgress(completed: Number,
 total: Number): Void
Parameters:
completed
Number current value
total
Number total value method to change the value and the maximum properties in the manual mode

setSource

function setSource(val): Void
Parameters:
val
Untyped new value for Source This is called whenever the ProgressBar source changes.

size

function size(Void): Void
Overrides:
mx.core.UIObject.size in class mx.core.UIObject

update

function update(Void): Void

The documentation was generated from the following file:

Copyright © 1997-2005 Macromedia, Inc. All rights reserved. Generated with AS2Doc