svn commit: r612702 - in /incubator/shindig/trunk/features: features.txt flash/ flash/feature.xml flash/flash.js

[zh...@apache.org]

Author: zhen
Date: Wed Jan 16 20:19:59 2008
New Revision: 612702

URL: http://svn.apache.org/viewvc?rev=612702&view=rev
Log:
Added Flash support.

New APIs:

gadgets.Flash.getMajorVersion
gadgets.Flash.embedFlash
gadgets.Flash.embedCachedFlash (using the /gadgets/proxy?url=* syntax for the cached URL)

Legacy APIs are supported as function aliases:

_IG_GetFlashMajorVersion
_IG_EmbedFlash
_IG_EmbedCachedFlash


Added:
    incubator/shindig/trunk/features/flash/
    incubator/shindig/trunk/features/flash/feature.xml
    incubator/shindig/trunk/features/flash/flash.js
Modified:
    incubator/shindig/trunk/features/features.txt

Modified: incubator/shindig/trunk/features/features.txt
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/features.txt?rev=612702&r1=612701&r2=612702&view=diff
==============================================================================
--- incubator/shindig/trunk/features/features.txt (original)
+++ incubator/shindig/trunk/features/features.txt Wed Jan 16 20:19:59 2008
@@ -8,3 +8,4 @@
 features/setprefs/feature.xml
 features/dynamic-height/feature.xml
 features/settitle/feature.xml
+features/flash/feature.xml

Added: incubator/shindig/trunk/features/flash/feature.xml
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/flash/feature.xml?rev=612702&view=auto
==============================================================================
--- incubator/shindig/trunk/features/flash/feature.xml (added)
+++ incubator/shindig/trunk/features/flash/feature.xml Wed Jan 16 20:19:59 2008
@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+-->
+<feature>
+  <name>flash</name>
+  <gadget>
+    <script src="flash.js"/>
+  </gadget>
+</feature>

Added: incubator/shindig/trunk/features/flash/flash.js
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/features/flash/flash.js?rev=612702&view=auto
==============================================================================
--- incubator/shindig/trunk/features/flash/flash.js (added)
+++ incubator/shindig/trunk/features/flash/flash.js Wed Jan 16 20:19:59 2008
@@ -0,0 +1,183 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+/**
+ * @fileoverview This library provides a standard and convenient way to embed
+ * Flash content into gadgets.
+ */
+
+var gadgets = gadgets || {};
+gadgets.Flash = gadgets.Flash || {};
+
+/**
+ * Detects Flash Player and its major version.
+ * @return {Number} The major version of Flash Player
+ *                  or 0 if Flash is not supported.
+ */
+gadgets.Flash.getMajorVersion = function() {
+  var flashMajorVersion = 0;
+  if (navigator.plugins && navigator.mimeTypes && navigator.mimeTypes.length) {
+    // Flash detection for browsers using Netscape's plugin architecture
+    var i = navigator.plugins["Shockwave Flash"];
+    if (i && i.description) {
+      flashMajorVersion = parseInt(i.description.match(/[0-9]+/)[0], 10);
+    }
+  } else {
+    // Flash detection for IE
+    // This is done by trying to create an ActiveX object with the name
+    // "ShockwaveFlash.ShockwaveFlash.{majorVersion}".
+    for (var i = 9; i > 0; i--) {
+      try {
+        new ActiveXObject("ShockwaveFlash.ShockwaveFlash." + i);
+        return i;
+      } catch (e) {
+      }
+    }
+  }
+  return flashMajorVersion;
+}
+
+/**
+ * Injects a Flash file into the DOM tree.
+ * @param {String} swfUrl SWF URL.
+ * @param {String|Object} swfContainer The id or object reference of an existing
+ *                        html container element.
+ * @param {Object} opt_params An optional object that may contain one or more
+ *                 fields:
+ *       {Number} .swf_version
+ *         Minimal Flash Player version required.
+ *       {Number|String} .width, .height
+ *         Preferred width and height. (Default value: '100%')
+ *       {String} .base
+ *         The base attribute enforces the base location from which the URL
+ *         loads. This prevents confusion about the location to which relative
+ *         links are relative. (Default value: the path of swfUrl)
+ *       Other fields such as .quality and .id can also be defined and will be
+ *       passed to the Flash movie on creation. The values must be HTML-escaped.
+ * @return {Boolean} Whether the function call completes successfully.
+ */
+gadgets.Flash.embedFlash = function(swfUrl, swfContainer, opt_params) {
+  switch (typeof swfContainer) {
+    case 'string':
+      swfContainer = document.getElementById(swfContainer);
+    case 'object':
+      if (swfContainer && (typeof swfContainer.innerHTML == 'string')) {
+        break;
+      }
+    default:
+      return false;
+  }
+
+  switch (typeof opt_params) {
+    case 'undefined':
+      opt_params = {};
+    case 'object':
+      break;
+    default:
+      return false;
+  }
+
+  var ver = gadgets.Flash.getMajorVersion();
+  if (ver) {
+    var swfVer = parseInt(opt_params.swf_version, 10);
+    if (isNaN(swfVer)) {
+      swfVer = 0;
+    }
+    if (ver >= swfVer) {
+      // Set default size
+      if (!opt_params.width) {
+        opt_params.width = '100%';
+      }
+      if (!opt_params.height) {
+        opt_params.height = '100%';
+      }
+      // Set the default "base" attribute
+      if (typeof opt_params.base != 'string') {
+        opt_params.base = swfUrl.match(/^[^?#]+\//)[0];
+      }
+      // Set wmode to "opaque" if it's not defined. The default value
+      // "window" is undesirable because browsers will render Flash
+      // on top of other html elements.
+      if (typeof opt_params.wmode != 'string') {
+        opt_params.wmode = 'opaque';
+      }
+      // Prepare html snippet
+      var html;
+      if (navigator.plugins && navigator.mimeTypes &&
+          navigator.mimeTypes.length) {
+        // Use <embed> tag for Netscape and Mozilla browsers
+        opt_params.type = 'application/x-shockwave-flash';
+        opt_params.src = swfUrl;
+
+        html = '<embed';
+        for (var prop in opt_params) {
+          if (!/^swf_/.test(prop)) {
+            html += ' ' + prop + '="' + opt_params[prop] + '"';
+          }
+        }
+        html += ' /></embed>';
+      } else {
+        // Use <object> tag for IE
+        opt_params.movie = swfUrl;
+        var attr = {
+          width: opt_params.width,
+          height: opt_params.height,
+          classid: "clsid:D27CDB6E-AE6D-11CF-96B8-444553540000"
+        };
+        if (opt_params.id) {
+          attr.id = opt_params.id;
+        }
+
+        html = '<object';
+        for (var prop in attr) {
+          html += ' ' + prop + '="' + attr[prop] + '"';
+        }
+        html += '>';
+        for (var prop in opt_params) {
+          if (!/^swf_/.test(prop) && !attr[prop]) {
+            html += '<param name="' + prop +
+              '" value="' + opt_params[prop] + '" />';
+          }
+        }
+        html += '</object>';
+      }
+      // Inject html
+      swfContainer.innerHTML = html;
+      return true;
+    }
+  }
+  return false;
+};
+
+/**
+ * Injects a cached Flash file into the DOM tree.
+ * Accepts the same parameters as gadgets.Flash.embedFlash does.
+ * @return {Boolean} Whether the function call completes successfully.
+ */
+gadgets.Flash.embedCachedFlash = function() {
+  var args = Array.prototype.slice.call(arguments);
+  args[0] = 'http://' + document.location.host + '/gadgets/proxy?url=' +
+            args[0];
+  gadgets.Flash.embedFlash.apply(this, args);
+};
+
+// Aliases for legacy code
+var _IG_GetFlashMajorVersion = gadgets.Flash.getMajorVersion;
+var _IG_EmbedFlash = gadgets.Flash.embedFlash;
+var _IG_EmbedCachedFlash = gadgets.Flash.embedCachedFlash;
+