biorderediterator.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiOrderedIterator" extends="BiObject">
	<description>This is an ordered iterator that allows you to add items ordered by an index.
 The items are ordered based on the index and finding and removing an item
 based on its index is done in constant time. Inserting an item is in worst
 case O(n) (where n is the number of items in the iterator).</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="add">
			<description>Adds an value with an index. Adding an item using an index that already
 exists in the iterator overwrites the old item.</description>
			<arguments>
				<argument name="nIndex">
					<description>The index to order the value by.</description>
					<type>Number</type>
				</argument>
				<argument name="val">
					<description>The value to add at the given index</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="remove">
			<description>Removes the item at the given index and returns it.</description>
			<arguments>
				<argument name="nIndex">
					<description>The index of the value to remove</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="first">
			<description>Resets the iterator to the first item</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="next">
			<description>Advances the iterator to the next item</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="containsIndex">
			<description>Whether the iterator contains an item with the given index</description>
			<arguments>
				<argument name="nIndex">
					<description>The index to check for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getValueAt">
			<description>Returns the value at the given index</description>
			<arguments>
				<argument name="nIndex">
					<description>The index to get the value for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="done" get="true">
			<description>Whether the iterator is finished (has passed the end).</description>
			<type>Boolean</type>
		</property>
		<property name="count" get="true">
			<description>The number of items in the iterator</description>
			<type>Number</type>
		</property>
		<property name="currentValue" get="true">
			<description>Returns the value for the current item.</description>
			<type>Object</type>
		</property>
		<property name="currentIndex" get="true">
			<description>Returns the index of the curren item</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>