Extends

• MenuButton

Members

protected hideThreshold_ :Number

menu/menu-button.js, line 113

Hide the menu if the number of items is less than or equal to this threshold. This defaults to 0 and whenever we add items which can be hidden to the menu we'll increment it. We list it here because every time we run createMenu we need to reset the value.

Inherited From:

• MenuButton#hideThreshold_

Methods

blur()

menu/menu-button.js, line 271

Remove the focus from the actual button, not this element

Inherited From:

• MenuButton#blur

buildCSSClass() → {string}

menu/menu-button.js, line 190

Builds the default DOM className.

Returns:

string -

The DOM className for this object.

Inherited From:

• MenuButton#buildCSSClass

buildWrapperCSSClass() → {string}

menu/menu-button.js, line 168

Allow sub components to stack CSS class names for the wrapper element

Returns:

string -

The constructed wrapper DOM className

Inherited From:

• MenuButton#buildWrapperCSSClass

controlText(textopt, elopt) → {string}

menu/menu-button.js, line 217

Get or set the localized control text that will be used for accessibility.

NOTE: This will come from the internal menuButton_ element.

Parameters:

Name	Type	Attributes	Default	Description
text	string	<optional>		Control text for element.
el	Element	<optional>	this.menuButton_.el()	Element to set the title on.

Returns:

string -

• The control text when getting

Inherited From:

• MenuButton#controlText

createEl() → {Element}

menu/menu-button.js, line 155

Create the MenuButtonss DOM element.

Returns:

Element -

The element that gets created.

Inherited From:

• MenuButton#createEl

abstract createItems()

menu/menu-button.js, line 147

Create the list of menu items. Specific to each subclass.

Inherited From:

• MenuButton#createItems

createMenu() → {Menu}

menu/menu-button.js, line 102

Create the menu and add all items to it.

Returns:

Menu -

The constructed menu

Inherited From:

• MenuButton#createMenu

disable()

menu/menu-button.js, line 400

Disable the MenuButton. Don't allow it to be clicked.

Inherited From:

• MenuButton#disable

dispose()

menu/menu-button.js, line 224

Dispose of the menu-button and all child components.

Inherited From:

• MenuButton#dispose

enable()

menu/menu-button.js, line 412

Enable the MenuButton. Allow it to be clicked.

Inherited From:

• MenuButton#enable

focus()

menu/menu-button.js, line 264

Set the focus to the actual button, not to this element

Inherited From:

• MenuButton#focus

handleClick(event)

menu/menu-button.js, line 240

Handle a click on a MenuButton. See ClickableComponent#handleClick for instances where this is called.

Parameters:

Name	Type	Description
event	EventTarget~Event	The keydown, tap, or click event that caused this function to be called.

Listens to Events:

• event:tap
• event:click

Inherited From:

• MenuButton#handleClick

handleKeyDown(event)

menu/menu-button.js, line 284

Handle tab, escape, down arrow, and up arrow keys for MenuButton. See ClickableComponent#handleKeyDown for instances where this is called.

Parameters:

Name	Type	Description
event	EventTarget~Event	The keydown event that caused this function to be called.

Listens to Events:

• event:keydown

Inherited From:

• MenuButton#handleKeyDown

handleMenuKeyUp(event)

menu/menu-button.js, line 316

Handle a keyup event on a MenuButton. The listener for this is added in the constructor.

Parameters:

Name	Type	Description
event	EventTarget~Event	Key press event

Listens to Events:

• event:keyup

Inherited From:

• MenuButton#handleMenuKeyUp

handleMouseLeave(event)

menu/menu-button.js, line 256

Handle mouseleave for MenuButton.

Parameters:

Name	Type	Description
event	EventTarget~Event	The mouseleave event that caused this function to be called.

Listens to Events:

• event:mouseleave

Inherited From:

• MenuButton#handleMouseLeave

handleSubmenuKeyDown(event)

menu/menu-button.js, line 344

Handle a keydown event on a sub-menu. The listener for this is added in the constructor.

Parameters:

Name	Type	Description
event	EventTarget~Event	Key press event

Listens to Events:

• event:keydown

Inherited From:

• MenuButton#handleSubmenuKeyDown

handleSubmenuKeyPress(event)

menu/menu-button.js, line 331

This method name now delegates to handleSubmenuKeyDown. This means anyone calling handleSubmenuKeyPress will not see their method calls stop working.

Parameters:

Name	Type	Description
event	EventTarget~Event	The event that caused this function to be called.

Inherited From:

• MenuButton#handleSubmenuKeyPress

pressButton()

menu/menu-button.js, line 367

Put the current MenuButton into a pressed state.

Inherited From:

• MenuButton#pressButton

unpressButton()

menu/menu-button.js, line 388

Take the current MenuButton out of a pressed state.

Inherited From:

• MenuButton#unpressButton

update()

menu/menu-button.js, line 69

Update the menu based on the current state of its items.

Inherited From:

• MenuButton#update