Progress Bar

Comments

(no comments yet)

Log in or Join to leave comments.

Article Metadata

---

Article

Created: User:Kbwiki (06 Nov 2009)

Last edited: hamishwillee (31 Jul 2012)

Inheritance

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

1 - Description

The Progress Bar component is a GUI element that dynamically informs the user of the progress status of an operation with a predictable end point. Progress bars are typically only shown when an operation will take more than 1 second. A progress bar is an animation that shows a graphical element that gradually fills up, reflecting the progress toward completion. The user should see the bar advancing periodically and be able to assume that the process will be complete when the bar is full. The progress bar should be as wide as possible – the wider the progress bar, the easier it is to see the progress. The progress bar can support associated text labels (see the Text Label component).

2 - Visual Design

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.
• label: boolean
  • Defines whether the component has a progress label.
• value: int
  • Defines the initial value of component. This is a number between 0 and 100.
• height: int
  • Defines the component height.
• width: int
  • Defines the component width.

4.2 - Events - Callbacks

• create: function()
  • Scope: [this.element]
• change: function(value)
  • Scope: [this.element]
• complete: function(value)
  • Scope: [this.element]

4.3 - Methods

• getValue: function()
  • Returns the component value.
  • return [int]
• setValeu: function(value)
  • Sets the component value.
  • return [void]

4.4 - Default options

• value: 0

5 - Component Demo

5.1 HTML

<div id="progressbar"></div>

5.2 Javascript

var progress1 = new Nokia.ProgressBar({
     element: '#progressbar',
     value: 30,
     label: true,
     create: function() {
          //alert('Progress Bar: Create');
     },
     change: function(value) {
          //alert('Progress Bar: Change ' + value);
     },
     complete: function(value) {
          //alert('Progress Bar: Complete ' + value);
     }
});

6 - Nokia WRT Browser Compatibility

 

▴	S60 3.1	S60 3.2	S60 5.0
Progress Bar	NO	YES	YES