add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / grid / plugin / Clipboard.js

/**\r
 * This {@link Ext.grid.Panel grid} plugin adds clipboard support to a grid.\r
 *\r
 * *Note that the grid must use the {@link Ext.grid.selection.SpreadsheetModel spreadsheet selection model} to utilize this plugin.*\r
 *\r
 * This class supports the following `{@link Ext.plugin.AbstractClipboard#formats formats}`\r
 * for grid data:\r
 *\r
 *  * `cell` - Complete field data that can be matched to other grids using the same\r
 *    {@link Ext.data.Model model} regardless of column order.\r
 *  * `text` - Cell content stripped of HTML tags.\r
 *  * `html` - Complete cell content, including any rendered HTML tags.\r
 *  * `raw` - Underlying field values based on `dataIndex`.\r
 *\r
 * The `cell` format is not valid for the `{@link Ext.plugin.AbstractClipboard#system system}`\r
 * clipboard format.\r
 */\r
Ext.define('Ext.grid.plugin.Clipboard', {\r
    extend: 'Ext.plugin.AbstractClipboard',\r
\r
    alias: 'plugin.clipboard',\r
    requires: [\r
        'Ext.util.Format',\r
        'Ext.util.TSV'\r
    ],\r
\r
    formats: {\r
        cell: {\r
            get: 'getCells'\r
        },\r
        html: {\r
            get: 'getCellData'\r
        },\r
        raw: {\r
            get: 'getCellData'\r
        }\r
    },\r
\r
    getCellData: function (format, erase) {\r
        var cmp = this.getCmp(),\r
            selModel = cmp.getSelectionModel(),\r
            ret = [],\r
            isRaw = format === 'raw',\r
            isText = format === 'text',\r
            viewNode,\r
            cell, data, dataIndex, lastRecord, column, record, row, view;\r
\r
        selModel.getSelected().eachCell(function (cellContext) {\r
            column = cellContext.column,\r
            view = cellContext.column.getView();\r
            record = cellContext.record;\r
\r
            // Do not copy the check column or row numberer column\r
            if (column.ignoreExport) {\r
                return;\r
            }\r
\r
            if (lastRecord !== record) {\r
                lastRecord = record;\r
                ret.push(row = []);\r
            }\r
            \r
            dataIndex = column.dataIndex;\r
\r
            if (isRaw) {\r
                data = record.data[dataIndex];\r
            } else {\r
                // Try to access the view node.\r
                viewNode = view.all.item(cellContext.rowIdx);\r
                // If we could not, it's because it's outside of the rendered block - recreate it.\r
                if (!viewNode) {\r
                    viewNode = Ext.fly(view.createRowElement(record, cellContext.rowIdx));\r
                }\r
                cell = viewNode.down(column.getCellInnerSelector());\r
                data = cell.dom.innerHTML;\r
                if (isText) {\r
                    data = Ext.util.Format.stripTags(data);\r
                }\r
            }\r
\r
            row.push(data);\r
\r
            if (erase && dataIndex) {\r
                record.set(dataIndex, null);\r
            }\r
        });\r
\r
        return Ext.util.TSV.encode(ret);\r
    },\r
\r
    getCells: function (format, erase) {\r
        var cmp = this.getCmp(),\r
            selModel = cmp.getSelectionModel(),\r
            ret = [],\r
            dataIndex, lastRecord, record, row;\r
\r
        selModel.getSelected().eachCell(function (cellContext) {\r
            record = cellContext.record;\r
            if (lastRecord !== record) {\r
                lastRecord = record;\r
                ret.push(row = {\r
                    model: record.self,\r
                    fields: []\r
                });\r
            }\r
\r
            dataIndex = cellContext.column.dataIndex;\r
\r
            row.fields.push({\r
                name: dataIndex,\r
                value: record.data[dataIndex]\r
            });\r
\r
            if (erase && dataIndex) {\r
                record.set(dataIndex, null);\r
            }\r
        });\r
\r
        return ret;\r
    },\r
\r
    getTextData: function (format, erase) {\r
        return this.getCellData(format, erase);\r
    },\r
\r
    putCellData: function (data, format) {\r
        var values = Ext.util.TSV.decode(data),\r
            row,\r
            recCount = values.length,\r
            colCount = recCount ? values[0].length : 0,\r
            sourceRowIdx, sourceColIdx,\r
            view = this.getCmp().getView(),\r
            maxRowIdx = view.dataSource.getCount() - 1,\r
            maxColIdx = view.getVisibleColumnManager().getColumns().length - 1,\r
            navModel = view.getNavigationModel(),\r
            destination = navModel.getPosition(),\r
            dataIndex, destinationStartColumn,\r
            dataObject = {};\r
\r
        // If the view is not focused, use the first cell of the selection as the destination.\r
        if (!destination) {\r
            view.getSelectionModel().getSelected().eachCell(function(c){\r
                destination = c;\r
                return false;\r
            });\r
        }\r
\r
        if (destination) {\r
            // Create a new Context based upon the outermost View.\r
            // NavigationModel works on local views. TODO: remove this step when NavModel is fixed to use outermost view in locked grid.\r
            // At that point, we can use navModel.getPosition()\r
            destination = new Ext.grid.CellContext(view).setPosition(destination.record, destination.column);\r
        } else {\r
            destination = new Ext.grid.CellContext(view).setPosition(0, 0);\r
        }\r
        destinationStartColumn = destination.colIdx;\r
\r
        for (sourceRowIdx = 0; sourceRowIdx < recCount; sourceRowIdx++) {\r
            row = values[sourceRowIdx];\r
\r
            // Collect new values in dataObject\r
            for (sourceColIdx = 0; sourceColIdx < colCount; sourceColIdx++) {\r
                dataIndex = destination.column.dataIndex;\r
                if (dataIndex) {\r
                    switch (format) {\r
                        // Raw field values\r
                        case 'raw':\r
                            dataObject[dataIndex] = row[sourceColIdx];\r
                            break;\r
\r
                        // Textual data with HTML tags stripped    \r
                        case 'text':\r
                            dataObject[dataIndex] = row[sourceColIdx];\r
                            break;\r
\r
                        // innerHTML from the cell inner\r
                        case 'html':\r
                            break;\r
                    }\r
                }\r
                // If we are at the end of the destination row, break the column loop.\r
                if (destination.colIdx === maxColIdx) {\r
                    break;\r
                }\r
                destination.setColumn(destination.colIdx + 1);\r
            }\r
\r
            // Update the record in one go.\r
            destination.record.set(dataObject);\r
\r
            // If we are at the end of the destination store, break the row loop.\r
            if (destination.rowIdx === maxRowIdx) {\r
                break;\r
            }\r
\r
            // Jump to next row in destination\r
            destination.setPosition(destination.rowIdx + 1, destinationStartColumn);\r
        }\r
    },\r
\r
    putTextData: function (data, format) {\r
        this.putCellData(data, format);\r
    },\r
\r
    getTarget: function(comp) {\r
        return comp.body;\r
    }\r
});\r