Class SettingsPanelPageOpenButton

Hierarchy

  • SettingsPanelPageNavigatorButton
    • SettingsPanelPageOpenButton

Constructors

constructor

Accessors

onClick onDisabled onEnabled onHide onHoverChanged onShow onViewModeChanged

Methods

configure disable enable getConfig getDomElement hasDomElement hide initialize isDisabled isEnabled isHidden isHovered isShown popPage pushTargetPage release setAriaAttr setAriaLabel setText show toggleHidden

Constructors

constructor

Accessors

onClick

onDisabled

  • get onDisabled(): Event<Component<Config>, NoArgs>

  • Gets the event that is fired when the component is disabling. See the detailed explanation on event architecture on the #componentEvents events list.

    Returns Event<Component<Config>, NoArgs>

onEnabled

  • get onEnabled(): Event<Component<Config>, NoArgs>

  • Gets the event that is fired when the component is enabling. See the detailed explanation on event architecture on the #componentEvents events list.

    Returns Event<Component<Config>, NoArgs>

onHide

  • get onHide(): Event<Component<Config>, NoArgs>

  • Gets the event that is fired when the component is hiding. See the detailed explanation on event architecture on the #componentEvents events list.

    Returns Event<Component<Config>, NoArgs>

onHoverChanged

onShow

  • get onShow(): Event<Component<Config>, NoArgs>

  • Gets the event that is fired when the component is showing. See the detailed explanation on event architecture on the #componentEvents events list.

    Returns Event<Component<Config>, NoArgs>

onViewModeChanged

  • get onViewModeChanged(): Event<Component<Config>, ViewModeChangedEventArgs>

  • Gets the event that is fired when the ViewMode of this component has changed.

    Returns Event<Component<Config>, ViewModeChangedEventArgs>

Methods

configure

  • configure(player, uimanager): void

  • 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.

    Parameters

    • player: PlayerAPI

      the player which this component controls

    • uimanager: UIInstanceManager

      the UIInstanceManager that manages this component

    Returns void

disable

  • disable(): void

  • 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)

    Returns void

enable

  • enable(): void

  • 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)

    Returns void

getConfig

  • getConfig(): SettingsPanelPageNavigatorConfig

  • Returns the configuration object of the component.

    Returns SettingsPanelPageNavigatorConfig

getDomElement

  • getDomElement(): DOM

  • Returns the DOM element of this component. Creates the DOM element if it does not yet exist.

    Should not be overwritten by subclasses.

    Returns DOM

hasDomElement

  • hasDomElement(): boolean

  • Checks if this component has a DOM element.

    Returns boolean

hide

  • hide(): void

  • Hides the component if shown. This method basically transfers the component into the hidden state. Actual hiding is done via CSS.

    Returns void

initialize

  • initialize(): void

  • 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.

    Returns void

isDisabled

  • isDisabled(): boolean

  • Determines if the component is disabled.

    Returns boolean

    true if the component is disabled, else false

isEnabled

  • isEnabled(): boolean

  • Determines if the component is enabled.

    Returns boolean

    true if the component is enabled, else false

isHidden

  • isHidden(): boolean

  • Determines if the component is hidden.

    Returns boolean

    true if the component is hidden, else false

isHovered

  • isHovered(): boolean

  • Determines if the component is currently hovered.

    Returns boolean

    true if the component is hovered, else false

isShown

  • isShown(): boolean

  • Determines if the component is shown.

    Returns boolean

    true if the component is visible, else false

popPage

pushTargetPage

release

  • release(): void

  • 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().

    Returns void

setAriaAttr

  • setAriaAttr(name, value): void

  • Parameters

    • name: string
    • value: string

    Returns void

setAriaLabel

setText

  • setText(text): void

  • Sets text on the label of the button.

    Parameters

    Returns void

show

toggleHidden

  • toggleHidden(): void

  • Toggles the hidden state by hiding the component if it is shown, or showing it if hidden.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods