📄 biabstractgridrow.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>BiAbstractGridRow</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="BiAbstractGridRow">BiAbstractGridRow</h1>
<p>
The base class for the <code><a href="BiGridRow.html">rows</a></code> and
<code><a href="BiTreeNode.html">nodes</a></code> in a <code><a href="BiGrid.html">grid</a></code>
or a <code><a href="BiTree.html">tree</a></code>.
</p>
<p>This class extends
<code><a href="BiObject.html">BiObject</a></code>
and therefore all methods and fields available for
<code><a href="BiObject.html">BiObject</a></code>
are also available for <code>BiAbstractGridRow</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiAbstractGridRow</code><ul id="api-derived-classes"><li><code><a href="BiGridRow.html">BiGridRow</a></code></li><li><code><a href="BiTreeNode.html">BiTreeNode</a></code></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiAbstractGridRow()</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="backColor"></a><code>backColor</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 background color name</td>
</tr>
<tr>
<td><a name="created"></a><code>created</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>
This is true when the grid row has been drawn and has a visual
representation. For this to be true the tree must have been
created and drawn.
</td>
</tr>
<tr>
<td><a name="foreColor"></a><code>foreColor</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 foreground color name</td>
</tr>
<tr>
<td><a name="height"></a><code>height</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 height of the grid row (for a tree node this does not include children).
</td>
</tr>
<tr>
<td><a name="icon"></a><code>icon</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 image to use as icon on the row.
</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 grid row is selected or not.
</td>
</tr>
<tr>
<td><a name="top"></a><code>top</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 top position relative to the grid.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#getData">getData</a></code></td>
<td>
Returns the data for the column.
</td>
</tr>
<tr>
<td><code><a href="#matchesString">matchesString</a></code></td>
<td>
Tests whether the beginning of the text of the first cell
of the row 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 text of the first cell
of the row matches the given string. This match is case
insensitive.
</td>
</tr>
<tr>
<td><code><a href="#scrollIntoView">scrollIntoView</a></code></td>
<td>Scrolls the grid component viewport so that the
row becomes visible inside the viewport if possible. The
argument can be used to tell what edge of the viewport the node
should be aligned to. For a row only vertical scrolling is
taken into account.
</td>
</tr>
<tr>
<td><code><a href="#scrollIntoViewY">scrollIntoViewY</a></code></td>
<td>Scrolls the grid component viewport vertically so that the
row becomes visible inside the viewport if possible. The
argument can be used to tell what edge of the viewport the node
should be aligned to.
</td>
</tr>
<tr>
<td><code><a href="#setData">setData</a></code></td>
<td>
Sets the data for the given column.
</td>
</tr>
<tr>
<td><code><a href="#update">update</a></code></td>
<td>
Updates the row. This allows the grid to redraw only the current
row of the grid. This is useful when only a few items have
changed and therefore the whole data of the grid does not need
to be redrawn.
</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
The abstract grid row is not a <code><a href="BiComponent.html">BiComponent</a></code>.
</p>
<h2>Method Details</h2>
<h3><a name="getData"></a>getData</h3>
<p>
Returns the data for the column.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getData(<span class="methodArgument">nCol</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>nCol</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The column to get the data for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="matchesString"></a>matchesString</h3>
<p>
Tests whether the beginning of the text of the first cell
of the row 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 text of the first cell
of the row 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>
<h3><a name="scrollIntoView"></a>scrollIntoView</h3>
<p>Scrolls the grid component viewport so that the
row becomes visible inside the viewport if possible. The
argument can be used to tell what edge of the viewport the node
should be aligned to. For a row only vertical scrolling is
taken into account.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.scrollIntoView([<span class="methodArgument">bTopLeft</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>bTopLeft</code></td>
<td><code class="type">void</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>null</code></td>
<td>
This describes the value to align the node to relative
to the viewport of the grid.<br>
<br>
<code>null</code> - Scroll as little as possible to make
the row visible in the grid viewport.<br>
<code>true</code> - try to align the row with the
upper left edge of the grid viewport.<br>
<code>false</code> - try to align the row with the
lower right edge of the grid viewport.
</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="scrollIntoViewY"></a>scrollIntoViewY</h3>
<p>Scrolls the grid component viewport vertically so that the
row becomes visible inside the viewport if possible. The
argument can be used to tell what edge of the viewport the node
should be aligned to.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.scrollIntoViewY([<span class="methodArgument">bTop</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>bTop</code></td>
<td><code class="type">void</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>null</code></td>
<td>
This describes the value to align the row to relative
to the viewport of the grid.<br>
<br>
<code>null</code> - Scroll as little as possible to make
the row visible in the parent viewport.<br>
<code>true</code> - try to align the row with the
upper edge of the grid viewport.<br>
<code>false</code> - try to align the row with the
lower edge of the grid viewport.
</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="setData"></a>setData</h3>
<p>
Sets the data for the given column.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.setData(<span class="methodArgument">nCol</span>, <span class="methodArgument">oData</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>nCol</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The column to get the data for</td>
</tr>
<tr>
<td><code>oData</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The data to set</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="update"></a>update</h3>
<p>
Updates the row. This allows the grid to redraw only the current
row of the grid. This is useful when only a few items have
changed and therefore the whole data of the grid does not need
to be redrawn.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.update()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -