Class Index | File Index

Classes


Built-In Namespace _global_

Field Summary
Field Attributes Field Name and Description
 
Class to apply to DOMNode in button to make it display an icon
 
Indicates that this widget acts as a "parent" to the descendant widgets.
 
Text to display in button.
 
Set this to true to hide the label text and display only the icon.
 
Defines the type of button.
Method Summary
Method Attributes Method Name and Description
 
Internal overridable function for when the button is clicked
<private>  
_getSiblingOfChild(child, dir)
Get the next or previous widget sibling of child
<private>  
Handler when the user activates the button portion.
<private>  
Internal function to handle click actions
<private>  
_setLabelAttr(content)
Hook for set('label', .
 
addChild(widget, insertIndex)
Makes the given widget a child of this widget.
 
Gets the index of the child in this container or -1 if not found
 
Returns true if widget has children, i.e.
 
Callback for when button is clicked.
 
removeChild(widget)
Removes the passed widget instance from this widget but does not destroy it.
 
setLabel(content)
Field Detail
{String} iconClass
Class to apply to DOMNode in button to make it display an icon
Defined in: Button.js.

{Boolean} isContainer
Indicates that this widget acts as a "parent" to the descendant widgets. When the parent is started it will call startup() on the child widgets. See also `isLayoutContainer`.
Defined in: _Container.js.

{HTML string} label
Text to display in button. If the label is hidden (showLabel=false) then and no title has been specified, then label is also set as title attribute of icon.
Defined in: Button.js.

{Boolean} showLabel
Set this to true to hide the label text and display only the icon. (If showLabel=false then iconClass must be specified.) Especially useful for toolbars. If showLabel=true, the label will become the title (a.k.a. tooltip/hint) of the icon.

The exception case is for computers in high-contrast mode, where the label will still be displayed, since the icon doesn't appear.
Defined in: Button.js.


{String} type
Defines the type of button. "button", "submit", or "reset".
Defined in: Button.js.
Method Detail
_clicked(e)
Internal overridable function for when the button is clicked
Defined in: Button.js.
Parameters:
e

<private> {dijit._Widget} _getSiblingOfChild(child, dir)
Get the next or previous widget sibling of child
Defined in: _Container.js.
Parameters:
{dijit._Widget} child
{int} dir
if 1, get the next sibling, if -1, get the previous sibling
Returns:
{dijit._Widget}

<private> _onButtonClick(e)
Handler when the user activates the button portion.
Defined in: Button.js.
Parameters:
{Event} e

<private> _onClick(e)
Internal function to handle click actions
Defined in: Button.js.
Parameters:
{Event} e

<private> _setLabelAttr(content)
Hook for set('label', ...) to work.
Defined in: Button.js.
Parameters:
{String} content
HTML string

addChild(widget, insertIndex)
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).
Defined in: _Container.js.
Parameters:
{dijit.Widget} widget
{Number} insertIndex Optional

{int} getIndexOfChild(child)
Gets the index of the child in this container or -1 if not found
Defined in: _Container.js.
Parameters:
{dijit._Widget} child
Returns:
{int}

{Boolean} hasChildren()
Returns true if widget has children, i.e. if this.containerNode contains something.
Defined in: _Container.js.
Returns:
{Boolean}

onClick(e)
Callback for when button is clicked. If type="submit", return true to perform submit, or false to cancel it.
Defined in: Button.js.
Parameters:
{Event} e

removeChild(widget)
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
Defined in: _Container.js.
Parameters:
{dijit._Widget|Number} widget

setLabel(content)

Defined in: Button.js.
Parameters:
{String} content

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Sep 20 2010 21:52:24 GMT+0900 (JST)