dijit/form/FilteringSelect.js

• Provides:

  • dijit.form.FilteringSelect

• Requires:

  • dijit.form.ComboBox in common

• dijit.form.FilteringSelect

  • type

    Function

  • chains:
    • dijit.form.MappedTextBox: (prototype)
    • dijit.form.ComboBoxMixin.prototype: (prototype)
    • dijit.form.MappedTextBox: (call)
    • dijit.form.ComboBoxMixin: (call)
  • summary

    An enhanced version of the HTML SELECT tag, populated dynamically

  • description

    An enhanced version of the HTML SELECT tag, populated dynamically. It works
    very nicely with very large data sets because it can load and page data as needed.
    It also resembles ComboBox, but does not allow values outside of the provided ones.
    If OPTION tags are used as the data provider via markup, then the
    OPTION tag's child text node is used as the displayed value when selected
    while the OPTION tag's value attribute is used as the widget value on form submit.
    To set the default value when using OPTION tags, specify the selected
    attribute on 1 of the child OPTION tags.
    
    Similar features:
    - There is a drop down list of possible values.
    - You can only enter a value from the drop down list.  (You can't
    enter an arbitrary value.)
    - The value submitted with the form is the hidden value (ex: CA),
    not the displayed value a.k.a. label (ex: California)
    
    Enhancements over plain HTML version:
    - If you type in some text then it will filter down the list of
    possible values in the drop down list.
    - List can be specified either as a static list or via a javascript
    function (that can get the list from a server)

  • classlike

• dijit.form.FilteringSelect.required

  • prototype - dijit.form.FilteringSelect
  • type

    Boolean

  • summary

    True (default) if user is required to enter a value into this field.

• dijit.form.FilteringSelect._lastDisplayedValue

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    String

• dijit.form.FilteringSelect._isValidSubset

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect.isValid

  • prototype - dijit.form.FilteringSelect
  • returns

    #5974

  • type

    Function

• dijit.form.FilteringSelect._refreshState

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._callbackSetLabel

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • result: (typeof Array)
    • dataObject: (typeof Object)
    • priorityChange: (typeof Boolean)
  • summary

    Callback from dojo.data after lookup of user entered value finishes

  • private - 1
  • type

    Function

• dijit.form.FilteringSelect.valueNode.value

  • prototype - dijit.form.FilteringSelect
  • type

    String

• dijit.form.FilteringSelect._openResultList

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • results: (typeof Object)
    • dataObject: (typeof Object)
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._getValueAttr

  • prototype - dijit.form.FilteringSelect
  • summary

    Hook for get('value') to work.

  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._getValueField

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._setValueAttr

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • value: (typeof String)
    • priorityChange: (typeof Boolean)
  • summary

    Hook so set('value', value) works.

  • description

    Sets the value of the select.
    Also sets the label to the corresponding value by reverse lookup.

  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._lastQuery

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    Object

• dijit.form.FilteringSelect._setItemAttr

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • item: (typeof item)
    • priorityChange: (typeof Boolean)
    • displayedValue: (typeof String)
  • summary

    Set the displayed valued in the input box, and the hidden value
    that gets submitted, based on a dojo.data store item.

  • description

    Users shouldn't call this function; they should be calling
    set('item', value)

  • tags:
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._getDisplayQueryString

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • text: (typeof String)
  • private - 1
  • type

    Function

• dijit.form.FilteringSelect._setDisplayedValueAttr

  • prototype - dijit.form.FilteringSelect
  • parameters:
    • label: (typeof String)
    • priorityChange: (typeof Boolean)
  • summary

    Hook so set('displayedValue', label) works.

  • description

    Sets textbox to display label. Also performs reverse lookup
    to set the hidden value.  label should corresponding to item.searchAttr.

  • private - 1
  • type

    Function

• dijit.form.FilteringSelect.textbox.value

  • prototype - dijit.form.FilteringSelect

• dijit.form.FilteringSelect._fetchHandle

  • prototype - dijit.form.FilteringSelect
  • private - 1
  • type

    Object

• dijit.form.FilteringSelect.undo

  • prototype - dijit.form.FilteringSelect
  • type

    Function

• dijit.form

  • type

    Object

• dijit

  • type

    Object