|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: widget-position-ext WidgetPositionExt (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>widget-position-ext <span class="subtitle">3.0.0</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a> |
|
22 > WidgetPositionExt |
|
23 |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <h2> |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 Class <b property="yui:name">WidgetPositionExt</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 </h2> |
|
56 <!-- class tree goes here --> |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 <div class="summary description" property="yui:description"> |
|
62 Widget extension, which can be used to add extended XY positioning support to the base Widget class, |
|
63 through the <a href="Base.html#method_build">Base.build</a> method. This extension requires that |
|
64 the WidgetPosition extension be added to the Widget (before WidgetPositionExt, if part of the same |
|
65 extension list passed to Base.build). |
|
66 </div> |
|
67 |
|
68 |
|
69 <div rel="yui:properties" resource="#properties"> |
|
70 <div class="section field details"> |
|
71 <h3 id="properties">Properties</h3> |
|
72 <div class="content"> |
|
73 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.ATTRS"> |
|
74 <h4><a name="property_WidgetPositionExt.ATTRS" property="yui:name">WidgetPositionExt.ATTRS</a> |
|
75 - <code>static <span property="yui:type">Object</span></code> |
|
76 </h4> |
|
77 <div class="detail"> |
|
78 <div class="description" property="yui:description"> |
|
79 Static property used to define the default attribute |
|
80 configuration introduced by WidgetPositionExt. |
|
81 </div> |
|
82 </div> |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 <hr /> |
|
88 </div> |
|
89 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.BC"> |
|
90 <h4><a name="property_WidgetPositionExt.BC" property="yui:name">WidgetPositionExt.BC</a> |
|
91 - <code>static <span property="yui:type">String</span></code> |
|
92 </h4> |
|
93 <div class="detail"> |
|
94 <div class="description" property="yui:description"> |
|
95 Constant used to specify the bottom edge, center point for alignment |
|
96 </div> |
|
97 </div> |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 <hr /> |
|
103 </div> |
|
104 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.BL"> |
|
105 <h4><a name="property_WidgetPositionExt.BL" property="yui:name">WidgetPositionExt.BL</a> |
|
106 - <code>static <span property="yui:type">String</span></code> |
|
107 </h4> |
|
108 <div class="detail"> |
|
109 <div class="description" property="yui:description"> |
|
110 Constant used to specify the bottom-left corner for alignment |
|
111 </div> |
|
112 </div> |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 <hr /> |
|
118 </div> |
|
119 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.BR"> |
|
120 <h4><a name="property_WidgetPositionExt.BR" property="yui:name">WidgetPositionExt.BR</a> |
|
121 - <code>static <span property="yui:type">String</span></code> |
|
122 </h4> |
|
123 <div class="detail"> |
|
124 <div class="description" property="yui:description"> |
|
125 Constant used to specify the bottom-right corner for alignment |
|
126 </div> |
|
127 </div> |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 <hr /> |
|
133 </div> |
|
134 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.CC"> |
|
135 <h4><a name="property_WidgetPositionExt.CC" property="yui:name">WidgetPositionExt.CC</a> |
|
136 - <code>static <span property="yui:type">String</span></code> |
|
137 </h4> |
|
138 <div class="detail"> |
|
139 <div class="description" property="yui:description"> |
|
140 Constant used to specify the center of widget/node/viewport for alignment |
|
141 </div> |
|
142 </div> |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 <hr /> |
|
148 </div> |
|
149 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.LC"> |
|
150 <h4><a name="property_WidgetPositionExt.LC" property="yui:name">WidgetPositionExt.LC</a> |
|
151 - <code>static <span property="yui:type">String</span></code> |
|
152 </h4> |
|
153 <div class="detail"> |
|
154 <div class="description" property="yui:description"> |
|
155 Constant used to specify the left edge, center point for alignment |
|
156 </div> |
|
157 </div> |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 <hr /> |
|
163 </div> |
|
164 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.RC"> |
|
165 <h4><a name="property_WidgetPositionExt.RC" property="yui:name">WidgetPositionExt.RC</a> |
|
166 - <code>static <span property="yui:type">String</span></code> |
|
167 </h4> |
|
168 <div class="detail"> |
|
169 <div class="description" property="yui:description"> |
|
170 Constant used to specify the right edge, center point for alignment |
|
171 </div> |
|
172 </div> |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 <hr /> |
|
178 </div> |
|
179 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.TC"> |
|
180 <h4><a name="property_WidgetPositionExt.TC" property="yui:name">WidgetPositionExt.TC</a> |
|
181 - <code>static <span property="yui:type">String</span></code> |
|
182 </h4> |
|
183 <div class="detail"> |
|
184 <div class="description" property="yui:description"> |
|
185 Constant used to specify the top edge-center point for alignment |
|
186 </div> |
|
187 </div> |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 <hr /> |
|
193 </div> |
|
194 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.TL"> |
|
195 <h4><a name="property_WidgetPositionExt.TL" property="yui:name">WidgetPositionExt.TL</a> |
|
196 - <code>static <span property="yui:type">String</span></code> |
|
197 </h4> |
|
198 <div class="detail"> |
|
199 <div class="description" property="yui:description"> |
|
200 Constant used to specify the top-left corner for alignment |
|
201 </div> |
|
202 </div> |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 <hr /> |
|
208 </div> |
|
209 <div class="" rel="yui:property" resource="#property_WidgetPositionExt.TR"> |
|
210 <h4><a name="property_WidgetPositionExt.TR" property="yui:name">WidgetPositionExt.TR</a> |
|
211 - <code>static <span property="yui:type">String</span></code> |
|
212 </h4> |
|
213 <div class="detail"> |
|
214 <div class="description" property="yui:description"> |
|
215 Constant used to specify the top-right corner for alignment |
|
216 </div> |
|
217 </div> |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 <hr /> |
|
223 </div> |
|
224 </div> |
|
225 </div> |
|
226 |
|
227 </div> |
|
228 |
|
229 <div rel="yui:methods" resource="#methods"> |
|
230 <div class="section method details"> |
|
231 <h3 id="methods">Methods</h3> |
|
232 <div class="content"> |
|
233 <div class="protected" rel="yui:method" resource="#method__afterAlignChange"> |
|
234 <h4> |
|
235 <a name="method__afterAlignChange">_afterAlignChange</a></h4> |
|
236 <div class="detail" > |
|
237 <code> |
|
238 protected |
|
239 |
|
240 |
|
241 void |
|
242 <strong property="yui:name">_afterAlignChange</strong> |
|
243 ( |
|
244 |
|
245 |
|
246 e |
|
247 |
|
248 |
|
249 ) |
|
250 </code> |
|
251 |
|
252 <div class="description" property="yui:description"> |
|
253 Default attribute change listener for the align attribute, responsible |
|
254 for updating the UI, in response to attribute changes. |
|
255 </div> |
|
256 |
|
257 <div class="description"> |
|
258 |
|
259 <dl rel="yui:parameters"> |
|
260 <dt>Parameters:</dt> |
|
261 <dd rel="yui:parameter"> |
|
262 <code><span property="yui:name">e</span> |
|
263 <<span property="yui:type">EventFacade</span>> |
|
264 </code> |
|
265 <span property="yui:description"> The event facade for the attribute change</span> |
|
266 </dd> |
|
267 </dl> |
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 </div> |
|
274 |
|
275 </div> |
|
276 <hr /> |
|
277 </div> |
|
278 <div class="protected" rel="yui:method" resource="#method__bindUIStack"> |
|
279 <h4> |
|
280 <a name="method__bindUIStack">_bindUIStack</a></h4> |
|
281 <div class="detail" > |
|
282 <code> |
|
283 protected |
|
284 |
|
285 |
|
286 void |
|
287 <strong property="yui:name">_bindUIStack</strong> |
|
288 ( |
|
289 ) |
|
290 </code> |
|
291 |
|
292 <div class="description" property="yui:description"> |
|
293 Binds event listeners responsible for updating the UI state in response to |
|
294 Widget extended positioning related state changes. |
|
295 <p> |
|
296 This method is invoked after bindUI is invoked for the Widget class |
|
297 using YUI's aop infrastructure. |
|
298 </p> |
|
299 </div> |
|
300 |
|
301 <div class="description"> |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 </div> |
|
309 |
|
310 </div> |
|
311 <hr /> |
|
312 </div> |
|
313 <div class="private" rel="yui:method" resource="#method__doAlign"> |
|
314 <h4> |
|
315 <a name="method__doAlign">_doAlign</a></h4> |
|
316 <div class="detail" > |
|
317 <code> |
|
318 private |
|
319 |
|
320 |
|
321 void |
|
322 <strong property="yui:name">_doAlign</strong> |
|
323 ( |
|
324 |
|
325 |
|
326 widgetPoint |
|
327 |
|
328 |
|
329 , |
|
330 x |
|
331 |
|
332 |
|
333 , |
|
334 y |
|
335 |
|
336 |
|
337 ) |
|
338 </code> |
|
339 |
|
340 <div class="description" property="yui:description"> |
|
341 Helper method, used to align the given point on the widget, with the XY page co-ordinates provided. |
|
342 </div> |
|
343 |
|
344 <div class="description"> |
|
345 |
|
346 <dl rel="yui:parameters"> |
|
347 <dt>Parameters:</dt> |
|
348 <dd rel="yui:parameter"> |
|
349 <code><span property="yui:name">widgetPoint</span> |
|
350 <<span property="yui:type">String</span>> |
|
351 </code> |
|
352 <span property="yui:description"> Supported point constant (e.g. WidgetPositionExt.TL)</span> |
|
353 </dd> |
|
354 <dd rel="yui:parameter"> |
|
355 <code><span property="yui:name">x</span> |
|
356 <<span property="yui:type">Number</span>> |
|
357 </code> |
|
358 <span property="yui:description"> X page co-ordinate to align to</span> |
|
359 </dd> |
|
360 <dd rel="yui:parameter"> |
|
361 <code><span property="yui:name">y</span> |
|
362 <<span property="yui:type">Number</span>> |
|
363 </code> |
|
364 <span property="yui:description"> Y page co-ordinate to align to</span> |
|
365 </dd> |
|
366 </dl> |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 </div> |
|
373 |
|
374 </div> |
|
375 <hr /> |
|
376 </div> |
|
377 <div class="protected" rel="yui:method" resource="#method__setAlignCenter"> |
|
378 <h4> |
|
379 <a name="method__setAlignCenter">_setAlignCenter</a></h4> |
|
380 <div class="detail" > |
|
381 <code> |
|
382 protected |
|
383 |
|
384 |
|
385 Number |
|
386 <strong property="yui:name">_setAlignCenter</strong> |
|
387 ( |
|
388 |
|
389 |
|
390 The |
|
391 |
|
392 |
|
393 ) |
|
394 </code> |
|
395 |
|
396 <div class="description" property="yui:description"> |
|
397 Default setter for center attribute changes. Sets up the appropriate value, and passes |
|
398 it through the to the align attribute. |
|
399 </div> |
|
400 |
|
401 <div class="description"> |
|
402 |
|
403 <dl rel="yui:parameters"> |
|
404 <dt>Parameters:</dt> |
|
405 <dd rel="yui:parameter"> |
|
406 <code><span property="yui:name">The</span> |
|
407 <<span property="yui:type">boolean | node</span>> |
|
408 </code> |
|
409 <span property="yui:description"> attribute value being set.</span> |
|
410 </dd> |
|
411 </dl> |
|
412 |
|
413 <dl> |
|
414 <dt>Returns: |
|
415 <code property="yui:return"> |
|
416 Number |
|
417 </code></dt> |
|
418 <dd property="yui:returnInfo">The attribute value being set.</dd> |
|
419 </dl> |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 </div> |
|
425 |
|
426 </div> |
|
427 <hr /> |
|
428 </div> |
|
429 <div class="protected" rel="yui:method" resource="#method__syncUIPosExtras"> |
|
430 <h4> |
|
431 <a name="method__syncUIPosExtras">_syncUIPosExtras</a></h4> |
|
432 <div class="detail" > |
|
433 <code> |
|
434 protected |
|
435 |
|
436 |
|
437 void |
|
438 <strong property="yui:name">_syncUIPosExtras</strong> |
|
439 ( |
|
440 ) |
|
441 </code> |
|
442 |
|
443 <div class="description" property="yui:description"> |
|
444 Synchronizes the UI to match the Widgets extended positioning state. |
|
445 This method in invoked after syncUI is invoked for the Widget class |
|
446 using YUI's aop infrastructure. |
|
447 </div> |
|
448 |
|
449 <div class="description"> |
|
450 |
|
451 |
|
452 |
|
453 |
|
454 |
|
455 |
|
456 </div> |
|
457 |
|
458 </div> |
|
459 <hr /> |
|
460 </div> |
|
461 <div class="protected" rel="yui:method" resource="#method__uiSetAlign"> |
|
462 <h4> |
|
463 <a name="method__uiSetAlign">_uiSetAlign</a></h4> |
|
464 <div class="detail" > |
|
465 <code> |
|
466 protected |
|
467 |
|
468 |
|
469 void |
|
470 <strong property="yui:name">_uiSetAlign</strong> |
|
471 ( |
|
472 |
|
473 |
|
474 The |
|
475 |
|
476 |
|
477 ) |
|
478 </code> |
|
479 |
|
480 <div class="description" property="yui:description"> |
|
481 Updates the UI to reflect the align value passed in (see the align attribute documentation, for the object stucture expected) |
|
482 </div> |
|
483 |
|
484 <div class="description"> |
|
485 |
|
486 <dl rel="yui:parameters"> |
|
487 <dt>Parameters:</dt> |
|
488 <dd rel="yui:parameter"> |
|
489 <code><span property="yui:name">The</span> |
|
490 <<span property="yui:type">Node | null</span>> |
|
491 </code> |
|
492 <span property="yui:description"> node to align to, or null to indicate the viewport</span> |
|
493 </dd> |
|
494 </dl> |
|
495 |
|
496 |
|
497 |
|
498 |
|
499 |
|
500 </div> |
|
501 |
|
502 </div> |
|
503 <hr /> |
|
504 </div> |
|
505 <div class="" rel="yui:method" resource="#method_align"> |
|
506 <h4> |
|
507 <a name="method_align">align</a></h4> |
|
508 <div class="detail" > |
|
509 <code> |
|
510 |
|
511 |
|
512 |
|
513 void |
|
514 <strong property="yui:name">align</strong> |
|
515 ( |
|
516 |
|
517 |
|
518 node |
|
519 |
|
520 |
|
521 , |
|
522 points |
|
523 |
|
524 |
|
525 ) |
|
526 </code> |
|
527 |
|
528 <div class="description" property="yui:description"> |
|
529 Aligns the Widget to the provided node (or viewport) using the provided |
|
530 points. The method can be invoked directly, however it will result in |
|
531 the align attribute being out of sync with current position of the of Widget. |
|
532 </div> |
|
533 |
|
534 <div class="description"> |
|
535 |
|
536 <dl rel="yui:parameters"> |
|
537 <dt>Parameters:</dt> |
|
538 <dd rel="yui:parameter"> |
|
539 <code><span property="yui:name">node</span> |
|
540 <<span property="yui:type">Node | String | null</span>> |
|
541 </code> |
|
542 <span property="yui:description"> A reference (or selector string) for the Node which with the Widget is to be aligned. |
|
543 If null is passed in, the Widget will be aligned with the viewport.</span> |
|
544 </dd> |
|
545 <dd rel="yui:parameter"> |
|
546 <code><span property="yui:name">points</span> |
|
547 <<span property="yui:type">Array[2]</span>> |
|
548 </code> |
|
549 <span property="yui:description"> A two element array, specifying the points on the Widget and node/viewport which need to be aligned. |
|
550 The first entry is the point on the Widget, and the second entry is the point on the node/viewport which need to align. |
|
551 Valid point references are defined as static constants on the WidgetPositionExt class. |
|
552 e.g. [WidgetPositionExt.TL, WidgetPositionExt.TR] will align the top-left corner of the Widget with the top-right corner of the node/viewport.</span> |
|
553 </dd> |
|
554 </dl> |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 </div> |
|
561 |
|
562 </div> |
|
563 <hr /> |
|
564 </div> |
|
565 <div class="" rel="yui:method" resource="#method_centered"> |
|
566 <h4> |
|
567 <a name="method_centered">centered</a></h4> |
|
568 <div class="detail" > |
|
569 <code> |
|
570 |
|
571 |
|
572 |
|
573 void |
|
574 <strong property="yui:name">centered</strong> |
|
575 ( |
|
576 |
|
577 |
|
578 node |
|
579 |
|
580 |
|
581 ) |
|
582 </code> |
|
583 |
|
584 <div class="description" property="yui:description"> |
|
585 Centers the container in the viewport, or if a node is passed in, |
|
586 the node. |
|
587 </div> |
|
588 |
|
589 <div class="description"> |
|
590 |
|
591 <dl rel="yui:parameters"> |
|
592 <dt>Parameters:</dt> |
|
593 <dd rel="yui:parameter"> |
|
594 <code><span property="yui:name">node</span> |
|
595 <<span property="yui:type">Node | String</span>> |
|
596 </code> |
|
597 <span property="yui:description"> Optional. A node reference or selector string defining the node |
|
598 inside which the Widget is to be centered. If not passed in, the Widget will be centered in the |
|
599 viewport.</span> |
|
600 </dd> |
|
601 </dl> |
|
602 |
|
603 |
|
604 |
|
605 |
|
606 |
|
607 </div> |
|
608 |
|
609 </div> |
|
610 <hr /> |
|
611 </div> |
|
612 </div> |
|
613 </div> |
|
614 |
|
615 </div> |
|
616 |
|
617 <div rel="yui:events" resource="#events"> |
|
618 <div class="section method details"> |
|
619 <h3 id="events">Events</h3> |
|
620 <div class="content"> |
|
621 <div class="" rel="yui:event" resource="#event_alignChange"> |
|
622 <h4> |
|
623 <a name="event_alignChange">alignChange</a></h4> |
|
624 <div class="detail"> |
|
625 <code> |
|
626 |
|
627 |
|
628 |
|
629 <strong property="yui:name">alignChange</strong> |
|
630 |
|
631 ( |
|
632 |
|
633 |
|
634 event |
|
635 |
|
636 |
|
637 ) |
|
638 |
|
639 </code> |
|
640 |
|
641 <div class="description" property="yui:description"> |
|
642 Fires when the value for the configuration attribute 'align' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
643 </div> |
|
644 |
|
645 <div class="description"> |
|
646 |
|
647 |
|
648 <dl rel="yui:parameters"> |
|
649 <dt>Parameters:</dt> |
|
650 <dd rel="yui:parameter"> |
|
651 <code><span property="yui:name">event</span> |
|
652 <<span property="yui:type">Event.Facade</span>> |
|
653 </code> |
|
654 <span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
655 </dd> |
|
656 |
|
657 </dl> |
|
658 |
|
659 |
|
660 </div> |
|
661 |
|
662 </div> |
|
663 <hr /> |
|
664 </div> |
|
665 <div class="" rel="yui:event" resource="#event_centeredChange"> |
|
666 <h4> |
|
667 <a name="event_centeredChange">centeredChange</a></h4> |
|
668 <div class="detail"> |
|
669 <code> |
|
670 |
|
671 |
|
672 |
|
673 <strong property="yui:name">centeredChange</strong> |
|
674 |
|
675 ( |
|
676 |
|
677 |
|
678 event |
|
679 |
|
680 |
|
681 ) |
|
682 |
|
683 </code> |
|
684 |
|
685 <div class="description" property="yui:description"> |
|
686 Fires when the value for the configuration attribute 'centered' is changed. You can listen for the event using the <a href="Attribute.html#method_on">on</a> method if you wish to be notified before the attribute's value has changed, or using the <a href="Event.Target.html#method_after">after</a> method if you wish to be notified after the attribute's value has changed. |
|
687 </div> |
|
688 |
|
689 <div class="description"> |
|
690 |
|
691 |
|
692 <dl rel="yui:parameters"> |
|
693 <dt>Parameters:</dt> |
|
694 <dd rel="yui:parameter"> |
|
695 <code><span property="yui:name">event</span> |
|
696 <<span property="yui:type">Event.Facade</span>> |
|
697 </code> |
|
698 <span property="yui:description">An Event Facade object with the following attribute specific properties added: <dl> <dt>prevVal</dt> <dd>The value of the attribute, prior to it being set</dd> <dt>newVal</dt> <dd>The value the attribute is to be set to</dd> <dt>attrName</dt> <dd>The name of the attribute being set</dd> <dt>subAttrName</dt> <dd>If setting a property within the attribute's value, the name of the sub-attribute property being set</dd> </dl></span> |
|
699 </dd> |
|
700 |
|
701 </dl> |
|
702 |
|
703 |
|
704 </div> |
|
705 |
|
706 </div> |
|
707 <hr /> |
|
708 </div> |
|
709 </div> |
|
710 </div> |
|
711 |
|
712 |
|
713 </div> |
|
714 |
|
715 <div rel="yui:attributes" resource="#configattributes"> |
|
716 <div class="section field details"> |
|
717 <h3 id="configattributes">Configuration Attributes</h3> |
|
718 <div class="content"> |
|
719 <div class="" rel="yui:attribute" resource="#config_align"> |
|
720 <h4><a name="config_align">align</a> |
|
721 <code>- <span property="yui:type">Object</span></code> |
|
722 </h4> |
|
723 <div class="detail"> |
|
724 <div class="description" property="yui:description"> |
|
725 |
|
726 </div> |
|
727 </div> |
|
728 |
|
729 |
|
730 <div class="default"> |
|
731 Default Value: null |
|
732 </div> |
|
733 |
|
734 <hr /> |
|
735 </div> |
|
736 <div class="" rel="yui:attribute" resource="#config_centered"> |
|
737 <h4><a name="config_centered">centered</a> |
|
738 <code>- <span property="yui:type">{boolean | node}</span></code> |
|
739 </h4> |
|
740 <div class="detail"> |
|
741 <div class="description" property="yui:description"> |
|
742 A convenience attribute, which can be used as a shortcut for the align attribute. |
|
743 If set to true, the Widget is centered in the viewport. If set to a node reference or valid selector string, |
|
744 the Widget will be centered within the node. If set the false, no center positioning is applied. |
|
745 </div> |
|
746 </div> |
|
747 |
|
748 |
|
749 <div class="default"> |
|
750 Default Value: false |
|
751 </div> |
|
752 |
|
753 <hr /> |
|
754 </div> |
|
755 |
|
756 </div> |
|
757 </div> |
|
758 |
|
759 </div> |
|
760 |
|
761 </div> |
|
762 </div> |
|
763 <div class="yui-b"> |
|
764 <div class="nav"> |
|
765 |
|
766 <div id="moduleList" class="module"> |
|
767 <h4>Modules</h4> |
|
768 <ul class="content"> |
|
769 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
770 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
771 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
772 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
773 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
774 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
775 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
776 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
777 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
778 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
779 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
780 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
781 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
782 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
783 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
784 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
785 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
786 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
787 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
788 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
789 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
790 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
791 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
792 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
793 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
794 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
795 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
796 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
797 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
798 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
799 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
800 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
801 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
802 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
803 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
804 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
805 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
806 <li class="selected"><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
807 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
808 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
809 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
810 </ul> |
|
811 </div> |
|
812 |
|
813 <div id="classList" class="module"> |
|
814 <h4>Classes</h4> |
|
815 <ul class="content"> |
|
816 <li class="selected"><a href="WidgetPositionExt.html" title="WidgetPositionExt">WidgetPositionExt</a></li> |
|
817 </ul> |
|
818 </div> |
|
819 |
|
820 <div id="fileList" class="module"> |
|
821 <h4>Files</h4> |
|
822 <ul class="content"> |
|
823 <li class=""><a href="Widget-PositionExt.js.html" title="Widget-PositionExt.js">Widget-PositionExt.js</a></li> |
|
824 </ul> |
|
825 </div> |
|
826 |
|
827 <div id="propertyList" class="module"> |
|
828 <h4>Properties</h4> |
|
829 <ul class="content"> |
|
830 <li class=""><a href="#property_WidgetPositionExt.ATTRS" title="WidgetPositionExt.ATTRS">WidgetPositionExt.ATTRS</a></li> |
|
831 <li class=""><a href="#property_WidgetPositionExt.BC" title="WidgetPositionExt.BC">WidgetPositionExt.BC</a></li> |
|
832 <li class=""><a href="#property_WidgetPositionExt.BL" title="WidgetPositionExt.BL">WidgetPositionExt.BL</a></li> |
|
833 <li class=""><a href="#property_WidgetPositionExt.BR" title="WidgetPositionExt.BR">WidgetPositionExt.BR</a></li> |
|
834 <li class=""><a href="#property_WidgetPositionExt.CC" title="WidgetPositionExt.CC">WidgetPositionExt.CC</a></li> |
|
835 <li class=""><a href="#property_WidgetPositionExt.LC" title="WidgetPositionExt.LC">WidgetPositionExt.LC</a></li> |
|
836 <li class=""><a href="#property_WidgetPositionExt.RC" title="WidgetPositionExt.RC">WidgetPositionExt.RC</a></li> |
|
837 <li class=""><a href="#property_WidgetPositionExt.TC" title="WidgetPositionExt.TC">WidgetPositionExt.TC</a></li> |
|
838 <li class=""><a href="#property_WidgetPositionExt.TL" title="WidgetPositionExt.TL">WidgetPositionExt.TL</a></li> |
|
839 <li class=""><a href="#property_WidgetPositionExt.TR" title="WidgetPositionExt.TR">WidgetPositionExt.TR</a></li> |
|
840 </ul> |
|
841 </div> |
|
842 |
|
843 <div id="methodsList" class="module"> |
|
844 <h4>Methods</h4> |
|
845 <ul class="content"> |
|
846 <li class="protected"><a href="#method__afterAlignChange" title="_afterAlignChange">_afterAlignChange</a></li> |
|
847 <li class="protected"><a href="#method__bindUIStack" title="_bindUIStack">_bindUIStack</a></li> |
|
848 <li class="private"><a href="#method__doAlign" title="_doAlign">_doAlign</a></li> |
|
849 <li class="protected"><a href="#method__setAlignCenter" title="_setAlignCenter">_setAlignCenter</a></li> |
|
850 <li class="protected"><a href="#method__syncUIPosExtras" title="_syncUIPosExtras">_syncUIPosExtras</a></li> |
|
851 <li class="protected"><a href="#method__uiSetAlign" title="_uiSetAlign">_uiSetAlign</a></li> |
|
852 <li class=""><a href="#method_align" title="align">align</a></li> |
|
853 <li class=""><a href="#method_centered" title="centered">centered</a></li> |
|
854 </ul> |
|
855 </div> |
|
856 |
|
857 <div id="eventsList" class="module"> |
|
858 <h4>Events</h4> |
|
859 <ul class="content"> |
|
860 <li class=""><a href="#event_alignChange" title="alignChange">alignChange</a></li> |
|
861 <li class=""><a href="#event_centeredChange" title="centeredChange">centeredChange</a></li> |
|
862 </ul> |
|
863 </div> |
|
864 |
|
865 <div id="configList" class="module"> |
|
866 <h4>Configuration Attributes</h4> |
|
867 <ul class="content"> |
|
868 <li class=""><a href="#config_align" title="align">align</a></li> |
|
869 <li class=""><a href="#config_centered" title="centered">centered</a></li> |
|
870 </ul> |
|
871 </div> |
|
872 |
|
873 </div> |
|
874 </div> |
|
875 </div> |
|
876 <div id="ft"> |
|
877 <hr /> |
|
878 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
879 </div> |
|
880 </div> |
|
881 <script type="text/javascript"> |
|
882 ALL_YUI_PROPS = [{"access": "protected", "host": "WidgetPositionExt", "name": "_afterAlignChange", "url": "WidgetPositionExt.html#method__afterAlignChange", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "align", "url": "WidgetPositionExt.html#method_align", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "align", "url": "WidgetPositionExt.html#config_align", "type": "config"}, {"access": "", "host": "WidgetPositionExt", "name": "alignChange", "url": "WidgetPositionExt.html#event_alignChange", "type": "event"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_bindUIStack", "url": "WidgetPositionExt.html#method__bindUIStack", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "centered", "url": "WidgetPositionExt.html#method_centered", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "centered", "url": "WidgetPositionExt.html#config_centered", "type": "config"}, {"access": "", "host": "WidgetPositionExt", "name": "centeredChange", "url": "WidgetPositionExt.html#event_centeredChange", "type": "event"}, {"access": "private", "host": "WidgetPositionExt", "name": "_doAlign", "url": "WidgetPositionExt.html#method__doAlign", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_setAlignCenter", "url": "WidgetPositionExt.html#method__setAlignCenter", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_syncUIPosExtras", "url": "WidgetPositionExt.html#method__syncUIPosExtras", "type": "method"}, {"access": "protected", "host": "WidgetPositionExt", "name": "_uiSetAlign", "url": "WidgetPositionExt.html#method__uiSetAlign", "type": "method"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.ATTRS", "url": "WidgetPositionExt.html#property_WidgetPositionExt.ATTRS", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BL", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BL", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.BR", "url": "WidgetPositionExt.html#property_WidgetPositionExt.BR", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.CC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.CC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.LC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.LC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.RC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.RC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TC", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TC", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TL", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TL", "type": "property"}, {"access": "", "host": "WidgetPositionExt", "name": "WidgetPositionExt.TR", "url": "WidgetPositionExt.html#property_WidgetPositionExt.TR", "type": "property"}]; |
|
883 </script> |
|
884 </body> |
|
885 </html> |