Class BimCTWindowAbstract

Abstract class representing a BimCT window.

Hierarchy

Constructors

constructor

Accessors

active footerText index leafRowHeight renderer resetWindowStyle title windowElement windowResizedEvent windowStateChangedEvent zIndex

Methods

activateWindow hide isShowing maximizeWindow moveHorizontally refreshUI resetToDefault restoreWindow setWindowLoading

Constructors

constructor

  • Constructor for BimCTWindow.

    Parameters

    • renderer: BaseRenderer

      The renderer associated with the window.

    • rendererElement: HTMLDivElement

      The HTML element for the renderer.

    • title: string

      The title of the window.

    • Optional resizable: boolean = true

      Whether the window is resizable.

    • Optional moveable: boolean = true

      Whether the window is moveable.

    Returns BimCTWindow

Accessors

active

  • get active(): boolean

  • Returns boolean

  • set active(active: boolean): void

  • Parameters

    • active: boolean

    Returns void

footerText

  • get footerText(): string

  • Returns string

  • set footerText(footerText: string): void

  • Parameters

    • footerText: string

    Returns void

index

  • get index(): number

  • Returns number

  • set index(index: number): void

  • Parameters

    • index: number

    Returns void

leafRowHeight

  • get leafRowHeight(): number

  • Returns number

renderer

  • get renderer(): BaseRenderer

  • Gets the renderer associated with the window.

    Returns

    The renderer.

    Returns BaseRenderer

resetWindowStyle

  • get resetWindowStyle(): string

  • Returns string

  • set resetWindowStyle(val: string): void

  • Parameters

    • val: string

    Returns void

title

  • get title(): string

  • Returns string

  • set title(title: string): void

  • Parameters

    • title: string

    Returns void

windowElement

  • get windowElement(): HTMLElement

  • Returns HTMLElement

windowResizedEvent

  • get windowResizedEvent(): IEvent<number, number>

  • Returns IEvent<number, number>

windowStateChangedEvent

zIndex

  • get zIndex(): number

  • Returns number

  • set zIndex(zIndex: number): void

  • Parameters

    • zIndex: number

    Returns void

Methods

activateWindow

  • Activates or deactivates the window.

    Parameters

    • activate: boolean

      Whether to activate the window.

    • Optional refresh: boolean = true

      Whether to refresh the UI.

    Returns void

hide

  • Hides the window.

    Returns

    True if the window was hidden, otherwise false.

    Returns boolean

isShowing

  • Checks if the window is currently showing.

    Returns

    True if the window is showing, otherwise false.

    Returns boolean

maximizeWindow

  • Maximizes the window to fill the screen.

    Returns void

moveHorizontally

  • Moves the window horizontally by a specified number of pixels. Only if already moved one time

    Parameters

    • pixels: number

      The number of pixels to move the window.

    Returns void

refreshUI

  • Refreshes the UI of the window.

    Returns void

resetToDefault

  • Resets the window to its default style.

    Parameters

    • force: boolean

      Whether to force the reset.

    Returns void

restoreWindow

  • Restores the window to its original size and position.

    Returns void

setWindowLoading

  • Sets the loading state of the window.

    Parameters

    • on: boolean

      Whether to show the loading state.

    Returns void

Settings

Member Visibility

Theme