biareacollection.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiAreaCollection" extends="BiObject">
	<description>This collection contains<link class="BiArea">BiArea</link> objects

 This implements the same interface as<link class="BiSelectionItemCollection">BiSelectionItemCollection</link>
	</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="add">
			<description>Adds an area to the collection. This does not check whether the area
 might intersect with any of the existing areas in the collection</description>
			<arguments>
				<argument name="oArea">
					<description>The area to add</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="hitTest">
			<description>Tests whether a point is inside any of the areas in the collection</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="remove">
			<description>Removes an area from the collection.</description>
			<arguments>
				<argument name="oArea">
					<description>The area to remove</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes all the areas in the collection making it empty</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="contains">
			<description>Whether the collection contains the area. This also returns true if
 one of the areas in the collection completely encloses the area.</description>
			<arguments>
				<argument name="oArea">
					<description>The area to test whether the collection contains</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getItemHashCode">
			<description>Returns an identifier for the area</description>
			<arguments>
				<argument name="oItem">
					<description>The area to get the identifier for</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="toArray">
			<description>Returns an array containing the areas in the collection</description>
			<arguments>
			</arguments>
			<returns>
				<type>
					<link class="BiArea">BiArea[]</link>
				</type>
			</returns>
		</method>
		<method name="isEmpty">
			<description>Whether the collection is empty</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="changeValue" get="true">
			<description>This is used by<link class="BiSelectionModel">BiSelectionModel</link> to compare whether the collection has changed.
 Two identical collections should always return the same value. If a change has
 occured the change value must also change</description>
			<type>Object</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>