biselectionitemcollection.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiSelectionItemCollection" extends="BiObject">
	<description>This class is used internally inside<link class="BiSelectionModel">BiSelectionModel</link> to keep track of the
 selected items. If you create a custom selection model you might need to also
 create a custom selection model item collection. The type of the items is not
 very important but the selection model needs to be able to work with this
 type. You also need to override <link>getItemHashCode</link> if the items
 are not instances of<link class="BiObject">BiObject</link>.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="add">
			<description>Adds an item to the collection</description>
			<arguments>
				<argument name="oItem">
					<description>The item to add</description>
					<type>
						<link class="BiObject">BiObject</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="remove">
			<description>Removes an item from the collection</description>
			<arguments>
				<argument name="oItem">
					<description>The item to remove</description>
					<type>
						<link class="BiObject">BiObject</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes all items from the collection</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="contains">
			<description>Checks whether an item is contained in the collection</description>
			<arguments>
				<argument name="oItem">
					<description>The item to check for</description>
					<type>
						<link class="BiObject">BiObject</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="toArray">
			<description>Returns an array with the items in the collection</description>
			<arguments>
			</arguments>
			<returns>
				<type>
					<link class="BiObject">BiObject[]</link>
				</type>
			</returns>
		</method>
		<method name="getItemHashCode">
			<description>This should return the hash code for an item</description>
			<arguments>
				<argument name="oItem">
					<description>The item to get the hash code for.</description>
					<type>
						<link class="BiObject">BiObject</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="isEmpty">
			<description>Whether the collection is empty or not</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="changeValue" get="true">
			<description>This returns a value that can later be compared to another value to see
 whether the collection has changed</description>
			<type>Object</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>