bicomponent.html

在流览器上仿CS界面的JAVASCRIPT脚本

</tr>
<tr>
<td><a name="resize"></a><code>resize</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td>
				This event is fired when a created component changes its size.
			</td>
</tr>
<tr>
<td><a name="scroll"></a><code>scroll</code></td>
<td><code class="type"><code><a href="BiEvent.html">BiEvent</a></code></code></td>
<td class="bubbles-column"></td>
<td></td>
</tr>
</tbody>
</table>
<h2>Static Methods</h2>
<p>None.</p>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>None.</p>
<h2>Method Details</h2>
<h3><a name="add"></a>add</h3>
<p>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.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.add(<span class="methodArgument">oChild</span> [, <span class="methodArgument">oBefore</span> [, <span class="methodArgument">bAnonymous</span>]])</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oChild</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The component to add</td>
</tr>
<tr>
<td><code>oBefore</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>The existing child do add the new component before</td>
</tr>
<tr>
<td><code>bAnonymous</code></td>
<td><code class="type">Boolean</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>false</code></td>
<td>
						Whether the added component should be <code><a href="#anonymous">anonymous</a></code>.
					</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="contains"></a>contains</h3>
<p>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>.
				</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.contains(<span class="methodArgument">oComponent</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oComponent</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The component to test whether the current component contains it.</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="getHtmlProperty"></a>getHtmlProperty</h3>
<p>Returns the HTML 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.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getHtmlProperty(<span class="methodArgument">sPropertyName</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sPropertyName</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The HTML property name</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="getStyleProperty"></a>getStyleProperty</h3>
<p>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.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getStyleProperty(<span class="methodArgument">sPropertyName</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sPropertyName</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The CSS property name</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="hasChildren"></a>hasChildren</h3>
<p>Returns true if the component has any child components</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasChildren()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="layoutAllChildren"></a>layoutAllChildren</h3>
<p>
				Calls <code><a href="#layoutComponent">layoutComponent</a></code> on all the <code><a href="#children">children</a></code>.
				Note that this does not call <code><a href="#layoutChildrenX">layoutChildrenX</a></code> or
				<code><a href="#layoutChildrenY">layoutChildrenY</a></code> so if you override this method you
				should also overried <code><a href="#layoutChildrenX">layoutChildrenX</a></code> and
				<code><a href="#layoutChildrenY">layoutChildrenY</a></code> as well.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutAllChildren()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutAllChildrenX"></a>layoutAllChildrenX</h3>
<p>
				Calls <code><a href="#layoutComponentX">layoutComponentX</a></code> on all the <code><a href="#children">children</a></code>.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutAllChildrenX()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutAllChildrenY"></a>layoutAllChildrenY</h3>
<p>
				Calls <code><a href="#layoutComponentY">layoutComponentY</a></code> on all the <code><a href="#children">children</a></code>.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutAllChildrenY()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutChild"></a>layoutChild</h3>
<p>
				Handles both the horizontal and verical layout of the child. If
				the child changes its size and it has any children this will also
				call layoutAllChildren on the child.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutChild(<span class="methodArgument">oChild</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oChild</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The component to layout</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutChildX"></a>layoutChildX</h3>
<p>
				Handles the horizontal layout of the child. If the child changes
				its size and it has any children this will also call layoutAllChildren
				on the child.
				</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutChildX(<span class="methodArgument">oChild</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oChild</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The component to layout</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutChildY"></a>layoutChildY</h3>
<p>
				Handles the vertical layout of the child. If the child changes
				its size and it has any children this will also call layoutAllChildren
				on the child.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutChildY(<span class="methodArgument">oChild</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oChild</code></td>
<td><code class="type"><code><a href="BiComponent.html">BiComponent</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The component to layout</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutComponent"></a>layoutComponent</h3>
<p>
				Handles the size and position of the current component. Most
				components ask their parent to do the actual layout but this can
				be overridden to allow the component to take care of its own size
				and position.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutComponent()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutComponentX"></a>layoutComponentX</h3>
<p>
				Handles the horizontal size and position (left, width and right)
				of the current component. Most components ask their parent to do
				the actual layout but this can be overridden to allow the component
				to take care of its own size and position.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutComponentX()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="layoutComponentY"></a>layoutComponentY</h3>
<p>
				Handles the vertical size and position (top, height and bottom)
				of the current component. Most components ask their parent to do
				the actual layout but this can be overridden to allow the component
				to take care of its own size and position.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.layoutComponentY()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="pack"></a>pack</h3>
<p>Sets the size to the preferred width and height</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.pack()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>