bitextloader.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTextLoader" extends="BiEventTarget">
	<description>This class is used to load a plain text document from the server or the
 file system (if the application is run locally).</description>
	<arguments>
	</arguments>
	<staticMethods>
		<method name="load">
			<description>Loads a file synchronously from the given URI and returns the text content
 the file</description>
			<arguments>
				<argument name="oUri">
					<description>The location of the file. If this is a string a
 							new URI is created from that string relative to the
                          <link class="BiApplication" field="adfPath">ADF path</link>.</description>
					<type>
						<link class="BiUri">BiUri</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="load">
			<description>Does an HTTP GET to recieve the file</description>
			<arguments>
				<argument name="oUri">
					<description>The location of the file. If this is a string a
 							new URI is created from that string relative to the
                          <link class="BiApplication" field="adfPath">ADF path</link>.</description>
					<type>
						<link class="BiUri">BiUri</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="post">
			<description>Does an HTTP POST to recieve the file. A<link class="BiXmlDocument">BiXmlDocument</link> can be sent to
 the server containing the data. The data sent can also be a string and in this
 case the content type of the underlying<link class="BiXmlHttp">BiXmlHttp</link> should be set.</description>
			<arguments>
				<argument name="oUri">
					<description>The location of the file. If this is a string a
 							new URI is created from that string relative to the
                          <link class="BiApplication" field="adfPath">ADF path</link>.</description>
					<type>
						<link class="BiUri">BiUri</link>
					</type>
				</argument>
				<argument name="oXmlDocument" optional="true">
					<description>An XML document containing the POST data </description>
					<type>
						<link class="BiXmlDocument">BiXmlDocument</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="open">
			<description>Prepares the text loader so that data can be sent and recieved. After the
 loader has been opened you can use <link>send</link> to start the send/load.
 This is done automatically when using <link>load</link> and <link>post</link>.</description>
			<arguments>
				<argument name="sMethod">
					<description>The HTTP method used to send/load the data. For
 								example <code>GET</code> and <code>POST</code>.</description>
					<type>String</type>
				</argument>
				<argument name="oUri">
					<description>The location of the file. If this is a string a
 								new URI is created from that string relative to the
                              <link class="BiApplication" field="adfPath">ADF path</link>.</description>
					<type>
						<link class="BiUri">BiUri</link>
					</type>
				</argument>
				<argument name="bAsync" optional="true">
					<description>Whether to load the text file asynchronously or synchronously </description>
					<type>Boolean</type>
				</argument>
				<argument name="sUser" optional="true">
					<description>The user name to use for authentication. If empty no authentacation is used. </description>
					<type>String</type>
				</argument>
				<argument name="sPassword" optional="true">
					<description>The password to use for authentication. If empty no authentacation is used. </description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="send">
			<description>Starts the HTTP request and loads the result. If an argument
 is provided this is either a<link class="BiXmlDocument">BiXmlDocument</link>
 or a <code>String</code>. You can simulate a HTML form post by encoding the
 string as a <code>application/x-www-form-urlencoded</code> and by setting
 the <code>Content-Type</code> request header of the <link>xmlHttp</link>
 object.</description>
			<arguments>
				<argument name="oObject">
					<description>An XML document or a string containing the POST data</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="abort">
			<description>Stops the loading of the current file</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="method" get="true" set="true">
			<description>The HTTP method to use for the request</description>
			<type>String</type>
		</property>
		<property name="uri" get="true" set="true">
			<description>The URI (location) of the file to load. If this is set to a string a
 new URI is created from that string relative to the
 <link class="BiApplication" field="adfPath">ADF path</link>.</description>
			<type>
				<link class="BiUri">BiUri</link>
			</type>
		</property>
		<property name="async" get="true" set="true">
			<description>Whether to load the text file asynchronously</description>
			<type>Boolean</type>
		</property>
		<property name="user" get="true" set="true">
			<description>The user name to use when authentication is needed to load the file</description>
			<type>String</type>
		</property>
		<property name="password" get="true" set="true">
			<description>The password to use when authentication is needed to load the file</description>
			<type>String</type>
		</property>
		<property name="loaded" get="true">
			<description>Whether the file has been loaded</description>
			<type>Boolean</type>
		</property>
		<property name="loading" get="true">
			<description>Whether a file is currently being loaded</description>
			<type>Boolean</type>
		</property>
		<property name="text" get="true">
			<description>The text inside the file</description>
			<type>String</type>
		</property>
		<property name="xmlHttp" get="true">
			<description>The underlying <link class="BiXmlHttp">BiXmlHttp</link> that handles the communication.</description>
			<type>
				<link class="BiXmlHttp">BiXmlHttp</link>
			</type>
		</property>
		<property name="error" get="true">
			<description>Whether any error occured when loading the file</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="load">
			<description>Fires when the file has been loaded</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>Using syncronous loading freezes the web browser while the loading
 			takes place. This should be prevented as much as possible and
          therefore asynchronous loading is preferred.</remarks>
</class>