bitreedatamodel.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeDataModel" extends="BiTreeViewDataModel">
	<description>This data model takes a a tree consisting of<link class="BiTreeNode2">BiTreeNode2</link> nodes and exposes
 the interface needed by the<link class="BiTreeView">BiTreeView</link>. The internal tree does not have to
 be a<link class="BiTreeNode2">BiTreeNode2</link> as long as getNodeChildren, getNodeHashCode, getCellText and
 getSortFunction (if sorting is needed) are overridden.
 The default implementation assumes that the data in the<link class="BiTreeNode2">BiTreeNode2</link> objects
 are arrays containing the cell data.</description>
	<arguments>
		<argument name="oRootNode" optional="true">
			<description>The optional node to act as the root for the data</description>
			<type>
				<link class="BiTreeNode2">BiTreeNode2</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getNodeAt">
			<description>This returns the node at the given row</description>
			<arguments>
				<argument name="y">
					<description>The index of the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode2">BiTreeNode2</link>
				</type>
			</returns>
		</method>
		<method name="getNodeChildren">
			<description>This returns the children of the tree node that is the root of the data. This should be overridden if your nodes are not instances of<link class="BiTreeNode2">BiTreeNode2</link>
			</description>
			<arguments>
				<argument name="oNode">
					<description>The object that acts as the root node</description>
					<type>
						<link class="BiTreeNode2">BiTreeNode2</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeNode2">BiTreeNode2[]</link>
				</type>
			</returns>
		</method>
		<method name="removeRowAt">
			<description>Removes the row at the given row. This also removes any possible subtree of
 the node</description>
			<arguments>
				<argument name="y">
					<description>the row to remove</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="insertRowAt">
			<description>inserts a new object into the tree rows</description>
			<arguments>
				<argument name="obj">
					<description>The object describing the data</description>
					<type>
						<link class="BiTreeNode2">BiTreeNode2</link>
					</type>
				</argument>
				<argument name="nParentRowIndex" optional="true">
					<description>The index of the parent row. If this is null or -1 then the row is added to the implicit
 									root.</description>
					<type>Number</type>
				</argument>
				<argument name="nChildIndex" optional="true">
					<description>The position of the new child. If left out then the new node is appended at the end.</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getNodeHashCode">
			<description>Returns a hash code for the node. It is useful to override this if you are building your own custom tree model that does not use<link class="BiTreeNode2">BiTreeNode2</link> as your tree nodes</description>
			<arguments>
				<argument name="oNode">
					<description>The node to get the hash code for</description>
					<type>
						<link class="BiTreeNode2">BiTreeNode2</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="rebuildSubtree">
			<description>This removes all the nodes in the subtree and readds them, basically refreshing
 the tree. This also fires a rowcountchanged event so that the view is refreshed</description>
			<arguments>
				<argument name="nIndex">
					<description>The index of the node to refresh the subtree for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="rootNode" get="true" set="true">
			<description>The tree node that is the root of the data</description>
			<type>
				<link class="BiTreeNode2">BiTreeNode2</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="datachanged">
			<description>This event is fired when the
 												data changes.</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
		<event name="expand">
			<description>This event is fired when a row has expanded</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
		<event name="collapse">
			<description>This event is fired when a row has collapsed</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
		<event name="beforeexpand">
			<description>This event is fired before a row is expanded</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
		<event name="beforecollapse">
			<description>This event is fired before a row is collapsed</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
		<event name="rowcountchanged">
			<description>This event is fired when the row count changes.
 													The rowIndex and the rowCount properties on the
                                                     event object are available for this event</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>