TextTrackButton(player, optionsopt)

The base class for buttons that toggle specific text track types (e.g. subtitles)

new TextTrackButton(player, optionsopt)
control-bar/text-track-controls/text-track-button.js, line 14

Creates an instance of this class.

Parameters:
Name Type Attributes Default Description
player Player

The Player that this class should be attached to.
options Object <optional>
 {}

The key/value store of player options.

Extends

Members

protected hideThreshold_ :Number
menu/menu-button.js, line 104

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.

Overrides:

Methods

blur()
menu/menu-button.js, line 248

Remove the focus from the actual button, not this element

Inherited From:

buildCSSClass() → {string}
menu/menu-button.js, line 180

Builds the default DOM className.

Returns:
string -

The DOM className for this object.

Inherited From:

buildWrapperCSSClass() → {string}
menu/menu-button.js, line 158

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

Returns:
string -

The constructed wrapper DOM className

Inherited From:

controlText(textopt, elopt) → {string}
menu/menu-button.js, line 207

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:

createEl() → {Element}
menu/menu-button.js, line 145

Create the MenuButtonss DOM element.

Returns:
Element -

The element that gets created.

Inherited From:

createItems(itemsopt) → {Array.<TextTrackMenuItem>}
control-bar/text-track-controls/text-track-button.js, line 40

Create a menu item for each text track

Parameters:
Name Type Attributes Default Description
items Array.<TextTrackMenuItem> <optional>
 []

Existing array of items to use during creation
Returns:
Array.<TextTrackMenuItem> -

Array of menu items that were created

Overrides:

createMenu() → {Menu}
menu/menu-button.js, line 93

Create the menu and add all items to it.

Returns:
Menu -

The constructed menu

Inherited From:

disable()
menu/menu-button.js, line 366

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

Inherited From:

enable()
menu/menu-button.js, line 378

Enable the MenuButton. Allow it to be clicked.

Inherited From:

focus()
menu/menu-button.js, line 241

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

Inherited From:

handleBlur(event)
menu/menu-button.js, line 275

Called when a MenuButton loses focus. Turns off the listener for keydown events. Which Stops this.handleKeyPress from getting called.

Parameters:
Name Type Description
event EventTarget~Event

The blur event that caused this function to be called.
Listens to Events:
  • event:blur
Inherited From:

handleClick(event)
menu/menu-button.js, line 222

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:

handleFocus(event)
menu/menu-button.js, line 262

This gets called when a MenuButton gains focus via a focus event. Turns on listening for keydown events. When they happen it calls this.handleKeyPress.

Parameters:
Name Type Description
event EventTarget~Event

The focus event that caused this function to be called.
Listens to Events:
  • event:focus
Inherited From:

handleKeyPress(event)
menu/menu-button.js, line 288

Handle tab, escape, down arrow, and up arrow keys for MenuButton. See ClickableComponent#handleKeyPress 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:

handleSubmenuKeyPress(event)
menu/menu-button.js, line 319

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:

pressButton()
menu/menu-button.js, line 338

Put the current MenuButton into a pressed state.

Inherited From:

unpressButton()
menu/menu-button.js, line 355

Take the current MenuButton out of a pressed state.

Inherited From:

update()
menu/menu-button.js, line 61

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

Inherited From: