dijit/form/ComboBox.js

• Provides:

  • dijit.form.ComboBox

• Requires:

  • dojo.window in common
  • dojo.regexp in common
  • dojo.data.util.simpleFetch in common
  • dojo.data.util.filter in common
  • dijit._CssStateMixin in common
  • dijit.form._FormWidget in common
  • dijit.form.ValidationTextBox in common
  • dijit._HasDropDown in common

• dijit.form._ComboBoxDataStore

  • type

    Function

  • chains:
    • dojo.data.util.simpleFetch: (prototype)
  • parameters:
    • root: (typeof DomNode)
  • summary

    Inefficient but small data store specialized for inlined <code>dijit.form.ComboBox</code> data

  • description

    Provides a store for inlined data like:
    
    	<select>
    		<option value="AL">Alabama</option>
    		...
    
    Actually. just implements the subset of dojo.data.Read/Notification
    needed for ComboBox and FilteringSelect to work.
    
    Note that an item is just a pointer to the <option> DomNode.

• dijit.form.ComboBoxMixin

  • type

    Function

  • chains:
    • dijit._HasDropDown: (prototype)
    • dijit._HasDropDown: (call)
  • summary

    Implements the base functionality for <code>dijit.form.ComboBox</code>/<code>dijit.form.FilteringSelect</code>

  • description

    All widgets that mix in dijit.form.ComboBoxMixin must extend `dijit.form._FormValueWidget`.

  • tags:

• dijit.form.ComboBoxMixin.item

  • type

    Object

  • summary

    This is the item returned by the dojo.data.store implementation that
    provides the data for this ComboBox, it's the currently selected item.

• dijit.form.ComboBoxMixin.pageSize

  • alias - Infinity
  • type

    Integer

  • summary

    Argument to data provider.
    Specifies number of search results per page (before hitting "next" button)

• dijit.form.ComboBoxMixin.store

  • tags: const
  • type

    Object

  • summary

    Reference to data provider object used by this ComboBox

• dijit.form.ComboBoxMixin.fetchProperties

  • type

    Object

  • summary

    Mixin to the dojo.data store's fetch.
    For example, to set the sort order of the ComboBox menu, pass:
    	{ sort: [{attribute:"name",descending: true}] }
    To override the default queryOptions so that deep=false, do:
    	{ queryOptions: {ignoreCase: true, deep: false} }

• dijit.form.ComboBoxMixin.query

  • type

    Object

  • summary

    A query that can be passed to 'store' to initially filter the items,
    before doing further filtering based on <code>searchAttr</code> and the key.
    Any reference to the <code>searchAttr</code> is ignored.

• dijit.form.ComboBoxMixin.autoComplete

  • type

    Boolean

  • summary

    If user types in a partial string, and then tab out of the <code>&lt;input&gt;</code> box,
    automatically copy the first entry displayed in the drop down list to
    the <code>&lt;input&gt;</code> field

• dijit.form.ComboBoxMixin.highlightMatch

  • type

    String

  • summary

    One of: "first", "all" or "none".
    
    If the ComboBox/FilteringSelect opens with the search results and the searched
    string can be found, it will be highlighted.  If set to "all"
    then will probably want to change <code>queryExpr</code> parameter to '*${0}*'
    
    Highlighting is only performed when <code>labelType</code> is &quot;text&quot;, so as to not
    interfere with any HTML markup an HTML label might contain.

• dijit.form.ComboBoxMixin.searchDelay

  • type

    Integer

  • summary

    Delay in milliseconds between when user types something and we start
    searching based on that value

• dijit.form.ComboBoxMixin.searchAttr

  • type

    String

  • summary

    Search for items in the data store where this attribute (in the item)
    matches what the user typed

• dijit.form.ComboBoxMixin.labelAttr

  • optional
  • type

    String

  • summary

    The entries in the drop down list come from this attribute in the
    dojo.data items.
    If not specified, the searchAttr attribute is used instead.

• dijit.form.ComboBoxMixin.labelType

  • type

    String

  • summary

    Specifies how to interpret the labelAttr in the data store items.
    Can be "html" or "text".

• dijit.form.ComboBoxMixin.queryExpr

  • type

    String

  • summary

    This specifies what query ComboBox/FilteringSelect sends to the data store,
    based on what the user has typed.  Changing this expression will modify
    whether the drop down shows only exact matches, a "starting with" match,
    etc.  Use it in conjunction with highlightMatch.
    dojo.data query expression pattern.
    <code>${0}</code> will be substituted for the user text.
    <code>*</code> is used for wildcards.
    <code>${0}*</code> means &quot;starts with&quot;, <code>*${0}*</code> means &quot;contains&quot;, <code>${0}</code> means &quot;is&quot;

• dijit.form.ComboBoxMixin.ignoreCase

  • type

    Boolean

  • summary

    Set true if the ComboBox/FilteringSelect should ignore case when matching possible items

• dijit.form.ComboBoxMixin.hasDownArrow

  • type

    Boolean

  • summary

    Set this textbox to have a down arrow button, to display the drop down list.
    Defaults to true.

• dijit.form.ComboBoxMixin.templateString

  • type

    Object

• dijit.form.ComboBoxMixin.baseClass

  • type

    String

• dijit.form.ComboBoxMixin.dropDownClass

  • tags: extension
  • type

    String

  • summary

    Name of the dropdown widget class used to select a date/time.
    Subclasses should specify this.

• dijit.form.ComboBoxMixin.cssStateNodes

  • type

    Object

• dijit.form.ComboBoxMixin.cssStateNodes._buttonNode

  • type

    String

• dijit.form.ComboBoxMixin.maxHeight

  • type

    Number

• dijit.form.ComboBoxMixin._stopClickEvents

  • type

    bool

• dijit.form.ComboBoxMixin._getCaretPos

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

    Function

• dijit.form.ComboBoxMixin._setCaretPos

  • parameters:
    • element: (typeof DomNode)
    • location: (typeof Number)
  • type

    Function

• dijit.form.ComboBoxMixin._setDisabledAttr

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

    Function

• dijit.form.ComboBoxMixin._abortQuery

  • type

    Function

• dijit.form.ComboBoxMixin.searchTimer

  • type

    Object

• dijit.form.ComboBoxMixin._fetchHandle

  • type

    Object

• dijit.form.ComboBoxMixin._onInput

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

    Handles paste events

  • type

    Function

• dijit.form.ComboBoxMixin._onKey

  • parameters:
    • evt: (typeof Event)
  • returns

    throw out weird key combinations and spurious events

  • summary

    Handles keyboard events

  • type

    Function

• dijit.form.ComboBoxMixin.dropDown

  • type

    Object

• dijit.form.ComboBoxMixin._prev_key_backspace

  • type

    Object

• dijit.form.ComboBoxMixin._lastQuery

  • type

    Object

• dijit.form.ComboBoxMixin._autoCompleteText

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

    Fill in the textbox with the first item from the drop down
    list, and highlight the characters that were
    auto-completed. For example, if user typed "CA" and the
    drop down list appeared, the textbox would be changed to
    "California" and "ifornia" would be highlighted.

  • type

    Function

• dijit.form.ComboBoxMixin.focusNode

• dijit.form.ComboBoxMixin.focusNode.value

  • type

    Object

• dijit.form.ComboBoxMixin._openResultList

  • parameters:
    • results: (typeof Object)
    • dataObject: (typeof Object)
  • summary

    Callback when a search completes.

  • description

    1. generates drop-down list and calls _showResultList() to display it
    2. if this result list is from user pressing "more choices"/"previous choices"
    then tell screen reader to announce new option

  • type

    Function

• dijit.form.ComboBoxMixin.dropDown._highlighted_option

• dijit.form.ComboBoxMixin._showResultList

  • summary

    Display the drop down if not already displayed, or if it is displayed, then
    reposition it if necessary (reposition may be necessary if drop down's height changed).

  • type

    Function

• dijit.form.ComboBoxMixin.loadDropDown

  • parameters:
    • callback: (typeof Function)
  • type

    Function

• dijit.form.ComboBoxMixin.isLoaded

  • type

    Function

• dijit.form.ComboBoxMixin.closeDropDown

  • type

    Function

• dijit.form.ComboBoxMixin._setBlurValue

  • type

    Function

• dijit.form.ComboBoxMixin._onBlur

  • summary

    Called magically when focus has shifted away from this widget and it's drop down

  • type

    Function

• dijit.form.ComboBoxMixin._setItemAttr

  • 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:
  • type

    Function

• dijit.form.ComboBoxMixin._announceOption

  • parameters:
    • node: (typeof Node)
  • summary

    a11y code that puts the highlighted option in the textbox.
    This way screen readers will know what is happening in the
    menu.

  • type

    Function

• dijit.form.ComboBoxMixin.value

  • type

    Object

• dijit.form.ComboBoxMixin._selectOption

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

    Menu callback function, called when an item in the menu is selected.

  • type

    Function

• dijit.form.ComboBoxMixin._startSearchAll

  • type

    Function

• dijit.form.ComboBoxMixin._startSearchFromInput

  • type

    Function

• dijit.form.ComboBoxMixin._getQueryString

  • parameters:
    • text: (typeof String)
  • type

    Function

• dijit.form.ComboBoxMixin._startSearch

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

    Starts a search for elements matching key (key=="" means to return all items),
    and calls _openResultList() when the search completes, to display the results.

  • type

    Function

• dijit.form.ComboBoxMixin._lastInput

• dijit.form.ComboBoxMixin._setMaxOptions

  • parameters:
    • size
    • request
  • type

    Function

• dijit.form.ComboBoxMixin._maxOptions

• dijit.form.ComboBoxMixin._getValueField

  • summary

    Helper for postMixInProperties() to set this.value based on data inlined into the markup.
    Returns the attribute name in the item (in dijit.form._ComboBoxDataStore) to use as the value.

  • type

    Function

• dijit.form.ComboBoxMixin.constructor

  • constructor - constructor
  • type

    Function

• dijit.form.ComboBoxMixin.postMixInProperties

  • type

    Function

• dijit.form.ComboBoxMixin.srcNodeRef

• dijit.form.ComboBoxMixin.postCreate

  • summary

    Subclasses must call this method from their postCreate() methods

  • tags:
  • type

    Function

• dijit.form.ComboBoxMixin._setHasDownArrowAttr

  • parameters:
    • val
  • type

    Function

• dijit.form.ComboBoxMixin._buttonNode.style.display

• dijit.form.ComboBoxMixin._getMenuLabelFromItem

  • parameters:
    • item: (typeof Item)
  • type

    Function

• dijit.form.ComboBoxMixin.doHighlight

  • parameters:
    • label: (typeof String)
    • find: (typeof String)
  • summary

    Highlights the string entered by the user in the menu.  By default this
    highlights the first occurrence found. Override this method
    to implement your custom highlighting.

  • tags:
  • type

    Function

• dijit.form.ComboBoxMixin._escapeHtml

  • parameters:
    • str: (typeof String)
  • returns

    string

  • summary

    Adds escape sequences for special characters in XML: &<>"'

  • type

    Function

• dijit.form.ComboBoxMixin.reset

  • type

    Function

• dijit.form.ComboBoxMixin.labelFunc

  • parameters:
    • item: (typeof item)
    • store: (typeof dojo.data.store)
  • returns

    String

  • summary

    Computes the label to display based on the dojo.data store item.

  • return_summary

    The label that the ComboBox should display

  • tags:
  • type

    Function

• dijit.form._ComboBoxMenu

  • type

    Function

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

    Focus-less menu for internal use in <code>dijit.form.ComboBox</code>

  • tags:

• dijit.form._ComboBoxMenu.templateString

  • type

    String

• dijit.form._ComboBoxMenu._messages

  • type

    Object

  • summary

    Holds "next" and "previous" text for paging buttons on drop down

• dijit.form._ComboBoxMenu.baseClass

  • type

    String

• dijit.form._ComboBoxMenu.postMixInProperties

  • type

    Function

• dijit.form._ComboBoxMenu.buildRendering

  • type

    Function

• dijit.form._ComboBoxMenu.previousButton.innerHTML

• dijit.form._ComboBoxMenu.nextButton.innerHTML

• dijit.form._ComboBoxMenu._setValueAttr

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

    Function

• dijit.form._ComboBoxMenu.value

• dijit.form._ComboBoxMenu.onChange

  • parameters:
    • value: (typeof Object)
  • summary

    Notifies ComboBox/FilteringSelect that user clicked an option in the drop down menu.
    Probably should be called onSelect.

  • tags: callback
  • type

    Function

• dijit.form._ComboBoxMenu.onPage

  • parameters:
    • direction: (typeof Number)
  • summary

    Notifies ComboBox/FilteringSelect that user clicked to advance to next/previous page.

  • tags: callback
  • type

    Function

• dijit.form._ComboBoxMenu.onClose

  • summary

    Callback from dijit.popup code to this widget, notifying it that it closed

  • tags:
  • type

    Function

• dijit.form._ComboBoxMenu._createOption

  • parameters:
    • item: (typeof Object)
    • labelFunc
  • summary

    Creates an option to appear on the popup menu subclassed by
    <code>dijit.form.FilteringSelect</code>.

  • type

    Function

• dijit.form._ComboBoxMenu.createOptions

  • parameters:
    • results: (typeof Array)

      of dojo.data items

    • dataObject: (typeof dojo.data)

      store

    • labelFunc: (typeof Function)

      to produce a label in the drop down list from a dojo.data item

  • summary

    Fills in the items in the drop down list

  • type

    Function

• dijit.form._ComboBoxMenu.previousButton.style.display

• dijit.form._ComboBoxMenu.nextButton.style.display

• dijit.form._ComboBoxMenu.clearResultList

  • summary

    Clears the entries in the drop down list, but of course keeps the previous and next buttons.

  • type

    Function

• dijit.form._ComboBoxMenu._onMouseDown

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

    Function

• dijit.form._ComboBoxMenu._onMouseUp

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

    Function

• dijit.form._ComboBoxMenu._onMouseOver

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

    Function

• dijit.form._ComboBoxMenu._onMouseOut

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

    Function

• dijit.form._ComboBoxMenu._focusOptionNode

  • parameters:
    • node: (typeof DomNode)
  • summary

    Does the actual highlight.

  • type

    Function

• dijit.form._ComboBoxMenu._highlighted_option

  • type

    Object

• dijit.form._ComboBoxMenu._blurOptionNode

  • summary

    Removes highlight on highlighted option.

  • type

    Function

• dijit.form._ComboBoxMenu._highlightNextOption

  • summary

    Highlight the item just below the current selection.
    If nothing selected, highlight first option.

  • type

    Function

• dijit.form._ComboBoxMenu.domNode.firstChild

• dijit.form._ComboBoxMenu._highlighted_option.nextSibling

• dijit.form._ComboBoxMenu.highlightFirstOption

  • summary

    Highlight the first real item in the list (not Previous Choices).

  • type

    Function

• dijit.form._ComboBoxMenu.domNode.firstChild.nextSibling

• dijit.form._ComboBoxMenu.highlightLastOption

  • summary

    Highlight the last real item in the list (not More Choices).

  • type

    Function

• dijit.form._ComboBoxMenu._highlightPrevOption

  • summary

    Highlight the item just above the current selection.
    If nothing selected, highlight last option (if
    you select Previous and try to keep scrolling up the list).

  • type

    Function

• dijit.form._ComboBoxMenu.domNode.lastChild

• dijit.form._ComboBoxMenu._highlighted_option.previousSibling

• dijit.form._ComboBoxMenu._page

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

    Handles page-up and page-down keypresses

  • type

    Function

• dijit.form._ComboBoxMenu.domNode.scrollTop

• dijit.form._ComboBoxMenu.pageUp

  • summary

    Handles pageup keypress.
    TODO: just call _page directly from handleKey().

  • tags:
  • type

    Function

• dijit.form._ComboBoxMenu.pageDown

  • summary

    Handles pagedown keypress.
    TODO: just call _page directly from handleKey().

  • tags:
  • type

    Function

• dijit.form._ComboBoxMenu.getHighlightedOption

  • summary

    Returns the highlighted option.

  • type

    Function

• dijit.form._ComboBoxMenu.handleKey

  • parameters:
    • evt
  • summary

    Handle keystroke event forwarded from ComboBox, returning false if it's
    a keystroke I recognize and process, true otherwise.

  • type

    Function

• dijit.form.ComboBox

  • type

    Function

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

    Auto-completing text box, and base class for dijit.form.FilteringSelect.

  • description

    The drop down box's values are populated from an class called
    a data provider, which returns a list of values based on the characters
    that the user has typed into the input box.
    If OPTION tags are used as the data provider via markup,
    then the OPTION tag's child text node is used as the widget value
    when selected.  The OPTION tag's value attribute is ignored.
    To set the default value when using OPTION tags, specify the selected
    attribute on 1 of the child OPTION tags.
    
    Some of the options to the ComboBox are actually arguments to the data
    provider.

• dijit.form.ComboBox._setValueAttr

  • parameters:
    • value: (typeof String)
    • priorityChange: (typeof Boolean)
    • displayedValue: (typeof String)
  • summary

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

  • description

    Sets the value of the select.

  • type

    Function

• dijit.form._ComboBoxDataStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • root: (typeof DomNode)

• dijit.form._ComboBoxDataStore.getValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • defaultValue: (typeof value)
  • type

    Function

• dijit.form._ComboBoxDataStore.isItemLoaded

  • parameters:
    • something: (typeof anything)
  • type

    Function

• dijit.form._ComboBoxDataStore.getFeatures

  • type

    Function

• dijit.form._ComboBoxDataStore._fetchItems

  • parameters:
    • args: (typeof Object)
    • findCallback: (typeof Function)
    • errorCallback: (typeof Function)
  • summary

    See dojo.data.util.simpleFetch.fetch()

  • type

    Function

• dijit.form._ComboBoxDataStore.close

  • parameters:
    • request: (typeof dojo.data.api.Request)

      || args || null

  • type

    Function

• dijit.form._ComboBoxDataStore.getLabel

  • parameters:
    • item: (typeof item)
  • type

    Function

• dijit.form._ComboBoxDataStore.getIdentity

  • parameters:
    • item: (typeof item)
  • type

    Function

• dijit.form._ComboBoxDataStore.fetchItemByIdentity

  • parameters:
    • args: (typeof Object)
  • summary

    Given the identity of an item, this method returns the item that has
    that identity through the onItem callback.
    Refer to dojo.data.api.Identity.fetchItemByIdentity() for more details.

  • description

    Given arguments like:
    
    		{identity: "CA", onItem: function(item){...}
    
    Call `onItem()` with the DOM node `<option value="CA">California</option>`

  • type

    Function

• dijit.form._ComboBoxDataStore.fetchSelectedItem

  • summary

    Get the option marked as selected, like <code>&lt;option selected&gt;</code>.
    Not part of dojo.data API.

  • type

    Function

• dijit.form._ComboBoxDataStore.root

• dijit.form._ComboBoxDataStore.root.selectedIndex

• dijit.form._ComboBoxDataStore.root.firstChild

  • type

    Object

• dijit.form._ComboBoxDataStore.root.innerHTML

  • type

    String

• dijit.form

  • type

    Object

• dijit

  • type

    Object