biborder.xml

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

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

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

	<description>
		This class is used to describe a border for a component. The border
		consists of three properties; width, style and color. Supported styles
		are:<br/>
		<br/>
		<code>none</code> - No border is drawn, regardless of the width.<br/>
		<code>dotted</code><br/>
		<code>dashed</code><br/>
		<code>solid</code><br/>
		<code>double</code><br/>
		<code>groove</code><br/>
		<code>ridge</code><br/>
		<code>inset</code><br/>
		<code>outset</code>
	</description>


	<arguments>
		<argument name="width" type="Number" description="The width (in pixels) of the border on all sides" optional="true" default="0"/>
		<argument name="style" type="String" description="The style of the border on all sides" optional="true" default="solid"/>
		<argument name="color" type="String" description="The color of the border on all sides" optional="true"/>
	</arguments>

	<staticMethods>
		<method name="fromString">
			<description>
				Parses a string and returns a new border object. The format for the
				string is<br/>
				<br/>
				(&lt;size&gt;"px"?)? &lt;style&gt;? &lt;color&gt;?<br/>
				<br/>
				2px dotted red<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="paintBorder">
			<description>Makes the component have a border described by the current border object</description>
			<arguments>
				<argument name="oComponent" description="The component to draw the border to">
					<type><link class="BiComponent">BiComponent</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="removeBorder">
			<description>
				Removes this border from a component. This means that
				the border styles this border object has applied to a component
				will be reset/removed.
			</description>
			<arguments>
				<argument name="oComponent" description="The component to remove the border from">
					<type><link class="BiComponent">BiComponent</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setLeft">
			<description>Sets the left width, style and color</description>
			<arguments>
				<argument name="width" type="Number" description="The width (in pixels) of the left border" optional="true" default="0"/>
				<argument name="style" type="String" description="The style of the left border" optional="true" default="solid"/>
				<argument name="color" type="String" description="The color of the left border" optional="true"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setRight">
			<description>Sets the right width, style and color</description>
			<arguments>
				<argument name="width" type="Number" description="The width (in pixels) of the right border" optional="true" default="0"/>
				<argument name="style" type="String" description="The style of the right border" optional="true" default="solid"/>
				<argument name="color" type="String" description="The color of the right border" optional="true"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setTop">
			<description>Sets the top width, style and color</description>
			<arguments>
				<argument name="width" type="Number" description="The width (in pixels) of the top border" optional="true" default="0"/>
				<argument name="style" type="String" description="The style of the top border" optional="true" default="solid"/>
				<argument name="color" type="String" description="The color of the top border" optional="true"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setBottom">
			<description>Sets the bottom width, style and color</description>
			<arguments>
				<argument name="width" type="Number" description="The width (in pixels) of the bottom border" optional="true" default="0"/>
				<argument name="style" type="String" description="The style of the bottom border" optional="true" default="solid"/>
				<argument name="color" type="String" description="The color of the bottom border" optional="true"/>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="leftWidth" type="Number" description="The left border width" get="true" set="true"/>
		<property name="rightWidth" type="Number" description="The right border width" get="true" set="true"/>
		<property name="topWidth" type="Number" description="The top border width" get="true" set="true"/>
		<property name="bottomWidth" type="Number" description="The bottom border width" get="true" set="true"/>

		<property name="leftStyle" type="String" description="The left border style" get="true" set="true"/>
		<property name="rightStyle" type="String" description="The right border style" get="true" set="true"/>
		<property name="topStyle" type="String" description="The top border style" get="true" set="true"/>
		<property name="bottomStyle" type="String" description="The bottom border style" get="true" set="true"/>

		<property name="leftColor" type="String" description="The left border color" get="true" set="true"/>
		<property name="rightColor" type="String" description="The right border color" get="true" set="true"/>
		<property name="topColor" type="String" description="The top border color" get="true" set="true"/>
		<property name="bottomColor" type="String" description="The bottom border color" get="true" set="true"/>

		<property name="width" type="Number" description="The width (in pixels) of the border on all sides" set="true"/>
		<property name="style" type="Number" description="The style of the border on all sides" set="true"/>
		<property name="color" type="Number" description="The color of the border on all sides" set="true"/>
	</properties>

	<events/>

	<remarks>
		To change the border on the component you have to use
		<link class="BiComponent" field="border">setBorder()</link>. Changing the
		border object without calling <link class="BiComponent" field="border">setBorder()</link>
		will not update the component.
	</remarks>

</class>