biuri.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiUri" extends="BiObject">
	<description>This class is used to define a Universal Resource Identifier (URI). This
 is sometimes also known as a Uniform Resource Locator (URL). A URI is
 used to describe the location and source of external files. A URI is
 only a representaion of the string format describing the URI. It does
 not know how to lookup the information the URI might point at.<br>
		</br>
		<br>
		</br>
 A general URI has the following format. Below this is a list of what
 part of the URI maps to what property.<br>
		</br>
		<br>
		</br>
		<code>http://user:[e-mail]:80/dir/file.html?param0=value=0;param1=value1#fragment</code>
		<br>
		</br>
		<br>
		</br>
		<link>scheme</link> - http<br>
		</br>
		<link>userInfo</link> - user:password<br>
		</br>
		<link>host</link> - www.domain.com<br>
		</br>
		<link>port</link> - 80<br>
		</br>
		<link>path</link> - /dir/file.html<br>
		</br>
		<link>dirPath</link> - /dir/<br>
		</br>
		<link>query</link> - ?param0=value=0;param1=value1
 <link>fragment</link> - #fragment<br>
		</br>
		<link>getParam</link>("param0") - value0<br>
		</br>
		<link>getParam</link>("param1") - value1<br>
		</br>
		<link>href</link> - http://user:[e-mail]:80/dir/file.html?param0=value=0;param1=value1#fragment<br>
		</br>
	</description>
	<arguments>
		<argument name="sBase" optional="true">
			<description>The base URI </description>
			<type>String</type>
		</argument>
		<argument name="sRel" optional="true">
			<description>The URI relative to the base URI. If this describes an absolute URI then the base URI will be replaced.</description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getParam">
			<description>Gets the value for a param. This returns <code>undefined</code> if the param is not
 present. This returns <code>null</code> if the param is present but it does
 not have a value associated with it.</description>
			<arguments>
				<argument name="sName">
					<description>The name of the param</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="setParam">
			<description>Sets the value for a param.</description>
			<arguments>
				<argument name="sName">
					<description>The name of the param</description>
					<type>String</type>
				</argument>
				<argument name="sValue">
					<description>The value of the param</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeParam">
			<description>Removes the params with the given param name</description>
			<arguments>
				<argument name="sName">
					<description>The name of the param to remove</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="hasParam">
			<description>Whether the URI has a param with the given name</description>
			<arguments>
				<argument name="sName">
					<description>The name of the param to check for</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getParams">
			<description>Returns all the params with the given name</description>
			<arguments>
				<argument name="sName">
					<description>The name of the params to get.</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String[]</type>
			</returns>
		</method>
		<method name="addParam">
			<description>Adds a param with a given name and value. This is similar to <link>setParam</link>
 except that it does not overwrite existing paramaters with the same name.</description>
			<arguments>
				<argument name="sName">
					<description>The name of the param</description>
					<type>String</type>
				</argument>
				<argument name="sValue">
					<description>The value of the param</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="scheme" get="true">
			<description>The scheme is the first part of the URI and is the text before
 the first ':'. For example "http", "mailto" and "file" are
 common schemes.</description>
			<type>String</type>
		</property>
		<property name="path" get="true">
			<description>This is the part of the URI that comes after the port. It includes
 the file part of URI if available.</description>
			<type>String</type>
		</property>
		<property name="dirPath" get="true">
			<description>This is the part of the URI discribing the directory and it
 does not include the file name. This ends with a '/' if the
 path is available.</description>
			<type>String</type>
		</property>
		<property name="host" get="true">
			<description>The name of the host (or domain) that the URI points at. For a
 mailto URI this is the part after the '@'.</description>
			<type>String</type>
		</property>
		<property name="port" get="true">
			<description>This is the port part of the URI.</description>
			<type>String</type>
		</property>
		<property name="fragment" get="true">
			<description>This is all the text coming after (and including) the first '#'
 character.</description>
			<type>String</type>
		</property>
		<property name="userInfo" get="true">
			<description>This is the part of the URI used to describe the user information.
 This is the part coming after the scheme but before the domain.
 This is empty when no user information is available.</description>
			<type>String</type>
		</property>
		<property name="href" get="true" set="true">
			<description>This is the complete string representation of the URI.</description>
			<type>String</type>
		</property>
		<property name="query" get="true">
			<description>This is all the text coming after (and including) the first '?'
 character. If the URI has a fragment the fragment is not included
 in the query.</description>
			<type>String</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>