bitreehelper.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeHelper" extends="BiObject">
	<description>This class contains some static methods that are usufull when working
 with trees.</description>
	<arguments>
	</arguments>
	<staticMethods>
		<method name="getLastShownDescendant">
			<description>Returns the last shown node in the sub tree of the node</description>
			<arguments>
				<argument name="n">
					<description>The node to get the last shown descendant for</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode</link>
				</type>
			</returns>
		</method>
		<method name="getNextShownNode">
			<description>Returns the next shown node. This is the next node in the
 preorder traversal. This can also be seen as the next row.</description>
			<arguments>
				<argument name="n">
					<description>The node to get the next shown node after</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode</link>
				</type>
			</returns>
		</method>
		<method name="getPreviousShownNode">
			<description>Returns the previous shown node. This is the previous node in the
 preorder traversal. This can also be seen as the previous row.</description>
			<arguments>
				<argument name="n">
					<description>The node to get the previous shown node before</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode</link>
				</type>
			</returns>
		</method>
		<method name="getPreorderShownNodes">
			<description>Returns all shown descendants in preorder. This mean that they are
 ordered in the same order as the rows are shown. (Document order)</description>
			<arguments>
				<argument name="n">
					<description>The node to get the descendants of</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode[]</link>
				</type>
			</returns>
		</method>
		<method name="isBefore">
			<description>Returns whether the first node comes before the second node. This
 is done using preorder. This means a node comes before another node
 if its row is displayed above the others in the visual tree. A node
 is not before itself. Both<link class="BiTreeNode">BiTreeNode</link> and<link class="BiTree">BiTree</link> objects can be compared</description>
			<arguments>
				<argument name="n1">
					<description>The node to see if it comes first</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
				<argument name="n2">
					<description>The node to see if it comes last</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
	</methods>
	<properties>
	</properties>
	<events>
	</events>
	<remarks>All the methods that contain "shown" operates on the visual state of
 			the tree. This means that a node with children that is collapsed is
             seen as a leaf.</remarks>
</class>