Login Register Help
API Documentation
Choose a stylesheet:

Constructordijit.form.DropDownButton

A button with a drop down

Usage

var foo=new dijit.form.DropDownButton();

Examples

Example 1

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

Example 2

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

Jump to PropertiesFunctionsBack to top

FunctionaddChild(widget: Widget, insertIndex: Integer?)
Defined by dijit._Container
Makes the given widget a child of this widget.
Functionattr(name: String|Object, value: Object?)
Defined by dijit._Widget
Set or get properties on a widget instance.
Construct the UI for this widget from a template, setting this.domNode.
Functioncompare(val1: anything, val2: anything)
Compare 2 values (as returned by attr('value') for this widget).
Functionconnect(obj: Object|null, event: String|Function, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy.
Functioncreate(params: Object?, srcNodeRef: DomNode|String?)
Kick off the life-cycle of a widget
Functiondestroy(preserveDom: Boolean)
Destroy this widget, but not its descendants. Will, however, destroy internal widgets such as those used within a template.
Destroys all the widgets inside this.containerNode, but not this widget itself
FunctiondestroyRecursive(preserveDom: Boolean?)
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.
FunctiondestroyRendering(preserveDom: Boolean?)
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
Put focus on this widget
FunctiongetChildren(): Widget[]
Returns array of children widgets.
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode. This method should generally be avoided as it returns widgets declared in templates, which are supposed to be internal/hidden, but it's left here for back-compat reasons.
FunctiongetIndexOfChild(child: Widget): Integer
Defined by dijit._Container
Gets the index of the child in this container or -1 if not found
Deprecated. Use attr('value') instead.
Defined by dijit._Container
Returns true if widget has children, i.e. if this.containerNode contains something.
Tells if this widget is focusable or not. Used internally by dijit.
Defined by dijit._Widget
Checks the page for text direction
Defined by dijit._Widget
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.
FunctiononChange(newValue)
Callback when this widget's value is changed.
FunctiononClick(e: Event): Boolean
Callback for when button is clicked. If type="submit", return true to perform submit, or false to cancel it. type: callback
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
FunctiononDblClick(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of mouse double click events.
Defined by dijit._Widget
Called when the widget becomes "active" because it or a widget inside of it either has focus, or has recently been clicked.
FunctiononKeyDown(event: key)
Defined by dijit._Widget
Connect to this function to receive notifications of keys being pressed down.
FunctiononKeyPress(event: key)
Defined by dijit._Widget
Connect to this function to receive notifications of printable keys being typed.
FunctiononKeyUp(event: key)
Defined by dijit._Widget
Connect to this function to receive notifications of keys being released.
FunctiononMouseDown(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse button is pressed down.
FunctiononMouseEnter(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves onto this widget.
FunctiononMouseLeave(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves off of this widget.
FunctiononMouseMove(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
FunctiononMouseOut(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
FunctiononMouseOver(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
FunctiononMouseUp(event: mouse)
Defined by dijit._Widget
Connect to this function to receive notifications of when the mouse button is released.
FunctionplaceAt(reference: String|DomNode|_Widget, position: String|Integer?)
Defined by dijit._Widget
Place this widget's domNode reference somewhere in the DOM based on standard dojo.place conventions, or passing a Widget reference that contains and addChild member.
Called after a widget's dom has been setup
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.
FunctionremoveChild(widget: 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
FunctionsetAttribute(attr: String, value: anything)
Defined by dijit._Widget
Deprecated. Use attr() instead.
FunctionsetDisabled(disabled: Boolean)
Deprecated. Use attr('disabled', ...) instead.
FunctionsetLabel(content: String)
Defined by dijit.form.Button
Deprecated. Use attr('label', ...) instead.
Deprecated. Use attr('value', ...) instead.
Overrides 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
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 reversable serialization.
Defined by dijit._Widget
Stub function. Override to implement custom widget tear-down behavior.
Defined by dijit._Widget
Step during widget creation to copy all widget attributes to the DOM as per attributeMap and _setXXXAttr functions.
Function_attachTemplateNodes(rootNode: DomNode|Array[Widgets], getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Function_attrToDom(attr: String, value: String)
Defined by dijit._Widget
Reflect a widget attribute (title, tabIndex, duration etc.) to the widget DOM, as specified in attributeMap.
Function_clicked(e: Event)
Defined by dijit.form.Button
Internal overridable function for when the button is clicked
Relocate source contents to templated container node. this.containerNode must be able to receive children, or exceptions will be thrown.
Defined by dijit._Container
Find the first (non-text, non-comment etc) node
Defined by dijit._Widget
Helper function for Widget.attr(). Caches attribute name values so we don't do the string ops every time.
Function_getSiblingOfChild(child: Widget, dir: Integer)
Defined by dijit._Container
Get the next or previous widget sibling of child
Function_handleOnChange(newValue: anything, priorityChange: Boolean?)
Called when the value of the widget is set. Calls onChange() if appropriate
Work around table sizing bugs on FF2 by forcing redraw
Defined by dijit._Container
Find the next (non-text, non-comment etc) node
Function_onArrowClick(e: Event)
Handler for when the user mouse clicks on menu popup node
Overrides dijit._Widget
Called magically when focus has shifted away from this widget and it's dropdown
Function_onButtonClick(e: Event)
Defined by dijit.form.Button
Handler when the user activates the button portion. If is activated via a keystroke, stop the event unless is submit or reset.
Function_onClick(e: Event): user click actions
Defined by dijit.form.Button
Internal function to handle click actions
Defined by dijit._Widget
Called when someone connects to one of my handlers. "Turn on" that handler if it isn't active yet. This is also called for every single initialization parameter so need to do nothing for parameters like "id".
Function_onDropDownBlur(e: Event)
This is where widgets do processing for when they are active, such as changing CSS classes. See onFocus() for more details.
Function_onKey(e: Event)
Handler when the user presses a key on drop down widget
Function_onMouse(event: 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.
Defined by dijit._Widget
Custom setter for the CSS "class" attribute
Defined by dijit.form.Button
Hook for attr('label', ...) to work.
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).
Defined by dijit._Widget
Sets the style attribut of the widget according to value, which is either a hash like {height: "5px", width: "3px"} or a plain string
Defined by dijit._Templated
Does substitution of ${foo} type properties in template string
Toggle the drop-down widget; if it is up, close it; if not, open it.

Jump to FunctionsPropertiesBack to top

Corresponds to the native HTML <input> element's attribute.
Root CSS class of the widget (ex: dijitTextBox), used to add CSS classes of widget (ex: "dijitTextBox dijitTextBoxInvalid dijitTextBoxFocused dijitTextBoxInvalidFocused") See _setStateClass().
Defined by dijit._Widget
HTML class attribute
Defined by dijit._Widget
True if user can close (destroy) this child, such as (for example) clicking the X on the tab. true if user can close this tab pane
Defined by dijit._Widget
Column of the grid to place the widget.
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 dojoType=myWidget> <b> here's a plain dom node <span dojoType=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 dojoType=subWidget>and a widget</span> <i> and another plain dom node </i> In templated widgets, "containerNode" is set via a dojoAttachPoint 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.
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 dojoAttachPoint syntax, but the domNode property is the canonical "top level" node in widget UI.
Defined by dijit._Widget
To remove the drag capability.
Defined by dijit._Widget
Defines a group belonging.
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._Container
Just a flag indicating that this widget descends from dijit._Container
Defined by dijit.form.Button
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.
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._Widget
"none", "left", "right", "bottom", "top", and "client". See the LayoutContainer description for details on this parameter.
Defined by dijit._Widget
Specifies a minimum size for this widget when resized by a splitter
Name used when submitting form; same as "name" attribute or plain HTML elements
Defined by dijit._Widget
List of nodes that correctly handle click events via native browser support, and don't need dijit's help
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._Widget
"top", "bottom", "leading", "trailing", "left", "right", "center". See the BorderContainer description for details on this parameter.
On focus, should this widget scroll into view?
Defined by dijit._Widget
Is this child currently selected?
Defined by dijit.form.Button
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 by dijit._Widget
Minimum size (width or height) of a child of a SplitContainer. The value is relative to other children's sizeShare properties.
Defined by dijit._Widget
Size (width or height) of a child of a SplitContainer. The value is relative to other children's sizeShare properties. For example, if there are two children and each has sizeShare=10, then each takes up 50% of the available space.
Defined by dijit._Widget
A parameter needed by RadioGroupSlide only. An optional paramter to force the ContentPane to slide in from a set direction. Defaults to "random", or specify one of "top", "left", "right", "bottom" to slideFrom top, left, right, or bottom.
Defined by dijit._Widget
If true, puts a draggable splitter on this widget to resize when used inside a border container edge region.
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attributes as cssText string or name/value hash
Order fields are traversed when user hits the tab key
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 templatePath. In builds that have their strings "interned", the templatePath is converted to an inline templateString, thereby preventing a synchronous network call.
Defined by dijit._Widget
Title of this widget. Used by TabContainer to the name the tab, etc. TODO: remove this, it's in _Widget already.
Defined by dijit._Widget
a css size value (e.g. "100px")
Defines the type of button. "button", "submit", or "reset".
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
Used by <img> nodes in templates that really get there image via CSS background-image
Indicates that changes to the value should call onChange() callback. This is false during widget initialization, to avoid calling onChange() when the initial value is set.