biradiobutton.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 79 行

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiRadioButton" extends="BiLabel">

	<description>
		Represents a radio button control. A radio button control can have two
		states; checked and unchecked. These are represented by the
		<link>checked</link> 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
		<link class="BiRadioGroup">radio group</link> must be checked.
	</description>


	<arguments>
		<argument name="sText" type="String" description="The text to show on the radio button"
			optional="true" default='""'/>
		<argument name="bChecked" type="Boolean" description="Whether the radio button is checked or not"
			optional="true" default="false"/>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods/>

	<properties>
		<property name="checked" type="Boolean" get="true" set="true">
			<description>
				Whether the radio button is checked or not. When this is changed
				the <link>change</link> event is fired.
			</description>
		</property>
		<property name="value" type="Boolean" get="true" set="true">
			<description>
				Depreciated. Use <link>checked</link> instead.
			</description>
		</property>
		<property name="userValue" type="Object" get="true" set="true">
			<description>
				A value associated with the radio button.
			</description>
		</property>
		<property name="group" get="true" set="true">
			<description>
				The group that the radio button should be part of
			</description>
			<type><link class="BiRadioGroup">BiRadioGroup</link></type>
		</property>
	</properties>

	<events>
		<event name="change">
			<description>
				Fires when the <link>checked</link> is changed
			</description>
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
		<event name="action">
			<description>Fires when the user presses the button (either using
				the mouse or the keyboard)
			</description>
			<type><link class="BiEvent">BiEvent</link></type>
		</event>
	</events>

	<remarks>
		Note that icons are not supported on radio buttons.<br/>
		<br/>
		If the radio button has a <link class="BiComponent" field="command">command</link>
		the command will be <link class="BiCommand" field="execute">executed</link>
		when the user clicks the button. The <link>checked</link> and
		<link>userValue</link> properties are synchronized with the command.
	</remarks>
</class>