Files
shaka-player/ui/ui_utils.js
T
Joey Parrish f539147d48 fix: Correct license headers in compiled output
This fixes all the license headers in the main library, which corrects
the appearance of the main license in the compiled output.

It seems that the `!` in the header forces the compiler to keep it in
the output.  I believe older compiler releases did this purely based
on `@license`.

Issue #2638

Change-Id: I7f0e918caad10c9af689c9d07672b7fe9be7b2f3
2020-06-09 16:05:09 -07:00

127 lines
3.2 KiB
JavaScript

/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
goog.provide('shaka.ui.Utils');
goog.require('goog.asserts');
shaka.ui.Utils = class {
/**
* @param {!HTMLElement} element
* @param {string} className
* @return {!HTMLElement}
*/
// TODO: This can be replaced by shaka.util.Dom.getElementByClassName
static getFirstDescendantWithClassName(element, className) {
const descendant = shaka.ui.Utils.getDescendantIfExists(element, className);
goog.asserts.assert(descendant != null, 'Should not be null!');
return descendant;
}
/**
* @param {!HTMLElement} element
* @param {string} className
* @return {?HTMLElement}
*/
static getDescendantIfExists(element, className) {
const childrenWithClassName = element.getElementsByClassName(className);
if (childrenWithClassName.length) {
return /** @type {!HTMLElement} */ (childrenWithClassName[0]);
}
return null;
}
/**
* Finds a descendant of |menu| that has a 'shaka-chosen-item' class
* and focuses on its' parent.
*
* @param {HTMLElement} menu
*/
static focusOnTheChosenItem(menu) {
if (!menu) {
return;
}
const chosenItem = shaka.ui.Utils.getDescendantIfExists(
menu, 'shaka-chosen-item');
if (chosenItem) {
chosenItem.parentElement.focus();
}
}
/**
* @return {!Element}
*/
static checkmarkIcon() {
const icon = shaka.util.Dom.createHTMLElement('i');
icon.classList.add('material-icons-round');
icon.classList.add('shaka-chosen-item');
icon.textContent = shaka.ui.Enums.MaterialDesignIcons.CHECKMARK;
// Screen reader should ignore icon text.
icon.setAttribute('aria-hidden', 'true');
return icon;
}
/**
* Depending on the value of display, sets/removes the css class of element to
* either display it or hide it.
*
* @param {Element} element
* @param {boolean} display
*/
static setDisplay(element, display) {
if (!element) {
return;
}
// You can't use setDisplay with SVG on IE, because classList isn't on SVG
// elements on that browser. It's better to find out on Chrome through an
// assertion, rather than wait for a failed test pass later on IE.
goog.asserts.assert(!(element instanceof SVGElement),
'Do not use setDisplay with SVG elements!');
if (display) {
// Removing a non-existent class doesn't throw, so, even if
// the element is not hidden, this should be fine.
element.classList.remove('shaka-hidden');
} else {
element.classList.add('shaka-hidden');
}
}
/**
* Builds a time string, e.g., 01:04:23, from |displayTime|.
*
* @param {number} displayTime (in seconds)
* @param {boolean} showHour
* @return {string}
*/
static buildTimeString(displayTime, showHour) {
const h = Math.floor(displayTime / 3600);
const m = Math.floor((displayTime / 60) % 60);
let s = Math.floor(displayTime % 60);
if (s < 10) {
s = '0' + s;
}
let text = m + ':' + s;
if (showHour) {
if (m < 10) {
text = '0' + text;
}
text = h + ':' + text;
}
return text;
}
};