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

package/platform/services/window/Docking/dockableWindow.d.ts

@@ -0,0 +1,272 @@
+import DockableBox from "./dockableBox";
+import DockingCalculator from "./dockingCalculator";
+import FinsembleEvent from "../../../../common/events/FinsembleEvent";
+import { DockableMonitor } from "./dockableMonitor";
+import { MonitorInfoDetail } from "../../../../FEA";
+import { StandardCallback, StandardPromise } from "../../../../types";
+import { FSBLWindow } from "../types";
+import { DockingConfigOptions, DefaultDockingOptions, DockedDimensions, DockingBounds, Vertex, MonitorDockablePositions, BoxCoordinates, MoveRequest, DockingSimulatedEvent, SnappedObject } from "./types";
+export declare class DockableWindow extends DockableBox {
+    win: FSBLWindow;
+    canGroup: boolean;
+    name: string;
+    guid: string;
+    hasDashbarData: boolean;
+    opacity: number;
+    groupNames: string[];
+    snappedWindows: SnappedObject[];
+    calculator: DockingCalculator;
+    resizeThrottlePeriod: number;
+    changeTaskbarVisibilityQueue: Function;
+    lastBoundsAdjustment: number;
+    animate: Function;
+    shouldOffsetByMouse: boolean;
+    allowTiling: boolean;
+    allowTabbing: boolean;
+    canMinimize: boolean;
+    shouldShowTaskbarIcon: boolean;
+    isDockableComponent: boolean;
+    monitorDockablePositions: MonitorDockablePositions;
+    dockingOptions: DockingConfigOptions;
+    dockedPosition: number | undefined;
+    ignoreSnappingRequests: boolean;
+    dockedDimensions: DockedDimensions | null;
+    undockedPosition: DockedDimensions;
+    primaryMonitor?: MonitorInfoDetail;
+    isHidden: boolean;
+    dockedParams: DockingConfigOptions;
+    dockedHeight: number;
+    snappedEdge: string;
+    dockedMonitor?: DockableMonitor;
+    snappedMonitor?: DockableMonitor;
+    monitor: DockableMonitor;
+    onboundschanged: number;
+    previouslySnappedEdge?: boolean;
+    dockedBounds?: DockingBounds;
+    justDocked?: boolean;
+    vertices: Record<string, Vertex>;
+    groups: string[];
+    closeEventListener?: Function;
+    finished: boolean;
+    limits: any;
+    edges: any;
+    onGroupEdge: any;
+    justUndocked: boolean;
+    /**
+     * Creates DockableWindow instances.
+     */
+    static factory(win: FSBLWindow, bounds: BoxCoordinates, calculator: DockingCalculator): DockableWindow;
+    /**
+     * Do not construct DockableWindow directly. Use the factory
+     *
+     * @param {*} win Window object; WebWindow, ExternalWindow, etc.
+     * @param {bounds} bounds initial bounds for the window.
+     * @param {object} dependencies Dependency object that provides the calculator, System, and Logger.
+     * @param {DockingCalculator} dependencies.calculator
+     * @param {System} dependencies.System
+     * @param {Logger} dependencies.Logger
+     */
+    private constructor();
+    private setMonitorDockablePosition;
+    private computeDockingDefaults;
+    private setminMaxWidths;
+    private initialize;
+    private dockToMonitor;
+    private recallBounds;
+    private getLocValue;
+    private recallDockedPosition;
+    /**
+     * Returns turn if the current monitor dimensions are different from the previous monitor dimensions
+     * @param {array} previousMonitorData the previous monitor info (an array of monitors)
+     */
+    monitorChanged(previousMonitorData: MonitorInfoDetail[]): Promise<boolean>;
+    /**
+     * Returns turn if the toolber handle (i.e. what the user can grab to move toolbar) is visible on one of the current monitors (based on the toolbars current bounds
+     * @param {array} currentBounds the toolbars current bounds
+     */
+    isToolbarVisible(currentBounds: DockingBounds): Promise<boolean>;
+    /**
+     * Returns a string representation of the docked location
+     */
+    getDockedStringFromLocation(): string | null;
+    /**
+     * Function to respond to finWindow bounds-changed events. Currently we only respond to this event in some cases.
+     * Aero_key: Sets bounds after an aero snap action is initiated (windows key + arrow key). Only triggers if Aero is enabled.
+     * System_restored: Triggered when a window is restored from minimized outside of Finsemble. This code block should only be hit if the
+            monitor configuration has changed after a window is minimized and the window's old restore position would be partially off-monitor.
+            The OS does not change the bounds of minimized windows, so they only action we can take	is to force it on monitor.
+     * @param {object} e The event
+     */
+    onSystemMovedWindow(e: FinsembleEvent): void;
+    /**
+     * Builds default docking options for dockable windows
+     * @param {object} options Taken from the incoming config
+     * @return {object} The docking defaults
+     */
+    buildDefaultDockingOptions(options: DockingConfigOptions): DefaultDockingOptions;
+    /**
+     * Function to handle chain of events when a dockable component type is docked
+     *
+     * @param {object} monitor Information about the monitor the component was docked to
+     * @param {string} location A string containing the location to dock to: "TOP", "LEFT", "BOTTOM", and "RIGHT" are the acceptable values
+     */
+    dock(monitor: MonitorInfoDetail, oldBounds: DockingBounds, location: number): void;
+    /**
+     * Function to handle chain of events when a dockable component type is undocked
+     */
+    undock(isClosing?: boolean): void;
+    saveDockableData(): void;
+    /**
+     * @function {function name}
+     * @return {type} {description}
+     */
+    onBoundsChanged(): void;
+    hiddenUnclaimSpace(): void;
+    unhiddenClaimSpace(): void;
+    /**
+     * @function {function name}
+     * @param  {type} request  {description}
+     * @param  {type} callback {description}
+     * @return {type} {description}
+     */
+    onBoundsChanging(event: DockingSimulatedEvent | FinsembleEvent, cb?: () => void): Promise<void>;
+    setResizeThrottlePeriod(throttlePeriod: number): void;
+    restored(event: FinsembleEvent): Promise<void>;
+    maximized(): void;
+    /**
+     * This removes event listeners.
+     * I can't be entirely certain, but from my testing, it _appears_ that Electron isn't actually deleting these objects.
+     * If you close the window, then load the window with the same name, old listeners are still registered with your new window.
+     * So if you reload a workspace, and then try to move a window, you get weird scenarios where onBoundsChanging is called twice with different values (presumably for old eventlisteners).
+     * Removing the eventListeners on close seems to handle this.
+     */
+    removeEventListeners(): void;
+    /** ******************************************
+     *											*
+     *			Window Moving Methods			*
+     *											*
+     ******************************************* */
+    /**
+     * Hides taskbar icon for windows. This prevents them from being clobbered by aeroshake.
+     */
+    hideTaskbarIcon(): void;
+    /**
+     * This shows the taskbar icon for a given window.
+     */
+    showTaskbarIcon(showIcon?: boolean): void;
+    /**
+     * @function {function name}
+     * @return {type} {description}
+     */
+    disableFrame(): void;
+    setOpacity(params?: {
+        opacity: number;
+        persist?: boolean;
+    }): void;
+    /**
+     * Sets bounds for internal calculations.
+     */
+    setInternalBounds(bounds: DockingBounds): void;
+    /**
+     * @function {function name}
+     * @param  {type} bounds    {description}
+     * @param  {type} successCB {description}
+     * @param  {type} errCB     {description}
+     * @return {type} {description}
+     */
+    setBounds(bounds: DockingBounds, successCB?: StandardCallback): StandardPromise<void>;
+    /**
+     * @function {function name}
+     * @param  {type} left {description}
+     * @param  {type} top  {description}
+     * @return {type} {description}
+     */
+    moveTo(left: number, top: number): void;
+    /**
+     * @function {function name}
+     * @return {type} {description}
+     */
+    getGroupNames(): string[];
+    /**
+     * @function {function name}
+     * @param  {type} request  {description}
+     * @param  {type} callback {description}
+     * @return {type} {description}
+     */
+    requestBoundsChange(request: MoveRequest, callback: () => void): void;
+    /** ******************************************
+     *											*
+     *			Helper Functions				*
+     *											*
+     ******************************************* */
+    /**
+     * @function {function name}
+     * @return {type} {description}
+     */
+    calculateInnerBoundingBox(): {
+        min: {
+            x: number;
+            y: number;
+        };
+        max: {
+            x: number;
+            y: number;
+        };
+    };
+    getInnerBoundingBox(): import("./types").BoundingBox;
+    /**
+     * @function {function name}
+     * @param  {type} bufferSize {description}
+     * @return {type} {description}
+     */
+    setBufferSize(bufferSize: number): void;
+    /**
+     * @function {function name}
+     * @return {type} {description}
+     */
+    setBoundingBoxes(): void;
+    getSnappingRegions(): import("./types").SnappingRegions;
+    updateState(): void;
+    /**
+     * @function setHidden
+     * @param  {function=} callback when done
+     *
+     * Sets the internal state to hidden.  Only needed if window is hidden outside of this class.
+     */
+    setHidden(): void;
+    /**
+     * @function setHidden
+     * @param  {function=} callback when done
+     *
+     * Sets the internal state to shown (i.e. not hidden). Only needed if window is hidden outside of this class.
+     */
+    setShown(): void;
+    hide(cb?: StandardCallback): void;
+    show(cb?: StandardCallback): void;
+    maximize(cb?: StandardCallback): void;
+    minimize(cb?: StandardCallback): void;
+    restore(cb?: StandardCallback): void;
+    alwaysOnTop(isAlwaysOnTop: boolean): void;
+    /**
+     * Returns the present alwaysOnTop status of the window.
+     *
+     * NOTE: This only reflects Finsemble's internal representation
+     * of the alwaysOnTop status, not the container/OS. When changing the status,
+     * Finsemble's status changes before the underlying container, causing them
+     * to briefly become out of sync.
+     */
+    isAlwaysOnTop(): boolean;
+    bringToFront(): void;
+    notifyWindowTitleBarOfGroupMembership(): void;
+    notifyWindowTitleBarOfGroupEjection(): void;
+    addSnappedWindow(snapObj: SnappedObject): void;
+    removeSnappedWindow(name: string): void;
+    animatePositionAndHeight(params: DockingBounds, cb: StandardCallback): void;
+    isGrouped(): boolean;
+    /**
+     * Adds eventListeners so that when the finWIndow moves, we can do things with that data.
+     */
+    addListeners(): void;
+}
+export default DockableWindow;
+//# sourceMappingURL=dockableWindow.d.ts.map

package/platform/services/window/Docking/dockableWindow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dockableWindow.d.ts","sourceRoot":"","sources":["../../../../../../src/platform/services/window/Docking/dockableWindow.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAMpD,OAAO,cAAc,MAAM,0CAA0C,CAAC;AAGtE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EACN,oBAAoB,EACpB,qBAAqB,EAErB,gBAAgB,EAChB,aAAa,EACb,MAAM,EACN,wBAAwB,EACxB,cAAc,EACd,WAAW,EACX,qBAAqB,EACrB,aAAa,EACb,MAAM,SAAS,CAAC;AAqCjB,qBAAa,cAAe,SAAQ,WAAW;IAC9C,GAAG,EAAE,UAAU,CAAC;IAEhB,QAAQ,EAAE,OAAO,CAAC;IAElB,IAAI,EAAE,MAAM,CAAC;IAEb,IAAI,EAAE,MAAM,CAAC;IAEb,cAAc,EAAE,OAAO,CAAC;IAExB,OAAO,EAAE,MAAM,CAAC;IAEhB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,cAAc,EAAE,aAAa,EAAE,CAAM;IAErC,UAAU,EAAE,iBAAiB,CAAC;IAE9B,oBAAoB,EAAE,MAAM,CAAK;IAEjC,4BAA4B,EAAE,QAAQ,CAAC;IAEvC,oBAAoB,EAAE,MAAM,CAAc;IAE1C,OAAO,EAAE,QAAQ,CAAC;IAGlB,mBAAmB,EAAE,OAAO,CAAS;IAErC,WAAW,EAAE,OAAO,CAAC;IAErB,YAAY,EAAE,OAAO,CAAC;IAEtB,WAAW,EAAE,OAAO,CAAC;IAErB,qBAAqB,EAAE,OAAO,CAAC;IAE/B,mBAAmB,EAAE,OAAO,CAAS;IAErC,wBAAwB,EAAE,wBAAwB,CAAM;IAExD,cAAc,EAAE,oBAAoB,CAAC;IAErC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC,sBAAsB,EAAE,OAAO,CAAS;IAExC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IAEjD,gBAAgB,EAAG,gBAAgB,CAAC;IAEpC,cAAc,CAAC,EAAE,iBAAiB,CAAC;IAEnC,QAAQ,EAAE,OAAO,CAAS;IAE1B,YAAY,EAAG,oBAAoB,CAAC;IAEpC,YAAY,EAAG,MAAM,CAAC;IAEtB,WAAW,EAAG,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,eAAe,CAAC;IAEhC,cAAc,CAAC,EAAE,eAAe,CAAC;IAEjC,OAAO,EAAE,eAAe,CAAC;IAEzB,eAAe,EAAE,MAAM,CAAK;IAE5B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,QAAQ,EAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAElC,MAAM,EAAG,MAAM,EAAE,CAAC;IAElB,kBAAkB,CAAC,EAAE,QAAQ,CAAC;IAE9B,QAAQ,EAAG,OAAO,CAAC;IAEnB,MAAM,EAAE,GAAG,CAAC;IAEZ,KAAK,EAAE,GAAG,CAAC;IAEX,WAAW,EAAE,GAAG,CAAC;IAEjB,YAAY,EAAG,OAAO,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,iBAAiB,GAAG,cAAc;IAMtG;;;;;;;;;OASG;IACH,OAAO;IA8DP,OAAO,CAAC,0BAA0B;IAwBlC,OAAO,CAAC,sBAAsB;IAwC9B,OAAO,CAAC,eAAe;YAST,UAAU;YAoDV,aAAa;YAgCb,YAAY;IAgC1B,OAAO,CAAC,WAAW;YA0DL,oBAAoB;IAkElC;;;OAGG;IACG,cAAc,CAAC,mBAAmB,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA2BhF;;;OAGG;IACH,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAoDhE;;OAEG;IACH,2BAA2B,IAAI,MAAM,GAAG,IAAI;IAY5C;;;;;;;OAOG;IACH,mBAAmB,CAAC,CAAC,EAAE,cAAc;IA0DrC;;;;OAIG;IACH,0BAA0B,CAAC,OAAO,EAAE,oBAAoB,GAAG,qBAAqB;IAoBhF;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM;IAiC3E;;OAEG;IACH,MAAM,CAAC,SAAS,GAAE,OAAe;IAWjC,gBAAgB;IA2ChB;;;OAGG;IACH,eAAe;IAmBf,kBAAkB;IAOlB,kBAAkB;IAqDlB;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,cAAc,EAAE,EAAE,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA6GrG,uBAAuB,CAAC,cAAc,EAAE,MAAM;IAIxC,QAAQ,CAAC,KAAK,EAAE,cAAc;IA+BpC,SAAS;IAqBT;;;;;;OAMG;IACH,oBAAoB;IAapB;;;;mDAI+C;IAE/C;;OAEG;IACH,eAAe;IAiBf;;OAEG;IACH,eAAe,CAAC,QAAQ,GAAE,OAAoC;IAe9D;;;OAGG;IACH,YAAY;IASZ,UAAU,CAAC,MAAM,GAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAmC;IAU1F;;OAEG;IACH,iBAAiB,CAAC,MAAM,EAAE,aAAa;IAWvC;;;;;;OAMG;IACG,SAAS,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC;IAsB3F;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAWhC;;;OAGG;IACH,aAAa,IAAI,MAAM,EAAE;IAIzB;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI;IA6B9D;;;;mDAI+C;IAE/C;;;OAGG;IACH,yBAAyB;;;;;;;;;;IAczB,mBAAmB;IAInB;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM;IAKhC;;;OAGG;IACH,gBAAgB;IAShB,kBAAkB;IAIlB,WAAW;IAMX;;;;;OAKG;IACH,SAAS;IAKT;;;;;OAKG;IACH,QAAQ;IAKR,IAAI,CAAC,EAAE,GAAE,gBAAuC;IAIhD,IAAI,CAAC,EAAE,GAAE,gBAAuC;IAIhD,QAAQ,CAAC,EAAE,GAAE,gBAAuC;IAIpD,QAAQ,CAAC,EAAE,GAAE,gBAAuC;IAIpD,OAAO,CAAC,EAAE,GAAE,gBAAuC;IAInD,WAAW,CAAC,aAAa,EAAE,OAAO;IAQlC;;;;;;;OAOG;IACH,aAAa,IAAI,OAAO;IAIxB,YAAY;IAQZ,qCAAqC;IAQrC,mCAAmC;IAQnC,gBAAgB,CAAC,OAAO,EAAE,aAAa;IAkBvC,mBAAmB,CAAC,IAAI,EAAE,MAAM;IAahC,wBAAwB,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE,EAAE,gBAAgB;IAQpE,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,YAAY;CASZ;AACD,eAAe,cAAc,CAAC"}