qnx.fuse.ui.progress.PercentageBar

PercentageBar

Properties | Methods | Examples


Packageqnx.fuse.ui.progress
Classpublic class PercentageBar
InheritancePercentageBar Inheritance ProgressBar Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip

The PercentageBar class shows activity progress by percentage.

A percentage bar.

The PercentageBar class extends the ProgressBar class to provide a text label that outputs the current percentage value.



Class information:
PlayBook Tablet OS Version:   1.0.6

View the examples

See also

ProgressBar
ActivityIndicator



Public Properties

 PropertyDefined By
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
  label : String
Sets the label for the progress value.
PercentageBar
 InheritedlayoutData : Object
Returns the layout data for the object.
UIComponent
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
 Inheritedprogress : Number
Gets or sets the current progress value as indicated by the progress bar.
ProgressBar
  showPercent : Boolean
A Boolean that toggles the percentage value label.
PercentageBar
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent

Public Methods

 MethodDefined By
  
Creates a new ProgressBar instance.
PercentageBar
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSkin(newSkin:Object):void
[override] Set the skin object on the progress bar for it to render.
ProgressBar
  
setTextFormat(format:TextFormat):void
Set the TextFormat for the item.
PercentageBar
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent
 Inherited
updateSkin(unscaledWidth:Number, unscaledHeight:Number):void
Updates the skin.
SkinnableComponent

Property Detail

label


label:String

Sets the label for the progress value. If set after the showPercent value, this value will override the showPercent property.

The following listing uses a PercentageBar to display a status message during a load operation:

         myPercentage = new PercentageBar();
         myPercentage.setPosition(400, 300);
         myPercentage.width = 200;
         myPercentage.height = 30;
         myPercentage.progress = 0;
         myPercentage.setTextFormat(percentFormat);
         myPercentage.label = "Loading..."
         

A percentage bar.


Implementation

public function get label():String
public function set label(value:String):void

showPercent


showPercent:Boolean

A Boolean that toggles the percentage value label.

The default value is true.


Implementation

public function get showPercent():Boolean
public function set showPercent(value:Boolean):void

Constructor Detail

PercentageBar()


public function PercentageBar()

Creates a new ProgressBar instance.

Method Detail

setTextFormat()


public function setTextFormat(format:TextFormat):void

Set the TextFormat for the item. The TextFormat object defines the text formatting for the percentage label. In the following listing, a TextFormat object is instantiated and applied to the PercentageBar:

         var percentlFormat:TextFormat = new TextFormat();
         percentlFormat.size = 20;
         percentlFormat.bold = true;
         percentlFormat.italic = true;

         myPercentage.setTextFormat(percentlFormat);
         this.addChild(myPercentage);
         

Parameters

format:TextFormat — The TextFormat object to apply to the label.

Examples

The following listing creates a PercentageBar instance. It contains a simple timer routine that is used to update the progress value.
package
{
    import flash.display.Sprite;
    import flash.events.TimerEvent;
    import flash.utils.Timer;

    import qnx.fuse.ui.progress.PercentageBar;

    [SWF(height="600", width="1024",
    frameRate="30", backgroundColor="#FFFFFF")]
    public class PercentBarSample extends Sprite
    {
        private var myPercentage:PercentageBar;
        private var timer:Timer;
        private var counter:int;

        public function PercentBarSample()
        {
            initializeUI();
        }

        private function initializeUI():void{


            myPercentage = new PercentageBar();
            myPercentage.setPosition(400, 300);
            myPercentage.width = 200;
            myPercentage.height = 10;
            myPercentage.progress = 0;

            this.addChild(myPercentage);

            // counter to keep track of how many times the timer has ticked
            counter = 0;
            timer  = new Timer(100,100);
            timer.addEventListener(TimerEvent.TIMER,handleTimerTick);
            timer.addEventListener(TimerEvent.TIMER_COMPLETE,handleTimerComplete);
            timer.start();

        }

        private function handleTimerComplete(e:TimerEvent):void
        {
            timer.removeEventListener(TimerEvent.TIMER,handleTimerTick);
            timer.removeEventListener(TimerEvent.TIMER_COMPLETE,handleTimerComplete);
            counter = 0;
        }

        private function handleTimerTick( e:TimerEvent ):void
        {
            counter++;
            myPercentage.progress = counter/100;
        }

    }
}