biselectionmodel.html

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· HTML 代码 · 共 1,409 行 · 第 1/3 页

<td>The mouse event used in the click event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="handleDblClick"></a>handleDblClick</h3>
<p>This should be called when the user double clicks on an item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleDblClick(<span class="methodArgument">oItem</span>, <span class="methodArgument">e</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item that was double clicked</td>
</tr>
<tr>
<td><code>e</code></td>
<td><code class="type">
						<code><a href="BiMouseEvent.html">BiMouseEvent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The mouse event used in the dblclick event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="handleKeyDown"></a>handleKeyDown</h3>
<p>This should be called when the user presses down a key on the component</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleKeyDown(<span class="methodArgument">e</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>e</code></td>
<td><code class="type">
						<code><a href="BiKeyboardEvent.html">BiKeyboardEvent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The keyboard event used in the key down event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="handleMouseDown"></a>handleMouseDown</h3>
<p>This should be called when the user pressed down the mouse button on an item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleMouseDown(<span class="methodArgument">oItem</span>, <span class="methodArgument">e</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item that was pressed</td>
</tr>
<tr>
<td><code>e</code></td>
<td><code class="type">
						<code><a href="BiMouseEvent.html">BiMouseEvent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The mouse event used in the mouse down event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="handleMouseOver"></a>handleMouseOver</h3>
<p>This should be called when the user moves the mouse over an item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleMouseOver(<span class="methodArgument">oItem</span>, <span class="methodArgument">e</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item that the mouse over was triggered on</td>
</tr>
<tr>
<td><code>e</code></td>
<td><code class="type">
						<code><a href="BiMouseEvent.html">BiMouseEvent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The mouse event used in the mouse over event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="handleMouseUp"></a>handleMouseUp</h3>
<p>This should be called when the user releases the mouse button on an item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleMouseUp(<span class="methodArgument">oItem</span>, <span class="methodArgument">e</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item that the mouse up was triggered on</td>
</tr>
<tr>
<td><code>e</code></td>
<td><code class="type">
						<code><a href="BiMouseEvent.html">BiMouseEvent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The mouse event used in the mouse up event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="isBefore"></a>isBefore</h3>
<p>Returns whether the first item is before the second item in the component.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.isBefore(<span class="methodArgument">oItem1</span>, <span class="methodArgument">oItem2</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>oItem1</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to test if before</td>
</tr>
<tr>
<td><code>oItem2</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to test if after</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="isEqual"></a>isEqual</h3>
<p>Compares two items and returns true if they are equal.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.isEqual(<span class="methodArgument">oItem1</span>, <span class="methodArgument">oItem2</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>oItem1</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>Item one to compare</td>
</tr>
<tr>
<td><code>oItem2</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>Item two to compare</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="scrollItemIntoView"></a>scrollItemIntoView</h3>
<p>Scrolls the owner so that the item becomes visible.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.scrollItemIntoView(<span class="methodArgument">oItem</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to scroll into view</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="selectAll"></a>selectAll</h3>
<p>Selects all items</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.selectAll()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="selectItemRange"></a>selectItemRange</h3>
<p>Selects the items passed as arguments and all the items between them</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.selectItemRange(<span class="methodArgument">oItem1</span>, <span class="methodArgument">oItem2</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>oItem1</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The first item to select</td>
</tr>
<tr>
<td><code>oItem2</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The last item to select</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="setItemSelected"></a>setItemSelected</h3>
<p>Sets the item as selected (or deselected) and also updates the
 selected items collection.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.setItemSelected(<span class="methodArgument">oItem</span>, <span class="methodArgument">bSelected</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to select or deselect</td>
</tr>
<tr>
<td><code>bSelected</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"></td>
<td></td>
<td>Whether to select or deselect</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updateItemAnchorState"></a>updateItemAnchorState</h3>
<p>This is called when the anchor state of the item has changed.
 Override this to update the visuals to reflect the anchor state.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updateItemAnchorState(<span class="methodArgument">oItem</span>, <span class="methodArgument">bAnchor</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to update the anchor state for</td>
</tr>
<tr>
<td><code>bAnchor</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"></td>
<td></td>
<td>Whether the item is the anchor item</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updateItemLeadState"></a>updateItemLeadState</h3>
<p>This is called when the lead state of the item has changed.
 Override this to update the visuals to reflect the lead state.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updateItemLeadState(<span class="methodArgument">oItem</span>, <span class="methodArgument">bLead</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to update the selected state for</td>
</tr>
<tr>
<td><code>bLead</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"></td>
<td></td>
<td>Whether the item is the lead item</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updateItemSelectionState"></a>updateItemSelectionState</h3>
<p>This is called when the selection state of the item has changed.
 Override this to update the visuals to reflect the selected state.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updateItemSelectionState(<span class="methodArgument">oItem</span>, <span class="methodArgument">bSelected</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>oItem</code></td>
<td><code class="type">
						<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The item to update the selected state for</td>
</tr>
<tr>
<td><code>bSelected</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"></td>
<td></td>
<td>Whether the item is selected</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>