dojox/mobile/IconItem (version 1.10)

dojox/mobile/_ItemBase

Summary

An icon item widget.

IconItem represents an item that has an application component and its icon image. You can tap the icon to open the corresponding application component. You can also use the icon to move to a different view by specifying either of the moveTo, href or url parameters.

Usage

var foo = new IconItem(params,srcNodeRef);
dijit/_WidgetBase
Parameter Type Description
params Object | null

Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties.

srcNodeRef DOMNode | String
Optional

If a srcNodeRef (DOM node) is specified:

  • use srcNodeRef.innerHTML as my contents
  • if this is a behavioral widget then apply behavior to that srcNodeRef
  • otherwise, replace srcNodeRef with my generated DOM tree

See the dojox/mobile/IconItem reference documentation for more information.

Property Summary

  • _attrPairNames
  • _blankGifPath to a blank 1x1 image.
  • _delayedSelectionIf true, selection is delayed 100ms and canceled if dragged in order to avoid selection when flick operation is performed.
  • _durationDuration of selection, milliseconds.
  • _handleClickIf true, this widget listens to touch events.
  • _selEndMethod
  • _selStartMethod
  • _setClassAttr
  • _setDirAttr
  • _setIdAttr
  • _setLangAttr
  • _setTabIndexAttrSets tabIndex to domNode.
  • _setTypeAttr
  • _startedstartup() has completed.
  • altAn alternate text for the icon image.
  • attributeMapDeprecated.
  • backIf true, history.back() is called when clicked.
  • badgeA text to show in a badge (ex. "55").
  • badgeClassA class name of a DOM button for a badge.
  • baseClass
  • callbackA callback function that is called when the transition has been finished.
  • class
  • clickableIf true, this item becomes clickable even if a transition destination (moveTo, etc.) is not specified.
  • containerNodeDesignates where children of the source DOM node will be placed. "Children" in this case refers to both DOM nodes and widgets.
  • contentAn HTML fragment to embed as icon content.
  • deletableIf true, you can delete this IconItem by clicking on the delete icon during edit mode.
  • deleteIconA delete icon to display at the top-left corner of the item during edit mode.
  • dirBi-directional support, as defined by the HTML DIR attribute.
  • domNodeThis is our visible representation of the widget!
  • focusedThis widget or a widget it contains has focus, or is "active" because it was recently clicked.
  • hrefA URL of another web page to go to.
  • hrefTargetA target that specifies where to open a page specified by href.
  • iconAn icon image to display.
  • iconPosThe position of an aggregated icon.
  • idA unique, opaque ID string that can be assigned by users or by the system.
  • labelA label of the item.
  • langRarely used.
  • lazyIf true, the content of the widget, which includes dojo markup, is instantiated lazily.
  • moveToThe id of the transition destination view which resides in the current page.
  • ownerDocumentThe document this widget belongs to.
  • paramsToInherit
  • requiresComma-separated required module names to be lazily loaded.
  • sceneThe name of a scene.
  • selectedIf true, the item is highlighted to indicate it is selected.
  • srcNodeRefpointer to original DOM node
  • styleHTML style attributes as cssText string or name/value hash
  • tabIndexTabindex setting for the item so users can hit the tab key to focus on it.
  • tagA name of the HTML tag to create as domNode.
  • timeoutDuration of highlight in seconds.
  • titleHTML title attribute.
  • toggleIf true, the item acts like a toggle button.
  • tooltipWhen this widget's title attribute is used to for a tab label, accordion pane title, etc., this specifies the tooltip to appear when the mouse is hovered over that text.
  • transitionA type of animated transition effect.
  • transitionDirThe transition direction.
  • transitionOptionsA hash object that holds transition options.
  • urlA URL of an html fragment page or JSON data that represents a new view content.
  • urlTargetNode id under which a new view will be created according to the url parameter.

Method Summary

  • _applyAttributes() Step during widget creation to copy widget attributes to the DOM according to attributeMap and _setXXXAttr objects, and also to call custom _setXXXAttr() methods.
  • _attrToDom(attr,value,commands) Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified by commands parameter.
  • _changeAttrValue(name,value) Internal helper for directly changing an attribute value.
  • _closeIconClicked(e) Internal handler for click events.
  • _disconnect()
  • _get(name) Helper function to get value for specified property stored by this._set(), i.e. for properties with custom setters.
  • _getAttrNames(name) Helper function for get() and set().
  • _getBadgeAttr()
  • _getSibling(which) Returns next or previous sibling
  • _getSiblingOfChild(child,dir) Get the next or previous widget sibling of child
  • _introspect() 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
  • _open_1() Opens the icon content for the 'below' transition.
  • _prepareForTransition(e,transOpts)
  • _set(name,value) Helper function to set new value for specified property, and call handlers registered with watch() if the value has changed.
  • _setBadgeAttr(value)
  • _setContentAttr(data)
  • _setDeleteIconAttr(icon)
  • _setIconAttr(icon)
  • _setLabelAttr(text)
  • _setOwnerDocumentAttr(val)
  • _setSelectedAttr(selected) Makes this widget in the selected or unselected state.
  • _setStyleAttr(value) Sets the style attribute of the widget according to value, which is either a hash like {height: "5px", width: "3px"} or a plain string
  • _updateHandles()
  • addChild(widget,insertIndex) Makes the given widget a child of this widget.
  • buildRendering()
  • cancel() Cancels an ongoing selection (if any).
  • close(noAnimation) Closes the icon content.
  • closeIconClicked(e) User-defined function to handle clicks for the close icon.
  • connect(obj,event,method) Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.
  • create(params,srcNodeRef) Kick off the life-cycle of a widget
  • defaultClickAction(e) The default action of this item.
  • defer(fcn,delay) Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed.
  • destroy()
  • destroyDescendants(preserveDom) Recursively destroy the children of this widget and their descendants.
  • destroyRecursive(preserveDom) Destroy this widget and its descendants
  • destroyRendering(preserveDom) Destroys the DOM nodes associated with this widget.
  • disconnect(handle) Deprecated, will be removed in 2.0, use handle.remove() instead.
  • emit(type,eventObj,callbackArgs) Used by widgets to signal that a synthetic event occurred, ex: myWidget.emit("attrmodified-selectedChildWidget", {}).
  • get(name) Get a property from a widget.
  • getChildren() Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget.
  • getIndexInParent() Returns the index of this widget within its container parent.
  • getIndexOfChild(child) Gets the index of the child in this container or -1 if not found
  • getNextSibling() Returns null if this is the last child of the parent, otherwise returns the next element sibling to the "right".
  • getParent() Returns the parent widget of this widget.
  • getPreviousSibling() Returns null if this is the first child of the parent, otherwise returns the next element sibling to the "left".
  • getTransOpts() Copies from the parent and returns the values of parametersspecified by the property paramsToInherit.
  • handleSelection(e) Handles this items selection state.
  • hasChildren() Returns true if widget has child widgets, i.e. if this.containerNode contains widgets.
  • highlight(timeout) Shakes the icon 10 seconds.
  • inheritParams() Copies from the parent the values of parameters specified by the property paramsToInherit.
  • isFocusable() Return true if this widget can currently be focused and false if not
  • isLeftToRight() Return this widget's explicit or implicit orientation (true for LTR, false for RTL)
  • isOpen(e) Returns true if the icon is open.
  • makeTransition(e) Makes a transition.
  • on(type,func) Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).
  • open(e) Opens the icon content, or makes a transition.
  • own() Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.
  • placeAt(reference,position) Place this widget somewhere in the DOM based on standard domConstruct.place() conventions.
  • postCreate() Processing after the DOM fragment is created
  • postMixInProperties() Called after the parameters to the widget have been read-in, but before the widget template is instantiated.
  • postscript(params,srcNodeRef) Kicks off widget instantiation.
  • removeChild(widget) Removes the passed widget instance from this widget but does not destroy it.
  • scrollIntoView(node) Scrolls until the given node is in the view.
  • set(name,value) Set a property on a widget
  • setTransitionPos(e) Stores the clicked position for later use.
  • startup()
  • subscribe(t,method) Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.
  • toString() Returns a string that represents the widget.
  • transitionTo(moveTo,href,url,scene) Performs a view transition.
  • unhighlight() Stops shaking the icon.
  • uninitialize() Deprecated.
  • unsubscribe(handle) Deprecated, will be removed in 2.0, use handle.remove() instead.
  • userClickAction(e) User-defined click action.
  • watch(name,callback) Watches a property for changes

Event Summary

  • _onBlur() This is where widgets do processing for when they stop being active, such as changing CSS classes.
  • _onClick(e) Internal handler for click events.
  • _onFocus() This is where widgets do processing for when they are active, such as changing CSS classes.
  • _onMap(type) Maps on() type parameter (ex: "mousemove") to method name (ex: "onMouseMove").
  • _onNewWindowOpened(e)
  • _onTouchEnd(e)
  • _onTouchMove(e)
  • _onTouchStart(e)
  • onBlur() Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.
  • onClick(e) User-defined function to handle clicks.
  • onClose() Stub method to allow the application to connect.
  • onFocus() Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
  • onOpen() Stub method to allow the application to connect.
  • onTouchStart(e) User-defined function to handle touchStart events.

Properties

_attrPairNames
Defined by: dijit/_WidgetBase
_blankGif
Defined by: dijit/_WidgetBase

Path to a blank 1x1 image. Used by <img> nodes in templates that really get their image via CSS background-image.

_delayedSelection

If true, selection is delayed 100ms and canceled if dragged in order to avoid selection when flick operation is performed.

_duration

Duration of selection, milliseconds.

_handleClick

If true, this widget listens to touch events.

_selEndMethod
Defined by: dojox/mobile/IconItem
_selStartMethod
Defined by: dojox/mobile/IconItem
_setClassAttr
Defined by: dijit/_WidgetBase
_setDirAttr
Defined by: dijit/_WidgetBase
_setIdAttr
Defined by: dijit/_WidgetBase
_setLangAttr
Defined by: dijit/_WidgetBase
_setTabIndexAttr

Sets tabIndex to domNode.

_setTypeAttr
Defined by: dijit/_WidgetBase
_started
Defined by: dijit/_WidgetBase

startup() has completed.

alt

An alternate text for the icon image.

attributeMap
Defined by: dijit/_WidgetBase

Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute for each XXX attribute to be mapped to the DOM.

attributeMap sets up a "binding" between attributes (aka properties) of the widget and the widget's DOM. Changes to widget attributes listed in attributeMap will be reflected into the DOM.

For example, calling set('title', 'hello') on a TitlePane will automatically cause the TitlePane's DOM to update with the new title.

attributeMap is a hash where the key is an attribute of the widget, and the value reflects a binding to a:

  • DOM node attribute

    focus: {node: "focusNode", type: "attribute"} Maps this.focus to this.focusNode.focus

  • DOM node innerHTML

    title: { node: "titleNode", type: "innerHTML" } Maps this.title to this.titleNode.innerHTML

  • DOM node innerText

    title: { node: "titleNode", type: "innerText" } Maps this.title to this.titleNode.innerText

  • DOM node CSS class

    myClass: { node: "domNode", type: "class" } Maps this.myClass to this.domNode.className

If the value is an array, then each element in the array matches one of the formats of the above list.

There are also some shorthands for backwards compatibility:

  • string --> { node: string, type: "attribute" }, for example:
"focusNode" ---> { node: "focusNode", type: "attribute" }
  • "" --> { node: "domNode", type: "attribute" }
back

If true, history.back() is called when clicked.

badge
Defined by: dojox/mobile/IconItem

A text to show in a badge (ex. "55").

badgeClass
Defined by: dojox/mobile/IconItem

A class name of a DOM button for a badge.

baseClass
Defined by: dojox/mobile/IconItem
callback

A callback function that is called when the transition has been finished. A function reference, or name of a function in context.

class
Defined by: dijit/_WidgetBase
clickable

If true, this item becomes clickable even if a transition destination (moveTo, etc.) is not specified.

containerNode
Defined by: dijit/_WidgetBase

Designates where children of the source DOM node will be placed. "Children" in this case refers to both DOM nodes and widgets. For example, for myWidget:

<div data-dojo-type=myWidget>
    <b> here's a plain DOM node
    <span data-dojo-type=subWidget>and a widget</span>
    <i> and another plain DOM node </i>
</div>

containerNode would point to:

<b> here's a plain DOM node
<span data-dojo-type=subWidget>and a widget</span>
<i> and another plain DOM node </i>

In templated widgets, "containerNode" is set via a data-dojo-attach-point assignment.

containerNode must be defined for any widget that accepts innerHTML (like ContentPane or BorderContainer or even Button), and conversely is null for widgets that don't, like TextBox.

content
Defined by: dojox/mobile/IconItem

An HTML fragment to embed as icon content.

deletable
Defined by: dojox/mobile/IconItem

If true, you can delete this IconItem by clicking on the delete icon during edit mode. If false, the delete icon is not displayed during edit mode so that it cannot be deleted.

deleteIcon
Defined by: dojox/mobile/IconItem

A delete icon to display at the top-left corner of the item during edit mode. The value can be either a path for an image file or a class name of a DOM button.

dir
Defined by: dijit/_WidgetBase

Bi-directional support, as defined by the HTML DIR attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's default direction.

domNode
Defined by: dijit/_WidgetBase

This is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's data-dojo-attach-point syntax, but the domNode property is the canonical "top level" node in widget UI.

focused
Defined by: dijit/_FocusMixin

This widget or a widget it contains has focus, or is "active" because it was recently clicked.

href

A URL of another web page to go to.

hrefTarget

A target that specifies where to open a page specified by href. The value will be passed to the 2nd argument of window.open().

icon

An icon image to display. The value can be either a path for an image file or a class name of a DOM button. If icon is not specified, the iconBase parameter of the parent widget is used.

iconPos

The position of an aggregated icon. IconPos is comma separated values like top,left,width,height (ex. "0,0,29,29"). If iconPos is not specified, the iconPos parameter of the parent widget is used.

id
Defined by: dijit/_WidgetBase

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.

label

A label of the item. If the label is not specified, innerHTML is used as a label.

lang
Defined by: dijit/_WidgetBase

Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the HTML LANG attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to RFC 3066 (like en-us).

lazy
Defined by: dojox/mobile/IconItem

If true, the content of the widget, which includes dojo markup, is instantiated lazily. That is, only when the widget is opened by the user, the required modules are loaded and the content widgets are instantiated. This option works both in the sync and async loader mode.

moveTo

The id of the transition destination view which resides in the current page.

If the value has a hash sign ('#') before the id (e.g. #view1) and the dojo/hash module is loaded by the user application, the view transition updates the hash in the browser URL so that the user can bookmark the destination view. In this case, the user can also use the browser's back/forward button to navigate through the views in the browser history.

If null, transitions to a blank view. If '#', returns immediately without transition.

ownerDocument
Defined by: dijit/_WidgetBase

The document this widget belongs to. If not specified to constructor, will default to srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global

paramsToInherit
Defined by: dojox/mobile/IconItem
requires
Defined by: dojox/mobile/IconItem

Comma-separated required module names to be lazily loaded. This property is effective only when lazy=true. All the modules specified with data-dojo-type and their depending modules are automatically loaded by the IconItem when it is opened. However, if you need other extra modules to be loaded, use this parameter. This option works both in the sync and async loader mode.

scene

The name of a scene. Used from dojox/mobile/app.

selected

If true, the item is highlighted to indicate it is selected.

srcNodeRef
Defined by: dijit/_WidgetBase

pointer to original DOM node

style
Defined by: dijit/_WidgetBase

HTML style attributes as cssText string or name/value hash

tabIndex

Tabindex setting for the item so users can hit the tab key to focus on it.

tag
Defined by: dojox/mobile/IconItem

A name of the HTML tag to create as domNode.

timeout
Defined by: dojox/mobile/IconItem

Duration of highlight in seconds.

title
Defined by: dijit/_WidgetBase

HTML title attribute.

For form widgets this specifies a tooltip to display when hovering over the widget (just like the native HTML title attribute).

For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, etc., it's used to specify the tab label, accordion pane title, etc. In this case it's interpreted as HTML.

toggle

If true, the item acts like a toggle button.

tooltip
Defined by: dijit/_WidgetBase

When this widget's title attribute is used to for a tab label, accordion pane title, etc., this specifies the tooltip to appear when the mouse is hovered over that text.

transition

A type of animated transition effect. You can choose from the standard transition types, "slide", "fade", "flip", or from the extended transition types, "cover", "coverv", "dissolve", "reveal", "revealv", "scaleIn", "scaleOut", "slidev", "swirl", "zoomIn", "zoomOut", "cube", and "swap". If "none" is specified, transition occurs immediately without animation.

transitionDir

The transition direction. If 1, transition forward. If -1, transition backward. For example, the slide transition slides the view from right to left when dir == 1, and from left to right when dir == -1.

transitionOptions

A hash object that holds transition options.

url

A URL of an html fragment page or JSON data that represents a new view content. The view content is loaded with XHR and inserted in the current page. Then a view transition occurs to the newly created view. The view is cached so that subsequent requests would not load the content again.

urlTarget

Node id under which a new view will be created according to the url parameter. If not specified, The new view will be created as a sibling of the current view.

Methods

_applyAttributes()
Defined by dijit/_WidgetBase

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.

_attrToDom(attr,value,commands)
Defined by dijit/_WidgetBase

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.

Parameter Type Description
attr String

Name of member variable (ex: "focusNode" maps to this.focusNode) pointing to DOMNode inside the widget, or alternately pointing to a subwidget

value String
commands Object
Optional
_changeAttrValue(name,value)
Defined by dojo/Stateful

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.

Parameter Type Description
name String

The property to set.

value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_closeIconClicked(e)

Internal handler for click events.

Parameter Type Description
e undefined
_disconnect()
_get(name)
Defined by dijit/_WidgetBase

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").

Parameter Type Description
name String
Returns:undefined
_getAttrNames(name)
Defined by dijit/_WidgetBase

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

Parameter Type Description
name undefined
Returns:undefined | object
_getBadgeAttr()
Returns:null
_getSibling(which)
Defined by dijit/_Contained

Returns next or previous sibling

Parameter Type Description
which String

Either "next" or "previous"

Returns:undefined
_getSiblingOfChild(child,dir)
Defined by dijit/_Container

Get the next or previous widget sibling of child

Parameter Type Description
child dijit/_WidgetBase
dir int

if 1, get the next sibling if -1, get the previous sibling

Returns:undefined
_introspect()
Defined by dijit/_WidgetBase

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
_open_1()

Opens the icon content for the 'below' transition.

_prepareForTransition(e,transOpts)
Parameter Type Description
e undefined
transOpts undefined
Returns:boolean
_set(name,value)
Defined by dijit/_WidgetBase

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

Parameter Type Description
name String
value anything
_setBadgeAttr(value)
Parameter Type Description
value String
_setContentAttr(data)
Parameter Type Description
data String | DomNode
_setDeleteIconAttr(icon)
Parameter Type Description
icon undefined
_setIconAttr(icon)
Parameter Type Description
icon undefined
_setLabelAttr(text)
Parameter Type Description
text String
_setOwnerDocumentAttr(val)
Defined by dijit/_WidgetBase
Parameter Type Description
val undefined
_setSelectedAttr(selected)

Makes this widget in the selected or unselected state.

Parameter Type Description
selected Boolean
_setStyleAttr(value)
Defined by dijit/_WidgetBase

Sets the style attribute of the widget according to value, which is either a hash like {height: "5px", width: "3px"} or a plain string

Determines which node to set the style on based on style setting in attributeMap.

Parameter Type Description
value String | Object
_updateHandles()
addChild(widget,insertIndex)
Defined by dijit/_Container

Makes the given widget a child of this widget.

Inserts specified child widget's dom node as a child of this widget's container node, and possibly does other processing (such as layout).

Parameter Type Description
widget dijit/_WidgetBase
insertIndex int
Optional
buildRendering()
cancel()

Cancels an ongoing selection (if any).

close(noAnimation)

Closes the icon content.

Parameter Type Description
noAnimation Boolean
Optional
closeIconClicked(e)

User-defined function to handle clicks for the close icon.

Parameter Type Description
e Event
connect(obj,event,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.

Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy.

Provide widget-specific analog to dojo.connect, except with the implicit use of this widget as the target object. Events connected with this.connect are disconnected upon destruction.

Parameter Type Description
obj Object | null
event String | Function
method String | Function
Returns:any | undefined

A handle that can be passed to disconnect in order to disconnect before the widget is destroyed.

Examples

Example 1

var btn = new Button();
// when foo.bar() is called, call the listener we're going to
// provide in the scope of btn
btn.connect(foo, "bar", function(){
    console.debug(this.toString());
});
create(params,srcNodeRef)
Defined by dijit/_WidgetBase

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.

Parameter Type Description
params Object | null

Hash of initialization parameters for widget, including scalar values (like title, duration etc.) and functions, typically callbacks like onClick. The hash can contain any of the widget's properties, excluding read-only properties.

srcNodeRef DOMNode | String
Optional

If a srcNodeRef (DOM node) is specified:

  • use srcNodeRef.innerHTML as my contents
  • if this is a behavioral widget then apply behavior to that srcNodeRef
  • otherwise, replace srcNodeRef with my generated DOM tree
defaultClickAction(e)

The default action of this item.

Parameter Type Description
e Event
defer(fcn,delay)
Defined by dijit/_WidgetBase

Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed. Returns an object handle with a remove method (that returns null) (replaces clearTimeout).

Parameter Type Description
fcn Function

Function reference.

delay Number
Optional

Delay, defaults to 0.

Returns:object
destroy()
destroyDescendants(preserveDom)
Defined by dijit/_WidgetBase

Recursively destroy the children of this widget and their descendants.

Parameter Type Description
preserveDom Boolean
Optional

If true, the preserveDom attribute is passed to all descendant widget's .destroy() method. Not for use with _Templated widgets.

destroyRecursive(preserveDom)
Defined by dijit/_WidgetBase

Destroy this widget and its 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 is removed from the manager object.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone of descendant Widgets. Note: This will NOT work with dijit._TemplatedMixin widgets.

destroyRendering(preserveDom)
Defined by dijit/_WidgetBase

Destroys the DOM nodes associated with this widget.

Parameter Type Description
preserveDom Boolean
Optional

If true, this method will leave the original DOM structure alone during tear-down. Note: this will not work with _Templated widgets yet.

disconnect(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Disconnects handle created by connect.

Parameter Type Description
handle undefined
emit(type,eventObj,callbackArgs)
Defined by dijit/_WidgetBase

Used by widgets to signal that a synthetic event occurred, ex:

myWidget.emit("attrmodified-selectedChildWidget", {}).

Emits an event on this.domNode named type.toLowerCase(), based on eventObj. Also calls onType() method, if present, and returns value from that method. By default passes eventObj to callback, but will pass callbackArgs instead, if specified. Modifies eventObj by adding missing parameters (bubbles, cancelable, widget).

Parameter Type Description
type String
eventObj Object
Optional
callbackArgs Array
Optional
Returns:undefined
get(name)
Defined by dijit/_WidgetBase

Get a property from a widget.

Get a named property from a widget. The property may potentially be retrieved via a getter method. If no getter is defined, this just retrieves the object's property.

For example, if the widget has properties foo and bar and a method named _getFooAttr(), calling: myWidget.get("foo") would be equivalent to calling widget._getFooAttr() and myWidget.get("bar") would be equivalent to the expression widget.bar2

Parameter Type Description
name undefined

The property to get.

Returns:undefined
getChildren()
Defined by dijit/_WidgetBase

Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget. Note that it does not return all descendants, but rather just direct children. Analogous to Node.childNodes, except containing widgets rather than DOMNodes.

The result intentionally excludes internally created widgets (a.k.a. supporting widgets) outside of this.containerNode.

Note that the array returned is a simple array. Application code should not assume existence of methods like forEach().

Returns:Array
getIndexInParent()
Defined by dijit/_Contained

Returns the index of this widget within its container parent. It returns -1 if the parent does not exist, or if the parent is not a dijit/_Container

Returns:number | undefined
getIndexOfChild(child)
Defined by dijit/_Container

Gets the index of the child in this container or -1 if not found

Parameter Type Description
child dijit/_WidgetBase
Returns:undefined
getNextSibling()
Defined by dijit/_Contained

Returns null if this is the last child of the parent, otherwise returns the next element sibling to the "right".

Returns:undefined
getParent()
Defined by dijit/_WidgetBase

Returns the parent widget of this widget.

Returns:undefined
getPreviousSibling()
Defined by dijit/_Contained

Returns null if this is the first child of the parent, otherwise returns the next element sibling to the "left".

Returns:undefined
getTransOpts()

Copies from the parent and returns the values of parameters
specified by the property paramsToInherit.

Returns:string
handleSelection(e)

Handles this items selection state.

Parameter Type Description
e Event
hasChildren()
Defined by dijit/_Container

Returns true if widget has child widgets, i.e. if this.containerNode contains widgets.

Returns:boolean
highlight(timeout)

Shakes the icon 10 seconds.

Parameter Type Description
timeout Number
Optional
inheritParams()

Copies from the parent the values of parameters specified by the property paramsToInherit.

Returns:boolean
isFocusable()
Defined by dijit/_WidgetBase

Return true if this widget can currently be focused and false if not

Returns:undefined
isLeftToRight()
Defined by dijit/_WidgetBase

Return this widget's explicit or implicit orientation (true for LTR, false for RTL)

Returns:undefined
isOpen(e)

Returns true if the icon is open.

Parameter Type Description
e undefined
Returns:undefined
makeTransition(e)

Makes a transition.

Parameter Type Description
e Event
on(type,func)
Defined by dijit/_WidgetBase

Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).

Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). Note that the function is not run in any particular scope, so if (for example) you want it to run in the widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)).

Parameter Type Description
type String | Function

Name of event (ex: "click") or extension event like touch.press.

func Function
Returns:undefined
open(e)

Opens the icon content, or makes a transition.

Parameter Type Description
e undefined
own()
Defined by dijit/Destroyable

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Returns:any | undefined

The array of specified handles, so you can do for example:

var handle = this.own(on(...))[0];
placeAt(reference,position)
Defined by dijit/_WidgetBase

Place this widget somewhere in the DOM based on standard domConstruct.place() conventions.

A convenience function provided in all _Widgets, providing a simple shorthand mechanism to put an existing (or newly created) Widget somewhere in the dom, and allow chaining.

Parameter Type Description
reference String | DomNode | DocumentFragment | dijit/_WidgetBase

Widget, DOMNode, DocumentFragment, or id of widget or DOMNode

position String | Int
Optional

If reference is a widget (or id of widget), and that widget has an ".addChild" method, it will be called passing this widget instance into that method, supplying the optional position index passed. In this case position (if specified) should be an integer.

If reference is a DOMNode (or id matching a DOMNode but not a widget), the position argument can be a numeric index or a string "first", "last", "before", or "after", same as dojo/dom-construct::place().

Returns:dijit/_WidgetBase | function

Provides a useful return of the newly created dijit._Widget instance so you can "chain" this function by instantiating, placing, then saving the return value to a variable.

Examples

Example 1

// create a Button with no srcNodeRef, and place it in the body:
var button = new Button({ label:"click" }).placeAt(win.body());
// now, 'button' is still the widget reference to the newly created button
button.on("click", function(e){ console.log('click'); }));

Example 2

// create a button out of a node with id="src" and append it to id="wrapper":
var button = new Button({},"src").placeAt("wrapper");

Example 3

// place a new button as the first element of some div
var button = new Button({ label:"click" }).placeAt("wrapper","first");

Example 4

// create a contentpane and add it to a TabContainer
var tc = dijit.byId("myTabs");
new ContentPane({ href:"foo.html", title:"Wow!" }).placeAt(tc)
postCreate()
Defined by dijit/_WidgetBase

Processing after the DOM fragment is created

Called after the DOM fragment has been created, but not necessarily added to the document. Do not include any operations which rely on node dimensions or placement.

postMixInProperties()
Defined by dijit/_WidgetBase

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.

postscript(params,srcNodeRef)
Defined by dijit/_WidgetBase

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

Parameter Type Description
params Object
Optional
srcNodeRef DomNode | String
removeChild(widget)
Defined by dijit/_Container

Removes the passed widget instance from this widget but does not destroy it. You can also pass in an integer indicating the index within the container to remove (ie, removeChild(5) removes the sixth widget).

Parameter Type Description
widget Widget | int
scrollIntoView(node)

Scrolls until the given node is in the view.

Parameter Type Description
node DomNode
set(name,value)
Defined by dijit/_WidgetBase

Set a property on a widget

Sets named properties on a widget which may potentially be handled by a setter in the widget.

For example, if the widget has properties foo and bar and a method named _setFooAttr(), calling myWidget.set("foo", "Howdy!") would be equivalent to calling widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) would be equivalent to the statement widget.bar = 3;

set() may also be called with a hash of name/value pairs, ex:

myWidget.set({
    foo: "Howdy",
    bar: 3
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Parameter Type Description
name undefined

The property to set.

value undefined

The value to set in the property.

Returns:function | string

Set a property on a widget

setTransitionPos(e)

Stores the clicked position for later use.

Some of the transition animations (e.g. ScaleIn) need the clicked position.

Parameter Type Description
e undefined
startup()
subscribe(t,method)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.

Subscribes to the specified topic and calls the specified method of this object and registers for unsubscribe() on widget destroy.

Provide widget-specific analog to dojo.subscribe, except with the implicit use of this widget as the target object.

Parameter Type Description
t String

The topic

method Function

The callback

Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
toString()
Defined by dijit/_WidgetBase

Returns a string that represents the widget.

When a widget is cast to a string, this method will be used to generate the output. Currently, it does not implement any sort of reversible serialization.

Returns:string
transitionTo(moveTo,href,url,scene)

Performs a view transition.

Given a transition destination, this method performs a view transition. This method is typically called when this item is clicked.

Parameter Type Description
moveTo String | Object
href String
url String
scene String
unhighlight()

Stops shaking the icon.

uninitialize()
Defined by dijit/_WidgetBase

Deprecated. Override destroy() instead to implement custom widget tear-down behavior.

Returns:boolean
unsubscribe(handle)
Defined by dijit/_WidgetBase

Deprecated, will be removed in 2.0, use handle.remove() instead.

Unsubscribes handle created by this.subscribe. Also removes handle from this widget's list of subscriptions

Parameter Type Description
handle Object
userClickAction(e)

User-defined click action.

Parameter Type Description
e Event
watch(name,callback)
Defined by dojo/Stateful

Watches a property for changes

Parameter Type Description
name String
Optional

Indicates the property to watch. This is optional (the callback may be the only parameter), and if omitted, all the properties will be watched

callback Function

The function to execute when the property changes. This will be called after the property has been changed. The callback will be called with the |this| set to the instance, the first argument as the name of the property, the second argument as the old value and the third argument as the new value.

Returns:any | object

An object handle for the watch. The unwatch method of this object can be used to discontinue watching this property:

var watchHandle = obj.watch("foo", callback);
watchHandle.unwatch(); // callback won't be called now

Events

_onBlur()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they stop being active, such as changing CSS classes. See onBlur() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onClick(e)
Defined by: dojox/mobile/IconItem

Internal handler for click events.

Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onFocus()
Defined by: dijit/_FocusMixin

This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onMap(type)
Defined by: dijit/_WidgetBase

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

Parameter Type Description
type String | Function
Returns:undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onNewWindowOpened(e)
Defined by: dojox/mobile/IconItem
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onTouchEnd(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onTouchMove(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
_onTouchStart(e)
Parameter Type Description
e undefined

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onBlur()
Defined by: dijit/_FocusMixin

Called when the widget stops being "active" because focus moved to something outside of it, or the user clicked somewhere outside of it, or the widget was hidden.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onClick(e)
Defined by: dojox/mobile/IconItem

User-defined function to handle clicks.

Parameter Type Description
e Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onClose()
Defined by: dojox/mobile/IconItem

Stub method to allow the application to connect.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onFocus()
Defined by: dijit/_FocusMixin

Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onOpen()
Defined by: dojox/mobile/IconItem

Stub method to allow the application to connect.

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
onTouchStart(e)

User-defined function to handle touchStart events.

Parameter Type Description
e Event

Examples

Example 1

var btn = new Button();
// when /my/topic is published, this button changes its label to
// be the parameter of the topic.
btn.subscribe("/my/topic", function(v){
    this.set("label", v);
});
Error in the documentation? Can’t find what you are looking for? Let us know!