RSX Code Reference
    Preparing search index...

    Class SaveNewResourceDialog

    The SaveNewResourceDialog class provides a ResourceBrowserWindowBase for saving a resource in the library.

    Hierarchy (View Summary)

    Index
    _libraryBrowser: UILibraryBrowser

    Library browser UI element.

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

    Action called when the user choses a location or cancels.

    _resourceNameTextBox: UITextField

    Text box used to enter the resource name.

    cancelAndClose: () => void

    Cancel the operation and close the dialog.

    onResourceDoubleClick: (uiEntry: UILibraryEntry) => void

    Triggered when the user doubleclicks an entry.

    onSelectionChanged: () => void

    Triggered when the browser selection changes.

    defaultContentPadding: Immutable<RectOffset>

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

    defaultWindowPadding: number

    The default window padding to be used for modal windows.

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • 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: number): void

      Parameters

      • value: number

      Returns void

    • get dpiScale(): number

      Returns the DPI scale factor.

      Returns number

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

    • get height(): number

      Sets the height of the window in points.

      Returns number

    • set height(value: number): void

      Parameters

      • value: number

      Returns void

    • get heightInPixels(): number

      Sets the height of the window in pixels.

      Returns number

    • set heightInPixels(value: number): void

      Parameters

      • value: number

      Returns void

    • get isDestroyed(): boolean

      Check whether the window was destroyed.

      Returns boolean

    • get isFocused(): boolean

      Checks whether the window currently has keyboard focus.

      Returns boolean

    • set isFocused(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get keyWindow(): KeyWindowBase

      Gets the key window which owns this window.

      Returns KeyWindowBase

    • get left(): number

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

      Returns number

    • get localShortcutContext(): ShortcutContext

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

      Returns ShortcutContext

    • get position(): Immutable<rsx.UIPoint>

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

      Returns Immutable<rsx.UIPoint>

    • get renderWindow(): RenderWindow

      Gets the RenderWindow associated with this EditorWindow.

      Returns RenderWindow

    • get shortcutContext(): ShortcutContext

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

      Returns ShortcutContext

    • get styleSheet(): StyleSheet

      Sets the stylesheet for this window's UI surface.

      Returns StyleSheet

    • set styleSheet(value: StyleSheet): void

      Sets the stylesheet for this window's UI surface.

      Parameters

      Returns void

    • set title(value: I18N): void

      Changes the text in the modal window title bar.

      Parameters

      Returns void

    • get top(): number

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

      Returns number

    • get ui(): UIPanel

      Returns UIPanel

    • get width(): number

      Sets the width of the window in points.

      Returns number

    • set width(value: number): void

      Parameters

      • value: number

      Returns void

    • get widthInPixels(): number

      Sets the width of the window in pixels.

      Returns number

    • set widthInPixels(value: number): void

      Parameters

      • value: number

      Returns void

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

      Parameters

      • path: string

      Returns string

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

      Returns LibraryPath

      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.

    • Virtual

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

      Returns 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

    • Virtual

      Called whenever window visibility changed.

      Parameters

      • isVisible: boolean

      Returns void

      Implementing classes must call super.

    • Virtual

      Triggered whenever the window gains or loses focus.

      Parameters

      • inFocus: boolean

        True if focus was gained, false otherwise.

      Returns 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

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

      Returns 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

    • Defines the window maximum width and height in points.

      Parameters

      • maxWidth: number
      • maxHeight: number

      Returns 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

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

      Parameters

      • x: number
      • y: number

      Returns void

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

      Parameters

      • x: number
      • y: number

      Returns void

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

      Parameters

      • width: number
      • height: number

      Returns void

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

      Parameters

      • width: number
      • height: number

      Returns void

    onResized: Event<[p0: number, p1: number]>

    Triggered whenever window size changes.

    onFocusChangedInternal: Event<[isFocused: boolean]>