// Type definitions for datatables.net-select 1.2
// Project: https://datatables.net/extensions/select/, https://datatables.net
// Definitions by: Jared Szechy <https://github.com/szechyjs>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

/// <reference types="jquery" />
/// <reference types="datatables.net"/>

declare namespace DataTables {
    interface Settings {
        /*
         * Select extension options
         */
        select?: boolean | string | SelectSettings;
    }

    interface SelectSettings {
        /*
         * Indicate if the selected items will be removed when clicking outside of the table
         */
        blurable?: boolean;

        /*
         * Set the class name that will be applied to selected items
         */
        className?: string;

        /*
         * Enable / disable the display for item selection information in the table summary
         */
        info?: boolean;

        /*
         * Set which table items to select (rows, columns or cells)
         */
        items?: string;

        /*
         * Set the element selector used for mouse event capture to select items
         */
        selector?: string;

        /*
         * Set the selection style for end user interaction with the table
         */
        style?: "api" | "single" | "multi" | "os" | "multi+shift";
    }

    interface Api {
        select: {
          /**
           * Initialise Select for a DataTable after the DataTable has been constructed.
           * 
           * @returns DataTables Api instance
           */
          (): Api;

          /**
           * Get the blurable state for the table.
           * 
           * @returns Current state - true if blurable, false otherwise. Note that if multiple tables are defined in the API's context, only the blurable state of the first table will be returned.
           */
          blurable(): boolean;

          /**
           * Set the blurable state for the table's selection options.
           * 
           * @param flag Value to set for the blurable option - true to enable, false to disable.
           * @returns DataTables Api instance for chaining
           */
          blurable(flag): Api;

          /**
           * Get the summary information display state for the table.
           * 
           * @returns Current state - true if information summary shown, false otherwise. Note that if multiple tables are defined in the API's context, only the information state of the first table will be returned.
           */
          info(): boolean;

          /**
           * Set the information summary display state for the table's selection options.
           * 
           * @param flag Value to set for the information summary display state - true to enable, false to disable.
           * @returns DataTables API instance for chaining.
           */
          info(flag): Api;

          /**
           * Get the items that will be selected by user interaction (i.e. a click on the table).
           * 
           * @returns The current item that will be selected when the user interacts with Select's event listeners - this will be the value row, column or cell.
           */
          items(): string;

          /**
           * Set the item type that will be selected by user interaction.
           * 
           * @param set Items to select - this must be one of row, column or cells.
           * @returns DataTables API instance for chaining.
           */
          items(set: string): Api;

          /**
           * Get the current item selector string applied to the table.
           * 
           * @returns the item selector string being used for the table.
           */
          selector(): string;

          /**
           * Set the table's item selector string. Note that any old selectors will be automatically removed if this is used as a selector to ensure that there are no memory leaks in unattached event listeners.
           * 
           * @param set jQuery selector that will select the cells that can trigger item selection.
           */
          selector(set: string): Api;

          /**
          * Get the current selection style applied to the table
          * 
          * @returns The current selection style, this will be one of "api", "single", "multi" or "os".
          */
          style(): string;

          /**
          * Set the table's selection style
          * 
          * @param s Selection style to set - this must be one of "api", "single", "multi" or "os".
          * @returns DataTables API instance for chaining.
          */
          style(s: "api" | "single" | "multi" | "os"): Api;

          /**
           * Get the toggle state of Select for the given DataTable.
           * 
           * @returns true if the item can be deselected when clicked on, false if it cannot be.
           */
          toggleable(): boolean;

          /**
           * Set the toggle state of Select for the DataTable.
           * 
           * @param set true to allow item deselection, false to disallow.
           * @returns DataTables API instance for chaining.
           */
          toggleable(set): Api;
        };
    }

    interface RowMethods {
      /**
       * Select a row
       */
      select(): Api;
      /**
       * Deselect a row
       */
      deselect(): Api;
    }

    interface RowsMethods {
      /**
       * Select multiple rows
       */
      select(): Api;
      /**
       * Deselect a row
       */
      deselect(): Api;
    }

    interface CellMethods {
        /**
         * Select cell
         */
        select(): Api;

        /**
         * Deselect a cell
         */
        deselect(): Api;
    }

    interface CellsMethods {
        /**
         * Select multiple cells
         */
        select(): Api;

        /**
         * Deselect cells
         */
        deselect(): Api;
    }
}