📄 bilistitem.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>BiListItem</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="BiListItem">BiListItem</h1>
<p></p>
<p>This class extends
<code><a href="BiLabel.html">BiLabel</a></code>
and therefore all methods and fields available for
<code><a href="BiLabel.html">BiLabel</a></code>
are also available for <code>BiListItem</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="BiComponent.html">BiComponent</a></code><ul><li><code><a href="BiLabel.html">BiLabel</a></code><ul><li><code>BiListItem</code><ul id="api-derived-classes"><li><code><a href="BiComboBoxItem.html">BiComboBoxItem</a></code></li></ul></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiListItem([<span class="methodArgument">sText</span> [, <span class="methodArgument">oUserValue</span>]])</code></p>
<h3>Parameters</h3>
<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>sText</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>""</code></td>
<td>The text to show on the list item</td>
</tr>
<tr>
<td><code>oUserValue</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>The user value of the item</td>
</tr>
</tbody>
</table>
<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="index"></a><code>index</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>
Returns the index of the item in the parent's
<code><a href="BiComponent.html#children">children</a></code> collection.
</td>
</tr>
<tr>
<td><a name="selected"></a><code>selected</code></td>
<td><code class="type">Boolean</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>Whether the item is selected or not</td>
</tr>
<tr>
<td><a name="userValue"></a><code>userValue</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>
A value associated with the list item. This is not the text on the item. To
change the text use the <code><a href="BiLabel.html#text">text</a></code>
property.
</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>
Depreciated. Use <code><a href="#userValue">userValue</a></code> instead.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#matchesString">matchesString</a></code></td>
<td>
Tests whether the beginning of the <code><a href="BiLabel.html#text">text</a></code>
of the item starts with the given string. This match is case insensitive.
</td>
</tr>
<tr>
<td><code><a href="#matchesStringExact">matchesStringExact</a></code></td>
<td>
Tests whether the <code><a href="BiLabel.html#text">text</a></code>
of the item matches the given string. This match is case
insensitive.
</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="action"></a><code>action</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 item is double
clicked or when enter is pressed</td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
Do not change the location of the list item or the layout of the list
might be corrupted. The <code><a href="BiComponent.html#width">width</a></code>
should not be changed either. The
<code><a href="BiComponent.html#height">height</a></code> can be changed
without breaking the layout.<br>
<br>
If the list item has a <code><a href="BiComponent.html#command">command</a></code>
the command will be <code><a href="BiCommand.html#execute">executed</a></code>
when the user double clicks the item (or presses enter when the item is
selected).
</p>
<h2>Method Details</h2>
<h3><a name="matchesString"></a>matchesString</h3>
<p>
Tests whether the beginning of the <code><a href="BiLabel.html#text">text</a></code>
of the item starts with the given string. This match is case insensitive.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.matchesString(<span class="methodArgument">sText</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>sText</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The text to search for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="matchesStringExact"></a>matchesStringExact</h3>
<p>
Tests whether the <code><a href="BiLabel.html#text">text</a></code>
of the item matches the given string. This match is case
insensitive.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.matchesStringExact(<span class="methodArgument">sText</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>sText</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The text to search for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -