Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TabDialog<T, E>

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected activePanel

activePanel: T

Protected activeSubpanel

activeSubpanel: SubpanelInformation | undefined

Readonly attributes

attributes: AttributeManipulator<this>

Protected body

body: Component

Readonly classes

classes: ClassManipulator<this>

Readonly data

data: DataManipulator<this>

edges

edges: IDialogEdges = {} as any

The positions of each edge of the dialog. Stored as percentages.

event

Protected footer

footer: Component

Protected header

header: Header

Readonly id

Readonly log

log: Log

Protected Readonly panelWrapper

panelWrapper: Component

Protected Readonly scrollableHandler

scrollableHandler: void = new ScrollableHandler(this.element, "dialog").watchAnimations()

Protected storePanels

storePanels: boolean = true

Readonly style

style: StyleManipulator<this>

Protected subpanelInformations

subpanelInformations: SubpanelInformation[]

Protected Readonly subpanelLinkWrapper

subpanelLinkWrapper: Component

Protected subpanels

subpanels: T[]

Accessors

childCount

  • get childCount(): number
  • Returns number

dataset

  • get dataset(): DOMStringMap
  • Returns DOMStringMap

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

square

  • get square(): boolean
  • Returns boolean

Methods

addPanel

  • addPanel(id: string | number): Component<HTMLElement>
  • Parameters

    • id: string | number

    Returns Component<HTMLElement>

addScrollableWrapper

  • addScrollableWrapper(initializer?: undefined | ((wrapper: Component) => any)): Component<HTMLElement>

addSettingsPanel

append

appendTo

close

  • Closes the dialog.

    Also the event handler for when the close button is pressed in the dialog's header.

    Returns Promise<boolean>

closest

  • closest(selector: string): null | Element

contains

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

findDescendants

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

focus

  • focus(): void
  • Makes this dialog the top dialog.

    Returns void

getAs

  • getAs<C>(cls: Class<C>): 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>

Protected getDefaultSubpanelInformation

getIndex

  • getIndex(): number | undefined

Abstract getName

getNthChild

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

getOffset

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

    • left: number
    • top: number

getPanel

  • getPanel(id: string | number): undefined | Component<HTMLElement>
  • Parameters

    • id: string | number

    Returns undefined | Component<HTMLElement>

getParent

  • getParent<C>(): C | null

Protected Abstract getSubpanelInformation

  • Implements the abstract method in "TabDialog". Returns an array of tuples containing information used to set-up the subpanels of this dialog.

    If the subpanel classes haven't been instantiated yet, it first instantiates them by calling getSubpanels. This includes binding a WillRemove event handler to the panel, which will store (cache) the panel instead of removing it, and trigger a SwitchAway event on the panel when this occurs.

    Parameters

    • subpanels: T[]

    Returns SubpanelInformation[]

Protected Abstract getSubpanels

  • getSubpanels(): T[]
  • Implements the abstract method in "TabDialog". Returns an array of subpanels. This will only be called once

    Returns T[]

hide

  • hide(): this
  • Returns this

isActive

  • isActive(): boolean
  • Returns boolean

isFocused

  • isFocused(): boolean

isPanelVisible

  • isPanelVisible(id: string | number): boolean
  • Parameters

    • id: string | number

    Returns boolean

isVisible

  • isVisible(): boolean

markActive

  • markActive(reason: any): void
  • Mark that this dialog is "active"

    Parameters

    • reason: any

    Returns void

markInactive

  • markInactive(reason: any): void
  • Mark that this dialog is not "active"

    Parameters

    • reason: any

    Returns void

matches

  • matches(selector: string): boolean
  • Parameters

    • selector: string

    Returns boolean

Protected onAppend

  • onAppend(): void
  • Event handler for when this dialog is appended

    Returns void

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 onSelect

  • onSelect(_: any, component?: Component): void
  • Parameters

    Returns void

Protected onShowSubpanel

  • onShowSubpanel(showPanel: T): (Anonymous function)
  • Returns a function that will be executed when the passed subpanel is shown.

    When executed, the return function will append the panel to show to the passed component (which is the panel wrapper of the TabDialog), and trigger a SwitchTo event on the panel.

    Parameters

    • showPanel: T

    Returns (Anonymous function)

reflow

  • reflow(reason: string): void
  • Parameters

    • reason: string

    Returns void

regenerateBoxes

  • regenerateBoxes(): void

registerBindHandlers

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

registerEventBusSubscriber

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

registerHookHost

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

remove

  • remove(): this

removeTooltip

  • removeTooltip(): void

repaint

  • repaint(): void

resetSizeAndPosition

  • resetSizeAndPosition(): 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

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

setEdgePosition

  • setEdgePosition(edge: Edge, position: number): void
  • Set the position of an edge.

    Parameters

    • edge: Edge
    • position: number

    Returns void

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

setInitialSelection

  • setInitialSelection(initialSelection?: boolean): this

setSelectable

setSizeAndPosition

setStyle

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

    • property: string
    • value: string | number

    Returns this

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

showPanel

  • showPanel(id: string | number): undefined | Component<HTMLElement>
  • Parameters

    • id: string | number

    Returns undefined | Component<HTMLElement>

showSettingsPanel

  • showSettingsPanel(): this

Protected showSubPanel

  • showSubPanel(button: Button): void
  • showSubPanel(id: string | number): (link: Button) => void
  • Parameters

    Returns void

  • Parameters

    • id: string | number

    Returns (link: Button) => void

siblings

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

    Parameters

    • Optional selector: undefined | string

    Returns Stream<C>

store

  • store(): this
  • Returns this

toggle

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

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

    Returns this

toggleActive

  • toggleActive(reason: any, active: boolean): void
  • Toggle whether this dialog is "active"

    Parameters

    • reason: any
    • active: boolean

    Returns void

Protected updateSubpanelList

  • updateSubpanelList(): void
  • Returns void

Static all

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

    • selector: string

    Returns Stream<Component<HTMLElement>>

Static append

Static findDescendants

  • findDescendants(inElement: IComponent | HTMLElement, selector: string, includeSelf?: boolean): 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 makeTopDialog

  • makeTopDialog(element: HTMLElement): void
  • Parameters

    • element: HTMLElement

    Returns void

Static remove

Generated using TypeDoc