dojox/form/DropDownSelect (version 1.10)

Creates (and adds) the option for the given item

For the given option, add an option to our dropdown. If the option doesn't have a value, then a separator is added in that place.

Step during widget creation to copy widget attributes to the DOM according to attributeMap and _setXXXAttr objects, and also to call custom _setXXXAttr() methods.

Skips over blank/false attribute values, unless they were explicitly specified as parameters to the widget, since those are the default anyway, and setting tabIndex="" is different than not setting tabIndex at all.

For backwards-compatibility reasons attributeMap overrides _setXXXAttr when _setXXXAttr is a hash/string/array, but _setXXXAttr as a functions override attributeMap.

Roughly corresponding to dojo/on, this is the default function for processing a data-dojo-attach-event. Meant to attach to DOMNodes, not to widgets.

Iterate through the dom nodes and attach functions and nodes accordingly.

Map widget properties and functions to the handlers specified in the dom node and it's descendants. This function iterates over all nodes and looks for these properties:

• dojoAttachPoint/data-dojo-attach-point
• dojoAttachEvent/data-dojo-attach-event

Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified by commands parameter. If commands isn't specified then it's looked up from attributeMap. Note some attributes like "type" cannot be processed this way as they are not mutable.

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Handler for CSS event on this.domNode. Sets hovering and active properties depending on mouse state, which triggers _setStateClass() to set appropriate CSS classes for this.domNode.

Sets the store you would like to use with this select widget. The selected value is the value of the new store to set. This function returns the original store, in case you want to reuse it or something.

Detach and clean up the attachments made in _attachtempalteNodes.

Escape a value to be inserted into the template, either into an attribute value (ex: foo="${bar}") or as inner text of an element (ex: ${foo})

Set the value to be the first, or the selected index

Helper function to get value for specified property stored by this._set(), i.e. for properties with custom setters. Used mainly by custom getters.

For example, CheckBox._getValueAttr() calls this._get("value").

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

returns the displayed value of the widget

Returns the first child widget.

Returns first child that can be focused.

Returns the last child widget.

Returns last child that can be focused.

For the given option, return the menu item that should be used to display it. This can be overridden as needed

Returns the next descendant, compared to "child".

Returns the next or previous focusable descendant, compared to "child". Implements and extends _KeyNavMixin._getNextFocusableChild() for a _Container.

Returns an option object based off the given item. The "value" of the option item will be the identity of the item, the "label" of the option will be the label of the item.

hooks into this.attr to provide a mechanism for getting the option items for the current value of the widget.

Returns the value of the widget by reading the options for the selected flag

Called when the value of the widget is set. Calls onChange() if appropriate

Collect metadata about this widget (only once per class, not once per instance):

- list of attributes with custom setters, storing in this.constructor._setterAttrs
- generate this.constructor._onMap, mapping names like "mousedown" to functions like onMouseDown

Perform a search of the widget's options based on the user's keyboard activity

Called on keypress (and sometimes keydown), searches through this widget's children looking for items that match the user's typed search string. Multiple characters typed within 1 sec of each other are combined for multicharacter searching.

Compares the searchString to the widget's text label, returning:

* -1: a high priority match  and stop searching
* 0: not a match
* 1: a match but keep looking for a higher priority match

Work around table sizing bugs on IE7 by forcing redraw

Resets the menu and the length attribute of the button - and ensures that the label is appropriately set.

Process data-dojo-attach-point and data-dojo-attach-event for given node or widget. Returns true if caller should process baseNode's children too.

a function that will "fake" loading children, if needed, and if we have set to not load children until the widget opens.

User-overridable function which, for the given option, removes its item from the select.

Helper function to set new value for specified property, and call handlers registered with watch() if the value has changed.

Sets the displayed value of the widget

Update the visual state of the widget by setting the css classes on this.domNode (or this.stateNode if defined) by combining this.baseClass with various suffixes that represent the current widget state(s).

In the case where a widget has multiple states, it sets the class based on all possible combinations. For example, an invalid form widget that is being hovered will be "dijitInput dijitInputInvalid dijitInputHover dijitInputInvalidHover".

The widget may have one or more of the following states, determined by this.state, this.checked, this.valid, and this.selected:

• Error - ValidationTextBox sets this.state to "Error" if the current input value is invalid
• Incomplete - ValidationTextBox sets this.state to "Incomplete" if the current input value is not finished yet
• Checked - ex: a checkmark or a ToggleButton in a checked state, will have this.checked==true
• Selected - ex: currently selected tab will have this.selected==true

In addition, it may have one or more of the following states, based on this.disabled and flags set in _onMouse (this.active, this.hovering) and from focus manager (this.focused):

• Disabled - if the widget is disabled
• Active - if the mouse (or space/enter key?) is being pressed down
• Focused - if the widget has focus
• Hover - if the mouse is over the widget

Does substitution of ${foo} type properties in template string

Handler for hover/active mouse event on widget's subnode

Track mouse/focus events on specified node and set CSS class on that node to indicate current state. Usually not called directly, but via cssStateNodes attribute.

Given class=foo, will set the following CSS class on the node

• fooActive: if the user is currently pressing down the mouse button while over the node
• fooHover: if the user is hovering the mouse over the node, but not pressing down a button
• fooFocus: if the node is focused

Note that it won't set any classes if the widget is disabled.

Sets the "selected" class on the item for styling purposes

Kick off the life-cycle of a widget

Create calls a number of widget methods (postMixInProperties, buildRendering, postCreate, etc.), some of which of you'll want to override. See http://dojotoolkit.org/reference-guide/dijit/_WidgetBase.html for a discussion of the widget creation lifecycle.

Of course, adventurous developers could override create entirely, but this should only be done as a last resort.

Kicks off widget instantiation. See create() for details.

Called when focus leaves a child widget to go to a sibling widget. Used to be used by MenuBase.js (remove for 2.0)

Called when a child widget gets focus, either by user clicking it, or programatically by arrow key handling code.

It marks that the current node is the selected one, and the previously selected node no longer is.

Handler for when the container itself gets focus.

Initially the container itself has a tabIndex, but when it gets focus, switch focus to first child.

TODO for 2.0 (or earlier): Instead of having the container tabbable, always maintain a single child widget as tabbable, Requires code in startup(), addChild(), and removeChild(). That would avoid various issues like #17347.

Called on down arrow key. Should go to the next child in vertical container widgets like Menu.

Callback when the user mousedown/touchstart on the arrow icon.

Callback on mouseup/touchend after mousedown/touchstart on the arrow icon. Note that this function is called regardless of what node the event occurred on (but only after a mousedown/touchstart on the arrow).

If the drop down is a simple menu and the cursor is over the menu, we execute it, otherwise, we focus our drop down widget. If the event is missing, then we are not a mouseup event.

This is useful for the common mouse movement pattern with native browser <select> nodes:

1. mouse down on the select node (probably on the arrow)
2. move mouse to a menu item while holding down the mouse button
3. mouse up. this selects the menu item as though the user had clicked it.

Callback when the user presses a key while focused on the button node

Called on left arrow key, or right arrow key if widget is in RTL mode. Should go back to the previous child in horizontal container widgets like Toolbar.

Maps on() type parameter (ex: "mousemove") to method name (ex: "onMouseMove"). If type is a synthetic event like touch.press then returns undefined.

Called on right arrow key, or left arrow key if widget is in RTL mode. Should go to the next child in horizontal container widgets like Toolbar.

Internal method called when this widget is made visible. See onShow for details.

Called on up arrow key. Should go to the previous child in vertical container widgets like Menu.