Constructordijit.form._Spinner

dojo.require("dijit.form._Spinner");
defined in dijit/form/_Spinner.js

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 
dijit._Templated (from dijit.form._FormWidget)

Jump to PropertiesFunctionsBack to top

Construct the UI for this widget from a template, setting this.domNode.
Functioncompare(val1, val2)
compare 2 values
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
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.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
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.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._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.
Functionfilter(val)
Defined by dijit.form.TextBox
Apply specified filters to textbox value
Functionformat(value: String, constraints: Object)
Defined by dijit.form.TextBox
Replacable function to convert a value to a properly formatted string
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Defined by dijit.form.TextBox
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
Return true if this widget can currently be focused and false if not
FunctionisInRange(isFocused: Boolean)
Need to over-ride with your own validation code in subclasses
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
FunctionisValid(isFocused: Boolean)
Need to over-ride with your own validation code in subclasses
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
FunctiononChange(newValue)
callback when value is changed
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
Functionparse(value: String, constraints: Object)
Defined by dijit.form.TextBox
Replacable function to convert a formatted string to a value
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.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
user replaceable function used to validate the range of the numeric input value
user replaceable function used to generate regExp when dependent on constraints Do not specify both regExp and regExpGen
Functionserialize(val, options: Object?)
user replaceable function used to convert the getValue() result to a String
FunctionsetAttribute(attr: String, value)
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
FunctionsetDisabled(disabled: Boolean)
Set disabled state of widget (Deprecated).
FunctionsetDisplayedValue(value: String, priorityChange: Boolean?)
Defined by dijit.form.TextBox
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.
FunctionsetValue(value: Number, priorityChange: Boolean?)
Sets the value of the widget to "value" which can be of any type as determined by the widget.
Defined by dijit._Widget
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
Functionundo()
restore the value to the last value passed to onChange
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Functionvalidate(isFocused: Boolean)
Called by oninit, onblur, and onkeypress.
user replaceable function used to validate the text input against the regular expression.
Function_arrowPressed(nodePressed: Node, direction: Number)
Function_arrowState(node: Node, pressed: Boolean)
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Function_handleOnChange(newValue, priorityChange)
set the value of the widget.
Function_isEmpty(value)
Checks for whitespace
work around table sizing bugs on FF2 by forcing redraw
Defined by dijit._Widget
Function_onMouse(event)
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.
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
Defined by dijit._Templated
Function_typematicCallback(count: Number, node: DOMNode, evt)

Jump to FunctionsPropertiesBack to top

value by this much when spinning using the PgUp/Dn keys
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'
Defined by dijit._Widget
HTML class attribute
user-defined object needed to pass parameters to the validator functions
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
Defined by dijit._Widget
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.
Defined by dijit._Widget
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.
Fires onChange for each value change or only on demand
The message to display if value is invalid.
Defined by dijit._Widget
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).
Defined by dijit.form.TextBox
Converts all characters to lowercase if true. Default is false.
Defined by dijit.form.TextBox
HTML INPUT tag maxLength declaration.
Name used when submitting form; same as "name" attribute or plain HTML elements
Defined by dijit.form.TextBox
Converts the first character of each word to uppercase if true.
The message to display if value is out-of-range
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.
Defined by dijit._Widget
pointer to original dom node
Shows current state (ie, validation result) of input (Normal, Warning, or Error)
Defined by dijit._Widget
HTML style attribute
Order fields are traversed when user hits the tab key
Defined by dijit._Templated
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
Defined by dijit._Templated
a string that represents the widget template. Pre-empts the
fraction of time used to change the typematic timer between events 1.0 means that each typematic event fires at defaultTimeout intervals < 1.0 means that each typematic event fires at an increasing faster rate
Defined by dijit._Widget
See description of dijit.Tooltip.defaultPosition for details on this parameter.
Defined by dijit.form.TextBox
Removes leading and trailing whitespace if true. Default is false.
Corresponds to the native HTML <input> element's attribute.
Defined by dijit.form.TextBox
Converts all characters to uppercase if true. Default is false.
Corresponds to the native HTML <input> element's attribute.
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
Defined by dijit._Widget