?? biradiogroup.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>BiRadioGroup</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="BiRadioGroup">BiRadioGroup</h1>
<p>
This class is used in conjunction with <code><a href="BiRadioButton.html">radio
buttons</a></code> to ensure only one buttons is checked.
</p>
<p>This class extends
<code><a href="BiEventTarget.html">BiEventTarget</a></code>
and therefore all methods and fields available for
<code><a href="BiEventTarget.html">BiEventTarget</a></code>
are also available for <code>BiRadioGroup</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>BiRadioGroup</code><ul id="api-derived-classes"></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiRadioGroup()</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="command"></a><code>command</code></td>
<td><code class="type"><code><a href="BiCommand.html">BiCommand</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>
When the radio group has a command the <code><a href="#enabled">enabled</a></code> and
<code><a href="#userValue">userValue</a></code> are synchronized with the command.
</td>
</tr>
<tr>
<td><a name="enabled"></a><code>enabled</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 radio group is enabled or not. Setting this also
sets the enabled property on the radio buttons.
</td>
</tr>
<tr>
<td><a name="items"></a><code>items</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton[]</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 is the items that are part of
the radio group</td>
</tr>
<tr>
<td><a name="selected"></a><code>selected</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton</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 is the radio button
that is checked</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 user value of the checked radio button in this radio
group. Setting this checks the first item that has this value.
If no item has this value the setting will have no effect.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#add">add</a></code></td>
<td>Adds a radio button to the group</td>
</tr>
<tr>
<td><code><a href="#remove">remove</a></code></td>
<td>Removes a radio button from the group</td>
</tr>
<tr>
<td><code><a href="#selectNext">selectNext</a></code></td>
<td>
Selects (checks and sets focus) the next valid radio button
comming after the provided radio button.
</td>
</tr>
<tr>
<td><code><a href="#selectPrevious">selectPrevious</a></code></td>
<td>
Selects (checks and sets focus) the previous valid radio button
comming before the provided radio button.
</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="change"></a><code>change</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>This is fired when the selected radio button is changed</td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>None.</p>
<h2>Method Details</h2>
<h3><a name="add"></a>add</h3>
<p>Adds a radio button to the group</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.add(<span class="methodArgument">oRadioButton</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>oRadioButton</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The radio button to add to the group</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="remove"></a>remove</h3>
<p>Removes a radio button from the group</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.remove(<span class="methodArgument">oRadioButton</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>oRadioButton</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The radio button to remove</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="selectNext"></a>selectNext</h3>
<p>
Selects (checks and sets focus) the next valid radio button
comming after the provided radio button.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.selectNext(<span class="methodArgument">oRadioButton</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>oRadioButton</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The radio button to find the next relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="selectPrevious"></a>selectPrevious</h3>
<p>
Selects (checks and sets focus) the previous valid radio button
comming before the provided radio button.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.selectPrevious(<span class="methodArgument">oRadioButton</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>oRadioButton</code></td>
<td><code class="type"><code><a href="BiRadioButton.html">BiRadioButton</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The radio button to find the previous relative to</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -