Only private and/or inherited functions are available.
Construct the UI for this widget from a template, setting this.domNode.
When inputting characters using an input method, such as Asian languages, it will generate this event instead of onKeyDown event Note: this event is only triggered in FF (not in IE)
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Kick off the life-cycle of a widget
Destroy this widget, but not its descendants
Recursively destroy the children of this widget and their descendants.
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Destroys the DOM nodes associated with this widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
User overridable method to display validation errors/hints. By default uses a tooltip.
Apply specified filters to textbox value
Replacable function to convert a value to a properly formatted string
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Returns the formatted value that the user sees in the textbox, which may be different from the serialized value that's actually sent to the server (see dijit.form.ValidationTextBox.serialize)
return an error message to show if appropriate
return a hint to show if appropriate
get the value of the widget.
Return true if this widget can currently be focused and false if not
Checks the DOM to for the text direction for bi-directional support
Need to over-ride with your own validation code in subclasses
Event handler called when the label changes return: the label that the ComboBox should display
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
callback when value is changed
Callback if someone tries to close the child, child will be closed if func returns true
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
parse(value, constraints)
Replacable function to convert a formatted string to a value
Called after a widget's dom has been setup
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
user replaceable function used to generate regExp when dependent on constraints Do not specify both regExp and regExpGen
user replaceable function used to convert the getValue() result to a String
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
Set disabled state of widget (Deprecated).
Sets the value of the visual element to the string "value". The widget value is also set to a corresponding, but not necessarily the same, value.
Sets the value of the select. Also sets the label to the corresponding value by reverse lookup.
Called after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.
display the widget as a printable string using the widget's value
restore the value to the last value passed to onChange
stub function. Override to implement custom widget tear-down behavior.
Called by oninit, onblur, and onkeypress.
user replaceable function used to validate the text input against the regular expression.
a11y code that puts the highlighted option in the textbox This way screen readers will know what is happening in the menu
Iterate through the template and attach functions and nodes accordingly.
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.
Callback function that dynamically sets the label of the ComboBox
ComboBox's menu callback function
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
set the value of the widget.
work around table sizing bugs on FF2 by forcing redraw
callback when arrow is clicked
called magically when focus has shifted away from this widget and it's dropdown
Sets _hovering, _active, and stateModifier properties depending on mouse state, then calls setStateClass() to set appropriate CSS classes for this.domNode. To get a different CSS class for hover, send onmouseover and onmouseout events to this method. To get a different CSS class while mouse button is depressed, send onmousedown to this method.
additional code to set disablbed state of combobox node
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". For complex widgets with multiple regions, there can be various hover/active states, such as "Hover" or "CloseButtonHover" (for tab buttons). This is controlled by a stateModifier="CloseButton" attribute on the close button node. 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 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, 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
Set the displayed valued in the input box, based on a selected item.
Only private and/or inherited properties are available.
Corresponds to the native HTML <input> element's attribute.
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
If you type in a partial string, and then tab out of the `<input>` box, automatically copy the first entry displayed in the drop down list to the `<input>` field
user-defined object needed to pass parameters to the validator functions
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
Should this widget respond to user input? In markup, this is specified as "disabled='disabled'", or just "disabled".
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
Set this textbox to have a down arrow button. Defaults to true.
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Set true if the ComboBox should ignore case when matching possible items
Fires onChange for each value change or only on demand
The message to display if value is invalid.
This is the item returned by the dojo.data.store implementation that provides the data for this cobobox, it's the currently selected item.
Optional. The text that actually appears in the drop down. If not specified, the searchAttr text is used instead.
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
Converts all characters to lowercase if true. Default is false.
HTML INPUT tag maxLength declaration.
Name used when submitting form; same as "name" attribute or plain HTML elements
Argument to data provider. Specifies number of search results per page (before hitting "next" button)
Converts the first character of each word to uppercase if true.
A query that can be passed to 'store' to initially filter the items, before doing further filtering based on `searchAttr` and the key. Any reference to the `searchAttr` is ignored.
dojo.data query expression pattern. `${0}` will be substituted for the user text. `*` is used for wildcards. `${0}*` means "starts with", `*${0}*` means "contains", `${0}` means "is"
Should this widget respond to user input? In markup, this is specified as "readOnly". Similar to disabled except readOnly form values are submitted
regular expression string used to validate the input Do not specify both regExp and regExpGen
values for new subclass properties Boolean Can be true or false, default is false.
Searches pattern match against this field
Delay in milliseconds between when user types something and we start searching based on that value
pointer to original dom node
Shows current state (ie, validation result) of input (Normal, Warning, or Error)
Reference to data provider object used by this ComboBox
Order fields are traversed when user hits the tab key
a node that represents the widget template. Pre-empts both templateString and templatePath.
Path to template (HTML file) for this widget relative to dojo.baseUrl
a string that represents the widget template. Pre-empts the
See description of dijit.Tooltip.defaultPosition for details on this parameter.
Removes leading and trailing whitespace if true. Default is false.
Corresponds to the native HTML <input> element's attribute.
Converts all characters to uppercase if true. Default is false.
Corresponds to the native HTML <input> element's attribute.
should we parse the template to find widgets that might be declared in markup inside it? false by default.