bitreeviewdatamodel.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiTreeViewDataModel" extends="BiEventTarget">
	<description>This defines the interface that is needed for a data model for a<link class="BiTreeView">BiTreeView</link>.
 This actually implements a dummy data model. Extend this class to create
 more useful data models</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getCellText">
			<description>This should return the text (HTML string) to show for the cell at (x,y)</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getHeaderCellText">
			<description>This should return the text (HTML string) to show for the header cell at x</description>
			<arguments>
				<argument name="x">
					<description>The column index for the header cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowHeaderCellText">
			<description>This should return the text (HTML string) to show for the row header cell at y</description>
			<arguments>
				<argument name="y">
					<description>The row index for the row header cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getCanSortColumn">
			<description>This returns whether the data model can be sorted by column</description>
			<arguments>
				<argument name="x">
					<description>The column index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="sort">
			<description>This sorts the data model by column x. This should fire a<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link> called "datachanged" if the data changed (or was reordered) so that the<link class="BiTreeView">BiTreeView</link> is correctly redrawn</description>
			<arguments>
				<argument name="x">
					<description>The column index</description>
					<type>Number</type>
				</argument>
				<argument name="bAscending" optional="true">
					<description>Optional. Whether to sort ascending. If left out									this toggles the current sort or sorts ascending									if the column was not sorted before</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getSortFunction">
			<description>Returns a function that compares two rows, looking at column x. The returned function should take 2 arguments and return a number depending on the relative order of the arguments.</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to compare the rows by</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Function</type>
			</returns>
		</method>
		<method name="getDepth">
			<description>The depth of the current row. If the data model describes a tree structure the depth is used to indent the row</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getHasChildren">
			<description>Returns whether the row has any children</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getExpanded">
			<description>Returns whether the row is expanded</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setExpanded">
			<description>Sets whether the row is expanded. The data model is responsible for taking care of the expanded state. The data model should fire the following<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link> events, "beforeexpand", "beforecollapse", "expand" and "collapse" so that the<link class="BiTreeView">BiTreeView</link> can be updated</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
				<argument name="b">
					<description>Whether the row is expanded or collapsed</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getParent">
			<description>Returns the row index for the parent. If this represents a flat structure and the the row has no parent then this should return -1</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getShownChildrenCount">
			<description>Returns the number of shown descendants. If the data model represents a tree then this is the sum all descendants that are shown.</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getHasIcon">
			<description>Returns whether the cell should display an icon. If this is the case the actual image URI is returned using getIcon</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getIcon">
			<description>Returns the path to the image to show on the cell. This is only called for
 cells that should have an icon accordingly to getHasIcon</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowStyle">
			<description>This allows a custom CSS text to be applied to the row. This allows more
 detailed control over the rendering of the row.</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getCellStyle">
			<description>This allows a custom CSS text to be applied to a cell. This allows more
 detailed control over the rendering of the cell.</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getRowHeaderCellStyle">
			<description>This allows a custom CSS text to be applied to a row header cell. This allows more
 detailed control over the rendering of the row header cell.</description>
			<arguments>
				<argument name="y">
					<description>The row index for the row header cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getHeaderCellStyle">
			<description>This allows a custom CSS text to be applied to a header cell. This allows
 more detailed control over the rendering of the header cell.</description>
			<arguments>
				<argument name="x">
					<description>The column index for the header cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getIconStyle">
			<description>Use this to specify some custom CSS to use for the icon image.</description>
			<arguments>
				<argument name="y">
					<description>The row index for the cell row containing the icon</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getContextMenu">
			<description>This allows a context menu to be shown when the user invokes the context menu on the cell</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiMenu">BiMenu</link>
				</type>
			</returns>
		</method>
		<method name="getToolTip">
			<description>This should return the tool tip to use for the cell</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiToolTip">BiToolTip</link>
				</type>
			</returns>
		</method>
		<method name="getDropDataTypes">
			<description>Returns the supported data types for the cell. Return <code>[]</code> or
 <code>null</code> if no drop is desired on the cll</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String[]</type>
			</returns>
		</method>
		<method name="getRowSelected">
			<description>Returns whether the row at y is selected</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getRowIsLead">
			<description>Returns whether the row is acting as the lead item in the selection</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getRowIsAnchor">
			<description>Returns whether the row is acting as the anchor item in the selection</description>
			<arguments>
				<argument name="y">
					<description>The index for the row</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getCellSelected">
			<description>Returns whether the cell is selected</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getCellIsLead">
			<description>Returns whether the cell is acting as the lead item in the selection</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getCellIsAnchor">
			<description>Returns whether the cell is acting as the anchor item in the selection</description>
			<arguments>
				<argument name="x">
					<description>The column index for the cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index for the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="rowCount" get="true">
			<description>The number of rows in the model. In case the data model is a tree then this should take collapsed subtrees into account</description>
			<type>Number</type>
		</property>
		<property name="columnCount" get="true">
			<description>The number of columns in the model.</description>
			<type>Number</type>
		</property>
		<property name="sortColumn" get="true">
			<description>The column that the model is currently sorted by. Return -1 if no sorting is done.</description>
			<type>Number</type>
		</property>
		<property name="sortAscending" get="true">
			<description>Whether the currently sorted column is sorted ascending or descending</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="datachanged">
			<description>This event is fired when the data
 													has changed.</description>
			<type>
				<link class="BiTreeViewDataModelEvent">BiTreeViewDataModelEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>