Scroll

Article Metadata

---

Article

Created: User:Kbwiki (09 Nov 2009)

Last edited: hamishwillee (31 Jul 2012)

Inheritance

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

1 - Description

The Scroll component is used as a visual feedback to indicate the existence of more content beyond the screen.

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:

• scrollBar: boolean
  • Defines whether a traditional scrollbar is used by the component.
• showArrows: boolean
  • Defines whether arrows are used by the component.
• bottomImage: boolean
  • Defines whether the bottom image indication is used.
• duration: boolean
  • Defines the duration of scroll activity.
• increase
  • Defines the increase of scroll activity. This option is used in scroll speed calculation.

4.2 - Events - Callbacks

• create: function()
  • Scope: [this.element]
• scroll: function()
  • Scope: [this.element]

4.3 - Methods:

• scroll: function(direction, callback)
  • Apply scroll on a specific direction
  • Return nothing

4.4 - Default options

• increase: 100,
• duration: 200,
• scrollBar: true,
• showArrows: false,
• bottomImage: true

5 - Component Demo

5.1 HTML

<empty> 

5.2 Javascript

var scroll = new Nokia.Scroll({
     scrollBar: true,
     showArrows: false,
     increase: 250,
     create: function() { 
          //alert('Scroll: Created'); 
     },
     scroll: function() {
          //alert('Scroll: Scroll'); 
     }
}); 

6 - Nokia WRT Browser Compatibility

 

▴	S60 3.1	S60 3.2	S60 5.0
Scroll	YES	YES	YES