webgui/www/extras/yui/docs/YAHOO.widget.FlashAdapter.html
2008-03-25 16:13:25 +00:00

1155 lines
56 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: uploader YAHOO.widget.FlashAdapter (YUI Library)</title>
<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">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Uploader&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_uploader.html">uploader</a>
&gt; YAHOO.widget.FlashAdapter
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.FlashAdapter</b>
<span class="extends">
</span>
<span class="extends">
- uses
<a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
Wraps Flash embedding functionality and allows communication with SWF through
attributes.
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__attributes">_attributes</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
The initializing attributes are stored here until the SWF is ready.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__id">_id</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
The id of this instance.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__swf">_swf</a>
<code>- private object</code>
</h4>
<div class="detail">
<div class="description">
A reference to the embedded SWF file.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__swfURL">_swfURL</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
The URL of the SWF file.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__embedSWF">_embedSWF</a></h4>
<div class="detail">
<code>
private
void
<strong>_embedSWF</strong>
(
)
</code>
<div class="description">
Embeds the SWF in the page and associates it with this instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__eventHandler">_eventHandler</a></h4>
<div class="detail">
<code>
private
void
<strong>_eventHandler</strong>
(
)
</code>
<div class="description">
Handles or re-dispatches events received from the SWF.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__getSWFURL">_getSWFURL</a></h4>
<div class="detail">
<code>
private
void
<strong>_getSWFURL</strong>
(
)
</code>
<div class="description">
Getter for swfURL attribute.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__initAttributes">_initAttributes</a></h4>
<div class="detail">
<code>
private
void
<strong>_initAttributes</strong>
(
)
</code>
<div class="description">
Initializes the attributes.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__loadHandler">_loadHandler</a></h4>
<div class="detail">
<code>
private
void
<strong>_loadHandler</strong>
(
)
</code>
<div class="description">
Called when the SWF has been initialized.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Public accessor to the unique name of the FlashAdapter instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the FlashAdapter instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_YAHOO.widget.FlashAdapter.eventHandler">YAHOO.widget.FlashAdapter.eventHandler</a></h4>
<div class="detail">
<code>
private
static
void
<strong>YAHOO.widget.FlashAdapter.eventHandler</strong>
(
)
</code>
<div class="description">
Receives event messages from SWF and passes them to the correct instance
of FlashAdapter.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_backgroundColorChange">backgroundColorChange</a></h4>
<div class="detail">
<code>
<strong>backgroundColorChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'backgroundColor' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeBackgroundColorChange">beforeBackgroundColorChange</a></h4>
<div class="detail">
<code>
<strong>beforeBackgroundColorChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'backgroundColor' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeExpressInstallChange">beforeExpressInstallChange</a></h4>
<div class="detail">
<code>
<strong>beforeExpressInstallChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'expressInstall' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeSwfURLChange">beforeSwfURLChange</a></h4>
<div class="detail">
<code>
<strong>beforeSwfURLChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'swfURL' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeVersionChange">beforeVersionChange</a></h4>
<div class="detail">
<code>
<strong>beforeVersionChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'version' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeWmodeChange">beforeWmodeChange</a></h4>
<div class="detail">
<code>
<strong>beforeWmodeChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'wmode' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_contentReady">contentReady</a></h4>
<div class="detail">
<code>
<strong>contentReady</strong>
(
)
</code>
<div class="description">
Fires when the SWF is initialized and communication is possible.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_expressInstallChange">expressInstallChange</a></h4>
<div class="detail">
<code>
<strong>expressInstallChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'expressInstall' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_swfURLChange">swfURLChange</a></h4>
<div class="detail">
<code>
<strong>swfURLChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'swfURL' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_versionChange">versionChange</a></h4>
<div class="detail">
<code>
<strong>versionChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'version' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_wmodeChange">wmodeChange</a></h4>
<div class="detail">
<code>
<strong>wmodeChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'wmode' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_backgroundColor">backgroundColor</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The background color of the SWF. Only available in the constructor because it may not be
set after Flash Player has been embedded in the page.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_expressInstall">expressInstall</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
URL pointing to a SWF file that handles Flash Player's express
install feature. Only available in the constructor because it may not be
set after Flash Player has been embedded in the page.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_swfURL">swfURL</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Absolute or relative URL to the SWF displayed by the FlashAdapter. Only available in the constructor because it may not be
set after Flash Player has been embedded in the page.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_version">version</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Minimum required version for the SWF file. Only available in the constructor because it may not be
set after Flash Player has been embedded in the page.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_wmode">wmode</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Sets the window mode of the Flash Player control. May be
"window", "opaque", or "transparent". Only available in the constructor
because it may not be set after Flash Player has been embedded in the page.
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class="selected"><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.FlashAdapter.html">YAHOO.widget.FlashAdapter</a></li>
<li class=""><a href="YAHOO.widget.Uploader.html">YAHOO.widget.Uploader</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Uploader.js.html">Uploader.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__attributes">_attributes</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__id">_id</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__swf">_swf</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__swfURL">_swfURL</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#method__embedSWF">_embedSWF</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__eventHandler">_eventHandler</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__getSWFURL">_getSWFURL</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__initAttributes">_initAttributes</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__loadHandler">_loadHandler</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_YAHOO.widget.FlashAdapter.eventHandler">YAHOO.widget.FlashAdapter.eventHandler</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_backgroundColorChange">backgroundColorChange</a>
</li>
<li class="">
<a href="#event_beforeBackgroundColorChange">beforeBackgroundColorChange</a>
</li>
<li class="">
<a href="#event_beforeExpressInstallChange">beforeExpressInstallChange</a>
</li>
<li class="">
<a href="#event_beforeSwfURLChange">beforeSwfURLChange</a>
</li>
<li class="">
<a href="#event_beforeVersionChange">beforeVersionChange</a>
</li>
<li class="">
<a href="#event_beforeWmodeChange">beforeWmodeChange</a>
</li>
<li class="">
<a href="#event_contentReady">contentReady</a>
</li>
<li class="">
<a href="#event_expressInstallChange">expressInstallChange</a>
</li>
<li class="">
<a href="#event_swfURLChange">swfURLChange</a>
</li>
<li class="">
<a href="#event_versionChange">versionChange</a>
</li>
<li class="">
<a href="#event_wmodeChange">wmodeChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_backgroundColor">backgroundColor</a>
</li>
<li class="">
<a href="#config_expressInstall">expressInstall</a>
</li>
<li class="">
<a href="#config_swfURL">swfURL</a>
</li>
<li class="">
<a href="#config_version">version</a>
</li>
<li class="">
<a href="#config_wmode">wmode</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>