biareacollection.html

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

HTML
301
字号
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--Generated using api.website.xsl version 2003-07-17--><head><META http-equiv="Content-Type" content="text/html; charset=utf-8"><title>BiAreaCollection</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">				function showDerivedClasses() {					var ul = document.getElementById("api-derived-classes");					var lis = ul.childNodes;					var l = lis.length;					for (var i = 1; i < l; i++)						lis[i].style.display = "";					lis[0].style.display = "none";				}			</script></head><body><h1 id="BiAreaCollection">BiAreaCollection</h1><p>This collection contains<code><a href="BiArea.html">BiArea</a></code> objects This implements the same interface as<code><a href="BiSelectionItemCollection.html">BiSelectionItemCollection</a></code>	</p><p>This class extends		<code><a href="BiObject.html">BiObject</a></code>		and therefore all methods and fields available for		<code><a href="BiObject.html">BiObject</a></code>		are also available for <code>BiAreaCollection</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code>BiAreaCollection</code><ul id="api-derived-classes"></ul></li></ul></li></ul><h2>Constructor</h2><p><code>	new BiAreaCollection()</code></p><h3>Parameters</h3><p>No parameters.</p><h2>Properties</h2><table><thead><tr><td>Name</td><td>Type</td><td class="get-header">get</td><td class="set-header">set</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="changeValue"></a><code>changeValue</code></td><td><code class="type">Object</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is used by<code><a href="BiSelectionModel.html">BiSelectionModel</a></code> to compare whether the collection has changed. Two identical collections should always return the same value. If a change has occured the change value must also change</td></tr></tbody></table><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#add">add</a></code></td><td>Adds an area to the collection. This does not check whether the area might intersect with any of the existing areas in the collection</td></tr><tr><td><code><a href="#contains">contains</a></code></td><td>Whether the collection contains the area. This also returns true if one of the areas in the collection completely encloses the area.</td></tr><tr><td><code><a href="#getItemHashCode">getItemHashCode</a></code></td><td>Returns an identifier for the area</td></tr><tr><td><code><a href="#hitTest">hitTest</a></code></td><td>Tests whether a point is inside any of the areas in the collection</td></tr><tr><td><code><a href="#isEmpty">isEmpty</a></code></td><td>Whether the collection is empty</td></tr><tr><td><code><a href="#remove">remove</a></code></td><td>Removes an area from the collection.</td></tr><tr><td><code><a href="#removeAll">removeAll</a></code></td><td>Removes all the areas in the collection making it empty</td></tr><tr><td><code><a href="#toArray">toArray</a></code></td><td>Returns an array containing the areas in the collection</td></tr></tbody></table><h2>Events</h2><p>None.</p><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><p>None.</p><h2>Remarks</h2><p>	</p><h2>Method Details</h2><h3><a name="add"></a>add</h3><p>Adds an area to the collection. This does not check whether the area might intersect with any of the existing areas in the collection</p><h4>Syntax</h4><pre class="method-syntax">object.add(<span class="methodArgument">oArea</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>oArea</code></td><td><code class="type">						<code><a href="BiArea.html">BiArea</a></code>					</code></td><td class="optional-column"></td><td></td><td>The area to add</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="contains"></a>contains</h3><p>Whether the collection contains the area. This also returns true if one of the areas in the collection completely encloses the area.</p><h4>Syntax</h4><pre class="method-syntax">object.contains(<span class="methodArgument">oArea</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>oArea</code></td><td><code class="type">						<code><a href="BiArea.html">BiArea</a></code>					</code></td><td class="optional-column"></td><td></td><td>The area to test whether the collection contains</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Boolean</code></p><h3><a name="getItemHashCode"></a>getItemHashCode</h3><p>Returns an identifier for the area</p><h4>Syntax</h4><pre class="method-syntax">object.getItemHashCode(<span class="methodArgument">oItem</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>oItem</code></td><td><code class="type">						<code><a href="BiArea.html">BiArea</a></code>					</code></td><td class="optional-column"></td><td></td><td>The area to get the identifier for</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">String</code></p><h3><a name="hitTest"></a>hitTest</h3><p>Tests whether a point is inside any of the areas in the collection</p><h4>Syntax</h4><pre class="method-syntax">object.hitTest(<span class="methodArgument">x</span>, <span class="methodArgument">y</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>x</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The x coordinate</td></tr><tr><td><code>y</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The y coordinate</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Boolean</code></p><h3><a name="isEmpty"></a>isEmpty</h3><p>Whether the collection is empty</p><h4>Syntax</h4><pre class="method-syntax">object.isEmpty()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">Boolean</code></p><h3><a name="remove"></a>remove</h3><p>Removes an area from the collection.</p><h4>Syntax</h4><pre class="method-syntax">object.remove(<span class="methodArgument">oArea</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>oArea</code></td><td><code class="type">						<code><a href="BiArea.html">BiArea</a></code>					</code></td><td class="optional-column"></td><td></td><td>The area to remove</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="removeAll"></a>removeAll</h3><p>Removes all the areas in the collection making it empty</p><h4>Syntax</h4><pre class="method-syntax">object.removeAll()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="toArray"></a>toArray</h3><p>Returns an array containing the areas in the collection</p><h4>Syntax</h4><pre class="method-syntax">object.toArray()</pre><h4>Parameters</h4><p>No arguments.</p><h4>Return Type</h4><p><code class="type">					<code><a href="BiArea.html">BiArea[]</a></code>				</code></p></body></html>

⌨️ 快捷键说明

复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?