bitoolbartogglebutton.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiToolBarToggleButton" extends="BiToolBarButton">
	<description>This represents a toggle button (check box button) that can be placed on a tool bar.</description>
	<arguments>
		<argument name="sText" optional="true">
			<description>The text to show on the button </description>
			<type>String</type>
		</argument>
		<argument name="oIcon" optional="true">
			<description>The image to show as icon on the button </description>
			<type>
				<link class="BiImage">BiImage</link>
			</type>
		</argument>
		<argument name="bChecked" optional="true" default="false">
			<description>Whether the button is checked or not </description>
			<type>Boolean</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
	</methods>
	<properties>
		<property name="checked" get="true" set="true">
			<description>Whether the button is checked or not. When this is changed
 the <link>change</link> event is fired.</description>
			<type>Boolean</type>
		</property>
		<property name="userValue" get="true" set="true">
			<description>A value associated with the button.</description>
			<type>Object</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>
	</events>
	<remarks>If the tool bar button has a <link class="BiComponent" field="command">command</link>
 			the command will be <link class="BiCommand" field="execute">executed</link>
          when the button is clicked. The <link>checked</link> and <link>userValue</link>
          properties will also be synchronized with the command.</remarks>
</class>