📄 biinlineeditmodel.html

📁 ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．
💻 HTML
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--Generated using api.website.xsl version 2003-07-17--><head><META http-equiv="Content-Type" content="text/html; charset=utf-8"><title>BiInlineEditModel</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">				function showDerivedClasses() {					var ul = document.getElementById("api-derived-classes");					var lis = ul.childNodes;					var l = lis.length;					for (var i = 1; i < l; i++)						lis[i].style.display = "";					lis[0].style.display = "none";				}			</script></head><body><h1 id="BiInlineEditModel">BiInlineEditModel</h1><p>This class is used to handle inline editing in a<code><a href="BiTreeView.html">BiTreeView</a></code> and a<code><a href="BiOlapGrid.html">BiOlapGrid</a></code>. This class provides editing by using one attached component at a time.</p><p>This class extends		<code><a href="BiAttachedComponentModel.html">BiAttachedComponentModel</a></code>		and therefore all methods and fields available for		<code><a href="BiAttachedComponentModel.html">BiAttachedComponentModel</a></code>		are also available for <code>BiInlineEditModel</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiAttachedComponentModel.html">BiAttachedComponentModel</a></code><ul><li><code>BiInlineEditModel</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code>	new BiInlineEditModel()</code></p><h3>Parameters</h3><p>No parameters.</p><h2>Properties</h2><table><thead><tr><td>Name</td><td>Type</td><td class="get-header">get</td><td class="set-header">set</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="column"></a><code>column</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>The column that is edited</td></tr><tr><td><a name="currentEditComponent"></a><code>currentEditComponent</code></td><td><code class="type">				<code><a href="BiComponent.html">BiComponent</a></code>			</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>The attached component that is used to edit the value of the cell</td></tr><tr><td><a name="isEditing"></a><code>isEditing</code></td><td><code class="type">Boolean</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Whether we are currently editing a cell</td></tr><tr><td><a name="row"></a><code>row</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>The row that is edited</td></tr><tr><td><a name="value"></a><code>value</code></td><td><code class="type">Object</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>The value of the currently editing cell</td></tr></tbody></table><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#cancelEdit">cancelEdit</a></code></td><td>Ends the current editing of the cell without raising a change event</td></tr><tr><td><code><a href="#commitEdit">commitEdit</a></code></td><td>Ends the current editing of the cell but fires of a change event</td></tr><tr><td><code><a href="#getCanEdit">getCanEdit</a></code></td><td>Whether we can edit the cell at the given position</td></tr><tr><td><code><a href="#getEditOptions">getEditOptions</a></code></td><td>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>				 For <code><a href="#EDIT_TYPE_NUMBER">EDIT_TYPE_NUMBER</a></code> 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<code><a href="BiSpinner.html">BiSpinner</a></code>.<br>								<br>				 For <code><a href="#EDIT_TYPE_ENUM">EDIT_TYPE_ENUM</a></code>, 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.</td></tr><tr><td><code><a href="#getEditType">getEditType</a></code></td><td>Returns the type of editing we want to use for the cell at the given position</td></tr><tr><td><code><a href="#setEditCell">setEditCell</a></code></td><td>Sets the cell to edit. This starts the editing of the cell and the attached component for that cell is shown and focused</td></tr></tbody></table><h2>Events</h2><table><thead><tr><td>Name</td><td>Type</td><td class="bubbles-header">Bubbles</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="beforehide"></a><code>beforehide</code></td><td><code class="type">				<code><a href="BiEvent.html">BiEvent</a></code>			</code></td><td class="bubbles-column"></td><td>This happens before the editing component is 									hidden. If the default action is prevented here                                  the component is not removed from the tree view</td></tr><tr><td><a name="beforeshow"></a><code>beforeshow</code></td><td><code class="type">				<code><a href="BiEvent.html">BiEvent</a></code>			</code></td><td class="bubbles-column"></td><td>This event is dispatched before the editing 									component is added to the<code><a href="BiTreeView.html">BiTreeView</a></code> component</td></tr><tr><td><a name="change"></a><code>change</code></td><td><code class="type">				<code><a href="BiEvent.html">BiEvent</a></code>			</code></td><td class="bubbles-column"></td><td>This event is fired when the value of the 									currently editing cell has changed.</td></tr><tr><td><a name="hide"></a><code>hide</code></td><td><code class="type">				<code><a href="BiEvent.html">BiEvent</a></code>			</code></td><td class="bubbles-column"></td><td>When the editing component has been removed/hidden.</td></tr></tbody></table><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>EDIT_TYPE_ENUM</code></td><td><code class="type">Number</code></td><td>Constant for selection one value out of a few options. This type shows a<code><a href="BiComboBox.html">BiComboBox</a></code> as the attached component</td></tr><tr><td><code>EDIT_TYPE_NUMBER</code></td><td><code class="type">Number</code></td><td>Constant for editing a number value. This shows a spinner for editing the value as the attached component</td></tr><tr><td><code>EDIT_TYPE_STRING</code></td><td><code class="type">Number</code></td><td>Constant for editing a string value. This type shows a simple<code><a href="BiTextField.html">BiTextField</a></code> as the attached component</td></tr></tbody></table><h2>Remarks</h2><p>	</p><h2>Method Details</h2><h3><a name="cancelEdit"></a>cancelEdit</h3><p>Ends the current editing of the cell without raising a change event</p><h4>Syntax</h4><pre class="method-syntax">object.cancelEdit()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="commitEdit"></a>commitEdit</h3><p>Ends the current editing of the cell but fires of a change event</p><h4>Syntax</h4><pre class="method-syntax">object.commitEdit()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="getCanEdit"></a>getCanEdit</h3><p>Whether we can edit the cell at the given position</p><h4>Syntax</h4><pre class="method-syntax">object.getCanEdit(<span class="methodArgument">x</span>, <span class="methodArgument">y</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>x</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The column of the cell we want to edit</td></tr><tr><td><code>y</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The row of the cell we want to edit</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Boolean</code></p><h3><a name="getEditOptions"></a>getEditOptions</h3><p>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>				 For <code><a href="#EDIT_TYPE_NUMBER">EDIT_TYPE_NUMBER</a></code> 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<code><a href="BiSpinner.html">BiSpinner</a></code>.<br>								<br>				 For <code><a href="#EDIT_TYPE_ENUM">EDIT_TYPE_ENUM</a></code>, 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.</p><h4>Syntax</h4><pre class="method-syntax">object.getEditOptions(<span class="methodArgument">x</span>, <span class="methodArgument">y</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>x</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The column of the editing cell</td></tr><tr><td><code>y</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The row of the editing cell</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Object</code></p><h3><a name="getEditType"></a>getEditType</h3><p>Returns the type of editing we want to use for the cell at the given position</p><h4>Syntax</h4><pre class="method-syntax">object.getEditType(<span class="methodArgument">x</span>, <span class="methodArgument">y</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>x</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The column of the cell we want to edit</td></tr><tr><td><code>y</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The row of the cell we want to edit</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Boolean</code></p><h3><a name="setEditCell"></a>setEditCell</h3><p>Sets the cell to edit. This starts the editing of the cell and the attached component for that cell is shown and focused</p><h4>Syntax</h4><pre class="method-syntax">object.setEditCell(<span class="methodArgument">x</span>, <span class="methodArgument">y</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>x</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The column that the cell is at</td></tr><tr><td><code>y</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The row that the cell is at</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p></body></html>
⌨️ 快捷键说明

复制代码 Ctrl + C
搜索代码 Ctrl + F
全屏模式 F11
切换主题 Ctrl + Shift + D
显示快捷键 ?
增大字号 Ctrl + =
减小字号 Ctrl + -