Class ErrorMessageBox

The ErrorMessageBox implements an error message window containing a title, a message and a set of buttons. The class allows an easy way to query and inform the user. When the user click a button, an optional user callback is called and the window is closed.

Hierarchy (view full)

Constructors

constructor

Properties

_buttonLayout _contentVerticalLayout _customElementLayout _flexibleSpace _icon _isRememberingChoice _mainVerticalLayout _message _messageLabel _secondaryMessage _secondaryMessageLabel _showRememberChoice _type cancelButton initialTitle noButton okButton onResult retryButton yesButton kButtonSpacing kElementSpacing kIconSize kWindowContentPadding kWindowPadding

Accessors

contentHeight contentHeightInPixels contentWidth contentWidthInPixels dpiScale getMaximumSize getMinimumSize height heightInPixels isDestroyed isFocused keyWindow left localShortcutContext parentWindow position renderWindow shortcutContext showRememberChoice size title top ui width widthInPixels errorIcon

Methods

autoResizeHeightForContents cancel center close confirm isVisible onButtonClicked onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setCustomElement setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToScreenPosition construct constructInternal open

Events

onResized onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_buttonLayout

_buttonLayout: UIVerticalLayout

The layout that holds the button elements.

Protected_contentVerticalLayout

_contentVerticalLayout: UIVerticalLayout

The main UI layout.

Protected_customElementLayout

_customElementLayout: UIVerticalLayout

The layout that holds the custom element.

Protected_flexibleSpace

_flexibleSpace: UIFlexibleSpace

Protected_icon

_icon: Image

The displayed icon.

Protected_isRememberingChoice

_isRememberingChoice: boolean

Protected_mainVerticalLayout

_mainVerticalLayout: UIVerticalLayout

The main UI layout.

Protected_message

_message: I18N

The main message.

Protected_messageLabel

_messageLabel: UILabel

Label that displays the message.

Protected_secondaryMessage

_secondaryMessage: I18N

The secondary message.

Protected_secondaryMessageLabel

_secondaryMessageLabel: UILabel

Label that displays the secondary message.

Protected_showRememberChoice

_showRememberChoice: boolean

Protected_type

_type: EnumValue<DialogBoxType, number>

Type of the dialog box.

cancelButton

cancelButton: UIButton

ReadonlyinitialTitle

initialTitle: I18N

The initial title of the message box.

noButton

noButton: UIButton

okButton

okButton: UIButton

onResult

onResult: ((result: EnumValue<DialogBoxResultType, number>, dialog: DialogBoxBase) => void)

Callback executed when the user pressed button, or enter/escape are pressed.

retryButton

retryButton: UIButton

yesButton

yesButton: UIButton

Static ReadonlykButtonSpacing

kButtonSpacing: number

Static ReadonlykElementSpacing

kElementSpacing: number

Static ReadonlykIconSize

kIconSize: number

Static ReadonlykWindowContentPadding

kWindowContentPadding: RectOffset

The default window content padding to be used for modal windows.

Static ReadonlykWindowPadding

kWindowPadding: number

The default window padding to be used for modal windows.

Accessors

contentHeight

  • get contentHeight(): number

  • Returns the height of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentHeight(value): void

  • Parameters

    • value: number

    Returns void

contentHeightInPixels

  • get contentHeightInPixels(): number

  • Returns the height of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentHeightInPixels(value): void

  • Parameters

    • value: number

    Returns void

contentWidth

  • get contentWidth(): number

  • Returns the width of the content area of the window, in points. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentWidth(value): void

  • Parameters

    • value: number

    Returns void

contentWidthInPixels

  • get contentWidthInPixels(): number

  • Returns the width of the content area of the window, in pixels. The content area represents the area of the window not including the title bar and the border.

    Returns number

  • set contentWidthInPixels(value): void

  • Parameters

    • value: number

    Returns void

dpiScale

  • get dpiScale(): number

  • Returns the DPI scale factor.

    Returns number

    Note

    The DPI scale is in relation to a 1x base resolution of 75 DPI.

getMaximumSize

getMinimumSize

height

  • get height(): number

  • Sets the height of the window in points.

    Returns number

  • set height(value): void

  • Parameters

    • value: number

    Returns void

heightInPixels

  • get heightInPixels(): number

  • Sets the height of the window in pixels.

    Returns number

  • set heightInPixels(value): void

  • Parameters

    • value: number

    Returns void

isDestroyed

  • get isDestroyed(): boolean

  • Check whether the window was destroyed.

    Returns boolean

isFocused

  • get isFocused(): boolean

  • Checks whether the window currently has keyboard focus.

    Returns boolean

  • set isFocused(value): void

  • Parameters

    • value: boolean

    Returns void

keyWindow

  • get keyWindow(): KeyWindowBase

  • Gets the key window which owns this window.

    Returns KeyWindowBase

left

  • get left(): number

  • Returns the X position of the window in screen coordinates in points.

    Returns number

localShortcutContext

  • get localShortcutContext(): ShortcutContext

  • Specifies the local shortcut context. This context will be automatically disabled whenever the user switches focus from the context.

    Returns ShortcutContext

parentWindow

position

  • get position(): Immutable<Vector2>

  • Determines the position in which the key window is, in screen coordinates.

    Returns Immutable<Vector2>

renderWindow

  • get renderWindow(): RenderWindow

  • Gets the RenderWindow associated with this EditorWindow.

    Returns RenderWindow

shortcutContext

  • get shortcutContext(): ShortcutContext

  • Specifies the global shortcut context. This context will be always enabled as long as the window is active.

    Returns ShortcutContext

showRememberChoice

  • get showRememberChoice(): boolean

  • Shows the remember my choice option to the user.

    Returns boolean

    Note

    This feature is not compatible with custom elements that can be added to a message box using setCustomElement. If a custom element is set, it will be removed.

  • set showRememberChoice(value): void

  • Parameters

    • value: boolean

    Returns void

size

title

  • set title(value): void

  • Changes the text in the modal window title bar.

    Parameters

    Returns void

top

  • get top(): number

  • Returns the X position of the window in screen coordinates in points.

    Returns number

ui

width

  • get width(): number

  • Sets the width of the window in points.

    Returns number

  • set width(value): void

  • Parameters

    • value: number

    Returns void

widthInPixels

  • get widthInPixels(): number

  • Sets the width of the window in pixels.

    Returns number

  • set widthInPixels(value): void

  • Parameters

    • value: number

    Returns void

StaticerrorIcon

  • get errorIcon(): Image

  • The default icon used for error message boxes.

    Returns Image

Methods

ProtectedautoResizeHeightForContents

cancel

  • cancel(): void

  • Shortcut triggered when Escape is pressed.

    Returns void

center

  • center(): void

  • Centers the window within it's parent window.

    Returns void

close

confirm

  • confirm(): void

  • Shortcut triggered when enter is pressed.

    Returns void

isVisible

onButtonClicked

onClose

  • onClose(): void
  • Virtual

    Called whenever the user or the program requested to close the window.

    Returns void

ProtectedonDestroy

  • onDestroy(): void
  • Virtual

    Method to override to implement destruction of custom windows. Called by the engine before the window is destroyed.

    Returns void

ProtectedonEditorUpdate

  • onEditorUpdate(): void
  • Virtual

    Method to override to implement custom behavior of a window, called by the engine once per frame.

    Returns void

ProtectedonEditorUpdateLate

  • onEditorUpdateLate(): void
  • Virtual

    Method to override to implement custom behavior of a window, called by the engine once per frame, once all the windows had their onEditorUpdate() method called.

    Returns void

onInitialize

onVisibilityChanged

  • onVisibilityChanged(isVisible): void
  • Virtual

    Called whenever window visibility changed.

    Parameters

    • isVisible: boolean

    Returns void

    Note

    Implementing classes must call super.

onWindowDPIChanged

onWindowFocusChanged

  • onWindowFocusChanged(inFocus): void
  • Virtual

    Triggered whenever the window gains or loses focus.

    Parameters

    • inFocus: boolean

      True if focus was gained, false otherwise.

    Returns void

onWindowResized

  • onWindowResized(width, height): void
  • Virtual

    Triggered whenever the window size changes.

    Parameters

    • width: number

      New width of the window in pixels.

    • height: number

      New height of the window in pixels.

    Returns void

screenToWindowPosition

setCustomElement

  • setCustomElement(element, overflowScroll?): void
  • Virtual

    Adds a custom element to the message box.

    Parameters

    • element: UIElementBase

      The element to add to the message box.

    • OptionaloverflowScroll: boolean

      If set, the element will be added to a scroll area if the height overflows The maximum height of the dialog box.

    Returns void

    Note

    To remove the custom element, call this method again and pass null

setMaximumSize

  • setMaximumSize(maxWidth, maxHeight): void

  • Defines the window maximum width and height in points.

    Parameters

    • maxWidth: number
    • maxHeight: number

    Returns void

setMinimumSize

  • setMinimumSize(minWidth, minHeight): void

  • Defines the window minimum width and height in points.

    Parameters

    • minWidth: number

      The minimum width of the window in points.

    • minHeight: number

      The minimum height of the window in points.

    Returns void

setPosition

  • setPosition(x, y): void

  • Moves the window on the desktop. Coordinates are in screen space using points.

    Parameters

    • x: number
    • y: number

    Returns void

setPositionInPixels

  • setPositionInPixels(x, y): void

  • Moves the window on the desktop. Coordinates are in screen space using pixels.

    Parameters

    • x: number
    • y: number

    Returns void

setSize

  • setSize(width, height): void

  • Resizes the window using a width and height in points.

    Parameters

    • width: number
    • height: number

    Returns void

setSizeInPixels

  • setSizeInPixels(width, height): void

  • Resizes the window using a width and height in pixels.

    Parameters

    • width: number
    • height: number

    Returns void

windowToScreenPosition

Staticconstruct

Protected StaticconstructInternal

Staticopen

  • open(parentWindow, title, message, secondaryMessage?, type?, resultCallback?): ErrorMessageBox

  • Opens a new message box.

    Parameters

    Returns ErrorMessageBox

    Instance of the dialog box window.

Events

ReadonlyonResized

onResized: Event<[number, number], void>

Triggered whenever widget size changes.

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events