add extjs 6.0.1 sources

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

/**\r
 * A class which encapsulates a range of columns defining a selection in a grid.\r
 * @since 5.1.0\r
 */\r
Ext.define('Ext.grid.selection.Columns', {\r
    extend: 'Ext.grid.selection.Selection',\r
\r
    type: 'columns',\r
\r
    /**\r
     * @property {Boolean} isColumns\r
     * This property indicates the this selection represents selected columns.\r
     * @readonly\r
     */\r
    isColumns: true,\r
\r
    //-------------------------------------------------------------------------\r
    // Base Selection API\r
\r
    clone: function() {\r
        var me = this,\r
            result = new me.self(me.view),\r
            columns = me.selectedColumns;\r
\r
        if (columns) {\r
            result.selectedColumns = Ext.Array.slice(columns);\r
        }\r
        return result;\r
    },\r
\r
    eachRow: function (fn, scope) {\r
        var columns = this.selectedColumns;\r
\r
        if (columns && columns.length) {\r
            this.view.dataSource.each(fn, scope || this);\r
        }\r
    },\r
\r
    eachColumn: function (fn, scope) {\r
        var me = this,\r
            view = me.view,\r
            columns = me.selectedColumns,\r
            len,\r
            i,\r
            context = new Ext.grid.CellContext(view);\r
\r
        if (columns) {\r
            len = columns.length;\r
            for (i = 0; i < len; i++) {\r
                context.setColumn(columns[i]);\r
                if (fn.call(scope || me, context.column, context.colIdx) === false) {\r
                    return false;\r
                }\r
            }\r
        }\r
    },\r
\r
    eachCell: function (fn, scope) {\r
        var me = this,\r
            view = me.view,\r
            columns = me.selectedColumns,\r
            len,\r
            i,\r
            context = new Ext.grid.CellContext(view);\r
\r
        if (columns) {\r
            len = columns.length;\r
\r
            // Use Store#each instead of copying the entire dataset into an array and iterating that.\r
            view.dataSource.each(function(record) {\r
                context.setRow(record);\r
                for (i = 0; i < len; i++) {\r
                    context.setColumn(columns[i]);\r
                    if (fn.call(scope || me, context, context.colIdx, context.rowIdx) === false) {\r
                        return false;\r
                    }\r
                }\r
            });\r
        }\r
    },\r
\r
    //-------------------------------------------------------------------------\r
    // Methods unique to this type of Selection\r
\r
    /**\r
     * Returns `true` if the passed {@link Ext.grid.column.Column column} is selected.\r
     * @param {Ext.grid.column.Column} column The column to test.\r
     * @return {Boolean} `true` if the passed {@link Ext.grid.column.Column column} is selected.\r
     */\r
    contains: function(column) {\r
        var selectedColumns = this.selectedColumns;\r
\r
        if (column && column.isColumn && selectedColumns && selectedColumns.length) {\r
            return Ext.Array.contains(selectedColumns, column);\r
        }\r
\r
        return false;\r
    },\r
\r
    /**\r
     * Returns the number of columns selected.\r
     * @return {Number} The number of columns selected.\r
     */\r
    getCount: function() {\r
        var selectedColumns = this.selectedColumns;\r
        return selectedColumns ? selectedColumns.length : 0;\r
    },\r
\r
    /**\r
     * Returns the columns selected.\r
     * @return {Ext.grid.column.Column[]} The columns selected.\r
     */\r
    getColumns: function() {\r
        return this.selectedColumns || [];\r
    },\r
\r
    //-------------------------------------------------------------------------\r
\r
    privates: {\r
        /**\r
         * Adds the passed Column to the selection.\r
         * @param {Ext.grid.column.Column} column\r
         * @private\r
         */\r
        add: function(column) {\r
            //<debug>\r
            if (!column.isColumn) {\r
                Ext.raise('Column selection must be passed a grid Column header object');\r
            }\r
            //</debug>\r
\r
            Ext.Array.include((this.selectedColumns || (this.selectedColumns = [])), column);\r
            this.refreshColumns(column);\r
        },\r
\r
        /**\r
         * @private\r
         */\r
        clear: function() {\r
            var me = this,\r
                prevSelection = me.selectedColumns;\r
\r
            if (prevSelection && prevSelection.length) {\r
                me.selectedColumns = [];\r
                me.refreshColumns.apply(me, prevSelection);\r
            }\r
        },\r
\r
        /**\r
         * @return {Boolean}\r
         * @private\r
         */\r
        isAllSelected: function() {\r
            var selectedColumns = this.selectedColumns;\r
\r
            // All selected means all columns, across both views if we are in a locking assembly.\r
            return selectedColumns && selectedColumns.length === this.view.ownerGrid.getVisibleColumnManager().getColumns().length;\r
        },\r
\r
        /**\r
         * @private\r
         */\r
        refreshColumns: function(column) {\r
            var me = this,\r
                view = me.view,\r
                rows = view.all,\r
                rowIdx,\r
                columns = arguments,\r
                len = columns.length,\r
                colIdx,\r
                cellContext = new Ext.grid.CellContext(view),\r
                selected = [];\r
\r
            if (view.rendered) {\r
                for (colIdx = 0; colIdx < len; colIdx++) {\r
                    selected[colIdx] = me.contains(columns[colIdx]);\r
                }\r
\r
                for (rowIdx = rows.startIndex; rowIdx <= rows.endIndex; rowIdx++) {\r
                    cellContext.setRow(rowIdx);\r
                    for (colIdx = 0; colIdx < len; colIdx++) {\r
                        // Note colIdx is not the column's visible index. setColumn must be passed the column object\r
                        cellContext.setColumn(columns[colIdx]);\r
                        if (selected[colIdx]) {\r
                            view.onCellSelect(cellContext);\r
                        } else {\r
                            view.onCellDeselect(cellContext);\r
                        }\r
                    }\r
                }\r
            }\r
        },\r
\r
        /**\r
         * Removes the passed Column from the selection.\r
         * @param {Ext.grid.column.Column} column\r
         * @private\r
         */\r
        remove: function(column) {\r
            //<debug>\r
            if (!column.isColumn) {\r
                Ext.raise('Column selection must be passed a grid Column header object');\r
            }\r
            //</debug>\r
\r
            if (this.selectedColumns) {\r
                Ext.Array.remove(this.selectedColumns, column);\r
\r
                // Might be being called because of column removal/hiding.\r
                // In which case the view will have selected cells removed, so no refresh needed.\r
                if (column.getView() && column.isVisible()) {\r
                    this.refreshColumns(column);\r
                }\r
            }\r
        },\r
\r
        /**\r
         * @private\r
         */\r
        selectAll: function () {\r
            var me = this;\r
\r
            me.clear();\r
            me.selectedColumns = me.view.getSelectionModel().lastContiguousColumnRange =\r
                me.view.getVisibleColumnManager().getColumns();\r
            me.refreshColumns.apply(me, me.selectedColumns);\r
        },\r
\r
        extendRange: function(extensionVector) {\r
            var me = this,\r
                columns = me.view.getVisibleColumnManager().getColumns(),\r
                i;\r
\r
            for (i = extensionVector.start.colIdx; i <=  extensionVector.end.colIdx; i++) {\r
                me.add(columns[i]);\r
            }\r
        },\r
\r
        onSelectionFinish: function() {\r
            var me = this,\r
                range = me.getContiguousSelection();\r
\r
            if (range) {\r
                me.view.getSelectionModel().onSelectionFinish(me,\r
                    new Ext.grid.CellContext(me.view).setPosition(0, range[0]),\r
                    new Ext.grid.CellContext(me.view).setPosition(me.view.dataSource.getCount() - 1, range[1]));\r
            } else {\r
                me.view.getSelectionModel().onSelectionFinish(me);\r
            }\r
        },\r
\r
        /**\r
         * @return {Array} `[startColumn, endColumn]` if the selection represents a visually contiguous set of columns.\r
         * The SelectionReplicator is only enabled if there is a contiguous block.\r
         * @private\r
         */\r
        getContiguousSelection: function() {\r
            var selection = Ext.Array.sort(this.selectedColumns, function(c1, c2) {\r
                    // Use index *in ownerGrid* so that a locking assembly can order columns correctly\r
                    return c1.getView().ownerGrid.getVisibleColumnManager().indexOf(c1) - c2.getView().ownerGrid.getVisibleColumnManager().indexOf(c2);\r
                }),\r
                len = selection.length,\r
                i;\r
\r
            if (len) {\r
                for (i = 1; i < len; i++) {\r
                    if (selection[i].getVisibleIndex() !== selection[i - 1].getVisibleIndex() + 1) {\r
                        return false;\r
                    }\r
                }\r
                return [selection[0], selection[len - 1]];\r
            }\r
        }\r
    }\r
});\r