bitimer.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTimer" extends="BiEventTarget">
	<description>This class can be used to schedule events to occur later in time.</description>
	<arguments>
		<argument name="nInterval" optional="true" default="1000">
			<description>The number of milliseconds between the firing of the <link>tick</link> events.</description>
			<type>Number</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="callOnce">
			<description>This method calls a function once after a certain time. The thirde argument
 allows you to set what object the function is a method of allowing you to
 correctly use the this keyword in the function.</description>
			<arguments>
				<argument name="fun">
					<description>The function object to call</description>
					<type>Function</type>
				</argument>
				<argument name="time" optional="true" default="1">
					<description>The number of milliseconds to wait before calling the function.</description>
					<type>Number</type>
				</argument>
				<argument name="obj">
					<description>The number to call the function as a method of.</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="start">
			<description>Starts and enables the timer. Every <link>interval</link> ms the
 <link>tick</link> event is fired (unless the timer has been disabled).</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="stop">
			<description>Stops and disables the timer</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="enabled" get="true" set="true">
			<description>If this is false no <link>tick</link> events are fired.</description>
			<type>Boolean</type>
		</property>
		<property name="interval" get="true" set="true">
			<description>The number of milliseconds between the firing of the <link>tick</link>
 events. Changing this also stops the timer.</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
		<event name="tick">
			<description>Fires every <link>interval</link> milliseconds for
 							an <link>enabled</link> and started timer.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>Be careful when using timers so that they are not fired when some
 			dependent object has been disposed. Either dispose or stop the timer
          object when it no longer can be used due to its dependencies.</remarks>
</class>