igniteui-webcomponents-layouts 7.1.1-beta.2 → 7.1.1-beta.3

package/esm2022/lib/igc-tool-panel-component.d.ts

@@ -0,0 +1,471 @@
+import { IgSize } from "igniteui-webcomponents-core";
+import { ToolPanel } from "./ToolPanel";
+import { BaseControlTheme } from "igniteui-webcomponents-core";
+import { ControlDisplayDensity } from "igniteui-webcomponents-core";
+import { IgcHTMLElement } from "igniteui-webcomponents-core";
+import { ToolPanelOrientation } from './ToolPanelOrientation';
+import { IgcToolActionComponent } from "./igc-tool-action-component";
+import { IgcToolActionCollection } from "./igc-tool-action-collection";
+import { IgcToolPanelContentRefreshedEventArgs } from "./igc-tool-panel-content-refreshed-event-args";
+import { IgcToolCommandEventArgs } from './igc-tool-command-event-args';
+import { NestedActionMode } from './NestedActionMode';
+import { ScrollbarStyle } from "igniteui-webcomponents-core";
+export declare class IgcToolPanelComponent extends IgcHTMLElement {
+    private _implementation;
+    private _height;
+    private _width;
+    set height(value: string);
+    get height(): string;
+    set width(value: string);
+    get width(): string;
+    private ensureStretch;
+    private _webComponentWrapper;
+    private _webComponentRenderer;
+    private _portalManager;
+    contentActions: IgcToolActionComponent[];
+    /**
+    * The actions actually present in the editor. Do not directly modify this array.
+    * This array's contents can be modified by using the actions property or providing child content.
+    */
+    actualActions: IgcToolActionComponent[];
+    private _actions;
+    private _actionsAdapter;
+    /**
+     * A collection of manually added actions for the editor.
+    */
+    get actions(): IgcToolActionCollection;
+    constructor();
+    updateStyle(): void;
+    destroy(): void;
+    private updateContentProperties;
+    protected createImplementation(): ToolPanel;
+    get i(): ToolPanel;
+    private _disconnected;
+    disconnectedCallback(): void;
+    connectedCallback(): void;
+    afterContentInit(): void;
+    private _settingAttributes;
+    protected _attached: boolean;
+    private _queuedSetAttributes;
+    protected _enqueueSetAttribute(attrName: string, attrValue: string): void;
+    protected _flushQueuedAttributes(): void;
+    protected _a(attrName: string, attrValue: any): void;
+    private static _observedAttributesIgcToolPanelComponent;
+    static get observedAttributes(): string[];
+    private _updatingFromAttribute;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+    static htmlTagName: string;
+    protected static _isElementRegistered: boolean;
+    static register(): void;
+    /**
+ * Gets or sets if the tool actions should display their submenus on mouse hover.
+*/
+    get showOnHover(): boolean;
+    set showOnHover(v: boolean);
+    /**
+     * Gets or sets if the tool action icon buttons should display their tooltips on mouse hover.
+    */
+    get showTooltipOnHover(): boolean;
+    set showTooltipOnHover(v: boolean);
+    /**
+     * Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was
+     * executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will
+     * always keep the dropdown open during a hover open and will require an extra click to close.
+    */
+    get dropdownClickBuffer(): number;
+    set dropdownClickBuffer(v: number);
+    /**
+     * Prevents clicks on the tool actions from bubbling.
+    */
+    get stopPropagation(): boolean;
+    set stopPropagation(v: boolean);
+    /**
+     * Gets or sets the text style for the panel.
+    */
+    get cellTextStyle(): string;
+    set cellTextStyle(v: string);
+    /**
+     * Gets or sets the subtitle text style for the panel.
+    */
+    get subtitleTextStyle(): string;
+    set subtitleTextStyle(v: string);
+    /**
+     * Gets or sets the text style.
+    */
+    get groupHeaderTextStyle(): string;
+    set groupHeaderTextStyle(v: string);
+    /**
+     * Gets or sets the base built in theme to use for the checkbox.
+    */
+    get baseTheme(): BaseControlTheme;
+    set baseTheme(v: BaseControlTheme);
+    /**
+     * Gets or sets the display density to use for the toolbar.
+    */
+    get density(): ControlDisplayDensity;
+    set density(v: ControlDisplayDensity);
+    /**
+     * Gets the resolved display density to use for the toolbar.
+    */
+    get actualDensity(): ControlDisplayDensity;
+    set actualDensity(v: ControlDisplayDensity);
+    /**
+     * Gets or sets the color to use for the background of the component.
+    */
+    get backgroundColor(): string;
+    set backgroundColor(v: string);
+    get actualBackgroundColor(): string;
+    set actualBackgroundColor(v: string);
+    /**
+     * Gets or sets the background color for submenus.
+    */
+    get submenuBackgroundColor(): string;
+    set submenuBackgroundColor(v: string);
+    get actualSubmenuBackgroundColor(): string;
+    set actualSubmenuBackgroundColor(v: string);
+    /**
+     * Gets or sets the group header background color.
+    */
+    get groupHeaderBackgroundColor(): string;
+    set groupHeaderBackgroundColor(v: string);
+    get actualGroupHeaderBackgroundColor(): string;
+    set actualGroupHeaderBackgroundColor(v: string);
+    /**
+     * Gets or sets the separator background color.
+    */
+    get separatorBackgroundColor(): string;
+    set separatorBackgroundColor(v: string);
+    get actualSeparatorBackgroundColor(): string;
+    set actualSeparatorBackgroundColor(v: string);
+    /**
+     * Gets or sets the group header separator background color.
+    */
+    get groupHeaderSeparatorBackgroundColor(): string;
+    set groupHeaderSeparatorBackgroundColor(v: string);
+    get actualGroupHeaderSeparatorBackgroundColor(): string;
+    set actualGroupHeaderSeparatorBackgroundColor(v: string);
+    /**
+     * Gets or sets the hover background color.
+    */
+    get hoverBackgroundColor(): string;
+    set hoverBackgroundColor(v: string);
+    get actualHoverBackgroundColor(): string;
+    set actualHoverBackgroundColor(v: string);
+    /**
+     * Gets or sets the color to use for the text of the component.
+    */
+    get textColor(): string;
+    set textColor(v: string);
+    get actualTextColor(): string;
+    set actualTextColor(v: string);
+    get actualSubtitleTextColor(): string;
+    set actualSubtitleTextColor(v: string);
+    /**
+     * Gets or sets the color to use for the subtitle of the component.
+    */
+    get subtitleTextColor(): string;
+    set subtitleTextColor(v: string);
+    /**
+     * Gets or sets the color to use for the text in disabled tool actions.
+    */
+    get disabledTextColor(): string;
+    set disabledTextColor(v: string);
+    get actualDisabledTextColor(): string;
+    set actualDisabledTextColor(v: string);
+    /**
+     * Gets or sets the text color for group header tool actions.
+    */
+    get groupHeaderTextColor(): string;
+    set groupHeaderTextColor(v: string);
+    get actualGroupHeaderTextColor(): string;
+    set actualGroupHeaderTextColor(v: string);
+    /**
+     * Gets or sets the text color for group header subtitle.
+    */
+    get groupHeaderSubtitleTextColor(): string;
+    set groupHeaderSubtitleTextColor(v: string);
+    get actualGroupHeaderSubtitleTextColor(): string;
+    set actualGroupHeaderSubtitleTextColor(v: string);
+    /**
+     * Gets or sets the tooltip text color.
+    */
+    get toolTipTextColor(): string;
+    set toolTipTextColor(v: string);
+    get actualToolTipTextColor(): string;
+    set actualToolTipTextColor(v: string);
+    /**
+     * Gets or sets the tooltip background color.
+    */
+    get toolTipBackgroundColor(): string;
+    set toolTipBackgroundColor(v: string);
+    /**
+     * Gets the actual tooltip background color.
+    */
+    get actualToolTipBackgroundColor(): string;
+    set actualToolTipBackgroundColor(v: string);
+    /**
+     * Gets or sets the tooltip corner radius.
+    */
+    get toolTipCornerRadius(): number;
+    set toolTipCornerRadius(v: number);
+    /**
+     * Gets the actual tooltip corner radius.
+    */
+    get actualToolTipCornerRadius(): number;
+    set actualToolTipCornerRadius(v: number);
+    /**
+     * Gets or sets the shadow elevation for the tooltip.
+    */
+    get toolTipElevation(): number;
+    set toolTipElevation(v: number);
+    /**
+     * Gets the actual shadow elevation used by the tooltip.
+    */
+    get actualToolTipElevation(): number;
+    set actualToolTipElevation(v: number);
+    /**
+     * Gets or sets the fill color of icons in the ToolPanel.
+    */
+    get iconFill(): string;
+    set iconFill(v: string);
+    /**
+     * Gets the actual icon fill color.
+    */
+    get actualIconFill(): string;
+    set actualIconFill(v: string);
+    /**
+     * Gets or sets the stroke color of icons in the ToolPanel.
+    */
+    get iconStroke(): string;
+    set iconStroke(v: string);
+    /**
+     * Gets the actual icon stroke color.
+    */
+    get actualIconStroke(): string;
+    set actualIconStroke(v: string);
+    /**
+     * Gets or sets the left padding for separators in the vertical orientation.
+    */
+    get separatorVerticalPaddingLeft(): number;
+    set separatorVerticalPaddingLeft(v: number);
+    get actualSeparatorVerticalPaddingLeft(): number;
+    set actualSeparatorVerticalPaddingLeft(v: number);
+    /**
+     * Gets or sets the right padding for separators in the vertical orientation.
+    */
+    get separatorVerticalPaddingRight(): number;
+    set separatorVerticalPaddingRight(v: number);
+    get actualSeparatorVerticalPaddingRight(): number;
+    set actualSeparatorVerticalPaddingRight(v: number);
+    /**
+     * Gets or sets the top padding for separators in the vertical orientation.
+    */
+    get separatorVerticalPaddingTop(): number;
+    set separatorVerticalPaddingTop(v: number);
+    get actualSeparatorVerticalPaddingTop(): number;
+    set actualSeparatorVerticalPaddingTop(v: number);
+    /**
+     * Gets or sets the bottom padding for separators in the vertical orientation.
+    */
+    get separatorVerticalPaddingBottom(): number;
+    set separatorVerticalPaddingBottom(v: number);
+    get actualSeparatorVerticalPaddingBottom(): number;
+    set actualSeparatorVerticalPaddingBottom(v: number);
+    /**
+     * Gets or sets the left padding for separators in the horizontal orientation.
+    */
+    get separatorHorizontalPaddingLeft(): number;
+    set separatorHorizontalPaddingLeft(v: number);
+    get actualSeparatorHorizontalPaddingLeft(): number;
+    set actualSeparatorHorizontalPaddingLeft(v: number);
+    /**
+     * Gets or sets the right padding for separators in the horizontal orientation.
+    */
+    get separatorHorizontalPaddingRight(): number;
+    set separatorHorizontalPaddingRight(v: number);
+    get actualSeparatorHorizontalPaddingRight(): number;
+    set actualSeparatorHorizontalPaddingRight(v: number);
+    /**
+     * Gets or sets the top padding for separators in the horizontal orientation.
+    */
+    get separatorHorizontalPaddingTop(): number;
+    set separatorHorizontalPaddingTop(v: number);
+    get actualSeparatorHorizontalPaddingTop(): number;
+    set actualSeparatorHorizontalPaddingTop(v: number);
+    /**
+     * Gets or sets the bottom padding for separators in the horizontal orientation.
+    */
+    get separatorHorizontalPaddingBottom(): number;
+    set separatorHorizontalPaddingBottom(v: number);
+    get actualSeparatorHorizontalPaddingBottom(): number;
+    set actualSeparatorHorizontalPaddingBottom(v: number);
+    /**
+     * Gets or sets the color to use for the background of the component.
+    */
+    get orientation(): ToolPanelOrientation;
+    set orientation(v: ToolPanelOrientation);
+    /**
+     * Gets or sets the row height for the panel.
+    */
+    get rowHeight(): number;
+    set rowHeight(v: number);
+    /**
+     * Gets the actual row height used by the panel.
+    */
+    get actualRowHeight(): number;
+    /**
+     * Gets or sets the height to use for the sub panel rows if different than default.
+    */
+    get subPanelRowHeight(): number;
+    set subPanelRowHeight(v: number);
+    get highlightWidth(): number;
+    set highlightWidth(v: number);
+    get actualHighlightWidth(): number;
+    set actualHighlightWidth(v: number);
+    get highlightRadius(): number;
+    set highlightRadius(v: number);
+    get actualHighlightRadius(): number;
+    set actualHighlightRadius(v: number);
+    get highlightColor(): string;
+    set highlightColor(v: string);
+    get actualHighlightColor(): string;
+    set actualHighlightColor(v: string);
+    get actualAccentColor(): string;
+    set actualAccentColor(v: string);
+    get accentColor(): string;
+    set accentColor(v: string);
+    /**
+     * Gets or sets the stroke color for all icon menu dropdown arrows.
+    */
+    get menuArrowStroke(): string;
+    set menuArrowStroke(v: string);
+    /**
+     * Gets the actual stroke color for all icon menu dropdown arrows.
+    */
+    get actualMenuArrowStroke(): string;
+    set actualMenuArrowStroke(v: string);
+    /**
+     * Gets or sets the background color of the radio when in the unchecked state.
+    */
+    get uncheckedBackgroundColor(): string;
+    set uncheckedBackgroundColor(v: string);
+    /**
+     * Gets the actual background color of the radio when in the unchecked state.
+    */
+    get actualUncheckedBackgroundColor(): string;
+    set actualUncheckedBackgroundColor(v: string);
+    /**
+     * Gets or sets the background color of the radio when in the checked state.
+    */
+    get checkedBackgroundColor(): string;
+    set checkedBackgroundColor(v: string);
+    /**
+     * Gets the actual background color of the radio when in the checked state.
+    */
+    get actualCheckedBackgroundColor(): string;
+    set actualCheckedBackgroundColor(v: string);
+    /**
+     * Gets or sets the border color of the radio when in the unchecked state.
+    */
+    get uncheckedBorderColor(): string;
+    set uncheckedBorderColor(v: string);
+    /**
+     * Gets the actual border color of the radio when in the unchecked state.
+    */
+    get actualUncheckedBorderColor(): string;
+    set actualUncheckedBorderColor(v: string);
+    /**
+     * Gets or sets the border color of the radio when in the checked state.
+    */
+    get checkedBorderColor(): string;
+    set checkedBorderColor(v: string);
+    /**
+     * Gets the actual border color of the radio when in the checked state.
+    */
+    get actualCheckedBorderColor(): string;
+    set actualCheckedBorderColor(v: string);
+    /**
+     * Gets or sets the dropdown delay time in milliseconds.
+    */
+    get dropdownDelay(): number;
+    set dropdownDelay(v: number);
+    /**
+     * Gets the actual dropdown delay.
+    */
+    get actualDropdownDelay(): number;
+    set actualDropdownDelay(v: number);
+    /**
+     * Gets or sets the style of scrollbar.
+    */
+    get scrollbarStyle(): ScrollbarStyle;
+    set scrollbarStyle(v: ScrollbarStyle);
+    /**
+     * Gets or sets the scrollbar background color for checkbox lists hosted in this tool panel's actions.
+    */
+    get checkboxListScrollbarBackground(): string;
+    set checkboxListScrollbarBackground(v: string);
+    /**
+     * Gets or sets the scrollbar thumb hover background color for checkbox lists hosted in this tool panel's actions.
+    */
+    get checkboxListScrollbarHoverBackground(): string;
+    set checkboxListScrollbarHoverBackground(v: string);
+    /**
+     * Gets or sets the scrollbar thumb active (dragging) background color for checkbox lists hosted in this tool panel's actions.
+    */
+    get checkboxListScrollbarActiveBackground(): string;
+    set checkboxListScrollbarActiveBackground(v: string);
+    /**
+     * Gets or sets the spacing between items
+    */
+    get itemSpacing(): number;
+    set itemSpacing(v: number);
+    /**
+     * Gets or sets the mode used when displaying nested actions.
+    */
+    get nestedActionMode(): NestedActionMode;
+    set nestedActionMode(v: NestedActionMode);
+    get isOpen(): boolean;
+    findByName(name: string): any;
+    protected __p: string;
+    protected _hasUserValues: Set<string>;
+    protected get hasUserValues(): Set<string>;
+    protected __m(propertyName: string): void;
+    protected _stylingContainer: any;
+    protected _stylingParent: any;
+    protected _inStyling: boolean;
+    protected _styling(container: any, component: any, parent?: any): void;
+    refresh(): void;
+    getDesiredSize(): IgSize;
+    flushRefresh(): void;
+    /**
+     * Forces any open sub menus to close.
+    
+    */
+    closeSubmenus(): void;
+    exportVisualData(): any;
+    exportSerializedVisualData(): string;
+    setBrushContextItem(key: string, value: string): void;
+    getBrushContextItem(key: string): string;
+    setBrushCollectionContextItem(key: string, value: string[]): void;
+    getBrushCollectionContextItem(key: string): string[];
+    setDoubleContextItem(key: string, value: number): void;
+    getDoubleContextItem(key: string): number;
+    setIntContextItem(key: string, value: number): void;
+    getIntContextItem(key: string): number;
+    setStringContextItem(key: string, value: string): void;
+    getStringContextItem(key: string): string;
+    setBoolContextItem(key: string, value: boolean): void;
+    getBoolContextItem(key: string): boolean;
+    setColorContextItem(key: string, value: string): void;
+    getColorContextItem(key: string): string;
+    setDataContextItem(key: string, value: any): void;
+    getDataContextItem(key: string): any;
+    private _contentRefreshed;
+    private _contentRefreshed_wrapped;
+    get contentRefreshed(): (s: IgcToolPanelComponent, e: IgcToolPanelContentRefreshedEventArgs) => void;
+    set contentRefreshed(ev: (s: IgcToolPanelComponent, e: IgcToolPanelContentRefreshedEventArgs) => void);
+    private _onCommand;
+    private _onCommand_wrapped;
+    get onCommand(): (s: IgcToolPanelComponent, e: IgcToolCommandEventArgs) => void;
+    set onCommand(ev: (s: IgcToolPanelComponent, e: IgcToolCommandEventArgs) => void);
+}