20f8df1291
data tables are going to need some work yet, but the other stuff seems to be working 100%
661 lines
29 KiB
HTML
661 lines
29 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: dom YAHOO.util.Region (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>dom <span class="subtitle">2.6.0</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_dom.html">dom</a>
|
|
> YAHOO.util.Region
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.util.Region</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
<dl class="subclasses">
|
|
<dt>Known Subclasses:</dd>
|
|
<dd>
|
|
<a href="YAHOO.util.Point.html">YAHOO.util.Point</a>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
A region is a representation of an object on a grid. It is defined
|
|
by the top, right, bottom, left extents, so is rectangular by default. If
|
|
other shapes are required, this class could be extended to support it.
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.util.Region</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
t
|
|
|
|
,
|
|
r
|
|
|
|
,
|
|
b
|
|
|
|
,
|
|
l
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>t
|
|
<Int>
|
|
</code>
|
|
the top extent
|
|
</dd>
|
|
<dd>
|
|
<code>r
|
|
<Int>
|
|
</code>
|
|
the right extent
|
|
</dd>
|
|
<dd>
|
|
<code>b
|
|
<Int>
|
|
</code>
|
|
the bottom extent
|
|
</dd>
|
|
<dd>
|
|
<code>l
|
|
<Int>
|
|
</code>
|
|
the left extent
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="property_0">0</a>
|
|
<code>- Int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's left extent as index, for symmetry with set/getXY
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_1">1</a>
|
|
<code>- Int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's top extent as index, for symmetry with set/getXY
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_bottom">bottom</a>
|
|
<code>- Int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's bottom extent
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_left">left</a>
|
|
<code>- Int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's left extent
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_right">right</a>
|
|
<code>- int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's right extent
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_top">top</a>
|
|
<code>- Int</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The region's top extent
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_contains">contains</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>contains</strong>
|
|
(
|
|
|
|
|
|
region
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns true if this region contains the region passed in
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>region <Region></code>
|
|
The region to evaluate
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>True if the region is contained with this region,
|
|
else false</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getArea">getArea</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Int
|
|
<strong>getArea</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns the area of the region
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Int
|
|
</code></dt>
|
|
<dd>the region's area</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getRegion">getRegion</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
static
|
|
|
|
Region
|
|
<strong>getRegion</strong>
|
|
(
|
|
|
|
|
|
el
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns a region that is occupied by the DOM element
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el <HTMLElement></code>
|
|
The element
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Region
|
|
</code></dt>
|
|
<dd>The region that the element occupies</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_intersect">intersect</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Region
|
|
<strong>intersect</strong>
|
|
(
|
|
|
|
|
|
region
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns the region where the passed in region overlaps with this one
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>region <Region></code>
|
|
The region that intersects
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Region
|
|
</code></dt>
|
|
<dd>The overlap region, or null if there is no overlap</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_toString">toString</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
|
|
<strong>toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
toString
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_union">union</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Region
|
|
<strong>union</strong>
|
|
(
|
|
|
|
|
|
region
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns the region representing the smallest region that can contain both
|
|
the passed in region and this region.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>region <Region></code>
|
|
The region that to create the union with
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Region
|
|
</code></dt>
|
|
<dd>The union region</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_carousel.html">carousel</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class="selected"><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class=""><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class=""><a href="module_paginator.html">paginator</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class=""><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="YAHOO.util.Dom.html">YAHOO.util.Dom</a></li>
|
|
<li class=""><a href="YAHOO.util.Point.html">YAHOO.util.Point</a></li>
|
|
<li class="selected"><a href="YAHOO.util.Region.html">YAHOO.util.Region</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Dom.js.html">Dom.js</a></li>
|
|
<li class=""><a href="Region.js.html">Region.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#property_0">0</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_1">1</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_bottom">bottom</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_left">left</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_right">right</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_top">top</a>
|
|
<!--<code><Int></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_contains">contains</a>
|
|
</li>
|
|
<li class=""><!--<code>Int</code>-->
|
|
<a href="#method_getArea">getArea</a>
|
|
</li>
|
|
<li class=""><!--<code>Region</code>-->
|
|
<a href="#method_getRegion">getRegion</a>
|
|
</li>
|
|
<li class=""><!--<code>Region</code>-->
|
|
<a href="#method_intersect">intersect</a>
|
|
</li>
|
|
<li class=""><!--<code></code>-->
|
|
<a href="#method_toString">toString</a>
|
|
</li>
|
|
<li class=""><!--<code>Region</code>-->
|
|
<a href="#method_union">union</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2008 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|