dijit/form/Button.js

• Provides:

  • dijit.form.Button

• Requires:

  • dijit.form._FormWidget in common
  • dijit._Container in common
  • dijit._HasDropDown in common

• dijit.form.Button

  • type

    Function

  • chains:
    • dijit.form._FormWidget: (prototype)
    • dijit.form._FormWidget: (call)
  • summary

    Basically the same thing as a normal HTML button, but with special styling.

  • description

    Buttons can display a label, an icon, or both.
    A label should always be specified (through innerHTML) or the label
    attribute.  It can be hidden via showLabel=false.

  • example

    	<button dojoType="dijit.form.Button" onClick="...">Hello world</button>

  • example

    	var button1 = new dijit.form.Button({label: "hello world", onClick: foo});
    	dojo.body().appendChild(button1.domNode);

• dijit.form.Button.label

  • type

    HTML

  • summary

    String
    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.

• dijit.form.Button.showLabel

  • type

    Boolean

  • summary

    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.

• dijit.form.Button.iconClass

  • type

    String

  • summary

    Class to apply to DOMNode in button to make it display an icon

• dijit.form.Button.type

  • type

    String

  • summary

    Defines the type of button.  "button", "submit", or "reset".

• dijit.form.Button.baseClass

  • type

    String

• dijit.form.Button.templateString

  • type

    Object

• dijit.form.Button.attributeMap

  • type

    Object

• dijit.form.Button._onClick

  • parameters:
    • e: (typeof Event)
  • returns

    user click actions

  • summary

    Internal function to handle click actions

  • type

    Function

• dijit.form.Button._onButtonClick

  • parameters:
    • e: (typeof Event)
  • summary

    Handler when the user activates the button portion.

  • type

    Function

• dijit.form.Button.buildRendering

  • type

    Function

• dijit.form.Button._fillContent

  • parameters:
    • source: (typeof DomNode)
  • type

    Function

• dijit.form.Button._setShowLabelAttr

  • parameters:
    • val
  • type

    Function

• dijit.form.Button.onClick

  • parameters:
    • e: (typeof Event)
  • returns

    Boolean

  • summary

    Callback for when button is clicked.
    If type="submit", return true to perform submit, or false to cancel it.
    type:
    callback

  • type

    Function

• dijit.form.Button._clicked

  • parameters:
    • e: (typeof Event)
  • summary

    Internal overridable function for when the button is clicked

  • type

    Function

• dijit.form.Button.setLabel

  • parameters:
    • content: (typeof String)
  • summary

    Deprecated.  Use set('label', ...) instead.

  • type

    Function

• dijit.form.Button._setLabelAttr

  • parameters:
    • content: (typeof String)
  • summary

    Hook for set('label', ...) to work.

  • description

    Set the label (text) of the button; takes an HTML string.

  • type

    Function

• dijit.form.Button.containerNode.innerHTML

• dijit.form.Button.titleNode.title

  • type

    Object

• dijit.form.Button._setIconClassAttr

  • parameters:
    • val: (typeof String)
  • type

    Function

• dijit.form.DropDownButton

  • type

    Function

  • chains:
    • dijit.form.Button: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit._HasDropDown.prototype: (prototype)
    • dijit.form.Button: (call)
    • dijit._Container: (call)
    • dijit._HasDropDown: (call)
  • summary

    A button with a drop down

  • example

    	<button dojoType="dijit.form.DropDownButton" label="Hello world">
    		<div dojotype="dijit.Menu">...</div>
    	</button>

  • example

    	var button1 = new dijit.form.DropDownButton({ label: "hi", dropDown: new dijit.Menu(...) });
    	dojo.body().appendChild(button1);

• dijit.form.DropDownButton.baseClass

  • type

    String

• dijit.form.DropDownButton.templateString

  • type

    Object

• dijit.form.DropDownButton._fillContent

  • type

    Function

• dijit.form.DropDownButton.dropDownContainer

• dijit.form.DropDownButton.startup

  • type

    Function

• dijit.form.DropDownButton.dropDown

  • type

    Object

• dijit.form.DropDownButton.isLoaded

  • type

    Function

• dijit.form.DropDownButton.loadDropDown

  • type

    Function

• dijit.form.DropDownButton.isFocusable

  • type

    Function

• dijit.form.ComboButton

  • type

    Function

  • chains:
    • dijit.form.DropDownButton: (prototype)
    • dijit.form.DropDownButton: (call)
  • summary

    A combination button and drop-down button.
    Users can click one side to "press" the button, or click an arrow
    icon to display the drop down.

  • example

    	<button dojoType="dijit.form.ComboButton" onClick="...">
    		<span>Hello world</span>
    		<div dojoType="dijit.Menu">...</div>
    	</button>

  • example

    	var button1 = new dijit.form.ComboButton({label: "hello world", onClick: foo, dropDown: "myMenu"});
    	dojo.body().appendChild(button1.domNode);

• dijit.form.ComboButton.templateString

  • type

    Object

• dijit.form.ComboButton.attributeMap

  • type

    Object

• dijit.form.ComboButton.optionsTitle

  • type

    String

  • summary

    Text that describes the options menu (accessibility)

• dijit.form.ComboButton.baseClass

  • type

    String

• dijit.form.ComboButton.cssStateNodes

  • type

    Object

• dijit.form.ComboButton.cssStateNodes.buttonNode

  • type

    String

• dijit.form.ComboButton.cssStateNodes.titleNode

  • type

    String

• dijit.form.ComboButton.cssStateNodes._popupStateNode

  • type

    String

• dijit.form.ComboButton._focusedNode

  • type

    Object

• dijit.form.ComboButton._onButtonKeyPress

  • parameters:
    • evt: (typeof Event)
  • summary

    Handler for right arrow key when focus is on left part of button

  • type

    Function

• dijit.form.ComboButton._onArrowKeyPress

  • parameters:
    • evt: (typeof Event)
  • summary

    Handler for left arrow key when focus is on right part of button

  • type

    Function

• dijit.form.ComboButton.focus

  • parameters:
    • position: (typeof String)

      "start" or "end"

  • summary

    Focuses this widget to according to position, if specified,
    otherwise on arrow node

  • type

    Function

• dijit.form.ToggleButton

  • type

    Function

  • chains:
    • dijit.form.Button: (prototype)
    • dijit.form.Button: (call)
  • summary

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

• dijit.form.ToggleButton.baseClass

  • type

    String

• dijit.form.ToggleButton.checked

  • type

    Boolean

  • summary

    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.

• dijit.form.ToggleButton.attributeMap

  • type

    Object

• dijit.form.ToggleButton._clicked

  • parameters:
    • evt: (typeof Event)
  • type

    Function

• dijit.form.ToggleButton._setCheckedAttr

  • parameters:
    • value: (typeof Boolean)
    • priorityChange: (typeof Boolean)
  • type

    Function

• dijit.form.ToggleButton.setChecked

  • parameters:
    • checked: (typeof Boolean)
  • summary

    Deprecated.  Use set('checked', true/false) instead.

  • type

    Function

• dijit.form.ToggleButton.reset

  • summary

    Reset the widget's value to what it was at initialization time

  • type

    Function

• dijit.form.ToggleButton._hasBeenBlurred

  • type

    bool

• dijit.form

  • type

    Object

• dijit

  • type

    Object