|
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-stack WidgetStack (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-stack <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_widget-stack.html" title="widget-stack">widget-stack</a> |
|
22 > WidgetStack |
|
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">WidgetStack</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 stackable (z-index) support to the |
|
63 base Widget class along with a shimming solution, through the |
|
64 <a href="Base.html#method_build">Base.build</a> method. |
|
65 </div> |
|
66 |
|
67 |
|
68 <div rel="yui:properties" resource="#properties"> |
|
69 <div class="section field details"> |
|
70 <h3 id="properties">Properties</h3> |
|
71 <div class="content"> |
|
72 <div class="" rel="yui:property" resource="#property_WidgetStack.ATTRS"> |
|
73 <h4><a name="property_WidgetStack.ATTRS" property="yui:name">WidgetStack.ATTRS</a> |
|
74 - <code>static <span property="yui:type">Object</span></code> |
|
75 </h4> |
|
76 <div class="detail"> |
|
77 <div class="description" property="yui:description"> |
|
78 Static property used to define the default attribute |
|
79 configuration introduced by WidgetStack. |
|
80 </div> |
|
81 </div> |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 <hr /> |
|
87 </div> |
|
88 <div class="" rel="yui:property" resource="#property_WidgetStack.HTML_PARSER"> |
|
89 <h4><a name="property_WidgetStack.HTML_PARSER" property="yui:name">WidgetStack.HTML_PARSER</a> |
|
90 - <code>static <span property="yui:type">Object</span></code> |
|
91 </h4> |
|
92 <div class="detail"> |
|
93 <div class="description" property="yui:description"> |
|
94 The HTML parsing rules for the WidgetStack class. |
|
95 </div> |
|
96 </div> |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 <hr /> |
|
102 </div> |
|
103 <div class="" rel="yui:property" resource="#property_WidgetStack.SHIM_CLASS_NAME"> |
|
104 <h4><a name="property_WidgetStack.SHIM_CLASS_NAME" property="yui:name">WidgetStack.SHIM_CLASS_NAME</a> |
|
105 - <code>static <span property="yui:type">String</span></code> |
|
106 </h4> |
|
107 <div class="detail"> |
|
108 <div class="description" property="yui:description"> |
|
109 Default class used to mark the shim element |
|
110 </div> |
|
111 </div> |
|
112 |
|
113 |
|
114 <div class="default" property="yui:defaultValue"> |
|
115 Default Value: "yui-widget-shim" |
|
116 </div> |
|
117 |
|
118 |
|
119 <hr /> |
|
120 </div> |
|
121 <div class="" rel="yui:property" resource="#property_WidgetStack.SHIM_TEMPLATE"> |
|
122 <h4><a name="property_WidgetStack.SHIM_TEMPLATE" property="yui:name">WidgetStack.SHIM_TEMPLATE</a> |
|
123 - <code>static <span property="yui:type">String</span></code> |
|
124 </h4> |
|
125 <div class="detail"> |
|
126 <div class="description" property="yui:description"> |
|
127 Default markup template used to generate the shim element. |
|
128 </div> |
|
129 </div> |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 <hr /> |
|
135 </div> |
|
136 <div class="" rel="yui:property" resource="#property_WidgetStack.STACKED_CLASS_NAME"> |
|
137 <h4><a name="property_WidgetStack.STACKED_CLASS_NAME" property="yui:name">WidgetStack.STACKED_CLASS_NAME</a> |
|
138 - <code>static <span property="yui:type">String</span></code> |
|
139 </h4> |
|
140 <div class="detail"> |
|
141 <div class="description" property="yui:description"> |
|
142 Default class used to mark the boundingBox of a stacked widget. |
|
143 </div> |
|
144 </div> |
|
145 |
|
146 |
|
147 <div class="default" property="yui:defaultValue"> |
|
148 Default Value: "yui-widget-stacked" |
|
149 </div> |
|
150 |
|
151 |
|
152 <hr /> |
|
153 </div> |
|
154 </div> |
|
155 </div> |
|
156 |
|
157 </div> |
|
158 |
|
159 <div rel="yui:methods" resource="#methods"> |
|
160 <div class="section method details"> |
|
161 <h3 id="methods">Methods</h3> |
|
162 <div class="content"> |
|
163 <div class="private" rel="yui:method" resource="#method__addShimResizeHandlers"> |
|
164 <h4> |
|
165 <a name="method__addShimResizeHandlers">_addShimResizeHandlers</a></h4> |
|
166 <div class="detail" > |
|
167 <code> |
|
168 private |
|
169 |
|
170 |
|
171 void |
|
172 <strong property="yui:name">_addShimResizeHandlers</strong> |
|
173 ( |
|
174 ) |
|
175 </code> |
|
176 |
|
177 <div class="description" property="yui:description"> |
|
178 Sets up event listeners to resize the shim when the size of the Widget changes. |
|
179 <p> |
|
180 NOTE: This method is only used for IE6 currently, since IE6 doesn't support a way to |
|
181 resize the shim purely through CSS, when the Widget does not have an explicit width/height |
|
182 set. |
|
183 </p> |
|
184 </div> |
|
185 |
|
186 <div class="description"> |
|
187 |
|
188 |
|
189 <dl> |
|
190 <dt>Returns: |
|
191 <code property="yui:return"> |
|
192 void |
|
193 </code></dt> |
|
194 <dd property="yui:returnInfo"></dd> |
|
195 </dl> |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 </div> |
|
201 |
|
202 </div> |
|
203 <hr /> |
|
204 </div> |
|
205 <div class="protected" rel="yui:method" resource="#method__afterShimChange"> |
|
206 <h4> |
|
207 <a name="method__afterShimChange">_afterShimChange</a></h4> |
|
208 <div class="detail" > |
|
209 <code> |
|
210 protected |
|
211 |
|
212 |
|
213 void |
|
214 <strong property="yui:name">_afterShimChange</strong> |
|
215 ( |
|
216 |
|
217 |
|
218 e |
|
219 |
|
220 |
|
221 ) |
|
222 </code> |
|
223 |
|
224 <div class="description" property="yui:description"> |
|
225 Default attribute change listener for the shim attribute, responsible |
|
226 for updating the UI, in response to attribute changes. |
|
227 </div> |
|
228 |
|
229 <div class="description"> |
|
230 |
|
231 <dl rel="yui:parameters"> |
|
232 <dt>Parameters:</dt> |
|
233 <dd rel="yui:parameter"> |
|
234 <code><span property="yui:name">e</span> |
|
235 <<span property="yui:type">EventFacade</span>> |
|
236 </code> |
|
237 <span property="yui:description"> The event facade for the attribute change</span> |
|
238 </dd> |
|
239 </dl> |
|
240 |
|
241 <dl> |
|
242 <dt>Returns: |
|
243 <code property="yui:return"> |
|
244 void |
|
245 </code></dt> |
|
246 <dd property="yui:returnInfo"></dd> |
|
247 </dl> |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 </div> |
|
253 |
|
254 </div> |
|
255 <hr /> |
|
256 </div> |
|
257 <div class="protected" rel="yui:method" resource="#method__afterZIndexChange"> |
|
258 <h4> |
|
259 <a name="method__afterZIndexChange">_afterZIndexChange</a></h4> |
|
260 <div class="detail" > |
|
261 <code> |
|
262 protected |
|
263 |
|
264 |
|
265 void |
|
266 <strong property="yui:name">_afterZIndexChange</strong> |
|
267 ( |
|
268 |
|
269 |
|
270 e |
|
271 |
|
272 |
|
273 ) |
|
274 </code> |
|
275 |
|
276 <div class="description" property="yui:description"> |
|
277 Default attribute change listener for the zIndex attribute, responsible |
|
278 for updating the UI, in response to attribute changes. |
|
279 </div> |
|
280 |
|
281 <div class="description"> |
|
282 |
|
283 <dl rel="yui:parameters"> |
|
284 <dt>Parameters:</dt> |
|
285 <dd rel="yui:parameter"> |
|
286 <code><span property="yui:name">e</span> |
|
287 <<span property="yui:type">EventFacade</span>> |
|
288 </code> |
|
289 <span property="yui:description"> The event facade for the attribute change</span> |
|
290 </dd> |
|
291 </dl> |
|
292 |
|
293 <dl> |
|
294 <dt>Returns: |
|
295 <code property="yui:return"> |
|
296 void |
|
297 </code></dt> |
|
298 <dd property="yui:returnInfo"></dd> |
|
299 </dl> |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 </div> |
|
305 |
|
306 </div> |
|
307 <hr /> |
|
308 </div> |
|
309 <div class="protected" rel="yui:method" resource="#method__bindUIStack"> |
|
310 <h4> |
|
311 <a name="method__bindUIStack">_bindUIStack</a></h4> |
|
312 <div class="detail" > |
|
313 <code> |
|
314 protected |
|
315 |
|
316 |
|
317 void |
|
318 <strong property="yui:name">_bindUIStack</strong> |
|
319 ( |
|
320 ) |
|
321 </code> |
|
322 |
|
323 <div class="description" property="yui:description"> |
|
324 Binds event listeners responsible for updating the UI state in response to |
|
325 Widget stack related state changes. |
|
326 <p> |
|
327 This method is invoked after bindUI is invoked for the Widget class |
|
328 using YUI's aop infrastructure. |
|
329 </p> |
|
330 </div> |
|
331 |
|
332 <div class="description"> |
|
333 |
|
334 |
|
335 <dl> |
|
336 <dt>Returns: |
|
337 <code property="yui:return"> |
|
338 void |
|
339 </code></dt> |
|
340 <dd property="yui:returnInfo"></dd> |
|
341 </dl> |
|
342 |
|
343 |
|
344 |
|
345 |
|
346 </div> |
|
347 |
|
348 </div> |
|
349 <hr /> |
|
350 </div> |
|
351 <div class="private" rel="yui:method" resource="#method__destroyShim"> |
|
352 <h4> |
|
353 <a name="method__destroyShim">_destroyShim</a></h4> |
|
354 <div class="detail" > |
|
355 <code> |
|
356 private |
|
357 |
|
358 |
|
359 void |
|
360 <strong property="yui:name">_destroyShim</strong> |
|
361 ( |
|
362 ) |
|
363 </code> |
|
364 |
|
365 <div class="description" property="yui:description"> |
|
366 Removes the shim from the DOM, and detaches any related event |
|
367 listeners. |
|
368 </div> |
|
369 |
|
370 <div class="description"> |
|
371 |
|
372 |
|
373 <dl> |
|
374 <dt>Returns: |
|
375 <code property="yui:return"> |
|
376 void |
|
377 </code></dt> |
|
378 <dd property="yui:returnInfo"></dd> |
|
379 </dl> |
|
380 |
|
381 |
|
382 |
|
383 |
|
384 </div> |
|
385 |
|
386 </div> |
|
387 <hr /> |
|
388 </div> |
|
389 <div class="private" rel="yui:method" resource="#method__detachStackHandles"> |
|
390 <h4> |
|
391 <a name="method__detachStackHandles">_detachStackHandles</a></h4> |
|
392 <div class="detail" > |
|
393 <code> |
|
394 private |
|
395 |
|
396 |
|
397 void |
|
398 <strong property="yui:name">_detachStackHandles</strong> |
|
399 ( |
|
400 |
|
401 |
|
402 String |
|
403 |
|
404 |
|
405 ) |
|
406 </code> |
|
407 |
|
408 <div class="description" property="yui:description"> |
|
409 Detaches any handles stored for the provided key |
|
410 </div> |
|
411 |
|
412 <div class="description"> |
|
413 |
|
414 <dl rel="yui:parameters"> |
|
415 <dt>Parameters:</dt> |
|
416 <dd rel="yui:parameter"> |
|
417 <code><span property="yui:name">String</span> |
|
418 <<span property="yui:type">object</span>> |
|
419 </code> |
|
420 <span property="yui:description"> handleKey The key defining the group of handles which should be detached</span> |
|
421 </dd> |
|
422 </dl> |
|
423 |
|
424 <dl> |
|
425 <dt>Returns: |
|
426 <code property="yui:return"> |
|
427 void |
|
428 </code></dt> |
|
429 <dd property="yui:returnInfo"></dd> |
|
430 </dl> |
|
431 |
|
432 |
|
433 |
|
434 |
|
435 </div> |
|
436 |
|
437 </div> |
|
438 <hr /> |
|
439 </div> |
|
440 <div class="private" rel="yui:method" resource="#method__getShimTemplate"> |
|
441 <h4> |
|
442 <a name="method__getShimTemplate">_getShimTemplate</a></h4> |
|
443 <div class="detail" > |
|
444 <code> |
|
445 private |
|
446 |
|
447 |
|
448 Node |
|
449 <strong property="yui:name">_getShimTemplate</strong> |
|
450 ( |
|
451 ) |
|
452 </code> |
|
453 |
|
454 <div class="description" property="yui:description"> |
|
455 Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance. |
|
456 </div> |
|
457 |
|
458 <div class="description"> |
|
459 |
|
460 |
|
461 <dl> |
|
462 <dt>Returns: |
|
463 <code property="yui:return"> |
|
464 Node |
|
465 </code></dt> |
|
466 <dd property="yui:returnInfo">node A new shim Node instance.</dd> |
|
467 </dl> |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 </div> |
|
473 |
|
474 </div> |
|
475 <hr /> |
|
476 </div> |
|
477 <div class="private" rel="yui:method" resource="#method__renderShim"> |
|
478 <h4> |
|
479 <a name="method__renderShim">_renderShim</a></h4> |
|
480 <div class="detail" > |
|
481 <code> |
|
482 private |
|
483 |
|
484 |
|
485 void |
|
486 <strong property="yui:name">_renderShim</strong> |
|
487 ( |
|
488 ) |
|
489 </code> |
|
490 |
|
491 <div class="description" property="yui:description"> |
|
492 Creates the shim element and adds it to the DOM |
|
493 </div> |
|
494 |
|
495 <div class="description"> |
|
496 |
|
497 |
|
498 <dl> |
|
499 <dt>Returns: |
|
500 <code property="yui:return"> |
|
501 void |
|
502 </code></dt> |
|
503 <dd property="yui:returnInfo"></dd> |
|
504 </dl> |
|
505 |
|
506 |
|
507 |
|
508 |
|
509 </div> |
|
510 |
|
511 </div> |
|
512 <hr /> |
|
513 </div> |
|
514 <div class="private" rel="yui:method" resource="#method__renderShimDeferred"> |
|
515 <h4> |
|
516 <a name="method__renderShimDeferred">_renderShimDeferred</a></h4> |
|
517 <div class="detail" > |
|
518 <code> |
|
519 private |
|
520 |
|
521 |
|
522 void |
|
523 <strong property="yui:name">_renderShimDeferred</strong> |
|
524 ( |
|
525 ) |
|
526 </code> |
|
527 |
|
528 <div class="description" property="yui:description"> |
|
529 Sets up change handlers for the visible attribute, to defer shim creation/rendering |
|
530 until the Widget is made visible. |
|
531 </div> |
|
532 |
|
533 <div class="description"> |
|
534 |
|
535 |
|
536 <dl> |
|
537 <dt>Returns: |
|
538 <code property="yui:return"> |
|
539 void |
|
540 </code></dt> |
|
541 <dd property="yui:returnInfo"></dd> |
|
542 </dl> |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 </div> |
|
548 |
|
549 </div> |
|
550 <hr /> |
|
551 </div> |
|
552 <div class="protected" rel="yui:method" resource="#method__renderUIStack"> |
|
553 <h4> |
|
554 <a name="method__renderUIStack">_renderUIStack</a></h4> |
|
555 <div class="detail" > |
|
556 <code> |
|
557 protected |
|
558 |
|
559 |
|
560 void |
|
561 <strong property="yui:name">_renderUIStack</strong> |
|
562 ( |
|
563 ) |
|
564 </code> |
|
565 |
|
566 <div class="description" property="yui:description"> |
|
567 Creates/Initializes the DOM to support stackability. |
|
568 <p> |
|
569 This method in invoked after renderUI is invoked for the Widget class |
|
570 using YUI's aop infrastructure. |
|
571 </p> |
|
572 </div> |
|
573 |
|
574 <div class="description"> |
|
575 |
|
576 |
|
577 <dl> |
|
578 <dt>Returns: |
|
579 <code property="yui:return"> |
|
580 void |
|
581 </code></dt> |
|
582 <dd property="yui:returnInfo"></dd> |
|
583 </dl> |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 </div> |
|
589 |
|
590 </div> |
|
591 <hr /> |
|
592 </div> |
|
593 <div class="protected" rel="yui:method" resource="#method__setZIndex"> |
|
594 <h4> |
|
595 <a name="method__setZIndex">_setZIndex</a></h4> |
|
596 <div class="detail" > |
|
597 <code> |
|
598 protected |
|
599 |
|
600 |
|
601 Number |
|
602 <strong property="yui:name">_setZIndex</strong> |
|
603 ( |
|
604 |
|
605 |
|
606 zIndex |
|
607 |
|
608 |
|
609 ) |
|
610 </code> |
|
611 |
|
612 <div class="description" property="yui:description"> |
|
613 Default setter for zIndex attribute changes. Normalizes zIndex values to |
|
614 numbers, converting non-numerical values to 0. |
|
615 </div> |
|
616 |
|
617 <div class="description"> |
|
618 |
|
619 <dl rel="yui:parameters"> |
|
620 <dt>Parameters:</dt> |
|
621 <dd rel="yui:parameter"> |
|
622 <code><span property="yui:name">zIndex</span> |
|
623 <<span property="yui:type">String | Number</span>> |
|
624 </code> |
|
625 <span property="yui:description"></span> |
|
626 </dd> |
|
627 </dl> |
|
628 |
|
629 <dl> |
|
630 <dt>Returns: |
|
631 <code property="yui:return"> |
|
632 Number |
|
633 </code></dt> |
|
634 <dd property="yui:returnInfo">Normalized zIndex</dd> |
|
635 </dl> |
|
636 |
|
637 |
|
638 |
|
639 |
|
640 </div> |
|
641 |
|
642 </div> |
|
643 <hr /> |
|
644 </div> |
|
645 <div class="protected" rel="yui:method" resource="#method__syncUIStack"> |
|
646 <h4> |
|
647 <a name="method__syncUIStack">_syncUIStack</a></h4> |
|
648 <div class="detail" > |
|
649 <code> |
|
650 protected |
|
651 |
|
652 |
|
653 void |
|
654 <strong property="yui:name">_syncUIStack</strong> |
|
655 ( |
|
656 ) |
|
657 </code> |
|
658 |
|
659 <div class="description" property="yui:description"> |
|
660 Synchronizes the UI to match the Widgets stack state. This method in |
|
661 invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure. |
|
662 </div> |
|
663 |
|
664 <div class="description"> |
|
665 |
|
666 |
|
667 <dl> |
|
668 <dt>Returns: |
|
669 <code property="yui:return"> |
|
670 void |
|
671 </code></dt> |
|
672 <dd property="yui:returnInfo"></dd> |
|
673 </dl> |
|
674 |
|
675 |
|
676 |
|
677 |
|
678 </div> |
|
679 |
|
680 </div> |
|
681 <hr /> |
|
682 </div> |
|
683 <div class="protected" rel="yui:method" resource="#method__uiSetShim"> |
|
684 <h4> |
|
685 <a name="method__uiSetShim">_uiSetShim</a></h4> |
|
686 <div class="detail" > |
|
687 <code> |
|
688 protected |
|
689 |
|
690 |
|
691 void |
|
692 <strong property="yui:name">_uiSetShim</strong> |
|
693 ( |
|
694 |
|
695 |
|
696 enable |
|
697 |
|
698 |
|
699 ) |
|
700 </code> |
|
701 |
|
702 <div class="description" property="yui:description"> |
|
703 Updates the UI to enable/disable the shim. If the widget is not currently visible, |
|
704 creation of the shim is deferred until it is made visible, for performance reasons. |
|
705 </div> |
|
706 |
|
707 <div class="description"> |
|
708 |
|
709 <dl rel="yui:parameters"> |
|
710 <dt>Parameters:</dt> |
|
711 <dd rel="yui:parameter"> |
|
712 <code><span property="yui:name">enable</span> |
|
713 <<span property="yui:type">boolean</span>> |
|
714 </code> |
|
715 <span property="yui:description"> If true, creates/renders the shim, if false, removes it.</span> |
|
716 </dd> |
|
717 </dl> |
|
718 |
|
719 <dl> |
|
720 <dt>Returns: |
|
721 <code property="yui:return"> |
|
722 void |
|
723 </code></dt> |
|
724 <dd property="yui:returnInfo"></dd> |
|
725 </dl> |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 </div> |
|
731 |
|
732 </div> |
|
733 <hr /> |
|
734 </div> |
|
735 <div class="protected" rel="yui:method" resource="#method__uiSetZIndex"> |
|
736 <h4> |
|
737 <a name="method__uiSetZIndex">_uiSetZIndex</a></h4> |
|
738 <div class="detail" > |
|
739 <code> |
|
740 protected |
|
741 |
|
742 |
|
743 void |
|
744 <strong property="yui:name">_uiSetZIndex</strong> |
|
745 ( |
|
746 |
|
747 |
|
748 zIndex |
|
749 |
|
750 |
|
751 ) |
|
752 </code> |
|
753 |
|
754 <div class="description" property="yui:description"> |
|
755 Updates the UI to reflect the zIndex value passed in. |
|
756 </div> |
|
757 |
|
758 <div class="description"> |
|
759 |
|
760 <dl rel="yui:parameters"> |
|
761 <dt>Parameters:</dt> |
|
762 <dd rel="yui:parameter"> |
|
763 <code><span property="yui:name">zIndex</span> |
|
764 <<span property="yui:type">number</span>> |
|
765 </code> |
|
766 <span property="yui:description"> The zindex to be reflected in the UI</span> |
|
767 </dd> |
|
768 </dl> |
|
769 |
|
770 <dl> |
|
771 <dt>Returns: |
|
772 <code property="yui:return"> |
|
773 void |
|
774 </code></dt> |
|
775 <dd property="yui:returnInfo"></dd> |
|
776 </dl> |
|
777 |
|
778 |
|
779 |
|
780 |
|
781 </div> |
|
782 |
|
783 </div> |
|
784 <hr /> |
|
785 </div> |
|
786 <div class="" rel="yui:method" resource="#method_sizeShim"> |
|
787 <h4> |
|
788 <a name="method_sizeShim">sizeShim</a></h4> |
|
789 <div class="detail" > |
|
790 <code> |
|
791 |
|
792 |
|
793 |
|
794 void |
|
795 <strong property="yui:name">sizeShim</strong> |
|
796 ( |
|
797 ) |
|
798 </code> |
|
799 |
|
800 <div class="description" property="yui:description"> |
|
801 For IE6, synchronizes the size and position of iframe shim to that of |
|
802 Widget bounding box which it is protecting. For all other browsers, |
|
803 this method does not do anything. |
|
804 </div> |
|
805 |
|
806 <div class="description"> |
|
807 |
|
808 |
|
809 <dl> |
|
810 <dt>Returns: |
|
811 <code property="yui:return"> |
|
812 void |
|
813 </code></dt> |
|
814 <dd property="yui:returnInfo"></dd> |
|
815 </dl> |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 </div> |
|
821 |
|
822 </div> |
|
823 <hr /> |
|
824 </div> |
|
825 </div> |
|
826 </div> |
|
827 |
|
828 </div> |
|
829 |
|
830 <div rel="yui:events" resource="#events"> |
|
831 <div class="section method details"> |
|
832 <h3 id="events">Events</h3> |
|
833 <div class="content"> |
|
834 <div class="" rel="yui:event" resource="#event_shimChange"> |
|
835 <h4> |
|
836 <a name="event_shimChange">shimChange</a></h4> |
|
837 <div class="detail"> |
|
838 <code> |
|
839 |
|
840 |
|
841 |
|
842 <strong property="yui:name">shimChange</strong> |
|
843 |
|
844 ( |
|
845 |
|
846 |
|
847 event |
|
848 |
|
849 |
|
850 ) |
|
851 |
|
852 </code> |
|
853 |
|
854 <div class="description" property="yui:description"> |
|
855 Fires when the value for the configuration attribute 'shim' 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. |
|
856 </div> |
|
857 |
|
858 <div class="description"> |
|
859 |
|
860 |
|
861 <dl rel="yui:parameters"> |
|
862 <dt>Parameters:</dt> |
|
863 <dd rel="yui:parameter"> |
|
864 <code><span property="yui:name">event</span> |
|
865 <<span property="yui:type">Event.Facade</span>> |
|
866 </code> |
|
867 <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> |
|
868 </dd> |
|
869 |
|
870 </dl> |
|
871 |
|
872 |
|
873 </div> |
|
874 |
|
875 </div> |
|
876 <hr /> |
|
877 </div> |
|
878 <div class="" rel="yui:event" resource="#event_zIndexChange"> |
|
879 <h4> |
|
880 <a name="event_zIndexChange">zIndexChange</a></h4> |
|
881 <div class="detail"> |
|
882 <code> |
|
883 |
|
884 |
|
885 |
|
886 <strong property="yui:name">zIndexChange</strong> |
|
887 |
|
888 ( |
|
889 |
|
890 |
|
891 event |
|
892 |
|
893 |
|
894 ) |
|
895 |
|
896 </code> |
|
897 |
|
898 <div class="description" property="yui:description"> |
|
899 Fires when the value for the configuration attribute 'zIndex' 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. |
|
900 </div> |
|
901 |
|
902 <div class="description"> |
|
903 |
|
904 |
|
905 <dl rel="yui:parameters"> |
|
906 <dt>Parameters:</dt> |
|
907 <dd rel="yui:parameter"> |
|
908 <code><span property="yui:name">event</span> |
|
909 <<span property="yui:type">Event.Facade</span>> |
|
910 </code> |
|
911 <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> |
|
912 </dd> |
|
913 |
|
914 </dl> |
|
915 |
|
916 |
|
917 </div> |
|
918 |
|
919 </div> |
|
920 <hr /> |
|
921 </div> |
|
922 </div> |
|
923 </div> |
|
924 |
|
925 |
|
926 </div> |
|
927 |
|
928 <div rel="yui:attributes" resource="#configattributes"> |
|
929 <div class="section field details"> |
|
930 <h3 id="configattributes">Configuration Attributes</h3> |
|
931 <div class="content"> |
|
932 <div class="" rel="yui:attribute" resource="#config_shim"> |
|
933 <h4><a name="config_shim">shim</a> |
|
934 <code>- <span property="yui:type">boolean</span></code> |
|
935 </h4> |
|
936 <div class="detail"> |
|
937 <div class="description" property="yui:description"> |
|
938 Boolean flag to indicate whether or not a shim should be added to the Widgets |
|
939 boundingBox, to protect it from select box bleedthrough. |
|
940 </div> |
|
941 </div> |
|
942 |
|
943 |
|
944 <div class="default"> |
|
945 Default Value: false, for all browsers other than IE6, for which a shim is enabled by default. |
|
946 </div> |
|
947 |
|
948 <hr /> |
|
949 </div> |
|
950 <div class="" rel="yui:attribute" resource="#config_zIndex"> |
|
951 <h4><a name="config_zIndex">zIndex</a> |
|
952 <code>- <span property="yui:type">number</span></code> |
|
953 </h4> |
|
954 <div class="detail"> |
|
955 <div class="description" property="yui:description"> |
|
956 The z-index to apply to the Widgets boundingBox. Non-numerical values for |
|
957 zIndex will be converted to 0 |
|
958 </div> |
|
959 </div> |
|
960 |
|
961 |
|
962 <div class="default"> |
|
963 Default Value: 0 |
|
964 </div> |
|
965 |
|
966 <hr /> |
|
967 </div> |
|
968 |
|
969 </div> |
|
970 </div> |
|
971 |
|
972 </div> |
|
973 |
|
974 </div> |
|
975 </div> |
|
976 <div class="yui-b"> |
|
977 <div class="nav"> |
|
978 |
|
979 <div id="moduleList" class="module"> |
|
980 <h4>Modules</h4> |
|
981 <ul class="content"> |
|
982 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
983 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
984 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
985 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
986 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
987 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
988 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
989 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
990 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
991 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
992 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
993 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
994 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
995 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
996 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
997 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
998 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
999 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
1000 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
1001 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
1002 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
1003 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
1004 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
1005 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
1006 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
1007 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
1008 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
1009 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
1010 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
1011 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
1012 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
1013 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
1014 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
1015 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
1016 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
1017 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
1018 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
1019 <li class="selected"><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
1020 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
1021 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
1022 </ul> |
|
1023 </div> |
|
1024 |
|
1025 <div id="classList" class="module"> |
|
1026 <h4>Classes</h4> |
|
1027 <ul class="content"> |
|
1028 <li class="selected"><a href="WidgetStack.html" title="WidgetStack">WidgetStack</a></li> |
|
1029 </ul> |
|
1030 </div> |
|
1031 |
|
1032 <div id="fileList" class="module"> |
|
1033 <h4>Files</h4> |
|
1034 <ul class="content"> |
|
1035 <li class=""><a href="Widget-Stack.js.html" title="Widget-Stack.js">Widget-Stack.js</a></li> |
|
1036 </ul> |
|
1037 </div> |
|
1038 |
|
1039 <div id="propertyList" class="module"> |
|
1040 <h4>Properties</h4> |
|
1041 <ul class="content"> |
|
1042 <li class=""><a href="#property_WidgetStack.ATTRS" title="WidgetStack.ATTRS">WidgetStack.ATTRS</a></li> |
|
1043 <li class=""><a href="#property_WidgetStack.HTML_PARSER" title="WidgetStack.HTML_PARSER">WidgetStack.HTML_PARSER</a></li> |
|
1044 <li class=""><a href="#property_WidgetStack.SHIM_CLASS_NAME" title="WidgetStack.SHIM_CLASS_NAME">WidgetStack.SHIM_CLASS_NAME</a></li> |
|
1045 <li class=""><a href="#property_WidgetStack.SHIM_TEMPLATE" title="WidgetStack.SHIM_TEMPLATE">WidgetStack.SHIM_TEMPLATE</a></li> |
|
1046 <li class=""><a href="#property_WidgetStack.STACKED_CLASS_NAME" title="WidgetStack.STACKED_CLASS_NAME">WidgetStack.STACKED_CLASS_NAME</a></li> |
|
1047 </ul> |
|
1048 </div> |
|
1049 |
|
1050 <div id="methodsList" class="module"> |
|
1051 <h4>Methods</h4> |
|
1052 <ul class="content"> |
|
1053 <li class="private"><a href="#method__addShimResizeHandlers" title="_addShimResizeHandlers">_addShimResizeHandlers</a></li> |
|
1054 <li class="protected"><a href="#method__afterShimChange" title="_afterShimChange">_afterShimChange</a></li> |
|
1055 <li class="protected"><a href="#method__afterZIndexChange" title="_afterZIndexChange">_afterZIndexChange</a></li> |
|
1056 <li class="protected"><a href="#method__bindUIStack" title="_bindUIStack">_bindUIStack</a></li> |
|
1057 <li class="private"><a href="#method__destroyShim" title="_destroyShim">_destroyShim</a></li> |
|
1058 <li class="private"><a href="#method__detachStackHandles" title="_detachStackHandles">_detachStackHandles</a></li> |
|
1059 <li class="private"><a href="#method__getShimTemplate" title="_getShimTemplate">_getShimTemplate</a></li> |
|
1060 <li class="private"><a href="#method__renderShim" title="_renderShim">_renderShim</a></li> |
|
1061 <li class="private"><a href="#method__renderShimDeferred" title="_renderShimDeferred">_renderShimDeferred</a></li> |
|
1062 <li class="protected"><a href="#method__renderUIStack" title="_renderUIStack">_renderUIStack</a></li> |
|
1063 <li class="protected"><a href="#method__setZIndex" title="_setZIndex">_setZIndex</a></li> |
|
1064 <li class="protected"><a href="#method__syncUIStack" title="_syncUIStack">_syncUIStack</a></li> |
|
1065 <li class="protected"><a href="#method__uiSetShim" title="_uiSetShim">_uiSetShim</a></li> |
|
1066 <li class="protected"><a href="#method__uiSetZIndex" title="_uiSetZIndex">_uiSetZIndex</a></li> |
|
1067 <li class=""><a href="#method_sizeShim" title="sizeShim">sizeShim</a></li> |
|
1068 </ul> |
|
1069 </div> |
|
1070 |
|
1071 <div id="eventsList" class="module"> |
|
1072 <h4>Events</h4> |
|
1073 <ul class="content"> |
|
1074 <li class=""><a href="#event_shimChange" title="shimChange">shimChange</a></li> |
|
1075 <li class=""><a href="#event_zIndexChange" title="zIndexChange">zIndexChange</a></li> |
|
1076 </ul> |
|
1077 </div> |
|
1078 |
|
1079 <div id="configList" class="module"> |
|
1080 <h4>Configuration Attributes</h4> |
|
1081 <ul class="content"> |
|
1082 <li class=""><a href="#config_shim" title="shim">shim</a></li> |
|
1083 <li class=""><a href="#config_zIndex" title="zIndex">zIndex</a></li> |
|
1084 </ul> |
|
1085 </div> |
|
1086 |
|
1087 </div> |
|
1088 </div> |
|
1089 </div> |
|
1090 <div id="ft"> |
|
1091 <hr /> |
|
1092 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
1093 </div> |
|
1094 </div> |
|
1095 <script type="text/javascript"> |
|
1096 ALL_YUI_PROPS = [{"access": "private", "host": "WidgetStack", "name": "_addShimResizeHandlers", "url": "WidgetStack.html#method__addShimResizeHandlers", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_afterShimChange", "url": "WidgetStack.html#method__afterShimChange", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_afterZIndexChange", "url": "WidgetStack.html#method__afterZIndexChange", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_bindUIStack", "url": "WidgetStack.html#method__bindUIStack", "type": "method"}, {"access": "private", "host": "WidgetStack", "name": "_destroyShim", "url": "WidgetStack.html#method__destroyShim", "type": "method"}, {"access": "private", "host": "WidgetStack", "name": "_detachStackHandles", "url": "WidgetStack.html#method__detachStackHandles", "type": "method"}, {"access": "private", "host": "WidgetStack", "name": "_getShimTemplate", "url": "WidgetStack.html#method__getShimTemplate", "type": "method"}, {"access": "private", "host": "WidgetStack", "name": "_renderShim", "url": "WidgetStack.html#method__renderShim", "type": "method"}, {"access": "private", "host": "WidgetStack", "name": "_renderShimDeferred", "url": "WidgetStack.html#method__renderShimDeferred", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_renderUIStack", "url": "WidgetStack.html#method__renderUIStack", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_setZIndex", "url": "WidgetStack.html#method__setZIndex", "type": "method"}, {"access": "", "host": "WidgetStack", "name": "shim", "url": "WidgetStack.html#config_shim", "type": "config"}, {"access": "", "host": "WidgetStack", "name": "shimChange", "url": "WidgetStack.html#event_shimChange", "type": "event"}, {"access": "", "host": "WidgetStack", "name": "sizeShim", "url": "WidgetStack.html#method_sizeShim", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_syncUIStack", "url": "WidgetStack.html#method__syncUIStack", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_uiSetShim", "url": "WidgetStack.html#method__uiSetShim", "type": "method"}, {"access": "protected", "host": "WidgetStack", "name": "_uiSetZIndex", "url": "WidgetStack.html#method__uiSetZIndex", "type": "method"}, {"access": "", "host": "WidgetStack", "name": "WidgetStack.ATTRS", "url": "WidgetStack.html#property_WidgetStack.ATTRS", "type": "property"}, {"access": "", "host": "WidgetStack", "name": "WidgetStack.HTML_PARSER", "url": "WidgetStack.html#property_WidgetStack.HTML_PARSER", "type": "property"}, {"access": "", "host": "WidgetStack", "name": "WidgetStack.SHIM_CLASS_NAME", "url": "WidgetStack.html#property_WidgetStack.SHIM_CLASS_NAME", "type": "property"}, {"access": "", "host": "WidgetStack", "name": "WidgetStack.SHIM_TEMPLATE", "url": "WidgetStack.html#property_WidgetStack.SHIM_TEMPLATE", "type": "property"}, {"access": "", "host": "WidgetStack", "name": "WidgetStack.STACKED_CLASS_NAME", "url": "WidgetStack.html#property_WidgetStack.STACKED_CLASS_NAME", "type": "property"}, {"access": "", "host": "WidgetStack", "name": "zIndex", "url": "WidgetStack.html#config_zIndex", "type": "config"}, {"access": "", "host": "WidgetStack", "name": "zIndexChange", "url": "WidgetStack.html#event_zIndexChange", "type": "event"}]; |
|
1097 </script> |
|
1098 </body> |
|
1099 </html> |