Class BimCTSettingsWindow

Class representing the settings window in BimCT.

Hierarchy

  • BimCTModalWindow
    • BimCTSettingsWindow

Constructors

constructor

Accessors

active footerText index leafRowHeight locked renderer resetWindowStyle settingsTabsBar settingsTabsContainer title windowElement windowResizedEvent windowStateChangedEvent zIndex

Methods

activateWindow fireSettingsChanged hide isShowing maximizeWindow moveHorizontally refreshUI resetToDefault restoreWindow setTempHide setWindowLoading show

Constructors

constructor

  • Constructor for BimCTSettingsWindow.

    Parameters

    • renderer: BaseRenderer

      The renderer.

    • rendererElement: HTMLDivElement

      The renderer element.

    Returns BimCTSettingsWindow

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

locked

  • get locked(): boolean

  • Gets the locked state of the settings window.

    Returns

    The locked state.

    Returns boolean

  • set locked(locked: boolean): void

  • Sets the locked state of the settings window.

    Parameters

    • locked: boolean

      The locked state.

    Returns void

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

settingsTabsBar

  • get settingsTabsBar(): HTMLDivElement

  • Gets the settings tabs bar element.

    Returns

    The settings tabs bar element.

    Returns HTMLDivElement

settingsTabsContainer

  • get settingsTabsContainer(): HTMLDivElement

  • Gets the settings tabs container element.

    Returns

    The settings tabs container element.

    Returns HTMLDivElement

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

fireSettingsChanged

  • Fires the settings changed event.

    Returns void

hide

  • Hides the settings window.

    Returns

    Whether the settings window was hidden.

    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 modal 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

setTempHide

  • Temporarily hides or shows the modal window.

    Parameters

    • val: boolean

      Whether to hide the window.

    Returns void

setWindowLoading

  • Sets the loading state of the window.

    Parameters

    • on: boolean

      Whether to show the loading state.

    Returns void

show

  • Shows the settings window.

    Returns

    Whether the settings window was shown.

    Returns boolean

Settings

Member Visibility

Theme