bigridrow.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiGridRow" extends="BiAbstractGridRow">
	<description>This class represents the rows in<link class="BiGrid">BiGrid</link>. Each row contains
 <link class="BiGridCell">cells</link> that contains the text to show for
 the column.</description>
	<arguments>
		<argument name="oData" optional="true">
			<description>This is an array containing the data to be used for each cell. If this argument is left out the cells will be have to be added
                             using <link>addCell</link>.</description>
			<type>Object[]</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getData">
			<description>Returns the data for the given column index</description>
			<arguments>
				<argument name="x">
					<description>The column index of the cell to get the data for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="setData">
			<description>Sets the data for a given column index</description>
			<arguments>
				<argument name="x">
					<description>The column index of the cell to set the data for</description>
					<type>Number</type>
				</argument>
				<argument name="oData">
					<description>The data to set on the cell</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCell">
			<description>Returns the cell for the given column index.</description>
			<arguments>
				<argument name="nCol">
					<description>The column to get the cell for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridCell">BiGridCell</link>
				</type>
			</returns>
		</method>
		<method name="addCell">
			<description>Adds a cell to the row</description>
			<arguments>
				<argument name="oChild">
					<description>The cell to add</description>
					<type>
						<link class="BiGridCell">BiGridCell</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>If provided, oChild is added before this cell </description>
					<type>
						<link class="BiGridCell">BiGridCell</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeCell">
			<description>Removes a cell from the row</description>
			<arguments>
				<argument name="oChild">
					<description>The cell to remove</description>
					<type>
						<link class="BiGridCell">BiGridCell</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiGridCell">BiGridCell</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="cells" get="true">
			<description>Returns the cells for the row.</description>
			<type>
				<link class="BiGridCell">BiGridCell[]</link>
			</type>
		</property>
		<property name="html" get="true">
			<description>Returns the HTML for the row and all its cells. This is used
 by the <link class="BiAbstractGrid" field="treeBodyHtml">BiAbstractGrid gridBodyHtml
 property</link> when drawing the grid.</description>
			<type>String</type>
		</property>
		<property name="cssClassName" get="true">
			<description>Returns the CSS class name used for the row.</description>
			<type>String</type>
		</property>
		<property name="rowHeaderHtml" get="true">
			<description>Returns the HTML used for the row header for the row.</description>
			<type>String</type>
		</property>
		<property name="rowHeaderLabelHtml" get="true">
			<description>Returns the HTML for the text on the row header used for the row.
 Override this method to define what to show on the row header.</description>
			<type>String</type>
		</property>
		<property name="rowIndex" get="true">
			<description>The index of the row</description>
			<type>Number</type>
		</property>
		<property name="previousSiblingRow" get="true">
			<description>Returns the previous grid row sibling.</description>
			<type>
				<link class="BiGridRow">BiGridRow</link>
			</type>
		</property>
		<property name="nextSiblingRow" get="true">
			<description>Returns the next grid row sibling.</description>
			<type>
				<link class="BiGridRow">BiGridRow</link>
			</type>
		</property>
		<property name="grid" get="true">
			<description>Returns the grid component that the row is part of</description>
			<type>
				<link class="BiGrid">BiGrid</link>
			</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>Changing the grid row does not automatically update the grid. The
 			<link class="BiGrid">grid</link> will have to be updated manually.</remarks>
</class>