smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
207 lines (206 loc) • 14.4 kB
TypeScript
import { MultiSplitButton } from './../index';
import { Animation, DropDownButtonPosition, DropDownOpenMode, DropDownPosition, FilterMode, SearchMode, VerticalAlignment, MultiSplitButtonSelectionMode } from './../index';
import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core';
import { BaseElement } from './smart.element';
import * as i0 from "@angular/core";
export { Animation, DropDownButtonPosition, DropDownOpenMode, DropDownPosition, FilterMode, SearchMode, VerticalAlignment, MultiSplitButtonSelectionMode, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { MultiSplitButton } from './../index';
export declare class MultiSplitButtonComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
constructor(ref: ElementRef<MultiSplitButton>);
private eventHandlers;
nativeElement: MultiSplitButton;
/** @description Creates the component on demand.
* @param properties An optional object of properties, which will be added to the template binded ones.
*/
createComponent(properties?: {}): any;
/** @description Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Determines a data source used to generate element's permanently visible buttons. */
get buttonsDataSource(): string[];
set buttonsDataSource(value: string[]);
/** @description Determines the data source of the multi split button's dropdown. */
get dataSource(): any;
set dataSource(value: any);
/** @description Enables or disables jqxMultiSplitButton. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Displays or hides the loading indicator */
get displayLoadingIndicator(): boolean;
set displayLoadingIndicator(value: boolean);
/** @description Sets or gets the displayMember. The displayMember specifies the name of an object property to display. The name is contained in the collection specified by the 'dataSource' property. */
get displayMember(): string;
set displayMember(value: string);
/** @description Sets the parent container of the button's dropDown list (the popup). The expected value is CSS Selector, ID or 'body'. Used when a CSS property of unknowned parent is interfering with the visibility of the dropDown list. */
get dropDownAppendTo(): string;
set dropDownAppendTo(value: string);
/** @description Determines position of the drop down button. */
get dropDownButtonPosition(): DropDownButtonPosition | string;
set dropDownButtonPosition(value: DropDownButtonPosition | string);
/** @description Defines how element's drop down behaves. In 'none' mode drop down never opens. In 'dropDownButton' mode drop down is opened only via elelent's drop down button. In 'auto' mode drop down is opened on click on the whole top section. */
get dropDownOpenMode(): DropDownOpenMode | string;
set dropDownOpenMode(value: DropDownOpenMode | string);
/** @description If this property is enabled, when the element's dropdown is opened, a transparent overlay is positioned between the dropdown and the rest of the document. */
get dropDownOverlay(): boolean;
set dropDownOverlay(value: boolean);
/** @description Determines the vertical position of the dropDown list. 'Auto' means its automatically determined depending on the viewport size. */
get dropDownPosition(): DropDownPosition | string;
set dropDownPosition(value: DropDownPosition | string);
/** @description Determines whether the Filtering is enabled. */
get filterable(): boolean;
set filterable(value: boolean);
/** @description Determines the filtering for the drop down list mode. */
get filterMode(): FilterMode | string;
set filterMode(value: FilterMode | string);
/** @description Determines the placeholder for the drop down list filter input field. */
get filterInputPlaceholder(): string;
set filterInputPlaceholder(value: string);
/** @description If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups. */
get grouped(): boolean;
set grouped(value: boolean);
/** @description Sets or gets the groupMember. If it's not set, by default is used 'group' property of the source object. */
get groupMember(): string;
set groupMember(value: string);
/** @description Sets ot gets the incrementalSearchDelay property. The incrementalSearchDelay specifies the time-interval in milliseconds after which the previous search string is deleted. The timer starts when you stop typing. */
get incrementalSearchDelay(): number;
set incrementalSearchDelay(value: number);
/** @description Sets ot gets the mode of the incremental search mode. */
get incrementalSearchMode(): SearchMode | string;
set incrementalSearchMode(value: SearchMode | string);
/** @description Determines the height of the items. */
get itemHeight(): number | null;
set itemHeight(value: number | null);
/** @description The itemTemplate property is a string that represents the id of an HTMLTemplateElement in the DOM. It's used to load list items from the HTMLTemplateElement. */
get itemTemplate(): any;
set itemTemplate(value: any);
/** @description Determines the text that will be displayed next to the loading indicator when the loader is visible and it's position is top or bottom. */
get loadingIndicatorPlaceholder(): string;
set loadingIndicatorPlaceholder(value: string);
/** @description The position of the loading indicator. */
get loadingIndicatorPosition(): VerticalAlignment | string;
set loadingIndicatorPosition(value: VerticalAlignment | string);
/** @description Sets or gets the license which unlocks the product. */
get license(): string;
set license(value: string);
/** @description Sets or gets the language. Used in conjunction with the property messages. */
get locale(): string;
set locale(value: string);
/** @description Callback, related to localization module. */
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property language. */
get messages(): any;
set messages(value: any);
/** @description Determines whether the popup is opened or closed */
get opened(): boolean;
set opened(value: boolean);
/** @description Disables user interaction with the element. */
get readonly(): boolean;
set readonly(value: boolean);
/** @description Sets or gets selected indexes of buttons's dropDown. */
get selectedIndexes(): number[];
set selectedIndexes(value: number[]);
/** @description Sets or gets selected values of buttons's dropDown. */
get selectedValues(): string[];
set selectedValues(value: string[]);
/** @description Determines how many items can be selected. */
get selectionMode(): MultiSplitButtonSelectionMode | string;
set selectionMode(value: MultiSplitButtonSelectionMode | string);
/** @description Determines whether the items in the dropDown are sorted alphabetically or not */
get sorted(): boolean;
set sorted(value: boolean);
/** @description Determines the theme. Theme defines the look of the element */
get theme(): string;
set theme(value: string);
/** @description If is set to true, the element cannot be focused. */
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** @description Determines the value member of an item. Stored as value in the item object. */
get valueMember(): string;
set valueMember(value: string);
/** @description Determines weather or not Virtualization is used for the button's dropDownList. */
get virtualized(): boolean;
set virtualized(value: boolean);
/** @description This event is triggered when action button is clicked.
* @param event. The custom event. */
onButtonClick: EventEmitter<CustomEvent>;
/** @description This event is triggered when the selection is changed.
* @param event. The custom event. Custom event was created with: event.detail( addedItems, disabled, index, label, removedItems, selected, value)
* addedItems - An array of List items that have been selected.
* disabled - A flag indicating whether or not the item that caused the change event is disabled.
* index - The index of the List item that triggered the event.
* label - The label of the List item that triggered the event.
* removedItems - An array of List items that have been unselected before the event was fired.
* selected - The selected state of the List item that triggered the event. If an item was selected the value will be true and vice versa.
* value - The value of the List item that triggered the event.
*/
onChange: EventEmitter<CustomEvent>;
/** @description This event is triggered when button's dropDown list is closed.
* @param event. The custom event. */
onClose: EventEmitter<CustomEvent>;
/** @description This event is triggered when button's dropDown list is closing.
* @param event. The custom event. */
onClosing: EventEmitter<CustomEvent>;
/** @description This event is triggered when an item is clicked.
* @param event. The custom event. Custom event was created with: event.detail( disabled, index, label, selected, value)
* disabled - Indicates whether the List item that was clicked is disabled or not.
* index - Indicates the index of the List item that was clicked.
* label - The label of the List item that was clicked.
* selected - Indicates whether the List item that was clicked is selected or not.
* value - The value of the List item that was clicked.
*/
onItemClick: EventEmitter<CustomEvent>;
/** @description This event is triggered when button's dropDown list is opened.
* @param event. The custom event. */
onOpen: EventEmitter<CustomEvent>;
/** @description This event is triggered when button's dropDown list is opening.
* @param event. The custom event. */
onOpening: EventEmitter<CustomEvent>;
/** @description This event is triggered when user scrolls to the end of the dropDown list.
* @param event. The custom event. */
onScrollBottomReached: EventEmitter<CustomEvent>;
/** @description This event is triggered when user scrolls to the start of the dropDown list.
* @param event. The custom event. */
onScrollTopReached: EventEmitter<CustomEvent>;
/** @description Closes button's dropDown list.
*/
close(): void;
/** @description Returns an item instance occured in the element's drop down.
* @param {string} value. The value of an item from the drop down list or a button.
* @returns {HTMLElement}
*/
getItem(value: any): Promise<any>;
/** @description Returns an array with the items from the split button's dropDown list.
* @returns {any[]}
*/
items(): Promise<any>;
/** @description Inserts a new item at a specified position in the drop down list.
* @param {number} position. The position where the item must be inserted.
* @param {any} value. The value of the new item.
*/
insert(position: number, value: any): void;
/** @description Opens the splitButton's dropDown list.
*/
open(): void;
/** @description Removes an item at a specified position in the drop down list.
* @param {number} position. The position of the removed item.
*/
removeAt(position: number): void;
/** @description Updates an item from the dropDown list.
* @param {number} position. The position where the item must be updated.
* @param {any} value. The value of the updated item.
*/
update(position: number, value: any): void;
get isRendered(): boolean;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
/** @description Add event listeners. */
private listen;
/** @description Remove event listeners. */
private unlisten;
static ɵfac: i0.ɵɵFactoryDeclaration<MultiSplitButtonComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<MultiSplitButtonComponent, "smart-multi-split-button, [smart-multi-split-button]", ["smart-multi-split-button"], { "animation": "animation"; "buttonsDataSource": "buttonsDataSource"; "dataSource": "dataSource"; "disabled": "disabled"; "displayLoadingIndicator": "displayLoadingIndicator"; "displayMember": "displayMember"; "dropDownAppendTo": "dropDownAppendTo"; "dropDownButtonPosition": "dropDownButtonPosition"; "dropDownOpenMode": "dropDownOpenMode"; "dropDownOverlay": "dropDownOverlay"; "dropDownPosition": "dropDownPosition"; "filterable": "filterable"; "filterMode": "filterMode"; "filterInputPlaceholder": "filterInputPlaceholder"; "grouped": "grouped"; "groupMember": "groupMember"; "incrementalSearchDelay": "incrementalSearchDelay"; "incrementalSearchMode": "incrementalSearchMode"; "itemHeight": "itemHeight"; "itemTemplate": "itemTemplate"; "loadingIndicatorPlaceholder": "loadingIndicatorPlaceholder"; "loadingIndicatorPosition": "loadingIndicatorPosition"; "license": "license"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "opened": "opened"; "readonly": "readonly"; "selectedIndexes": "selectedIndexes"; "selectedValues": "selectedValues"; "selectionMode": "selectionMode"; "sorted": "sorted"; "theme": "theme"; "unfocusable": "unfocusable"; "valueMember": "valueMember"; "virtualized": "virtualized"; }, { "onButtonClick": "onButtonClick"; "onChange": "onChange"; "onClose": "onClose"; "onClosing": "onClosing"; "onItemClick": "onItemClick"; "onOpen": "onOpen"; "onOpening": "onOpening"; "onScrollBottomReached": "onScrollBottomReached"; "onScrollTopReached": "onScrollTopReached"; }, never>;
}