bigridcell.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiGridCell" extends="BiObject">
	<description>This class represents a cell in a <link class="BiGridRow">grid row</link>.</description>
	<arguments>
		<argument name="oData">
			<description>The data describing the cell. This is by default displayed as text on the cell.</description>
			<type>Object</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="isIconCell">
			<description>Returns <code>true</code> when the cell should display an icon. This
 asks the grid for the <link class="BiAbstractGrid" field="iconColumn">icon column</link>
 to decide whether this cell should show the icon.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="update">
			<description>Updates the cell. This allows the grid to redraw only the current
 cell of the grid. This is useful when only a few items have
 changed and therefore the whole data of the grid does not need
 to be redrawn.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollIntoViewX">
			<description>Scrolls the grid component viewport horizontally so that the
 cell becomes visible inside the viewport if possible. The
 argument can be used to tell what edge of the viewport the cell
 should be aligned to.</description>
			<arguments>
				<argument name="bLeft" optional="true" default="null">
					<description>This describes the value to align the cell to relative to the viewport of the grid.<br>
						</br>
						<br>
						</br>
						<code>null</code> - Scroll as little as possible to make
 							the cell visible in the parent viewport.<br>
						</br>
						<code>true</code> - try to align the cell with the
 							left edge of the grid viewport.<br>
						</br>
						<code>false</code> - try to align the cell with the
 							right edge of the grid viewport.</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollIntoViewY">
			<description>Scrolls the grid component viewport vertically so that the
 cell becomes visible inside the viewport if possible. The
 argument can be used to tell what edge of the viewport the cell
 should be aligned to.</description>
			<arguments>
				<argument name="bTop" optional="true" default="null">
					<description>This describes the value to align the cell to relative to the viewport of the grid.<br>
						</br>
						<br>
						</br>
						<code>null</code> - Scroll as little as possible to make
 							the cell visible in the parent viewport.<br>
						</br>
						<code>true</code> - try to align the cell with the
 							upper edge of the grid viewport.<br>
						</br>
						<code>false</code> - try to align the cell with the
 							lower edge of the grid viewport.</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollIntoView">
			<description>Scrolls the grid component viewport so that the
 cell becomes visible inside the viewport if possible. The
 argument can be used to tell what edge of the viewport the cell
 should be aligned to.</description>
			<arguments>
				<argument name="bTopLeft" optional="true" default="null">
					<description>This describes the value to align the cell to relative to the viewport of the grid.<br>
						</br>
						<br>
						</br>
						<code>null</code> - Scroll as little as possible to make
 							the cell visible in the parent viewport.<br>
						</br>
						<code>true</code> - try to align the cell with the
 							upper left edge of the grid viewport.<br>
						</br>
						<code>false</code> - try to align the cell with the
 							lower right edge of the grid viewport.</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="row" get="true">
			<description>The row that the cell is part of</description>
			<type>
				<link class="BiGridRow">BiGridRow</link>
			</type>
		</property>
		<property name="columnIndex" get="true">
			<description>The column index of the cell</description>
			<type>Number</type>
		</property>
		<property name="data" get="true" set="true">
			<description>The data associated with the cell</description>
			<type>Object</type>
		</property>
		<property name="backColor" get="true" set="true">
			<description>The background color name</description>
			<type>String</type>
		</property>
		<property name="foreColor" get="true" set="true">
			<description>The foreground color name</description>
			<type>String</type>
		</property>
		<property name="rowIndex" get="true">
			<description>The index of the row that the cell is part of</description>
			<type>Number</type>
		</property>
		<property name="html" get="true">
			<description>Returns the HTML for the cell. This is used by the
 <link class="BiAbstractGrid" field="treeBodyHtml">BiAbstractGrid treeBodyHtml
 property</link> when drawing the grid.</description>
			<type>String</type>
		</property>
		<property name="labelHtml" get="true">
			<description>Returns the actual HTML to show on the cell. Override this to handle specific
 data. The default implementation uses <code>String(cell.getData())</code>
			</description>
			<type>String</type>
		</property>
		<property name="icon" get="true">
			<description>Returns the icon for the row. If you need different icons for different
 cells you should override this getter.</description>
			<type>
				<link class="BiImage">BiImage</link>
			</type>
		</property>
		<property name="iconHtml" get="true">
			<description>Returns the HTML used to draw the icon.</description>
			<type>String</type>
		</property>
		<property name="grid" get="true">
			<description>Returns the grid component that the cell is part of</description>
			<type>
				<link class="BiGrid">BiGrid</link>
			</type>
		</property>
		<property name="cssClassName" get="true">
			<description>Returns the CSS class name used for the cell.</description>
			<type>String</type>
		</property>
		<property name="created" get="true">
			<description>This is true when the cell has been drawn and has a visual
 representation. For this to be <code>true</code> the grid must have been
 created and drawn.</description>
			<type>Boolean</type>
		</property>
		<property name="height" get="true">
			<description>Returns the height of the cell.</description>
			<type>Number</type>
		</property>
		<property name="top" get="true">
			<description>Returns the top position relative to the grid.</description>
			<type>Number</type>
		</property>
		<property name="width" get="true">
			<description>Returns the width of the cell.</description>
			<type>Number</type>
		</property>
		<property name="left" get="true">
			<description>Returns the left position relative to the grid.</description>
			<type>Number</type>
		</property>
		<property name="selected" get="true" set="true">
			<description>Whether the cell is selected or not. This should not be set when
 the selection mode for the grid is set to row selection.</description>
			<type>Boolean</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>To change the way the cell is displayed after the grid is drawn use the
 			<link>update</link> method.<br>
		</br>
		<br>
		</br>
             To change the way the cell displays the data override the <link>labelHtml</link>
             getter.</remarks>
</class>