Class ResourceBrowserWindowBase<T>Abstract

The ResourceBrowserWindowBase implements a base ModalWindow that enables the user to browse the library to pick a path to load or save a resource from. The dialog is specialized further as OpenResourceDialog and SaveNewResourceDialog.

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

_libraryBrowser _onAction _resourceNameTextBox cancelAndClose onResourceDoubleClick onSelectionChanged kWindowContentPadding kWindowPadding

Accessors

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

Methods

addOption cancel center close confirm deleteSelection getConfirmActionContent getParentFolder isVisible moveBackwards moveDown moveLeft moveRight moveUp onActionTriggeredCopy onActionTriggeredCut onActionTriggeredDelete onActionTriggeredDuplicate onActionTriggeredPaste onActionTriggeredRename onActionTriggeredSelectAll onClose onConfirm onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized pasteToSelection renameSelection reset saveAndClose screenToWindowPosition selectAll setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels windowToScreenPosition construct constructInternal

Events

onResized onFocusChangedInternal

Constructors

Protectedconstructor

Properties

Protected_libraryBrowser

_libraryBrowser: UILibraryBrowser

Library browser UI element.

Protected_onAction

_onAction: ((isSaving: boolean, resource: T) => void)

Action called when the user choses a location or cancels.

Protected_resourceNameTextBox

_resourceNameTextBox: UITextField

Text box used to enter the resource name.

ProtectedcancelAndClose

cancelAndClose: (() => void)

Cancel the operation and close the dialog.

ProtectedonResourceDoubleClick

onResourceDoubleClick: ((uiEntry: UILibraryEntry) => void)

Triggered when the user doubleclicks an entry.

ProtectedonSelectionChanged

onSelectionChanged: (() => void)

Triggered when the browser selection changes.

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

mainLayout

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

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

Methods

addOption

  • addOption(label, element): void

  • Adds an option to the resource browser window.

    Parameters

    • label: {
          __brand: "EditorI18N";
          compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
          trimString(value: string): string;
          trimStringEnd(value: string): string;
          trimStringStart(value: string): string;
      }

      The label for the option.

      • __brand: "EditorI18N"
      • compare:function
        • compare(other, mode): boolean

        • Compares two strings for equality by respecting the given comparison mode.

          Parameters

          • other: string

            The string to compare to.

          • mode: EnumValue<StringCompareMode, number>

            The mode to compare the string. Allows specifying how case sensitivity should be treated on the compare.

          Returns boolean

          True if the strings are considered equal for the given mode; false otherwise.

      • trimString:function
        • trimString(value): string

        • Trims the characters from the start and the end and returns the result as a new string.

          Parameters

          • value: string

          Returns string

      • trimStringEnd:function
        • trimStringEnd(value): string

        • Trims the characters from the end and returns the result as a new string.

          Parameters

          • value: string

          Returns string

      • trimStringStart:function
        • trimStringStart(value): string

        • Trims the characters from the start and returns the result as a new string.

          Parameters

          • value: string

          Returns string

    • element: UIElementBase

      The element to add to the options form.

    Returns void

Protectedcancel

  • cancel(): void

  • Shortcut triggered when Escape is pressed.

    Returns void

center

  • center(): void

  • Centers the window within it's parent window.

    Returns void

close

  • close(): void

  • Closes and destroys the window.

    Returns void

Protectedconfirm

  • confirm(): void

  • Shortcut triggered when enter is pressed.

    Returns void

ProtecteddeleteSelection

  • deleteSelection(): void

  • Deletes currently selected elements. User will be asked to confirm deletion via a dialog box.

    Returns void

Protected AbstractgetConfirmActionContent

  • getConfirmActionContent(): UIContent

  • Gets the title of the confirm action. If null, the confirm button will not be available.

    Returns UIContent

ProtectedgetParentFolder

  • getParentFolder(path): string

  • Get the parent folder of a resource, if it is a package, return the library root.

    Parameters

    • path: string

    Returns string

isVisible

  • isVisible(): boolean

  • Determines if the window is visible.

    Returns boolean

ProtectedmoveBackwards

  • moveBackwards(): void

  • Returns void

ProtectedmoveDown

  • moveDown(): void

  • Returns void

moveLeft

  • moveLeft(): void

  • Returns void

moveRight

  • moveRight(): void

  • Returns void

ProtectedmoveUp

  • moveUp(): void

  • Returns void

ProtectedonActionTriggeredCopy

  • onActionTriggeredCopy(): void

  • Performs LibraryBrowser.copy operation on the currently selected elements.

    Returns void

ProtectedonActionTriggeredCut

  • onActionTriggeredCut(): void

  • Performs LibraryBrowser.cut operation on the currently selected elements.

    Returns void

ProtectedonActionTriggeredDelete

  • onActionTriggeredDelete(): void

  • Returns void

ProtectedonActionTriggeredDuplicate

  • onActionTriggeredDuplicate(): void

  • Performs LibraryBrowser.duplicate operation on the currently selected elements.

    Returns void

ProtectedonActionTriggeredPaste

  • onActionTriggeredPaste(): void

  • Returns void

ProtectedonActionTriggeredRename

  • onActionTriggeredRename(): void

  • Returns void

ProtectedonActionTriggeredSelectAll

  • onActionTriggeredSelectAll(): void

  • Returns void

onClose

  • onClose(): void
  • Virtual

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

    Returns void

Protected AbstractonConfirm

  • onConfirm(): T

  • Implemented by the child class to handle the confirmation action.

    Returns T

    Note

    If this method returns a null, the operation will be aborted without closing the window. It is assumed that the child class displays a error or message to the user to inform why the action was canceled.

    If this method returns a valid object of type T, the operation will continue and the onAction handler will be called with the object.

onDestroy

  • onDestroy(): void

  • Gets called when 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

  • Initializes the window content.

    Parameters

    • options: {
          defaultName: string;
          initialLibraryPathOrResourceEntry: string | ResourceEntry;
          message: {
              __brand: "EditorI18N";
              compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
              trimString(value: string): string;
              trimStringEnd(value: string): string;
              trimStringStart(value: string): string;
          };
          nameFieldLabel: {
              __brand: "EditorI18N";
              compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
              trimString(value: string): string;
              trimStringEnd(value: string): string;
              trimStringStart(value: string): string;
          };
          onAction: ((isSaving: boolean, resource: T) => void);
          resourceType: Type | EnumValue<ResourceType, number>;
          showAffixResources?: boolean;
          title: {
              __brand: "EditorI18N";
              compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
              trimString(value: string): string;
              trimStringEnd(value: string): string;
              trimStringStart(value: string): string;
          };
      }
      • defaultName: string
      • initialLibraryPathOrResourceEntry: string | ResourceEntry
      • message: {
            __brand: "EditorI18N";
            compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
            trimString(value: string): string;
            trimStringEnd(value: string): string;
            trimStringStart(value: string): string;
        }
        • __brand: "EditorI18N"
        • compare:function
          • compare(other, mode): boolean

          • Compares two strings for equality by respecting the given comparison mode.

            Parameters

            • other: string

              The string to compare to.

            • mode: EnumValue<StringCompareMode, number>

              The mode to compare the string. Allows specifying how case sensitivity should be treated on the compare.

            Returns boolean

            True if the strings are considered equal for the given mode; false otherwise.

        • trimString:function
          • trimString(value): string

          • Trims the characters from the start and the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringEnd:function
          • trimStringEnd(value): string

          • Trims the characters from the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringStart:function
          • trimStringStart(value): string

          • Trims the characters from the start and returns the result as a new string.

            Parameters

            • value: string

            Returns string

      • nameFieldLabel: {
            __brand: "EditorI18N";
            compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
            trimString(value: string): string;
            trimStringEnd(value: string): string;
            trimStringStart(value: string): string;
        }
        • __brand: "EditorI18N"
        • compare:function
          • compare(other, mode): boolean

          • Compares two strings for equality by respecting the given comparison mode.

            Parameters

            • other: string

              The string to compare to.

            • mode: EnumValue<StringCompareMode, number>

              The mode to compare the string. Allows specifying how case sensitivity should be treated on the compare.

            Returns boolean

            True if the strings are considered equal for the given mode; false otherwise.

        • trimString:function
          • trimString(value): string

          • Trims the characters from the start and the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringEnd:function
          • trimStringEnd(value): string

          • Trims the characters from the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringStart:function
          • trimStringStart(value): string

          • Trims the characters from the start and returns the result as a new string.

            Parameters

            • value: string

            Returns string

      • onAction: ((isSaving: boolean, resource: T) => void)
          • (isSaving, resource): void

          • Parameters

            • isSaving: boolean
            • resource: T

            Returns void

      • resourceType: Type | EnumValue<ResourceType, number>
      • OptionalshowAffixResources?: boolean
      • title: {
            __brand: "EditorI18N";
            compare(other: string, mode: EnumValue<StringCompareMode, number>): boolean;
            trimString(value: string): string;
            trimStringEnd(value: string): string;
            trimStringStart(value: string): string;
        }
        • __brand: "EditorI18N"
        • compare:function
          • compare(other, mode): boolean

          • Compares two strings for equality by respecting the given comparison mode.

            Parameters

            • other: string

              The string to compare to.

            • mode: EnumValue<StringCompareMode, number>

              The mode to compare the string. Allows specifying how case sensitivity should be treated on the compare.

            Returns boolean

            True if the strings are considered equal for the given mode; false otherwise.

        • trimString:function
          • trimString(value): string

          • Trims the characters from the start and the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringEnd:function
          • trimStringEnd(value): string

          • Trims the characters from the end and returns the result as a new string.

            Parameters

            • value: string

            Returns string

        • trimStringStart:function
          • trimStringStart(value): string

          • Trims the characters from the start and returns the result as a new string.

            Parameters

            • value: string

            Returns string

    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

ProtectedpasteToSelection

  • pasteToSelection(): void

  • Performs LibraryBrowser.paste operation. Elements will be pasted in the currently selected directory (if any), or the active directory otherwise.

    Returns void

ProtectedrenameSelection

  • renameSelection(): void

  • Starts a rename operation on the currently selected elements. If more than one elements are selected only the first one will be affected.

    Returns void

reset

  • reset(): void

  • Resets the library window to initial state.

    Returns void

ProtectedsaveAndClose

  • saveAndClose(): void

  • Save the resource at the chosen location and close the dialog.

    Returns void

screenToWindowPosition

ProtectedselectAll

  • selectAll(): void

  • Performs LibraryBrowser.selectAll operation.

    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

Staticconstruct

Protected StaticconstructInternal

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