bicombobox.xml

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

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

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

	<description>
		This class represents a combo box.
	</description>

	<arguments/>

	<staticMethods/>

	<staticFields>
		<field name="BUTTON_IMAGE" type="String" description="The path to the image to represent the down arrow on the drop down button"/>
	</staticFields>

	<methods>
		<method name="findString">
			<description>
				Searches the <link class="BiComboBoxItem">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="BiComboBoxItem">BiComboBoxItem</link></type>
			</returns>
		</method>
		<method name="findStringExact">
			<description>
				Searches the <link class="BiComboBoxItem">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="BiComboBoxItem">BiComboBoxItem</link></type>
			</returns>
		</method>
		<method name="findUserValueExact">
			<description>
				Searches the <link class="BiComboBoxItem">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 user 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="BiComboBoxItem">BiComboBoxItem</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="BiComboBoxItem">BiComboBoxItem</link></type>
			</returns>
		</method>

		<!-- data binding -->
		<method name="dataBind">
			<description>
				If the combo box 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="BiComboBoxItem">BiComboBoxItem</link> from a
				<link class="BiDataRow">BiDataRow</link>.
			</description>
			<arguments>
				<argument name="oRow">
					<description>
						This is the row to create a new <link class="BiComboBoxItem">BiComboBoxItem</link> from.
					</description>
					<type><link class="BiDataRow">BiDataRow</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiComboBoxItem">BiComboBoxItem</link></type>
			</returns>
		</method>
		<!-- end data binding -->

	</methods>

	<properties>
		<property name="selectedItem" get="true" set="true">
			<description>
				The selected <link class="BiComboBoxItem">combo box item</link>.
				If no item is selected this returns <code>null</code>. When this
				changes the <link>change</link> event fires.
			</description>
			<type><link class="BiComboBoxItem">BiComboBoxItem</link></type>
		</property>
		<property name="editable" type="Boolean" description="Whether the text field can be edited" get="true" set="true"/>

		<property name="dropDownVisible" type="Boolean" description="Whether the combo box is displaying its drop-down list." get="true" set="true"/>
		<property name="dropDownWidth" type="Boolean" description="The desired width of the drop-down list. The width of the
			drop-down is always greater than or equal to the width of the combo box." get="true" set="true"/>
		<property name="text" type="String" description="The text shown in the combo box. This can be used to find the text that the
			user is currently typing into the text field of the combo box" get="true" set="true"/>
		<property name="textField" get="true">
			<description>
				This returns the internal text field used for the editable combo
				box. This can then be used to access the text selection model.
			</description>
			<type><link class="BiTextField">BiTextField</link></type>
		</property>
		<property name="userValue" get="true" set="true" type="Object">
			<description>
				This is the <link class="BiListItem" field="userValue">userValue</link> of
				the selected <link class="BiComboBoxItem">combo box item</link>.
				If no item is selected then this returns <code>null</code>. When
				setting this, the first item with the given user value will be selected.
				If no item has this value no item will be selected.
			</description>
		</property>
		<property name="value" get="true" set="true" type="Object">
			<description>
				Depreciated. Use <link>userValue</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="BiComboBoxItem">BiComboBoxItem</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="BiComboBoxItem">BiComboBoxItem</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 -->

	</properties>

	<events>
		<event name="change">
			<description>
				Fires when the <link>selectedItem</link> changes.
			</description>
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<event name="textchanged">
			<description>
				Fires when the text changes in the text field of the combo box. To
				get the new text use the <link>text</link> property.
			</description>
			<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/>

</class>