1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <title>API: dom YAHOO.util.Region (YUI Library)
</title>
5 <link rel=
"stylesheet" type=
"text/css" href=
"assets/api.css">
9 <div id=
"doc3" class=
"yui-t2">
12 <h1>Yahoo! UI Library
</h1>
13 <h3>dom
<span class=
"subtitle">2.2.0</span></h3>
15 <a href=
"./index.html">Yahoo! UI Library
</a>
16 > <a href=
"./module_dom.html">dom
</a>
17 > YAHOO.util.Region
32 Class
<b>YAHOO.util.Region
</b>
33 <span class=
"extends">
36 <span class=
"extends">
41 <!-- class tree goes here -->
43 <dl class=
"subclasses">
44 <dt>Known Subclasses:
</dd>
46 <a href=
"YAHOO.util.Point.html">YAHOO.util.Point
</a>
52 <div class=
"summary description">
53 A region is a representation of an object on a grid. It is defined
54 by the top, right, bottom, left extents, so is rectangular by default. If
55 other shapes are required, this class could be extended to support it.
58 <div class=
"section constructor details">
59 <h3><a name=
"constructor_detail">Constructor
</a></h3>
62 <strong>YAHOO.util.Region
</strong>
80 <div class=
"description">
115 <div class=
"section field details">
116 <h3><a name=
"field_detail">Properties
</a></h3>
117 <div class=
"content">
118 <h4><a name=
"0">0</a>
122 <div class=
"description">
123 The region's left extent as index, for symmetry with set/getXY
131 <h4><a name=
"1">1</a>
135 <div class=
"description">
136 The region's top extent as index, for symmetry with set/getXY
144 <h4><a name=
"bottom">bottom
</a>
148 <div class=
"description">
149 The region's bottom extent
157 <h4><a name=
"left">left
</a>
161 <div class=
"description">
162 The region's left extent
170 <h4><a name=
"right">right
</a>
174 <div class=
"description">
175 The region's right extent
183 <h4><a name=
"top">top
</a>
187 <div class=
"description">
188 The region's top extent
202 <div class=
"section method details">
203 <h3><a name=
"methodDetails">Methods
</a></h3>
204 <div class=
"content">
206 <a name=
"contains">contains
</a></h4>
213 <strong>contains
</strong>
223 <div class=
"description">
224 Returns true if this region contains the region passed in
227 <div class=
"description">
232 <code>region
<Region
></code>
233 The region to evaluate
242 <dd>True if the region is contained with this region,
251 <a name=
"getArea">getArea
</a></h4>
258 <strong>getArea
</strong>
263 <div class=
"description">
264 Returns the area of the region
267 <div class=
"description">
275 <dd>the region's area
</dd>
283 <a name=
"getRegion">getRegion
</a></h4>
290 <strong>getRegion
</strong>
300 <div class=
"description">
301 Returns a region that is occupied by the DOM element
304 <div class=
"description">
309 <code>el
<HTMLElement
></code>
319 <dd>The region that the element occupies
</dd>
327 <a name=
"intersect">intersect
</a></h4>
334 <strong>intersect
</strong>
344 <div class=
"description">
345 Returns the region where the passed in region overlaps with this one
348 <div class=
"description">
353 <code>region
<Region
></code>
354 The region that intersects
363 <dd>The overlap region, or null if there is no overlap
</dd>
371 <a name=
"toString">toString
</a></h4>
378 <strong>toString
</strong>
383 <div class=
"description">
387 <div class=
"description">
395 <dd>string the region properties
</dd>
403 <a name=
"union">union
</a></h4>
410 <strong>union
</strong>
420 <div class=
"description">
421 Returns the region representing the smallest region that can contain both
422 the passed in region and this region.
425 <div class=
"description">
430 <code>region
<Region
></code>
431 The region that to create the union with
440 <dd>The union region
</dd>
465 <li class=
""><a href=
"module_animation.html">animation
</a></li>
467 <li class=
""><a href=
"module_autocomplete.html">autocomplete
</a></li>
469 <li class=
""><a href=
"module_button.html">button
</a></li>
471 <li class=
""><a href=
"module_calendar.html">calendar
</a></li>
473 <li class=
""><a href=
"module_connection.html">connection
</a></li>
475 <li class=
""><a href=
"module_container.html">container
</a></li>
477 <li class=
""><a href=
"module_datasource.html">datasource
</a></li>
479 <li class=
""><a href=
"module_datatable.html">datatable
</a></li>
481 <li class=
"selected"><a href=
"module_dom.html">dom
</a></li>
483 <li class=
""><a href=
"module_dragdrop.html">dragdrop
</a></li>
485 <li class=
""><a href=
"module_element.html">element
</a></li>
487 <li class=
""><a href=
"module_event.html">event
</a></li>
489 <li class=
""><a href=
"module_history.html">history
</a></li>
491 <li class=
""><a href=
"module_logger.html">logger
</a></li>
493 <li class=
""><a href=
"module_menu.html">menu
</a></li>
495 <li class=
""><a href=
"module_slider.html">slider
</a></li>
497 <li class=
""><a href=
"module_tabview.html">tabview
</a></li>
499 <li class=
""><a href=
"module_treeview.html">treeview
</a></li>
501 <li class=
""><a href=
"module_yahoo.html">yahoo
</a></li>
508 <li class=
""><a href=
"YAHOO.util.Dom.html">YAHOO.util.Dom
</a></li>
509 <li class=
""><a href=
"YAHOO.util.Point.html">YAHOO.util.Point
</a></li>
510 <li class=
"selected"><a href=
"YAHOO.util.Region.html">YAHOO.util.Region
</a></li>
517 <li class=
""><a href=
"Dom.js.html">Dom.js
</a></li>
518 <li class=
""><a href=
"Region.js.html">Region.js
</a></li>
525 <li><a href=
"#0">0</a>
526 <!--<code><Int></code>-->
528 <li><a href=
"#1">1</a>
529 <!--<code><Int></code>-->
531 <li><a href=
"#bottom">bottom
</a>
532 <!--<code><Int></code>-->
534 <li><a href=
"#left">left
</a>
535 <!--<code><Int></code>-->
537 <li><a href=
"#right">right
</a>
538 <!--<code><Int></code>-->
540 <li><a href=
"#top">top
</a>
541 <!--<code><Int></code>-->
549 <li><!--<code>Boolean</code>-->
550 <a href=
"#contains">contains
</a>
552 <li><!--<code>Int</code>-->
553 <a href=
"#getArea">getArea
</a>
555 <li><!--<code>Region</code>-->
556 <a href=
"#getRegion">getRegion
</a>
558 <li><!--<code>Region</code>-->
559 <a href=
"#intersect">intersect
</a>
561 <li><!--<code>void</code>-->
562 <a href=
"#toString">toString
</a>
564 <li><!--<code>Region</code>-->
565 <a href=
"#union">union
</a>
577 Copyright
© 2007 Yahoo! Inc. All rights reserved.