biselectionmodel.html

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

					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getEnd"></a>getEnd</h3>
<p>Returns the item to navigate to when the end key is pressed.
 This should usually just return the last item.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getEnd(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getHome"></a>getHome</h3>
<p>Returns the item to navigate to when the home key is pressed.
 This should usually just return the first item.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getHome(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getItemHeight"></a>getItemHeight</h3>
<p>Returns the height of the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemHeight(<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 get the size for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getItemLeft"></a>getItemLeft</h3>
<p>Returns the left position of the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemLeft(<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 get the position for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getItemSelected"></a>getItemSelected</h3>
<p>Returns whether the item is selected or not.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemSelected(<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 that we want to check whether it is selected</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="getItemTop"></a>getItemTop</h3>
<p>Returns the top position of the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemTop(<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 get the position for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getItemToSelect"></a>getItemToSelect</h3>
<p>Returns the next item to select (move to) when using the keyboard.
 Usually it is enough to override the needed methods among these:
 getLeft, getRight, getUp, getDown, getHome, getCtrlHome, getEnd,
 getCtrlEnd, getpageUp and getPageDown.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemToSelect(<span class="methodArgument">oKeyboardEvent</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>oKeyboardEvent</code></td>
<td><code class="type">
						<code><a href="BiKeyboardEvent.html">BiKeyboardEvent</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The event object used for the keyboard event</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getItemWidth"></a>getItemWidth</h3>
<p>Returns the width of the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getItemWidth(<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 get the size for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getLeft"></a>getLeft</h3>
<p>Returns the item to navigate to when the left arrow key is pressed.
 This should usually just return the item to the left of the current one.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getLeft(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getNext"></a>getNext</h3>
<p>Gets the item coming next after the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getNext(<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 get the next from</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getPageDown"></a>getPageDown</h3>
<p>Returns the item to navigate to when the page down is pressed.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getPageDown(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getPageUp"></a>getPageUp</h3>
<p>Returns the item to navigate to when the page up key is pressed.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getPageUp(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getPrevious"></a>getPrevious</h3>
<p>Gets the item coming before after the item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getPrevious(<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 get the previous from</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getRight"></a>getRight</h3>
<p>Returns the item to navigate to when the right arrow key is pressed.
 This should usually just return the item to the right of the current one.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getRight(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="getUp"></a>getUp</h3>
<p>Returns the item to navigate to when the up arrow key is pressed.
 This should usually just return the item above the current one.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getUp(<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 that we want to get the new item relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiComponent.html">BiComponent</a></code>/Object</code></p>
<h3><a name="handleClick"></a>handleClick</h3>
<p>This should be called when the user clicks on an item</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.handleClick(<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 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>