bigridheaders.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiGridHeaders" extends="BiComponent">
	<description>This class represents the headers for a <link class="BiGrid">grid</link>
 or a <link class="BiTree">tree</link>.
 The headers contain several <link class="BiGridHeader">header cells</link>.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
	</methods>
	<properties>
		<property name="fitColumnWidths" get="true" set="true">
			<description>When this is true the column widths are distributed so that the fill the
 width of the grid</description>
			<type>Boolean</type>
		</property>
		<property name="filler" get="true">
			<description>Returns the header acting as the filler. This is the part that is
 shown after the last column if the grid is wider than all the columns
 combined.</description>
			<type>
				<link class="BiGridHeaderFiller">BiGridHeaderFiller</link>
			</type>
		</property>
		<property name="columnCount" get="true" set="true">
			<description>The number of columns in the header</description>
			<type>Number</type>
		</property>
		<property name="columnWidths" get="true" set="true">
			<description>The widths of the cell headers in the headers</description>
			<type>Number[]</type>
		</property>
		<property name="columnOrders" get="true" set="true">
			<description>The order in which the cell headers should be displayed in. A
 value of <code>[2,0,1]</code> means that the third cell comes first,
 then comes the first cell and last the second.</description>
			<type>Number[]</type>
		</property>
		<property name="sortColumn" get="true" set="true">
			<description>The index of the column that should show the sort arrow.</description>
			<type>Number</type>
		</property>
		<property name="ascending" get="true" set="true">
			<description>If this is <code>true</code> then the sorting should be done
 ascending, if <code>false</code> descending and if <code>null</code>
 no sort. This is also reflected on the <link class="BiGridHeader" field="ascending">ascending</link> property for the
 <link class="BiGridHeader">header</link> this applies to.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
		<event name="columnwidthschanged">
			<description>Fired when the column widths are changed. This happens when either
 										the user has finished resized a column or the column widths are
                                         changed through script.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="columnorderschanged">
			<description>Fired when the column orders are changed. This happens when either
 										the user has reordered the columns or the order is
                                         changed through script.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="sortcolumnchanged">
			<description>Fired when the sort column is changed. This happens when either
 										the user has clicks on a sortable column or the sort column is
                                         changed through script.<br>
				</br>
				<br>
				</br>
                                         Note that when the user clicks on the currently sorted column this
                                         event is not fired. Instead the <link>ascendingchanged</link> event
                                         is triggered because the sorting is changed from ascending to
                                         descending or the other way around.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="ascendingchanged">
			<description>Fired when the ascending property changes. This happens when either
 										the user clicks on a column header cell that is already sorted or
                                         this property is changed through script.<br>
				</br>
				<br>
				</br>
                                         Note that if the <link>ascending</link> property changed due to
                                         a change of the <link>sortColumn</link> this event is not fired.
                                         This is by design to prevent preformance issues.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="columnwidthschanging">
			<description>Fired when the column widths are changing. This happens when
 										the user is resizing a column.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>When working with grids there is no need to manually use this class.</remarks>
</class>