add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / grid / column / Template.js

/**\r
 * A Column definition class which renders a value by processing a {@link Ext.data.Model Model}'s\r
 * {@link Ext.data.Model#getData data} using a {@link #tpl configured}\r
 * {@link Ext.XTemplate XTemplate}.\r
 *\r
 *     @example\r
 *     Ext.create('Ext.data.Store', {\r
 *         storeId:'employeeStore',\r
 *         fields:['firstname', 'lastname', 'seniority', 'department'],\r
 *         groupField: 'department',\r
 *         data:[\r
 *             { firstname: "Michael", lastname: "Scott",   seniority: 7, department: "Management" },\r
 *             { firstname: "Dwight",  lastname: "Schrute", seniority: 2, department: "Sales" },\r
 *             { firstname: "Jim",     lastname: "Halpert", seniority: 3, department: "Sales" },\r
 *             { firstname: "Kevin",   lastname: "Malone",  seniority: 4, department: "Accounting" },\r
 *             { firstname: "Angela",  lastname: "Martin",  seniority: 5, department: "Accounting" }\r
 *         ]\r
 *     });\r
 *\r
 *     Ext.create('Ext.grid.Panel', {\r
 *         title: 'Column Template Demo',\r
 *         store: Ext.data.StoreManager.lookup('employeeStore'),\r
 *         columns: [\r
 *             { text: 'Full Name',       xtype: 'templatecolumn', tpl: '{firstname} {lastname}', flex:1 },\r
 *             { text: 'Department (Yrs)', xtype: 'templatecolumn', tpl: '{department} ({seniority})' }\r
 *         ],\r
 *         height: 200,\r
 *         width: 300,\r
 *         renderTo: Ext.getBody()\r
 *     });\r
 */\r
Ext.define('Ext.grid.column.Template', {\r
    extend: 'Ext.grid.column.Column',\r
    alias: ['widget.templatecolumn'],\r
    requires: ['Ext.XTemplate'],\r
    alternateClassName: 'Ext.grid.TemplateColumn',\r
\r
    /**\r
     * @cfg {String/Ext.XTemplate} tpl\r
     * An {@link Ext.XTemplate XTemplate}, or an XTemplate *definition string* to use to process a\r
     * {@link Ext.data.Model Model}'s data object to produce a cell's rendered value.\r
     */\r
\r
    /**\r
     * @cfg {Object} renderer\r
     * @hide\r
     */\r
\r
    /**\r
     * @cfg {Object} scope\r
     * @hide\r
     */\r
\r
    initComponent: function(){\r
        var me = this;\r
        me.tpl = (!Ext.isPrimitive(me.tpl) && me.tpl.compile) ? me.tpl : new Ext.XTemplate(me.tpl);\r
        // Set this here since the template may access any record values,\r
        // so we must always run the update for this column\r
        me.hasCustomRenderer = true;\r
        me.callParent(arguments);\r
    },\r
\r
    defaultRenderer: function(value, meta, record) {\r
        var data = Ext.apply({}, record.data, record.getAssociatedData());\r
        return this.tpl.apply(data);\r
    },\r
\r
    updater: function(cell, value) {\r
        Ext.fly(cell).down(this.getView().innerSelector, true).innerHTML = Ext.grid.column.CheckColumn.prototype.defaultRenderer.call(this, value);\r
    }\r
});\r