ErrorDisplay

A display that indicates an error has occurred. This means that the video is unplayable.

Constructor

new ErrorDisplay(player, optionsopt)

Creates an instance of this class.

Parameters:
Name Type Attributes Description
player Player

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

Extends

Methods

buildCSSClass() → {string}

Builds the default DOM className.

Returns:
string -

The DOM className for this object.

Overrides:
Deprecated:
  • Since version 5.

close()

Closes the modal, does nothing if the ModalDialog is not open.

Fires:
Inherited From:

closeable(valueopt) → {boolean}

Check to see if the ModalDialog is closeable via the UI.

Parameters:
Name Type Attributes Description
value boolean <optional>

If given as a boolean, it will set the closeable option.

Returns:
boolean -

Returns the final value of the closable option.

Inherited From:

content() → {string}

Gets the localized error message based on the Players error.

Returns:
string -

The Players error message localized or an empty string.

Overrides:

createEl() → {Element}

Create the ModalDialog's DOM element

Returns:
Element -

The DOM element that gets created.

Inherited From:

description() → {string}

Returns the description string for this modal. Primarily used for accessibility.

Returns:
string -

The localized or raw description of this modal.

Inherited From:

empty()

Empties the content element. This happens anytime the modal is filled.

Fires:
Inherited From:

fill()

Fill the modal's content element with the modal's "content" option. The content element will be emptied before this change takes place.

Inherited From:

fillWith(contentopt)

Fill the modal's content element with arbitrary content. The content element will be emptied before this change takes place.

Parameters:
Name Type Attributes Description
content Mixed <optional>

The same rules apply to this as apply to the content option.

Fires:
Inherited From:

handleKeyDown()

Keydown handler. Attached when modal is focused.

Listens to Events:
  • event:keydown
Inherited From:

handleKeyPress(e)

Handles keydown events on the document, looking for ESC, which closes the modal.

Parameters:
Name Type Description
e EventTarget~Event

The keypress that triggered this event.

Listens to Events:
  • event:keydown
Inherited From:

label() → {string}

Returns the label string for this modal. Primarily used for accessibility.

Returns:
string -

the localized or raw label of this modal.

Inherited From:

open()

Opens the modal.

Fires:
Inherited From:

opened(valueopt) → {boolean}

If the ModalDialog is currently open or closed.

Parameters:
Name Type Attributes Description
value boolean <optional>

If given, it will open (true) or close (false) the modal.

Returns:
boolean -

the current open state of the modaldialog

Inherited From:

Events

beforemodalclose

Fired just before a ModalDialog is closed.

Type:
Inherited From:

beforemodalempty

Fired just before a ModalDialog is emptied.

Type:
Inherited From:

beforemodalfill

Fired just before a ModalDialog is filled with content.

Type:
Inherited From:

beforemodalopen

Fired just before a ModalDialog is opened.

Type:
Inherited From:

modalclose

Fired just after a ModalDialog is closed.

Type:
Inherited From:

modalempty

Fired just after a ModalDialog is emptied.

Type:
Inherited From:

modalfill

Fired just after a ModalDialog is filled with content.

Type:
Inherited From:

modalopen

Fired just after a ModalDialog is opened.

Type:
Inherited From: