bilistitem.xml

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

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiListItem" extends="BiLabel">

	<arguments>
		<argument name="sText" type="String" description="The text to show on the list item" optional="true"
			default='""'/>
		<argument name="oUserValue" type="Object" description="The user value of the item"
			optional="true"/>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="matchesString">
			<description>
				Tests whether the beginning of the <link class="BiLabel" field="text">text</link>
				of the item starts with the given string. This match is case insensitive.
			</description>
			<arguments>
				<argument name="sText" type="String" description="The text to search for"/>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="matchesStringExact">
			<description>
				Tests whether the <link class="BiLabel" field="text">text</link>
				of the item matches the given string. This match is case
				insensitive.
			</description>
			<arguments>
				<argument name="sText" type="String" description="The text to search for"/>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
	</methods>

	<properties>
		<property name="selected" type="Boolean" description="Whether the item is selected or not" get="true" set="true"/>
		<property name="index" type="Number" get="true">
			<description>
				Returns the index of the item in the parent's
				<link class="BiComponent" field="children">children</link> collection.
			</description>
		</property>
		<property name="userValue" type="Object" get="true" set="true">
			<description>
				A value associated with the list item. This is not the text on the item. To
				change the text use the <link class="BiLabel" field="text">text</link>
				property.
			</description>
		</property>
		<property name="value" type="Object" get="true" set="true">
			<description>
				Depreciated. Use <link>userValue</link> instead.
			</description>
		</property>
	</properties>

	<events>
		<event name="action" description="This event is fired when the item is double
			clicked or when enter is pressed">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
	</events>

	<remarks>
		Do not change the location of the list item or the layout of the list
		might be corrupted. The <link class="BiComponent" field="width">width</link>
		should not be changed either. The
		<link class="BiComponent" field="height">height</link> can be changed
		without breaking the layout.<br/>
		<br/>
		If the list item has a <link class="BiComponent" field="command">command</link>
		the command will be <link class="BiCommand" field="execute">executed</link>
		when the user double clicks the item (or presses enter when the item is
		selected).
	</remarks>

</class>