add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / grid / selection / Cells.js

/**\r
 * A class which encapsulates a range of cells defining a selection in a grid.\r
 *\r
 * Note that when range start and end points are represented by an array, the\r
 * order is traditional `x, y` order, that is column index followed by row index.\r
 * @since 5.1.0\r
 */\r
Ext.define('Ext.grid.selection.Cells', {\r
    extend: 'Ext.grid.selection.Selection',\r
\r
    type: 'cells',\r
\r
    /**\r
     * @property {Boolean} isCells\r
     * This property indicates the this selection represents selected cells.\r
     * @readonly\r
     */\r
    isCells: true,\r
\r
    //-------------------------------------------------------------------------\r
    // Base Selection API\r
\r
    clone: function() {\r
        var me = this,\r
            result = new me.self(me.view);\r
\r
        if (me.startCell) {\r
            result.startCell = me.startCell.clone();\r
            result.endCell = me.endCell.clone();\r
        }\r
        return result;\r
    },\r
\r
    /**\r
     * Returns `true` if the passed {@link Ext.grid.CellContext cell context} is selected.\r
     * @param {Ext.grid.CellContext} cellContext The cell context to test.\r
     * @return {Boolean} `true` if the passed {@link Ext.grid.CellContext cell context} is selected.\r
     */\r
    contains: function(cellContext) {\r
        var range;\r
\r
        if (!cellContext || !cellContext.isCellContext) {\r
            return false;\r
        }\r
\r
        if (this.startCell) {\r
            // get start and end rows in the range\r
            range = this.getRowRange();\r
\r
            if (cellContext.rowIdx >= range[0] && cellContext.rowIdx <= range[1]) {\r
                // get start and end columns in the range\r
                range = this.getColumnRange();\r
                return (cellContext.colIdx >= range[0] && cellContext.colIdx <= range[1]);\r
            }\r
        }\r
\r
        return false;\r
    },\r
\r
    eachRow: function(fn, scope) {\r
        var me = this,\r
            rowRange = me.getRowRange(),\r
            context = new Ext.grid.CellContext(me.view),\r
            rowIdx;\r
\r
        for (rowIdx = rowRange[0]; rowIdx <= rowRange[1]; rowIdx++) {\r
            context.setRow(rowIdx);\r
            if (fn.call(scope || me, context.record) === false) {\r
                return;\r
            }\r
        }\r
    },\r
\r
    eachColumn: function(fn, scope) {\r
        var me = this,\r
            colRange = me.getColumnRange(),\r
            context = new Ext.grid.CellContext(me.view),\r
            colIdx;\r
\r
        for (colIdx = colRange[0]; colIdx <= colRange[1]; colIdx++) {\r
            context.setColumn(colIdx);\r
            if (fn.call(scope || me, context.column, colIdx) === false) {\r
                return;\r
            }\r
        }\r
    },\r
\r
    eachCell: function(fn, scope) {\r
        var me = this,\r
            rowRange = me.getRowRange(),\r
            colRange = me.getColumnRange(),\r
            context = new Ext.grid.CellContext(me.view),\r
            rowIdx, colIdx;\r
\r
        for (rowIdx = rowRange[0]; rowIdx <= rowRange[1]; rowIdx++) {\r
            context.setRow(rowIdx);\r
            for (colIdx = colRange[0]; colIdx <= colRange[1]; colIdx++) {\r
                context.setColumn(colIdx);\r
                if (fn.call(scope || me, context, colIdx, rowIdx) === false) {\r
                    return;\r
                }\r
            }\r
        }\r
    },\r
\r
    /**\r
     * @return {Number} The row index of the first row in the range or zero if no range.\r
     */\r
    getFirstRowIndex: function() {\r
        return this.startCell ? Math.min(this.startCell.rowIdx, this.endCell.rowIdx) : 0;\r
    },\r
\r
    /**\r
     * @return {Number} The row index of the last row in the range or -1 if no range.\r
     */\r
    getLastRowIndex: function() {\r
        return this.startCell ? Math.max(this.startCell.rowIdx, this.endCell.rowIdx) : -1;\r
    },\r
\r
    /**\r
     * @return {Number} The column index of the first column in the range or zero if no range.\r
     */\r
    getFirstColumnIndex: function() {\r
        return this.startCell ? Math.min(this.startCell.colIdx, this.endCell.colIdx) : 0;\r
    },\r
\r
    /**\r
     * @return {Number} The column index of the last column in the range or -1 if no range.\r
     */\r
    getLastColumnIndex: function() {\r
        return this.startCell ? Math.max(this.startCell.colIdx, this.endCell.colIdx) : -1;\r
    },\r
\r
    //-------------------------------------------------------------------------\r
\r
    privates: {\r
        /**\r
         * @private\r
         */\r
        clear: function() {\r
            var me = this,\r
                view = me.view;\r
\r
            me.eachCell(function(cellContext) {\r
                view.onCellDeselect(cellContext);\r
            });\r
            me.startCell = me.endCell = null;\r
        },\r
\r
        /**\r
         * Used during drag/shift+downarrow range selection on start.\r
         * @param {Ext.grid.CellContext} startCell The start cell of the cell drag selection.\r
         * @private\r
         */\r
        setRangeStart: function (startCell, endCell) {\r
            // Must clone them. Users might use one instance and reconfigure it to navigate.\r
            this.startCell = (this.endCell = startCell.clone()).clone();\r
            this.view.onCellSelect(startCell);\r
        },\r
\r
        /**\r
         * Used during drag/shift+downarrow range selection on drag.\r
         * @param {Ext.grid.CellContext} endCell The end cell of the cell drag selection.\r
         * @private\r
         */\r
        setRangeEnd: function (endCell) {\r
            var me = this,\r
                range,\r
                lastRange,\r
                rowStart,\r
                rowEnd,\r
                colStart,\r
                colEnd,\r
                rowIdx,\r
                colIdx,\r
                view = me.view,\r
                rows = view.all,\r
                cell = new Ext.grid.CellContext(view),\r
                maxColIdx = view.getVisibleColumnManager().getColumns().length - 1;\r
\r
            me.endCell = endCell.clone();\r
            range = me.getRange();\r
            lastRange = me.lastRange || range;\r
\r
            rowStart = Math.max(Math.min(range[0][1], lastRange[0][1]), rows.startIndex);\r
            rowEnd   = Math.min(Math.max(range[1][1], lastRange[1][1]), rows.endIndex);\r
\r
            colStart = Math.min(range[0][0], lastRange[0][0]);\r
            colEnd   = Math.min(Math.max(range[1][0], lastRange[1][0]), maxColIdx);\r
\r
            // Loop through the union of last range and current range\r
            for (rowIdx = rowStart; rowIdx <= rowEnd; rowIdx++) {\r
                for (colIdx = colStart; colIdx <= colEnd; colIdx++) {\r
                    cell.setPosition(rowIdx, colIdx);\r
\r
                    // If we are outside the current range, deselect\r
                    if (rowIdx < range[0][1] || rowIdx > range[1][1] || colIdx < range[0][0] || colIdx > range[1][0]) {\r
                        view.onCellDeselect(cell);\r
                    } else {\r
                        view.onCellSelect(cell);\r
                    }\r
                }\r
            }\r
            me.lastRange = range;\r
        },\r
\r
        extendRange: function(extensionVector) {\r
            var me = this,\r
                newEndCell;\r
\r
            if (extensionVector[extensionVector.type] < 0) {\r
                newEndCell = me.endCell.clone().setPosition(me.getLastRowIndex(), me.getLastColumnIndex());\r
                me.startCell = extensionVector.start.clone();\r
                me.setRangeEnd(newEndCell);\r
                me.view.getNavigationModel().setPosition(extensionVector.start);\r
            } else {\r
                me.startCell = me.startCell.setPosition(me.getFirstRowIndex(), me.getFirstColumnIndex());\r
                me.setRangeEnd(extensionVector.end);\r
                me.view.getNavigationModel().setPosition(extensionVector.end);\r
            }\r
        },\r
\r
        /**\r
         * Returns the `[[x, y],[x,y]]` coordinates in top-left to bottom-right order\r
         * of the current selection.\r
         *\r
         * If no selection, returns [[0, 0],[-1, -1]] so that an incrementing iteration\r
         * will not execute.\r
         *\r
         * @return {Number[][]}\r
         * @private\r
         */\r
        getRange: function() {\r
            return [[this.getFirstColumnIndex(), this.getFirstRowIndex()], [this.getLastColumnIndex(), this.getLastRowIndex()]];\r
        },\r
\r
        /**\r
         * Returns the size of the selection rectangle.\r
         * @return {Number}\r
         * @private\r
         */\r
        getRangeSize: function() {\r
            return this.getCount();\r
        },\r
\r
        /**\r
         * Returns the number of cells selected.\r
         * @return {Number} The nuimber of cells selected\r
         * @private\r
         */\r
        getCount: function() {\r
            var range = this.getRange();\r
\r
            return (range[1][0] - range[0][0] + 1) * (range[1][1] - range[0][1] + 1);\r
        },\r
\r
        /**\r
         * @private\r
         */\r
        selectAll: function() {\r
            var me = this,\r
                view = me.view;\r
\r
            me.clear();\r
            me.setRangeStart(new Ext.grid.CellContext(view).setPosition(0, 0));\r
            me.setRangeEnd(new Ext.grid.CellContext(view).setPosition(view.dataSource.getCount() - 1, view.getVisibleColumnManager().getColumns().length - 1));\r
        },\r
\r
        /**\r
         * @return {Boolean}\r
         * @private\r
         */\r
        isAllSelected: function() {\r
            var start = this.rangeStart,\r
                end = this.rangeEnd;\r
\r
            // All selected only if we encompass the entire store and every visible column\r
            if (start) {\r
                if (!start.colIdx && !start.rowIdx) {\r
                    return end.colIdx === end.view.getVisibleColumnManager().getColumns().length - 1 && end.rowIdx === end.view.dataSource.getCount - 1;\r
                }\r
            }\r
            return false;\r
        },\r
\r
        /**\r
         * @return {Number[]} The column range which encapsulates the range.\r
         * @private\r
         */\r
        getColumnRange: function() {\r
            return [this.getFirstColumnIndex(), this.getLastColumnIndex()];\r
        },\r
\r
        /**\r
         * Returns the row range which encapsulates the range - the view range that needs\r
         * updating.\r
         * @return {Number[]}\r
         * @private\r
         */\r
        getRowRange: function() {\r
            return [this.getFirstRowIndex(), this.getLastRowIndex()];\r
        },\r
\r
        onSelectionFinish: function() {\r
            var me = this;\r
\r
            if (me.getCount()) {\r
                me.view.getSelectionModel().onSelectionFinish(me,\r
                    new Ext.grid.CellContext(me.view).setPosition(me.getFirstRowIndex(), me.getFirstColumnIndex()),\r
                    new Ext.grid.CellContext(me.view).setPosition(me.getLastRowIndex(), me.getLastColumnIndex()));\r
            } else {\r
                me.view.getSelectionModel().onSelectionFinish(me);\r
            }\r
        }\r
    }\r
});\r