bifont.xml

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

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


<class name="BiFont" extends="BiObject">

	<description>
		This class is used with <link class="BiLabel">BiLabel</link> to provide
		the font style information.
	</description>

	<arguments>
		<argument name="nSize" type="Number" description="The font size in pixels" optional="true"/>
		<argument name="sName" type="String" description="The font name" optional="true"/>
	</arguments>

	<staticMethods>
		<method name="fromString">
			<description>
				Parses a string and returns a new font object. The format for the
				string is<br/>
				<br/>
				"bold"? "italic"? "underline"? "strikeout"? (&lt;size&gt;"px"?)? &lt;font name&gt;?<br/>
				<br/>
				12px bold italic Arial<br/>
				<br/>
				The order of the parts is not relevant.
			</description>
			<arguments>
				<argument name="s" description="The string to parse" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiFont">BiFont</link></type>
			</returns>
		</method>
	</staticMethods>

	<staticFields/>

	<methods>
		<method name="paintFont">
			<description>Makes the component have a font described by the current font object</description>
			<arguments>
				<argument name="oComponent" description="The component to set the font to">
					<type><link class="BiComponent">BiComponent</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="removeFont">
			<description>
				Removes this font from a component. This means that
				the font styles this font object has applied to a component
				will be reset/removed.
			</description>
			<arguments>
				<argument name="oComponent" description="The component to remove the font from">
					<type><link class="BiComponent">BiComponent</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="size" type="Number" description="The font size (in pixels)" get="true" set="true"/>
		<property name="bold" type="Boolean" description="Whether to use bold" get="true" set="true"/>
		<property name="italic" type="Boolean" description="Whether to use italic" get="true" set="true"/>
		<property name="underline" type="Boolean" description="Whether to underline the text" get="true" set="true"/>
		<property name="strikeout" type="Boolean" description="Whether to line through the text" get="true" set="true"/>
		<property name="name" type="String" description="The name of the font. A comma seprated list also works" get="true" set="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.
	</remarks>

</class>