ag-grid-community/dist/types/src/edit/strategy/baseEditStrategy.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import { BeanStub } from '../../context/beanStub';
import type { BeanName } from '../../context/context';
import type { AgEventType } from '../../eventTypes';
import type { CellFocusClearedEvent, CellFocusedEvent } from '../../events';
import type { EditMap, IEditModelService } from '../../interfaces/iEditModelService';
import type { EditPosition, EditRowPosition, EditSource, IEditService, _SetEditingCellsParams } from '../../interfaces/iEditService';
import type { CellCtrl } from '../../rendering/cell/cellCtrl';
export type EditValidationResult<T extends Required<EditPosition> = Required<EditPosition>> = {
    all: T[];
    pass: T[];
    fail: T[];
};
export type EditValidationAction<T extends Required<EditPosition> = Required<EditPosition>> = {
    destroy: T[];
    keep: T[];
};
export declare abstract class BaseEditStrategy extends BeanStub {
    beanName: BeanName | undefined;
    protected model: IEditModelService;
    protected editSvc: IEditService;
    postConstruct(): void;
    abstract midBatchInputsAllowed(position?: EditPosition): boolean;
    clearEdits(position: EditPosition): void;
    abstract start(position: Required<EditPosition>, event?: KeyboardEvent | MouseEvent | null, source?: EditSource, ignoreEventKey?: boolean): void;
    onCellFocusChanged(event: CellFocusedEvent | CellFocusClearedEvent): void;
    abstract moveToNextEditingCell(previousCell: CellCtrl, backwards: boolean, event?: KeyboardEvent, source?: EditSource): boolean | null;
    isCellEditable({ rowNode, column }: Required<EditPosition>, _source?: 'api' | 'ui'): boolean;
    stop(cancel?: boolean): boolean;
    protected abstract processValidationResults(results: EditValidationResult): EditValidationAction;
    cleanupEditors({ rowNode }?: EditRowPosition, includeEditing?: boolean): void;
    stopAllEditing(): void;
    setFocusOutOnEditor(cellCtrl: CellCtrl): void;
    setFocusInOnEditor(cellCtrl: CellCtrl): void;
    setupEditors(cells: Required<EditPosition>[] | undefined, position: Required<EditPosition>, cellStartedEdit?: boolean, event?: Event | null, ignoreEventKey?: boolean): void;
    dispatchCellEvent<T extends AgEventType>(position: Required<EditPosition>, event?: Event | null, type?: T, payload?: any): void;
    dispatchRowEvent(position: Required<EditRowPosition>, type: 'rowEditingStarted' | 'rowEditingStopped' | 'rowValueChanged'): void;
    shouldStart({ column }: Required<EditPosition>, event?: KeyboardEvent | MouseEvent | null, cellStartedEdit?: boolean | null, source?: EditSource): boolean | null;
    shouldStop(_position?: EditPosition, event?: KeyboardEvent | MouseEvent | null | undefined, source?: EditSource): boolean | null;
    shouldCancel(_position?: EditPosition, event?: KeyboardEvent | MouseEvent | null | undefined, source?: 'api' | 'ui' | string): boolean | null;
    setEditMap(edits: EditMap, params?: _SetEditingCellsParams): void;
    private deriveClickCount;
    destroy(): void;
}