@progress/kendo-angular-treelist 4.0.6 → 5.0.0-dev.202204150741

package/navigation/focus-group.d.ts

@@ -0,0 +1,66 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { FocusableElement } from "./focusable-element.interface";
+import { FocusRoot } from './focus-root';
+import * as i0 from "@angular/core";
+/**
+ * Represents group of components that can be activated or focused.
+ *
+ * A focus group may contain focusable elements, such as rows, cells and input elements.
+ *
+ * Elements are added to the focus group by tagging them with the `kendoTreeListFocusable` directive.
+ * See [Controlling the Focus]({% slug keyboard_navigation_treelist %}#toc-controlling-the-focus).
+ *
+ * @hidden
+ */
+export declare class FocusGroup {
+    private root;
+    private active;
+    private children;
+    private get focusableChildren();
+    get isActive(): boolean;
+    /**
+     * @hidden
+     */
+    constructor(root: FocusRoot);
+    ngOnDestroy(): void;
+    /**
+     * @hidden
+     */
+    registerElement(element: FocusableElement): void;
+    /**
+     * @hidden
+     */
+    unregisterElement(element: FocusableElement): void;
+    /**
+     * Returns a boolean value which indicates if the group will receive focus when the cell is focused.
+     * Evaluates to `true` when the focus group has a single focusable element such as a button or a checkbox.
+     *
+     * @returns A boolean value which indicates if the group will receive focus when the cell is focused.
+     */
+    isNavigable(): boolean;
+    /**
+     * Returns a boolean value which indicates if the focus group contains focusable component.
+     *
+     * @returns A boolean value which indicates if the focus group contains focusable component.
+     */
+    canFocus(): boolean;
+    /**
+     * Focuses the first focusable component, if any.
+     */
+    focus(): void;
+    /**
+     * @hidden
+     */
+    activate(): void;
+    /**
+     * @hidden
+     */
+    deactivate(): void;
+    private hasFocus;
+    private toggleState;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FocusGroup, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FocusGroup>;
+}

package/navigation/focus-root.d.ts

@@ -0,0 +1,19 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { FocusGroup } from './focus-group';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare class FocusRoot {
+    alive: boolean;
+    private groups;
+    registerGroup(group: FocusGroup): void;
+    unregisterGroup(group: FocusGroup): void;
+    activate(): any;
+    deactivate(): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FocusRoot, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FocusRoot>;
+}

package/navigation/focusable.directive.d.ts

@@ -0,0 +1,83 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { AfterViewInit, ElementRef, OnDestroy, OnInit, Renderer2 } from '@angular/core';
+import { FocusGroup } from './focus-group';
+import { FocusableElement } from './focusable-element.interface';
+import * as i0 from "@angular/core";
+/**
+ * A directive that controls the way focusable cell elements receive
+ * [focus in a navigable TreeList]({% slug keyboard_navigation_treelist %}).
+ *
+ * The directive takes as input the `cellContext` from the cell template.
+ *
+ * ```ts-no-run
+ * <kendo-treelist-column>
+ *   <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
+ *     <input type="button" kendoButton [kendoTreeListFocusable]="cellContext" value="Focus me!" />
+ *   </ng-template>
+ * </kendo-treelist-column>
+ * ```
+ */
+export declare class FocusableDirective implements AfterViewInit, FocusableElement, OnInit, OnDestroy {
+    private hostElement;
+    private renderer;
+    private group;
+    /**
+     * The cell context provided by the template.
+     */
+    cellContext: any;
+    /**
+     * @hidden
+     */
+    set addCellContext(value: any);
+    /**
+     * @hidden
+     */
+    set editCellContext(value: any);
+    /**
+     * @hidden
+     */
+    set removeCellContext(value: any);
+    /**
+     * @hidden
+     */
+    set saveCellContext(value: any);
+    /**
+     * @hidden
+     */
+    set cancelCellContext(value: any);
+    private active;
+    private element;
+    constructor(hostElement: ElementRef, renderer: Renderer2, group: FocusGroup);
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * @hidden
+     */
+    toggle(active: boolean): void;
+    /**
+     * @hidden
+     */
+    canFocus(): boolean;
+    /**
+     * @hidden
+     */
+    isNavigable(): boolean;
+    /**
+     * @hidden
+     */
+    focus(): void;
+    /**
+     * @hidden
+     */
+    hasFocus(): boolean;
+    /**
+     * @hidden
+     */
+    registerElement(element: FocusableElement): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FocusableDirective, [null, null, { optional: true; }]>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<FocusableDirective, "[kendoTreeListFocusable],        [kendoTreeListAddCommand],        [kendoTreeListEditCommand],        [kendoTreeListRemoveCommand],        [kendoTreeListSaveCommand],        [kendoTreeListCancelCommand]    ", never, { "cellContext": "kendoTreeListFocusable"; "addCellContext": "kendoTreeListAddCommand"; "editCellContext": "kendoTreeListEditCommand"; "removeCellContext": "kendoTreeListRemoveCommand"; "saveCellContext": "kendoTreeListSaveCommand"; "cancelCellContext": "kendoTreeListCancelCommand"; }, {}, never>;
+}

package/navigation/item-map.d.ts

@@ -0,0 +1,19 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * @hidden
+ */
+export declare class ItemMap {
+    count: number;
+    items: any;
+    get first(): any;
+    get last(): any;
+    removeItem(key: any): void;
+    setItem(key: any, item: any): void;
+    getItem(key: any): any;
+    toArray(): any[];
+    forEach(callback: any): any;
+    find(callback: any): any;
+}

package/navigation/logical-cell.directive.d.ts

@@ -0,0 +1,52 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { DoCheck, ElementRef, NgZone, Renderer2, SimpleChanges } from '@angular/core';
+import { OnChanges, OnDestroy, OnInit } from '@angular/core';
+import { FocusGroup } from './focus-group';
+import { LogicalCell } from './logical-cell.interface';
+import { NavigationService } from './navigation.service';
+import { ColumnInfoService } from '../common/column-info.service';
+import { IdService } from '../common/id.service';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare class LogicalCellDirective implements LogicalCell, OnInit, OnChanges, OnDestroy, DoCheck {
+    focusGroup: FocusGroup;
+    private element;
+    private columnInfoService;
+    private idService;
+    private navigationService;
+    private renderer;
+    private zone;
+    logicalColIndex: number;
+    logicalRowIndex: number;
+    logicalSlaveCell: boolean;
+    column: any;
+    colIndex: number;
+    colSpan: number;
+    rowSpan: number;
+    dataRowIndex: number;
+    dataItem: any;
+    expandable: boolean;
+    readonly uid: number;
+    get id(): string;
+    get ariaColIndex(): number;
+    private navigationChange;
+    constructor(focusGroup: FocusGroup, element: ElementRef, columnInfoService: ColumnInfoService, idService: IdService, navigationService: NavigationService, renderer: Renderer2, zone: NgZone);
+    ngOnInit(): void;
+    ngDoCheck(): void;
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    private onNavigationChange;
+    private updateElement;
+    private microtask;
+    private registerChanges;
+    private registerNoChanges;
+    private isFocusable;
+    private isFocused;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LogicalCellDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<LogicalCellDirective, "[kendoTreeListLogicalCell]", never, { "logicalColIndex": "logicalColIndex"; "logicalRowIndex": "logicalRowIndex"; "logicalSlaveCell": "logicalSlaveCell"; "column": "column"; "colIndex": "colIndex"; "colSpan": "colSpan"; "rowSpan": "rowSpan"; "dataRowIndex": "dataRowIndex"; "dataItem": "dataItem"; "expandable": "expandable"; }, {}, never>;
+}

package/navigation/logical-row.directive.d.ts

@@ -0,0 +1,32 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { OnDestroy, OnChanges } from '@angular/core';
+import { IdService } from '../common/id.service';
+import { NavigationService } from './navigation.service';
+import { LogicalRow } from './logical-row.interface';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare class LogicalRowDirective implements LogicalRow, OnDestroy, OnChanges {
+    private idService;
+    private navigation;
+    logicalRowIndex: number;
+    logicalSlaveRow: boolean;
+    logicalCellsCount: number;
+    logicalSlaveCellsCount: number;
+    dataRowIndex: number;
+    dataItem: any;
+    isNew: boolean;
+    uid: number;
+    get hostRole(): string;
+    get ariaRowIndex(): number;
+    get ariaOwns(): string;
+    constructor(idService: IdService, navigation: NavigationService);
+    ngOnChanges(changes: any): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<LogicalRowDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<LogicalRowDirective, "[kendoTreeListLogicalRow]", never, { "logicalRowIndex": "logicalRowIndex"; "logicalSlaveRow": "logicalSlaveRow"; "logicalCellsCount": "logicalCellsCount"; "logicalSlaveCellsCount": "logicalSlaveCellsCount"; "dataRowIndex": "dataRowIndex"; "dataItem": "dataItem"; "isNew": "isNew"; }, {}, never>;
+}

package/navigation/navigation-cursor.d.ts

@@ -0,0 +1,48 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Subject } from 'rxjs';
+import { NavigationChange } from './navigation-change.interface';
+import { NavigationCell } from './navigation-cell.interface';
+import { NavigationModel } from './navigation-model';
+import { NavigationMetadata } from './navigation-metadata';
+/**
+ * @hidden
+ */
+export declare class NavigationCursor {
+    private model;
+    readonly changes: Subject<NavigationChange>;
+    metadata: NavigationMetadata;
+    private activeRow;
+    private activeCol;
+    private virtualCol;
+    private virtualRow;
+    get row(): any;
+    get cell(): NavigationCell;
+    get dataRowIndex(): number;
+    constructor(model: NavigationModel);
+    /**
+     * Assumes and announces a new cursor position.
+     */
+    reset(rowIndex?: number, colIndex?: number, force?: boolean): void;
+    activate(rowIndex: number, colIndex: number, force?: boolean): boolean;
+    isActiveRange(rowIndex: number, colIndex: number): boolean;
+    /**
+     * Assumes a new cursor position without announcing it.
+     */
+    assume(rowIndex?: number, colIndex?: number): void;
+    /**
+     * Announces a current cursor position to subscribers.
+     */
+    announce(): void;
+    activateVirtualCell(cell: any): boolean;
+    isActive(rowIndex: number, colIndex: number): boolean;
+    moveUp(offset?: number): boolean;
+    moveDown(offset?: number): boolean;
+    moveLeft(offset?: number): boolean;
+    moveRight(offset?: number): boolean;
+    lastCellIndex(): number;
+    private offsetCol;
+    private offsetRow;
+}

package/navigation/navigation-metadata.d.ts

@@ -0,0 +1,20 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ElementRef } from '@angular/core';
+/**
+ * @hidden
+ */
+export declare class NavigationMetadata {
+    view: any;
+    headerRows: number;
+    isVirtual: boolean;
+    hasPager: boolean;
+    treelistElement: ElementRef;
+    virtualColumns: boolean;
+    columns: any;
+    get maxLogicalRowIndex(): number;
+    get dataRows(): number;
+    constructor(view: any, headerRows: number, isVirtual: boolean, hasPager: boolean, treelistElement: ElementRef, virtualColumns: boolean, columns: any);
+}

package/navigation/navigation-model.d.ts

@@ -0,0 +1,27 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { LogicalCell } from './logical-cell.interface';
+import { LogicalRow } from './logical-row.interface';
+/**
+ * @hidden
+ *
+ * Contains information for the currently rendered rows and cells.
+ */
+export declare class NavigationModel {
+    private rows;
+    get firstRow(): any;
+    get lastRow(): any;
+    registerCell(cell: LogicalCell): any;
+    unregisterCell(index: number, rowIndex: number, cell: LogicalCell): void;
+    registerRow(row: LogicalRow): void;
+    updateRow(row: LogicalRow): void;
+    unregisterRow(index: number, row: LogicalRow): void;
+    cellRange(cell: any): any;
+    rowRange(cell: any): any;
+    nextRow(rowIndex: any, offset: number): any;
+    findRow(index: number): any;
+    findCell(index: number, row: any): any;
+    private rowCell;
+}

package/navigation/navigation.service.d.ts

@@ -0,0 +1,109 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ChangeDetectorRef, EventEmitter, NgZone, OnDestroy } from '@angular/core';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { Subject } from 'rxjs';
+import { FocusRoot } from './focus-root';
+import { FocusableDirective } from './focusable.directive';
+import { LogicalCell } from './logical-cell.interface';
+import { LogicalRow } from './logical-row.interface';
+import { NavigationCell } from './navigation-cell.interface';
+import { NavigationChange } from './navigation-change.interface';
+import { NavigationMetadata } from './navigation-metadata';
+import { NavigationRow } from './navigation-row.interface';
+import { DomEventsService } from '../common/dom-events.service';
+import { EditService } from '../editing/edit.service';
+import { ExpandStateService } from '../expand-state/expand-state.service';
+import { PagerContextService } from '../pager/pager-context.service';
+import { ScrollRequestService } from '../scrolling/scroll-request.service';
+import { SelectionService } from '../selection/selection.service';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare class NavigationViewport {
+    firstItemIndex: number;
+    lastItemIndex: number;
+    constructor(firstItemIndex: number, lastItemIndex: number);
+    containsRow(dataRowIndex: number): boolean;
+    intersects(start: number, end: number): boolean;
+}
+/**
+ * @hidden
+ */
+export declare class NavigationService implements OnDestroy {
+    private zone;
+    private domEvents;
+    private pagerContextService;
+    private scrollRequestService;
+    private focusRoot;
+    private editService;
+    private localization;
+    private expandState;
+    private selectionService;
+    private changeDetector;
+    private focusableParent;
+    readonly changes: Subject<NavigationChange>;
+    readonly cellKeydown: EventEmitter<any>;
+    set metadata(value: NavigationMetadata);
+    get metadata(): NavigationMetadata;
+    get enabled(): boolean;
+    get activeCell(): NavigationCell;
+    get activeRow(): NavigationRow;
+    viewport: NavigationViewport;
+    columnViewport: NavigationViewport;
+    private activeRowIndex;
+    private alive;
+    private active;
+    private mode;
+    private model;
+    private cursor;
+    private meta;
+    private subs;
+    private pendingRowIndex;
+    private virtualCell;
+    private get activeDataRow();
+    constructor(zone: NgZone, domEvents: DomEventsService, pagerContextService: PagerContextService, scrollRequestService: ScrollRequestService, focusRoot: FocusRoot, editService: EditService, localization: LocalizationService, expandState: ExpandStateService, selectionService: SelectionService, changeDetector: ChangeDetectorRef, focusableParent: FocusableDirective);
+    init(meta: NavigationMetadata): void;
+    ngOnDestroy(): void;
+    registerCell(cell: LogicalCell): void;
+    registerCellOnCurrentRow(cell: LogicalCell): void;
+    unregisterCell(index: number, rowIndex: number, cell: LogicalCell): void;
+    registerRow(row: LogicalRow): void;
+    updateRow(row: LogicalRow): void;
+    unregisterRow(index: number, row: LogicalRow): void;
+    isCellFocusable(cell: LogicalCell): boolean;
+    isCellFocused(cell: LogicalCell): boolean;
+    navigateTo(el: Element): void;
+    tryFocus(el: Element): boolean;
+    needsViewport(): boolean;
+    setViewport(firstItemIndex: number, lastItemIndex: number): void;
+    setColumnViewport(firstItemIndex: number, lastItemIndex: number): void;
+    focusCell(rowIndex?: number, colIndex?: number): NavigationCell;
+    focusNextCell(wrap?: boolean): NavigationCell;
+    focusPrevCell(wrap?: boolean): NavigationCell;
+    toggle(active: boolean): void;
+    hasFocus(): boolean;
+    autoFocusCell(start: number, end: number): boolean;
+    private focusAdjacentCell;
+    private enterCell;
+    private leaveCell;
+    private activateElements;
+    private deactivateElements;
+    private activateRow;
+    private moveCursorFwd;
+    private moveCursorBwd;
+    private updateSelection;
+    private onCursorKeydown;
+    private onContentKeydown;
+    private onCellKeydown;
+    private onCursorChanges;
+    private onFocusOut;
+    private onWindowBlur;
+    private onKeydown;
+    private onTabout;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NavigationService, [null, null, null, null, null, null, null, null, null, null, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NavigationService>;
+}