ReadonlydismissButton that ends the pause ad. Exposed so a navigation group can make it the first focus target for remote-controlled platforms.
Gets the event that is fired when the component's focus-state is changing.
Gets the event that is fired when the component's hover-state is changing.
Gets the event that is fired when the ViewMode of this component has changed.
Adds a child component to the container.
the component to add
Configures the component for the supplied Player and UIInstanceManager. This is the place where all the magic happens, where components typically subscribe and react to events (on their DOM element, the Player, or the UIInstanceManager), and basically everything that makes them interactive. This method is called only once, when the UIManager initializes the UI.
Subclasses usually overwrite this method to add their own functionality.
the player which this component controls
the UIInstanceManager that manages this component
Disables the component. This method basically transfers the component into the disabled state. Actual disabling is done via CSS or child components. (e.g. Button needs to unsubscribe click listeners)
Enables the component. This method basically transfers the component into the enabled state. Actual enabling is done via CSS or child components. (e.g. Button needs to subscribe click listeners)
Captures the active creative's click-through action for an external input surface.
Like linear ads (see AdClickOverlay), the action opens the destination and then reports it
through clickThroughUrlOpened, which only tracks the click.
The action becomes a no-op when this ad ends or is replaced, or this overlay becomes hidden.
Returns undefined when there is no click-through destination.
Gets an array of all child components in this container.
Returns the configuration object of the component.
Returns the DOM element of this component. Creates the DOM element if it does not yet exist.
Should not be overwritten by subclasses.
Checks if this component has a DOM element.
Hides the component if shown. This method basically transfers the component into the hidden state. Actual hiding is done via CSS.
Initializes the component, e.g. by applying config settings. This method must not be called from outside the UI framework.
This method is automatically called by the UIInstanceManager. If the component is an inner component of some component, and thus encapsulated abd managed internally and never directly exposed to the UIManager, this method must be called from the managing component's #initialize method.
Determines if the component is disabled.
true if the component is disabled, else false
Determines if the component is enabled.
true if the component is enabled, else false
Determines if the component is hidden.
true if the component is hidden, else false
Determines if the component is currently hovered.
true if the component is hovered, else false
Determines if the component is shown.
true if the component is visible, else false
Adds a child component as the first component in the container.
the component to add
Releases all resources and dependencies that the component holds. Player, DOM, and UIManager events are automatically removed during release and do not explicitly need to be removed here. This method is called by the UIManager when it releases the UI.
Subclasses that need to release resources should override this method and call super.release().
Removes a child component from the container.
the component to remove
true if the component has been removed, false if it is not contained in this container
Removes all child components from the container.
Shows the component if hidden.
Toggles the hidden state by hiding the component if it is shown, or showing it if hidden.
Updates the DOM of the container with the current components.
This is called automatically after construction. However, when you dynamically
add or remove components at runtime, you must call updateComponents() to
re-render the container’s children.
An overlay holding status controls for pause ads.