×
Namespaces

Variants
Actions

Busy Indicator

From Nokia Developer Wiki
Jump to: navigation, search
Article Metadata
Article
Created: User:Kbwiki (09 Nov 2009)
Last edited: hamishwillee (30 Jul 2012)

Contents

Inheritance

Nokia.Busy
|- Nokia.Widget
|- Nokia.Class (basic class)

1 - Description

An animation that lets the user know that the system is busy working on a user request. The Busy Indicator component is used when an operation is expected to take more than 1 second, but the system is not able to predict exactly how long it will take.

2 - Visual Design

Busy01.png


3 - Component Dependencies

3.1 CSS

<!-- Themeroller CSS -->
<link rel="stylesheet" href="themes/themeroller/<theme>/Themeroller.css" type="text/css" media="screen">
<!-- Specific Theme/Resolution CSS -->
<link rel="stylesheet" href="/themes/nokia/ext-theme/<theme>/<resolution>/custom.css" type="text/css" media="screen">

3.2 Javascript

<!-- jQuery file -->
<script src="/lib/jquery/jQuery.js" type="text/javascript" charset="utf-8"></script>
<!-- Guarana file -->
<script src="/lib/Guarana.js" type="text/javascript" charset="utf-8"></script>

4 - Functional Specifications/Requirements

4.1 - Options

  • element: 'selector'
    • jQuery selector or the DOM reference to become the container of the component.
  • autoOpen: boolean
    • Defines whether the component will be showed on creation or not.
  • image: string
    • The busy indication image path.
  • height: int
    • Defines the component height.
  • width: int
    • Defines the component width.

 

4.2 - Events - Callbacks

  • create: function()
    • Scope: [this.element]
  • destroy: function(event)
    • Scope: [this.element]
  • hide: function(event)
    • Scope: [this.element]
  • show: function(event)
    • Scope: [this.element]

 

4.3 - Methods

  • destroy: function()
    • Destroys the busy component.
    • return [int]
  • hide: function(value)
    • Hides the busy component.
    • return [void]
  • show: function()
    • Shows the busy component.
    • return [int]


4.4- Default options

  • autoOpen: true,
  • overflow: true,
  • height: 108,
  • width: 108,
  • loaderText: false


5 - Component Demo

5.1 HTML

<div id="busy01"> Div 01 </div>

5.2 Javascript

window.busy1 = new Nokia.Busy({
     element: '#busy01',
     image: 'themes/nokia/images/busyindicator.gif',
     height: 107,
     width: 108,
     autoOpen: false,
     create: function() {
          //alert("Busy: Create.");
     },
     show: function() {
          //alert("Busy: Show.");
     }
});

6 - Nokia WRT Browser Compatibility

 

▴   S60 3.1 S60 3.2 S60 5.0
Accordion YES  YES  YES 

 

This page was last modified on 30 July 2012, at 13:35.
46 page views in the last 30 days.
×