/*!
    *
    * Wijmo Library 5.20231.888
    * http://wijmo.com/
    *
    * Copyright(c) GrapeCity, Inc.  All rights reserved.
    *
    * Licensed under the GrapeCity Commercial License.
    * sales@wijmo.com
    * wijmo.com/products/wijmo-5/license/
    *
    */
/**
 * {@module wijmo.grid.detail}
 * Extension that provides detail rows for {@link FlexGrid} controls.
 */
/**
 *
 */
export declare var ___keepComment: any;
import { EventArgs } from '@grapecity/wijmo';
import { Row, FlexGrid, MergeManager, GridPanel, CellRange, CellRangeEventArgs, FormatItemEventArgs, Column } from '@grapecity/wijmo.grid';
import * as selfModule from '@grapecity/wijmo.grid.detail';
/**
 * Row that contains a single detail cell spanning all grid columns.
 */
export declare class DetailRow extends Row {
    _detail: HTMLElement;
    /**
     * Initializes a new instance of the {@link DetailRow} class.
     *
     * @param parentRow {@link Row} that this {@link DetailRow} provides details for.
     */
    constructor(parentRow: Row);
    /**
     * Gets or sets the HTML element that represents the detail cell in this {@link DetailRow}.
     */
    detail: HTMLElement;
}
/**
 * Merge manager class used by the {@link FlexGridDetailProvider} class.
 *
 * The {@link DetailMergeManager} merges detail cells (cells in a {@link DetailRow})
 * into a single detail cell that spans all grid columns.
 */
export declare class DetailMergeManager extends MergeManager {
    _originalMergeManager: MergeManager;
    /**
     * Initializes a new instance of a {@link DetailMergeManager} class.
     *
     * @param grid Grid that owns this merge manager.
     */
    constructor(grid: FlexGrid);
    /**
     * Gets a {@link CellRange} that specifies the merged extent of a cell
     * in a {@link GridPanel}.
     *
     * @param p The {@link GridPanel} that contains the range.
     * @param r The index of the row that contains the cell.
     * @param c The index of the column that contains the cell.
     * @param clip Whether to clip the merged range to the grid's current view range.
     * @return A {@link CellRange} that specifies the merged range, or null if the cell is not merged.
     */
    getMergedRange(p: GridPanel, r: number, c: number, clip?: boolean): CellRange;
}
/**
 * Specifies constants that define the action to perform when the
 * ENTER key is pressed.
 */
export declare enum KeyAction {
    /** No special action (let the grid handle the key). */
    None = 0,
    /** Toggle the detail display. */
    ToggleDetail = 1
}
/**
 * Specifies when and how the row details are displayed.
 */
export declare enum DetailVisibilityMode {
    /**
     * Details are shown or hidden in code, using the
     * {@link FlexGridDetailProvider.showDetail} and
     * {@link FlexGridDetailProvider.hideDetail} methods.
     */
    Code = 0,
    /**
     * Details are shown for the row that is currently selected.
     */
    Selection = 1,
    /**
     * Details are shown or hidden using buttons added to the row headers.
     * Only one row may be expanded at a time.
     */
    ExpandSingle = 2,
    /**
     * Details are shown or hidden using buttons added to the row headers.
     * Multiple rows may be expanded at a time.
     */
    ExpandMulti = 3
}
/**
 * Represents a method that takes a {@link Row} and returns an HTMLElement
 * containing details about the row.
 */
export interface ICreateDetailCell {
    /**
     * @param row {@link Row} that contains the details.
     * @param col {@link Column} that contains the details.
     * @returns Element with details about the row.
     */
    (row: Row, col?: Column): HTMLElement;
}
/**
 * Represents a method that takes a {@link Row} and disposes of detail
 * elements associated with the row.
 */
export interface IDisposeDetailCell {
    /**
     * @param row {@link Row} that contains details that were just removed from view.
     * @returns Returning true will prevent {@link FlexGridDetailProvider} from
     * disposing controls in details. Can be used if all the disposing logic is
     * fulfilled by the method.
     */
    (row: Row): boolean | void;
}
/**
 * Represents a method that takes a {@link Row} and returns true if
 * the row has details that can be displayed.
 */
export interface IRowHasDetail {
    /**
     * @param row {@link Row} on the main grid.
     * @returns true if the row has details that can be shown.
     */
    (row: Row): boolean;
}
/**
 * Implements detail rows for {@link FlexGrid} controls.
 *
 * To add detail rows to a {@link FlexGrid} control, create an instance of a
 * {@link FlexGridDetailProvider} and set the {@link createDetailCell} property
 * to a function that creates elements to be displayed in the detail cells.
 *
 * For example:
 *
 * ```typescript
 * import { FlexGrid } from '@grapecity/wijmo.grid';
 * import { FlexGridDetailProvider } from '@grapecity/wijmo.grid.detail';
 *
 * // create FlexGrid to show categories
 * let gridCat = new FlexGrid('#gridCat', {
 *     itemsSource: getCategories();
 * });
 *
 * // add detail rows showing products in each category
 * let detailProvider = new FlexGridDetailProvider(gridCat, {
 *     createDetailCell: (row) => {
 *         let cell = document.createElement('div');
 *         new FlexGrid(cell, {
 *             itemsSource: getProducts(row.dataItem.CategoryID)
 *         });
 *         return cell;
 *     }
 * });
 * ```
 *
 * The {@link FlexGridDetailProvider} provides a {@link detailVisibilityMode} property
 * that determines when the detail rows should be displayed.
 *
 * The default value for this property is **ExpandSingle**, which adds collapse/expand
 * icons to the row headers.
 *
 * The example below shows how you can use a {@link FlexGridDetailProvider} to add
 * different types of detail to the rows in a {@link FlexGrid}:
 *
 * {@sample Grid/Rows/RowDetail/Overview/purejs Example}
 */
export declare class FlexGridDetailProvider {
    static _WJC_DETAIL: string;
    _g: FlexGrid;
    _maxHeight: number | null;
    _mode: DetailVisibilityMode;
    _animated: boolean;
    _toSel: any;
    _createDetailCellFn: ICreateDetailCell;
    _disposeDetailCellFn: IDisposeDetailCell;
    _rowHasDetailFn: IRowHasDetail;
    _keyActionEnter: KeyAction;
    /**
     * Initializes a new instance of the {@link FlexGridDetailProvider} class.
     *
     * @param grid {@link FlexGrid} that will receive detail rows.
     * @param options Initialization options for the new {@link FlexGridDetailProvider}.
     */
    constructor(grid: FlexGrid, options?: any);
    /**
     * Gets the {@link FlexGrid} that owns this {@link FlexGridDetailProvider}.
     */
    readonly grid: FlexGrid;
    /**
     * Gets or sets a value that determines when row details are displayed.
     *
     * The default value for this property is **DetailVisibilityMode.ExpandSingle**.
     */
    detailVisibilityMode: DetailVisibilityMode;
    /**
     * Gets or sets the maximum height of the detail rows, in pixels.
     *
     * The default value for this property is **null**, which means
     * there's no upper limit to the detail row height.
     */
    maxHeight: number | null;
    /**
     * Gets or sets a value that indicates whether to use animation when
     * showing row details.
     *
     * The default value for this property is **false**.
     */
    isAnimated: boolean;
    /**
     * Gets or sets the action to perform when the ENTER key is pressed.
     *
     * The default setting for this property is {@link KeyAction.None},
     * which lets the grid handle the key.
     * The other option is {@link KeyAction.ToggleDetail}, which handles
     * the Enter key to toggle the display of the row details.
     */
    keyActionEnter: KeyAction;
    /**
     * Gets or sets the callback function that creates detail cells.
     *
     * The callback function takes a {@link Row} as a parameter and
     * returns an HTML element representing the row details.
     * For example:
     *
     * ```typescript
     * // create detail cells for a given row
     * dp.createDetailCell = (row) => {
     *     let cell = document.createElement('div');
     *     new FlexGrid(cell, {
     *         itemsSource: getProducts(row.dataItem.CategoryID),
     *         headersVisibility: 'Column'
     *     });
     *     return cell;
     * };
     * ```
     */
    createDetailCell: ICreateDetailCell;
    /**
     * Gets or sets the callback function that disposes of detail cells.
     *
     * The callback function takes a {@link Row} as a parameter and
     * disposes of any resources associated with the detail cell.
     *
     * This function is optional. Use it in cases where the
     * {@link createDetailCell} function allocates resources that are not
     * automatically garbage-collected.
     */
    disposeDetailCell: IDisposeDetailCell;
    /**
     * Gets or sets the callback function that determines whether a row
     * has details.
     *
     * The callback function takes a {@link Row} as a parameter and
     * returns a boolean value that indicates whether the row has
     * details. For example:
     *
     * ```typescript
     * // remove details from items with odd CategoryID
     * dp.rowHasDetail = (row) => {
     *     return row.dataItem.CategoryID % 2 == 0;
     * };
     * ```
     *
     * Setting this property to null means all regular data
     * rows (not group rows or new item templates) have details.
     */
    rowHasDetail: IRowHasDetail;
    /**
     * Gets the detail row associated with a given grid row.
     *
     * @param row Row or index of the row to investigate.
     */
    getDetailRow(row: any): DetailRow | null;
    /**
     * Gets a value that determines if a row's details are visible.
     *
     * @param row Row or index of the row to investigate.
     */
    isDetailVisible(row: any): boolean;
    /**
     * Gets a value that determines if a row has details to show.
     *
     * @param row Row or index of the row to investigate.
     */
    isDetailAvailable(row: any): boolean;
    /**
     * Hides the detail row for a given row.
     *
     * @param row {@link Row} or index of the row that will have its details hidden.
     * This parameter is optional. If not provided, all detail rows are hidden.
     */
    hideDetail(row?: Row | number): void;
    /**
     * Shows the detail row for a given row.
     *
     * @param row {@link Row} or index of the row that will have its details shown.
     * @param hideOthers Whether to hide details for all other rows.
     */
    showDetail(row: Row | number, hideOthers?: boolean): void;
    _sizeDetailRow(row: DetailRow, useScrollHeight?: boolean): number;
    _handleFrozenCells(): void;
    _toIndex(row: any): number;
    _hdrClick(e: MouseEvent): void;
    _toggleRowDetail(row: number): boolean;
    _selectionChanged(s: FlexGrid, e: EventArgs): void;
    _formatItem(s: any, e: FormatItemEventArgs): void;
    _resizedRow(s: any, e: CellRangeEventArgs): void;
    _hasDetail(row: number): boolean;
    _isRegularRow(row: Row): boolean;
    _createDetailCell(row: Row): HTMLElement;
}