add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / flash / Component.js

/**\r
 * A simple Component for displaying an Adobe Flash SWF movie. The movie will be sized and can participate\r
 * in layout like any other Component.\r
 *\r
 * This component requires the third-party SWFObject library version 2.2 or above. It is not included within\r
 * the ExtJS distribution, so you will have to include it into your page manually in order to use this component.\r
 * The SWFObject library can be downloaded from the [SWFObject project page](http://code.google.com/p/swfobject)\r
 * and then simply import it into the head of your HTML document:\r
 *\r
 *     <script type="text/javascript" src="path/to/local/swfobject.js"></script>\r
 *\r
 * ## Configuration\r
 *\r
 * This component allows several options for configuring how the target Flash movie is embedded. The most\r
 * important is the required {@link #url} which points to the location of the Flash movie to load. Other\r
 * configurations include:\r
 *\r
 * - {@link #backgroundColor}\r
 * - {@link #wmode}\r
 * - {@link #flashVars}\r
 * - {@link #flashParams}\r
 * - {@link #flashAttributes}\r
 *\r
 * ## Example usage:\r
 *\r
 *     var win = Ext.widget('window', {\r
 *         title: "It's a tiger!",\r
 *         layout: 'fit',\r
 *         width: 300,\r
 *         height: 300,\r
 *         x: 20,\r
 *         y: 20,\r
 *         resizable: true,\r
 *         items: {\r
 *             xtype: 'flash',\r
 *             url: 'tiger.swf'\r
 *         }\r
 *     });\r
 *     win.show();\r
 *\r
 * ## Express Install\r
 *\r
 * Adobe provides a tool called [Express Install](http://www.adobe.com/devnet/flashplayer/articles/express_install.html)\r
 * that offers users an easy way to upgrade their Flash player. If you wish to make use of this, you should set\r
 * the static EXPRESS\_INSTALL\_URL property to the location of your Express Install SWF file:\r
 *\r
 *     Ext.flash.Component.EXPRESS_INSTALL_URL = 'path/to/local/expressInstall.swf';\r
 */\r
Ext.define('Ext.flash.Component', {\r
    extend: 'Ext.Component',\r
    alternateClassName: 'Ext.FlashComponent',\r
    alias: 'widget.flash',\r
\r
    /**\r
     * @cfg {String} [flashVersion="9.0.115"]\r
     * Indicates the version the flash content was published for.\r
     */\r
    flashVersion : '9.0.115',\r
\r
    /**\r
     * @cfg {String} [backgroundColor="#ffffff"]\r
     * The background color of the SWF movie.\r
     */\r
    backgroundColor: '#ffffff',\r
\r
    /**\r
     * @cfg {String} [wmode="opaque"]\r
     * The wmode of the flash object. This can be used to control layering.\r
     * Set to 'transparent' to ignore the {@link #backgroundColor} and make the background of the Flash\r
     * movie transparent.\r
     */\r
    wmode: 'opaque',\r
\r
    /**\r
     * @cfg {Object} flashVars\r
     * A set of key value pairs to be passed to the flash object as flash variables.\r
     */\r
\r
    /**\r
     * @cfg {Object} flashParams\r
     * A set of key value pairs to be passed to the flash object as parameters. Possible parameters can be found here:\r
     * http://kb2.adobe.com/cps/127/tn_12701.html\r
     */\r
\r
    /**\r
     * @cfg {Object} flashAttributes\r
     * A set of key value pairs to be passed to the flash object as attributes.\r
     */\r
\r
    /**\r
     * @cfg {String} url (required)\r
     * The URL of the SWF file to include.\r
     */\r
\r
    /**\r
     * @cfg {String/Number} [swfWidth="100%"]\r
     * The width of the embedded SWF movie inside the component.\r
     *\r
     * Defaults to "100%" so that the movie matches the width of the component.\r
     */\r
    swfWidth: '100%',\r
\r
    /**\r
     * @cfg {String/Number} [swfHeight="100%"]\r
     * The height of the embedded SWF movie inside the component.\r
     *\r
     * Defaults to "100%" so that the movie matches the height of the component.\r
     */\r
    swfHeight: '100%',\r
\r
    /**\r
     * @cfg {Boolean} [expressInstall=false]\r
     * True to prompt the user to install flash if not installed. Note that this uses\r
     * Ext.FlashComponent.EXPRESS_INSTALL_URL, which should be set to the local resource.\r
     */\r
    expressInstall: false,\r
\r
    /**\r
     * @property {Ext.dom.Element} swf\r
     * A reference to the object or embed element into which the SWF file is loaded. Only\r
     * populated after the component is rendered and the SWF has been successfully embedded.\r
     */\r
\r
    // Have to create a placeholder div with the swfId, which SWFObject will replace with the object/embed element.\r
    renderTpl: ['<div id="{swfId}" role="application"></div>'],\r
\r
    /**\r
     * @event success\r
     * Fired when the Flash movie has been successfully embedded\r
     * @param {Ext.flash.Component} this\r
     */\r
\r
    /**\r
     * @event failure\r
     * Fired when the Flash movie embedding fails\r
     * @param {Ext.flash.Component} this\r
     */\r
\r
    initComponent: function() {\r
        // <debug>\r
        if (!('swfobject' in window)) {\r
            Ext.raise('The SWFObject library is not loaded. Ext.flash.Component requires SWFObject version 2.2 or later: http://code.google.com/p/swfobject/');\r
        }\r
        if (!this.url) {\r
            Ext.raise('The "url" config is required for Ext.flash.Component');\r
        }\r
        // </debug>\r
\r
        this.callParent();\r
    },\r
    \r
    beforeRender: function(){\r
        this.callParent();\r
        \r
        Ext.applyIf(this.renderData, {\r
            swfId: this.getSwfId()\r
        });\r
    },\r
\r
    afterRender: function() {\r
        var me = this,\r
            flashParams = Ext.apply({}, me.flashParams), \r
            flashVars = Ext.apply({}, me.flashVars);\r
\r
        me.callParent();\r
\r
        flashParams = Ext.apply({\r
            allowScriptAccess: 'always',\r
            bgcolor: me.backgroundColor,\r
            wmode: me.wmode\r
        }, flashParams);\r
\r
        flashVars = Ext.apply({\r
            allowedDomain: document.location.hostname\r
        }, flashVars);\r
\r
        new swfobject.embedSWF( // jshint ignore:line\r
            me.url,\r
            me.getSwfId(),\r
            me.swfWidth,\r
            me.swfHeight,\r
            me.flashVersion,\r
            me.expressInstall ? me.statics.EXPRESS_INSTALL_URL : undefined,\r
            flashVars,\r
            flashParams,\r
            me.flashAttributes,\r
            me.swfCallback.bind(me)\r
        );\r
    },\r
\r
    /**\r
     * @private\r
     * The callback method for handling an embedding success or failure by SWFObject\r
     * @param {Object} e The event object passed by SWFObject - see http://code.google.com/p/swfobject/wiki/api\r
     */\r
    swfCallback: function(e) {\r
        var me = this;\r
        if (e.success) {\r
            me.swf = Ext.get(e.ref);\r
            me.onSuccess();\r
            me.fireEvent('success', me);\r
        } else {\r
            me.onFailure();\r
            me.fireEvent('failure', me);\r
        }\r
    },\r
\r
    /**\r
     * Retrieves the id of the SWF object/embed element.\r
     */\r
    getSwfId: function() {\r
        return this.swfId || (this.swfId = "extswf" + this.getAutoId());\r
    },\r
\r
    onSuccess: function() {\r
        // swfobject forces visiblity:visible on the swf element, which prevents it \r
        // from getting hidden when an ancestor is given visibility:hidden.\r
        this.swf.setStyle('visibility', 'inherit');\r
    },\r
\r
    onFailure: Ext.emptyFn,\r
\r
    beforeDestroy: function() {\r
        var me = this,\r
            swf = me.swf;\r
        if (swf) {\r
            swfobject.removeSWF(me.getSwfId()); // jshint ignore:line\r
            Ext.destroy(swf);\r
            delete me.swf;\r
        }\r
        me.callParent();\r
    },\r
\r
    statics: {\r
        /**\r
         * @property {String}\r
         * The url for installing flash if it doesn't exist. This should be set to a local resource.\r
         * See [http://get.adobe.com/flashplayer/](http://get.adobe.com/flashplayer/) for details.\r
         * @static\r
         */\r
        EXPRESS_INSTALL_URL: 'http:/' + '/swfobject.googlecode.com/svn/trunk/swfobject/expressInstall.swf'\r
    }\r
});\r