bidatatable.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiDataTable" extends="BiObject">
	<description>This class represents a data table inside a data set. A data table
 consists of <link class="BiDataColumn">columns</link> and
 <link class="BiDataRow">rows</link>.</description>
	<arguments>
		<argument name="sName" optional="true">
			<description>The name of the table. </description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="getColumnByName">
			<description>Returns the column with the given name.</description>
			<arguments>
				<argument name="s">
					<description>The name of the column to get</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDataColumn">BiDataColumn</link>
				</type>
			</returns>
		</method>
		<method name="addRow">
			<description>Adds a <link class="BiDataRow">row</link> to the table.</description>
			<arguments>
				<argument name="oRow">
					<description>The row to add</description>
					<type>
						<link class="BiDataRow">BiDataRow</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>If provided the new row is added before this </description>
					<type>
						<link class="BiDataRow">BiDataRow</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeRow">
			<description>Removes a <link class="BiDataRow">row</link> from the table.</description>
			<arguments>
				<argument name="oRow">
					<description>The row to remove</description>
					<type>
						<link class="BiDataRow">BiDataRow</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDataRow">BiDataRow</link>
				</type>
			</returns>
		</method>
		<method name="addColumn">
			<description>Adds a <link class="BiDataColumn">column</link> to the table.</description>
			<arguments>
				<argument name="oColumn">
					<description>The column to add</description>
					<type>
						<link class="BiDataColumn">BiDataColumn</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>If provided the new column is added before this </description>
					<type>
						<link class="BiDataColumn">BiDataColumn</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeColumn">
			<description>Removes a <link class="BiDataColumn">column</link> from the table.</description>
			<arguments>
				<argument name="oColumn">
					<description>The column to remove</description>
					<type>
						<link class="BiDataColumn">BiDataColumn</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiDataColumn">BiDataColumn</link>
				</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="name" get="true">
			<description>The name of the table.</description>
			<type>String</type>
		</property>
		<property name="dataSet" get="true">
			<description>This is the data set that the table is part of</description>
			<type>
				<link class="BiDataSet">BiDataSet</link>
			</type>
		</property>
		<property name="columns" get="true">
			<description>The columns in the table</description>
			<type>
				<link class="BiDataColumn">BiDataColumn[]</link>
			</type>
		</property>
		<property name="rows" get="true">
			<description>The rows in the table</description>
			<type>
				<link class="BiDataRow">BiDataRow[]</link>
			</type>
		</property>
		<property name="dataReady" get="true">
			<description>This is true if the data is ready. This is always true for
 a<link class="BiDataTable">BiDataTable</link> but might not be true for a sub class.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>