add extjs 6.0.1 sources

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

/**\r
 * @class Ext.ux.DataTip\r
 * @extends Ext.ToolTip.\r
 * This plugin implements automatic tooltip generation for an arbitrary number of child nodes *within* a Component.\r
 *\r
 * This plugin is applied to a high level Component, which contains repeating elements, and depending on the host Component type,\r
 * it automatically selects a {@link Ext.ToolTip#delegate delegate} so that it appears when the mouse enters a sub-element.\r
 *\r
 * When applied to a GridPanel, this ToolTip appears when over a row, and the Record's data is applied\r
 * using this object's {@link #tpl} template.\r
 *\r
 * When applied to a DataView, this ToolTip appears when over a view node, and the Record's data is applied\r
 * using this object's {@link #tpl} template.\r
 *\r
 * When applied to a TreePanel, this ToolTip appears when over a tree node, and the Node's {@link Ext.data.Model} record data is applied\r
 * using this object's {@link #tpl} template.\r
 *\r
 * When applied to a FormPanel, this ToolTip appears when over a Field, and the Field's `tooltip` property is used is applied\r
 * using this object's {@link #tpl} template, or if it is a string, used as HTML content. If there is no `tooltip` property,\r
 * the field itself is used as the template's data object.\r
 *\r
 * If more complex logic is needed to determine content, then the {@link #beforeshow} event may be used.\r
 * This class also publishes a **`beforeshowtip`** event through its host Component. The *host Component* fires the\r
 * **`beforeshowtip`** event.\r
 */\r
Ext.define('Ext.ux.DataTip', function(DataTip) {\r
\r
//  Target the body (if the host is a Panel), or, if there is no body, the main Element.\r
    function onHostRender() {\r
        var e = this.isXType('panel') ? this.body : this.el;\r
        if (this.dataTip.renderToTarget) {\r
            this.dataTip.render(e);\r
        }\r
        this.dataTip.setTarget(e);\r
    }\r
\r
    function updateTip(tip, data) {\r
        if (tip.rendered) {\r
            if (tip.host.fireEvent('beforeshowtip', tip.eventHost, tip, data) === false) {\r
                return false;\r
            }\r
            tip.update(data);\r
        } else {\r
            if (Ext.isString(data)) {\r
                tip.html = data;\r
            } else {\r
                tip.data = data;\r
            }\r
        }\r
    }\r
\r
    function beforeViewTipShow(tip) {\r
        var rec = this.view.getRecord(tip.triggerElement),\r
            data;\r
\r
        if (rec) {\r
            data = tip.initialConfig.data ? Ext.apply(tip.initialConfig.data, rec.data) : rec.data;\r
            return updateTip(tip, data);\r
        } else {\r
            return false;\r
        }\r
    }\r
\r
    function beforeFormTipShow(tip) {\r
        var field = Ext.getCmp(tip.triggerElement.id);\r
        if (field && (field.tooltip || tip.tpl)) {\r
            return updateTip(tip, field.tooltip || field);\r
        } else {\r
            return false;\r
        }\r
    }\r
\r
    return {\r
        extend: 'Ext.tip.ToolTip',\r
\r
        mixins: {\r
            plugin: 'Ext.plugin.Abstract'\r
        },\r
\r
        alias: 'plugin.datatip',\r
\r
        lockableScope: 'both',\r
\r
        constructor: function(config) {\r
            var me = this;\r
            me.callParent([config]);\r
            me.mixins.plugin.constructor.call(me, config);\r
        },\r
\r
        init: function(host) {\r
            var me = this;\r
\r
            me.mixins.plugin.init.call(me, host);\r
            host.dataTip = me;\r
            me.host = host;\r
\r
            if (host.isXType('tablepanel')) {\r
                me.view = host.getView();\r
                if (host.ownerLockable) {\r
                    me.host = host.ownerLockable;\r
                }\r
                me.delegate = me.delegate || me.view.rowSelector;\r
                me.on('beforeshow', beforeViewTipShow);\r
            } else if (host.isXType('dataview')) {\r
                me.view = me.host;\r
                me.delegate = me.delegate || host.itemSelector;\r
                me.on('beforeshow', beforeViewTipShow);\r
            } else if (host.isXType('form')) {\r
                me.delegate = '.' + Ext.form.Labelable.prototype.formItemCls;\r
                me.on('beforeshow', beforeFormTipShow);\r
            } else if (host.isXType('combobox')) {\r
                me.view = host.getPicker();\r
                me.delegate = me.delegate || me.view.getItemSelector();\r
                me.on('beforeshow', beforeViewTipShow);\r
            }\r
            if (host.rendered) {\r
                onHostRender.call(host);\r
            } else {\r
                host.onRender = Ext.Function.createSequence(host.onRender, onHostRender);\r
            }\r
        }\r
    };\r
});\r