📄 bilist.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>BiList</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="BiList">BiList</h1><p> This is a list component that can contain <code><a href="BiListItem.html">BiListItem</a></code> objects. It uses the normal object model and can therefore be extended and used just like any other component. The only limitation is that the the direct children should only be of type <code><a href="BiListItem.html">BiListItem</a></code> and the size and position of these should not be changed.<br> <br> The list uses a <code><a href="BiListSelectionModel.html">BiListSelectionModel</a></code> that handles the selection. </p><p>This class extends <code><a href="BiComponent.html">BiComponent</a></code> and therefore all methods and fields available for <code><a href="BiComponent.html">BiComponent</a></code> are also available for <code>BiList</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>BiList</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiList()</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="allowInlineFind"></a><code>allowInlineFind</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> When <code>true</code>, typing a word will select the first matching item. </td></tr><tr><td><a name="currentDataPage"></a><code>currentDataPage</code></td><td><code class="type">Number</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 index of the current data page. </td></tr><tr><td><a name="dataPageCount"></a><code>dataPageCount</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 number of data pages that are available. This is the numbers of rows in the data set divided by the number of rows per page. </td></tr><tr><td><a name="dataPageSize"></a><code>dataPageSize</code></td><td><code class="type">Number</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 amount of rows to show at one time from the data source. </td></tr><tr><td><a name="dataSource"></a><code>dataSource</code></td><td><code class="type"> <code><a href="BiDataTable.html">BiDataTable</a></code> / <code><a href="BiDataSet.html">BiDataSet</a></code> </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 object to use as the data source. This can be a either a <code><a href="BiDataTable.html">BiDataTable</a></code> or a <code><a href="BiDataSet.html">BiDataSet</a></code> (in which case the first table is used). </td></tr><tr><td><a name="dataTextField"></a><code>dataTextField</code></td><td><code class="type">String</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 name of the column to use as the data for the text property of the <code><a href="BiListItem.html">BiListItem</a></code>s. </td></tr><tr><td><a name="dataUserValueField"></a><code>dataUserValueField</code></td><td><code class="type">String</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 name of the column to use as the data for the <code><a href="#userValue">userValue</a></code> property of the <code><a href="BiListItem.html">BiListItem</a></code>s. </td></tr><tr><td><a name="dataValueField"></a><code>dataValueField</code></td><td><code class="type">String</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="#dataUserValueField">dataUserValueField</a></code> instead. </td></tr><tr><td><a name="multipleSelection"></a><code>multipleSelection</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 list supports multiple selection </td></tr><tr><td><a name="selectedItem"></a><code>selectedItem</code></td><td><code class="type"><code><a href="BiListItem.html">BiListItem</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td> This is a convenience method that returns the first selected item. This is same as <code>list.getSelectedItems()[0]</code>. </td></tr><tr><td><a name="selectedItems"></a><code>selectedItems</code></td><td><code class="type"><code><a href="BiListItem.html">BiListItem[]</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td> Returns an array containing the selected list items. </td></tr><tr><td><a name="selectionModel"></a><code>selectionModel</code></td><td><code class="type"><code><a href="BiListSelectionModel.html">BiListSelectionModel</a></code></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> This handles the selection of the items in the list </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> This is the <code><a href="BiListItem.html#userValue">userValue</a></code> of the first selected <code><a href="BiListItem.html">list item</a></code>. If no item is selected then this returns <code>null</code>. </td></tr><tr><td><a name="userValues"></a><code>userValues</code></td><td><code class="type">Object[]</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td> This is an array containing the <code><a href="BiListItem.html#userValue">user values</a></code> of the selected <code><a href="BiListItem.html">list items</a></code>. </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><tr><td><a name="values"></a><code>values</code></td><td><code class="type">Object[]</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td> Depreciated. Use <code><a href="#userValues">userValues</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="#createItemFromDataRow">createItemFromDataRow</a></code></td><td> This method is called when using data binding. This is used to create a new <code><a href="BiListItem.html">BiListItem</a></code> from a <code><a href="BiDataRow.html">BiDataRow</a></code>. </td></tr><tr><td><code><a href="#dataBind">dataBind</a></code></td><td> If the list has a <code><a href="#dataSource">dataSource</a></code> then this binds that data source to the list. </td></tr><tr><td><code><a href="#findString">findString</a></code></td><td> Searches the <code><a href="BiListItem.html">items</a></code> for an item that starts with the given string. This match is case insensitive. If no item is found this returns <code>null</code> </td></tr><tr><td><code><a href="#findStringExact">findStringExact</a></code></td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -