@finsemble/finsemble-ui 8.0.2 → 8.1.0-beta.2

package/platform/services/window/WindowAbstractions/stackedWindowWrapper.d.ts

@@ -0,0 +1,194 @@
+import { BaseWindow } from "./BaseWindow";
+import { WindowIdentifier } from "../types";
+import { StandardErrorCallback, StandardPromise } from "../../../../types";
+declare class StackedWindow extends BaseWindow {
+    params: any;
+    _listeners: object;
+    identifier: WindowIdentifier;
+    alwaysOnTop: boolean;
+    constructor(params: any);
+    removeListeners(): void;
+    _setResizable(): void;
+    addListeners(): void;
+    _addEventListener(params: any, handler?: Function): void;
+    addEventListener(event: any, handler?: Function): void;
+    _removeEventListener(params: any, handler?: Function): void;
+    removeEventListener(event: any, handler?: Function): void;
+    eventChannelName(channelTopic: any): string;
+    bindAllFunctions(): void;
+    listenForBoundsChanging(): void;
+    /**
+     * Handles common housekeeping checks and modifications on params at the beginning of each private window function
+     *
+     * @param {string} methodName method name (e.g. "minimize", "maximize")
+     * @param {object} params
+     * @memberof StackedWindow
+     * @private
+     */
+    _privatePreface<T = any>(methodName: string, params: T): T & {
+        stackedWindowIdentifier: WindowIdentifier;
+        doNotTransmitEvent?: boolean;
+    };
+    _minimize(params: any, callback?: Function): Promise<unknown>;
+    _maximize(params: any, callback?: Function): Promise<unknown>;
+    _restore(params: any, cb?: StandardErrorCallback<{
+        shouldContinue: boolean;
+    }>): StandardPromise<{
+        shouldContinue: boolean;
+    }>;
+    _focus(params: {
+        stackedWindowIdentifier: {
+            windowName: string | number;
+        };
+        windowIdentifier: {
+            windowName: string | number;
+        };
+        invokedByParent: boolean;
+    }, callback?: Function): Promise<unknown>;
+    _bringToFront(params: any, callback?: Function): Promise<unknown>;
+    _saveWindowOptions(params: any, callback?: Function): Promise<unknown>;
+    _setBounds(params: any, callback?: Function): Promise<unknown>;
+    _getBoundsFromSystem(params: any, callback?: Function): Promise<unknown>;
+    _getBounds(params: {
+        invokedByParent?: any;
+        windowIdentifier?: any;
+    }, cb?: StandardErrorCallback<any>): StandardPromise<any>;
+    /**
+     * Is Window Visible?
+     * @param {*} params Currently unused
+     * @param {*} callback returns true in response if showing, false otherwise
+     */
+    _isShowing(params: any, callback?: Function): Promise<unknown>;
+    _updateOptions(params: any, callback?: Function): Promise<unknown>;
+    _hide(params: any, callback?: Function): Promise<unknown>;
+    _show(params: {
+        invokedByParent?: boolean;
+        windowIdentifier: WindowIdentifier;
+        shouldMaximize?: boolean;
+        shouldRestore?: boolean;
+        saveState?: boolean;
+        switchedMonitors?: boolean;
+    }, cb?: StandardErrorCallback<{
+        shouldContinue: boolean;
+    }>): StandardPromise<{
+        shouldContinue: boolean;
+    }>;
+    _showAt(params: any, callback?: Function): Promise<unknown>;
+    _close(params?: {
+        fromSystem?: any;
+        removeFromWorkspace?: any;
+        stackedWindowIdentifier?: any;
+        invokedByParent?: any;
+        ignoreParent?: any;
+        windowIdentifier?: any;
+        noDocking?: any;
+        force?: boolean;
+    }, cb?: StandardErrorCallback<{
+        shouldContinue: boolean;
+    }>): StandardPromise<{
+        shouldContinue: boolean;
+    }>;
+    _alwaysOnTop(params: any, callback?: Function): Promise<unknown>;
+    /**
+     *
+     * Returns true if the window is always on top. False otherwise.
+     *
+     * Disable eslint below because params is undefined, but we don't want to refactor the other calls to expect the 1st param to equal the callback.
+     */
+    _isAlwaysOnTop(params?: {}, callback?: Function): boolean;
+    _setOpacity(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Handles common housekeeping checks and modifications on params at the beginning of each private window-management function
+     *
+     * @param {string} methodName method name (e.g. "minimize", "maximize")
+     * @param {object} params
+     * @memberof StackedWindow
+     * @private
+     */
+    _privateManagementPreface(methodName: any, params: any): any;
+    /**
+     * Temporary function until more cleanup done. Handles common housekeeping checks and modifications on params at the beginning of each private window-management function
+     *
+     * @param {string} methodName method name (e.g. "minimize", "maximize")
+     * @param {object} params
+     * @memberof StackedWindow
+     * @private
+     */
+    _newPrivateManagementPreface(methodName: any, params: any): any;
+    _removeWindow(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Adds window as a child to a stacked window.  Adds to the top of the stack, or if specified to a specific location in the stack;
+     *
+     * @param {object=} params
+     * @param {object} params.stackedWindowIdentifier stacked window to operate on stacked window to operate on
+     * @param {object} params.windowIdentifier window to add
+     * @param {number=} params.position the location in the stack to push the window.  Location 0 is the bottom of the stack. Defaults to the top of stack.
+     * @param {boolean=} params.noSave if true then don't save the store after updating it (will be saved by caller)
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    addWindow(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Removes a child window from a stacked window.  If removed window was visible, then the bottom child window (position 0) in stack will be made visible.
+     *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+     * @param {object} params.windowIdentifier window to remove
+     * @param {boolean=} params.noDocking if true then do not register removed window with docking (the workspace is unaffected)
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    removeWindow(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Removes a window from the stack then closes it.  If removed window was visible, then the bottom child window (position 0) in stack will be made visible.
+     *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+     * @param {object} params.windowIdentifier window to delete
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    deleteWindow(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Sets the visible window within the stack.  The previously visible window in stack will be automatically hidden.
+     *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+     * @param {object} params.windowIdentifier
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    setVisibleWindow(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Reorders the stack, but odes not affect visibility
+     *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+     * @param {array} params.windowIdentifiers array of windowIdentifiers which provides the new order
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    reorder(params: any, callback?: Function): Promise<unknown>;
+    /**
+     * Reorders the stack, but odes not affect visibility
+     *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+     * @param {array} params.windowIdentifiers array of windowIdentifiers which provides the new order
+     * @param {function=} callback function(err)
+     * @memberof StackedWindow
+     */
+    stopMove(params?: {}, callback?: Function): Promise<unknown>;
+    /**
+ * Reorders the stack, but odes not affect visibility
+ *
+     * @param {object} params
+.	 * @param {object} params.stackedWindowIdentifier stacked window to operate on
+ * @param {array} params.windowIdentifiers array of windowIdentifiers which provides the new order
+ * @param {function=} callback function(err)
+ * @memberof StackedWindow
+ */
+    startMove(params?: {}, callback?: Function): Promise<unknown>;
+}
+export default StackedWindow;
+//# sourceMappingURL=stackedWindowWrapper.d.ts.map

package/platform/services/window/WindowAbstractions/stackedWindowWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stackedWindowWrapper.d.ts","sourceRoot":"","sources":["../../../../../../src/platform/services/window/WindowAbstractions/stackedWindowWrapper.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE3E,cAAM,aAAc,SAAQ,UAAU;IACrC,MAAM,EAAE,GAAG,CAAC;IAEZ,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAG,gBAAgB,CAAC;IAE9B,WAAW,EAAG,OAAO,CAAC;gBAEV,MAAM,KAAA;IASlB,eAAe;IAIf,aAAa;IAIb,YAAY;IAwBZ,iBAAiB,CAAC,MAAM,KAAA,EAAE,OAAO,WAAqB;IAKtD,gBAAgB,CAAC,KAAK,KAAA,EAAE,OAAO,WAAqB;IAKpD,oBAAoB,CAAC,MAAM,KAAA,EAAE,OAAO,WAAqB;IAKzD,mBAAmB,CAAC,KAAK,KAAA,EAAE,OAAO,WAAqB;IAKvD,gBAAgB,CAAC,YAAY,KAAA;IAI7B,gBAAgB;IAUhB,uBAAuB;IAkBvB;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EACtB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,GACP,CAAC,GAAG;QACN,uBAAuB,EAAE,gBAAgB,CAAC;QAC1C,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC7B;IA8BD,SAAS,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAmB/C,SAAS,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAyBzC,QAAQ,CACb,MAAM,KAAA,EACN,EAAE,CAAC,EAAE,qBAAqB,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC,GACrD,eAAe,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC;IA6B/C,MAAM,CACL,MAAM,EAAE;QACP,uBAAuB,EAAE;YAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QACzD,gBAAgB,EAAE;YAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAClD,eAAe,EAAE,OAAO,CAAC;KACzB,EACD,QAAQ,WAAqB;IAqB9B,aAAa,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBnD,kBAAkB,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IA+BxD,UAAU,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBhD,oBAAoB,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoB1D,UAAU,CACT,MAAM,EAAE;QAAE,eAAe,CAAC,EAAE,GAAG,CAAC;QAAC,gBAAgB,CAAC,EAAE,GAAG,CAAA;KAAE,EACzD,EAAE,CAAC,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAC7B,eAAe,CAAC,GAAG,CAAC;IAoBvB;;;;OAIG;IACH,UAAU,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBhD,cAAc,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBpD,KAAK,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBrC,KAAK,CACV,MAAM,EAAE;QACP,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC3B,EACD,EAAE,CAAC,EAAE,qBAAqB,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC,GACrD,eAAe,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC;IAc/C,OAAO,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAY7C,MAAM,CACL,MAAM,GAAE;QACP,UAAU,CAAC,EAAE,GAAG,CAAC;QACjB,mBAAmB,CAAC,EAAE,GAAG,CAAC;QAC1B,uBAAuB,CAAC,EAAE,GAAG,CAAC;QAC9B,eAAe,CAAC,EAAE,GAAG,CAAC;QACtB,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,gBAAgB,CAAC,EAAE,GAAG,CAAC;QACvB,SAAS,CAAC,EAAE,GAAG,CAAC;QAChB,KAAK,CAAC,EAAE,OAAO,CAAC;KACX,EACN,EAAE,CAAC,EAAE,qBAAqB,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC,GACrD,eAAe,CAAC;QAAE,cAAc,EAAE,OAAO,CAAA;KAAE,CAAC;IAwB/C,YAAY,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAoBlD;;;;;OAKG;IACH,cAAc,CAAC,MAAM,KAAK,EAAE,QAAQ,WAAqB;IAOzD,WAAW,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAgCjD;;;;;;;OAOG;IACH,yBAAyB,CAAC,UAAU,KAAA,EAAE,MAAM,KAAA;IAc5C;;;;;;;OAOG;IACH,4BAA4B,CAAC,UAAU,KAAA,EAAE,MAAM,KAAA;IAoB/C,aAAa,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAanD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAa/C;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAalD;;;;;;;;OAQG;IACH,YAAY,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAalD;;;;;;;;OAQG;IACH,gBAAgB,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAatD;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,KAAA,EAAE,QAAQ,WAAqB;IAa7C;;;;;;;;OAQG;IACH,QAAQ,CAAC,MAAM,KAAK,EAAE,QAAQ,WAAqB;IAanD;;;;;;;;GAQE;IACF,SAAS,CAAC,MAAM,KAAK,EAAE,QAAQ,WAAqB;CAYpD;AAED,eAAe,aAAa,CAAC"}