bitreenode.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeNode" extends="BiAbstractGridRow">
	<description>This represents a tree node for a <link class="BiTree">tree</link> or a
 row for a <link class="BiTree">tree</link>. A tree node is not a component
 but it has some visual properties that are similar to a
 <link class="BiComponent">component</link>.<br>
		</br>
		<br>
		</br>
 When working with trees and column list it is usually suitable to extend
 this class instead of using it directly because this gives better control
 over what data is bound to the node and what text to show on the row.</description>
	<arguments>
		<argument name="oData" optional="true" default="[]">
			<description>This is an array containing the data to be used for each column. </description>
			<type>Object[]</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getData">
			<description>Returns the data for the given column index</description>
			<arguments>
				<argument name="x">
					<description>The column index of the column to get the data for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="setData">
			<description>Sets the data for a given column index</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to set the data for</description>
					<type>Number</type>
				</argument>
				<argument name="oData">
					<description>The data to set on the given column</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCellHtml">
			<description>Returns the HTML for the entire cell (includes indention, expand icon and icon)</description>
			<arguments>
				<argument name="nCol">
					<description>The column to get the cell HTML for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getLabelHtml">
			<description>Returns the actual HTML to show on the cell. Override this to handle specific
 data. The default implementation uses <code>String(treeNode.getData(nCol))</code>
			</description>
			<arguments>
				<argument name="nCol">
					<description>The column to get the label html for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="update">
			<description>Updates the node and all of its children. This allows the tree to redraw
 only the current branch of the tree.
 This is useful when only a few items have changed and therefore
 the whole data of the tree does not need to be redrawn.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateRow">
			<description>Updates the row of the tree node. This allows the tree to redraw
 only the current tree item row (the children are not redrawn).
 This is useful when only a few items have changed and therefore
 the whole data of the tree does not need to be redrawn.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addNode">
			<description>Adds a tree node as a child to the current tree node</description>
			<arguments>
				<argument name="oChild">
					<description>The tree node child to add</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>If provided, the child is added before this node </description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeNode">
			<description>Removes a tree node child</description>
			<arguments>
				<argument name="oChild">
					<description>The node to remove</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode</link>
				</type>
			</returns>
		</method>
		<method name="removeNodeAt">
			<description>Removes the tree node child at the given index</description>
			<arguments>
				<argument name="i">
					<description>The index of the node to remove</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode">BiTreeNode</link>
				</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes all child nodes (and disposes them)</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="containsNode">
			<description>Whether the tree node contains another node</description>
			<arguments>
				<argument name="oDescendant">
					<description>The node to test if it is contained</description>
					<type>
						<link class="BiTreeNode">BiTreeNode</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="hasNodes">
			<description>Returns true if the tree node has any child nodes</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="isLeaf">
			<description>Returns true if the tree node has no child nodes</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="isLastSiblingNode">
			<description>Returns true if the node has no next sibling node.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="reveal">
			<description>Expands all parent tree nodes to make this node visible</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="toggle">
			<description>Toggles the expand property</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="html" get="true">
			<description>Returns the HTML for the node and all its children. This is used
 by the <link class="BiTree" field="treeBodyHtml">BiTree treeBodyHtml
 property</link> when drawing the tree.</description>
			<type>String</type>
		</property>
		<property name="rowHtml" get="true">
			<description>Returns the HTML for the row of the node. This does not include
 any of the child nodes for the tree node.</description>
			<type>String</type>
		</property>
		<property name="cssClassName" get="true">
			<description>Returns the CSS class name used for the row of the node.</description>
			<type>String</type>
		</property>
		<property name="iconHtml" get="true">
			<description>Returns the HTML used to draw the icon.</description>
			<type>String</type>
		</property>
		<property name="expandIconSrc" get="true">
			<description>Returns the URI to the image file that should be used for the expand icon.</description>
			<type>String</type>
		</property>
		<property name="expandIconHtml" get="true">
			<description>Returns the HTML used to draw the expand icon.</description>
			<type>String</type>
		</property>
		<property name="parentNode" get="true">
			<description>Returns the parent tree node.</description>
			<type>
				<link class="BiTreeNode">BiTreeNode</link> /<link class="BiTree">BiTree</link>
			</type>
		</property>
		<property name="nodes" get="true">
			<description>Returns all the child nodes.</description>
			<type>
				<link class="BiTreeNode">BiTreeNode[]</link>
			</type>
		</property>
		<property name="firstNode" get="true">
			<description>Returns the first child node.</description>
			<type>
				<link class="BiTreeNode">BiTreeNode</link>
			</type>
		</property>
		<property name="lastNode" get="true">
			<description>Returns the last child node.</description>
			<type>
				<link class="BiTreeNode">BiTreeNode</link>
			</type>
		</property>
		<property name="previousSiblingNode" get="true">
			<description>Returns the previous tree node sibling (if any).</description>
			<type>
				<link class="BiTreeNode">BiTreeNode</link>
			</type>
		</property>
		<property name="nextSiblingNode" get="true">
			<description>* Returns the next tree node sibling (if any).</description>
			<type>
				<link class="BiTreeNode">BiTreeNode</link>
			</type>
		</property>
		<property name="level" get="true">
			<description>The level of indention for the tree.</description>
			<type>Number</type>
		</property>
		<property name="grid" get="true">
			<description>Returns the tree component that the node is part of. Same as <link>tree</link>
			</description>
			<type>
				<link class="BiTree">BiTree</link>
			</type>
		</property>
		<property name="tree" get="true">
			<description>Returns the tree component that the node is part of</description>
			<type>
				<link class="BiTree">BiTree</link>
			</type>
		</property>
		<property name="depth" get="true">
			<description>The depth of the tree</description>
			<type>Number</type>
		</property>
		<property name="expanded" get="true" set="true">
			<description>Whether the node is expanded or not.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>Changing the node does not automatically update the tree. The
 			<link class="BiTree">tree</link> will have to be updated manually.</remarks>
</class>