qnx.fuse.ui.progress.ActivityIndicator

ActivityIndicator

Properties | Methods | Events | Examples


Packageqnx.fuse.ui.progress
Classpublic class ActivityIndicator
InheritanceActivityIndicator Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip

The ActivityIndicator class provides visual progress feedback to the user during time-consuming operations. The ActivityIndicator indicator animation appears as a rotating circle.

It's a good idea to use an activity indicator during load operations or when performing time-sensitive, processor-intensive operations where you are unsure how long the operation may take.

There are three different sizes available for the ActivityIndicator. You can pass any of the following values into the setSkin() method, ActivityIndicatorSkinSmall, ActivityIndicatorSkinMedium, or ActivityIndicatorSkinLarge. You can also create your own custom ActivityIndicator skins.

A small ActivityIndicator: The small activity indicator.
A medium ActivityIndicator: The medium activity indicator.
A large ActivityIndicator: The large activity indicator.


Class information:
BlackBerry 10 Version:   10.0.0
Found in:  qnxui.swc

View the examples

See also

ProgressBar
PercentageBar



Public Properties

 PropertyDefined By
  animationSpeed : Number
Sets the speed of the animation.
ActivityIndicator
 InheritedcontextActions : Vector.<ActionSet>
Gets or Sets a Vector of ActionSet objects.
UIComponent
 InheritedcontextMultiSelectText : String
Gets or Sets a String to be displayed when showing the Multi Select Context Menu.
UIComponent
 InheritedcurrentTheme : String
[read-only] Returns the current theme this component is styled with.
UIComponent
 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
 Inheritedid : String
The id is a name for the component that can be used in CSS using the # selector.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Gets or sets the layoutData.
UIComponent
 Inheritedlocale : String
Gets or sets the current locale of the component.
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
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent
 InheritedstyleChildren : Boolean
Allows you to style the children of this component with CSS.
UIComponent

Protected Properties

 PropertyDefined By
 InheritedaccessibilityImplimentationClass : Class
UIComponent
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
ActivityIndicator
 InheritedexplicitLocale : Boolean
Set to true when the locale property has been set externally.
UIComponent
 InheritedinternalID : String
The Component's Id used for styling.
UIComponent
 InheritedlongPressEnabled : Boolean
Specifies whether the UIComponent can detect a long press.
UIComponent

Public Methods

 MethodDefined By
  
Creates a new ActivityIndicator instance.
ActivityIndicator
  
animate(doAnimate:Boolean):void
Starts or stops the indicator animation.
ActivityIndicator
 Inherited
Cancels a long press from occuring on the component.
UIComponent
 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
configureStyles(styles:Array):void
[override] The SkinnableComponent version styles the component with the base style first, and then styles it with the current state's style.
SkinnableComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the CSS selector for the object, composing it from its position in the display hierarchy and an optional ID selector.
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
  
isAnimating():Boolean
Returns a Boolean that indicates whether or not the animation is currently playing.
ActivityIndicator
 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
  
setSkin(newSkin:Object):void
[override] Set the skin object on the activity indicator for it to render.
ActivityIndicator
 Inherited
updateDefaultLocale(updateChildren:Boolean = true):void
Updates the locale property to be the same as the locale of the device.
UIComponent
 Inherited
Lets a component that contains text know that it should update its font formats as the font settings have changed.
UIComponent
 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
allowShowContextMenu(target:IEventDispatcher):Boolean
When the user presses on the component this method is called with the object that dispatched the event.
UIComponent
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
Style the component after the style has changed.
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
excemptFromCSSStyling(target:*, property:String = null):void
Exempts a property on an object from being styled by CSS.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
getStyleApplier():Function
A style applier is a method that gets called every time a property from the stylesheet should be applied to the component.
UIComponent
 Inherited
getStyleForState(state:String):IStyleable
A utility method to get the styling information for a given state.
SkinnableComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
Is called when a user is no longer long pressing on the component.
UIComponent
 Inherited
Is called when a user long presses on the component.
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
Calling this function will refresh the ContextMenu with whatever actions were set by contextActions.
UIComponent
 Inherited
Shows the context menu if there are contextActions associated with the control.
UIComponent
 Inherited
styleState():void
Style the component after state has changed.
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's dimensions.
SkinnableComponent

Events

 Event Summary Defined By
 InheritedDispatched when an action in the Context Menu is selected.UIComponent
 InheritedDispatched when the Context Menu has closed to the DISMISSED state.UIComponent
 InheritedDispatched when the ContextMenu is closing to the DISMISSED state.UIComponent
 InheritedDispatched when the Context Menu has opened to the PEEK or EXPANDED state.UIComponent
 InheritedDispatched when the ContextMenu is opening from the DISMISSED state.UIComponent
 InheritedDispatched when the CrossCut multiselect has been canceled.UIComponent

Property Detail

animationSpeed


animationSpeed:Number

Sets the speed of the animation. It should be a value between 0 and 1.

The default value is 0.


Implementation

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

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is ActivityIndicator.


Implementation

protected function get cssID():String

Constructor Detail

ActivityIndicator()


public function ActivityIndicator()

Creates a new ActivityIndicator instance.

Method Detail

animate()


public function animate(doAnimate:Boolean):void

Starts or stops the indicator animation.

Parameters

doAnimate:Booleantrue to start, or continue displaying the animation, false to stop animating.

isAnimating()


public function isAnimating():Boolean

Returns a Boolean that indicates whether or not the animation is currently playing.

The following example uses the isAnimating method to toggle the animate property of an ActivityIndicator instance.

private function onClick( e:MouseEvent ):void
{
    if ( !myActivity.isAnimating() )
    {
        myAnimate.label = "Stop";
        myActivity.animate( true );
    }
    else 
    {
        myAnimate.label = "Animate";
        myActivity.animate( false );
    }
}
         

Returns

Boolean — Returns true if the animation is currently running, otherwise false.

setSkin()


override public function setSkin(newSkin:Object):void

Set the skin object on the activity indicator for it to render.

If a skin is found, it is removed and a new skin is created. The newSkin parameter can be one of three different types: Class, String, or DisplayObject instance.

  • If you pass in a Class, a new instance of that class is created and returned.
  • If you pass in a String, the flash.utils.getDefinitionByName will attempt to create a new method.
  • If you pass in a DisplayObject instance, the x and y values of the instance are set to 0 and returned.

Activity indicator skins must implement the ISkin and the IActivityIndicatorSkin interfaces.

Parameters

newSkin:Object — A Class, String, or DisplayObject instance. The created object must implements IActivityIndicatorSkin


Throws

ArgumentError — Throws an ArgumentError if the supplied parameter does not create a skin that implements IActivityIndicatorSkin.

See also

ISkin
IActivityIndicatorSkin
ActivityIndicatorSkinLarge
ActivityIndicatorSkinMedium
ActivityIndicatorSkinSmall

Examples

In the following example, a LabelButton instance is used to toggle the animation property of an activity indicator
package
{
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    
    import qnx.fuse.ui.buttons.LabelButton;
    import qnx.fuse.ui.progress.ActivityIndicator;
    
    [SWF(height="1280", width="768", frameRate="60", backgroundColor="#FFFFFF")]
    public class ActivityIndicatorSample extends Sprite
    {
        private var myActivity:ActivityIndicator;
        private var myAnimate:LabelButton;
        
        public function ActivityIndSample()
        {
            initializeUI();
        }
        
        private function initializeUI():void
        {
            myActivity = new ActivityIndicator();            
            myActivity.setPosition( 260, 225 );
            myActivity.setSkin( ActivityIndicatorSkinMedium ); // uses the medium size skin.
            this.addChild( myActivity );
            
            myAnimate = new LabelButton();
            myAnimate.setPosition( 200, 300 );
            myAnimate.label = "Animate";
            this.addChild( myAnimate );
            
            myAnimate.addEventListener( MouseEvent.CLICK, onClick );    
        }
        
        private function onClick( e:MouseEvent ):void
        {
            if ( !myActivity.isAnimating() )
            {
                myAnimate.label = "Stop";
                myActivity.animate( true );
            }
            else 
            {
                myAnimate.label = "Animate";
                myActivity.animate( false );
            }    
        }
    }
}
     
     




comments powered by Disqus