UNPKG

5 kBTypeScriptView Raw
1import type { BeanCollection, ComponentSelector, IAfterGuiAttachedParams, IDoesFilterPassParams, ISetFilter, SetFilterModel, SetFilterModelValue, SetFilterParams } from 'ag-grid-community';
2import { AgPromise, ProvidedFilter } from 'ag-grid-community';
3import { SetValueModel } from './setValueModel';
4/** @param V type of value in the Set Filter */
5export declare class SetFilter<V = string> extends ProvidedFilter<SetFilterModel, V> implements ISetFilter<V> {
6 private rowGroupColsSvc?;
7 private valueSvc;
8 private dataTypeSvc?;
9 protected filterType: "set";
10 wireBeans(beans: BeanCollection): void;
11 private readonly eMiniFilter;
12 private readonly eFilterLoading;
13 private readonly eSetFilterList;
14 private readonly eFilterNoMatches;
15 private valueModel;
16 private setFilterParams;
17 private virtualList;
18 private caseSensitive;
19 private treeDataTreeList;
20 private groupingTreeList;
21 private hardRefreshVirtualList;
22 private noValueFormatterSupplied;
23 private createKey;
24 private valueFormatter?;
25 private readonly filterModelFormatter;
26 constructor();
27 postConstruct(): void;
28 protected updateUiVisibility(): void;
29 protected createBodyTemplate(): string;
30 protected getAgComponents(): ComponentSelector[];
31 protected handleKeyDown(e: KeyboardEvent): void;
32 private handleKeySpace;
33 private handleKeyEnter;
34 private handleKeyLeft;
35 private handleKeyRight;
36 private getComponentForKeyEvent;
37 protected getCssIdentifier(): string;
38 setModel(model: SetFilterModel | null): AgPromise<void>;
39 refresh(params: SetFilterParams<any, V>): boolean;
40 private haveColDefParamsChanged;
41 private setModelAndRefresh;
42 protected resetUiToDefaults(): AgPromise<void>;
43 protected setModelIntoUi(model: SetFilterModel | null): AgPromise<void>;
44 getModelFromUi(): SetFilterModel | null;
45 getValueModel(): SetValueModel<V>;
46 protected areModelsEqual(a: SetFilterModel, b: SetFilterModel): boolean;
47 private updateSetFilterOnParamsChange;
48 setParams(params: SetFilterParams<any, V>): void;
49 private onAddCurrentSelectionToFilterChange;
50 private setValueFormatter;
51 private generateCreateKey;
52 getFormattedValue(key: string | null): string | null;
53 private applyExcelModeOptions;
54 private addEventListenersForDataChanges;
55 private syncAfterDataChange;
56 private setIsLoading;
57 private initialiseFilterBodyUi;
58 private initVirtualList;
59 private createVirtualListModel;
60 private getSelectAllLabel;
61 private getAddSelectionToFilterLabel;
62 private createSetListItem;
63 private newSetTreeItemAttributes;
64 private newSetListItemAttributes;
65 private updateSetListItem;
66 private isSelectedExpanded;
67 private isSetFilterModelTreeItem;
68 private initMiniFilter;
69 private updateMiniFilter;
70 afterGuiAttached(params?: IAfterGuiAttachedParams): void;
71 afterGuiDetached(): void;
72 applyModel(source?: 'api' | 'ui' | 'rowDataUpdated'): boolean;
73 protected isModelValid(model: SetFilterModel): boolean;
74 doesFilterPass(params: IDoesFilterPassParams): boolean;
75 private doesFilterPassForTreeData;
76 private doesFilterPassForGrouping;
77 private isInAppliedModel;
78 private getValueFromNode;
79 private getKeyCreatorParams;
80 onNewRowsLoaded(): void;
81 private isValuesTakenFromGrid;
82 /**
83 * Public method provided so the user can change the value of the filter once
84 * the filter has been already started
85 * @param values The values to use.
86 */
87 setFilterValues(values: (V | null)[]): void;
88 /**
89 * Public method provided so the user can reset the values of the filter once that it has started.
90 */
91 resetFilterValues(): void;
92 refreshFilterValues(): void;
93 onAnyFilterChanged(): void;
94 private onMiniFilterInput;
95 private updateUiAfterMiniFilterChange;
96 private showOrHideResults;
97 private resetMiniFilter;
98 protected resetUiToActiveModel(currentModel: SetFilterModel | null, afterUiUpdatedFunc?: () => void): void;
99 protected handleCancelEnd(e: Event): void;
100 private onMiniFilterKeyDown;
101 private filterOnAllVisibleValues;
102 private focusRowIfAlive;
103 private onSelectAll;
104 private onGroupItemSelected;
105 private onItemSelected;
106 private selectItem;
107 private onExpandAll;
108 private onExpandedChanged;
109 private refreshAfterExpansion;
110 private refreshAfterSelection;
111 setMiniFilter(newMiniFilter: string | null): void;
112 getMiniFilter(): string | null;
113 private checkAndRefreshVirtualList;
114 getFilterKeys(): SetFilterModelValue;
115 getFilterValues(): (V | null)[];
116 getValues(): SetFilterModelValue;
117 refreshVirtualList(): void;
118 private translateForSetFilter;
119 private isSelectAllSelected;
120 private areAllChildrenSelected;
121 destroy(): void;
122 private caseFormat;
123 private resetExpansion;
124 getModelAsString(model: SetFilterModel): string;
125 protected getPositionableElement(): HTMLElement;
126}