add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / tree / Column.js

/**\r
 * Provides indentation and folder structure markup for a Tree taking into account\r
 * depth and position within the tree hierarchy.\r
 */\r
Ext.define('Ext.tree.Column', {\r
    extend: 'Ext.grid.column.Column',\r
    alias: 'widget.treecolumn',\r
\r
    tdCls: Ext.baseCSSPrefix + 'grid-cell-treecolumn',\r
\r
    autoLock: true,\r
    lockable: false,\r
    draggable: false,\r
    hideable: false,\r
\r
    iconCls: Ext.baseCSSPrefix + 'tree-icon',\r
    checkboxCls: Ext.baseCSSPrefix + 'tree-checkbox',\r
    elbowCls: Ext.baseCSSPrefix + 'tree-elbow',\r
    expanderCls: Ext.baseCSSPrefix + 'tree-expander',\r
    textCls: Ext.baseCSSPrefix + 'tree-node-text',\r
    innerCls: Ext.baseCSSPrefix + 'grid-cell-inner-treecolumn',\r
    customIconCls: Ext.baseCSSPrefix + 'tree-icon-custom',\r
    isTreeColumn: true,\r
\r
    cellTpl: [\r
        '<tpl for="lines">',\r
            '<div class="{parent.childCls} {parent.elbowCls}-img ',\r
            '{parent.elbowCls}-<tpl if=".">line<tpl else>empty</tpl>" role="presentation"></div>',\r
        '</tpl>',\r
        '<div class="{childCls} {elbowCls}-img {elbowCls}',\r
            '<tpl if="isLast">-end</tpl><tpl if="expandable">-plus {expanderCls}</tpl>" role="presentation"></div>',\r
        '<tpl if="checked !== null">',\r
            '<div role="button" {ariaCellCheckboxAttr}',\r
                ' class="{childCls} {checkboxCls}<tpl if="checked"> {checkboxCls}-checked</tpl>"></div>',\r
        '</tpl>',\r
        '<tpl if="icon"><img src="{blankUrl}"<tpl else><div</tpl>',\r
            ' role="presentation" class="{childCls} {baseIconCls} {customIconCls} ',\r
            '{baseIconCls}-<tpl if="leaf">leaf<tpl else><tpl if="expanded">parent-expanded<tpl else>parent</tpl></tpl> {iconCls}" ',\r
            '<tpl if="icon">style="background-image:url({icon})"/><tpl else>></div></tpl>',\r
        '<tpl if="href">',\r
            '<a href="{href}" role="link" target="{hrefTarget}" class="{textCls} {childCls}">{value}</a>',\r
        '<tpl else>',\r
            '<span class="{textCls} {childCls}">{value}</span>',\r
        '</tpl>'\r
    ],\r
\r
    // fields that will trigger a change in the ui that aren't likely to be bound to a column\r
    uiFields: {\r
        checked: 1,\r
        icon: 1,\r
        iconCls: 1\r
    },\r
\r
    // fields that requires a full row render\r
    rowFields: {\r
        expanded: 1,\r
        loaded: 1,\r
        expandable: 1,\r
        leaf: 1,\r
        loading: 1,\r
        qtip: 1,\r
        qtitle: 1,\r
        cls: 1\r
    },\r
\r
    initComponent: function() {\r
        var me = this;\r
\r
        me.rendererScope = me.scope;\r
        me.setupRenderer();\r
\r
        // This always uses its own renderer.\r
        // Any custom renderer is used as an inner renderer to produce the text node of a tree cell.\r
        me.innerRenderer = me.renderer;\r
\r
        me.renderer = me.treeRenderer;\r
\r
        me.callParent();\r
\r
        me.scope = me;\r
        \r
        me.hasCustomRenderer = me.innerRenderer && me.innerRenderer.length > 1;\r
    },\r
\r
    treeRenderer: function(value, metaData, record, rowIdx, colIdx, store, view){\r
        var me = this,\r
            cls = record.get('cls'),\r
            rendererData;\r
\r
        // The initial render will inject the cls into the TD's attributes.\r
        // If cls is ever *changed*, then the full rendering path is followed.\r
        if (metaData && cls) {\r
            metaData.tdCls += ' ' + cls;\r
        }\r
\r
        rendererData = me.initTemplateRendererData(value, metaData, record, rowIdx, colIdx, store, view);\r
        \r
        return me.getTpl('cellTpl').apply(rendererData);\r
    },\r
    \r
    initTemplateRendererData: function(value, metaData, record, rowIdx, colIdx, store, view) {\r
        var me = this,\r
            innerRenderer = me.innerRenderer,\r
            data = record.data,\r
            parent = record.parentNode,\r
            rootVisible = view.rootVisible,\r
            lines = [],\r
            parentData;\r
        \r
        while (parent && (rootVisible || parent.data.depth > 0)) {\r
            parentData = parent.data;\r
            lines[rootVisible ? parentData.depth : parentData.depth - 1] =\r
                    parentData.isLast ? 0 : 1;\r
            parent = parent.parentNode;\r
        }\r
        \r
        return {\r
            record: record,\r
            baseIconCls: me.iconCls,\r
            customIconCls: (data.icon || data.iconCls) ? me.customIconCls : '',\r
            iconCls: data.iconCls,\r
            icon: data.icon,\r
            checkboxCls: me.checkboxCls,\r
            checked: data.checked,\r
            elbowCls: me.elbowCls,\r
            expanderCls: me.expanderCls,\r
            textCls: me.textCls,\r
            leaf: data.leaf,\r
            expandable: record.isExpandable(),\r
            expanded: data.expanded,\r
            isLast: record.isLastVisible(),\r
            blankUrl: Ext.BLANK_IMAGE_URL,\r
            href: data.href,\r
            hrefTarget: data.hrefTarget,\r
            lines: lines,\r
            metaData: metaData,\r
            // subclasses or overrides can implement a getChildCls() method, which can\r
            // return an extra class to add to all of the cell's child elements (icon,\r
            // expander, elbow, checkbox).  This is used by the rtl override to add the\r
            // "x-rtl" class to these elements.\r
            childCls: me.getChildCls ? me.getChildCls() + ' ' : '',\r
            value: innerRenderer ? innerRenderer.apply(me.rendererScope, arguments) : value\r
        };\r
    },\r
\r
    shouldUpdateCell: function(record, changedFieldNames) {\r
        // For the TreeColumn, if any of the known tree column UI affecting fields are updated\r
        // the cell should be updated in whatever way.\r
        // 1 if a custom renderer (not our default tree cell renderer), else 2.\r
        var me = this,\r
            i = 0,\r
            len, field;\r
\r
        if (changedFieldNames) {\r
            len = changedFieldNames.length;\r
\r
            for (; i < len; ++i) {\r
                field = changedFieldNames[i];\r
                // Check for fields which always require a full row update.\r
                if (me.rowFields[field]) {\r
                    return 1;\r
                }\r
\r
                // Check for fields which require this column to be updated.\r
                // The TreeColumn's treeRenderer is not a custom renderer.\r
                if (me.uiFields[field]) {\r
                    return 2;\r
                }\r
            }\r
        }\r
\r
        return me.callParent([record, changedFieldNames]);\r
    }\r
});\r