biimagepreloader.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 52 行

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiImagePreloader" extends="BiEventTarget">

	<description>
		This class handles preloading of an image. There will never be more than
		one instance of this class per image URI. So if there already exists a
		preloader for the given URI that will be returned.<br/>
		<br/>
		Since there might be other objects dependent on the current instance it
		is not a good idea to call dispose on the instance object. Disposal is
		handled by the system.
	</description>

	<arguments>
		<argument name="sUri" type="String" description="The location of the image file to preload"/>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods/>

	<properties>
		<property name="width" type="Number" description="The natural width of the image.
			This might be undefined before the image has loaded" get="true"/>
		<property name="height" type="Number" description="The natural height of the image.
			This might be undefined before the image has loaded" get="true"/>
		<property name="loaded" type="Boolean" get="true">
			<description>
				This becomes <code>true</code> once the image is loaded
			</description>
		</property>
	</properties>

	<events>
		<event name="load" description="Fires when the image file loads">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<event name="error" description="Fires if the image file fails to load">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
	</events>

	<remarks>
		The image file might already be loaded when the constructor returns and
		therefore it is not sufficient to depend on the <link>load</link> event.
		Therefore it is a good idea to check <link>loaded</link> as well.
	</remarks>
</class>