Class: shaka.ui.TextStyleMenu

Constructor

new TextStyleMenu(parentnon-null, controlsnon-null, icon)

Parameters:
Name Type Description
parent HTMLElement
controls shaka.ui.Controls
icon string
Extends:
Source:

Extends

Members

Type:
Overrides:
Implements:
Source:

adManager :shaka.extern.IAdManager

Type:
Overrides:
Implements:
Source:

backButton :HTMLButtonElement

Type:
  • HTMLButtonElement
Overrides:
Implements:
Source:

backIcon_ :shaka.ui.Icon

Type:
Overrides:
Source:

backSpan :HTMLElement

Type:
  • HTMLElement
Overrides:
Implements:
Source:

button :HTMLButtonElement

Type:
  • HTMLButtonElement
Overrides:
Implements:
Source:

config :shaka.extern.UIConfiguration

Type:
Overrides:
Source:

controls :shaka.ui.Controls

Type:
Overrides:
Implements:
Source:

currentSelection :HTMLElement

Type:
  • HTMLElement
Overrides:
Implements:
Source:

eventManager :shaka.util.EventManager

Type:
Overrides:
Implements:
Source:

icon :shaka.ui.Icon

Type:
Overrides:
Implements:
Source:

isInMenuGroup :boolean

True when the element is a child of a shaka.ui.MenuGroup.
Type:
  • boolean
Overrides:
Implements:
Source:

isMenuOpened_ :boolean

Type:
  • boolean
Overrides:
Source:

isSubMenu :boolean

Type:
  • boolean
Overrides:
Implements:
Source:

isSubMenuOpened :boolean

Type:
  • boolean
Overrides:
Implements:
Source:

localization :shaka.ui.Localization

Type:
Overrides:
Implements:
Source:
Type:
  • HTMLElement
Overrides:
Implements:
Source:

menuMutationObserver_ :MutationObserver

Type:
  • MutationObserver
Overrides:
Source:

mutationObserver_ :MutationObserver

Type:
  • MutationObserver
Overrides:
Source:

nameSpan :HTMLElement

Type:
  • HTMLElement
Overrides:
Implements:
Source:

parent :HTMLElement

Type:
  • HTMLElement
Overrides:
Implements:
Source:

player :shaka.Player

Type:
Overrides:
Implements:
Source:

resizeObserver_ :ResizeObserver

Type:
  • ResizeObserver
Overrides:
Source:

resizeRafId_ :number

Type:
  • number
Overrides:
Source:

video :HTMLMediaElement

Type:
Overrides:
Implements:
Source:

videoContainer_ :HTMLElement

Type:
  • HTMLElement
Overrides:
Source:

Methods

isStyleAvailable(player, controls) → {boolean}

Whether the subtitle style can be changed. The style can be set before the text is enabled, so it is available as soon as there is any text track. The preview shows an example subtitle even while the text is hidden.
Parameters:
Name Type Description
player shaka.Player
controls shaka.ui.Controls
Source:
Returns:
Type
boolean

addButton_(iconText)

Parameters:
Name Type Description
iconText shaka.extern.UIIcon | string
Overrides:
Source:

addMenu_()

Overrides:
Source:

adjustMenuStyle(menuElementnon-null, buttonElementnon-null, controlsContainernon-null)

Shared positioning algorithm used by both OverflowMenu and SettingsMenu. Computes: - maxHeight so the menu does not overflow the video container vertically. - left/right offset so the menu stays within the controls bar horizontally, aligned with the button that opened it.
Parameters:
Name Type Description
menuElement HTMLElement The floating menu div to position.
buttonElement HTMLElement The button that triggered the menu.
controlsContainer HTMLElement The bottom controls bar used as the horizontal reference.
Overrides:
Source:

dispatchSubMenuEvent_(type)

Notifies the elements that share this submenu's container, so they hide or show their buttons. Other menu levels are not affected.
Parameters:
Name Type Description
type string
Overrides:
Source:

focusOnMenuOpen()

Moves the focus into the menu after it is opened.
Overrides:
Source:

getCurrentValueLabel() → {string}

Source:
Returns:
Type
string

getItems() → {Array<T>}

Source:
Returns:
Type
Array<T>

getLabelForItem(item) → {string}

Parameters:
Name Type Description
item T
Source:
Returns:
Type
string

getPreviewConfigForItem(item) → {shaka.ui.TextStylePreview.Configuration}

Parameters:
Name Type Description
item T
Source:
Returns:
Type
shaka.ui.TextStylePreview.Configuration

getSwatchColorForItem(item) → {string}

Returns the CSS color of the swatch shown next to the item, or null to not show a swatch.
Parameters:
Name Type Description
item T
Source:
Returns:
Type
string

inOverflowMenu_()

Overrides:
Source:

notifyMenuClose_()

Overrides:
Source:

notifyMenuOpen_()

Overrides:
Source:

onButtonClick_()

Overrides:
Source:

onItemSelected(item)

Parameters:
Name Type Description
item T
Source:

onMenuClose()

Overrides:
Source:

onMenuOpen()

Overrides:
Source:

rebuildMenu()

Clears and rebuilds the menu items, then refreshes the selection indicator. Call from the subclass constructor and from updateLocalizedStrings() when item labels are localized strings.
Source:

shouldCloseOnMenuClick(eventnon-null) → {boolean}

Whether a click inside a submenu closes it and returns to its parent. By default any click does, since it usually chooses an item.
Parameters:
Name Type Description
event Event
Overrides:
Source:
Returns:
Type
boolean

updateCurrentSelection_()

Source: