Class BimCTMessageBoxWindow

Class representing a message box window.

Hierarchy

  • BimCTModalWindow
    • BimCTMessageBoxWindow

Constructors

constructor

Accessors

active footerText index leafRowHeight renderer resetWindowStyle title windowElement windowResizedEvent windowStateChangedEvent zIndex

Methods

activateWindow hide isShowing maximizeWindow moveHorizontally refreshUI resetToDefault restoreWindow setTempHide setWindowLoading showInputNumberMessageAsync showInputTextMessageAsync showInputUnitMessageAsync showMessage showMessageAsync

Constructors

constructor

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 message box window.

    Returns

    True if the message box was hidden, false otherwise.

    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

showInputNumberMessageAsync

  • Shows a message box with a number input asynchronously.

    Returns

    A promise that resolves to the input number value.

    Parameters

    • message: string

      The message to display.

    • title: string = ...

      The title of the message box.

    • value: number = undefined

      The initial value of the number input.

    • icon: MessageIcon = MessageIcon.INFO

      The icon to display in the message box.

    Returns Promise<number>

showInputTextMessageAsync

  • Shows a message box with a text input asynchronously.

    Returns

    A promise that resolves to the input text value.

    Parameters

    • message: string

      The message to display.

    • title: string = ...

      The title of the message box.

    • value: string = ''

      The initial value of the text input.

    • icon: MessageIcon = MessageIcon.INFO

      The icon to display in the message box.

    Returns Promise<string>

showInputUnitMessageAsync

  • Shows a message box with a unit input asynchronously.

    Returns

    A promise that resolves to the input number value in millimeters

    Parameters

    • message: string

      The message to display.

    • title: string = ...

      The title of the message box.

    • valueInMM: number = undefined
    • icon: MessageIcon = MessageIcon.INFO

      The icon to display in the message box.

    Returns Promise<number>

showMessage

  • Shows a message box with the specified parameters.

    Returns

    True if the message box was shown, false otherwise.

    Parameters

    • message: string

      The message to display.

    • title: string = ...

      The title of the message box.

    • callback: BimCTMessageBoxWindowCallback

      The callback to execute when a button is clicked.

    • option: MessageOption = MessageOption.OKCANCEL

      The options to display in the message box.

    • icon: MessageIcon = MessageIcon.INFO

      The icon to display in the message box.

    Returns boolean

showMessageAsync

  • Shows a message box asynchronously with the specified parameters.

    Returns

    A promise that resolves to the result of the message box.

    Parameters

    • message: string

      The message to display.

    • title: string = ...

      The title of the message box.

    • option: MessageOption = MessageOption.OKCANCEL

      The options to display in the message box.

    • icon: MessageIcon = MessageIcon.INFO

      The icon to display in the message box.

    Returns Promise<MessageResult>

Settings

Member Visibility

Theme