Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabGameplay<I, E>

Type parameters

  • I: string | number | undefined

  • E: HTMLElement

Hierarchy

  • Tab
    • TabGameplay

Implements

Index

Constructors

constructor

Properties

Readonly attributes

attributes: AttributeManipulator<this>

Readonly classes

classes: ClassManipulator<this>

Readonly data

data: DataManipulator<this>

Optional description

description: Paragraph

event

Readonly id

id: I

section

section: MenuSection | undefined

Readonly style

style: StyleManipulator<this>

Readonly text

text: Text

Optional wrapperButtons

wrapperButtons: Component

Accessors

childCount

  • get childCount(): number
  • Returns number

dataset

  • get dataset(): DOMStringMap
  • Returns DOMStringMap

disabled

  • get disabled(): boolean

element

  • get element(): E
  • Returns E

listen

  • get listen(): (...args: A) => R
  • Alias of .element.addEventListener

    Returns (...args: A) => R

      • (...args: A): R
      • Parameters

        • Rest ...args: A

        Returns R

selectable

subtabs

  • get subtabs(): Tab<undefined | string | number>[]
  • Returns Tab<undefined | string | number>[]

Methods

activate

  • activate(playSound?: boolean): void
  • Parameters

    • Default value playSound: boolean = true

    Returns void

addButton

addDescription

  • addDescription(initializer: (description: Paragraph) => any): this

append

appendTo

closest

  • closest(selector: string): null | Element
  • Parameters

    • selector: string

    Returns null | Element

contains

  • Parameters

    Returns boolean

deregisterBindHandlers

  • deregisterBindHandlers(): void

deregisterEventBusSubscriber

  • deregisterEventBusSubscriber(): void

dump

  • dump(filter?: undefined | ((element: HTMLElement, component?: Component) => boolean)): this
  • Parameters

    • Optional filter: undefined | ((element: HTMLElement, component?: Component) => boolean)

    Returns this

exists

  • exists(): boolean
  • Returns boolean

findDescendants

  • findDescendants<E>(selector: string): NodeListOf<E>

getAs

  • getAs<C>(cls: Class<C>): undefined | C
  • Type parameters

    Parameters

    Returns undefined | C

getBox

  • getBox(regenIfZero?: boolean, forceRegen?: boolean): Rectangle
  • Parameters

    • Default value regenIfZero: boolean = true
    • Default value forceRegen: boolean = false

    Returns Rectangle

getChildren

  • getChildren<C>(selector?: undefined | string): Stream<C>
  • Type parameters

    Parameters

    • Optional selector: undefined | string

    Returns Stream<C>

getIndex

  • getIndex(): number | undefined
  • Returns number | undefined

getNthChild

  • getNthChild<C>(nth?: number): C
  • Type parameters

    Parameters

    • Default value nth: number = 0

    Returns C

getOffset

  • getOffset(): { left: number; top: number }
  • Returns { left: number; top: number }

    • left: number
    • top: number

getParent

  • getParent<C>(): C | null
  • Type parameters

    Returns C | null

getText

getTextAsString

  • getTextAsString(): string

hide

  • hide(): this
  • Returns this

isButtonList

  • isButtonList(): boolean

isFocused

  • isFocused(): boolean
  • Returns boolean

isVisible

  • isVisible(): boolean

matches

  • matches(selector: string): boolean
  • Parameters

    • selector: string

    Returns boolean

Protected onContextMenu

Protected onEnter

  • onEnter(reason: "mouse" | "focus"): void
  • Parameters

    • reason: "mouse" | "focus"

    Returns void

Protected onLeave

  • onLeave(reason: "mouse" | "focus"): void
  • Parameters

    • reason: "mouse" | "focus"

    Returns void

Protected playSound

  • playSound(): void

reflow

  • reflow(reason: string): void
  • Parameters

    • reason: string

    Returns void

refresh

  • refresh(): this
  • Returns this

refreshText

  • refreshText(): this

regenerateBoxes

  • regenerateBoxes(): void

registerBindHandlers

  • registerBindHandlers(...untilEvents: Array<keyof Events<this>>): void
  • registerBindHandlers(warnIfNoHandlers: false, ...untilEvents: Array<keyof Events<this>>): void
  • Parameters

    • Rest ...untilEvents: Array<keyof Events<this>>

    Returns void

  • Parameters

    • warnIfNoHandlers: false
    • Rest ...untilEvents: Array<keyof Events<this>>

    Returns void

registerEventBusSubscriber

  • registerEventBusSubscriber(...untilEvents: Array<keyof Events<this>>): void

registerHookHost

  • registerHookHost(name?: undefined | string, ...untilEvents: Array<keyof Events<this>>): void
  • Parameters

    • Optional name: undefined | string
    • Rest ...untilEvents: Array<keyof Events<this>>

    Returns void

remove

  • remove(): this

removeTooltip

  • removeTooltip(): void
  • Returns void

repaint

  • repaint(): void

schedule

  • schedule<A>(cb: (this: this, button: this, ...args: A) => any, ...args: A): this
  • schedule(cb?: undefined | ((this: this, button: this) => any), ...args: any[]): this
  • schedule<A>(ms: number, cb: (this: this, button: this, ...args: A) => any, ...args: A): this
  • schedule(ms: number, cb?: undefined | ((this: this, button: this) => any), ...args: any[]): this
  • schedule<A>(ms: number, debounce: number, cb: (this: this, button: this, ...args: A) => any, ...args: A): this
  • schedule(ms: number, debounce: number, cb?: undefined | ((this: this, button: this) => any), ...args: any[]): this
  • Type parameters

    • A: any[]

    Parameters

    • cb: (this: this, button: this, ...args: A) => any
        • (this: this, button: this, ...args: A): any
        • Parameters

          • this: this
          • button: this
          • Rest ...args: A

          Returns any

    • Rest ...args: A

    Returns this

  • Parameters

    • Optional cb: undefined | ((this: this, button: this) => any)
    • Rest ...args: any[]

    Returns this

  • Type parameters

    • A: any[]

    Parameters

    • ms: number
    • cb: (this: this, button: this, ...args: A) => any
        • (this: this, button: this, ...args: A): any
        • Parameters

          • this: this
          • button: this
          • Rest ...args: A

          Returns any

    • Rest ...args: A

    Returns this

  • Parameters

    • ms: number
    • Optional cb: undefined | ((this: this, button: this) => any)
    • Rest ...args: any[]

    Returns this

  • Type parameters

    • A: any[]

    Parameters

    • ms: number
    • debounce: number
    • cb: (this: this, button: this, ...args: A) => any
        • (this: this, button: this, ...args: A): any
        • Parameters

          • this: this
          • button: this
          • Rest ...args: A

          Returns any

    • Rest ...args: A

    Returns this

  • Parameters

    • ms: number
    • debounce: number
    • Optional cb: undefined | ((this: this, button: this) => any)
    • Rest ...args: any[]

    Returns this

scrollTo

  • scrollTo(child: Component, ms?: undefined | number): void
  • scrollTo(child: Component, offsetTop: number, ms?: undefined | number): void
  • Parameters

    • child: Component
    • Optional ms: undefined | number

    Returns void

  • Parameters

    • child: Component
    • offsetTop: number
    • Optional ms: undefined | number

    Returns void

setActionless

  • setActionless(isActionless?: boolean): this
  • Parameters

    • Default value isActionless: boolean = true

    Returns this

setActive

  • setActive(active?: boolean): this
  • Parameters

    • Default value active: boolean = true

    Returns this

setButtonList

  • setButtonList(isButtonList?: boolean): this
  • Parameters

    • Default value isButtonList: boolean = true

    Returns this

setContents

  • setContents(html: string, escape?: boolean): this
  • Parameters

    • html: string
    • Default value escape: boolean = false

    Returns this

setContextMenu

  • setContextMenu(): this
  • setContextMenu(generator: (contextMenu: ContextMenu) => ContextMenu | undefined, priority?: undefined | number): this

setDisabled

  • setDisabled(val?: boolean, reason?: string): this
  • Parameters

    • Default value val: boolean = true
    • Default value reason: string = "any"

    Returns this

setElement

  • setElement(element: E): this
  • setElement(elementType?: undefined | string, namespace?: Namespace): this
  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • element: E

    Returns this

  • Warning: This method will replace the internal element backing this component.

    Only call this directly after constructing the element.

    Parameters

    • Optional elementType: undefined | string
    • Optional namespace: Namespace

    Returns this

setHighlight

setId

  • setId(id: string): this
  • Parameters

    • id: string

    Returns this

setInactive

  • setInactive(): this
  • Returns this

setInitialSelection

  • setInitialSelection(initialSelection?: boolean): this
  • Parameters

    • Default value initialSelection: boolean = true

    Returns this

setSection

  • Parameters

    Returns this

setSelectable

setStyle

  • setStyle(property: string, value: string | number): this
  • Parameters

    • property: string
    • value: string | number

    Returns this

setSubTabs

setText

setTooltip

  • setTooltip(initializer?: undefined | ((tooltip: ITooltip) => any), _showOnHover?: boolean): this
  • Parameters

    • Optional initializer: undefined | ((tooltip: ITooltip) => any)
    • Default value _showOnHover: boolean = true

    Returns this

show

  • show(): this
  • Returns this

siblings

  • siblings<C>(selector?: undefined | string): Stream<C>
  • Type parameters

    Parameters

    • Optional selector: undefined | string

    Returns Stream<C>

store

  • store(): this

toggle

  • toggle(visible?: boolean): this
  • Parameters

    • Default value visible: boolean = this.classes.hasAny("hidden")

    Returns this

Static all

  • all(selector: string): Stream<Component<HTMLElement>>
  • Parameters

    • selector: string

    Returns Stream<Component<HTMLElement>>

Static append

  • Parameters

    Returns void

Static createContent

Static findDescendants

  • findDescendants(inElement: IComponent | HTMLElement, selector: string, includeSelf?: boolean): HTMLElement[]
  • Parameters

    • inElement: IComponent | HTMLElement
    • selector: string
    • Default value includeSelf: boolean = false

    Returns HTMLElement[]

Static get

  • get(selector: string): Component | undefined
  • get(element: Element): Component
  • get(event: Event): Component
  • get(element: Element | null | false | undefined): Component | undefined
  • get(selector: string, create: false | undefined): Component | undefined
  • get(element: Element, create: false | undefined): Component | undefined
  • get(event: Event, create: false | undefined): Component | undefined
  • get(element: Element | null | false | undefined, create: false | undefined): Component | undefined
  • get<C>(selector: string): C | undefined
  • get<C>(element: Element): C
  • get<C>(event: Event): C
  • get<C>(element: Element | null | false | undefined): C | undefined
  • get<C>(selector: string, create: false | undefined): C | undefined
  • get<C>(element: Element, create: false | undefined): C | undefined
  • get<C>(event: Event, create: false | undefined): C | undefined
  • get<C>(element: Element | null | false | undefined, create: false | undefined): C | undefined
  • Parameters

    • selector: string

    Returns Component | undefined

  • Parameters

    Returns Component

  • Parameters

    Returns Component

  • Parameters

    • element: Element | null | false | undefined

    Returns Component | undefined

  • Parameters

    • selector: string
    • create: false | undefined

    Returns Component | undefined

  • Parameters

    • element: Element
    • create: false | undefined

    Returns Component | undefined

  • Parameters

    • event: Event
    • create: false | undefined

    Returns Component | undefined

  • Parameters

    • element: Element | null | false | undefined
    • create: false | undefined

    Returns Component | undefined

  • Type parameters

    Parameters

    • selector: string

    Returns C | undefined

  • Type parameters

    Parameters

    Returns C

  • Type parameters

    Parameters

    Returns C

  • Type parameters

    Parameters

    • element: Element | null | false | undefined

    Returns C | undefined

  • Type parameters

    Parameters

    • selector: string
    • create: false | undefined

    Returns C | undefined

  • Type parameters

    Parameters

    • element: Element
    • create: false | undefined

    Returns C | undefined

  • Type parameters

    Parameters

    • event: Event
    • create: false | undefined

    Returns C | undefined

  • Type parameters

    Parameters

    • element: Element | null | false | undefined
    • create: false | undefined

    Returns C | undefined

Static getSelectableLayer

  • getSelectableLayer(element: IComponent | HTMLElement): number | false

Static remove

  • Parameters

    Returns void

Generated using TypeDoc