The `goog.ui.SelectionMenuButton` Class

goog.ui.SelectionMenuButton
> goog.ui.MenuButton
> goog.ui.Button
> goog.ui.Control
> goog.ui.Component
> goog.events.EventTarget
> goog.Disposable

`goog.ui.SelectionMenuButton(opt_renderer, opt_itemRenderer, opt_domHelper)`

A selection menu button control. Extends {@link goog.ui.MenuButton}. Menu contains 'select all' and 'select none' MenuItems for selecting all and no items by default. Other MenuItems can be added by user. The checkbox content fires the action events associated with the 'select all' and 'select none' menu items.

opt_renderer {goog.ui.ButtonRenderer=}: Renderer used to render or decorate the menu button; defaults to {@link goog.ui.MenuButtonRenderer}.
opt_itemRenderer {goog.ui.MenuItemRenderer=}: Optional menu item renderer.
opt_domHelper {goog.dom.DomHelper=}: Optional DOM hepler, used for document interaction.

The `goog.ui.SelectionMenuButton.SelectionState` Enum

Constants for menu action types. … more

`.addChild(child, opt_render)`

Inherited from goog.ui.Component .

Adds the specified component as the last child of this component. See {@link goog.ui.Component#addChildAt} for detailed semantics.

child {goog.ui.Component}: The new child component.
opt_render {boolean=}: If true, the child component will be rendered into the parent.
@see: goog.ui.Component#addChildAt

`.addChildAt(child, index, opt_render)`

Inherited from goog.ui.Component .

Adds the specified component as a child of this component at the given 0-based index. Both {@code addChild} and {@code addChildAt} assume the following contract between parent and child components:

the child component's element must be a descendant of the parent component's element, and
the DOM state of the child component must be consistent with the DOM state of the parent component (see {@code isInDocument}) in the steady state -- the exception is to addChildAt(child, i, false) and then immediately decorate/render the child.

In particular, {@code parent.addChild(child)} will throw an error if the child component is already in the document, but the parent isn't. Clients of this API may call {@code addChild} and {@code addChildAt} with {@code opt_render} set to true. If {@code opt_render} is true, calling these methods will automatically render the child component's element into the parent component's element. However, {@code parent.addChild(child, true)} will throw an error if:

the parent component has no DOM (i.e. {@code parent.getElement()} is null), or
the child component is already in the document, regardless of the parent's DOM state.

If {@code opt_render} is true and the parent component is not already in the document, {@code enterDocument} will not be called on this component at this point. Finally, this method also throws an error if the new child already has a different parent, or the given index is out of bounds.

child {goog.ui.Component}: The new child component.
index {number}: 0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive).
opt_render {boolean=}: If true, the child component will be rendered into the parent.
returns {void}: Nada.
@see: goog.ui.Component#addChild

The goog.ui.SelectionMenuButton Class

goog.ui.SelectionMenuButton(opt_renderer, opt_itemRenderer, opt_domHelper)

The goog.ui.SelectionMenuButton.SelectionState Enum

.addCheckboxEvent() [protected]

.addChild(child, opt_render)

.addChildAt(child, index, opt_render)

.addClassName(className)

.addEventListener(type, handler, opt_capture, opt_handlerScope)

.addItem(item)

.addItemAt(item, index)

.addOnDisposeCallback(callback, opt_scope)

.canDecorate(element)

.containsElement(element) [protected]

.createCheckbox() [protected]

.createDom() [protected]

.creationStack {string}

.decorate(element)

.decorateInternal()

.dispatchEvent(e)

.dispose()

.disposeInternal() [protected]

.dom_ [protected] {!goog.dom.DomHelper}

.enableClassName(className, enable)

.enterDocument()

.exitDocument()

.forEachChild(f, opt_obj)

.getCaption()

.getCheckboxElement() [protected]

.getChild(id)

.getChildAt(index)

.getChildCount()

.getChildIds()

.getContent()

.getContentElement()

.getDisposed [deprecated]

.getDomHelper()

.getElement()

.getElementByClass(className)

.getElementByFragment(idFragment)

.getElementsByClass(className)

.getExtraClassNames()

.getFragmentFromId(id)

.getHandler() [protected]

.getId()

.getItemAt(index)

.getItemCount()

.getKeyEventTarget()

.getKeyHandler() [protected]

.getMenu()

.getModel()

.getParent()

.getParentEventTarget()

.getPreferredAriaRole()

.getRenderer()

.getSelectionState()

.getState()

.getTooltip()

.getValue()

.handleBlur(e) [protected]

.handleCheckboxClick(e) [protected]

.handleContextMenu

.handleDblClick(e)

.handleDocumentMouseDown(e) [protected]

.handleFocus(e)

.handleHighlightItem(e)

.handleKeyEvent(e)

.handleKeyEventInternal(e) [protected]

.handleMenuAction(e) [protected]

.handleMenuBlur(e)

.handleMouseDown(e) [protected]

.handleMouseOut(e)

.handleMouseOver(e)

.handleMouseUp(e) [protected]

.handleUnHighlightItem(e)

.hasChildren()

.hasState(state)

.hideMenu() [deprecated]

.indexOfChild(child)

.invalidateMenuSize()

.isActive()

The `goog.ui.SelectionMenuButton` Class

`goog.ui.SelectionMenuButton(opt_renderer, opt_itemRenderer, opt_domHelper)`

The `goog.ui.SelectionMenuButton.SelectionState` Enum

`.addCheckboxEvent()` [protected]

`.addChild(child, opt_render)`

`.addChildAt(child, index, opt_render)`

`.addClassName(className)`

`.addEventListener(type, handler, opt_capture, opt_handlerScope)`

`.addItem(item)`

`.addItemAt(item, index)`

`.addOnDisposeCallback(callback, opt_scope)`

`.canDecorate(element)`

`.containsElement(element)` [protected]

`.createCheckbox()` [protected]

`.createDom()` [protected]

`.creationStack` {`string`}

`.decorate(element)`

`.decorateInternal()`

`.dispatchEvent(e)`

`.dispose()`

`.disposeInternal()` [protected]

`.dom_` [protected] {!`goog.dom.DomHelper`}

`.enableClassName(className, enable)`

`.enterDocument()`

`.exitDocument()`

`.forEachChild(f, opt_obj)`

`.getCaption()`

`.getCheckboxElement()` [protected]

`.getChild(id)`

`.getChildAt(index)`

`.getChildCount()`

`.getChildIds()`

`.getContent()`

`.getContentElement()`

`.getDisposed` [deprecated]

`.getDomHelper()`

`.getElement()`

`.getElementByClass(className)`

`.getElementByFragment(idFragment)`

`.getElementsByClass(className)`

`.getExtraClassNames()`

`.getFragmentFromId(id)`

`.getHandler()` [protected]

`.getId()`

`.getItemAt(index)`

`.getItemCount()`

`.getKeyEventTarget()`

`.getKeyHandler()` [protected]

`.getMenu()`

`.getModel()`

`.getParent()`

`.getParentEventTarget()`

`.getPreferredAriaRole()`

`.getRenderer()`

`.getSelectionState()`

`.getState()`

`.getTooltip()`

`.getValue()`

`.handleBlur(e)` [protected]

`.handleCheckboxClick(e)` [protected]

`.handleContextMenu`

`.handleDblClick(e)`

`.handleDocumentMouseDown(e)` [protected]

`.handleFocus(e)`

`.handleHighlightItem(e)`

`.handleKeyEvent(e)`

`.handleKeyEventInternal(e)` [protected]

`.handleMenuAction(e)` [protected]

`.handleMenuBlur(e)`

`.handleMouseDown(e)` [protected]

`.handleMouseOut(e)`

`.handleMouseOver(e)`

`.handleMouseUp(e)` [protected]

`.handleUnHighlightItem(e)`

`.hasChildren()`

`.hasState(state)`

`.hideMenu()` [deprecated]

`.indexOfChild(child)`

`.invalidateMenuSize()`

`.isActive()`