bigrid.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiGrid" extends="BiAbstractGrid">
	<description>This component is used to display a grid (table, column list). A grid
 can show headers for both the columns and the rows. A grid also supports
 selection of whole rows as well as of individual cells.</description>
	<arguments>
		<argument name="oGridData" optional="true">
			<description>The initial data. This should be a 2-dimensional array (an array of arrays) containing the data. The items in the array are passed
                                 to the <link class="BiGridRow">grid row</link> and then to the
                                 <link class="BiGridCell">grid cell</link>.</description>
			<type>Object[][]</type>
		</argument>
		<argument name="oColumnNames">
			<description>An array containt the names of the columns in the grid.</description>
			<type>String[]</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="updateRowHeadersHeight">
			<description>Updates the height of the row headers</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="addRow">
			<description>Adds a grid row to the grid</description>
			<arguments>
				<argument name="oChild">
					<description>The grid row child to add</description>
					<type>
						<link class="BiGridRow">BiGridRow</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>If provided, the child is added before this row </description>
					<type>
						<link class="BiGridRow">BiGridRow</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeRow">
			<description>Removes a grid row. Returns the removed row.</description>
			<arguments>
				<argument name="oChild">
					<description>The row to remove</description>
					<type>
						<link class="BiGridRow">BiGridRow</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridRow">BiGridRow</link>
				</type>
			</returns>
		</method>
		<method name="removeRowAt">
			<description>Removes the grid row at the given index. Returns the removed row.</description>
			<arguments>
				<argument name="i">
					<description>The index of the row to remove</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridRow">BiGridRow</link>
				</type>
			</returns>
		</method>
		<method name="hasRows">
			<description>Returns true if the grid has any rows</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes and disposes all rows from the grid</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCellAtPoint">
			<description>Returns the grid cell at the given point. If no cell is found this returns
 null.</description>
			<arguments>
				<argument name="nClientX">
					<description>The left position relative to the browser window</description>
					<type>Number</type>
				</argument>
				<argument name="nClientY">
					<description>The top position relative to the browser window</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridCell">BiGridCell</link>
				</type>
			</returns>
		</method>
		<method name="getRowAtPoint">
			<description>Returns the grid row at the given point. If no row is found this returns
 null.</description>
			<arguments>
				<argument name="nClientX">
					<description>The left position relative to the browser window</description>
					<type>Number</type>
				</argument>
				<argument name="nClientY">
					<description>The top position relative to the browser window</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridRow">BiGridRow</link>
				</type>
			</returns>
		</method>
		<method name="dataBind">
			<description>If the grid has a <link>dataSource</link> then this binds that
 data source to the list.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="createItemFromDataRow">
			<description>This method is called when using data binding. This is used to
 create a new<link class="BiGridRow">BiGridRow</link> from a<link class="BiDataRow">BiDataRow</link>.</description>
			<arguments>
				<argument name="oRow">
					<description>This is the row to create a new<link class="BiGridRow">BiGridRow</link> from.</description>
					<type>
						<link class="BiDataRow">BiDataRow</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridRow">BiGridRow</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="rowHeaders" get="true">
			<description>The component responsible for drawing the grid row headers</description>
			<type>
				<link class="BiGridRowHeaders">BiGridRowHeaders</link>
			</type>
		</property>
		<property name="headerCorner" get="true">
			<description>This is the component that is shown in the upper left corner of
 the grid when both headers and row headers are shown.</description>
			<type>
				<link class="BiGridHeaderCorner">BiGridHeaderCorner</link>
			</type>
		</property>
		<property name="rowHeadersHtml" get="true">
			<description>Returns the HTML needed for the row headers</description>
			<type>String</type>
		</property>
		<property name="selectionMode" get="true" set="true">
			<description>Sets the selection mode. Allowed values are "cell" and "row".</description>
			<type>String</type>
		</property>
		<property name="firstRow" get="true">
			<description>Returns the first row.</description>
			<type>
				<link class="BiGridRow">BiGridRow</link>
			</type>
		</property>
		<property name="lastRow" get="true">
			<description>Returns the last row.</description>
			<type>
				<link class="BiGridRow">BiGridRow</link>
			</type>
		</property>
		<property name="rows" get="true">
			<description>Returns all the rows.</description>
			<type>
				<link class="BiGridRow">BiGridRow[]</link>
			</type>
		</property>
		<property name="dataSource" get="true" set="true">
			<description>The object to use as the data source. This can be a either a
<link class="BiDataTable">BiDataTable</link> or a<link class="BiDataSet">BiDataSet</link> (in which case the first table is used).</description>
			<type>
				<link class="BiDataSet">BiDataSet</link> /<link class="BiDataTable">BiDataTable</link>
			</type>
		</property>
		<property name="currentDataPage" get="true" set="true">
			<description>The index of the current data page.</description>
			<type>Number</type>
		</property>
		<property name="dataPageSize" get="true" set="true">
			<description>The amount of rows to show at one time from the data source.</description>
			<type>Number</type>
		</property>
		<property name="dataPageCount" get="true">
			<description>The number of data pages that are available. This is the numbers
 of rows in the data set divided by the number of rows per page.</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
		<event name="change">
			<description>Fires when the selected row/cell changes</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="databind">
			<description>Called after the component has been data bound</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>After changing the data call <link class="BiAbstractGrid" field="updateData">updateData</link>
 			to redraw the body of the grid. When the columns have been changed you
             should call <link class="BiAbstractGrid" field="updateColumns">updateColumns</link>.</remarks>
</class>