bilabel.xml

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

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

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

	<description>
		This class is used to show text
	</description>

	<arguments>
		<argument name="sText" type="String" description="The text to show on the label"
			optional="true" default='""'/>
	</arguments>

	<staticMethods>
		<method name="htmlToText">
			<description>Strips HTML markup from an HTML string and returns a plain text string</description>
			<arguments>
				<argument name="sHtml" type="String" description="The HTML string to convert"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="textToHtml">
			<description>Converts a plain text string to HTML. This includes adding line breaks and entities.</description>
			<arguments>
				<argument name="sText" type="String" description="The plain text string to convert"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="addMnemonic">
			<description>Changes an HTML string to designate a character as a mnemonic</description>
			<arguments>
				<argument name="sHtml" type="String" description="The HTML text to add the mnemonic to"/>
				<argument name="sMnemonic" type="String" description="The mnemonic character"/>
			</arguments>
			<returns type="String"/>
		</method>
	</staticMethods>

	<staticFields/>

	<methods>
		<method name="setPadding">
			<description>
				Sets the padding on more than one side. This method can ba called with
				1, 2 or 4 arguments. In case of 1 argument it sets the padding on all
				sides. If 2 arguments are used then the padding on the left/right and
				top/bottom are set to the same. And if called with 4 all 4 sides can have
				different padding,<br/>
				<br/>
				<code>setPadding(nPadding)</code> - Sets the padding on all sides to
				<code>nPadding</code><br/>
				<code>setPadding(nLeftRight, nTopBottom)</code> - Sets the padding on
				the left and right to <code>nLeftRight</code> and the padding on the
				top and bottom to <code>nTopBottom</code><br/>
				<code>setPadding(nLeft, nRight, nTop, nBottom)</code> - Sets the padding
				on all sides to <code>nLeft</code>, <code>nRight</code>, <code>nTop</code>
				and <code>nBottom</code> respectively.
			</description>
			<arguments>
				<argument name="nLeft" type="Number" description="Left padding"/>
				<argument name="nRight" type="Number" description="Right padding" optional="true"/>
				<argument name="nTop" type="Number" description="Top padding" optional="true"/>
				<argument name="nBottom" type="Number" description="Bottom padding" optional="true"/>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="text" type="String" description="The plain text shown on the label" get="true" set="true"/>
		<property name="html" type="String" description="The HTML text shown on the label" get="true" set="true"/>
		<property name="mnemonic" type="String" description="A character used to give UI hints about the access key for the label" get="true" set="true"/>
		<property name="font" get="true" set="true">
			<description>This is used to describe how to paint the text on the label.</description>
			<type><link class="BiFont">BiFont</link></type>
		</property>
		<property name="labelFor" get="true" set="true">
			<description>If this is set then focusing on the current label moves the focus to another component</description>
			<type><link class="BiComponent">BiComponent</link></type>
		</property>
		<property name="wrap" type="Boolean" description="Whether to wrap the text if the label is not wide enough" get="true" set="true"/>
		<!--
		<property name="padding" type="Number" description="The padding (in pixels) on all sides" set="true"/>
		-->
		<property name="paddingLeft" type="Number" description="The left padding (in pixels)" set="true" get="true"/>
		<property name="paddingRight" type="Number" description="The right padding (in pixels)" set="true" get="true"/>
		<property name="paddingTop" type="Number" description="The top padding (in pixels)" set="true" get="true"/>
		<property name="paddingBottom" type="Number" description="The bottom padding (in pixels)" set="true" get="true"/>

		<property name="align" type="String" set="true" get="true">
			<description>
				The text alignment. Valid values are:<br/>
				<br/>
				<code>left</code><br/>
				<code>right</code><br/>
				<code>center</code><br/>
				<code>justify</code>
			</description>
		</property>
		<property name="verticalAlign" type="String" set="true" get="true">
			<description>
				NOT IMPLEMENTED<br/>
				<br/>
				The vertical text alignment. Valid values are:<br/>
				<br/>
				<code>top</code><br/>
				<code>middle</code><br/>
				<code>bottom</code>
			</description>
		</property>
		<property name="icon" get="true" set="true">
			<description>The icon image to show on the label. Note that changing
				the image object does not update the label icon. You'll have to
				set the icon property to update the label icon.</description>
			<type><link class="BiImage">BiImage</link></type>
		</property>
		<property name="iconPosition" type="String" set="true" get="true">
			<description>
				The position of the icon relative to the text. Valid values are:<br/>
				<br/>
				<code>left</code><br/>
				<code>right</code><br/>
				<code>top</code><br/>
				<code>bottom</code>
			</description>
		</property>
		<property name="iconTextGap" type="Number" description="The gap between the icon and the text (in pixels)" set="true" get="true"/>
	</properties>

	<events/>

	<remarks>
		To change the font of the component you have to use
		<link class="BiLabel" field="font">setFont()</link>. Changing the
		font object without calling <link class="BiLabel" field="font">setFont()</link>
		will not update the component.<br/>
		<br/>
		To change the icon of the component you have to use
		<link class="BiLabel" field="icon">setIcon()</link>. Changing the
		image object without calling <link class="BiLabel" field="icon">setIcon()</link>
		will not update the component.
	</remarks>

</class>