add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / GlobalEvents.js

/**\r
 * An `{@link Ext.mixin.Observable Observable}` through which Ext fires global events.\r
 * \r
 * Ext.on() and Ext.un() are shorthand for {@link #addListener} and {@link #removeListener}\r
 * on this Observable.  For example, to listen for the idle event:\r
 * \r
 *     Ext.on('idle', function() {\r
 *         // do something\r
 *     });\r
 */\r
Ext.define('Ext.GlobalEvents', {\r
    extend: 'Ext.mixin.Observable',\r
    alternateClassName: 'Ext.globalEvents', // for compat with Ext JS 4.2 and earlier\r
    \r
    requires: [\r
        'Ext.dom.Element'\r
    ],\r
\r
    observableType: 'global',\r
\r
    singleton: true,\r
\r
    /**\r
     * @private\r
     */\r
    resizeBuffer: 100,\r
\r
    /**\r
     * @event added\r
     * Fires when a Component is added to a Container.\r
     * @param {Ext.Component} component\r
     */\r
\r
    /**\r
     * @event beforeresponsiveupdate\r
     * Fires before {@link Ext.mixin.Responsive} perform any updates in response to\r
     * dynamic changes. This is prior to refreshing `responsiveFormulas`.\r
     * @param {Object} context The context object used by `responsiveConfig` expressions.\r
     * @since 5.0.1\r
     */\r
\r
    /**\r
     * @event beginresponsiveupdate\r
     * Fires when {@link Ext.mixin.Responsive} is about to perform updates in response to\r
     * dynamic changes. At this point all `responsiveFormulas` have been refreshed.\r
     * @param {Object} context The context object used by `responsiveConfig` expressions.\r
     * @since 5.0.1\r
     */\r
\r
    /**\r
     * @event responsiveupdate\r
     * Fires after {@link Ext.mixin.Responsive} has performed updates in response to\r
     * dynamic changes.\r
     * @param {Object} context The context object used by `responsiveConfig` expressions.\r
     * @since 5.0.1\r
     */\r
\r
    /**\r
     * @event collapse\r
     * Fires when a Component is collapsed (e.g., a panel).\r
     * @param {Ext.Component} component\r
     */\r
\r
    /**\r
     * @event expand\r
     * Fires when a Component is expanded (e.g., a panel).\r
     * @param {Ext.Component} component\r
     */\r
\r
    /**\r
     * @event hide\r
     * Fires when a Component is hidden.\r
     * @param {Ext.Component} component\r
     */\r
\r
    /**\r
     * @event idle\r
     * Fires when an event handler finishes its run, just before returning to\r
     * browser control.\r
     * \r
     * This includes DOM event handlers, Ajax (including JSONP) event handlers,\r
     * and {@link Ext.util.TaskRunner TaskRunners}\r
     * \r
     * When called at the tail of a DOM event, the event object is passed as the\r
     * sole parameter.\r
     * \r
     * This can be useful for performing cleanup, or update tasks which need to\r
     * happen only after all code in an event handler has been run, but which\r
     * should not be executed in a timer due to the intervening browser\r
     * reflow/repaint which would take place.\r
     */\r
\r
    /**\r
     * @event removed\r
     * Fires when a Component is removed from a Container.\r
     * @param {Ext.Component} component\r
     */\r
\r
    /**\r
     * @event resize\r
     * Fires when the browser window is resized.  To avoid running resize handlers\r
     * too often resulting in sluggish window resizing, resize events use a buffer\r
     * of 100 milliseconds.\r
     * @param {Number} width The new width\r
     * @param {Number} height The new height\r
     */\r
\r
    /**\r
     * @event show\r
     * Fires when a Component is shown.\r
     * @param {Ext.Component} component\r
     */\r
    \r
    /**\r
     * @event beforebindnotify\r
     * Fires before a scheduled set of bindings are fired. This allows interested parties\r
     * to react and do any required work.\r
     * @param {Ext.util.Scheduler} scheduler The scheduler triggering the bindings.\r
     * \r
     * @private\r
     * @since 5.1.0\r
     */\r
    \r
    /**\r
     * @event mousedown\r
     * A mousedown listener on the document that is immune to stopPropagation()\r
     * used in cases where we need to know if a mousedown event occurred on the\r
     * document regardless of whether some other handler tried to stop it.  An\r
     * example where this is useful is a menu that needs to be hidden whenever\r
     * there is a mousedown event on the document.\r
     * @param {Ext.event.Event} e The event object\r
     */\r
\r
    /**\r
     * @property {Object} idleEventMask\r
     * This object holds event names for events that should not trigger an `idle` event\r
     * following their dispatch.\r
     * @private\r
     * @since 5.0.0\r
     */\r
    idleEventMask: {\r
        mousemove: 1,\r
        touchmove: 1,\r
        pointermove: 1,\r
        MSPointerMove: 1,\r
        unload: 1\r
    },\r
\r
    constructor: function() {\r
        var me = this;\r
\r
        me.callParent();\r
\r
        Ext.onInternalReady(function() {\r
            // using a closure here instead of attaching the event directly to the\r
            // attachListeners method gives us a chance to override the method\r
            me.attachListeners();\r
        });\r
    },\r
\r
    attachListeners: function() {\r
        Ext.get(window).on('resize', this.fireResize, this, {\r
            buffer: this.resizeBuffer\r
        });\r
        Ext.getDoc().on('mousedown', this.fireMouseDown, this);\r
    },\r
\r
    fireMouseDown: function(e) {\r
        this.fireEvent('mousedown', e);\r
    },\r
\r
    fireResize: function() {\r
        var me = this,\r
            Element = Ext.Element,\r
            w = Element.getViewportWidth(),\r
            h = Element.getViewportHeight();\r
\r
         // In IE the resize event will sometimes fire even though the w/h are the same.\r
         if (me.curHeight !== h || me.curWidth !== w) {\r
             me.curHeight = h;\r
             me.curWidth = w;\r
             me.fireEvent('resize', w, h);\r
         }\r
    }\r
\r
}, function(GlobalEvents) {\r
    /**\r
     * @member Ext\r
     * @method on\r
     * Shorthand for {@link Ext.GlobalEvents#addListener}.\r
     * @inheritdoc Ext.util.Observable#addListener\r
     */\r
    Ext.on = function() {\r
        return GlobalEvents.addListener.apply(GlobalEvents, arguments);\r
    };\r
\r
    /**\r
     * @member Ext\r
     * @method\r
     * Shorthand for {@link Ext.GlobalEvents#removeListener}.\r
     * @inheritdoc Ext.util.Observable#removeListener\r
     */\r
    Ext.un = function() {\r
        return GlobalEvents.removeListener.apply(GlobalEvents, arguments);\r
    };\r
});\r