Class UiConfigRendererBase<TUiNode>`Abstract`

A simple event dispatcher with typed event types, see IEventDispatcher.

Type Parameters

TUiNode = any

Hierarchy (view full)

SimpleEventDispatcher<"preFrame" | "preRender" | "postRender" | "postFrame">
- UiConfigRendererBase

Index

Constructors

Properties

_refreshQueue _root? config methods

Methods

_createUiContainer _refreshUiConfigObject addEventListener addToRefreshQueue appendChild dispatchEvent dispose disposeUiConfig hasEventListener refreshQueue refreshRoot removeChild removeEventListener renderUiConfig

Constructors

`Protected` constructor

new UiConfigRendererBase<TUiNode>(container?, autoFrameEvents?, methods?): UiConfigRendererBase<TUiNode>
Type Parameters
- TUiNode = any
Parameters
- container: HTMLElement = document.body
- autoFrameEvents: boolean = true
- Optional methods: UiConfigMethods
Returns UiConfigRendererBase<TUiNode>
Overrides SimpleEventDispatcher.constructor

Properties

`Protected` _refreshQueue

_refreshQueue: Record<TUiRefreshModes, [UiObjectConfig<any, string, any>, number, string][]> = ...

`Protected` `Optional` _root

_root?: TUiNode

`Readonly` config

config: UiObjectConfig<any, "panel", any> = ...

`Readonly` methods

methods: UiConfigMethods

Methods

`Protected` _createUiContainer

_createUiContainer(): HTMLDivElement
Returns HTMLDivElement

`Protected` `Abstract` _refreshUiConfigObject

_refreshUiConfigObject(config): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void

addEventListener

addEventListener(type, listener): void
Adds a listener to an event type.
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
  The type of event to listen to.
- listener: ((event) => void)
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      Returns void
Returns void
Inherited from SimpleEventDispatcher.addEventListener

addToRefreshQueue

addToRefreshQueue(mode, uiConfig, deep, delay): void
Parameters
- mode: "immediate" | TUiRefreshModes
- uiConfig: UiObjectConfig<any, string, any>
- deep: boolean
- delay: number
Returns void

appendChild

appendChild(config?): void
Parameters
- Optional config: UiObjectConfig<any, string, any>
Returns void

dispatchEvent

dispatchEvent(event): void
Fire an event type.
Parameters
- event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
Returns void
Inherited from SimpleEventDispatcher.dispatchEvent

dispose

dispose(): void
Returns void

disposeUiConfig

disposeUiConfig(config?, performDispose?): void
Disposes the UI associated with a config, doesn't makes change to the object or its parent.
Parameters
- Optional config: UiObjectConfig<any, string, any>
- performDispose: boolean = true
Returns void

hasEventListener

hasEventListener(type, listener): boolean
Checks if listener is added to an event type.
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
  The type of event to listen to.
- listener: ((event) => void)
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      Returns void
Returns boolean
Inherited from SimpleEventDispatcher.hasEventListener

refreshQueue

refreshQueue(mode): void
Parameters
- mode: TUiRefreshModes
Returns void

refreshRoot

refreshRoot(deep?, mode?, delay?): void
Parameters
- deep: boolean = true
- mode: "immediate" | TUiRefreshModes = "postFrame"
- delay: number = 0
Returns void

removeChild

removeChild(config): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void

removeEventListener

removeEventListener(type, listener): void
Removes a listener from an event type.
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
  The type of the listener that gets removed.
- listener: ((event) => void)
  The listener function that gets removed.
  - - (event): void
    - Parameters
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      Returns void
Returns void
Inherited from SimpleEventDispatcher.removeEventListener

`Abstract` renderUiConfig

renderUiConfig(uiConfig): void
Parameters
- uiConfig: UiObjectConfig<any, string, any>
Returns void