ProgressBar

Kind of class:class
Inherits from:UIObject < MovieClip
Classpath:mx.controls.ProgressBar
File last modified:Tuesday, 18 December 2007, 15:44:37
Component metadata:
    Event
    "complete"

    Summary


    Constructor
    Class properties
    Class properties inherited from UIObject
    symbolName symbolOwner textColorList version
    Instance properties
    Instance properties inherited from UIObject
    __height __onUnload __width _color _endInit _id _maxHeight _maxWidth _minHeight _minWidth _preferredHeight _preferredWidth _tf _topmost addEventListener bottom buildDepthTable changeColorStyleInChildren changeTextStyleInChildren childrenCreated className clipParameters color createAccessibilityImplementation createChildAtDepth createClassChildAtDepth createEvent dispatchEvent embedFonts findNextAvailableDepth fontFamily fontSize fontStyle fontWeight handleEvent height idNames ignoreClassStyleDeclaration initProperties invalidateFlag left lineColor lineWidth marginLeft marginRight methodTable minHeight minWidth notifyStyleChangeInChildren removeEventListener right scaleX scaleY setStyle stylecache styleName tabEnabled textAlign textDecoration textIndent tfList top validateNow visible width x y
    Class methods
    Class methods inherited from UIObject
    mergeClipParameters
    Instance methods
    Instance methods inherited from 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 move redraw setColor setMinHeight setMinWidth setSize setSkin setVisible size

    Constructor

    ProgressBar

    function ProgressBar (
    )

    Constructor

    Class properties

    mergedClipParameters

    static mergedClipParameters:Boolean = UIObject.mergeClipParameters(ProgressBar.prototype.clipParameters, UIObject.prototype.clipParameters)
    (read)

    symbolName

    static symbolName:String = "ProgressBar"
    (read)

    symbolOwner

    static symbolOwner:Object = Object(mx.controls.ProgressBar)
    (read)

    version

    static version:String = "2.0.2.127"
    (read)

    Instance properties

    __conversion

    __conversion:Number = 1
    (read)

    __direction

    __direction:String = "right"
    (read)

    __indeterminate

    __indeterminate:Boolean = false
    (read)

    __indValue

    __indValue:Number
    (read)

    __interval

    __interval:Number = 30
    (read)

    __label

    __label:String = "LOADING %3%% "
    (read)

    __labelPlacement

    __labelPlacement:String = "bottom"
    (read)

    __leave

    __leave:Number = 2
    (read)

    __maximum

    __maximum:Number = 0
    (read)

    __minimum

    __minimum:Number = 0
    (read)

    __mode

    __mode:String = "event"
    (read)

    __source

    __source:Object
    (read)

    __stringSource

    __stringSource:String
    (read)

    __value

    __value:Number = 0
    (read)

    boundingBox_mc

    boundingBox_mc:Object
    (read)

    className

    className:String = "ProgressBar"
    (read)

    name of this class

    clipParameters

    clipParameters:Object = {mode: 1, source: 1, direction: 1, label: 1, labelPlacement: 1, conversion: 1}
    (read)

    conversion

    conversion:Number
    (read,write)

    conversion factor

    direction

    direction:String
    (read,write)

    direction of fill

    idNames

    idNames:Array = new Array("progTrackLeft_mc", "progTrackMiddle_mc", "progTrackRight_mc", "progBarLeft_mc", "progBarMiddle_mc", "progBarRight_mc", "progIndBar_mc")
    (read)

    indeterminate

    indeterminate:Boolean
    (read,write)

    indeterminate status

    label

    label:String
    (read,write)

    label text

    labelPath

    labelPath:Object
    (read)

    labelPlacement

    labelPlacement:String
    (read,write)

    label placement

    mask_mc

    mask_mc:Object
    (read)

    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)

    percentage of progress
    Read-Only: use setProgress() to change.
    Component metadata:
      Bindable
      "readonly"
      ChangeEvent
      "progress"

      progBarLeft_mc

      progBarLeft_mc:Object
      (read)

      progBarLeftName

      progBarLeftName:String = "ProgBarLeft"
      (read)

      progBarMiddle_mc

      progBarMiddle_mc:Object
      (read)

      progBarMiddleName

      progBarMiddleName:String = "ProgBarMiddle"
      (read)

      progBarRight_mc

      progBarRight_mc:Object
      (read)

      progBarRightName

      progBarRightName:String = "ProgBarRight"
      (read)

      progIndBar_mc

      progIndBar_mc:Object
      (read)

      progIndBarName

      progIndBarName:String = "ProgIndBar"
      (read)

      progTrackLeft_mc

      progTrackLeft_mc:Object
      (read)

      progTrackLeftName

      progTrackLeftName:String = "ProgTrackLeft"
      (read)

      progTrackMiddle_mc

      progTrackMiddle_mc:Object
      (read)

      progTrackMiddleName

      progTrackMiddleName:String = "ProgTrackMiddle"
      (read)

      progTrackRight_mc

      progTrackRight_mc:Object
      (read)

      progTrackRightName

      progTrackRightName:String = "ProgTrackRight"
      (read)

      si

      si
      (read)

      skinIDLabel

      skinIDLabel:Number = 200
      (read)

      skinIDMask

      skinIDMask:Number = 100
      (read)

      skinIDProgBarLeft

      skinIDProgBarLeft:Number = 3
      (read)

      skinIDProgBarMiddle

      skinIDProgBarMiddle:Number = 4
      (read)

      skinIDProgBarRight

      skinIDProgBarRight:Number = 5
      (read)

      skinIDProgIndBar

      skinIDProgIndBar:Number = 6
      (read)

      skinIDProgTrackLeft

      skinIDProgTrackLeft:Number = 0
      (read)

      skinIDProgTrackMiddle

      skinIDProgTrackMiddle:Number = 1
      (read)

      skinIDProgTrackRight

      skinIDProgTrackRight:Number = 2
      (read)

      source

      source
      (read,write)

      ProgressBar source object

      value

      value:Number
      (read)

      current value.
      Component metadata:
        Bindable
        "readonly"
        ChangeEvent
        "progress"

        Instance methods

        _setProgress

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

        Parameters:
        Number:
        current value
        Number:
        total value
        private method to change the value and the maximum properties

        complete

        function complete (
        pEvent) : Void

        Parameters:
        Untyped:
        complete Event object
        complete event handler for event mode

        createChildren

        function createChildren (
        Void) : Void

        Overrides:

        draw

        function draw (
        Void) : Void

        Overrides:

        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:

        progress

        function progress (
        pEvent) : Void

        Parameters:
        Untyped:
        progress Event object
        progress event handler for event mode

        replace

        function replace (
        str:String, from:String, to:String) : String

        setConversion

        function setConversion (
        val:Number) : Void

        Parameters:
        Number:
        new value for conversion property
        This is called whenever the component's conversion factor changes.

        setDirection

        function setDirection (
        val:String) : Void

        Parameters:
        String:
        new ProgressBar direction
        This is called whenever the component's direction of fill changes.

        setIndeterminate

        function setIndeterminate (
        val:Boolean) : Void

        Parameters:
        Boolean:
        new value for indeterminate flag
        This is called whenever the component's indeterminate status changes.

        setLabel

        function setLabel (
        val:String) : Void

        Parameters:
        String:
        new value for ProgressBar Label
        This is called whenever the component's label changes.

        setLabelPlacement

        function setLabelPlacement (
        val:String) : Void

        Parameters:
        String:
        new label placement for ProgressBar
        This is called whenever the component's placement of label changes.

        setMaximum

        function setMaximum (
        val:Number) : Void

        Parameters:
        Number:
        new maximum value
        This is called whenever the maximum value changes.

        setMinimum

        function setMinimum (
        val:Number) : Void

        Parameters:
        Number:
        new minimum value
        This is called whenever the minimum value changes.

        setMode

        function setMode (
        val:String) : Void

        Parameters:
        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:
        Number:
        current value
        Number:
        total value
        method to change the value and the maximum properties in the manual mode

        setSource

        function setSource (
        val) : Void

        Parameters:
        Untyped:
        new value for Source
        This is called whenever the ProgressBar source changes.

        size

        function size (
        Void) : Void

        Overrides:

        update

        function update (
        Void) : Void