Option Box

Comments

(no comments yet)

Log in or Join to leave comments.

Article Metadata

---

Article

Created: User:Kbwiki (09 Nov 2009)

Last edited: hamishwillee (05 Jul 2012)

Inheritance

Nokia.Widget
    |- Nokia.OptionBox

1 - Description

This is the basic class for Checkbox and Radio Button Components.

2 - Visual Design

Not Applicable for this component.

3 - Component Dependencies

3.1 CSS

Not Applicable for this component.

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

• checked: boolean
  • Defines if the component will be created in checked state.
• disableLabelSelection: boolean
  • Defines that the component label will be not selectable.
• label: String
  • Defines the Label for the component.
• wrapper: String
  • Wrapper element for the component.

4.2 - Events - Callbacks

• check: function()
  • Scope: [this.element]
• unckeck: function()
  • Scope: [this.element]

4.3 - Methods

• isChecked: function()
  • Checks if component is in checked state.
  • return [void]
• check: function(event)
  • Performs check.
  • return [void]
• unckeck: function(event)
  • Performs uncheck.
  • return [void]

4.4 - Default options

• wrapper: 'div',
• disableLabelSelection: true,
• checked: false

5 - Component Demo

5.1 HTML

Not Applicable for this component.

5.2 Javascript

Not Applicable for this component.

6 - Nokia WRT Browser Compatibility

Not Applicable for this component.