Constructordijit.form.ToggleButton

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

A button that can be in two states (checked or not). Can be base class for things like tabs or checkbox or radio buttons

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.
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
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
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.form.Button
user callback for when button is clicked if type="submit", return true to perform submit
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.
get label and set as title on button icon if necessary
Defined by dijit._Widget
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
FunctionsetAttribute(attr: String, value)
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
FunctionsetChecked(checked: Boolean)
Programatically deselect the button
FunctionsetDisabled(disabled: Boolean)
Set disabled state of widget (Deprecated).
FunctionsetLabel(content: String)
Defined by dijit.form.Button
reset the label (text) of the button; takes an HTML string
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.
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Function_clicked(evt)
internal replaceable function for when the button is clicked
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.
work around table sizing bugs on FF2 by forcing redraw
Defined by dijit._Widget
Defined by dijit.form.Button
callback when the user mouse clicks the button portion
Defined by dijit.form.Button
internal function to handle click actions
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

Jump to FunctionsPropertiesBack to top

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'
Corresponds to the native HTML <input> element's attribute. In markup, specified as "checked='checked'" or just "checked". True if the button is depressed, or the checkbox is checked, or the radio button is selected, etc.
Defined by dijit._Widget
HTML class attribute
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.form.Button
class to apply to div in button to make it display an icon
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
Defined by dijit.form.Button
text to display in button
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).
Name used when submitting form; same as "name" attribute or plain HTML elements
Should this widget respond to user input? In markup, this is specified as "readOnly". Similar to disabled except readOnly form values are submitted
Defined by dijit.form.Button
whether or not to display the text label in button
Defined by dijit._Widget
pointer to original dom node
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
Defined by dijit._Widget
Corresponds to the native HTML <input> element's attribute.
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