add extjs 6.0.1 sources

[extjs.git] / extjs / packages / ux / classic / src / PreviewPlugin.js

/**\r
 * The Preview Plugin enables toggle of a configurable preview of all visible records.\r
 *\r
 * Note: This plugin does NOT assert itself against an existing RowBody feature and may conflict with\r
 * another instance of the same plugin.\r
 */\r
Ext.define('Ext.ux.PreviewPlugin', {\r
    extend: 'Ext.plugin.Abstract',\r
    alias: 'plugin.preview',\r
    requires: ['Ext.grid.feature.RowBody'],\r
    \r
    /**\r
     * @private\r
     * css class to use to hide the body\r
     */\r
    hideBodyCls: 'x-grid-row-body-hidden',\r
    \r
    /**\r
     * @cfg {String} bodyField\r
     * Field to display in the preview. Must be a field within the Model definition\r
     * that the store is using.\r
     */\r
    bodyField: '',\r
    \r
    /**\r
     * @cfg {Boolean} previewExpanded\r
     */\r
    previewExpanded: true,\r
\r
    /**\r
     * Plugin may be safely declared on either a panel.Grid or a Grid View/viewConfig\r
     * @param {Ext.grid.Panel/Ext.view.View} target\r
     */\r
    setCmp: function(target) {\r
        this.callParent(arguments);\r
\r
        // Resolve grid from view as necessary\r
        var me = this,\r
            grid        = me.cmp = target.isXType('gridview') ? target.grid : target,\r
            bodyField   = me.bodyField,\r
            hideBodyCls = me.hideBodyCls,\r
            feature     = Ext.create('Ext.grid.feature.RowBody', {\r
                grid : grid,\r
                getAdditionalData: function(data, idx, model, rowValues) {\r
\r
                    var getAdditionalData = Ext.grid.feature.RowBody.prototype.getAdditionalData,\r
                        additionalData = {\r
                            rowBody: data[bodyField],\r
                            rowBodyCls: grid.getView().previewExpanded ? '' : hideBodyCls\r
                        };\r
\r
                    if (Ext.isFunction(getAdditionalData)) {\r
                        // "this" is the RowBody object hjere. Do not change to "me"\r
                        Ext.apply(additionalData, getAdditionalData.apply(this, arguments));\r
                    }\r
                    return additionalData;\r
                }\r
            }),\r
            initFeature = function(grid, view) {\r
                view.previewExpanded = me.previewExpanded;\r
\r
                // By this point, existing features are already in place, so this must be initialized and added\r
                view.featuresMC.add(feature);\r
                feature.init(grid);\r
            };\r
\r
        // The grid has already created its view\r
        if (grid.view) {\r
            initFeature(grid, grid.view);\r
        }\r
\r
        // At the time a grid creates its plugins, it has not created all the things\r
        // it needs to create its view correctly.\r
        // Process the view and init the RowBody Feature as soon as the view is created.\r
        else {\r
            grid.on({\r
                viewcreated: initFeature,\r
                single: true\r
            });\r
        }\r
    },\r
\r
    /**\r
     * Toggle between the preview being expanded/hidden on all rows\r
     * @param {Boolean} expanded Pass true to expand the record and false to not show the preview.\r
     */\r
    toggleExpanded: function(expanded) {\r
        var grid = this.getCmp(),\r
            view = grid && grid.getView(),\r
            bufferedRenderer = view.bufferedRenderer,\r
            scrollManager = view.scrollManager;\r
\r
        if (grid && view && expanded !== view.previewExpanded ) {\r
            this.previewExpanded = view.previewExpanded = !!expanded;\r
            view.refreshView();\r
\r
            // If we are using the touch scroller, ensure that the scroller knows about\r
            // the correct scrollable range\r
            if (scrollManager) {\r
                if (bufferedRenderer) {\r
                    bufferedRenderer.stretchView(view, bufferedRenderer.getScrollHeight(true));\r
                } else {\r
                    scrollManager.refresh(true);\r
                }\r
            }\r
        }\r
    }\r
});\r