YAHOO.widget.SWF.html revision 7fb726e2aaa756245473d9f98b18e3ff806d3f9f
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: swf YAHOO.widget.SWF (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>SWF Utility&nbsp; <span class="subtitle">3.1.0</span></h3>
<a href="/index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="/module_swf.html" title="swf">swf</a>
&gt; YAHOO.widget.SWF
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">YAHOO.widget.SWF</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Creates the SWF instance and keeps the configuration data
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">YAHOO.widget.SWF</strong>
<code>
(
id
,
swfURL
,
p_oAttributes
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String|HTMLElement</span>&gt;
</code>
<span property="yui:description"> The id of the element, or the element itself that the SWF will be inserted into.
The width and height of the SWF will be set to the width and height of this container element.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">swfURL</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The URL of the SWF to be embedded into the page.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">p_oAttributes</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> (optional) Configuration parameters for the Flash application and values for Flashvars
to be passed to the SWF. The p_oAttributes object allows the following additional properties:
<dl>
<dt>version : String</dt>
<dd>The minimum version of Flash required on the user's machine.</dd>
<dt>fixedAttributes : Object</dt>
<dd>An object literal containing one or more of the following String keys and their values: <code>align,
allowFullScreen, allowNetworking, allowScriptAccess, base, bgcolor, menu, name, quality, salign, scale,
tabindex, wmode.</code> event from the thumb</dd>
</dl></span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property__instances">
<h4><a name="property__instances" property="yui:name">_instances</a>
- <code>private <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The static collection of all instances of the SWFs on the page.
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__eventHandler">
<h4>
<a name="method__eventHandler">_eventHandler</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_eventHandler</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Propagates a specific event from Flash to JS.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> The event to be propagated from Flash.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_callSWF">
<h4>
<a name="method_callSWF">callSWF</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">callSWF</strong>
(
func
,
args
)
</code>
<div class="description" property="yui:description">
Calls a specific function exposed by the SWF's
ExternalInterface.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">func</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> the name of the function to call</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> the set of arguments to pass to the function.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_eventHandler">
<h4>
<a name="method_eventHandler">eventHandler</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">eventHandler</strong>
(
swfid
,
event
)
</code>
<div class="description" property="yui:description">
Handles an event coming from within the SWF and delegate it
to a specific instance of SWF.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">swfid</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> the id of the SWF dispatching the event</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> the event being transmitted.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_toString">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail" >
<code>
String
<strong property="yui:name">toString</strong>
(
)
</code>
<div class="description" property="yui:description">
Public accessor to the unique name of the SWF instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
String
</code></dt>
<dd property="yui:returnInfo">Unique name of the SWF instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_wrongflashversion">
<h4>
<a name="event_wrongflashversion">wrongflashversion</a></h4>
<div class="detail">
<code>
<strong property="yui:name">wrongflashversion</strong>
(
)
</code>
<div class="description" property="yui:description">
Fired when the Flash player version on the user's machine is below the required value.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_align-plugin.html" title="align-plugin">align-plugin</a></li>
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_editor.html" title="editor">editor</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_intl.html" title="intl">intl</a></li>
<li class=""><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_jsonp.html" title="jsonp">jsonp</a></li>
<li class=""><a href="module_loader.html" title="loader">loader</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-flick.html" title="node-flick">node-flick</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_pluginhost.html" title="pluginhost">pluginhost</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_querystring.html" title="querystring">querystring</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_scrollview.html" title="scrollview">scrollview</a></li>
<li class=""><a href="module_scrollview-base.html" title="scrollview-base">scrollview-base</a></li>
<li class=""><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
<li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
<li class=""><a href="module_shim-plugin.html" title="shim-plugin">shim-plugin</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_sortable.html" title="sortable">sortable</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class="selected"><a href="module_swf.html" title="swf">swf</a></li>
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
<li class=""><a href="module_value-change.html" title="value-change">value-change</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-anim.html" title="widget-anim">widget-anim</a></li>
<li class=""><a href="module_widget-child.html" title="widget-child">widget-child</a></li>
<li class=""><a href="module_widget-locale.html" title="widget-locale">widget-locale</a></li>
<li class=""><a href="module_widget-parent.html" title="widget-parent">widget-parent</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
<li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yql.html" title="yql">yql</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.SWF.html" title="YAHOO.widget.SWF">YAHOO.widget.SWF</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="swf.js.html" title="swf.js">swf.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__instances" title="_instances">_instances</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__eventHandler" title="_eventHandler">_eventHandler</a></li>
<li class=""><a href="#method_callSWF" title="callSWF">callSWF</a></li>
<li class="private"><a href="#method_eventHandler" title="eventHandler">eventHandler</a></li>
<li class=""><a href="#method_toString" title="toString">toString</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_wrongflashversion" title="wrongflashversion">wrongflashversion</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.widget.SWF", "name": "callSWF", "url": "YAHOO.widget.SWF.html#method_callSWF", "type": "method"}, {"access": "private", "host": "YAHOO.widget.SWF", "name": "_eventHandler", "url": "YAHOO.widget.SWF.html#method__eventHandler", "type": "method"}, {"access": "private", "host": "YAHOO.widget.SWF", "name": "eventHandler", "url": "YAHOO.widget.SWF.html#method_eventHandler", "type": "method"}, {"access": "private", "host": "YAHOO.widget.SWF", "name": "_instances", "url": "YAHOO.widget.SWF.html#property__instances", "type": "property"}, {"access": "", "host": "YAHOO.widget.SWF", "name": "toString", "url": "YAHOO.widget.SWF.html#method_toString", "type": "method"}, {"access": "", "host": "YAHOO.widget.SWF", "name": "wrongflashversion", "url": "YAHOO.widget.SWF.html#event_wrongflashversion", "type": "event"}];
</script>
</body>
</html>