build/swf/swf.js

	swf.js revision 829f44d633f4910c12181f3295e5c6b996d7e559
6e89f0a006cdbb50151504b3107096e365136687Jenny Han DonnellyYUI.add('swf', function(Y) {
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly/**
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly * Embed a Flash applications in a standard manner and communicate with it
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly * via External Interface.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly * @module swf
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly */
c28f85fdfe5f4318a887f384ac1e58d40414fdbaLuke Smith
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly    var Event = Y.Event,
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly        SWFDetect = Y.SWFDetect,
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly        Lang = Y.Lang,
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly        uA = Y.UA,
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        Node = Y.Node,
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        Escape = Y.Escape,
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        // private
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        FLASH_CID = "clsid:d27cdb6e-ae6d-11cf-96b8-444553540000",
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        FLASH_TYPE = "application/x-shockwave-flash",
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        FLASH_VER = "10.0.22",
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        EXPRESS_INSTALL_URL = "http://fpdownload.macromedia.com/pub/flashplayer/update/current/swf/autoUpdater.swf?" + Math.random(),
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        EVENT_HANDLER = "SWF.eventHandler",
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        possibleAttributes = {align:"", allowFullScreen:"", allowNetworking:"", allowScriptAccess:"", base:"", bgcolor:"", menu:"", name:"", quality:"", salign:"", scale:"", tabindex:"", wmode:""};
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        /**
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * The SWF utility is a tool for embedding Flash applications in HTML pages.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @module swf
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @title SWF Utility
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @requires event-custom, node, swfdetect
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         */
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        /**
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * Creates the SWF instance and keeps the configuration data
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @class SWF
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @augments Y.Event.Target
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @constructor
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @param {String|HTMLElement} id The id of the element, or the element itself that the SWF will be inserted into.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *        The width and height of the SWF will be set to the width and height of this container element.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @param {String} swfURL The URL of the SWF to be embedded into the page.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @param {Object} p_oAttributes (optional) Configuration parameters for the Flash application and values for Flashvars
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *        to be passed to the SWF. The p_oAttributes object allows the following additional properties:
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *        <dl>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *          <dt>version : String</dt>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *          <dd>The minimum version of Flash required on the user's machine.</dd>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *          <dt>fixedAttributes : Object</dt>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *          <dd>An object literal containing one or more of the following String keys and their values: <code>align,
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *              allowFullScreen, allowNetworking, allowScriptAccess, base, bgcolor, menu, name, quality, salign, scale,
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *              tabindex, wmode.</code> event from the thumb</dd>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *        </dl>
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         */
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnellyfunction SWF (p_oElement /*:String*/, swfURL /*:String*/, p_oAttributes /*:Object*/ ) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    this._id = Y.guid("yuiswf");
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var _id = this._id;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var oElement = Node.one(p_oElement);
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly	var p_oAttributes = p_oAttributes || {};
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly	var flashVersion = p_oAttributes["version"] || FLASH_VER;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var flashVersionSplit = (flashVersion + '').split(".");
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var isFlashVersionRight = SWFDetect.isFlashVersionAtLeast(parseInt(flashVersionSplit[0], 10), parseInt(flashVersionSplit[1], 10), parseInt(flashVersionSplit[2], 10));
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var canExpressInstall = (SWFDetect.isFlashVersionAtLeast(8,0,0));
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var shouldExpressInstall = canExpressInstall && !isFlashVersionRight && p_oAttributes.useExpressInstall;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var flashURL = (shouldExpressInstall)?EXPRESS_INSTALL_URL:swfURL;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var objstring = '<object ';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var w, h;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    var flashvarstring = "yId=" + Y.id + "&YUISwfId=" + _id + "&YUIBridgeCallback=" + EVENT_HANDLER + "&allowedDomain=" + document.location.hostname;
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    Y.SWF._instances[_id] = this;
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly    if (oElement && (isFlashVersionRight || shouldExpressInstall) && flashURL) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        objstring += 'id="' + _id + '" ';
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly        if (uA.ie) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            objstring += 'classid="' + FLASH_CID + '" ';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        } else {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            objstring += 'type="' + FLASH_TYPE + '" data="' + Escape.html(flashURL) + '" ';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        w = "100%";
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        h = "100%";
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        objstring += 'width="' + w + '" height="' + h + '">';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        if (uA.ie) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            objstring += '<param name="movie" value="' + Escape.html(flashURL) + '"/>';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        for (var attribute in p_oAttributes.fixedAttributes) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            if (possibleAttributes.hasOwnProperty(attribute)) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly                objstring += '<param name="' + Escape.html(attribute) + '" value="' + Escape.html(p_oAttributes.fixedAttributes[attribute]) + '"/>';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        for (var flashvar in p_oAttributes.flashVars) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            var fvar = p_oAttributes.flashVars[flashvar];
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            if (Lang.isString(fvar)) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly                flashvarstring += "&" + Escape.html(flashvar) + "=" + Escape.html(encodeURIComponent(fvar));
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        if (flashvarstring) {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly            objstring += '<param name="flashVars" value="' + flashvarstring + '"/>';
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        objstring += "</object>";
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly        oElement.setContent(objstring);
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        this._swf = Node.one("#" + _id);
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    } else {
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        /**
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * Fired when the Flash player version on the user's machine is
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * below the required value.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         *
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         * @event wrongflashversion
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly         */
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        var event = {};
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        event.type = "wrongflashversion";
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        this.publish("wrongflashversion", {fireOnce:true});
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly        this.fire("wrongflashversion", event);
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly    }
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly}
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly/**
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @private
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * The static collection of all instances of the SWFs on the page.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @property _instances
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @type Object
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly */
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny DonnellySWF._instances = SWF._instances || {};
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly/**
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @private
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * Handles an event coming from within the SWF and delegate it
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * to a specific instance of SWF.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @method eventHandler
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly * @param swfid {String} the id of the SWF dispatching the event
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly * @param event {Object} the event being transmitted.
83051cc2f61c3e17f61b8f8f409a69c057db0e6bJenny Donnelly */
6e89f0a006cdbb50151504b3107096e365136687Jenny Han DonnellySWF.eventHandler = function (swfid, event) {
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly    SWF._instances[swfid]._eventHandler(event);
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly};

SWF.prototype = {
    /**
     * @private
     * Propagates a specific event from Flash to JS.
     * @method _eventHandler
     * @param event {Object} The event to be propagated from Flash.
     */
    _eventHandler: function(event) {
        if (event.type === "swfReady") {
            this.publish("swfReady", {fireOnce:true});
            this.fire("swfReady", event);
        } else if(event.type === "log") {
        } else {
            this.fire(event.type, event);
        }
    },

        /**
	 * Calls a specific function exposed by the SWF's
	 * ExternalInterface.
	 * @method callSWF
	 * @param func {String} the name of the function to call
	 * @param args {Array} the set of arguments to pass to the function.
	 */

	callSWF: function (func, args)
	{
	if (!args) {
		  args= [];
	}
		if (this._swf._node[func]) {
		return(this._swf._node[func].apply(this._swf._node, args));
	    } else {
		return null;
	    }
	},

	/**
	 * Public accessor to the unique name of the SWF instance.
	 *
	 * @method toString
	 * @return {String} Unique name of the SWF instance.
	 */
	toString: function()
	{
		return "SWF " + this._id;
	}
};

Y.augment(SWF, Y.EventTarget);

Y.SWF = SWF;


}, '@VERSION@' ,{requires:['event-custom','node','swfdetect','escape']});