biarea.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiArea" extends="BiObject">
	<description>This class represents an area with a given left, top, width and height</description>
	<arguments>
		<argument name="nLeft">
			<description>The left positon</description>
			<type>Number</type>
		</argument>
		<argument name="nTop">
			<description>The top positon</description>
			<type>Number</type>
		</argument>
		<argument name="nWidth" optional="true" default="1">
			<description>The width </description>
			<type>Number</type>
		</argument>
		<argument name="nHeight" optional="true" default="1">
			<description>The height </description>
			<type>Number</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="enclose">
			<description>This takes two areas and returns another area that completely encloses both
 these areas</description>
			<arguments>
				<argument name="a1">
					<description>The first area to enclose</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
				<argument name="a2">
					<description>The second area to enclose</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiArea">BiArea</link>
				</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="hitTest">
			<description>Tests whether a point is inside the area</description>
			<arguments>
				<argument name="x">
					<description>The x coordinate</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The y coordinate</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="contains">
			<description>Tests whether this area completely encloses another area</description>
			<arguments>
				<argument name="a">
					<description>The area to test if enclosed</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="equals">
			<description>Whether this area is representing the same area as another</description>
			<arguments>
				<argument name="oArea">
					<description>The area to test with</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="left" get="true" set="true">
			<description>The left postion of the area</description>
			<type>Number</type>
		</property>
		<property name="top" get="true" set="true">
			<description>The top postion of the area</description>
			<type>Number</type>
		</property>
		<property name="width" get="true" set="true">
			<description>The width of the area</description>
			<type>Number</type>
		</property>
		<property name="height" get="true" set="true">
			<description>The height of the area</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>