biabstractgrid.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiAbstractGrid" extends="BiComponent">
	<description>The abstract base class for the <link class="BiGrid">grid</link> and the
 <link class="BiTree">tree</link>.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getColumnWidth">
			<description>Returns the column width for the column</description>
			<arguments>
				<argument name="x">
					<description>The column to get the width for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getColumnOrder">
			<description>Returns the column order index for the column. If <link>columnOrders</link>
 is <code>[2, 0, 1]</code> then <code>getColumnOrder(1)</code> will
 return <code>2</code>.</description>
			<arguments>
				<argument name="x">
					<description>The column to get the order index for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getColumnAlign">
			<description>Returns the text align for the column.</description>
			<arguments>
				<argument name="x">
					<description>The column to get the text align for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getColumnName">
			<description>Returns the name of the column</description>
			<arguments>
				<argument name="x">
					<description>The column to get the name for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="getColumnSortType">
			<description>Returns the sort type of the column</description>
			<arguments>
				<argument name="x">
					<description>The column to get the sort type for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="update">
			<description>Updates both the columns and the data.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateColumns">
			<description>Updates the column widths by regenerating the <link>styleText</link>.
 This should be called before the first draw of the grid and it
 should be called if the columns widths, column align or the indent
 column is changed.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateData">
			<description>Redraws the data by regenerating the <link>gridBodyHtml</link>.
 This should be called before the first draw of the grid and it
 should be called when changes to the data has occured. It should
 also be called when the icon column or the indent column is
 changed.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="updateHeadersWidth">
			<description>Updates the width of the grid headers. This can be called if
 the size of the headers becomes dirty.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="findString">
			<description>Searches the <link class="BiAbstractRow">rows</link>
 for a row that starts with the given string. This match is case
 insensitive. If no item is found this returns <code>null</code>.
 For a <link class="BiTree">tree</link> this does not include hidden
 children of collapsed nodes.</description>
			<arguments>
				<argument name="sText">
					<description>The text to search for</description>
					<type>String</type>
				</argument>
				<argument name="nStartIndex" optional="true" default="0">
					<description>The index to start the searching from </description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiAbstractRow">BiAbstractRow</link>
				</type>
			</returns>
		</method>
		<method name="findStringExact">
			<description>Searches the <link class="BiAbstractRow">rows</link>
 for a row that matches the given string. This match is case
 insensitive. If no item is found this returns <code>null</code>.
 For a <link class="BiTree">tree</link> this does not include hidden
 children of collapsed nodes.</description>
			<arguments>
				<argument name="sText">
					<description>The text to search for</description>
					<type>String</type>
				</argument>
				<argument name="nStartIndex" optional="true" default="0">
					<description>The index to start the searching from </description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiAbstractRow">BiAbstractRow</link>
				</type>
			</returns>
		</method>
		<method name="sort">
			<description>Sorts the grid by the given column</description>
			<arguments>
				<argument name="nCol">
					<description>The column to sort by</description>
					<type>Number</type>
				</argument>
				<argument name="bAscending" optional="true" default="false">
					<description>Sorting ascending or descending </description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="allowInlineFind" get="true" set="true">
			<description>When <code>true</code>, typing a word will select the first matching item.</description>
			<type>Boolean</type>
		</property>
		<property name="columns" get="true">
			<description>An array containing the column objects used for the grid</description>
			<type>
				<link class="BiGridColumn">BiGridColumn[]</link>
			</type>
		</property>
		<property name="showRowHeaders" get="true" set="true">
			<description>Whether to show the row headers on the grid</description>
			<type>Boolean</type>
		</property>
		<property name="rowHeadersWidth" get="true" set="true">
			<description>The width of the row headers that can be shown when using a grid</description>
			<type>Number</type>
		</property>
		<property name="sortColumn" get="true">
			<description>The column to sort the grid by. Use the <link>sort</link>
 method to update the sort column.</description>
			<type>Number</type>
		</property>
		<property name="ascending" get="true">
			<description>Whether to sort the grid ascendingly or descendingly. Use the
 <link>sort</link> method to change the ascending property.</description>
			<type>Boolean</type>
		</property>
		<property name="rowHeight" get="true" set="true">
			<description>The height of each row in the grid</description>
			<type>Number</type>
		</property>
		<property name="headers" get="true">
			<description>The component containing the grid headers</description>
			<type>
				<link class="BiGridHeaders">BiGridHeaders</link>
			</type>
		</property>
		<property name="columnCount" get="true" set="true">
			<description>The number of columns to show in the grid</description>
			<type>Number</type>
		</property>
		<property name="columnWidths" get="true" set="true">
			<description>An array containing the widths of the columns</description>
			<type>Number[]</type>
		</property>
		<property name="columnOrders" get="true" set="true">
			<description>An array containing the orders of the columns. A value of
 <code>[2, 0, 1]</code> means that the third column should be displayed left most
 and the second column right most.</description>
			<type>Number[]</type>
		</property>
		<property name="columnAligns" get="true" set="true">
			<description>An array containing the text aligns for the columns</description>
			<type>String[]</type>
		</property>
		<property name="columnNames" get="true" set="true">
			<description>An array containing the names for
 the columns. The names is used for the text on the column header.</description>
			<type>String[]</type>
		</property>
		<property name="columnSortTypes" get="true" set="true">
			<description>An array containg the sort types for the columns. Valid values can
 be found in the documentation for the <link class="BiGridColumn" field="sortType">BiGridColumn
 sortType</link>.</description>
			<type>String[]</type>
		</property>
		<property name="iconColumn" get="true" set="true">
			<description>The column to show the icon on.
 Setting this to -1 (or a value greater than the column count) removes
 the icons.</description>
			<type>Number</type>
		</property>
		<property name="fitColumnWidths" get="true" set="true">
			<description>When this is true the column will be sized so that the fill the grid viewport</description>
			<type>Boolean</type>
		</property>
		<property name="liveResize" get="true" set="true">
			<description>When this is set to true the column size in the grid body is
 updated as the user resizes the headers. If this is false the
 column size in the body is only updated as the user finishes the
 resize of the column header.</description>
			<type>Boolean</type>
		</property>
		<property name="showHeaders" get="true" set="true">
			<description>Whether to show the headers on the grid</description>
			<type>Boolean</type>
		</property>
		<property name="headersHeight" get="true" set="true">
			<description>The height of the headers</description>
			<type>Number</type>
		</property>
		<property name="gridBodyHtml" get="true">
			<description>Generates the HTML code used to display the grid body.</description>
			<type>String</type>
		</property>
		<property name="selectedNode" get="true">
			<description>Returns the first selected grid row (or cell).
 This is same as <code>grid.getSelectedNodes()[0]</code>.
 Same as <link>selectedRow</link>.</description>
			<type>
				<link class="BiAbstractGridRow">BiAbstractGridRow</link> /<link class="BiGridCell">BiGridCell</link>
			</type>
		</property>
		<property name="selectedRow" get="true">
			<description>Returns the first selected grid row (or cell).
 This is same as <code>grid.getSelectedNodes()[0]</code>.</description>
			<type>
				<link class="BiAbstractGridRow">BiAbstractGridRow</link> /<link class="BiGridCell">BiGridCell</link>
			</type>
		</property>
		<property name="selectedNodes" get="true">
			<description>Returns the selected grid rows or grid cells if cell selection is used.
 Same as <link>selectedRows</link>.</description>
			<type>
				<link class="BiAbstractGridRow">BiAbstractGridRow[]</link> /<link class="BiGridCell">BiGridCell[]</link>
			</type>
		</property>
		<property name="selectedRows" get="true">
			<description>Returns the selected grid rows or grid cells if cell selection is used.</description>
			<type>
				<link class="BiAbstractGridRow">BiAbstractGridRow[]</link> /<link class="BiGridCell">BiGridCell[]</link>
			</type>
		</property>
		<property name="multipleSelection" get="true" set="true">
			<description>Whether to allow multiple selection</description>
			<type>Boolean</type>
		</property>
		<property name="selectionModel" get="true" set="true">
			<description>This handles the selection of the rows in the grid.</description>
			<type>
				<link class="BiSelectionModel">BiSelectionModel</link>
			</type>
		</property>
	</properties>
	<events>
		<event name="beforesort">
			<description>Fires before the sort happens. Call
 								<link class="BiEvent" field="preventDefault">preventDefault</link>
 	                            to prevent the sorting.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="sort">
			<description>Fired after the grid has been sorted.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>This class is abstract and should not be instanciated.</remarks>
</class>