biresourceloader.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiResourceLoader" extends="BiEventTarget">
	<description>This class is used to load different kinds of resources. There are basically
 3 types of resources that this class can handle. The first 2 are script files
 and a code string. The third one is a genereal object described by an XML
 element and in this case an object is created using a<link class="BiXmlResourceParser">BiXmlResourceParser</link>.<br>
		</br>
		<br>
		</br>
 When creating general objects a few special rules apply. If the created object
 is an event target the resource loader will listen to <code>load</code>
 and <code>error</code> events so that it can be notified by the object that
 it is loaded. If the object has a <code>load()</code> method that will be
 called if the object is not already loaded. To decide if the object is loaded
 the resource loader will use <code>getLoaded()</code> if available and if that
 isn't available it is assumed that the object is loaded (or does not require
 loading).</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getResourceById">
			<description>Returns the resource with the given id</description>
			<arguments>
				<argument name="sId">
					<description>The id of the resource to lookup</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="addResource">
			<description>Adds a resource that the resource loader will instantiate and load.</description>
			<arguments>
				<argument name="sType">
					<description>This is either one of the following 2 types or the
 							name of the class to use to instantiate the object.
                          If a class name is passed then the oData argument
                          should be an XML element that is then used to
                          describe the object.<br>
						</br>
						<br>
						</br>
						<code>script</code> - the oData is treated as URI of the script file<br>
						</br>
						<code>inlinescript</code> - the oDate string is treated as the script code</description>
					<type>String</type>
				</argument>
				<argument name="oData">
					<description>For script this should be the URI of the script file.
 							This is UIR is relative to the ADF file.
 							For inlinescript this is the script code as a string.
                          For a general object this should be an XML element that
                          is then passed to a<link class="BiXmlResourceLoader">BiXmlResourceLoader</link> which will instantiate
                          the object.</description>
					<type>Object</type>
				</argument>
				<argument name="sId" optional="true">
					<description>Optional id to use to find the source using
 							<link>getResourceById</link>. If a general
 							object is used the id attribute in the XML element is
                          used instead.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="load">
			<description>Starts the loading of the resource. The loading is done
 asynchronously so this will return immediately. When all resources
 are loaded the <link>load</link> event will fire.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="abort">
			<description>Stops the current loading</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="autoNameMapping" get="true" set="true">
			<description>When this is true any XML object that has an id attribute will create a
 global reference to the object created from this XML element.</description>
			<type>Boolean</type>
		</property>
		<property name="loaded" get="true">
			<description>Whether all resources have been loaded.</description>
			<type>Boolean</type>
		</property>
		<property name="loadedCount" get="true">
			<description>The number of finished loading resources. This includes inline scripts and
 general objects as well.</description>
			<type>Number</type>
		</property>
		<property name="count" get="true">
			<description>The number of added resources</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
		<event name="progress">
			<description>Fires every time one of the external resources have
 							been loaded. This is useful for providing visual feedback.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="load">
			<description>Fires when all the resources have been loaded and executed</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>