biinlineeditmodel.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiInlineEditModel" extends="BiAttachedComponentModel">
	<description>This class is used to handle inline editing in a<link class="BiTreeView">BiTreeView</link> and a<link class="BiOlapGrid">BiOlapGrid</link>.
 This class provides editing by using one attached component at a time.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
		<field name="EDIT_TYPE_STRING">
			<description>Constant for editing a string value. This type shows a simple<link class="BiTextField">BiTextField</link> as the
 attached component</description>
			<type>Number</type>
		</field>
		<field name="EDIT_TYPE_ENUM">
			<description>Constant for selection one value out of a few options. This type shows a<link class="BiComboBox">BiComboBox</link>
 as the attached component</description>
			<type>Number</type>
		</field>
		<field name="EDIT_TYPE_NUMBER">
			<description>Constant for editing a number value. This shows a spinner for editing the value
 as the attached component</description>
			<type>Number</type>
		</field>
	</staticFields>
	<methods>
		<method name="setEditCell">
			<description>Sets the cell to edit. This starts the editing of the cell and the attached
 component for that cell is shown and focused</description>
			<arguments>
				<argument name="x">
					<description>The column that the cell is at</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row that the cell is at</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getCanEdit">
			<description>Whether we can edit the cell at the given position</description>
			<arguments>
				<argument name="x">
					<description>The column of the cell we want to edit</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row of the cell we want to edit</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getEditType">
			<description>Returns the type of editing we want to use for the cell at the given
 position</description>
			<arguments>
				<argument name="x">
					<description>The column of the cell we want to edit</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row of the cell we want to edit</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getEditOptions">
			<description>This provides some options for the curren edit component. The type
 of Object returned is not well defined and different edit types uses
 different options.<br>
				</br>
				<br>
				</br>
 For <link>EDIT_TYPE_NUMBER</link> the object can contain a field called
 <code>maximum</code> and a field called <code>minimum</code> and these
 will be used as properties on the<link class="BiSpinner">BiSpinner</link>.<br>
				</br>
				<br>
				</br>
 For <link>EDIT_TYPE_ENUM</link>, which is displayed as a combo box, the
 options describe the items in the combo box and the options object can
 be an array of objects with <code>text</code> and <code>userValue</code>
 fields.</description>
			<arguments>
				<argument name="x">
					<description>The column of the editing cell</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row of the editing cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="cancelEdit">
			<description>Ends the current editing of the cell without raising a change event</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="commitEdit">
			<description>Ends the current editing of the cell but fires of a change event</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="row" get="true">
			<description>The row that is edited</description>
			<type>Number</type>
		</property>
		<property name="column" get="true">
			<description>The column that is edited</description>
			<type>Number</type>
		</property>
		<property name="isEditing" get="true">
			<description>Whether we are currently editing a cell</description>
			<type>Boolean</type>
		</property>
		<property name="currentEditComponent" get="true">
			<description>The attached component that is used to edit the value of the cell</description>
			<type>
				<link class="BiComponent">BiComponent</link>
			</type>
		</property>
		<property name="value" get="true" set="true">
			<description>The value of the currently editing cell</description>
			<type>Object</type>
		</property>
	</properties>
	<events>
		<event name="beforeshow">
			<description>This event is dispatched before the editing
 									component is added to the<link class="BiTreeView">BiTreeView</link> component</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="change">
			<description>This event is fired when the value of the
 									currently editing cell has changed.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="beforehide">
			<description>This happens before the editing component is
 									hidden. If the default action is prevented here
                                  the component is not removed from the tree view</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="hide">
			<description>When the editing component has been removed/hidden.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>