bigridcolumn.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiGridColumn" extends="BiObject">
	<description>This class is used to describe columns for<link class="BiGrid">BiGrid</link> and<link class="BiTree">BiTree</link>.</description>
	<arguments>
		<argument name="sName" optional="true" default="Untitled">
			<description>This is used for the text to to show on the <link class="BiGridHeader">header cell</link>
                         for the column</description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="numberCompare">
			<description>A function taking two number arguments and returns a number used
 to compare them (less than zero if first is smaller, zero if equal
 and otherwise larger than zero).</description>
			<arguments>
				<argument name="n1">
					<description>The first number</description>
					<type>Number</type>
				</argument>
				<argument name="n2">
					<description>The second number</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="dateCompare">
			<description>A function taking two Date objects and returns a number used
 to compare them (less than zero if first is smaller, zero if equal
 and otherwise larger than zero).</description>
			<arguments>
				<argument name="d1">
					<description>The first number</description>
					<type>Number</type>
				</argument>
				<argument name="d2">
					<description>The second number</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="lessThanCompare">
			<description>A function taking two objects and uses the built in less than
 operator to compare them and returns a number (less than zero if
 first is smaller, zero if equal and otherwise larger than zero).</description>
			<arguments>
				<argument name="v1">
					<description>The first value</description>
					<type>Object</type>
				</argument>
				<argument name="v2">
					<description>The second value</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="stringCompare">
			<description>A function taking two strings and returns a number used
 to compare them (less than zero if first is smaller, zero if
 equal and otherwise larger than zero).</description>
			<arguments>
				<argument name="s1">
					<description>The first string</description>
					<type>String</type>
				</argument>
				<argument name="s2">
					<description>The second string</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="caseInsensitiveStringCompare">
			<description>A function taking two strings and returns a number used
 to compare them (less than zero if first is smaller, zero if
 equal and otherwise larger than zero). This comparison is case
 insensitive.</description>
			<arguments>
				<argument name="s1">
					<description>The first string</description>
					<type>String</type>
				</argument>
				<argument name="s2">
					<description>The second string</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
	</methods>
	<properties>
		<property name="header" get="true">
			<description>This is the header represenging the column in the grid.</description>
			<type>
				<link class="BiGridHeader">BiGridHeader</link>
			</type>
		</property>
		<property name="grid" get="true">
			<description>The grid that the column is used in.</description>
			<type>
				<link class="BiAbstractGrid">BiAbstractGrid</link>
			</type>
		</property>
		<property name="orderIndex" get="true">
			<description>The index of the column as it is currently being displayed. This
 means that the left most column has an order index of 0. This is
 not necessarily the same as the <link>columnIndex</link> when
 the columns have been reordered.</description>
			<type>Number</type>
		</property>
		<property name="columnIndex" get="true">
			<description>The index of the column in the grid columns collection. This is
 not neccessarily the same as the display order.</description>
			<type>Number</type>
		</property>
		<property name="tree" get="true">
			<description>The grid that the column is used in. (Same as <link>grid</link>.)</description>
			<type>
				<link class="BiAbstractGrid">BiAbstractGrid</link>
			</type>
		</property>
		<property name="align" get="true" set="true">
			<description>The alignment of the content inside the column.</description>
			<type>String</type>
		</property>
		<property name="name" get="true" set="true">
			<description>The name of the column. This is the same as the text shown on
 the header.</description>
			<type>String</type>
		</property>
		<property name="width" get="true" set="true">
			<description>The width of the column.</description>
			<type>Number</type>
		</property>
		<property name="indentColumn" get="true" set="true">
			<description>Whether the current column is the indent column in the grid.
 This is ignored when using the columns for a non tree.</description>
			<type>Number</type>
		</property>
		<property name="iconColumn" get="true" set="true">
			<description>Whether the current column is the icon column in the grid.</description>
			<type>Number</type>
		</property>
		<property name="visible" get="true" set="true">
			<description>Whether the column is visible or not.</description>
			<type>Boolean</type>
		</property>
		<property name="sortType" get="true" set="true">
			<description>The type of the data in the column. This is used to decide how
 to sort the data in the column. Built in support for the following
 types:<br>
				</br>
				<br>
				</br>
				<code>string</code>
				<br>
				</br>
				<code>caseInsensitiveString</code>
				<br>
				</br>
				<code>number</code>
				<br>
				</br>
				<code>date</code> - Uses the native JS Date type<br>
				</br>
				<br>
				</br>
 To get better control over the sorting create a subclass that
 overrides the <link>sortFunction</link> getter.</description>
			<type>String</type>
		</property>
		<property name="sortFunction" get="true">
			<description>This returns the function used to compare two
 <link class="BiAbstractGridRow">grid rows</link>. This means that this
 should return a function that takes two arguments and returns a
 number (just like the normal comparison function used when sorting
 arrays in JavaScript).</description>
			<type>Function</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>