biabstractgridrow.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiAbstractGridRow" extends="BiObject">
	<description>The base class for the <link class="BiGridRow">rows</link> and
 <link class="BiTreeNode">nodes</link> in a <link class="BiGrid">grid</link>
 or a <link class="BiTree">tree</link>.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="update">
			<description>Updates the row. This allows the grid to redraw only the current
 row 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="scrollIntoView">
			<description>Scrolls the grid component viewport so that the
 row becomes visible inside the viewport if possible. The
 argument can be used to tell what edge of the viewport the node
 should be aligned to. For a row only vertical scrolling is
 taken into account.</description>
			<arguments>
				<argument name="bTopLeft" optional="true" default="null">
					<description>This describes the value to align the node to relative to the viewport of the grid.<br>
						</br>
						<br>
						</br>
						<code>null</code> - Scroll as little as possible to make
                             the row visible in the grid viewport.<br>
						</br>
						<code>true</code> - try to align the row with the
                             upper left edge of the grid viewport.<br>
						</br>
						<code>false</code> - try to align the row with the
                             lower 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
 row becomes visible inside the viewport if possible. The
 argument can be used to tell what edge of the viewport the node
 should be aligned to.</description>
			<arguments>
				<argument name="bTop" optional="true" default="null">
					<description> This describes the value to align the row to relative
 						to the viewport of the grid.<br>
						</br>
						<br>
						</br>
						<code>null</code> - Scroll as little as possible to make
                         the row visible in the parent viewport.<br>
						</br>
						<code>true</code> - try to align the row with the
                         upper edge of the grid viewport.<br>
						</br>
						<code>false</code> - try to align the row with the
                         lower edge of the grid viewport.  *</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="matchesString">
			<description>Tests whether the beginning of the text of the first cell
 of the row starts with the given string. This match is case insensitive.</description>
			<arguments>
				<argument name="sText">
					<description>The text to search for</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="matchesStringExact">
			<description>Tests whether the text of the first cell
 of the row matches the given string. This match is case
 insensitive.</description>
			<arguments>
				<argument name="sText">
					<description>The text to search for</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>
	<properties>
		<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="icon" get="true" set="true">
			<description>The image to use as icon on the row. The icon supports both<link class="BiImage">BiImage</link> (or
 other objects with getIconHtml) as well as a string/uri for backwards compat
 and more lightweight</description>
			<type>
				<link class="BiImage">BiImage</link> /<link class="BiUri">BiUri</link> / String</type>
		</property>
		<property name="selected" get="true" set="true">
			<description>Whether the grid row is selected or not.</description>
			<type>Boolean</type>
		</property>
		<property name="created" get="true">
			<description>This is true when the grid row has been drawn and has a visual
 representation. For this to be true the tree must have been
 created and drawn.</description>
			<type>Boolean</type>
		</property>
		<property name="height" get="true">
			<description>Returns the height of the grid row (for a tree node this does not include children).</description>
			<type>Number</type>
		</property>
		<property name="top" get="true">
			<description>Returns the top position relative to the grid.</description>
			<type>Number</type>
		</property>
	</properties>
	<events>
	</events>
	<remarks>
	</remarks>
</class>