bitreeiterator.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeIterator" extends="BiObject">
	<description>This class is used for iterating over rows and subtrees in a tree</description>
	<arguments>
		<argument name="oIterator" optional="true">
			<description>optional parameter. If provided then the new
 								iterator will be a copy of the old one</description>
			<type>
				<link class="BiTreeIterator">BiTreeIterator</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="next">
			<description>this increments the iterator a step</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="previous">
			<description>this decrements the iterator a step</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="append">
			<description>Descends into a subtree</description>
			<arguments>
				<argument name="oSubtree">
					<description>The subtree to descend into</description>
					<type>
						<link class="BiSubtree">BiSubtree</link>
					</type>
				</argument>
				<argument name="nChildIndex">
					<description>The child index of the current tree</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="pop">
			<description>Pops the iterator up one level</description>
			<arguments>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeIterator">BiTreeIterator</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="rowIndex" get="true" set="true">
			<description>The row index that the iterator is currently at</description>
			<type>Number</type>
		</property>
		<property name="parent" get="true">
			<description>the parent of the current item</description>
			<type>
				<link class="BiSubtree">BiSubtree</link>
			</type>
		</property>
		<property name="childIndex" get="true">
			<description>the child index of the item that the iterator is currently at</description>
			<type>Number</type>
		</property>
		<property name="depth" get="true">
			<description>the depth of the item the iterator is currently at</description>
			<type>Number</type>
		</property>
		<property name="node" get="true">
			<description>The current node object</description>
			<type>Object</type>
		</property>
		<property name="subtree" get="true">
			<description>The current subtree</description>
			<type>
				<link class="BiSubtree">BiSubtree</link>
			</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>