dijit/form/_CheckBoxMixin (version 1.10)

Summary

Mixin to provide widget functionality corresponding to an HTML checkbox

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.

See the dijit/form/_CheckBoxMixin reference documentation for more information.

Property Summary

  • _aria_attr
  • _setLabelAttr
  • readOnlyShould this widget respond to user input?
  • typetype attribute on <input> node.
  • valueAs an initialization parameter, equivalent to value field on normal checkbox (if checked, the value is passed as the value when form is submitted).

Method Summary

Event Summary

  • _onClick(e) Internal function to handle click actions - need to check readOnly, since button no longer does that check.

Properties

_aria_attr
_setLabelAttr
readOnly

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

type

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

value

As an initialization parameter, equivalent to value field on normal checkbox (if checked, the value is passed as the value when form is submitted).

Methods

_getSubmitValue(value)
Parameter Type Description
value String
Returns:string
_setReadOnlyAttr(value)
Parameter Type Description
value Boolean
_setValueAttr(newValue)
Parameter Type Description
newValue undefined
reset()

Events

_onClick(e)

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

Parameter Type Description
e Event
Returns:boolean | undefined
Error in the documentation? Can’t find what you are looking for? Let us know!