bicomponent.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 1,308 行 · 第 1/4 页

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiComponent" extends="BiEventTarget">
	<description>This is the core class for all visual components in Bindows.</description>
	<arguments>
		<argument name="sName" optional="true">
			<description>The argument is optional and can be used to describe the component.</description>
			<type>String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="enqueueLayout">
			<description>This adds a component to the layout queue. This will make the layout system
 update the size and location of the component (if needed) the next time it
 updates the layout.</description>
			<arguments>
				<argument name="c">
					<description>The component to enqueue</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="flushLayoutQueue">
			<description>This goes through the entire layout queue and calls <link>layoutComponent</link>
 and <link>layoutAllChildren</link> (if needed) for the enqued components.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="flushLayoutComponent">
			<description>This updates the layout for the component and all its ancestors (if needed)</description>
			<arguments>
				<argument name="c">
					<description>The component to update the layout for</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="invalidateAll">
			<description>This goes through all the exisiting components and invalidates them</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="add">
			<description>Adds a component to the current component. The added
 component becomes a child of the current component. If the component
 is child of another component it is first removed from that component.
 The second, optional, argument can be used to insert the new component
 before an existing child.
 This raises exception if oBefore is not a child of this.</description>
			<arguments>
				<argument name="oChild">
					<description>The component to add</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="oBefore" optional="true">
					<description>The existing child do add the new component before </description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
				<argument name="bAnonymous">
					<description>Whether the added component should be <link>anonymous</link>.</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="remove">
			<description>Removes an existing child from the component.</description>
			<arguments>
				<argument name="oChild">
					<description>The component to remove</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiComponent">BiComponent</link>
				</type>
			</returns>
		</method>
		<method name="removeAll">
			<description>Removes and disposes all children.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="hasChildren">
			<description>Returns true if the component has any child components. This does not include
 anonymous children so if all children are anonymous then this will return
 <code>false</code>.</description>
			<arguments>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="contains">
			<description>Returns true if the componenent contains another component.
 This means that the current component is an ancestor of the descendant.
 Note that the current component contains itself so calling
 <code>component.contains(component)</code> will return <code>true</code>.</description>
			<arguments>
				<argument name="oDescendant">
					<description>The component to test whether the current component contains it.</description>
					<type>
						<link class="BiComponent">BiComponent</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setStyleProperty">
			<description>Adds a certain style property to the HTML element represented
 by the component. This should be used with caution since in some cases
 this might give unrespected results.</description>
			<arguments>
				<argument name="sProp">
					<description>The CSS property name</description>
					<type>String</type>
				</argument>
				<argument name="sValue">
					<description>The CSS value</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getStyleProperty">
			<description>Returns the CSS style property value for the HTML element
 represented by the component. This should be used with caution since in some cases
 this might give unrespected results.</description>
			<arguments>
				<argument name="sProp">
					<description>The CSS property name</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="removeStyleProperty">
			<description>Removes the CSS style property value for the HTML element
 represented by the component. This should be used with caution since in some cases
 this might give unrespected results.</description>
			<arguments>
				<argument name="sProp">
					<description>The CSS property name</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getHtmlProperty">
			<description>Returns the HTML property value for the HTML element
 represented by the component.</description>
			<arguments>
				<argument name="sProp">
					<description>The HTML property name</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="setHtmlProperty">
			<description>Sets a certain HTML DOM property to the HTML element represented
 by the component. This should be used with caution since in some cases
 this might give unrespected results.</description>
			<arguments>
				<argument name="sProp">
					<description>The HTML DOM property name</description>
					<type>String</type>
				</argument>
				<argument name="oValue">
					<description>The HTML DOM property value</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="removeHtmlProperty">
			<description>Removes the HTML DOM property value for the HTML element
 represented by the component. This should be used with caution since in some cases
 this might give unrespected results.</description>
			<arguments>
				<argument name="sProp">
					<description>The HTML DOM property name</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setSize">
			<description>Sets both width and height for the component.</description>
			<arguments>
				<argument name="nWidth">
					<description>The new width of the component</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The new height of the component</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setLocation">
			<description>Sets the left and top position for the component.</description>
			<arguments>
				<argument name="nLeft">
					<description>The new left location for the component</description>
					<type>Number</type>
				</argument>
				<argument name="nTop">
					<description>The new top locatin for the component</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="setBounds">
			<description>Sets the left and top position as well as the width and height for the component.</description>
			<arguments>
				<argument name="nLeft">
					<description>The new left location for the component</description>
					<type>Number</type>
				</argument>
				<argument name="nTop">
					<description>The new top locatin for the component</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The new width of the component</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The new height of the component</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="invalidateParentLayout">
			<description>This is called when the size and/or position of the component is changed
 and therefore the layout needs to be updated<br>
				</br>
 The hint can be used by layout components to be more efficient and ignore
 hints that does not affect the layout. Known hints are:<br>
				</br>
 "size"<br>
				</br>
 "preferred"<br>
				</br>
 "minimum"<br>
				</br>
 "maximum"<br>
				</br>
 "margin"</description>
			<arguments>
				<argument name="sHint">
					<description>A hint string that the layout manager can use</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="invalidateLayout">
			<description>This method is called when a component is changed so that its internal
 layout is no longer valid. This schedules a call to <link>layoutAllChildren</link>
			</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="invalidateChild">
			<description>This method is called when a child component no longer has valid size and/or