dijit/form/CheckBox.js

• Provides:

  • dijit.form.CheckBox

• Requires:

  • dijit.form.ToggleButton in common

• dijit.form.CheckBox

  • type

    Function

  • chains:
    • dijit.form.ToggleButton: (prototype)
    • dijit.form.ToggleButton: (call)
  • summary

    Same as an HTML checkbox, but with fancy styling.

  • description

    User interacts with real html inputs.
    On onclick (which occurs by mouse click, space-bar, or
    using the arrow keys to switch the selected radio button),
    we update the state of the checkbox/radio.
    
    There are two modes:
    1. High contrast mode
    2. Normal mode
    
    In case 1, the regular html inputs are shown and used by the user.
    In case 2, the regular html inputs are invisible but still used by
    the user. They are turned quasi-invisible and overlay the background-image.

• dijit.form.CheckBox.templateString

  • type

    Object

• dijit.form.CheckBox.baseClass

  • type

    String

• dijit.form.CheckBox.type

  • tags:
  • type

    String

  • summary

    type attribute on <input> node.
    Overrides <code>dijit.form.Button.type</code>.  Users should not change this value.

• dijit.form.CheckBox.value

  • type

    String

  • summary

    As an initialization parameter, equivalent to value field on normal checkbox
    (if checked, the value is passed as the value when form is submitted).
    
    However, get('value') will return either the string or false depending on
    whether or not the checkbox is checked.
    
    set('value', string) will check the checkbox and change the value to the
    specified string
    
    set('value', boolean) will change the checked state.

• dijit.form.CheckBox.readOnly

  • type

    Boolean

  • summary

    Should this widget respond to user input?
    In markup, this is specified as "readOnly".
    Similar to disabled except readOnly form values are submitted.

• dijit.form.CheckBox.attributeMap

  • type

    Object

• dijit.form.CheckBox._setReadOnlyAttr

  • parameters:
    • value: (typeof Boolean)
  • type

    Function

• dijit.form.CheckBox._setValueAttr

  • parameters:
    • newValue: (typeof String|Boolean)
    • priorityChange: (typeof Boolean)
  • summary

    Handler for value= attribute to constructor, and also calls to
    set('value', val).

  • description

    During initialization, just saves as attribute to the <input type=checkbox>.
    
    After initialization,
    when passed a boolean, controls whether or not the CheckBox is checked.
    If passed a string, changes the value attribute of the CheckBox (the one
    specified as "value" when the CheckBox was constructed (ex: <input
    dojoType="dijit.CheckBox" value="chicken">)

  • type

    Function

• dijit.form.CheckBox._getValueAttr

  • summary

    Hook so get('value') works.

  • description

    If the CheckBox is checked, returns the value attribute.
    Otherwise returns false.

  • type

    Function

• dijit.form.CheckBox._setLabelAttr

  • type

    Object

• dijit.form.CheckBox.postMixInProperties

  • type

    Function

• dijit.form.CheckBox.checkedAttrSetting

• dijit.form.CheckBox._fillContent

  • parameters:
    • source: (typeof DomNode)
  • type

    Function

• dijit.form.CheckBox.reset

  • type

    Function

• dijit.form.CheckBox._hasBeenBlurred

  • type

    bool

• dijit.form.CheckBox._onFocus

  • type

    Function

• dijit.form.CheckBox._onBlur

  • type

    Function

• dijit.form.CheckBox._onClick

  • parameters:
    • e: (typeof Event)
  • summary

    Internal function to handle click actions - need to check
    readOnly, since button no longer does that check.

  • type

    Function

• dijit.form.RadioButton

  • type

    Function

  • chains:
    • dijit.form.CheckBox: (prototype)
    • dijit.form.CheckBox: (call)
  • summary

    Same as an HTML radio, but with fancy styling.

• dijit.form.RadioButton.type

  • type

    String

• dijit.form.RadioButton.baseClass

  • type

    String

• dijit.form.RadioButton._setCheckedAttr

  • parameters:
    • value: (typeof Boolean)
  • type

    Function

• dijit.form.RadioButton._clicked

  • parameters:
    • e: (typeof Event)
  • type

    Function

• dijit.form

  • type

    Object

• dijit

  • type

    Object