📄 biradiobutton.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>BiRadioButton</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="BiRadioButton">BiRadioButton</h1>
<p>
Represents a radio button control. A radio button control can have two
states; checked and unchecked. These are represented by the
<code><a href="#checked">checked</a></code> property.<br>
<br>
Once a radio button is checked clicking it again will not uncheck it. To
uncheck a radio button another radio button in the same
<code><a href="BiRadioGroup.html">radio group</a></code> must be checked.
</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>BiRadioButton</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>BiRadioButton</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiRadioButton([<span class="methodArgument">sText</span> [, <span class="methodArgument">bChecked</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 radio button</td>
</tr>
<tr>
<td><code>bChecked</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>false</code></td>
<td>Whether the radio button is checked or not</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="checked"></a><code>checked</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 button is checked or not. When this is changed
the <code><a href="#change">change</a></code> event is fired.
</td>
</tr>
<tr>
<td><a name="group"></a><code>group</code></td>
<td><code class="type"><code><a href="BiRadioGroup.html">BiRadioGroup</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 group that the radio button should be part of
</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 radio button.
</td>
</tr>
<tr>
<td><a name="value"></a><code>value</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>
Depreciated. Use <code><a href="#checked">checked</a></code> instead.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<p>None.</p>
<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>Fires when the user presses the button (either using
the mouse or the keyboard)
</td>
</tr>
<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>
Fires when the <code><a href="#checked">checked</a></code> is changed
</td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
Note that icons are not supperted on radio buttons.<br>
<br>
If the radio button 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 clicks the button. The <code><a href="#checked">checked</a></code> and
<code><a href="#userValue">userValue</a></code> properties are synchronized with the command.
</p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -