@finsemble/finsemble-ui 1.0.0-beta-1 → 1.0.0-beta-5

package/react/components/windowTitleBar/WindowTitleBarShell.d.ts

@@ -1,196 +0,0 @@
-/*!
- * Copyright 2017 by ChartIQ, Inc.
- * All rights reserved.
- */
-import * as React from "react";
-import "../../assets/css/windowTitleBar.css";
-import { StandardError } from "@finsemble/finsemble-api/types/types";
-import StoreModel from "@finsemble/finsemble-api/types/clients/StoreModel";
-import { TabProperties } from "../../types/windowTitleBar";
-declare type BumpElements = {
-    bumpBy: string;
-    fixed: string;
-    absolute: string;
-    monitorFixedAdditions: boolean;
-};
-interface WindowTitleBarShellProps {
-}
-interface WindowTitleBarShellState {
-    tabs: TabProperties[];
-    activeTab: TabProperties;
-    windowTitle: string;
-    initialized: boolean;
-    alwaysOnTop: boolean;
-    showTabs: boolean;
-    minButton: boolean;
-    maxButton: boolean;
-    closeButton: boolean;
-    showShareButton: boolean;
-    showLinkerButton: boolean;
-    isTopRight: boolean;
-    dockingEnabled: boolean;
-    alwaysOnTopButton: boolean;
-    allowDragOnCenterRegion: boolean;
-    dockingIcon: string;
-    hackScrollbar: boolean;
-    showDockingTooltip: boolean;
-    showTabRegion: boolean;
-    tabBarBoundingBox: any;
-    useDOMBasedMovement: boolean;
-    dragHandleName: string;
-    bumpElements: BumpElements;
-    adjustContentHeights: boolean;
-}
-export declare class WindowTitleBarShell extends React.Component<WindowTitleBarShellProps, WindowTitleBarShellState> {
-    store?: StoreModel;
-    isMousePressed: boolean;
-    constructor(props: WindowTitleBarShellProps);
-    alwaysOnTopListener({ data: { alwaysOnTop } }: any): void;
-    /**
-     * This is necessary to make sure that the `this` inside of the callback is correct.
-     *
-     * @memberof WindowTitleBar
-     */
-    bindCorrectContext(): void;
-    onInitialized(): void;
-    onStoreChange(): void;
-    componentDidMount(): void;
-    componentDidUpdate(): void;
-    componentWillUnmount(): void;
-    setDOMBasedMovement(err: StandardError, response: any): void;
-    /**
-     * When we are not tiling/tabbing, we want to allow the user to drag the window around via any available space in the tab-region. This function allows that.
-     */
-    allowDragOnCenterRegion(): void;
-    /**
-     * When we are tiling/tabbing, we do not want to allow any window to be dragged around and moved.
-     */
-    disallowDragOnCenterRegion(): void;
-    /**
-     * When tiling start, we want to find the dragHandler and hide it
-     */
-    onTilingStart(): void;
-    /**
-     * When tiling stops, we want to find the dragHandler and re-show it
-     */
-    onTilingStop(): void;
-    /**
-     * Called whenever a tab is dropped on a non tab area.
-     * It won't be called when dropped on a tab that handles handle the event.
-     */
-    onDropHandler(): void;
-    /**
-     * Called when user double clicks on drag handle
-     */
-    onDoubleClick(): void;
-    _setOnMouseUpAndDownHandlers(element: HTMLDivElement): void;
-    makeDragHandle(fsblHeader: Element, dragHandleCssClass: string): HTMLElement;
-    dragHandleBoundsForShowTabs(startingBounds: DOMRect): DOMRect;
-    /**
-     * The dragger is an absolutely positioned element that is superimposed on the actual area that we'd like to drag.
-     * This is necessary due to a bug in Chromium. Effectively, we need the dragger to change its left position and width
-     * to match the intended drag area. These dimensions can change whenever the header is re-rendered (for instance when
-     * changing mode from tabbing to non-tabbing). Dimensions can also change when the window itself is resized (due to natural
-     * css).
-     *
-     * Can remove all of the cq-drag and cq-no-drag because Chromium bug is fixed
-     * Remove fsbl-drag-region, it is no longer needed
-     * Hide the dragHandle during drop operations, so that it doesn't interfere
-     */
-    resizeDragHandle(): void;
-    /**
-     * Whether the component's config allows for the linker.
-     * @param {} err
-     * @param {*} response
-     */
-    showLinkerButton(err: StandardError, response: any): void;
-    /**
-     * Whether the window is the top-right-most window in a group of windows. If so, it renders a minimize icon for the whole group.
-     * @param {} err
-     * @param {*} response
-     */
-    isTopRight(err: StandardError, response: any): void;
-    /**
-     * @param {*} err
-     * @param {*} response
-     */
-    onTitleChange(err: StandardError, response: any): void;
-    /**
-     * The next few methods are store change handlers that sync local state with the store's state.
-     */
-    onShowDockingToolTip(err: StandardError, response: any): void;
-    onToggleDockingIcon(err: StandardError, response: any): void;
-    onDockingEnabledChanged(err: StandardError, response: any): void;
-    onAlwaysOnTopChanged(err: StandardError, response: any): void;
-    onStoreChanged(newState: WindowTitleBarShellState): void;
-    onShareEmitterChanged(err: StandardError, response: any): void;
-    onTabsChanged(err: StandardError, response: any): void;
-    onShowTabsChanged(err: StandardError, response: any): void;
-    hackScrollbar(): void;
-    beginAdjustment(): void;
-    /**
-     * Once document is ready and header is injected into DOM, begin adjusting the height of elements and bump fixed/absolute elements
-     */
-    maybeAdjustWindow(): Promise<void>;
-    /**
-     * Monitors the DOM for mutations, if the added node has a fixed position with a top style of 0px, it will be bumped by the title bar height.
-     * @param headerHeight the height of the header
-     */
-    monitorFixedPositionedElements(headerHeight: string): void;
-    /**
-     * Calls functions to bump fixed and/or absolute elements if configured to do so.
-     * @param {object} config bumpElements object
-     */
-    bumpElements(config: BumpElements): void;
-    /**
-     * Set the max height of each element to be the height of the parent container
-     * subtracted by the height of the previous element. This forces the element to either obey its
-     * predefined height or stay within the bounds of the max height.
-     * @param {object} elem HTML element
-     * @param {number} prev height of previous sibling
-     * @param maxHeight
-     */
-    private adjust;
-    /**
-     * Adjusts the top level content view height to be its height subtracted by the headerHeight and its
-     * maxHeight to be 100vh subtracted by the total height of the previous elements.
-     * The height of the previous elements are added to this calculation if they are not fixed or absolute.
-     * @param {number} headerHeight the height of the header
-     */
-    private adjustTopLevelHeight;
-    /**
-     * Adjusts the content view height to be maximum the parent container height subtracted by the total height elements above it.
-     * The height of the previous elements are added to this calculation if they are not fixed or absolute.
-     * @param {object} headerNode window titlebar
-     */
-    private adjustContentHeight;
-    /**
-     * Calculates value to bump element by. If 'all' return top style and header height, if '0Positioned' return header height
-     * @param type Whether all elements are being bumped by the header height and their top style or just header height
-     * @param topStyle Element top value
-     * @param bumpBy Value to bump element by
-     * @returns Top style for element
-     */
-    private calculateBumpValue;
-    /**
-     * Recursively traverse through the HTML document and return an array of the top level elements
-     * and elements with static parents
-     * @param {object} element The HTML element
-     * @param {array} acc accumulator
-     * @returns {array} array top level elements and elements with static parents
-     *
-     */
-    private traverseHtml;
-    /**
-     * Bumps elements with fixed positioning down by the configured amount.
-     * @private
-     */
-    private bumpFixedElements;
-    /**
-     * Bumps absolute positioned elements with static parents down by the configured amount.
-     * @private
-     */
-    private bumpAbsoluteElements;
-    render(): JSX.Element;
-}
-export {};