bilist.xml

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

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

<class name="BiList" extends="BiComponent">

	<description>
		This is a list component that can contain <link class="BiListItem">BiListItem</link>
		objects. It uses the normal object model and can therefore be extended and
		used just like any other component. The only limitation is that the the direct
		children should only be of type <link class="BiListItem">BiListItem</link>
		and the size and position of these should not be changed.<br/>
		<br/>
		The list uses a <link class="BiListSelectionModel">BiListSelectionModel</link>
		that handles the selection.
	</description>

	<arguments/>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="findString">
			<description>
				Searches the <link class="BiListItem">items</link>
				for an item that starts with the given string. This match is case
				insensitive. If no item is found this returns <code>null</code>
			</description>
			<arguments>
				<argument name="sText" type="String" description="The text to search for"/>
				<argument name="nStartIndex" type="Number" description="The index to start the searching from"
					optional="true" default="0"/>
			</arguments>
			<returns>
				<type><link class="BiListItem">BiListItem</link></type>
			</returns>
		</method>
		<method name="findStringExact">
			<description>
				Searches the <link class="BiListItem">items</link>
				for an item that matches the given string. This match is case
				insensitive. If no item is found this returns <code>null</code>
			</description>
			<arguments>
				<argument name="sText" type="String" description="The text to search for"/>
				<argument name="nStartIndex" type="Number" description="The index to start the searching from"
					optional="true" default="0"/>
			</arguments>
			<returns>
				<type><link class="BiListItem">BiListItem</link></type>
			</returns>
		</method>
		<method name="findUserValueExact">
			<description>
				Searches the <link class="BiListItem">list items</link>
				for an item that has the given user value. If no item is found
				this returns <code>null</code>
			</description>
			<arguments>
				<argument name="oValue" type="Object" description="The value to search for"/>
				<argument name="nStartIndex" type="Number" description="The index to start the searching from"
					optional="true" default="0"/>
			</arguments>
			<returns>
				<type><link class="BiListItem">BiListItem</link></type>
			</returns>
		</method>
		<method name="findValueExact">
			<description>
				Depreciated. Use <link>findUserValueExact</link> instead.
			</description>
			<arguments>
				<argument name="oValue" type="Object" description="The value to search for"/>
				<argument name="nStartIndex" type="Number" description="The index to start the searching from"
					optional="true" default="0"/>
			</arguments>
			<returns>
				<type><link class="BiListItem">BiListItem</link></type>
			</returns>
		</method>

		<!-- data binding -->
		<method name="dataBind">
			<description>
				If the list has a <link>dataSource</link> then this binds that
				data source to the list.
			</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="createItemFromDataRow">
			<description>
				This method is called when using data binding. This is used to
				create a new <link class="BiListItem">BiListItem</link> from a
				<link class="BiDataRow">BiDataRow</link>.
			</description>
			<arguments>
				<argument name="oRow">
					<description>
						This is the row to create a new <link class="BiListItem">BiListItem</link> from.
					</description>
					<type><link class="BiDataRow">BiDataRow</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiListItem">BiListItem</link></type>
			</returns>
		</method>
		<!-- end data binding -->

	</methods>

	<properties>
		<property name="selectedItems" get="true">
			<type><link class="BiListItem">BiListItem[]</link></type>
			<description>
				Returns an array containing the selected list items.
			</description>
		</property>
		<property name="selectedItem" get="true">
			<type><link class="BiListItem">BiListItem</link></type>
			<description>
				This is a convenience method that returns the first selected item.
				This is same as <code>list.getSelectedItems()[0]</code>.
			</description>
		</property>
		<property name="selectionModel" get="true" set="true">
			<type><link class="BiListSelectionModel">BiListSelectionModel</link></type>
			<description>
				This handles the selection of the items in the list
			</description>
		</property>
		<property name="multipleSelection" get="true" set="true">
			<type>Boolean</type>
			<description>
				Whether the list supports multiple selection
			</description>
		</property>
		<property name="userValue" get="true" set="true" type="Object">
			<description>
				This is the <link class="BiListItem" field="userValue">userValue</link> of
				the first selected <link class="BiListItem">list item</link>.
				If no item is selected then this returns <code>null</code>.
			</description>
		</property>
		<property name="value" get="true" set="true" type="Object">
			<description>
				Depreciated. Use <link>userValue</link> instead.
			</description>
		</property>
		<property name="userValues" get="true" type="Object[]">
			<description>
				This is an array containing the <link class="BiListItem" field="userValue">user
				values</link>
				of the selected <link class="BiListItem">list items</link>.
			</description>
		</property>
		<property name="values" get="true" type="Object[]">
			<description>
				Depreciated. Use <link>userValues</link> instead.
			</description>
		</property>

		<!-- data binding -->
		<property name="dataTextField" get="true" set="true" type="String">
			<description>
				The name of the column to use as the data for the text property
				of the <link class="BiListItem">BiListItem</link>s.
			</description>
		</property>
		<property name="dataUserValueField" get="true" set="true" type="String">
			<description>
				The name of the column to use as the data for the <link>userValue</link>
				property
				of the <link class="BiListItem">BiListItem</link>s.
			</description>
		</property>
		<property name="dataValueField" get="true" set="true" type="String">
			<description>
				Depreciated. Use <link>dataUserValueField</link> instead.
			</description>
		</property>
		<property name="dataSource" get="true" set="true">
			<description>
				The object to use as the data source. This can be a either a
				<link class="BiDataTable">BiDataTable</link> or a
				<link class="BiDataSet">BiDataSet</link> (in which case the
				first table is used).
			</description>
			<type>
				<link class="BiDataTable">BiDataTable</link> / <link class="BiDataSet">BiDataSet</link>
			</type>
		</property>
		<property name="dataPageSize" get="true" set="true" type="Number">
			<description>
				The amount of rows to show at one time from the data source.
			</description>
		</property>
		<property name="dataPageCount" get="true" type="Number">
			<description>
				The number of data pages that are available. This is the numbers
				of rows in the data set divided by the number of rows per page.
			</description>
		</property>
		<property name="currentDataPage" get="true" set="true" type="Number">
			<description>
				The index of the current data page.
			</description>
		</property>
		<!-- end data binding -->

		<property name="allowInlineFind" get="true" set="true">
			<type>Boolean</type>
			<description>
				When <code>true</code>, typing a word will select the first matching item.
			</description>
		</property>

	</properties>

	<events>
		<event name="change" description="Fires when the selected items change">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>

		<!-- data binding -->
		<event name="databind" description="Called after the component has been data bound">
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<!-- end data binding -->

	</events>

	<remarks>
		Only <link class="BiListItem">BiListItems</link> should be added to the
		list. Other components might result in unexpected behaviors.
	</remarks>

</class>