Class InlineCalloutWindow

The InlineCalloutWindow class provides a quick way to construct an inline CalloutWindow. The user of the class provides a callback that will be invoked when the window contents will be created. The inline callout window can be dismissed by pressing the Escape button.

Note

This class should not be used for complex windows and interactions. It aims to provide a quick way to construct a window without the need for subclassing, only to display a handful of UI elements.

Hierarchy (view full)

Constructors

constructor

Properties

_closeCallback _isEscapeButtonAction

Accessors

dpiScale getMaximumSize getMinimumSize height heightInPixels isDestroyed isFocused keyWindow left localShortcutContext parentWindow position renderWindow shortcutContext size top ui width widthInPixels

Methods

center close isVisible onActionTriggeredClose onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setAnchor setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToScreenPosition construct constructInternal open

Events

onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_closeCallback

_closeCallback: ((window: CalloutWindow, isEscapeButtonAction: boolean) => void)

Protected_isEscapeButtonAction

_isEscapeButtonAction: boolean

Accessors

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

size

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

Methods

center

  • center(): void

  • Centers the window within it's parent window.

    Returns void

close

  • close(): void

  • Closes and destroys the window.

    Returns void

isVisible

  • isVisible(): boolean

  • Determines if the window is visible.

    Returns boolean

onActionTriggeredClose

  • onActionTriggeredClose(): void

  • Closes the window.

    Returns void

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

  • onInitialize(options): void
  • Virtual

    Method to override to implement initialization of custom windows. Called by the engine after window creation.

    Parameters

    • options: {
          onClose: ((window: CalloutWindow, isEscapeButtonAction: boolean) => void);
          onInitialize: ((window: CalloutWindow) => void);
      }
      • onClose: ((window: CalloutWindow, isEscapeButtonAction: boolean) => void)
          • (window, isEscapeButtonAction): void

          • Parameters

            Returns void

      • onInitialize: ((window: CalloutWindow) => void)

    Returns void

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

setAnchor

  • setAnchor(anchorScreenBounds): void

  • Changes anchoring of callout window to anchor manually to a given screen rectangle.

    Parameters

    Returns void

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

Protected Staticconstruct

  • construct<T>(windowClass, keyWindow, anchor, anchorPosition?, placement?, windowOptions?): T

  • Opens a CalloutWindow of the specified windowClass.

    Type Parameters

    • T

    Parameters

    Returns T

    The newly constructed window.

StaticconstructInternal

Staticopen

  • open(keyWindow, anchor, anchorPosition, onInitialize, onClose?, placement?): InlineCalloutWindow

  • Opens an inline CalloutWindow that can be constructed in the specified onInitialize callback.

    Parameters

    • keyWindow: KeyWindowBase

      The parent key window, if null, will use the current.

    • anchor: UIElementBase

      The anchoring element.

    • anchorPosition: number

      The optional anchor position.

    • onInitialize: ((window: CalloutWindow) => void)

      The callback that will be called when the window is being initialized and the UI should be populated.

    • OptionalonClose: ((window: CalloutWindow, isEscapeButtonAction: boolean) => void)

      The optional callback when the window is being closed.

        • (window, isEscapeButtonAction): void

        • Parameters

          Returns void

    • Optionalplacement: EnumValue<CalloutPlacement, number>

      The optional placement.

    Returns InlineCalloutWindow

    The newly constructed window.

Events

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events