bitreeview.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeView" extends="BiTreeViewBase">
	<description>This class is the base for<link class="BiGrid2">BiGrid2</link> and<link class="BiTree2">BiTree2</link>. It can be used directly
 with a data model.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="updateContentSize">
			<description>This is called when the size of the content has changed. This happens for
 example when a row is added/removed and when subtrees are collapsed/expanded</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateSize">
			<description>This updates the sizes of different parts of the sub controls</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getHtmlCode">
			<description>This returns the HTML code for the body of the tree view</description>
			<arguments>
				<argument name="nScrollLeft">
					<description>The distance from the left to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nScrollTop">
					<description>The distance from the top to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The width of the viewport</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getHeaderHtmlCode">
			<description>This returns the HTML code for header of the tree view</description>
			<arguments>
				<argument name="nScrollLeft">
					<description>The distance from the left to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The width of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowHeaderHtmlCode">
			<description>This returns the HTML code for the row headers.</description>
			<arguments>
				<argument name="nScrollTop">
					<description>The distance from the top to start painting at</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The height of the viewport</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getExpandIconHtml">
			<description>this returns the HTML code for the expand icon</description>
			<arguments>
				<argument name="x">
					<description>the column index</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>the row index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="updateCell">
			<description>Updates (redraws) the given cell</description>
			<arguments>
				<argument name="x">
					<description>The column of the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row of the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateRow">
			<description>This redraws a row</description>
			<arguments>
				<argument name="y">
					<description>The row index for the row to update</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateRowHeaderCell">
			<description>This updates the row header cell for the given row</description>
			<arguments>
				<argument name="y">
					<description>The index of the row header to update</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="invalidateRow">
			<description>Marks the row as invalid. This will try to redraw only the invalidated rows
 instead of redrawing the entire viewport (in some cases).</description>
			<arguments>
				<argument name="y">
					<description>The index of the row to invalidate</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCellInfoFromMouseEvent">
			<description>This takes a mouse event object and returns a cell info describing the
 cell that is related to the mouse event</description>
			<arguments>
				<argument name="e">
					<description>The event object used in the mouse event</description>
					<type>
						<link class="BiMouseEvent">BiMouseEvent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeViewCellInfo">BiTreeViewCellInfo</link>
				</type>
			</returns>
		</method>
		<method name="getCellInfo">
			<description>Returns a<link class="BiTreeViewCellInfo">BiTreeViewCellInfo</link> object based on the mouse coordinates</description>
			<arguments>
				<argument name="nOffsetX">
					<description>The left postion relative to the tree view</description>
					<type>Number</type>
				</argument>
				<argument name="nOffsetY">
					<description>The top postion relative to the tree view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiTreeViewCellInfo">BiTreeViewCellInfo</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="scrollTopExact" get="true">
			<description>This returns the exact scroll position. scrollTop on the
 other hand returns the scroll position where the first visible row starts at</description>
			<type>Number</type>
		</property>
		<property name="scrollLeftExact" get="true">
			<description>This returns the exact scroll position. scrollLeft on the
 other hand returns the scroll position where the first visible row starts at</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>