dojox/form/CheckedMultiSelect.js

• Provides:

  • dojox.form.CheckedMultiSelect

• Requires:

  • dijit.form.CheckBox in common
  • dijit.Tooltip in common
  • dijit.form._FormSelectWidget in common

• dojox.form._CheckedMultiSelectItem

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    The individual items for a CheckedMultiSelect

• dojox.form._CheckedMultiSelectItem.widgetsInTemplate

  • type

    Object

• dojox.form._CheckedMultiSelectItem.templateString

  • type

    Object

• dojox.form._CheckedMultiSelectItem.baseClass

  • type

    String

• dojox.form._CheckedMultiSelectItem.option

  • type

    dojox.form.__SelectOption

  • summary

    The option that is associated with this item

• dojox.form._CheckedMultiSelectItem.parent

  • type

    Object

• dojox.form._CheckedMultiSelectItem.disabled

  • type

    boolean

  • summary

    Whether or not this widget is disabled

• dojox.form._CheckedMultiSelectItem.readOnly

  • type

    boolean

  • summary

    Whether or not this widget is readOnly

• dojox.form._CheckedMultiSelectItem.postMixInProperties

  • summary

    Set the appropriate _subClass value - based on if we are multi-
    or single-select

  • type

    Function

• dojox.form._CheckedMultiSelectItem._type

  • type

    Object

• dojox.form._CheckedMultiSelectItem.option.disabled

  • type

    bool

• dojox.form._CheckedMultiSelectItem.postCreate

  • summary

    Set innerHTML here - since the template gets messed up sometimes
    with rich text

  • type

    Function

• dojox.form._CheckedMultiSelectItem.labelNode.innerHTML

• dojox.form._CheckedMultiSelectItem._changeBox

  • summary

    Called to force the select to match the state of the check box
    (only on click of the checkbox)	 Radio-based calls _setValueAttr
    instead.

  • type

    Function

• dojox.form._CheckedMultiSelectItem.option.selected

• dojox.form._CheckedMultiSelectItem._onClick

  • parameters:
    • e
  • summary

    Sets the click state (passes through to the check box)

  • type

    Function

• dojox.form._CheckedMultiSelectItem._updateBox

  • summary

    Called to force the box to match the state of the select

  • type

    Function

• dojox.form._CheckedMultiSelectItem._setDisabledAttr

  • parameters:
    • value
  • summary

    Disables (or enables) all the children as well

  • type

    Function

• dojox.form._CheckedMultiSelectItem._setReadOnlyAttr

  • parameters:
    • value
  • summary

    Sets read only (or unsets) all the children as well

  • type

    Function

• dojox.form.CheckedMultiSelect

  • type

    Function

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

    Extends the core dijit MultiSelect to provide a "checkbox" selector

• dojox.form.CheckedMultiSelect.templateString

  • type

    Object

• dojox.form.CheckedMultiSelect.baseClass

  • type

    String

• dojox.form.CheckedMultiSelect.required

  • type

    Boolean

  • summary

    User is required to check at least one item.

• dojox.form.CheckedMultiSelect.invalidMessage

  • type

    String

  • summary

    The message to display if value is invalid.

• dojox.form.CheckedMultiSelect._message

  • type

    String

  • summary

    Currently displayed message

• dojox.form.CheckedMultiSelect.tooltipPosition

  • type

    String[]

  • summary

    See description of <code>dijit.Tooltip.defaultPosition</code> for details on this parameter.

• dojox.form.CheckedMultiSelect._onMouseDown

  • parameters:
    • e
  • summary

    Cancels the mousedown event to prevent others from stealing
    focus

  • type

    Function

• dojox.form.CheckedMultiSelect.validator

  • summary

    Overridable function used to validate that an item is selected if required =
    true.

  • tags:
  • type

    Function

• dojox.form.CheckedMultiSelect.validate

  • parameters:
    • isFocused
  • type

    Function

• dojox.form.CheckedMultiSelect.isValid

  • parameters:
    • isFocused: (typeof Boolean)
  • summary

    Tests if the required items are selected.
    Can override with your own routine in a subclass.

  • tags:
  • type

    Function

• dojox.form.CheckedMultiSelect.getErrorMessage

  • parameters:
    • isFocused: (typeof Boolean)
  • summary

    Return an error message to show if appropriate

  • tags:
  • type

    Function

• dojox.form.CheckedMultiSelect.displayMessage

  • parameters:
    • message: (typeof String)
  • summary

    Overridable method to display validation errors/hints.
    By default uses a tooltip.

  • tags: extension
  • type

    Function

• dojox.form.CheckedMultiSelect.onAfterAddOptionItem

  • parameters:
    • item
    • option
  • summary

    a function that can be connected to in order to receive a
    notification that an item as been added to this dijit.

  • type

    Function

• dojox.form.CheckedMultiSelect._addOptionItem

  • parameters:
    • option: (typeof dojox.form.__SelectOption)
  • type

    Function

• dojox.form.CheckedMultiSelect._refreshState

  • summary

    Validate if selection changes.

  • type

    Function

• dojox.form.CheckedMultiSelect.onChange

  • parameters:
    • newValue
  • summary

    Validate if selection changes.

  • type

    Function

• dojox.form.CheckedMultiSelect.reset

  • summary

    Overridden so that the state will be cleared.

  • type

    Function

• dojox.form.CheckedMultiSelect._updateSelection

  • type

    Function

• dojox.form.CheckedMultiSelect._getChildren

  • type

    Function

• dojox.form.CheckedMultiSelect.invertSelection

  • parameters:
    • onChange: (typeof Boolean)

      If null, onChange is not fired.

  • summary

    Invert the selection

  • type

    Function

• dojox.form.CheckedMultiSelect._setDisabledAttr

  • parameters:
    • value
  • summary

    Disable (or enable) all the children as well

  • type

    Function

• dojox.form.CheckedMultiSelect._setReadOnlyAttr

  • parameters:
    • value
  • summary

    Sets read only (or unsets) all the children as well

  • type

    Function

• dojox.form.CheckedMultiSelect.readOnly

• dojox.form.CheckedMultiSelect.uninitialize

  • type

    Function

• dojox.form

  • type

    Object

• dojox

  • type

    Object