Class CloudSyncStatusWindow

A callout window displaying the contents of the current sync status.

Hierarchy (view full)

Constructors

constructor

Properties

onActionAdded _bottomBarContentSpacing _buttonTotalHeight _buttonTotalWidth _iconButtonSize _listEntryHeight _minimumButtomLabelSize _minimumScrollAreaHeight _syncStatusIconSize _titleToContentSpacing defaultSpacing kMaximumActionCount

Accessors

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

Methods

center clearHistory close fetchInitialHistoryUpdate isVisible markWatchdogActionHistoryDirty onClose onDestroy onEditorUpdate onEditorUpdateLate onInitialize onVisibilityChanged onWindowDPIChanged onWindowFocusChanged onWindowResized screenToWindowPosition setAnchor setMaximumSize setMinimumSize setPosition setPositionInPixels setSize setSizeInPixels updateCatalogReceiveTime updateFinalizedAction windowToScreenPosition clearActionsListFromMemory construct constructInternal getActionsHistory isActionEntryEqual isActionRelevant isActionUIRelevant loadActionsListFromDisk open persistWatchdogHistory updateWatchdogHistory

Events

onWatchdogActionAdded onFocusChangedInternal

Constructors

Protectedconstructor

Properties

onActionAdded

onActionAdded: ((newAction: WatchdogAction) => void)

Gets called whenever a new WatchdogAction was added to the list.

Static_bottomBarContentSpacing

_bottomBarContentSpacing: number

The spacing between the separator and the bottom buttons area.

Static_buttonTotalHeight

_buttonTotalHeight: number

The height of each button on the bottom area.

Static_buttonTotalWidth

_buttonTotalWidth: number

The width of each button on the bottom area.

Static_iconButtonSize

_iconButtonSize: number

The size of the each icon in the bottom buttons.

Static_listEntryHeight

_listEntryHeight: number

The height of each entry on the list.

Static_minimumButtomLabelSize

_minimumButtomLabelSize: number

The minimum height of the label inside each bottom button.

Static_minimumScrollAreaHeight

_minimumScrollAreaHeight: number

The minimum size of the Scroll area with the main content.

Static_syncStatusIconSize

_syncStatusIconSize: number

The size of the sync status icon.

Static_titleToContentSpacing

_titleToContentSpacing: number

The spacing between the title content to the main scroll area.

StaticdefaultSpacing

defaultSpacing: number

Default spacing between one element to another.

StatickMaximumActionCount

kMaximumActionCount: number

The maximum Watchdog Actions count possible in the queue before deleting old actions.

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

clearHistory

  • clearHistory(): void

  • Clears the watchdog history.

    Returns void

close

  • close(): void

  • Closes and destroys the window.

    Returns void

ProtectedfetchInitialHistoryUpdate

  • fetchInitialHistoryUpdate(): void

  • Fill the initial list view with the current Action History, and update the last catalog update received.

    Returns void

isVisible

  • isVisible(): boolean

  • Determines if the window is visible.

    Returns boolean

ProtectedmarkWatchdogActionHistoryDirty

  • markWatchdogActionHistoryDirty(): void

  • Mark the current watchdog history list view as dirty.

    Returns void

onClose

  • onClose(): void
  • Virtual

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

    Returns void

onDestroy

  • onDestroy(): void
  • Virtual

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

    Returns void

onEditorUpdate

  • 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: any

    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

ProtectedupdateCatalogReceiveTime

  • updateCatalogReceiveTime(catalogUpdateAction): void

  • Updates the UI elements with the last catalog fetch action.

    Parameters

    Returns void

ProtectedupdateFinalizedAction

  • updateFinalizedAction(action): void

  • Updates the UI Entry representing the given finished action. If the action was in the list already marked as in-progress, it will be removed and a new one added instead. If no action was present before, a new entry will be added.

    Parameters

    Returns void

windowToScreenPosition

StaticclearActionsListFromMemory

  • clearActionsListFromMemory(): void

  • Clears the current content of the watchdog action list from memory.

    Returns void

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

StaticgetActionsHistory

Protected StaticisActionEntryEqual

  • isActionEntryEqual(left, right): boolean

  • Checks if the given two watchdog actions represents the same Entry in the list. If they represent the same actual user "action", but only changes its complete state, they should be represented in the same Entry in the list.

    Parameters

    Returns boolean

Protected StaticisActionRelevant

  • isActionRelevant(action): boolean

  • Checks if the given Watchdog Entry is from a type that should be processed by the window.

    Parameters

    Returns boolean

Protected StaticisActionUIRelevant

  • isActionUIRelevant(action): boolean

  • Checks if the given Watchdog Entry is from a type that should be displayed in the main List View. Some actions should not be presented to the user, use this to make sure an action should.

    Parameters

    Returns boolean

StaticloadActionsListFromDisk

  • loadActionsListFromDisk(): void

  • Loads the watchdog actions list from cache (if any).

    Returns void

Staticopen

StaticpersistWatchdogHistory

  • persistWatchdogHistory(): void

  • Saves the current watchdog actions list to disk.

    Returns void

StaticupdateWatchdogHistory

  • updateWatchdogHistory(): boolean

  • Updates the list with the latest actions.

    Returns boolean

    Whether or not new items were added to the list in this update.

Events

StaticonWatchdogActionAdded

onWatchdogActionAdded: Event<[WatchdogAction], void>

Gets called once a Watchdog Action is added to the history of actions list.

ReadonlyonFocusChangedInternal

onFocusChangedInternal: Event<[boolean], void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events