|
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 WidgetPosition (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 <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.html" title="widget-position">widget-position</a> |
|
22 > WidgetPosition |
|
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">WidgetPosition</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 positioning support to the base Widget class, |
|
63 through the <a href="Base.html#method_build">Base.build</a> method. |
|
64 </div> |
|
65 |
|
66 |
|
67 <div rel="yui:properties" resource="#properties"> |
|
68 <div class="section field details"> |
|
69 <h3 id="properties">Properties</h3> |
|
70 <div class="content"> |
|
71 <div class="" rel="yui:property" resource="#property_WidgetPosition.ATTRS"> |
|
72 <h4><a name="property_WidgetPosition.ATTRS" property="yui:name">WidgetPosition.ATTRS</a> |
|
73 - <code>static <span property="yui:type">Object</span></code> |
|
74 </h4> |
|
75 <div class="detail"> |
|
76 <div class="description" property="yui:description"> |
|
77 Static property used to define the default attribute |
|
78 configuration introduced by WidgetPosition. |
|
79 </div> |
|
80 </div> |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 <hr /> |
|
86 </div> |
|
87 <div class="" rel="yui:property" resource="#property_WidgetPosition.POSITIONED_CLASS_NAME"> |
|
88 <h4><a name="property_WidgetPosition.POSITIONED_CLASS_NAME" property="yui:name">WidgetPosition.POSITIONED_CLASS_NAME</a> |
|
89 - <code>static <span property="yui:type">String</span></code> |
|
90 </h4> |
|
91 <div class="detail"> |
|
92 <div class="description" property="yui:description"> |
|
93 Default class used to mark the boundingBox of a positioned widget. |
|
94 </div> |
|
95 </div> |
|
96 |
|
97 |
|
98 <div class="default" property="yui:defaultValue"> |
|
99 Default Value: "yui-widget-positioned" |
|
100 </div> |
|
101 |
|
102 |
|
103 <hr /> |
|
104 </div> |
|
105 </div> |
|
106 </div> |
|
107 |
|
108 </div> |
|
109 |
|
110 <div rel="yui:methods" resource="#methods"> |
|
111 <div class="section method details"> |
|
112 <h3 id="methods">Methods</h3> |
|
113 <div class="content"> |
|
114 <div class="protected" rel="yui:method" resource="#method__afterXYChange"> |
|
115 <h4> |
|
116 <a name="method__afterXYChange">_afterXYChange</a></h4> |
|
117 <div class="detail" > |
|
118 <code> |
|
119 protected |
|
120 |
|
121 |
|
122 void |
|
123 <strong property="yui:name">_afterXYChange</strong> |
|
124 ( |
|
125 |
|
126 |
|
127 e |
|
128 |
|
129 |
|
130 ) |
|
131 </code> |
|
132 |
|
133 <div class="description" property="yui:description"> |
|
134 Default attribute change listener for the xy attribute, responsible |
|
135 for updating the UI, in response to attribute changes. |
|
136 </div> |
|
137 |
|
138 <div class="description"> |
|
139 |
|
140 <dl rel="yui:parameters"> |
|
141 <dt>Parameters:</dt> |
|
142 <dd rel="yui:parameter"> |
|
143 <code><span property="yui:name">e</span> |
|
144 <<span property="yui:type">EventFacade</span>> |
|
145 </code> |
|
146 <span property="yui:description"> The event facade for the attribute change</span> |
|
147 </dd> |
|
148 </dl> |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
|
154 </div> |
|
155 |
|
156 </div> |
|
157 <hr /> |
|
158 </div> |
|
159 <div class="protected" rel="yui:method" resource="#method__bindUIPosition"> |
|
160 <h4> |
|
161 <a name="method__bindUIPosition">_bindUIPosition</a></h4> |
|
162 <div class="detail" > |
|
163 <code> |
|
164 protected |
|
165 |
|
166 |
|
167 void |
|
168 <strong property="yui:name">_bindUIPosition</strong> |
|
169 ( |
|
170 ) |
|
171 </code> |
|
172 |
|
173 <div class="description" property="yui:description"> |
|
174 Binds event listeners responsible for updating the UI state in response to |
|
175 Widget position related state changes. |
|
176 <p> |
|
177 This method in invoked after bindUI is invoked for the Widget class |
|
178 using YUI's aop infrastructure. |
|
179 </p> |
|
180 </div> |
|
181 |
|
182 <div class="description"> |
|
183 |
|
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 </div> |
|
190 |
|
191 </div> |
|
192 <hr /> |
|
193 </div> |
|
194 <div class="" rel="yui:method" resource="#method__getX"> |
|
195 <h4> |
|
196 <a name="method__getX">_getX</a></h4> |
|
197 <div class="detail" > |
|
198 <code> |
|
199 |
|
200 |
|
201 |
|
202 Number |
|
203 <strong property="yui:name">_getX</strong> |
|
204 ( |
|
205 ) |
|
206 </code> |
|
207 |
|
208 <div class="description" property="yui:description"> |
|
209 Default getter for the X attribute. The value is retrieved from |
|
210 the XY attribute, which is the sole store for the XY state. |
|
211 </div> |
|
212 |
|
213 <div class="description"> |
|
214 |
|
215 |
|
216 <dl> |
|
217 <dt>Returns: |
|
218 <code property="yui:return"> |
|
219 Number |
|
220 </code></dt> |
|
221 <dd property="yui:returnInfo">The X page co-ordinate value</dd> |
|
222 </dl> |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 </div> |
|
228 |
|
229 </div> |
|
230 <hr /> |
|
231 </div> |
|
232 <div class="" rel="yui:method" resource="#method__getY"> |
|
233 <h4> |
|
234 <a name="method__getY">_getY</a></h4> |
|
235 <div class="detail" > |
|
236 <code> |
|
237 |
|
238 |
|
239 |
|
240 Number |
|
241 <strong property="yui:name">_getY</strong> |
|
242 ( |
|
243 ) |
|
244 </code> |
|
245 |
|
246 <div class="description" property="yui:description"> |
|
247 Default getter for the Y attribute. The value is retrieved from |
|
248 the XY attribute, which is the sole store for the XY state. |
|
249 </div> |
|
250 |
|
251 <div class="description"> |
|
252 |
|
253 |
|
254 <dl> |
|
255 <dt>Returns: |
|
256 <code property="yui:return"> |
|
257 Number |
|
258 </code></dt> |
|
259 <dd property="yui:returnInfo">The Y page co-ordinate value</dd> |
|
260 </dl> |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 </div> |
|
266 |
|
267 </div> |
|
268 <hr /> |
|
269 </div> |
|
270 <div class="protected" rel="yui:method" resource="#method__renderUIPosition"> |
|
271 <h4> |
|
272 <a name="method__renderUIPosition">_renderUIPosition</a></h4> |
|
273 <div class="detail" > |
|
274 <code> |
|
275 protected |
|
276 |
|
277 |
|
278 void |
|
279 <strong property="yui:name">_renderUIPosition</strong> |
|
280 ( |
|
281 ) |
|
282 </code> |
|
283 |
|
284 <div class="description" property="yui:description"> |
|
285 Creates/Initializes the DOM to support xy page positioning. |
|
286 <p> |
|
287 This method in invoked after renderUI is invoked for the Widget class |
|
288 using YUI's aop infrastructure. |
|
289 </p> |
|
290 </div> |
|
291 |
|
292 <div class="description"> |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 </div> |
|
300 |
|
301 </div> |
|
302 <hr /> |
|
303 </div> |
|
304 <div class="" rel="yui:method" resource="#method__setX"> |
|
305 <h4> |
|
306 <a name="method__setX">_setX</a></h4> |
|
307 <div class="detail" > |
|
308 <code> |
|
309 |
|
310 |
|
311 |
|
312 void |
|
313 <strong property="yui:name">_setX</strong> |
|
314 ( |
|
315 |
|
316 |
|
317 val |
|
318 |
|
319 |
|
320 ) |
|
321 </code> |
|
322 |
|
323 <div class="description" property="yui:description"> |
|
324 Default setter for the X attribute. The setter passes the X value through |
|
325 to the XY attribute, which is the sole store for the XY state. |
|
326 </div> |
|
327 |
|
328 <div class="description"> |
|
329 |
|
330 <dl rel="yui:parameters"> |
|
331 <dt>Parameters:</dt> |
|
332 <dd rel="yui:parameter"> |
|
333 <code><span property="yui:name">val</span> |
|
334 <<span property="yui:type">Number</span>> |
|
335 </code> |
|
336 <span property="yui:description"> The X page co-ordinate value</span> |
|
337 </dd> |
|
338 </dl> |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 |
|
344 </div> |
|
345 |
|
346 </div> |
|
347 <hr /> |
|
348 </div> |
|
349 <div class="" rel="yui:method" resource="#method__setY"> |
|
350 <h4> |
|
351 <a name="method__setY">_setY</a></h4> |
|
352 <div class="detail" > |
|
353 <code> |
|
354 |
|
355 |
|
356 |
|
357 void |
|
358 <strong property="yui:name">_setY</strong> |
|
359 ( |
|
360 |
|
361 |
|
362 val |
|
363 |
|
364 |
|
365 ) |
|
366 </code> |
|
367 |
|
368 <div class="description" property="yui:description"> |
|
369 Default setter for the Y attribute. The setter passes the Y value through |
|
370 to the XY attribute, which is the sole store for the XY state. |
|
371 </div> |
|
372 |
|
373 <div class="description"> |
|
374 |
|
375 <dl rel="yui:parameters"> |
|
376 <dt>Parameters:</dt> |
|
377 <dd rel="yui:parameter"> |
|
378 <code><span property="yui:name">val</span> |
|
379 <<span property="yui:type">Number</span>> |
|
380 </code> |
|
381 <span property="yui:description"> The Y page co-ordinate value</span> |
|
382 </dd> |
|
383 </dl> |
|
384 |
|
385 |
|
386 |
|
387 |
|
388 |
|
389 </div> |
|
390 |
|
391 </div> |
|
392 <hr /> |
|
393 </div> |
|
394 <div class="protected" rel="yui:method" resource="#method__syncUIPosition"> |
|
395 <h4> |
|
396 <a name="method__syncUIPosition">_syncUIPosition</a></h4> |
|
397 <div class="detail" > |
|
398 <code> |
|
399 protected |
|
400 |
|
401 |
|
402 void |
|
403 <strong property="yui:name">_syncUIPosition</strong> |
|
404 ( |
|
405 ) |
|
406 </code> |
|
407 |
|
408 <div class="description" property="yui:description"> |
|
409 Synchronizes the UI to match the Widgets xy page position state. |
|
410 <p> |
|
411 This method in invoked after syncUI is invoked for the Widget class |
|
412 using YUI's aop infrastructure. |
|
413 </p> |
|
414 </div> |
|
415 |
|
416 <div class="description"> |
|
417 |
|
418 |
|
419 |
|
420 |
|
421 |
|
422 |
|
423 </div> |
|
424 |
|
425 </div> |
|
426 <hr /> |
|
427 </div> |
|
428 <div class="protected" rel="yui:method" resource="#method__uiSetXY"> |
|
429 <h4> |
|
430 <a name="method__uiSetXY">_uiSetXY</a></h4> |
|
431 <div class="detail" > |
|
432 <code> |
|
433 protected |
|
434 |
|
435 |
|
436 void |
|
437 <strong property="yui:name">_uiSetXY</strong> |
|
438 ( |
|
439 |
|
440 |
|
441 val |
|
442 |
|
443 |
|
444 ) |
|
445 </code> |
|
446 |
|
447 <div class="description" property="yui:description"> |
|
448 Updates the UI to reflect the XY page co-ordinates passed in. |
|
449 </div> |
|
450 |
|
451 <div class="description"> |
|
452 |
|
453 <dl rel="yui:parameters"> |
|
454 <dt>Parameters:</dt> |
|
455 <dd rel="yui:parameter"> |
|
456 <code><span property="yui:name">val</span> |
|
457 <<span property="yui:type">String</span>> |
|
458 </code> |
|
459 <span property="yui:description"> The XY page co-ordinates value to be reflected in the UI</span> |
|
460 </dd> |
|
461 </dl> |
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 </div> |
|
468 |
|
469 </div> |
|
470 <hr /> |
|
471 </div> |
|
472 <div class="" rel="yui:method" resource="#method__validateXY"> |
|
473 <h4> |
|
474 <a name="method__validateXY">_validateXY</a></h4> |
|
475 <div class="detail" > |
|
476 <code> |
|
477 |
|
478 |
|
479 |
|
480 boolean |
|
481 <strong property="yui:name">_validateXY</strong> |
|
482 ( |
|
483 |
|
484 |
|
485 val |
|
486 |
|
487 |
|
488 ) |
|
489 </code> |
|
490 |
|
491 <div class="description" property="yui:description"> |
|
492 Default validator for the XY attribute |
|
493 </div> |
|
494 |
|
495 <div class="description"> |
|
496 |
|
497 <dl rel="yui:parameters"> |
|
498 <dt>Parameters:</dt> |
|
499 <dd rel="yui:parameter"> |
|
500 <code><span property="yui:name">val</span> |
|
501 <<span property="yui:type">Array</span>> |
|
502 </code> |
|
503 <span property="yui:description"> The XY page co-ordinate value which is being set.</span> |
|
504 </dd> |
|
505 </dl> |
|
506 |
|
507 <dl> |
|
508 <dt>Returns: |
|
509 <code property="yui:return"> |
|
510 boolean |
|
511 </code></dt> |
|
512 <dd property="yui:returnInfo">true if valid, false if not.</dd> |
|
513 </dl> |
|
514 |
|
515 |
|
516 |
|
517 |
|
518 </div> |
|
519 |
|
520 </div> |
|
521 <hr /> |
|
522 </div> |
|
523 <div class="" rel="yui:method" resource="#method_move"> |
|
524 <h4> |
|
525 <a name="method_move">move</a></h4> |
|
526 <div class="detail" > |
|
527 <code> |
|
528 |
|
529 |
|
530 |
|
531 void |
|
532 <strong property="yui:name">move</strong> |
|
533 ( |
|
534 |
|
535 |
|
536 x |
|
537 |
|
538 |
|
539 , |
|
540 y |
|
541 |
|
542 |
|
543 , |
|
544 x, |
|
545 |
|
546 |
|
547 ) |
|
548 </code> |
|
549 |
|
550 <div class="description" property="yui:description"> |
|
551 Moves the Widget to the specified page xy co-ordinate position. |
|
552 </div> |
|
553 |
|
554 <div class="description"> |
|
555 |
|
556 <dl rel="yui:parameters"> |
|
557 <dt>Parameters:</dt> |
|
558 <dd rel="yui:parameter"> |
|
559 <code><span property="yui:name">x</span> |
|
560 <<span property="yui:type">Number</span>> |
|
561 </code> |
|
562 <span property="yui:description"> The new x position</span> |
|
563 </dd> |
|
564 <dd rel="yui:parameter"> |
|
565 <code><span property="yui:name">y</span> |
|
566 <<span property="yui:type">Number</span>> |
|
567 </code> |
|
568 <span property="yui:description"> The new y position |
|
569 <p>Or</p></span> |
|
570 </dd> |
|
571 <dd rel="yui:parameter"> |
|
572 <code><span property="yui:name">x,</span> |
|
573 <<span property="yui:type">Array</span>> |
|
574 </code> |
|
575 <span property="yui:description"> y values passed as an array ([x, y]), to support |
|
576 simple pass through of Node.getXY results</span> |
|
577 </dd> |
|
578 </dl> |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 </div> |
|
585 |
|
586 </div> |
|
587 <hr /> |
|
588 </div> |
|
589 <div class="" rel="yui:method" resource="#method_syncXY"> |
|
590 <h4> |
|
591 <a name="method_syncXY">syncXY</a></h4> |
|
592 <div class="detail" > |
|
593 <code> |
|
594 |
|
595 |
|
596 |
|
597 void |
|
598 <strong property="yui:name">syncXY</strong> |
|
599 ( |
|
600 ) |
|
601 </code> |
|
602 |
|
603 <div class="description" property="yui:description"> |
|
604 Synchronizes the Panel's "xy", "x", and "y" properties with the |
|
605 Widget's position in the DOM. |
|
606 </div> |
|
607 |
|
608 <div class="description"> |
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 |
|
615 </div> |
|
616 |
|
617 </div> |
|
618 <hr /> |
|
619 </div> |
|
620 </div> |
|
621 </div> |
|
622 |
|
623 </div> |
|
624 |
|
625 <div rel="yui:events" resource="#events"> |
|
626 <div class="section method details"> |
|
627 <h3 id="events">Events</h3> |
|
628 <div class="content"> |
|
629 <div class="" rel="yui:event" resource="#event_xChange"> |
|
630 <h4> |
|
631 <a name="event_xChange">xChange</a></h4> |
|
632 <div class="detail"> |
|
633 <code> |
|
634 |
|
635 |
|
636 |
|
637 <strong property="yui:name">xChange</strong> |
|
638 |
|
639 ( |
|
640 |
|
641 |
|
642 event |
|
643 |
|
644 |
|
645 ) |
|
646 |
|
647 </code> |
|
648 |
|
649 <div class="description" property="yui:description"> |
|
650 Fires when the value for the configuration attribute 'x' 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. |
|
651 </div> |
|
652 |
|
653 <div class="description"> |
|
654 |
|
655 |
|
656 <dl rel="yui:parameters"> |
|
657 <dt>Parameters:</dt> |
|
658 <dd rel="yui:parameter"> |
|
659 <code><span property="yui:name">event</span> |
|
660 <<span property="yui:type">Event.Facade</span>> |
|
661 </code> |
|
662 <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> |
|
663 </dd> |
|
664 |
|
665 </dl> |
|
666 |
|
667 |
|
668 </div> |
|
669 |
|
670 </div> |
|
671 <hr /> |
|
672 </div> |
|
673 <div class="" rel="yui:event" resource="#event_xyChange"> |
|
674 <h4> |
|
675 <a name="event_xyChange">xyChange</a></h4> |
|
676 <div class="detail"> |
|
677 <code> |
|
678 |
|
679 |
|
680 |
|
681 <strong property="yui:name">xyChange</strong> |
|
682 |
|
683 ( |
|
684 |
|
685 |
|
686 event |
|
687 |
|
688 |
|
689 ) |
|
690 |
|
691 </code> |
|
692 |
|
693 <div class="description" property="yui:description"> |
|
694 Fires when the value for the configuration attribute 'xy' 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. |
|
695 </div> |
|
696 |
|
697 <div class="description"> |
|
698 |
|
699 |
|
700 <dl rel="yui:parameters"> |
|
701 <dt>Parameters:</dt> |
|
702 <dd rel="yui:parameter"> |
|
703 <code><span property="yui:name">event</span> |
|
704 <<span property="yui:type">Event.Facade</span>> |
|
705 </code> |
|
706 <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> |
|
707 </dd> |
|
708 |
|
709 </dl> |
|
710 |
|
711 |
|
712 </div> |
|
713 |
|
714 </div> |
|
715 <hr /> |
|
716 </div> |
|
717 <div class="" rel="yui:event" resource="#event_yChange"> |
|
718 <h4> |
|
719 <a name="event_yChange">yChange</a></h4> |
|
720 <div class="detail"> |
|
721 <code> |
|
722 |
|
723 |
|
724 |
|
725 <strong property="yui:name">yChange</strong> |
|
726 |
|
727 ( |
|
728 |
|
729 |
|
730 event |
|
731 |
|
732 |
|
733 ) |
|
734 |
|
735 </code> |
|
736 |
|
737 <div class="description" property="yui:description"> |
|
738 Fires when the value for the configuration attribute 'y' 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. |
|
739 </div> |
|
740 |
|
741 <div class="description"> |
|
742 |
|
743 |
|
744 <dl rel="yui:parameters"> |
|
745 <dt>Parameters:</dt> |
|
746 <dd rel="yui:parameter"> |
|
747 <code><span property="yui:name">event</span> |
|
748 <<span property="yui:type">Event.Facade</span>> |
|
749 </code> |
|
750 <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> |
|
751 </dd> |
|
752 |
|
753 </dl> |
|
754 |
|
755 |
|
756 </div> |
|
757 |
|
758 </div> |
|
759 <hr /> |
|
760 </div> |
|
761 </div> |
|
762 </div> |
|
763 |
|
764 |
|
765 </div> |
|
766 |
|
767 <div rel="yui:attributes" resource="#configattributes"> |
|
768 <div class="section field details"> |
|
769 <h3 id="configattributes">Configuration Attributes</h3> |
|
770 <div class="content"> |
|
771 <div class="" rel="yui:attribute" resource="#config_x"> |
|
772 <h4><a name="config_x">x</a> |
|
773 <code>- <span property="yui:type">number</span></code> |
|
774 </h4> |
|
775 <div class="detail"> |
|
776 <div class="description" property="yui:description"> |
|
777 Page X co-ordinate for the widget. This attribute acts as a facade for the |
|
778 xy attribute. Changes in position can be monitored by listening for xyChange events. |
|
779 </div> |
|
780 </div> |
|
781 |
|
782 |
|
783 <div class="default"> |
|
784 Default Value: 0 |
|
785 </div> |
|
786 |
|
787 <hr /> |
|
788 </div> |
|
789 <div class="" rel="yui:attribute" resource="#config_xy"> |
|
790 <h4><a name="config_xy">xy</a> |
|
791 <code>- <span property="yui:type">Array</span></code> |
|
792 </h4> |
|
793 <div class="detail"> |
|
794 <div class="description" property="yui:description"> |
|
795 Page XY co-ordinate pair for the widget. |
|
796 </div> |
|
797 </div> |
|
798 |
|
799 |
|
800 <div class="default"> |
|
801 Default Value: [0,0] |
|
802 </div> |
|
803 |
|
804 <hr /> |
|
805 </div> |
|
806 <div class="" rel="yui:attribute" resource="#config_y"> |
|
807 <h4><a name="config_y">y</a> |
|
808 <code>- <span property="yui:type">number</span></code> |
|
809 </h4> |
|
810 <div class="detail"> |
|
811 <div class="description" property="yui:description"> |
|
812 Page Y co-ordinate for the widget. This attribute acts as a facade for the |
|
813 xy attribute. Changes in position can be monitored by listening for xyChange events. |
|
814 </div> |
|
815 </div> |
|
816 |
|
817 |
|
818 <div class="default"> |
|
819 Default Value: 0 |
|
820 </div> |
|
821 |
|
822 <hr /> |
|
823 </div> |
|
824 |
|
825 </div> |
|
826 </div> |
|
827 |
|
828 </div> |
|
829 |
|
830 </div> |
|
831 </div> |
|
832 <div class="yui-b"> |
|
833 <div class="nav"> |
|
834 |
|
835 <div id="moduleList" class="module"> |
|
836 <h4>Modules</h4> |
|
837 <ul class="content"> |
|
838 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
839 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
840 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
841 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
842 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
843 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
844 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
845 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
846 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
847 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
848 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
849 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
850 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
851 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
852 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
853 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
854 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
855 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
856 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
857 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
858 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
859 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
860 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
861 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
862 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
863 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
864 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
865 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
866 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
867 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
868 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
869 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
870 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
871 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
872 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
873 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
874 <li class="selected"><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
875 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
876 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
877 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
878 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
879 </ul> |
|
880 </div> |
|
881 |
|
882 <div id="classList" class="module"> |
|
883 <h4>Classes</h4> |
|
884 <ul class="content"> |
|
885 <li class="selected"><a href="WidgetPosition.html" title="WidgetPosition">WidgetPosition</a></li> |
|
886 </ul> |
|
887 </div> |
|
888 |
|
889 <div id="fileList" class="module"> |
|
890 <h4>Files</h4> |
|
891 <ul class="content"> |
|
892 <li class=""><a href="Widget-Position.js.html" title="Widget-Position.js">Widget-Position.js</a></li> |
|
893 </ul> |
|
894 </div> |
|
895 |
|
896 <div id="propertyList" class="module"> |
|
897 <h4>Properties</h4> |
|
898 <ul class="content"> |
|
899 <li class=""><a href="#property_WidgetPosition.ATTRS" title="WidgetPosition.ATTRS">WidgetPosition.ATTRS</a></li> |
|
900 <li class=""><a href="#property_WidgetPosition.POSITIONED_CLASS_NAME" title="WidgetPosition.POSITIONED_CLASS_NAME">WidgetPosition.POSITIONED_CLASS_NAME</a></li> |
|
901 </ul> |
|
902 </div> |
|
903 |
|
904 <div id="methodsList" class="module"> |
|
905 <h4>Methods</h4> |
|
906 <ul class="content"> |
|
907 <li class="protected"><a href="#method__afterXYChange" title="_afterXYChange">_afterXYChange</a></li> |
|
908 <li class="protected"><a href="#method__bindUIPosition" title="_bindUIPosition">_bindUIPosition</a></li> |
|
909 <li class=""><a href="#method__getX" title="_getX">_getX</a></li> |
|
910 <li class=""><a href="#method__getY" title="_getY">_getY</a></li> |
|
911 <li class="protected"><a href="#method__renderUIPosition" title="_renderUIPosition">_renderUIPosition</a></li> |
|
912 <li class=""><a href="#method__setX" title="_setX">_setX</a></li> |
|
913 <li class=""><a href="#method__setY" title="_setY">_setY</a></li> |
|
914 <li class="protected"><a href="#method__syncUIPosition" title="_syncUIPosition">_syncUIPosition</a></li> |
|
915 <li class="protected"><a href="#method__uiSetXY" title="_uiSetXY">_uiSetXY</a></li> |
|
916 <li class=""><a href="#method__validateXY" title="_validateXY">_validateXY</a></li> |
|
917 <li class=""><a href="#method_move" title="move">move</a></li> |
|
918 <li class=""><a href="#method_syncXY" title="syncXY">syncXY</a></li> |
|
919 </ul> |
|
920 </div> |
|
921 |
|
922 <div id="eventsList" class="module"> |
|
923 <h4>Events</h4> |
|
924 <ul class="content"> |
|
925 <li class=""><a href="#event_xChange" title="xChange">xChange</a></li> |
|
926 <li class=""><a href="#event_xyChange" title="xyChange">xyChange</a></li> |
|
927 <li class=""><a href="#event_yChange" title="yChange">yChange</a></li> |
|
928 </ul> |
|
929 </div> |
|
930 |
|
931 <div id="configList" class="module"> |
|
932 <h4>Configuration Attributes</h4> |
|
933 <ul class="content"> |
|
934 <li class=""><a href="#config_x" title="x">x</a></li> |
|
935 <li class=""><a href="#config_xy" title="xy">xy</a></li> |
|
936 <li class=""><a href="#config_y" title="y">y</a></li> |
|
937 </ul> |
|
938 </div> |
|
939 |
|
940 </div> |
|
941 </div> |
|
942 </div> |
|
943 <div id="ft"> |
|
944 <hr /> |
|
945 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
946 </div> |
|
947 </div> |
|
948 <script type="text/javascript"> |
|
949 ALL_YUI_PROPS = [{"access": "protected", "host": "WidgetPosition", "name": "_afterXYChange", "url": "WidgetPosition.html#method__afterXYChange", "type": "method"}, {"access": "protected", "host": "WidgetPosition", "name": "_bindUIPosition", "url": "WidgetPosition.html#method__bindUIPosition", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "_getX", "url": "WidgetPosition.html#method__getX", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "_getY", "url": "WidgetPosition.html#method__getY", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "move", "url": "WidgetPosition.html#method_move", "type": "method"}, {"access": "protected", "host": "WidgetPosition", "name": "_renderUIPosition", "url": "WidgetPosition.html#method__renderUIPosition", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "_setX", "url": "WidgetPosition.html#method__setX", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "_setY", "url": "WidgetPosition.html#method__setY", "type": "method"}, {"access": "protected", "host": "WidgetPosition", "name": "_syncUIPosition", "url": "WidgetPosition.html#method__syncUIPosition", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "syncXY", "url": "WidgetPosition.html#method_syncXY", "type": "method"}, {"access": "protected", "host": "WidgetPosition", "name": "_uiSetXY", "url": "WidgetPosition.html#method__uiSetXY", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "_validateXY", "url": "WidgetPosition.html#method__validateXY", "type": "method"}, {"access": "", "host": "WidgetPosition", "name": "WidgetPosition.ATTRS", "url": "WidgetPosition.html#property_WidgetPosition.ATTRS", "type": "property"}, {"access": "", "host": "WidgetPosition", "name": "WidgetPosition.POSITIONED_CLASS_NAME", "url": "WidgetPosition.html#property_WidgetPosition.POSITIONED_CLASS_NAME", "type": "property"}, {"access": "", "host": "WidgetPosition", "name": "x", "url": "WidgetPosition.html#config_x", "type": "config"}, {"access": "", "host": "WidgetPosition", "name": "xChange", "url": "WidgetPosition.html#event_xChange", "type": "event"}, {"access": "", "host": "WidgetPosition", "name": "xy", "url": "WidgetPosition.html#config_xy", "type": "config"}, {"access": "", "host": "WidgetPosition", "name": "xyChange", "url": "WidgetPosition.html#event_xyChange", "type": "event"}, {"access": "", "host": "WidgetPosition", "name": "y", "url": "WidgetPosition.html#config_y", "type": "config"}, {"access": "", "host": "WidgetPosition", "name": "yChange", "url": "WidgetPosition.html#event_yChange", "type": "event"}]; |
|
950 </script> |
|
951 </body> |
|
952 </html> |