Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.util.Region.html
blob79d1ecf46e6ec61f3211acfd6412893eaa92f250
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: dom YAHOO.util.Region (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>dom&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_dom.html">dom</a>
17 &gt; YAHOO.util.Region
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>YAHOO.util.Region</b>
33 <span class="extends">
34 </span>
36 <span class="extends">
37 </span>
39 </code>
40 </h2>
41 <!-- class tree goes here -->
43 <dl class="subclasses">
44 <dt>Known Subclasses:</dd>
45 <dd>
46 <a href="YAHOO.util.Point.html">YAHOO.util.Point</a>
47 </dd>
48 </dl>
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.
56 </div>
58 <div class="section constructor details">
59 <h3><a name="constructor_detail">Constructor</a></h3>
60 <div class="content">
61 <div class="detail">
62 <strong>YAHOO.util.Region</strong>
63 <code>
79 </code>
80 <div class="description">
81 <dl>
82 <dt>Parameters:</dt>
83 <dd>
84 <code>t
85 &lt;Int&gt;
86 </code>
87 the top extent
88 </dd>
89 <dd>
90 <code>r
91 &lt;Int&gt;
92 </code>
93 the right extent
94 </dd>
95 <dd>
96 <code>b
97 &lt;Int&gt;
98 </code>
99 the bottom extent
100 </dd>
101 <dd>
102 <code>l
103 &lt;Int&gt;
104 </code>
105 the left extent
106 </dd>
107 </dl>
110 </div>
111 </div>
112 </div>
113 </div>
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>
119 <code>- Int</code>
120 </h4>
121 <div class="detail">
122 <div class="description">
123 The region's left extent as index, for symmetry with set/getXY
124 </div>
125 </div>
130 <hr />
131 <h4><a name="1">1</a>
132 <code>- Int</code>
133 </h4>
134 <div class="detail">
135 <div class="description">
136 The region's top extent as index, for symmetry with set/getXY
137 </div>
138 </div>
143 <hr />
144 <h4><a name="bottom">bottom</a>
145 <code>- Int</code>
146 </h4>
147 <div class="detail">
148 <div class="description">
149 The region's bottom extent
150 </div>
151 </div>
156 <hr />
157 <h4><a name="left">left</a>
158 <code>- Int</code>
159 </h4>
160 <div class="detail">
161 <div class="description">
162 The region's left extent
163 </div>
164 </div>
169 <hr />
170 <h4><a name="right">right</a>
171 <code>- int</code>
172 </h4>
173 <div class="detail">
174 <div class="description">
175 The region's right extent
176 </div>
177 </div>
182 <hr />
183 <h4><a name="top">top</a>
184 <code>- Int</code>
185 </h4>
186 <div class="detail">
187 <div class="description">
188 The region's top extent
189 </div>
190 </div>
195 <hr />
198 </div>
199 </div>
202 <div class="section method details">
203 <h3><a name="methodDetails">Methods</a></h3>
204 <div class="content">
205 <h4>
206 <a name="contains">contains</a></h4>
207 <div class="detail">
208 <code>
212 Boolean
213 <strong>contains</strong>
217 region
221 </code>
223 <div class="description">
224 Returns true if this region contains the region passed in
225 </div>
227 <div class="description">
229 <dl>
230 <dt>Parameters:</dt>
231 <dd>
232 <code>region &lt;Region&gt;</code>
233 The region to evaluate
234 </dd>
235 </dl>
237 <dl>
238 <dt>Returns:
239 <code>
240 Boolean
241 </code></dt>
242 <dd>True if the region is contained with this region,
243 else false</dd>
244 </dl>
246 </div>
248 </div>
249 <hr />
250 <h4>
251 <a name="getArea">getArea</a></h4>
252 <div class="detail">
253 <code>
258 <strong>getArea</strong>
261 </code>
263 <div class="description">
264 Returns the area of the region
265 </div>
267 <div class="description">
270 <dl>
271 <dt>Returns:
272 <code>
274 </code></dt>
275 <dd>the region's area</dd>
276 </dl>
278 </div>
280 </div>
281 <hr />
282 <h4>
283 <a name="getRegion">getRegion</a></h4>
284 <div class="detail">
285 <code>
287 static
289 Region
290 <strong>getRegion</strong>
298 </code>
300 <div class="description">
301 Returns a region that is occupied by the DOM element
302 </div>
304 <div class="description">
306 <dl>
307 <dt>Parameters:</dt>
308 <dd>
309 <code>el &lt;HTMLElement&gt;</code>
310 The element
311 </dd>
312 </dl>
314 <dl>
315 <dt>Returns:
316 <code>
317 Region
318 </code></dt>
319 <dd>The region that the element occupies</dd>
320 </dl>
322 </div>
324 </div>
325 <hr />
326 <h4>
327 <a name="intersect">intersect</a></h4>
328 <div class="detail">
329 <code>
333 Region
334 <strong>intersect</strong>
338 region
342 </code>
344 <div class="description">
345 Returns the region where the passed in region overlaps with this one
346 </div>
348 <div class="description">
350 <dl>
351 <dt>Parameters:</dt>
352 <dd>
353 <code>region &lt;Region&gt;</code>
354 The region that intersects
355 </dd>
356 </dl>
358 <dl>
359 <dt>Returns:
360 <code>
361 Region
362 </code></dt>
363 <dd>The overlap region, or null if there is no overlap</dd>
364 </dl>
366 </div>
368 </div>
369 <hr />
370 <h4>
371 <a name="toString">toString</a></h4>
372 <div class="detail">
373 <code>
377 void
378 <strong>toString</strong>
381 </code>
383 <div class="description">
384 toString
385 </div>
387 <div class="description">
390 <dl>
391 <dt>Returns:
392 <code>
393 void
394 </code></dt>
395 <dd>string the region properties</dd>
396 </dl>
398 </div>
400 </div>
401 <hr />
402 <h4>
403 <a name="union">union</a></h4>
404 <div class="detail">
405 <code>
409 Region
410 <strong>union</strong>
414 region
418 </code>
420 <div class="description">
421 Returns the region representing the smallest region that can contain both
422 the passed in region and this region.
423 </div>
425 <div class="description">
427 <dl>
428 <dt>Parameters:</dt>
429 <dd>
430 <code>region &lt;Region&gt;</code>
431 The region that to create the union with
432 </dd>
433 </dl>
435 <dl>
436 <dt>Returns:
437 <code>
438 Region
439 </code></dt>
440 <dd>The union region</dd>
441 </dl>
443 </div>
445 </div>
446 <hr />
447 </div>
448 </div>
456 </div>
457 </div>
458 <div class="yui-b">
459 <div class="nav">
461 <div class="module">
462 <h4>Modules</h4>
463 <ul class="content">
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>
502 </ul>
503 </div>
505 <div class="module">
506 <h4>Classes</h4>
507 <ul class="content">
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>
511 </ul>
512 </div>
514 <div class="module">
515 <h4>Files</h4>
516 <ul class="content">
517 <li class=""><a href="Dom.js.html">Dom.js</a></li>
518 <li class=""><a href="Region.js.html">Region.js</a></li>
519 </ul>
520 </div>
522 <div class="module">
523 <h4>Properties</h4>
524 <ul class="content">
525 <li><a href="#0">0</a>
526 <!--<code>&lt;Int&gt;</code>-->
527 </li>
528 <li><a href="#1">1</a>
529 <!--<code>&lt;Int&gt;</code>-->
530 </li>
531 <li><a href="#bottom">bottom</a>
532 <!--<code>&lt;Int&gt;</code>-->
533 </li>
534 <li><a href="#left">left</a>
535 <!--<code>&lt;Int&gt;</code>-->
536 </li>
537 <li><a href="#right">right</a>
538 <!--<code>&lt;Int&gt;</code>-->
539 </li>
540 <li><a href="#top">top</a>
541 <!--<code>&lt;Int&gt;</code>-->
542 </li>
543 </ul>
544 </div>
546 <div class="module">
547 <h4>Methods</h4>
548 <ul class="content">
549 <li><!--<code>Boolean</code>-->
550 <a href="#contains">contains</a>
551 </li>
552 <li><!--<code>Int</code>-->
553 <a href="#getArea">getArea</a>
554 </li>
555 <li><!--<code>Region</code>-->
556 <a href="#getRegion">getRegion</a>
557 </li>
558 <li><!--<code>Region</code>-->
559 <a href="#intersect">intersect</a>
560 </li>
561 <li><!--<code>void</code>-->
562 <a href="#toString">toString</a>
563 </li>
564 <li><!--<code>Region</code>-->
565 <a href="#union">union</a>
566 </li>
567 </ul>
568 </div>
572 </div>
573 </div>
574 </div>
575 <div id="ft">
576 <hr />
577 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
578 </div>
579 </div>
580 </body>
581 </html>