| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="IModuleInfo,mx.modules.IModuleInfo,applicationDomain,child,data,error,factory,loaded,ready,setup,trustContent,url,url,getAssociatedFactory,getModule,load,loadModule,publish,release,unload,unloadModule"><title>mx.modules.IModuleInfo</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'IModuleInfo - ApacheFlex API Reference'; |
| var baseRef = '../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/modules/IModuleInfo.html&mx/modules/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">IModuleInfo</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("IModuleInfo"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.modules</a></td></tr><tr><td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IModuleInfo extends flash.events.IEventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| An interface that acts as a handle for a particular module. |
| From this interface, the module status can be queried, |
| its inner factory can be obtained, and it can be loaded or unloaded. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#data" class="signatureLink">data</a> : Object<div class="summaryTableDescription"> |
| User data that can be associated with the singleton IModuleInfo |
| for a given URL.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#error" class="signatureLink">error</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A flag that is true if there was an error |
| during module loading.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#factory" class="signatureLink">factory</a> : <a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a><div class="summaryTableDescription">[read-only] |
| The IFlexModuleFactory implementation defined in the module.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#loaded" class="signatureLink">loaded</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A flag that is true if the load() |
| method has been called on this module.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#ready" class="signatureLink">ready</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A flag that is true if the module is sufficiently loaded |
| to get a handle to its associated IFlexModuleFactory implementation |
| and call its create() method.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#setup" class="signatureLink">setup</a> : Boolean<div class="summaryTableDescription">[read-only] |
| A flag that is true if the module is sufficiently loaded |
| to get a handle to its associated IFlexModuleFactory implementation |
| and call its info() method.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#url" class="signatureLink">url</a> : String<div class="summaryTableDescription">[read-only] |
| The URL associated with this module (for example, "MyImageModule.swf" or |
| "http://somedomain.com/modules/MyImageModule.swf".</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#load()" class="signatureLink">load</a>(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a> = null):void</div><div class="summaryTableDescription"> |
| Requests that the module be loaded.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#publish()" class="signatureLink">publish</a>(factory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>):void</div><div class="summaryTableDescription"> |
| Publishes an interface to the ModuleManager.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#release()" class="signatureLink">release</a>():void</div><div class="summaryTableDescription"> |
| Releases the current reference to the module.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#unload()" class="signatureLink">unload</a>():void</div><div class="summaryTableDescription"> |
| Unloads the module.</div></td><td class="summaryTableOwnerCol">IModuleInfo</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:error" class="signatureLink">error</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the backing ModuleInfo if there was an error during module loading.</td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:progress" class="signatureLink">progress</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the backing ModuleInfo at regular intervals while the module is being loaded.</td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:ready" class="signatureLink">ready</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the backing ModuleInfo once the module is sufficiently loaded to call the IModuleInfo.factory() method and the IFlexModuleFactory.create() method.</td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:setup" class="signatureLink">setup</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the backing ModuleInfo once the module is sufficiently loaded to call the IModuleInfo.factory() method and the IFlexModuleFactory.info() method.</td><td class="summaryTableOwnerCol">IModuleInfo</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:unload" class="signatureLink">unload</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the backing ModuleInfo when the module data is unloaded.</td><td class="summaryTableOwnerCol">IModuleInfo</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="data"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">data</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>data:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| User data that can be associated with the singleton IModuleInfo |
| for a given URL. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get data():Object</code><br/><code> public function set data(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="error"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">error</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>error:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that is <code>true</code> if there was an error |
| during module loading. |
| |
| <p>This flag is <code>true</code> when the ModuleManager dispatches the |
| <code>ModuleEvent.ERROR</code> event.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get error():Boolean</code><br/></div><a name="propertyDetail"></a><a name="factory"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">factory</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>factory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The IFlexModuleFactory implementation defined in the module. |
| This will only be non-<code>null</code> after the |
| <code>ModuleEvent.SETUP</code> event has been dispatched |
| (or the <code>IModuleInfo.setup()</code> method returns <code>true</code>). |
| At this point, the <code>IFlexModuleFactory.info()</code> method can be called. |
| Once a <code>ModuleEvent.READY</code> event is dispatched |
| (or the <code>IModuleInfo.ready()</code> method returns <code>true</code>), |
| it is possible to call the <code>IFlexModuleFactory.create()</code> method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get factory():<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code><br/></div><a name="propertyDetail"></a><a name="loaded"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">loaded</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>loaded:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that is <code>true</code> if the <code>load()</code> |
| method has been called on this module. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get loaded():Boolean</code><br/></div><a name="propertyDetail"></a><a name="ready"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ready</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>ready:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that is <code>true</code> if the module is sufficiently loaded |
| to get a handle to its associated IFlexModuleFactory implementation |
| and call its <code>create()</code> method. |
| |
| <p>This flag is <code>true</code> when the ModuleManager dispatches the |
| <code>ModuleEvent.READY</code> event.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get ready():Boolean</code><br/></div><a name="propertyDetail"></a><a name="setup"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setup</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>setup:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that is <code>true</code> if the module is sufficiently loaded |
| to get a handle to its associated IFlexModuleFactory implementation |
| and call its <code>info()</code> method. |
| |
| <p>This flag is <code>true</code> when the ModuleManager dispatches the |
| <code>ModuleEvent.SETUP</code> event.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get setup():Boolean</code><br/></div><a name="propertyDetail"></a><a name="url"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>url:String</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The URL associated with this module (for example, "MyImageModule.swf" or |
| "http://somedomain.com/modules/MyImageModule.swf". The URL can be local or remote, but |
| if it is remote, you must establish a trust between the module's domain and the |
| application that loads it. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get url():String</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="load()"></a><a name="load(flash.system.ApplicationDomain,flash.system.SecurityDomain,flash.utils.ByteArray,mx.core.IFlexModuleFactory)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">load</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function load(applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null, bytes:ByteArray = null, moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a> = null):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Requests that the module be loaded. If the module is already loaded, |
| the call does nothing. Otherwise, the module begins loading and dispatches |
| <code>progress</code> events as loading proceeds. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">applicationDomain</span>:ApplicationDomain</code> (default = <code>null</code>)<code></code> — The current application domain in which your code is executing. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">securityDomain</span>:SecurityDomain</code> (default = <code>null</code>)<code></code> — The current security "sandbox". |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">bytes</span>:ByteArray</code> (default = <code>null</code>)<code></code> — A ByteArray object. The ByteArray is expected to contain |
| the bytes of a SWF file that represents a compiled Module. The ByteArray |
| object can be obtained by using the URLLoader class. If this parameter |
| is specified the module will be loaded from the ByteArray. If this |
| parameter is null the module will be loaded from the url specified in |
| the url property. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">moduleFactory</span>:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code> (default = <code>null</code>)<code></code> — The moduleFactory of the caller. One use of the |
| moduleFactory is to determine the parent style manager of the loaded |
| module. |
| |
| </td></tr></table></p></div><a name="publish()"></a><a name="publish(mx.core.IFlexModuleFactory)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">publish</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function publish(factory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Publishes an interface to the ModuleManager. This allows late (or decoupled) |
| subscriptions to factories with a String handle. Use a URL that starts with |
| <code>publish://</code> to reference factories that are published in this manner. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">factory</span>:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code> — The class that implements the module's IFlexModuleFactory interface. |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ModuleManager.html" target="">mx.modules.ModuleManager</a></div></div><a name="release()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">release</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function release():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Releases the current reference to the module. |
| This does not unload the module unless there are no other |
| open references to it and the ModuleManager is set up |
| to have only a limited number of loaded modules. |
| |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ModuleManager.html" target="">mx.modules.ModuleManager</a></div></div><a name="unload()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unload</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function unload():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Unloads the module. |
| Flash Player and AIR will not fully unload and garbage collect this module if |
| there are any outstanding references to definitions inside the |
| module. |
| |
| </p></div><div class="detailSectionHeader"> Event Detail </div><a name="event:error"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">error</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ModuleEvent.html"><code>mx.events.ModuleEvent</code></a><br/><span class="label">ModuleEvent.type property = </span><a href="../../mx/events/ModuleEvent.html#ERROR"><code>mx.events.ModuleEvent.ERROR</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the backing ModuleInfo if there was an error during |
| module loading. |
| </p> |
| Dispatched when there is an error downloading the module. |
| The <code>ModuleEvent.ERROR</code> constant defines the value of the |
| <code>type</code> property of the event object for an <code>error</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>bytesLoaded</code></td><td>Empty</td></tr><tr><td><code>bytesTotal</code></td><td>Empty</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>errorText</code></td><td>The error message.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:progress"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">progress</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ModuleEvent.html"><code>mx.events.ModuleEvent</code></a><br/><span class="label">ModuleEvent.type property = </span><a href="../../mx/events/ModuleEvent.html#PROGRESS"><code>mx.events.ModuleEvent.PROGRESS</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the backing ModuleInfo at regular intervals |
| while the module is being loaded. |
| </p> |
| Dispatched when the module is in the process of downloading. This module is |
| dispatched at regular intervals during the download process. |
| The <code>ModuleEvent.PROGRESS</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>progress</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>bytesLoaded</code></td><td>The number of bytes loaded.</td></tr><tr><td><code>bytesTotal</code></td><td>The total number of bytes to load.</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>errorText</code></td><td>Empty</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:ready"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ready</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ModuleEvent.html"><code>mx.events.ModuleEvent</code></a><br/><span class="label">ModuleEvent.type property = </span><a href="../../mx/events/ModuleEvent.html#READY"><code>mx.events.ModuleEvent.READY</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the backing ModuleInfo once the module is sufficiently |
| loaded to call the <code>IModuleInfo.factory()</code> method and the |
| <code>IFlexModuleFactory.create()</code> method. |
| </p> |
| Dispatched when the module has finished downloading. |
| The <code>ModuleEvent.READY</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>complete</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>bytesLoaded</code></td><td>The number of bytes loaded.</td></tr><tr><td><code>bytesTotal</code></td><td>The total number of bytes to load.</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>errorText</code></td><td>Empty</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:setup"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setup</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ModuleEvent.html"><code>mx.events.ModuleEvent</code></a><br/><span class="label">ModuleEvent.type property = </span><a href="../../mx/events/ModuleEvent.html#SETUP"><code>mx.events.ModuleEvent.SETUP</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the backing ModuleInfo once the module is sufficiently |
| loaded to call the <code>IModuleInfo.factory()</code> method and |
| the <code>IFlexModuleFactory.info()</code> method. |
| </p> |
| Dispatched when enough of a module has been downloaded that you can get information |
| about the module. You do this by calling the <code>IFlexModuleFactory.info()</code> |
| method on the module. |
| The <code>ModuleEvent.SETUP</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>setup</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>bytesLoaded</code></td><td>Empty</td></tr><tr><td><code>bytesTotal</code></td><td>Empty</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>errorText</code></td><td>An error message.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:unload"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unload</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ModuleEvent.html"><code>mx.events.ModuleEvent</code></a><br/><span class="label">ModuleEvent.type property = </span><a href="../../mx/events/ModuleEvent.html#UNLOAD"><code>mx.events.ModuleEvent.UNLOAD</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the backing ModuleInfo when the module data is unloaded. |
| </p> |
| Dispatched when the module is unloaded. |
| The <code>ModuleEvent.UNLOAD</code> constant defines the value of the |
| <code>type</code> property of the event object for an <code>unload</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>bytesLoaded</code></td><td>Empty</td></tr><tr><td><code>bytesTotal</code></td><td>Empty</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>errorText</code></td><td>An error message.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
