|
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 Widget (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 <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.html" title="widget">widget</a> |
|
22 > Widget |
|
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">Widget</b> |
|
52 <span class="extends"> |
|
53 - extends <a href="Base.html" title="Base">Base</a> |
|
54 </span> |
|
55 |
|
56 </h2> |
|
57 <!-- class tree goes here --> |
|
58 |
|
59 <dl class="subclasses" rel="yui:subclasses"> |
|
60 <dt>Known Subclasses:</dt> |
|
61 <dd> |
|
62 <span rel="yui:subclass" resource="Console.html"> |
|
63 <a href="Console.html" property="yui:name" title="Console">Console</a> |
|
64 </span> |
|
65 <span rel="yui:subclass" resource="Overlay.html"> |
|
66 <a href="Overlay.html" property="yui:name" title="Overlay">Overlay</a> |
|
67 </span> |
|
68 <span rel="yui:subclass" resource="Slider.html"> |
|
69 <a href="Slider.html" property="yui:name" title="Slider">Slider</a> |
|
70 </span> |
|
71 </dd> |
|
72 </dl> |
|
73 |
|
74 |
|
75 |
|
76 <div class="summary description" property="yui:description"> |
|
77 A base class for widgets, providing: |
|
78 <ul> |
|
79 <li>The render lifecycle method, in addition to the init and destroy |
|
80 lifecycle methods provide by Base</li> |
|
81 <li>Abstract methods to support consistent MVC structure across |
|
82 widgets: renderer, renderUI, bindUI, syncUI</li> |
|
83 <li>Support for common widget attributes, such as boundingBox, contentBox, visible, |
|
84 disabled, focused, strings</li> |
|
85 </ul> |
|
86 </div> |
|
87 |
|
88 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
89 <h3 id="constructor">Constructor</h3> |
|
90 <div class="content"> |
|
91 <div class="detail"> |
|
92 <strong property="yui:name">Widget</strong> |
|
93 <code> |
|
94 ( |
|
95 |
|
96 |
|
97 |
|
98 config |
|
99 ) |
|
100 </code> |
|
101 <div class="description"> |
|
102 <dl rel="yui:parameters"> |
|
103 <dt>Parameters:</dt> |
|
104 <dd rel="yui:parameter"> |
|
105 <code><span property="yui:name">config</span> |
|
106 <<span property="yui:type">Object</span>> |
|
107 </code> |
|
108 <span property="yui:description"> Object literal specifying widget configuration |
|
109 properties.</span> |
|
110 </dd> |
|
111 </dl> |
|
112 |
|
113 |
|
114 </div> |
|
115 </div> |
|
116 </div> |
|
117 </div> |
|
118 |
|
119 <div rel="yui:properties" resource="#properties"> |
|
120 <div class="section field details"> |
|
121 <h3 id="properties">Properties</h3> |
|
122 <div class="content"> |
|
123 <div class="private" rel="yui:property" resource="#property__buildCfg"> |
|
124 <h4><a name="property__buildCfg" property="yui:name">_buildCfg</a> |
|
125 - <code>private static final <span property="yui:type">Object</span></code> |
|
126 </h4> |
|
127 <div class="detail"> |
|
128 <div class="description" property="yui:description"> |
|
129 The build configuration for the Widget class. |
|
130 <p> |
|
131 Defines the static fields which need to be aggregated, |
|
132 when this class is used as the main class passed to |
|
133 the <a href="Base.html#method_build">Base.build</a> method. |
|
134 </p> |
|
135 </div> |
|
136 </div> |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 <hr /> |
|
142 </div> |
|
143 <div class="private" rel="yui:property" resource="#property__strings"> |
|
144 <h4><a name="property__strings" property="yui:name">_strings</a> |
|
145 - <code>private <span property="yui:type">Object</span></code> |
|
146 </h4> |
|
147 <div class="detail"> |
|
148 <div class="description" property="yui:description"> |
|
149 Private stings hash, used to store strings in locale specific buckets. |
|
150 </div> |
|
151 </div> |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 <hr /> |
|
157 </div> |
|
158 <div class="" rel="yui:property" resource="#property_BOUNDING_TEMPLATE"> |
|
159 <h4><a name="property_BOUNDING_TEMPLATE" property="yui:name">BOUNDING_TEMPLATE</a> |
|
160 - <code><span property="yui:type">String</span></code> |
|
161 </h4> |
|
162 <div class="detail"> |
|
163 <div class="description" property="yui:description"> |
|
164 Static property defining the markup template for bounding box. |
|
165 </div> |
|
166 </div> |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 <hr /> |
|
172 </div> |
|
173 <div class="" rel="yui:property" resource="#property_CONTENT_TEMPLATE"> |
|
174 <h4><a name="property_CONTENT_TEMPLATE" property="yui:name">CONTENT_TEMPLATE</a> |
|
175 - <code><span property="yui:type">String</span></code> |
|
176 </h4> |
|
177 <div class="detail"> |
|
178 <div class="description" property="yui:description"> |
|
179 Static property defining the markup template for content box. |
|
180 </div> |
|
181 </div> |
|
182 |
|
183 |
|
184 |
|
185 |
|
186 <hr /> |
|
187 </div> |
|
188 <div class="" rel="yui:property" resource="#property_DEF_UNIT"> |
|
189 <h4><a name="property_DEF_UNIT" property="yui:name">DEF_UNIT</a> |
|
190 - <code><span property="yui:type">object</span></code> |
|
191 </h4> |
|
192 <div class="detail"> |
|
193 <div class="description" property="yui:description"> |
|
194 Default unit to use for dimension values |
|
195 </div> |
|
196 </div> |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 <hr /> |
|
202 </div> |
|
203 <div class="private" rel="yui:property" resource="#property_Widget._NAME_LOWERCASE"> |
|
204 <h4><a name="property_Widget._NAME_LOWERCASE" property="yui:name">Widget._NAME_LOWERCASE</a> |
|
205 - <code>private static <span property="yui:type">object</span></code> |
|
206 </h4> |
|
207 <div class="detail"> |
|
208 <div class="description" property="yui:description"> |
|
209 Cached lowercase version of Widget.NAME |
|
210 </div> |
|
211 </div> |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 <hr /> |
|
217 </div> |
|
218 <div class="" rel="yui:property" resource="#property_Widget.ATTRS"> |
|
219 <h4><a name="property_Widget.ATTRS" property="yui:name">Widget.ATTRS</a> |
|
220 - <code>static <span property="yui:type">Object</span></code> |
|
221 </h4> |
|
222 <div class="detail"> |
|
223 <div class="description" property="yui:description"> |
|
224 Static property used to define the default attribute |
|
225 configuration for the Widget. |
|
226 </div> |
|
227 </div> |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 <hr /> |
|
233 </div> |
|
234 <div class="" rel="yui:property" resource="#property_Widget.HTML_PARSER"> |
|
235 <h4><a name="property_Widget.HTML_PARSER" property="yui:name">Widget.HTML_PARSER</a> |
|
236 - <code>static <span property="yui:type">Object</span></code> |
|
237 </h4> |
|
238 <div class="detail"> |
|
239 <div class="description" property="yui:description"> |
|
240 Object hash, defining how attribute values are to be parsed from |
|
241 markup contained in the widget's content box. e.g.: |
|
242 <pre> |
|
243 { |
|
244 // Set single Node references using selector syntax |
|
245 // (selector is run through node.query) |
|
246 titleNode: "span.yui-title", |
|
247 // Set NodeList references using selector syntax |
|
248 // (array indicates selector is to be run through node.queryAll) |
|
249 listNodes: ["li.yui-item"], |
|
250 // Set other attribute types, using a parse function. |
|
251 // Context is set to the widget instance. |
|
252 label: function(contentBox) { |
|
253 return contentBox.query("span.title").get("innerHTML"); |
|
254 } |
|
255 } |
|
256 </pre> |
|
257 </div> |
|
258 </div> |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 <hr /> |
|
264 </div> |
|
265 <div class="" rel="yui:property" resource="#property_Widget.NAME"> |
|
266 <h4><a name="property_Widget.NAME" property="yui:name">Widget.NAME</a> |
|
267 - <code>static <span property="yui:type">String</span></code> |
|
268 </h4> |
|
269 <div class="detail"> |
|
270 <div class="description" property="yui:description"> |
|
271 Static property provides a string to identify the class. |
|
272 <p> |
|
273 Currently used to apply class identifiers to the bounding box |
|
274 and to classify events fired by the widget. |
|
275 </p> |
|
276 </div> |
|
277 </div> |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 <hr /> |
|
283 </div> |
|
284 <div class="" rel="yui:property" resource="#property_Widget.UI_SRC"> |
|
285 <h4><a name="property_Widget.UI_SRC" property="yui:name">Widget.UI_SRC</a> |
|
286 - <code>static final <span property="yui:type">String</span></code> |
|
287 </h4> |
|
288 <div class="detail"> |
|
289 <div class="description" property="yui:description"> |
|
290 Constant used to identify state changes originating from |
|
291 the DOM (as opposed to the JavaScript model). |
|
292 </div> |
|
293 </div> |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 <hr /> |
|
299 </div> |
|
300 <div class="" rel="yui:property" resource="#property_WRAP_STYLES"> |
|
301 <h4><a name="property_WRAP_STYLES" property="yui:name">WRAP_STYLES</a> |
|
302 - <code><span property="yui:type">Object</span></code> |
|
303 </h4> |
|
304 <div class="detail"> |
|
305 <div class="description" property="yui:description"> |
|
306 Static property listing the styles that are mimiced on the bounding box from the content box. |
|
307 </div> |
|
308 </div> |
|
309 |
|
310 |
|
311 |
|
312 |
|
313 <hr /> |
|
314 </div> |
|
315 </div> |
|
316 </div> |
|
317 |
|
318 <div rel="yui:inheritance"> |
|
319 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
320 <h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
321 <div class="content" rel="yui:properties"> |
|
322 <code> |
|
323 |
|
324 </code> |
|
325 </div> |
|
326 </div> |
|
327 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
328 <h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
329 <div class="content" rel="yui:properties"> |
|
330 <code> |
|
331 |
|
332 <span rel="yui:property" resource="Base.html#property_name"> |
|
333 <a class=" deprecated" href="Base.html#property_name" property="yui:name" title="name">name</a> |
|
334 </span> |
|
335 |
|
336 </code> |
|
337 </div> |
|
338 </div> |
|
339 </div> |
|
340 </div> |
|
341 |
|
342 <div rel="yui:methods" resource="#methods"> |
|
343 <div class="section method details"> |
|
344 <h3 id="methods">Methods</h3> |
|
345 <div class="content"> |
|
346 <div class="protected" rel="yui:method" resource="#method__afterDisabledChange"> |
|
347 <h4> |
|
348 <a name="method__afterDisabledChange">_afterDisabledChange</a></h4> |
|
349 <div class="detail" > |
|
350 <code> |
|
351 protected |
|
352 |
|
353 |
|
354 void |
|
355 <strong property="yui:name">_afterDisabledChange</strong> |
|
356 ( |
|
357 |
|
358 |
|
359 evt |
|
360 |
|
361 |
|
362 ) |
|
363 </code> |
|
364 |
|
365 <div class="description" property="yui:description"> |
|
366 Default disabled attribute state change handler |
|
367 </div> |
|
368 |
|
369 <div class="description"> |
|
370 |
|
371 <dl rel="yui:parameters"> |
|
372 <dt>Parameters:</dt> |
|
373 <dd rel="yui:parameter"> |
|
374 <code><span property="yui:name">evt</span> |
|
375 <<span property="yui:type">EventFacade</span>> |
|
376 </code> |
|
377 <span property="yui:description"> The event facade for the attribute change</span> |
|
378 </dd> |
|
379 </dl> |
|
380 |
|
381 |
|
382 |
|
383 |
|
384 |
|
385 </div> |
|
386 |
|
387 </div> |
|
388 <hr /> |
|
389 </div> |
|
390 <div class="protected" rel="yui:method" resource="#method__afterFocusedChange"> |
|
391 <h4> |
|
392 <a name="method__afterFocusedChange">_afterFocusedChange</a></h4> |
|
393 <div class="detail" > |
|
394 <code> |
|
395 protected |
|
396 |
|
397 |
|
398 void |
|
399 <strong property="yui:name">_afterFocusedChange</strong> |
|
400 ( |
|
401 |
|
402 |
|
403 evt |
|
404 |
|
405 |
|
406 ) |
|
407 </code> |
|
408 |
|
409 <div class="description" property="yui:description"> |
|
410 Default focused attribute state change handler |
|
411 </div> |
|
412 |
|
413 <div class="description"> |
|
414 |
|
415 <dl rel="yui:parameters"> |
|
416 <dt>Parameters:</dt> |
|
417 <dd rel="yui:parameter"> |
|
418 <code><span property="yui:name">evt</span> |
|
419 <<span property="yui:type">EventFacade</span>> |
|
420 </code> |
|
421 <span property="yui:description"> The event facade for the attribute change</span> |
|
422 </dd> |
|
423 </dl> |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 </div> |
|
430 |
|
431 </div> |
|
432 <hr /> |
|
433 </div> |
|
434 <div class="protected" rel="yui:method" resource="#method__afterHeightChange"> |
|
435 <h4> |
|
436 <a name="method__afterHeightChange">_afterHeightChange</a></h4> |
|
437 <div class="detail" > |
|
438 <code> |
|
439 protected |
|
440 |
|
441 |
|
442 void |
|
443 <strong property="yui:name">_afterHeightChange</strong> |
|
444 ( |
|
445 |
|
446 |
|
447 evt |
|
448 |
|
449 |
|
450 ) |
|
451 </code> |
|
452 |
|
453 <div class="description" property="yui:description"> |
|
454 Default height attribute state change handler |
|
455 </div> |
|
456 |
|
457 <div class="description"> |
|
458 |
|
459 <dl rel="yui:parameters"> |
|
460 <dt>Parameters:</dt> |
|
461 <dd rel="yui:parameter"> |
|
462 <code><span property="yui:name">evt</span> |
|
463 <<span property="yui:type">EventFacade</span>> |
|
464 </code> |
|
465 <span property="yui:description"> The event facade for the attribute change</span> |
|
466 </dd> |
|
467 </dl> |
|
468 |
|
469 |
|
470 |
|
471 |
|
472 |
|
473 </div> |
|
474 |
|
475 </div> |
|
476 <hr /> |
|
477 </div> |
|
478 <div class="protected" rel="yui:method" resource="#method__afterVisibleChange"> |
|
479 <h4> |
|
480 <a name="method__afterVisibleChange">_afterVisibleChange</a></h4> |
|
481 <div class="detail" > |
|
482 <code> |
|
483 protected |
|
484 |
|
485 |
|
486 void |
|
487 <strong property="yui:name">_afterVisibleChange</strong> |
|
488 ( |
|
489 |
|
490 |
|
491 evt |
|
492 |
|
493 |
|
494 ) |
|
495 </code> |
|
496 |
|
497 <div class="description" property="yui:description"> |
|
498 Default visible attribute state change handler |
|
499 </div> |
|
500 |
|
501 <div class="description"> |
|
502 |
|
503 <dl rel="yui:parameters"> |
|
504 <dt>Parameters:</dt> |
|
505 <dd rel="yui:parameter"> |
|
506 <code><span property="yui:name">evt</span> |
|
507 <<span property="yui:type">EventFacade</span>> |
|
508 </code> |
|
509 <span property="yui:description"> The event facade for the attribute change</span> |
|
510 </dd> |
|
511 </dl> |
|
512 |
|
513 |
|
514 |
|
515 |
|
516 |
|
517 </div> |
|
518 |
|
519 </div> |
|
520 <hr /> |
|
521 </div> |
|
522 <div class="protected" rel="yui:method" resource="#method__afterWidthChange"> |
|
523 <h4> |
|
524 <a name="method__afterWidthChange">_afterWidthChange</a></h4> |
|
525 <div class="detail" > |
|
526 <code> |
|
527 protected |
|
528 |
|
529 |
|
530 void |
|
531 <strong property="yui:name">_afterWidthChange</strong> |
|
532 ( |
|
533 |
|
534 |
|
535 evt |
|
536 |
|
537 |
|
538 ) |
|
539 </code> |
|
540 |
|
541 <div class="description" property="yui:description"> |
|
542 Default widget attribute state change handler |
|
543 </div> |
|
544 |
|
545 <div class="description"> |
|
546 |
|
547 <dl rel="yui:parameters"> |
|
548 <dt>Parameters:</dt> |
|
549 <dd rel="yui:parameter"> |
|
550 <code><span property="yui:name">evt</span> |
|
551 <<span property="yui:type">EventFacade</span>> |
|
552 </code> |
|
553 <span property="yui:description"> The event facade for the attribute change</span> |
|
554 </dd> |
|
555 </dl> |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 |
|
561 </div> |
|
562 |
|
563 </div> |
|
564 <hr /> |
|
565 </div> |
|
566 <div class="protected" rel="yui:method" resource="#method__bindDOMListeners"> |
|
567 <h4> |
|
568 <a name="method__bindDOMListeners">_bindDOMListeners</a></h4> |
|
569 <div class="detail" > |
|
570 <code> |
|
571 protected |
|
572 |
|
573 |
|
574 void |
|
575 <strong property="yui:name">_bindDOMListeners</strong> |
|
576 ( |
|
577 ) |
|
578 </code> |
|
579 |
|
580 <div class="description" property="yui:description"> |
|
581 Sets up DOM listeners, on elements rendered by the widget. |
|
582 </div> |
|
583 |
|
584 <div class="description"> |
|
585 |
|
586 |
|
587 |
|
588 |
|
589 |
|
590 |
|
591 </div> |
|
592 |
|
593 </div> |
|
594 <hr /> |
|
595 </div> |
|
596 <div class="protected" rel="yui:method" resource="#method__bindUI"> |
|
597 <h4> |
|
598 <a name="method__bindUI">_bindUI</a></h4> |
|
599 <div class="detail" > |
|
600 <code> |
|
601 protected |
|
602 |
|
603 |
|
604 void |
|
605 <strong property="yui:name">_bindUI</strong> |
|
606 ( |
|
607 ) |
|
608 </code> |
|
609 |
|
610 <div class="description" property="yui:description"> |
|
611 Sets up DOM and CustomEvent listeners for the widget. |
|
612 </div> |
|
613 |
|
614 <div class="description"> |
|
615 |
|
616 |
|
617 |
|
618 |
|
619 |
|
620 |
|
621 </div> |
|
622 |
|
623 </div> |
|
624 <hr /> |
|
625 </div> |
|
626 <div class="protected" rel="yui:method" resource="#method__defRenderFn"> |
|
627 <h4> |
|
628 <a name="method__defRenderFn">_defRenderFn</a></h4> |
|
629 <div class="detail" > |
|
630 <code> |
|
631 protected |
|
632 |
|
633 |
|
634 void |
|
635 <strong property="yui:name">_defRenderFn</strong> |
|
636 ( |
|
637 |
|
638 |
|
639 e |
|
640 |
|
641 |
|
642 , |
|
643 parentNode |
|
644 |
|
645 |
|
646 ) |
|
647 </code> |
|
648 |
|
649 <div class="description" property="yui:description"> |
|
650 Default render handler |
|
651 </div> |
|
652 |
|
653 <div class="description"> |
|
654 |
|
655 <dl rel="yui:parameters"> |
|
656 <dt>Parameters:</dt> |
|
657 <dd rel="yui:parameter"> |
|
658 <code><span property="yui:name">e</span> |
|
659 <<span property="yui:type">EventFacade</span>> |
|
660 </code> |
|
661 <span property="yui:description"> The Event object</span> |
|
662 </dd> |
|
663 <dd rel="yui:parameter"> |
|
664 <code><span property="yui:name">parentNode</span> |
|
665 <<span property="yui:type">Node</span>> |
|
666 </code> |
|
667 <span property="yui:description"> The parent node to render to, if passed in to the <code>render</code> method</span> |
|
668 </dd> |
|
669 </dl> |
|
670 |
|
671 |
|
672 |
|
673 |
|
674 |
|
675 </div> |
|
676 |
|
677 </div> |
|
678 <hr /> |
|
679 </div> |
|
680 <div class="" rel="yui:method" resource="#method__getHtmlParser"> |
|
681 <h4> |
|
682 <a name="method__getHtmlParser">_getHtmlParser</a></h4> |
|
683 <div class="detail" > |
|
684 <code> |
|
685 |
|
686 |
|
687 |
|
688 Object |
|
689 <strong property="yui:name">_getHtmlParser</strong> |
|
690 ( |
|
691 ) |
|
692 </code> |
|
693 |
|
694 <div class="description" property="yui:description"> |
|
695 Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER |
|
696 definitions across the class hierarchy. |
|
697 </div> |
|
698 |
|
699 <div class="description"> |
|
700 |
|
701 |
|
702 <dl> |
|
703 <dt>Returns: |
|
704 <code property="yui:return"> |
|
705 Object |
|
706 </code></dt> |
|
707 <dd property="yui:returnInfo">HTML_PARSER definition for this instance</dd> |
|
708 </dl> |
|
709 |
|
710 |
|
711 |
|
712 |
|
713 </div> |
|
714 |
|
715 </div> |
|
716 <hr /> |
|
717 </div> |
|
718 <div class="protected" rel="yui:method" resource="#method__getStrings"> |
|
719 <h4> |
|
720 <a name="method__getStrings">_getStrings</a></h4> |
|
721 <div class="detail" > |
|
722 <code> |
|
723 protected |
|
724 |
|
725 |
|
726 void |
|
727 <strong property="yui:name">_getStrings</strong> |
|
728 ( |
|
729 |
|
730 |
|
731 locale |
|
732 |
|
733 |
|
734 ) |
|
735 </code> |
|
736 |
|
737 <div class="description" property="yui:description"> |
|
738 Returns the strings key/value hash for a paricular locale, without locale lookup applied. |
|
739 </div> |
|
740 |
|
741 <div class="description"> |
|
742 |
|
743 <dl rel="yui:parameters"> |
|
744 <dt>Parameters:</dt> |
|
745 <dd rel="yui:parameter"> |
|
746 <code><span property="yui:name">locale</span> |
|
747 <<span property="yui:type">Object</span>> |
|
748 </code> |
|
749 <span property="yui:description"></span> |
|
750 </dd> |
|
751 </dl> |
|
752 |
|
753 |
|
754 |
|
755 |
|
756 |
|
757 </div> |
|
758 |
|
759 </div> |
|
760 <hr /> |
|
761 </div> |
|
762 <div class="private" rel="yui:method" resource="#method__moveStyles"> |
|
763 <h4> |
|
764 <a name="method__moveStyles">_moveStyles</a></h4> |
|
765 <div class="detail" > |
|
766 <code> |
|
767 private |
|
768 |
|
769 |
|
770 void |
|
771 <strong property="yui:name">_moveStyles</strong> |
|
772 ( |
|
773 |
|
774 |
|
775 nodeFrom |
|
776 |
|
777 |
|
778 , |
|
779 nodeTo |
|
780 |
|
781 |
|
782 ) |
|
783 </code> |
|
784 |
|
785 <div class="description" property="yui:description"> |
|
786 Moves a pre-defined set of style rules (WRAP_STYLES) from one node to another. |
|
787 </div> |
|
788 |
|
789 <div class="description"> |
|
790 |
|
791 <dl rel="yui:parameters"> |
|
792 <dt>Parameters:</dt> |
|
793 <dd rel="yui:parameter"> |
|
794 <code><span property="yui:name">nodeFrom</span> |
|
795 <<span property="yui:type">Node</span>> |
|
796 </code> |
|
797 <span property="yui:description"> The node to gather the styles from</span> |
|
798 </dd> |
|
799 <dd rel="yui:parameter"> |
|
800 <code><span property="yui:name">nodeTo</span> |
|
801 <<span property="yui:type">Node</span>> |
|
802 </code> |
|
803 <span property="yui:description"> The node to apply the styles to</span> |
|
804 </dd> |
|
805 </dl> |
|
806 |
|
807 |
|
808 |
|
809 |
|
810 |
|
811 </div> |
|
812 |
|
813 </div> |
|
814 <hr /> |
|
815 </div> |
|
816 <div class="protected" rel="yui:method" resource="#method__onDocMouseDown"> |
|
817 <h4> |
|
818 <a name="method__onDocMouseDown">_onDocMouseDown</a></h4> |
|
819 <div class="detail" > |
|
820 <code> |
|
821 protected |
|
822 |
|
823 |
|
824 void |
|
825 <strong property="yui:name">_onDocMouseDown</strong> |
|
826 ( |
|
827 |
|
828 |
|
829 evt |
|
830 |
|
831 |
|
832 ) |
|
833 </code> |
|
834 |
|
835 <div class="description" property="yui:description"> |
|
836 "mousedown" event handler for the owner document of the |
|
837 widget's bounding box. |
|
838 </div> |
|
839 |
|
840 <div class="description"> |
|
841 |
|
842 <dl rel="yui:parameters"> |
|
843 <dt>Parameters:</dt> |
|
844 <dd rel="yui:parameter"> |
|
845 <code><span property="yui:name">evt</span> |
|
846 <<span property="yui:type">EventFacade</span>> |
|
847 </code> |
|
848 <span property="yui:description"> The event facade for the DOM focus event</span> |
|
849 </dd> |
|
850 </dl> |
|
851 |
|
852 |
|
853 |
|
854 |
|
855 |
|
856 </div> |
|
857 |
|
858 </div> |
|
859 <hr /> |
|
860 </div> |
|
861 <div class="protected" rel="yui:method" resource="#method__onFocus"> |
|
862 <h4> |
|
863 <a name="method__onFocus">_onFocus</a></h4> |
|
864 <div class="detail" > |
|
865 <code> |
|
866 protected |
|
867 |
|
868 |
|
869 void |
|
870 <strong property="yui:name">_onFocus</strong> |
|
871 ( |
|
872 |
|
873 |
|
874 evt |
|
875 |
|
876 |
|
877 ) |
|
878 </code> |
|
879 |
|
880 <div class="description" property="yui:description"> |
|
881 DOM focus event handler, used to sync the state of the Widget with the DOM |
|
882 </div> |
|
883 |
|
884 <div class="description"> |
|
885 |
|
886 <dl rel="yui:parameters"> |
|
887 <dt>Parameters:</dt> |
|
888 <dd rel="yui:parameter"> |
|
889 <code><span property="yui:name">evt</span> |
|
890 <<span property="yui:type">EventFacade</span>> |
|
891 </code> |
|
892 <span property="yui:description"> The event facade for the DOM focus event</span> |
|
893 </dd> |
|
894 </dl> |
|
895 |
|
896 |
|
897 |
|
898 |
|
899 |
|
900 </div> |
|
901 |
|
902 </div> |
|
903 <hr /> |
|
904 </div> |
|
905 <div class="private" rel="yui:method" resource="#method__parseHTML"> |
|
906 <h4> |
|
907 <a name="method__parseHTML">_parseHTML</a></h4> |
|
908 <div class="detail" > |
|
909 <code> |
|
910 private |
|
911 |
|
912 |
|
913 Object |
|
914 <strong property="yui:name">_parseHTML</strong> |
|
915 ( |
|
916 |
|
917 |
|
918 node |
|
919 |
|
920 |
|
921 ) |
|
922 </code> |
|
923 |
|
924 <div class="description" property="yui:description"> |
|
925 Utilitity method used to apply the <code>HTML_PARSER</code> configuration for the |
|
926 instance, to retrieve config data values. |
|
927 </div> |
|
928 |
|
929 <div class="description"> |
|
930 |
|
931 <dl rel="yui:parameters"> |
|
932 <dt>Parameters:</dt> |
|
933 <dd rel="yui:parameter"> |
|
934 <code><span property="yui:name">node</span> |
|
935 <<span property="yui:type">Node</span>> |
|
936 </code> |
|
937 <span property="yui:description"> Root node to use to parse markup for configuration data</span> |
|
938 </dd> |
|
939 </dl> |
|
940 |
|
941 <dl> |
|
942 <dt>Returns: |
|
943 <code property="yui:return"> |
|
944 Object |
|
945 </code></dt> |
|
946 <dd property="yui:returnInfo">config configuration object, with values found in the HTML, populated</dd> |
|
947 </dl> |
|
948 |
|
949 |
|
950 |
|
951 |
|
952 </div> |
|
953 |
|
954 </div> |
|
955 <hr /> |
|
956 </div> |
|
957 <div class="private" rel="yui:method" resource="#method__renderBox"> |
|
958 <h4> |
|
959 <a name="method__renderBox">_renderBox</a></h4> |
|
960 <div class="detail" > |
|
961 <code> |
|
962 private |
|
963 |
|
964 |
|
965 void |
|
966 <strong property="yui:name">_renderBox</strong> |
|
967 ( |
|
968 |
|
969 |
|
970 parentNode |
|
971 |
|
972 |
|
973 ) |
|
974 </code> |
|
975 |
|
976 <div class="description" property="yui:description"> |
|
977 Helper method to collect the boundingBox and contentBox, set styles and append to the provided parentNode, if not |
|
978 already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used |
|
979 as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and |
|
980 the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered |
|
981 to the current document's body. |
|
982 </div> |
|
983 |
|
984 <div class="description"> |
|
985 |
|
986 <dl rel="yui:parameters"> |
|
987 <dt>Parameters:</dt> |
|
988 <dd rel="yui:parameter"> |
|
989 <code><span property="yui:name">parentNode</span> |
|
990 <<span property="yui:type">Node</span>> |
|
991 </code> |
|
992 <span property="yui:description"> The parentNode to render the widget to. If not provided, and both the boundingBox and |
|
993 the contentBox are not currently in the document, the widget will be rendered to the current document's body.</span> |
|
994 </dd> |
|
995 </dl> |
|
996 |
|
997 |
|
998 |
|
999 |
|
1000 |
|
1001 </div> |
|
1002 |
|
1003 </div> |
|
1004 <hr /> |
|
1005 </div> |
|
1006 <div class="protected" rel="yui:method" resource="#method__renderBoxClassNames"> |
|
1007 <h4> |
|
1008 <a name="method__renderBoxClassNames">_renderBoxClassNames</a></h4> |
|
1009 <div class="detail" > |
|
1010 <code> |
|
1011 protected |
|
1012 |
|
1013 |
|
1014 void |
|
1015 <strong property="yui:name">_renderBoxClassNames</strong> |
|
1016 ( |
|
1017 ) |
|
1018 </code> |
|
1019 |
|
1020 <div class="description" property="yui:description"> |
|
1021 Applies standard class names to the boundingBox and contentBox |
|
1022 </div> |
|
1023 |
|
1024 <div class="description"> |
|
1025 |
|
1026 |
|
1027 |
|
1028 |
|
1029 |
|
1030 |
|
1031 </div> |
|
1032 |
|
1033 </div> |
|
1034 <hr /> |
|
1035 </div> |
|
1036 <div class="protected" rel="yui:method" resource="#method__renderUI"> |
|
1037 <h4> |
|
1038 <a name="method__renderUI">_renderUI</a></h4> |
|
1039 <div class="detail" > |
|
1040 <code> |
|
1041 protected |
|
1042 |
|
1043 |
|
1044 void |
|
1045 <strong property="yui:name">_renderUI</strong> |
|
1046 ( |
|
1047 |
|
1048 |
|
1049 The |
|
1050 |
|
1051 |
|
1052 ) |
|
1053 </code> |
|
1054 |
|
1055 <div class="description" property="yui:description"> |
|
1056 Initializes the UI state for the Widget's bounding/content boxes. |
|
1057 </div> |
|
1058 |
|
1059 <div class="description"> |
|
1060 |
|
1061 <dl rel="yui:parameters"> |
|
1062 <dt>Parameters:</dt> |
|
1063 <dd rel="yui:parameter"> |
|
1064 <code><span property="yui:name">The</span> |
|
1065 <<span property="yui:type">Node</span>> |
|
1066 </code> |
|
1067 <span property="yui:description"> parent node to rendering the widget into</span> |
|
1068 </dd> |
|
1069 </dl> |
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 |
|
1075 </div> |
|
1076 |
|
1077 </div> |
|
1078 <hr /> |
|
1079 </div> |
|
1080 <div class="private" rel="yui:method" resource="#method__setBoundingBox"> |
|
1081 <h4> |
|
1082 <a name="method__setBoundingBox">_setBoundingBox</a></h4> |
|
1083 <div class="detail" > |
|
1084 <code> |
|
1085 private |
|
1086 |
|
1087 |
|
1088 |
|
1089 <strong property="yui:name">_setBoundingBox</strong> |
|
1090 ( |
|
1091 |
|
1092 |
|
1093 Node/String |
|
1094 |
|
1095 |
|
1096 ) |
|
1097 </code> |
|
1098 |
|
1099 <div class="description" property="yui:description"> |
|
1100 Setter for the boundingBox attribute |
|
1101 </div> |
|
1102 |
|
1103 <div class="description"> |
|
1104 |
|
1105 <dl rel="yui:parameters"> |
|
1106 <dt>Parameters:</dt> |
|
1107 <dd rel="yui:parameter"> |
|
1108 <code><span property="yui:name">Node/String</span> |
|
1109 <<span property="yui:type">object</span>> |
|
1110 </code> |
|
1111 <span property="yui:description"></span> |
|
1112 </dd> |
|
1113 </dl> |
|
1114 |
|
1115 <dl> |
|
1116 <dt>Returns: |
|
1117 <code property="yui:return"> |
|
1118 </code></dt> |
|
1119 <dd property="yui:returnInfo">Node</dd> |
|
1120 </dl> |
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 </div> |
|
1126 |
|
1127 </div> |
|
1128 <hr /> |
|
1129 </div> |
|
1130 <div class="private" rel="yui:method" resource="#method__setBox"> |
|
1131 <h4> |
|
1132 <a name="method__setBox">_setBox</a></h4> |
|
1133 <div class="detail" > |
|
1134 <code> |
|
1135 private |
|
1136 |
|
1137 |
|
1138 Node |
|
1139 <strong property="yui:name">_setBox</strong> |
|
1140 ( |
|
1141 |
|
1142 |
|
1143 node |
|
1144 |
|
1145 |
|
1146 , |
|
1147 template |
|
1148 |
|
1149 |
|
1150 ) |
|
1151 </code> |
|
1152 |
|
1153 <div class="description" property="yui:description"> |
|
1154 Helper method to set the bounding/content box, or create it from |
|
1155 the provided template if not found. |
|
1156 </div> |
|
1157 |
|
1158 <div class="description"> |
|
1159 |
|
1160 <dl rel="yui:parameters"> |
|
1161 <dt>Parameters:</dt> |
|
1162 <dd rel="yui:parameter"> |
|
1163 <code><span property="yui:name">node</span> |
|
1164 <<span property="yui:type">Node|String</span>> |
|
1165 </code> |
|
1166 <span property="yui:description"> The node reference</span> |
|
1167 </dd> |
|
1168 <dd rel="yui:parameter"> |
|
1169 <code><span property="yui:name">template</span> |
|
1170 <<span property="yui:type">String</span>> |
|
1171 </code> |
|
1172 <span property="yui:description"> HTML string template for the node</span> |
|
1173 </dd> |
|
1174 </dl> |
|
1175 |
|
1176 <dl> |
|
1177 <dt>Returns: |
|
1178 <code property="yui:return"> |
|
1179 Node |
|
1180 </code></dt> |
|
1181 <dd property="yui:returnInfo">The node</dd> |
|
1182 </dl> |
|
1183 |
|
1184 |
|
1185 |
|
1186 |
|
1187 </div> |
|
1188 |
|
1189 </div> |
|
1190 <hr /> |
|
1191 </div> |
|
1192 <div class="private" rel="yui:method" resource="#method__setContentBox"> |
|
1193 <h4> |
|
1194 <a name="method__setContentBox">_setContentBox</a></h4> |
|
1195 <div class="detail" > |
|
1196 <code> |
|
1197 private |
|
1198 |
|
1199 |
|
1200 |
|
1201 <strong property="yui:name">_setContentBox</strong> |
|
1202 ( |
|
1203 |
|
1204 |
|
1205 node |
|
1206 |
|
1207 |
|
1208 ) |
|
1209 </code> |
|
1210 |
|
1211 <div class="description" property="yui:description"> |
|
1212 Setter for the contentBox attribute |
|
1213 </div> |
|
1214 |
|
1215 <div class="description"> |
|
1216 |
|
1217 <dl rel="yui:parameters"> |
|
1218 <dt>Parameters:</dt> |
|
1219 <dd rel="yui:parameter"> |
|
1220 <code><span property="yui:name">node</span> |
|
1221 <<span property="yui:type">Node|String</span>> |
|
1222 </code> |
|
1223 <span property="yui:description"></span> |
|
1224 </dd> |
|
1225 </dl> |
|
1226 |
|
1227 <dl> |
|
1228 <dt>Returns: |
|
1229 <code property="yui:return"> |
|
1230 </code></dt> |
|
1231 <dd property="yui:returnInfo">Node</dd> |
|
1232 </dl> |
|
1233 |
|
1234 |
|
1235 |
|
1236 |
|
1237 </div> |
|
1238 |
|
1239 </div> |
|
1240 <hr /> |
|
1241 </div> |
|
1242 <div class="protected" rel="yui:method" resource="#method__setStrings"> |
|
1243 <h4> |
|
1244 <a name="method__setStrings">_setStrings</a></h4> |
|
1245 <div class="detail" > |
|
1246 <code> |
|
1247 protected |
|
1248 |
|
1249 |
|
1250 void |
|
1251 <strong property="yui:name">_setStrings</strong> |
|
1252 ( |
|
1253 |
|
1254 |
|
1255 strings |
|
1256 |
|
1257 |
|
1258 , |
|
1259 locale |
|
1260 |
|
1261 |
|
1262 ) |
|
1263 </code> |
|
1264 |
|
1265 <div class="description" property="yui:description"> |
|
1266 Sets strings for a particular locale, merging with any existing |
|
1267 strings which may already be defined for the locale. |
|
1268 </div> |
|
1269 |
|
1270 <div class="description"> |
|
1271 |
|
1272 <dl rel="yui:parameters"> |
|
1273 <dt>Parameters:</dt> |
|
1274 <dd rel="yui:parameter"> |
|
1275 <code><span property="yui:name">strings</span> |
|
1276 <<span property="yui:type">Object</span>> |
|
1277 </code> |
|
1278 <span property="yui:description"> The hash of string key/values to set</span> |
|
1279 </dd> |
|
1280 <dd rel="yui:parameter"> |
|
1281 <code><span property="yui:name">locale</span> |
|
1282 <<span property="yui:type">Object</span>> |
|
1283 </code> |
|
1284 <span property="yui:description"> The locale for the string values being set</span> |
|
1285 </dd> |
|
1286 </dl> |
|
1287 |
|
1288 |
|
1289 |
|
1290 |
|
1291 |
|
1292 </div> |
|
1293 |
|
1294 </div> |
|
1295 <hr /> |
|
1296 </div> |
|
1297 <div class="protected" rel="yui:method" resource="#method__syncUI"> |
|
1298 <h4> |
|
1299 <a name="method__syncUI">_syncUI</a></h4> |
|
1300 <div class="detail" > |
|
1301 <code> |
|
1302 protected |
|
1303 |
|
1304 |
|
1305 void |
|
1306 <strong property="yui:name">_syncUI</strong> |
|
1307 ( |
|
1308 ) |
|
1309 </code> |
|
1310 |
|
1311 <div class="description" property="yui:description"> |
|
1312 Updates the widget UI to reflect the attribute state. |
|
1313 </div> |
|
1314 |
|
1315 <div class="description"> |
|
1316 |
|
1317 |
|
1318 |
|
1319 |
|
1320 |
|
1321 |
|
1322 </div> |
|
1323 |
|
1324 </div> |
|
1325 <hr /> |
|
1326 </div> |
|
1327 <div class="protected" rel="yui:method" resource="#method__uiSetDisabled"> |
|
1328 <h4> |
|
1329 <a name="method__uiSetDisabled">_uiSetDisabled</a></h4> |
|
1330 <div class="detail" > |
|
1331 <code> |
|
1332 protected |
|
1333 |
|
1334 |
|
1335 void |
|
1336 <strong property="yui:name">_uiSetDisabled</strong> |
|
1337 ( |
|
1338 |
|
1339 |
|
1340 val |
|
1341 |
|
1342 |
|
1343 ) |
|
1344 </code> |
|
1345 |
|
1346 <div class="description" property="yui:description"> |
|
1347 Sets the disabled state for the UI |
|
1348 </div> |
|
1349 |
|
1350 <div class="description"> |
|
1351 |
|
1352 <dl rel="yui:parameters"> |
|
1353 <dt>Parameters:</dt> |
|
1354 <dd rel="yui:parameter"> |
|
1355 <code><span property="yui:name">val</span> |
|
1356 <<span property="yui:type">boolean</span>> |
|
1357 </code> |
|
1358 <span property="yui:description"></span> |
|
1359 </dd> |
|
1360 </dl> |
|
1361 |
|
1362 |
|
1363 |
|
1364 |
|
1365 |
|
1366 </div> |
|
1367 |
|
1368 </div> |
|
1369 <hr /> |
|
1370 </div> |
|
1371 <div class="protected" rel="yui:method" resource="#method__uiSetFocused"> |
|
1372 <h4> |
|
1373 <a name="method__uiSetFocused">_uiSetFocused</a></h4> |
|
1374 <div class="detail" > |
|
1375 <code> |
|
1376 protected |
|
1377 |
|
1378 |
|
1379 void |
|
1380 <strong property="yui:name">_uiSetFocused</strong> |
|
1381 ( |
|
1382 |
|
1383 |
|
1384 val |
|
1385 |
|
1386 |
|
1387 , |
|
1388 src |
|
1389 |
|
1390 |
|
1391 ) |
|
1392 </code> |
|
1393 |
|
1394 <div class="description" property="yui:description"> |
|
1395 Sets the focused state for the UI |
|
1396 </div> |
|
1397 |
|
1398 <div class="description"> |
|
1399 |
|
1400 <dl rel="yui:parameters"> |
|
1401 <dt>Parameters:</dt> |
|
1402 <dd rel="yui:parameter"> |
|
1403 <code><span property="yui:name">val</span> |
|
1404 <<span property="yui:type">boolean</span>> |
|
1405 </code> |
|
1406 <span property="yui:description"></span> |
|
1407 </dd> |
|
1408 <dd rel="yui:parameter"> |
|
1409 <code><span property="yui:name">src</span> |
|
1410 <<span property="yui:type">string</span>> |
|
1411 </code> |
|
1412 <span property="yui:description"> String representing the source that triggered an update to |
|
1413 the UI.</span> |
|
1414 </dd> |
|
1415 </dl> |
|
1416 |
|
1417 |
|
1418 |
|
1419 |
|
1420 |
|
1421 </div> |
|
1422 |
|
1423 </div> |
|
1424 <hr /> |
|
1425 </div> |
|
1426 <div class="protected" rel="yui:method" resource="#method__uiSetHeight"> |
|
1427 <h4> |
|
1428 <a name="method__uiSetHeight">_uiSetHeight</a></h4> |
|
1429 <div class="detail" > |
|
1430 <code> |
|
1431 protected |
|
1432 |
|
1433 |
|
1434 void |
|
1435 <strong property="yui:name">_uiSetHeight</strong> |
|
1436 ( |
|
1437 |
|
1438 |
|
1439 val |
|
1440 |
|
1441 |
|
1442 ) |
|
1443 </code> |
|
1444 |
|
1445 <div class="description" property="yui:description"> |
|
1446 Sets the height on the widget's bounding box element |
|
1447 </div> |
|
1448 |
|
1449 <div class="description"> |
|
1450 |
|
1451 <dl rel="yui:parameters"> |
|
1452 <dt>Parameters:</dt> |
|
1453 <dd rel="yui:parameter"> |
|
1454 <code><span property="yui:name">val</span> |
|
1455 <<span property="yui:type">String | Number</span>> |
|
1456 </code> |
|
1457 <span property="yui:description"></span> |
|
1458 </dd> |
|
1459 </dl> |
|
1460 |
|
1461 |
|
1462 |
|
1463 |
|
1464 |
|
1465 </div> |
|
1466 |
|
1467 </div> |
|
1468 <hr /> |
|
1469 </div> |
|
1470 <div class="protected" rel="yui:method" resource="#method__uiSetTabIndex"> |
|
1471 <h4> |
|
1472 <a name="method__uiSetTabIndex">_uiSetTabIndex</a></h4> |
|
1473 <div class="detail" > |
|
1474 <code> |
|
1475 protected |
|
1476 |
|
1477 |
|
1478 void |
|
1479 <strong property="yui:name">_uiSetTabIndex</strong> |
|
1480 ( |
|
1481 |
|
1482 |
|
1483 Number |
|
1484 |
|
1485 |
|
1486 ) |
|
1487 </code> |
|
1488 |
|
1489 <div class="description" property="yui:description"> |
|
1490 Set the tabIndex on the widget's rendered UI |
|
1491 </div> |
|
1492 |
|
1493 <div class="description"> |
|
1494 |
|
1495 <dl rel="yui:parameters"> |
|
1496 <dt>Parameters:</dt> |
|
1497 <dd rel="yui:parameter"> |
|
1498 <code><span property="yui:name">Number</span> |
|
1499 <<span property="yui:type">object</span>> |
|
1500 </code> |
|
1501 <span property="yui:description"></span> |
|
1502 </dd> |
|
1503 </dl> |
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 </div> |
|
1510 |
|
1511 </div> |
|
1512 <hr /> |
|
1513 </div> |
|
1514 <div class="protected" rel="yui:method" resource="#method__uiSetVisible"> |
|
1515 <h4> |
|
1516 <a name="method__uiSetVisible">_uiSetVisible</a></h4> |
|
1517 <div class="detail" > |
|
1518 <code> |
|
1519 protected |
|
1520 |
|
1521 |
|
1522 void |
|
1523 <strong property="yui:name">_uiSetVisible</strong> |
|
1524 ( |
|
1525 |
|
1526 |
|
1527 val |
|
1528 |
|
1529 |
|
1530 ) |
|
1531 </code> |
|
1532 |
|
1533 <div class="description" property="yui:description"> |
|
1534 Sets the visible state for the UI |
|
1535 </div> |
|
1536 |
|
1537 <div class="description"> |
|
1538 |
|
1539 <dl rel="yui:parameters"> |
|
1540 <dt>Parameters:</dt> |
|
1541 <dd rel="yui:parameter"> |
|
1542 <code><span property="yui:name">val</span> |
|
1543 <<span property="yui:type">boolean</span>> |
|
1544 </code> |
|
1545 <span property="yui:description"></span> |
|
1546 </dd> |
|
1547 </dl> |
|
1548 |
|
1549 |
|
1550 |
|
1551 |
|
1552 |
|
1553 </div> |
|
1554 |
|
1555 </div> |
|
1556 <hr /> |
|
1557 </div> |
|
1558 <div class="protected" rel="yui:method" resource="#method__uiSetWidth"> |
|
1559 <h4> |
|
1560 <a name="method__uiSetWidth">_uiSetWidth</a></h4> |
|
1561 <div class="detail" > |
|
1562 <code> |
|
1563 protected |
|
1564 |
|
1565 |
|
1566 void |
|
1567 <strong property="yui:name">_uiSetWidth</strong> |
|
1568 ( |
|
1569 |
|
1570 |
|
1571 val |
|
1572 |
|
1573 |
|
1574 ) |
|
1575 </code> |
|
1576 |
|
1577 <div class="description" property="yui:description"> |
|
1578 Sets the width on the widget's bounding box element |
|
1579 </div> |
|
1580 |
|
1581 <div class="description"> |
|
1582 |
|
1583 <dl rel="yui:parameters"> |
|
1584 <dt>Parameters:</dt> |
|
1585 <dd rel="yui:parameter"> |
|
1586 <code><span property="yui:name">val</span> |
|
1587 <<span property="yui:type">String | Number</span>> |
|
1588 </code> |
|
1589 <span property="yui:description"></span> |
|
1590 </dd> |
|
1591 </dl> |
|
1592 |
|
1593 |
|
1594 |
|
1595 |
|
1596 |
|
1597 </div> |
|
1598 |
|
1599 </div> |
|
1600 <hr /> |
|
1601 </div> |
|
1602 <div class="protected" rel="yui:method" resource="#method_bindUI"> |
|
1603 <h4> |
|
1604 <a name="method_bindUI">bindUI</a></h4> |
|
1605 <div class="detail" > |
|
1606 <code> |
|
1607 protected |
|
1608 |
|
1609 |
|
1610 void |
|
1611 <strong property="yui:name">bindUI</strong> |
|
1612 ( |
|
1613 ) |
|
1614 </code> |
|
1615 |
|
1616 <div class="description" property="yui:description"> |
|
1617 Configures/Sets up listeners to bind Widget State to UI/DOM |
|
1618 This method is not called by framework and is not chained |
|
1619 automatically for the class hierarchy. |
|
1620 </div> |
|
1621 |
|
1622 <div class="description"> |
|
1623 |
|
1624 |
|
1625 |
|
1626 |
|
1627 |
|
1628 |
|
1629 </div> |
|
1630 |
|
1631 </div> |
|
1632 <hr /> |
|
1633 </div> |
|
1634 <div class="" rel="yui:method" resource="#method_blur"> |
|
1635 <h4> |
|
1636 <a name="method_blur">blur</a></h4> |
|
1637 <div class="detail" > |
|
1638 <code> |
|
1639 |
|
1640 |
|
1641 |
|
1642 void |
|
1643 <strong property="yui:name">blur</strong> |
|
1644 ( |
|
1645 ) |
|
1646 </code> |
|
1647 |
|
1648 <div class="description" property="yui:description"> |
|
1649 Causes the Widget to lose focus by setting the "focused" attribute |
|
1650 to "false" |
|
1651 </div> |
|
1652 |
|
1653 <div class="description"> |
|
1654 |
|
1655 |
|
1656 |
|
1657 |
|
1658 |
|
1659 |
|
1660 </div> |
|
1661 |
|
1662 </div> |
|
1663 <hr /> |
|
1664 </div> |
|
1665 <div class="protected" rel="yui:method" resource="#method_destructor"> |
|
1666 <h4> |
|
1667 <a name="method_destructor">destructor</a></h4> |
|
1668 <div class="detail" > |
|
1669 <code> |
|
1670 protected |
|
1671 |
|
1672 |
|
1673 void |
|
1674 <strong property="yui:name">destructor</strong> |
|
1675 ( |
|
1676 ) |
|
1677 </code> |
|
1678 |
|
1679 <div class="description" property="yui:description"> |
|
1680 Descructor lifecycle implementation for the Widget class. Purges events attached |
|
1681 to the bounding box (and all child nodes) and removes the Widget from the |
|
1682 list of registered widgets. |
|
1683 </div> |
|
1684 |
|
1685 <div class="description"> |
|
1686 |
|
1687 |
|
1688 |
|
1689 |
|
1690 |
|
1691 |
|
1692 </div> |
|
1693 |
|
1694 </div> |
|
1695 <hr /> |
|
1696 </div> |
|
1697 <div class="" rel="yui:method" resource="#method_disabled"> |
|
1698 <h4> |
|
1699 <a name="method_disabled">disabled</a></h4> |
|
1700 <div class="detail" > |
|
1701 <code> |
|
1702 |
|
1703 |
|
1704 |
|
1705 void |
|
1706 <strong property="yui:name">disabled</strong> |
|
1707 ( |
|
1708 ) |
|
1709 </code> |
|
1710 |
|
1711 <div class="description" property="yui:description"> |
|
1712 Set the Widget's "disabled" attribute to "true". |
|
1713 </div> |
|
1714 |
|
1715 <div class="description"> |
|
1716 |
|
1717 |
|
1718 |
|
1719 |
|
1720 |
|
1721 |
|
1722 </div> |
|
1723 |
|
1724 </div> |
|
1725 <hr /> |
|
1726 </div> |
|
1727 <div class="" rel="yui:method" resource="#method_enable"> |
|
1728 <h4> |
|
1729 <a name="method_enable">enable</a></h4> |
|
1730 <div class="detail" > |
|
1731 <code> |
|
1732 |
|
1733 |
|
1734 |
|
1735 void |
|
1736 <strong property="yui:name">enable</strong> |
|
1737 ( |
|
1738 ) |
|
1739 </code> |
|
1740 |
|
1741 <div class="description" property="yui:description"> |
|
1742 Set the Widget's "disabled" attribute to "false". |
|
1743 </div> |
|
1744 |
|
1745 <div class="description"> |
|
1746 |
|
1747 |
|
1748 |
|
1749 |
|
1750 |
|
1751 |
|
1752 </div> |
|
1753 |
|
1754 </div> |
|
1755 <hr /> |
|
1756 </div> |
|
1757 <div class="" rel="yui:method" resource="#method_focus"> |
|
1758 <h4> |
|
1759 <a name="method_focus">focus</a></h4> |
|
1760 <div class="detail" > |
|
1761 <code> |
|
1762 |
|
1763 |
|
1764 |
|
1765 void |
|
1766 <strong property="yui:name">focus</strong> |
|
1767 ( |
|
1768 ) |
|
1769 </code> |
|
1770 |
|
1771 <div class="description" property="yui:description"> |
|
1772 Causes the Widget to receive the focus by setting the "focused" |
|
1773 attribute to "true". |
|
1774 </div> |
|
1775 |
|
1776 <div class="description"> |
|
1777 |
|
1778 |
|
1779 |
|
1780 |
|
1781 |
|
1782 |
|
1783 </div> |
|
1784 |
|
1785 </div> |
|
1786 <hr /> |
|
1787 </div> |
|
1788 <div class="" rel="yui:method" resource="#method_getClassName"> |
|
1789 <h4> |
|
1790 <a name="method_getClassName">getClassName</a></h4> |
|
1791 <div class="detail" > |
|
1792 <code> |
|
1793 |
|
1794 |
|
1795 |
|
1796 void |
|
1797 <strong property="yui:name">getClassName</strong> |
|
1798 ( |
|
1799 |
|
1800 |
|
1801 args* |
|
1802 |
|
1803 |
|
1804 ) |
|
1805 </code> |
|
1806 |
|
1807 <div class="description" property="yui:description"> |
|
1808 Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined |
|
1809 by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and |
|
1810 <code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for |
|
1811 the prefix and widget class name). |
|
1812 <p> |
|
1813 The instance based version of this method can be used to generate standard prefixed classnames, |
|
1814 based on the instances NAME, as opposed to Widget.NAME. This method should be used when you |
|
1815 need to use a constant class name across different types instances. |
|
1816 </p> |
|
1817 </div> |
|
1818 |
|
1819 <div class="description"> |
|
1820 |
|
1821 <dl rel="yui:parameters"> |
|
1822 <dt>Parameters:</dt> |
|
1823 <dd rel="yui:parameter"> |
|
1824 <code><span property="yui:name">args*</span> |
|
1825 <<span property="yui:type">String*</span>> |
|
1826 </code> |
|
1827 <span property="yui:description"> 0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</span> |
|
1828 </dd> |
|
1829 </dl> |
|
1830 |
|
1831 |
|
1832 |
|
1833 |
|
1834 |
|
1835 </div> |
|
1836 |
|
1837 </div> |
|
1838 <hr /> |
|
1839 </div> |
|
1840 <div class="" rel="yui:method" resource="#method_getDefaultLocale"> |
|
1841 <h4> |
|
1842 <a name="method_getDefaultLocale">getDefaultLocale</a></h4> |
|
1843 <div class="detail" > |
|
1844 <code> |
|
1845 |
|
1846 |
|
1847 |
|
1848 String |
|
1849 <strong property="yui:name">getDefaultLocale</strong> |
|
1850 ( |
|
1851 ) |
|
1852 </code> |
|
1853 |
|
1854 <div class="description" property="yui:description"> |
|
1855 Returns the default locale for the widget (the locale value defined by the |
|
1856 widget class, or provided by the user during construction). |
|
1857 </div> |
|
1858 |
|
1859 <div class="description"> |
|
1860 |
|
1861 |
|
1862 <dl> |
|
1863 <dt>Returns: |
|
1864 <code property="yui:return"> |
|
1865 String |
|
1866 </code></dt> |
|
1867 <dd property="yui:returnInfo">The default locale for the widget</dd> |
|
1868 </dl> |
|
1869 |
|
1870 |
|
1871 |
|
1872 |
|
1873 </div> |
|
1874 |
|
1875 </div> |
|
1876 <hr /> |
|
1877 </div> |
|
1878 <div class="" rel="yui:method" resource="#method_getString"> |
|
1879 <h4> |
|
1880 <a name="method_getString">getString</a></h4> |
|
1881 <div class="detail" > |
|
1882 <code> |
|
1883 |
|
1884 |
|
1885 |
|
1886 void |
|
1887 <strong property="yui:name">getString</strong> |
|
1888 ( |
|
1889 |
|
1890 |
|
1891 key |
|
1892 |
|
1893 |
|
1894 , |
|
1895 locale |
|
1896 |
|
1897 |
|
1898 ) |
|
1899 </code> |
|
1900 |
|
1901 <div class="description" property="yui:description"> |
|
1902 Gets the string for a particular key, for a particular locale, performing locale lookup. |
|
1903 <p> |
|
1904 If no values if defined for the key, for the given locale, the value for the |
|
1905 default locale (in initial locale set for the class) is returned. |
|
1906 </p> |
|
1907 </div> |
|
1908 |
|
1909 <div class="description"> |
|
1910 |
|
1911 <dl rel="yui:parameters"> |
|
1912 <dt>Parameters:</dt> |
|
1913 <dd rel="yui:parameter"> |
|
1914 <code><span property="yui:name">key</span> |
|
1915 <<span property="yui:type">String</span>> |
|
1916 </code> |
|
1917 <span property="yui:description"> The key.</span> |
|
1918 </dd> |
|
1919 <dd rel="yui:parameter"> |
|
1920 <code><span property="yui:name">locale</span> |
|
1921 <<span property="yui:type">String</span>> |
|
1922 </code> |
|
1923 <span property="yui:description"> (optional) The locale for which the string value is required. Defaults to the current locale, if not provided.</span> |
|
1924 </dd> |
|
1925 </dl> |
|
1926 |
|
1927 |
|
1928 |
|
1929 |
|
1930 |
|
1931 </div> |
|
1932 |
|
1933 </div> |
|
1934 <hr /> |
|
1935 </div> |
|
1936 <div class="" rel="yui:method" resource="#method_getStrings"> |
|
1937 <h4> |
|
1938 <a name="method_getStrings">getStrings</a></h4> |
|
1939 <div class="detail" > |
|
1940 <code> |
|
1941 |
|
1942 |
|
1943 |
|
1944 void |
|
1945 <strong property="yui:name">getStrings</strong> |
|
1946 ( |
|
1947 |
|
1948 |
|
1949 locale |
|
1950 |
|
1951 |
|
1952 ) |
|
1953 </code> |
|
1954 |
|
1955 <div class="description" property="yui:description"> |
|
1956 Gets the entire strings hash for a particular locale, performing locale lookup. |
|
1957 <p> |
|
1958 If no values of the key are defined for a particular locale the value for the |
|
1959 default locale (in initial locale set for the class) is returned. |
|
1960 </p> |
|
1961 </div> |
|
1962 |
|
1963 <div class="description"> |
|
1964 |
|
1965 <dl rel="yui:parameters"> |
|
1966 <dt>Parameters:</dt> |
|
1967 <dd rel="yui:parameter"> |
|
1968 <code><span property="yui:name">locale</span> |
|
1969 <<span property="yui:type">String</span>> |
|
1970 </code> |
|
1971 <span property="yui:description"> (optional) The locale for which the string value is required. Defaults to the current locale, if not provided.</span> |
|
1972 </dd> |
|
1973 </dl> |
|
1974 |
|
1975 |
|
1976 |
|
1977 |
|
1978 |
|
1979 </div> |
|
1980 |
|
1981 </div> |
|
1982 <hr /> |
|
1983 </div> |
|
1984 <div class="" rel="yui:method" resource="#method_hide"> |
|
1985 <h4> |
|
1986 <a name="method_hide">hide</a></h4> |
|
1987 <div class="detail" > |
|
1988 <code> |
|
1989 |
|
1990 |
|
1991 |
|
1992 void |
|
1993 <strong property="yui:name">hide</strong> |
|
1994 ( |
|
1995 ) |
|
1996 </code> |
|
1997 |
|
1998 <div class="description" property="yui:description"> |
|
1999 Shows the Module element by setting the "visible" attribute to "false". |
|
2000 </div> |
|
2001 |
|
2002 <div class="description"> |
|
2003 |
|
2004 |
|
2005 |
|
2006 |
|
2007 |
|
2008 |
|
2009 </div> |
|
2010 |
|
2011 </div> |
|
2012 <hr /> |
|
2013 </div> |
|
2014 <div class="protected" rel="yui:method" resource="#method_initializer"> |
|
2015 <h4> |
|
2016 <a name="method_initializer">initializer</a></h4> |
|
2017 <div class="detail" > |
|
2018 <code> |
|
2019 protected |
|
2020 |
|
2021 |
|
2022 void |
|
2023 <strong property="yui:name">initializer</strong> |
|
2024 ( |
|
2025 |
|
2026 |
|
2027 config |
|
2028 |
|
2029 |
|
2030 ) |
|
2031 </code> |
|
2032 |
|
2033 <div class="description" property="yui:description"> |
|
2034 Initializer lifecycle implementation for the Widget class. Registers the |
|
2035 widget instance, and runs through the Widget's HTML_PARSER definition. |
|
2036 </div> |
|
2037 |
|
2038 <div class="description"> |
|
2039 |
|
2040 <dl rel="yui:parameters"> |
|
2041 <dt>Parameters:</dt> |
|
2042 <dd rel="yui:parameter"> |
|
2043 <code><span property="yui:name">config</span> |
|
2044 <<span property="yui:type">Object</span>> |
|
2045 </code> |
|
2046 <span property="yui:description"> Configuration object literal for the widget</span> |
|
2047 </dd> |
|
2048 </dl> |
|
2049 |
|
2050 |
|
2051 |
|
2052 |
|
2053 |
|
2054 </div> |
|
2055 |
|
2056 </div> |
|
2057 <hr /> |
|
2058 </div> |
|
2059 <div class="" rel="yui:method" resource="#method_render"> |
|
2060 <h4> |
|
2061 <a name="method_render">render</a></h4> |
|
2062 <div class="detail" > |
|
2063 <code> |
|
2064 |
|
2065 |
|
2066 final |
|
2067 void |
|
2068 <strong property="yui:name">render</strong> |
|
2069 ( |
|
2070 |
|
2071 |
|
2072 parentNode |
|
2073 |
|
2074 |
|
2075 ) |
|
2076 </code> |
|
2077 |
|
2078 <div class="description" property="yui:description"> |
|
2079 Establishes the initial DOM for the widget. Invoking this |
|
2080 method will lead to the creating of all DOM elements for |
|
2081 the widget (or the manipulation of existing DOM elements |
|
2082 for the progressive enhancement use case). |
|
2083 <p> |
|
2084 This method should only be invoked once for an initialized |
|
2085 widget. |
|
2086 </p> |
|
2087 <p> |
|
2088 It delegates to the widget specific renderer method to do |
|
2089 the actual work. |
|
2090 </p> |
|
2091 </div> |
|
2092 |
|
2093 <div class="description"> |
|
2094 |
|
2095 <dl rel="yui:parameters"> |
|
2096 <dt>Parameters:</dt> |
|
2097 <dd rel="yui:parameter"> |
|
2098 <code><span property="yui:name">parentNode</span> |
|
2099 <<span property="yui:type">Object | String</span>> |
|
2100 </code> |
|
2101 <span property="yui:description"> Optional. The Node under which the |
|
2102 Widget is to be rendered. This can be a Node instance or a CSS selector string. |
|
2103 <p> |
|
2104 If the selector string returns more than one Node, the first node will be used |
|
2105 as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox |
|
2106 are not currently in the document. If it's not provided, the Widget will be rendered |
|
2107 to the body of the current document in this case. |
|
2108 </p></span> |
|
2109 </dd> |
|
2110 </dl> |
|
2111 |
|
2112 |
|
2113 <div class="chainable"> |
|
2114 <strong>Chainable:</strong> This method is chainable. |
|
2115 </div> |
|
2116 |
|
2117 |
|
2118 |
|
2119 </div> |
|
2120 |
|
2121 </div> |
|
2122 <hr /> |
|
2123 </div> |
|
2124 <div class="protected" rel="yui:method" resource="#method_renderer"> |
|
2125 <h4> |
|
2126 <a name="method_renderer">renderer</a></h4> |
|
2127 <div class="detail" > |
|
2128 <code> |
|
2129 protected |
|
2130 |
|
2131 |
|
2132 void |
|
2133 <strong property="yui:name">renderer</strong> |
|
2134 ( |
|
2135 ) |
|
2136 </code> |
|
2137 |
|
2138 <div class="description" property="yui:description"> |
|
2139 Creates DOM (or manipulates DOM for progressive enhancement) |
|
2140 This method is invoked by render() and is not chained |
|
2141 automatically for the class hierarchy (like initializer, destructor) |
|
2142 so it should be chained manually for subclasses if required. |
|
2143 </div> |
|
2144 |
|
2145 <div class="description"> |
|
2146 |
|
2147 |
|
2148 |
|
2149 |
|
2150 |
|
2151 |
|
2152 </div> |
|
2153 |
|
2154 </div> |
|
2155 <hr /> |
|
2156 </div> |
|
2157 <div class="protected" rel="yui:method" resource="#method_renderUI"> |
|
2158 <h4> |
|
2159 <a name="method_renderUI">renderUI</a></h4> |
|
2160 <div class="detail" > |
|
2161 <code> |
|
2162 protected |
|
2163 |
|
2164 |
|
2165 void |
|
2166 <strong property="yui:name">renderUI</strong> |
|
2167 ( |
|
2168 ) |
|
2169 </code> |
|
2170 |
|
2171 <div class="description" property="yui:description"> |
|
2172 Adds nodes to the DOM |
|
2173 This method is not called by framework and is not chained |
|
2174 automatically for the class hierarchy. |
|
2175 </div> |
|
2176 |
|
2177 <div class="description"> |
|
2178 |
|
2179 |
|
2180 |
|
2181 |
|
2182 |
|
2183 |
|
2184 </div> |
|
2185 |
|
2186 </div> |
|
2187 <hr /> |
|
2188 </div> |
|
2189 <div class="" rel="yui:method" resource="#method_show"> |
|
2190 <h4> |
|
2191 <a name="method_show">show</a></h4> |
|
2192 <div class="detail" > |
|
2193 <code> |
|
2194 |
|
2195 |
|
2196 |
|
2197 void |
|
2198 <strong property="yui:name">show</strong> |
|
2199 ( |
|
2200 ) |
|
2201 </code> |
|
2202 |
|
2203 <div class="description" property="yui:description"> |
|
2204 Shows the Module element by setting the "visible" attribute to "true". |
|
2205 </div> |
|
2206 |
|
2207 <div class="description"> |
|
2208 |
|
2209 |
|
2210 |
|
2211 |
|
2212 |
|
2213 |
|
2214 </div> |
|
2215 |
|
2216 </div> |
|
2217 <hr /> |
|
2218 </div> |
|
2219 <div class="" rel="yui:method" resource="#method_syncUI"> |
|
2220 <h4> |
|
2221 <a name="method_syncUI">syncUI</a></h4> |
|
2222 <div class="detail" > |
|
2223 <code> |
|
2224 |
|
2225 |
|
2226 |
|
2227 void |
|
2228 <strong property="yui:name">syncUI</strong> |
|
2229 ( |
|
2230 ) |
|
2231 </code> |
|
2232 |
|
2233 <div class="description" property="yui:description"> |
|
2234 Refreshes the rendered UI, based on Widget State |
|
2235 This method is not called by framework and is not chained |
|
2236 automatically for the class hierarchy. |
|
2237 </div> |
|
2238 |
|
2239 <div class="description"> |
|
2240 |
|
2241 |
|
2242 |
|
2243 |
|
2244 |
|
2245 |
|
2246 </div> |
|
2247 |
|
2248 </div> |
|
2249 <hr /> |
|
2250 </div> |
|
2251 <div class="" rel="yui:method" resource="#method_toString"> |
|
2252 <h4> |
|
2253 <a name="method_toString">toString</a></h4> |
|
2254 <div class="detail" > |
|
2255 <code> |
|
2256 |
|
2257 |
|
2258 |
|
2259 String |
|
2260 <strong property="yui:name">toString</strong> |
|
2261 ( |
|
2262 ) |
|
2263 </code> |
|
2264 |
|
2265 <div class="description" property="yui:description"> |
|
2266 Generic toString implementation for all widgets. |
|
2267 </div> |
|
2268 |
|
2269 <div class="description"> |
|
2270 |
|
2271 |
|
2272 <dl> |
|
2273 <dt>Returns: |
|
2274 <code property="yui:return"> |
|
2275 String |
|
2276 </code></dt> |
|
2277 <dd property="yui:returnInfo">The default string value for the widget [ displays the NAME of the instance, and the unique id ]</dd> |
|
2278 </dl> |
|
2279 |
|
2280 |
|
2281 |
|
2282 |
|
2283 </div> |
|
2284 |
|
2285 </div> |
|
2286 <hr /> |
|
2287 </div> |
|
2288 <div class="" rel="yui:method" resource="#method_Widget.getByNode"> |
|
2289 <h4> |
|
2290 <a name="method_Widget.getByNode">Widget.getByNode</a></h4> |
|
2291 <div class="detail" > |
|
2292 <code> |
|
2293 |
|
2294 static |
|
2295 |
|
2296 Widget |
|
2297 <strong property="yui:name">Widget.getByNode</strong> |
|
2298 ( |
|
2299 |
|
2300 |
|
2301 node |
|
2302 |
|
2303 |
|
2304 ) |
|
2305 </code> |
|
2306 |
|
2307 <div class="description" property="yui:description"> |
|
2308 Returns the widget instance whose bounding box contains, or is, the given node. |
|
2309 <p> |
|
2310 In the case of nested widgets, the nearest bounding box ancestor is used to |
|
2311 return the widget instance. |
|
2312 </p> |
|
2313 </div> |
|
2314 |
|
2315 <div class="description"> |
|
2316 |
|
2317 <dl rel="yui:parameters"> |
|
2318 <dt>Parameters:</dt> |
|
2319 <dd rel="yui:parameter"> |
|
2320 <code><span property="yui:name">node</span> |
|
2321 <<span property="yui:type">Node | String</span>> |
|
2322 </code> |
|
2323 <span property="yui:description"> The node for which to return a Widget instance. If a selector |
|
2324 string is passed in, which selects more than one node, the first node found is used.</span> |
|
2325 </dd> |
|
2326 </dl> |
|
2327 |
|
2328 <dl> |
|
2329 <dt>Returns: |
|
2330 <code property="yui:return"> |
|
2331 Widget |
|
2332 </code></dt> |
|
2333 <dd property="yui:returnInfo">Widget instance, or null if not found.</dd> |
|
2334 </dl> |
|
2335 |
|
2336 |
|
2337 |
|
2338 |
|
2339 </div> |
|
2340 |
|
2341 </div> |
|
2342 <hr /> |
|
2343 </div> |
|
2344 </div> |
|
2345 </div> |
|
2346 |
|
2347 <div rel="yui:inheritance"> |
|
2348 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
2349 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
2350 <div class="content" rel="yui:methods"> |
|
2351 <code> |
|
2352 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
2353 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
2354 </span> |
|
2355 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
2356 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
2357 </span> |
|
2358 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
2359 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
2360 </span> |
|
2361 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
2362 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
2363 </span> |
|
2364 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
2365 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
2366 </span> |
|
2367 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
2368 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
2369 </span> |
|
2370 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
2371 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
2372 </span> |
|
2373 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
2374 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
2375 </span> |
|
2376 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
2377 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
2378 </span> |
|
2379 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
2380 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
2381 </span> |
|
2382 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
2383 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
2384 </span> |
|
2385 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
2386 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
2387 </span> |
|
2388 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
2389 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
2390 </span> |
|
2391 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
2392 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
2393 </span> |
|
2394 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
2395 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
2396 </span> |
|
2397 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
2398 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
2399 </span> |
|
2400 </code> |
|
2401 </div> |
|
2402 </div> |
|
2403 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
2404 <h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
2405 <div class="content" rel="yui:methods"> |
|
2406 <code> |
|
2407 <span rel="yui:method" resource="Attribute.html#method__addAttrs"> |
|
2408 <a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span> |
|
2409 </span> |
|
2410 <span rel="yui:method" resource="Attribute.html#method__addLazyAttr"> |
|
2411 <a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span> |
|
2412 </span> |
|
2413 <span rel="yui:method" resource="Attribute.html#method__defAttrChangeFn"> |
|
2414 <a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span> |
|
2415 </span> |
|
2416 <span rel="yui:method" resource="Attribute.html#method__fireAttrChange"> |
|
2417 <a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span> |
|
2418 </span> |
|
2419 <span rel="yui:method" resource="Attribute.html#method__getAttr"> |
|
2420 <a class="protected" href="Attribute.html#method__getAttr" property="yui:name" title="_getAttr">_getAttr</a><span class="protected">,</span> |
|
2421 </span> |
|
2422 <span rel="yui:method" resource="Attribute.html#method__getAttrInitVal"> |
|
2423 <a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span> |
|
2424 </span> |
|
2425 <span rel="yui:method" resource="Attribute.html#method__getAttrs"> |
|
2426 <a class="protected" href="Attribute.html#method__getAttrs" property="yui:name" title="_getAttrs">_getAttrs</a><span class="protected">,</span> |
|
2427 </span> |
|
2428 <span rel="yui:method" resource="Attribute.html#method__getStateVal"> |
|
2429 <a class="private" href="Attribute.html#method__getStateVal" property="yui:name" title="_getStateVal">_getStateVal</a><span class="private">,</span> |
|
2430 </span> |
|
2431 <span rel="yui:method" resource="Attribute.html#method__isLazyAttr"> |
|
2432 <a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span> |
|
2433 </span> |
|
2434 <span rel="yui:method" resource="Attribute.html#method__normAttrVals"> |
|
2435 <a class="private" href="Attribute.html#method__normAttrVals" property="yui:name" title="_normAttrVals">_normAttrVals</a><span class="private">,</span> |
|
2436 </span> |
|
2437 <span rel="yui:method" resource="Attribute.html#method__protectAttrs"> |
|
2438 <a class="protected" href="Attribute.html#method__protectAttrs" property="yui:name" title="_protectAttrs">_protectAttrs</a><span class="protected">,</span> |
|
2439 </span> |
|
2440 <span rel="yui:method" resource="Attribute.html#method__set"> |
|
2441 <a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span> |
|
2442 </span> |
|
2443 <span rel="yui:method" resource="Attribute.html#method__setAttr"> |
|
2444 <a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span> |
|
2445 </span> |
|
2446 <span rel="yui:method" resource="Attribute.html#method__setAttrs"> |
|
2447 <a class="protected" href="Attribute.html#method__setAttrs" property="yui:name" title="_setAttrs">_setAttrs</a><span class="protected">,</span> |
|
2448 </span> |
|
2449 <span rel="yui:method" resource="Attribute.html#method__setAttrVal"> |
|
2450 <a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span> |
|
2451 </span> |
|
2452 <span rel="yui:method" resource="Attribute.html#method__setStateVal"> |
|
2453 <a class="private" href="Attribute.html#method__setStateVal" property="yui:name" title="_setStateVal">_setStateVal</a><span class="private">,</span> |
|
2454 </span> |
|
2455 <span rel="yui:method" resource="Attribute.html#method_addAttr"> |
|
2456 <a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span> |
|
2457 </span> |
|
2458 <span rel="yui:method" resource="Attribute.html#method_addAttrs"> |
|
2459 <a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span> |
|
2460 </span> |
|
2461 <span rel="yui:method" resource="Attribute.html#method_attrAdded"> |
|
2462 <a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span> |
|
2463 </span> |
|
2464 <span rel="yui:method" resource="Attribute.html#method_get"> |
|
2465 <a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span> |
|
2466 </span> |
|
2467 <span rel="yui:method" resource="Attribute.html#method_getAttrs"> |
|
2468 <a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span> |
|
2469 </span> |
|
2470 <span rel="yui:method" resource="Attribute.html#method_modifyAttr"> |
|
2471 <a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span> |
|
2472 </span> |
|
2473 <span rel="yui:method" resource="Attribute.html#method_removeAttr"> |
|
2474 <a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span> |
|
2475 </span> |
|
2476 <span rel="yui:method" resource="Attribute.html#method_reset"> |
|
2477 <a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span> |
|
2478 </span> |
|
2479 <span rel="yui:method" resource="Attribute.html#method_set"> |
|
2480 <a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span> |
|
2481 </span> |
|
2482 <span rel="yui:method" resource="Attribute.html#method_setAttrs"> |
|
2483 <a class="" href="Attribute.html#method_setAttrs" property="yui:name" title="setAttrs">setAttrs</a> |
|
2484 </span> |
|
2485 </code> |
|
2486 </div> |
|
2487 </div> |
|
2488 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
2489 <h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
2490 <div class="content" rel="yui:methods"> |
|
2491 <code> |
|
2492 <span rel="yui:method" resource="Base.html#method__aggregateAttrs"> |
|
2493 <a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span> |
|
2494 </span> |
|
2495 <span rel="yui:method" resource="Base.html#method__defDestroyFn"> |
|
2496 <a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span> |
|
2497 </span> |
|
2498 <span rel="yui:method" resource="Base.html#method__defInitFn"> |
|
2499 <a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span> |
|
2500 </span> |
|
2501 <span rel="yui:method" resource="Base.html#method__destroyHierarchy"> |
|
2502 <a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> |
|
2503 </span> |
|
2504 <span rel="yui:method" resource="Base.html#method__filterAttrCfs"> |
|
2505 <a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span> |
|
2506 </span> |
|
2507 <span rel="yui:method" resource="Base.html#method__getAttrCfgs"> |
|
2508 <a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span> |
|
2509 </span> |
|
2510 <span rel="yui:method" resource="Base.html#method__getClasses"> |
|
2511 <a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span> |
|
2512 </span> |
|
2513 <span rel="yui:method" resource="Base.html#method__initHierarchy"> |
|
2514 <a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span> |
|
2515 </span> |
|
2516 <span rel="yui:method" resource="Base.html#method__initHierarchyData"> |
|
2517 <a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span> |
|
2518 </span> |
|
2519 <span rel="yui:method" resource="Base.html#method_destroy"> |
|
2520 <a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
2521 </span> |
|
2522 <span rel="yui:method" resource="Base.html#method_init"> |
|
2523 <a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
2524 </span> |
|
2525 <span rel="yui:method" resource="Base.html#method_toString"> |
|
2526 <a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a> |
|
2527 </span> |
|
2528 </code> |
|
2529 </div> |
|
2530 </div> |
|
2531 </div> |
|
2532 </div> |
|
2533 |
|
2534 <div rel="yui:events" resource="#events"> |
|
2535 <div class="section method details"> |
|
2536 <h3 id="events">Events</h3> |
|
2537 <div class="content"> |
|
2538 <div class="" rel="yui:event" resource="#event_boundingBoxChange"> |
|
2539 <h4> |
|
2540 <a name="event_boundingBoxChange">boundingBoxChange</a></h4> |
|
2541 <div class="detail"> |
|
2542 <code> |
|
2543 |
|
2544 |
|
2545 |
|
2546 <strong property="yui:name">boundingBoxChange</strong> |
|
2547 |
|
2548 ( |
|
2549 |
|
2550 |
|
2551 event |
|
2552 |
|
2553 |
|
2554 ) |
|
2555 |
|
2556 </code> |
|
2557 |
|
2558 <div class="description" property="yui:description"> |
|
2559 Fires when the value for the configuration attribute 'boundingBox' 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. |
|
2560 </div> |
|
2561 |
|
2562 <div class="description"> |
|
2563 |
|
2564 |
|
2565 <dl rel="yui:parameters"> |
|
2566 <dt>Parameters:</dt> |
|
2567 <dd rel="yui:parameter"> |
|
2568 <code><span property="yui:name">event</span> |
|
2569 <<span property="yui:type">Event.Facade</span>> |
|
2570 </code> |
|
2571 <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> |
|
2572 </dd> |
|
2573 |
|
2574 </dl> |
|
2575 |
|
2576 |
|
2577 </div> |
|
2578 |
|
2579 </div> |
|
2580 <hr /> |
|
2581 </div> |
|
2582 <div class="" rel="yui:event" resource="#event_contentBoxChange"> |
|
2583 <h4> |
|
2584 <a name="event_contentBoxChange">contentBoxChange</a></h4> |
|
2585 <div class="detail"> |
|
2586 <code> |
|
2587 |
|
2588 |
|
2589 |
|
2590 <strong property="yui:name">contentBoxChange</strong> |
|
2591 |
|
2592 ( |
|
2593 |
|
2594 |
|
2595 event |
|
2596 |
|
2597 |
|
2598 ) |
|
2599 |
|
2600 </code> |
|
2601 |
|
2602 <div class="description" property="yui:description"> |
|
2603 Fires when the value for the configuration attribute 'contentBox' 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. |
|
2604 </div> |
|
2605 |
|
2606 <div class="description"> |
|
2607 |
|
2608 |
|
2609 <dl rel="yui:parameters"> |
|
2610 <dt>Parameters:</dt> |
|
2611 <dd rel="yui:parameter"> |
|
2612 <code><span property="yui:name">event</span> |
|
2613 <<span property="yui:type">Event.Facade</span>> |
|
2614 </code> |
|
2615 <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> |
|
2616 </dd> |
|
2617 |
|
2618 </dl> |
|
2619 |
|
2620 |
|
2621 </div> |
|
2622 |
|
2623 </div> |
|
2624 <hr /> |
|
2625 </div> |
|
2626 <div class="" rel="yui:event" resource="#event_disabledChange"> |
|
2627 <h4> |
|
2628 <a name="event_disabledChange">disabledChange</a></h4> |
|
2629 <div class="detail"> |
|
2630 <code> |
|
2631 |
|
2632 |
|
2633 |
|
2634 <strong property="yui:name">disabledChange</strong> |
|
2635 |
|
2636 ( |
|
2637 |
|
2638 |
|
2639 event |
|
2640 |
|
2641 |
|
2642 ) |
|
2643 |
|
2644 </code> |
|
2645 |
|
2646 <div class="description" property="yui:description"> |
|
2647 Fires when the value for the configuration attribute 'disabled' 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. |
|
2648 </div> |
|
2649 |
|
2650 <div class="description"> |
|
2651 |
|
2652 |
|
2653 <dl rel="yui:parameters"> |
|
2654 <dt>Parameters:</dt> |
|
2655 <dd rel="yui:parameter"> |
|
2656 <code><span property="yui:name">event</span> |
|
2657 <<span property="yui:type">Event.Facade</span>> |
|
2658 </code> |
|
2659 <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> |
|
2660 </dd> |
|
2661 |
|
2662 </dl> |
|
2663 |
|
2664 |
|
2665 </div> |
|
2666 |
|
2667 </div> |
|
2668 <hr /> |
|
2669 </div> |
|
2670 <div class="" rel="yui:event" resource="#event_focusedChange"> |
|
2671 <h4> |
|
2672 <a name="event_focusedChange">focusedChange</a></h4> |
|
2673 <div class="detail"> |
|
2674 <code> |
|
2675 |
|
2676 |
|
2677 |
|
2678 <strong property="yui:name">focusedChange</strong> |
|
2679 |
|
2680 ( |
|
2681 |
|
2682 |
|
2683 event |
|
2684 |
|
2685 |
|
2686 ) |
|
2687 |
|
2688 </code> |
|
2689 |
|
2690 <div class="description" property="yui:description"> |
|
2691 Fires when the value for the configuration attribute 'focused' 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. |
|
2692 </div> |
|
2693 |
|
2694 <div class="description"> |
|
2695 |
|
2696 |
|
2697 <dl rel="yui:parameters"> |
|
2698 <dt>Parameters:</dt> |
|
2699 <dd rel="yui:parameter"> |
|
2700 <code><span property="yui:name">event</span> |
|
2701 <<span property="yui:type">Event.Facade</span>> |
|
2702 </code> |
|
2703 <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> |
|
2704 </dd> |
|
2705 |
|
2706 </dl> |
|
2707 |
|
2708 |
|
2709 </div> |
|
2710 |
|
2711 </div> |
|
2712 <hr /> |
|
2713 </div> |
|
2714 <div class="" rel="yui:event" resource="#event_heightChange"> |
|
2715 <h4> |
|
2716 <a name="event_heightChange">heightChange</a></h4> |
|
2717 <div class="detail"> |
|
2718 <code> |
|
2719 |
|
2720 |
|
2721 |
|
2722 <strong property="yui:name">heightChange</strong> |
|
2723 |
|
2724 ( |
|
2725 |
|
2726 |
|
2727 event |
|
2728 |
|
2729 |
|
2730 ) |
|
2731 |
|
2732 </code> |
|
2733 |
|
2734 <div class="description" property="yui:description"> |
|
2735 Fires when the value for the configuration attribute 'height' 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. |
|
2736 </div> |
|
2737 |
|
2738 <div class="description"> |
|
2739 |
|
2740 |
|
2741 <dl rel="yui:parameters"> |
|
2742 <dt>Parameters:</dt> |
|
2743 <dd rel="yui:parameter"> |
|
2744 <code><span property="yui:name">event</span> |
|
2745 <<span property="yui:type">Event.Facade</span>> |
|
2746 </code> |
|
2747 <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> |
|
2748 </dd> |
|
2749 |
|
2750 </dl> |
|
2751 |
|
2752 |
|
2753 </div> |
|
2754 |
|
2755 </div> |
|
2756 <hr /> |
|
2757 </div> |
|
2758 <div class="" rel="yui:event" resource="#event_localeChange"> |
|
2759 <h4> |
|
2760 <a name="event_localeChange">localeChange</a></h4> |
|
2761 <div class="detail"> |
|
2762 <code> |
|
2763 |
|
2764 |
|
2765 |
|
2766 <strong property="yui:name">localeChange</strong> |
|
2767 |
|
2768 ( |
|
2769 |
|
2770 |
|
2771 event |
|
2772 |
|
2773 |
|
2774 ) |
|
2775 |
|
2776 </code> |
|
2777 |
|
2778 <div class="description" property="yui:description"> |
|
2779 Fires when the value for the configuration attribute 'locale' 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. |
|
2780 </div> |
|
2781 |
|
2782 <div class="description"> |
|
2783 |
|
2784 |
|
2785 <dl rel="yui:parameters"> |
|
2786 <dt>Parameters:</dt> |
|
2787 <dd rel="yui:parameter"> |
|
2788 <code><span property="yui:name">event</span> |
|
2789 <<span property="yui:type">Event.Facade</span>> |
|
2790 </code> |
|
2791 <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> |
|
2792 </dd> |
|
2793 |
|
2794 </dl> |
|
2795 |
|
2796 |
|
2797 </div> |
|
2798 |
|
2799 </div> |
|
2800 <hr /> |
|
2801 </div> |
|
2802 <div class="" rel="yui:event" resource="#event_moveStylesChange"> |
|
2803 <h4> |
|
2804 <a name="event_moveStylesChange">moveStylesChange</a></h4> |
|
2805 <div class="detail"> |
|
2806 <code> |
|
2807 |
|
2808 |
|
2809 |
|
2810 <strong property="yui:name">moveStylesChange</strong> |
|
2811 |
|
2812 ( |
|
2813 |
|
2814 |
|
2815 event |
|
2816 |
|
2817 |
|
2818 ) |
|
2819 |
|
2820 </code> |
|
2821 |
|
2822 <div class="description" property="yui:description"> |
|
2823 Fires when the value for the configuration attribute 'moveStyles' 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. |
|
2824 </div> |
|
2825 |
|
2826 <div class="description"> |
|
2827 |
|
2828 |
|
2829 <dl rel="yui:parameters"> |
|
2830 <dt>Parameters:</dt> |
|
2831 <dd rel="yui:parameter"> |
|
2832 <code><span property="yui:name">event</span> |
|
2833 <<span property="yui:type">Event.Facade</span>> |
|
2834 </code> |
|
2835 <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> |
|
2836 </dd> |
|
2837 |
|
2838 </dl> |
|
2839 |
|
2840 |
|
2841 </div> |
|
2842 |
|
2843 </div> |
|
2844 <hr /> |
|
2845 </div> |
|
2846 <div class="" rel="yui:event" resource="#event_renderedChange"> |
|
2847 <h4> |
|
2848 <a name="event_renderedChange">renderedChange</a></h4> |
|
2849 <div class="detail"> |
|
2850 <code> |
|
2851 |
|
2852 |
|
2853 |
|
2854 <strong property="yui:name">renderedChange</strong> |
|
2855 |
|
2856 ( |
|
2857 |
|
2858 |
|
2859 event |
|
2860 |
|
2861 |
|
2862 ) |
|
2863 |
|
2864 </code> |
|
2865 |
|
2866 <div class="description" property="yui:description"> |
|
2867 Fires when the value for the configuration attribute 'rendered' 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. |
|
2868 </div> |
|
2869 |
|
2870 <div class="description"> |
|
2871 |
|
2872 |
|
2873 <dl rel="yui:parameters"> |
|
2874 <dt>Parameters:</dt> |
|
2875 <dd rel="yui:parameter"> |
|
2876 <code><span property="yui:name">event</span> |
|
2877 <<span property="yui:type">Event.Facade</span>> |
|
2878 </code> |
|
2879 <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> |
|
2880 </dd> |
|
2881 |
|
2882 </dl> |
|
2883 |
|
2884 |
|
2885 </div> |
|
2886 |
|
2887 </div> |
|
2888 <hr /> |
|
2889 </div> |
|
2890 <div class="" rel="yui:event" resource="#event_stringsChange"> |
|
2891 <h4> |
|
2892 <a name="event_stringsChange">stringsChange</a></h4> |
|
2893 <div class="detail"> |
|
2894 <code> |
|
2895 |
|
2896 |
|
2897 |
|
2898 <strong property="yui:name">stringsChange</strong> |
|
2899 |
|
2900 ( |
|
2901 |
|
2902 |
|
2903 event |
|
2904 |
|
2905 |
|
2906 ) |
|
2907 |
|
2908 </code> |
|
2909 |
|
2910 <div class="description" property="yui:description"> |
|
2911 Fires when the value for the configuration attribute 'strings' 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. |
|
2912 </div> |
|
2913 |
|
2914 <div class="description"> |
|
2915 |
|
2916 |
|
2917 <dl rel="yui:parameters"> |
|
2918 <dt>Parameters:</dt> |
|
2919 <dd rel="yui:parameter"> |
|
2920 <code><span property="yui:name">event</span> |
|
2921 <<span property="yui:type">Event.Facade</span>> |
|
2922 </code> |
|
2923 <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> |
|
2924 </dd> |
|
2925 |
|
2926 </dl> |
|
2927 |
|
2928 |
|
2929 </div> |
|
2930 |
|
2931 </div> |
|
2932 <hr /> |
|
2933 </div> |
|
2934 <div class="" rel="yui:event" resource="#event_tabIndexChange"> |
|
2935 <h4> |
|
2936 <a name="event_tabIndexChange">tabIndexChange</a></h4> |
|
2937 <div class="detail"> |
|
2938 <code> |
|
2939 |
|
2940 |
|
2941 |
|
2942 <strong property="yui:name">tabIndexChange</strong> |
|
2943 |
|
2944 ( |
|
2945 |
|
2946 |
|
2947 event |
|
2948 |
|
2949 |
|
2950 ) |
|
2951 |
|
2952 </code> |
|
2953 |
|
2954 <div class="description" property="yui:description"> |
|
2955 Fires when the value for the configuration attribute 'tabIndex' 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. |
|
2956 </div> |
|
2957 |
|
2958 <div class="description"> |
|
2959 |
|
2960 |
|
2961 <dl rel="yui:parameters"> |
|
2962 <dt>Parameters:</dt> |
|
2963 <dd rel="yui:parameter"> |
|
2964 <code><span property="yui:name">event</span> |
|
2965 <<span property="yui:type">Event.Facade</span>> |
|
2966 </code> |
|
2967 <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> |
|
2968 </dd> |
|
2969 |
|
2970 </dl> |
|
2971 |
|
2972 |
|
2973 </div> |
|
2974 |
|
2975 </div> |
|
2976 <hr /> |
|
2977 </div> |
|
2978 <div class="" rel="yui:event" resource="#event_visibleChange"> |
|
2979 <h4> |
|
2980 <a name="event_visibleChange">visibleChange</a></h4> |
|
2981 <div class="detail"> |
|
2982 <code> |
|
2983 |
|
2984 |
|
2985 |
|
2986 <strong property="yui:name">visibleChange</strong> |
|
2987 |
|
2988 ( |
|
2989 |
|
2990 |
|
2991 event |
|
2992 |
|
2993 |
|
2994 ) |
|
2995 |
|
2996 </code> |
|
2997 |
|
2998 <div class="description" property="yui:description"> |
|
2999 Fires when the value for the configuration attribute 'visible' 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. |
|
3000 </div> |
|
3001 |
|
3002 <div class="description"> |
|
3003 |
|
3004 |
|
3005 <dl rel="yui:parameters"> |
|
3006 <dt>Parameters:</dt> |
|
3007 <dd rel="yui:parameter"> |
|
3008 <code><span property="yui:name">event</span> |
|
3009 <<span property="yui:type">Event.Facade</span>> |
|
3010 </code> |
|
3011 <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> |
|
3012 </dd> |
|
3013 |
|
3014 </dl> |
|
3015 |
|
3016 |
|
3017 </div> |
|
3018 |
|
3019 </div> |
|
3020 <hr /> |
|
3021 </div> |
|
3022 <div class="" rel="yui:event" resource="#event_widget:contentUpdate"> |
|
3023 <h4> |
|
3024 <a name="event_widget:contentUpdate">widget:contentUpdate</a></h4> |
|
3025 <div class="detail"> |
|
3026 <code> |
|
3027 |
|
3028 |
|
3029 |
|
3030 <strong property="yui:name">widget:contentUpdate</strong> |
|
3031 |
|
3032 ( |
|
3033 |
|
3034 |
|
3035 e |
|
3036 |
|
3037 |
|
3038 ) |
|
3039 |
|
3040 </code> |
|
3041 |
|
3042 <div class="description" property="yui:description"> |
|
3043 Notification event, which widget implementations can fire, when |
|
3044 they change the content of the widget. This event has no default |
|
3045 behavior and cannot be prevented, so the "on" or "after" |
|
3046 moments are effectively equivalent (with on listeners being invoked before |
|
3047 after listeners). |
|
3048 </div> |
|
3049 |
|
3050 <div class="description"> |
|
3051 |
|
3052 |
|
3053 <dl rel="yui:parameters"> |
|
3054 <dt>Parameters:</dt> |
|
3055 <dd rel="yui:parameter"> |
|
3056 <code><span property="yui:name">e</span> |
|
3057 <<span property="yui:type">EventFacade</span>> |
|
3058 </code> |
|
3059 <span property="yui:description"> The Event Facade</span> |
|
3060 </dd> |
|
3061 |
|
3062 </dl> |
|
3063 |
|
3064 <div class="preventable"> |
|
3065 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is false. |
|
3066 </div> |
|
3067 |
|
3068 </div> |
|
3069 |
|
3070 </div> |
|
3071 <hr /> |
|
3072 </div> |
|
3073 <div class="" rel="yui:event" resource="#event_widget:render"> |
|
3074 <h4> |
|
3075 <a name="event_widget:render">widget:render</a></h4> |
|
3076 <div class="detail"> |
|
3077 <code> |
|
3078 |
|
3079 |
|
3080 |
|
3081 <strong property="yui:name">widget:render</strong> |
|
3082 |
|
3083 ( |
|
3084 |
|
3085 |
|
3086 e |
|
3087 |
|
3088 |
|
3089 ) |
|
3090 |
|
3091 </code> |
|
3092 |
|
3093 <div class="description" property="yui:description"> |
|
3094 Lifcyle event for the render phase, fired prior to rendering the UI |
|
3095 for the widget (prior to invoking the widgets renderer method). |
|
3096 <p> |
|
3097 Subscribers to the "on" moment of this event, will be notified |
|
3098 before the widget is rendered. |
|
3099 </p> |
|
3100 <p> |
|
3101 Subscribers to the "after" momemt of this event, will be notified |
|
3102 after rendering is complete. |
|
3103 </p> |
|
3104 </div> |
|
3105 |
|
3106 <div class="description"> |
|
3107 |
|
3108 |
|
3109 <dl rel="yui:parameters"> |
|
3110 <dt>Parameters:</dt> |
|
3111 <dd rel="yui:parameter"> |
|
3112 <code><span property="yui:name">e</span> |
|
3113 <<span property="yui:type">EventFacade</span>> |
|
3114 </code> |
|
3115 <span property="yui:description"> The Event Facade</span> |
|
3116 </dd> |
|
3117 |
|
3118 </dl> |
|
3119 |
|
3120 <div class="preventable"> |
|
3121 <strong>Preventable:</strong> This event is preventable by method e.preventDefault(). The default function executed by this event is _defRenderFn. |
|
3122 </div> |
|
3123 |
|
3124 </div> |
|
3125 |
|
3126 </div> |
|
3127 <hr /> |
|
3128 </div> |
|
3129 <div class="" rel="yui:event" resource="#event_widthChange"> |
|
3130 <h4> |
|
3131 <a name="event_widthChange">widthChange</a></h4> |
|
3132 <div class="detail"> |
|
3133 <code> |
|
3134 |
|
3135 |
|
3136 |
|
3137 <strong property="yui:name">widthChange</strong> |
|
3138 |
|
3139 ( |
|
3140 |
|
3141 |
|
3142 event |
|
3143 |
|
3144 |
|
3145 ) |
|
3146 |
|
3147 </code> |
|
3148 |
|
3149 <div class="description" property="yui:description"> |
|
3150 Fires when the value for the configuration attribute 'width' 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. |
|
3151 </div> |
|
3152 |
|
3153 <div class="description"> |
|
3154 |
|
3155 |
|
3156 <dl rel="yui:parameters"> |
|
3157 <dt>Parameters:</dt> |
|
3158 <dd rel="yui:parameter"> |
|
3159 <code><span property="yui:name">event</span> |
|
3160 <<span property="yui:type">Event.Facade</span>> |
|
3161 </code> |
|
3162 <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> |
|
3163 </dd> |
|
3164 |
|
3165 </dl> |
|
3166 |
|
3167 |
|
3168 </div> |
|
3169 |
|
3170 </div> |
|
3171 <hr /> |
|
3172 </div> |
|
3173 </div> |
|
3174 </div> |
|
3175 |
|
3176 |
|
3177 <div rel="yui:inheritance"> |
|
3178 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
3179 <h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
3180 <div class="content" rel="yui:events"> |
|
3181 <code> |
|
3182 <span rel="yui:event" resource="Base.html#event_destroy"> |
|
3183 <a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
3184 </span> |
|
3185 <span rel="yui:event" resource="Base.html#event_destroyedChange"> |
|
3186 <a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span> |
|
3187 </span> |
|
3188 <span rel="yui:event" resource="Base.html#event_init"> |
|
3189 <a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
3190 </span> |
|
3191 <span rel="yui:event" resource="Base.html#event_initializedChange"> |
|
3192 <a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span> |
|
3193 </span> |
|
3194 |
|
3195 </code> |
|
3196 </div> |
|
3197 </div> |
|
3198 </div> |
|
3199 </div> |
|
3200 |
|
3201 <div rel="yui:attributes" resource="#configattributes"> |
|
3202 <div class="section field details"> |
|
3203 <h3 id="configattributes">Configuration Attributes</h3> |
|
3204 <div class="content"> |
|
3205 <div class="" rel="yui:attribute" resource="#config_boundingBox"> |
|
3206 <h4><a name="config_boundingBox">boundingBox</a> |
|
3207 <code>- <span property="yui:type">Node</span></code> |
|
3208 </h4> |
|
3209 <div class="detail"> |
|
3210 <div class="description" property="yui:description"> |
|
3211 The outermost DOM node for the Widget, used for sizing and positioning |
|
3212 of a Widget as well as a containing element for any decorator elements used |
|
3213 for skinning. |
|
3214 </div> |
|
3215 </div> |
|
3216 |
|
3217 |
|
3218 |
|
3219 <hr /> |
|
3220 </div> |
|
3221 <div class="" rel="yui:attribute" resource="#config_contentBox"> |
|
3222 <h4><a name="config_contentBox">contentBox</a> |
|
3223 <code>- <span property="yui:type">Node</span></code> |
|
3224 </h4> |
|
3225 <div class="detail"> |
|
3226 <div class="description" property="yui:description"> |
|
3227 A DOM node that is a direct descendent of a Widget's bounding box that |
|
3228 houses its content. |
|
3229 </div> |
|
3230 </div> |
|
3231 |
|
3232 |
|
3233 |
|
3234 <hr /> |
|
3235 </div> |
|
3236 <div class="" rel="yui:attribute" resource="#config_disabled"> |
|
3237 <h4><a name="config_disabled">disabled</a> |
|
3238 <code>- <span property="yui:type">boolean</span></code> |
|
3239 </h4> |
|
3240 <div class="detail"> |
|
3241 <div class="description" property="yui:description"> |
|
3242 Boolean indicating if the Widget should be disabled. The disabled implementation |
|
3243 is left to the specific classes extending widget. |
|
3244 </div> |
|
3245 </div> |
|
3246 |
|
3247 |
|
3248 <div class="default"> |
|
3249 Default Value: false |
|
3250 </div> |
|
3251 |
|
3252 <hr /> |
|
3253 </div> |
|
3254 <div class="" rel="yui:attribute" resource="#config_focused"> |
|
3255 <h4><a name="config_focused">focused</a> |
|
3256 <code>- <span property="yui:type">boolean</span></code> |
|
3257 </h4> |
|
3258 <div class="detail"> |
|
3259 <div class="description" property="yui:description"> |
|
3260 Boolean indicating if the Widget, or one of its descendants, |
|
3261 has focus. |
|
3262 </div> |
|
3263 </div> |
|
3264 |
|
3265 |
|
3266 <div class="default"> |
|
3267 Default Value: false |
|
3268 </div> |
|
3269 |
|
3270 <hr /> |
|
3271 </div> |
|
3272 <div class="" rel="yui:attribute" resource="#config_height"> |
|
3273 <h4><a name="config_height">height</a> |
|
3274 <code>- <span property="yui:type">{String | Number}</span></code> |
|
3275 </h4> |
|
3276 <div class="detail"> |
|
3277 <div class="description" property="yui:description"> |
|
3278 String with units, or number, representing the height of the Widget. If a number is provided, |
|
3279 the default unit, defined by the Widgets DEF_UNIT, property is used. |
|
3280 </div> |
|
3281 </div> |
|
3282 |
|
3283 |
|
3284 <div class="default"> |
|
3285 Default Value: "" |
|
3286 </div> |
|
3287 |
|
3288 <hr /> |
|
3289 </div> |
|
3290 <div class="" rel="yui:attribute" resource="#config_locale"> |
|
3291 <h4><a name="config_locale">locale</a> |
|
3292 <code>- <span property="yui:type">String</span></code> |
|
3293 </h4> |
|
3294 <div class="detail"> |
|
3295 <div class="description" property="yui:description"> |
|
3296 The default locale for the widget. NOTE: Using get/set on the "strings" attribute will |
|
3297 return/set strings for this locale. |
|
3298 </div> |
|
3299 </div> |
|
3300 |
|
3301 |
|
3302 <div class="default"> |
|
3303 Default Value: "en" |
|
3304 </div> |
|
3305 |
|
3306 <hr /> |
|
3307 </div> |
|
3308 <div class="" rel="yui:attribute" resource="#config_moveStyles"> |
|
3309 <h4><a name="config_moveStyles">moveStyles</a> |
|
3310 <code>- <span property="yui:type">boolean</span></code> |
|
3311 </h4> |
|
3312 <div class="detail"> |
|
3313 <div class="description" property="yui:description"> |
|
3314 Flag defining whether or not style properties from the content box |
|
3315 should be moved to the bounding box when wrapped (as defined by the WRAP_STYLES property) |
|
3316 </div> |
|
3317 </div> |
|
3318 |
|
3319 |
|
3320 <div class="default"> |
|
3321 Default Value: false |
|
3322 </div> |
|
3323 |
|
3324 <hr /> |
|
3325 </div> |
|
3326 <div class="" rel="yui:attribute" resource="#config_rendered"> |
|
3327 <h4><a name="config_rendered">rendered</a> |
|
3328 <code>- <span property="yui:type">boolean</span></code> |
|
3329 </h4> |
|
3330 <div class="detail"> |
|
3331 <div class="description" property="yui:description"> |
|
3332 Flag indicating whether or not this object |
|
3333 has been through the render lifecycle phase. |
|
3334 </div> |
|
3335 </div> |
|
3336 |
|
3337 |
|
3338 <div class="default"> |
|
3339 Default Value: false |
|
3340 </div> |
|
3341 |
|
3342 <hr /> |
|
3343 </div> |
|
3344 <div class="" rel="yui:attribute" resource="#config_strings"> |
|
3345 <h4><a name="config_strings">strings</a> |
|
3346 <code>- <span property="yui:type">Object</span></code> |
|
3347 </h4> |
|
3348 <div class="detail"> |
|
3349 <div class="description" property="yui:description"> |
|
3350 Collection of strings used to label elements of the Widget's UI. |
|
3351 </div> |
|
3352 </div> |
|
3353 |
|
3354 |
|
3355 <div class="default"> |
|
3356 Default Value: null |
|
3357 </div> |
|
3358 |
|
3359 <hr /> |
|
3360 </div> |
|
3361 <div class="" rel="yui:attribute" resource="#config_tabIndex"> |
|
3362 <h4><a name="config_tabIndex">tabIndex</a> |
|
3363 <code>- <span property="yui:type">Number</span></code> |
|
3364 </h4> |
|
3365 <div class="detail"> |
|
3366 <div class="description" property="yui:description"> |
|
3367 Number (between -32767 to 32767) indicating the widget's |
|
3368 position in the default tab flow. The value is used to set the |
|
3369 "tabIndex" attribute on the widget's bounding box. Negative values allow |
|
3370 the widget to receive DOM focus programmatically (by calling the focus |
|
3371 method), while being removed from the default tab flow. A value of |
|
3372 null removes the "tabIndex" attribute from the widget's bounding box. |
|
3373 </div> |
|
3374 </div> |
|
3375 |
|
3376 |
|
3377 <div class="default"> |
|
3378 Default Value: null |
|
3379 </div> |
|
3380 |
|
3381 <hr /> |
|
3382 </div> |
|
3383 <div class="" rel="yui:attribute" resource="#config_visible"> |
|
3384 <h4><a name="config_visible">visible</a> |
|
3385 <code>- <span property="yui:type">boolean</span></code> |
|
3386 </h4> |
|
3387 <div class="detail"> |
|
3388 <div class="description" property="yui:description"> |
|
3389 Boolean indicating weather or not the Widget is visible. |
|
3390 </div> |
|
3391 </div> |
|
3392 |
|
3393 |
|
3394 <div class="default"> |
|
3395 Default Value: true |
|
3396 </div> |
|
3397 |
|
3398 <hr /> |
|
3399 </div> |
|
3400 <div class="" rel="yui:attribute" resource="#config_width"> |
|
3401 <h4><a name="config_width">width</a> |
|
3402 <code>- <span property="yui:type">{String | Number}</span></code> |
|
3403 </h4> |
|
3404 <div class="detail"> |
|
3405 <div class="description" property="yui:description"> |
|
3406 String with units, or number, representing the width of the Widget. If a number is provided, |
|
3407 the default unit, defined by the Widgets DEF_UNIT, property is used. |
|
3408 </div> |
|
3409 </div> |
|
3410 |
|
3411 |
|
3412 <div class="default"> |
|
3413 Default Value: "" |
|
3414 </div> |
|
3415 |
|
3416 <hr /> |
|
3417 </div> |
|
3418 |
|
3419 </div> |
|
3420 </div> |
|
3421 |
|
3422 <div rel="yui:inheritance"> |
|
3423 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
3424 <h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
3425 <div class="content" rel="yui:attributes"> |
|
3426 <code> |
|
3427 <span rel="yui:attribute" resource="Base.html#config_destroyed"> |
|
3428 <a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span> |
|
3429 </span> |
|
3430 <span rel="yui:attribute" resource="Base.html#config_initialized"> |
|
3431 <a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span> |
|
3432 </span> |
|
3433 |
|
3434 </code> |
|
3435 </div> |
|
3436 </div> |
|
3437 </div> |
|
3438 </div> |
|
3439 |
|
3440 </div> |
|
3441 </div> |
|
3442 <div class="yui-b"> |
|
3443 <div class="nav"> |
|
3444 |
|
3445 <div id="moduleList" class="module"> |
|
3446 <h4>Modules</h4> |
|
3447 <ul class="content"> |
|
3448 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
3449 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
3450 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
3451 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
3452 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
3453 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
3454 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
3455 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
3456 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
3457 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
3458 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
3459 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
3460 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
3461 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
3462 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
3463 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
3464 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
3465 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
3466 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
3467 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
3468 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
3469 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
3470 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
3471 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
3472 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
3473 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
3474 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
3475 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
3476 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
3477 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
3478 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
3479 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
3480 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
3481 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
3482 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
3483 <li class="selected"><a href="module_widget.html" title="widget">widget</a></li> |
|
3484 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
3485 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
3486 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
3487 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
3488 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
3489 </ul> |
|
3490 </div> |
|
3491 |
|
3492 <div id="classList" class="module"> |
|
3493 <h4>Classes</h4> |
|
3494 <ul class="content"> |
|
3495 <li class="selected"><a href="Widget.html" title="Widget">Widget</a></li> |
|
3496 </ul> |
|
3497 </div> |
|
3498 |
|
3499 <div id="fileList" class="module"> |
|
3500 <h4>Files</h4> |
|
3501 <ul class="content"> |
|
3502 <li class=""><a href="Widget.js.html" title="Widget.js">Widget.js</a></li> |
|
3503 </ul> |
|
3504 </div> |
|
3505 |
|
3506 <div id="propertyList" class="module"> |
|
3507 <h4>Properties</h4> |
|
3508 <ul class="content"> |
|
3509 <li class="private"><a href="#property__buildCfg" title="_buildCfg">_buildCfg</a></li> |
|
3510 <li class="private"><a href="#property__strings" title="_strings">_strings</a></li> |
|
3511 <li class=""><a href="#property_BOUNDING_TEMPLATE" title="BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a></li> |
|
3512 <li class=""><a href="#property_CONTENT_TEMPLATE" title="CONTENT_TEMPLATE">CONTENT_TEMPLATE</a></li> |
|
3513 <li class=""><a href="#property_DEF_UNIT" title="DEF_UNIT">DEF_UNIT</a></li> |
|
3514 <li class="private"><a href="#property_Widget._NAME_LOWERCASE" title="Widget._NAME_LOWERCASE">Widget._NAME_LOWERCASE</a></li> |
|
3515 <li class=""><a href="#property_Widget.ATTRS" title="Widget.ATTRS">Widget.ATTRS</a></li> |
|
3516 <li class=""><a href="#property_Widget.HTML_PARSER" title="Widget.HTML_PARSER">Widget.HTML_PARSER</a></li> |
|
3517 <li class=""><a href="#property_Widget.NAME" title="Widget.NAME">Widget.NAME</a></li> |
|
3518 <li class=""><a href="#property_Widget.UI_SRC" title="Widget.UI_SRC">Widget.UI_SRC</a></li> |
|
3519 <li class=""><a href="#property_WRAP_STYLES" title="WRAP_STYLES">WRAP_STYLES</a></li> |
|
3520 </ul> |
|
3521 </div> |
|
3522 |
|
3523 <div id="methodsList" class="module"> |
|
3524 <h4>Methods</h4> |
|
3525 <ul class="content"> |
|
3526 <li class="protected"><a href="#method__afterDisabledChange" title="_afterDisabledChange">_afterDisabledChange</a></li> |
|
3527 <li class="protected"><a href="#method__afterFocusedChange" title="_afterFocusedChange">_afterFocusedChange</a></li> |
|
3528 <li class="protected"><a href="#method__afterHeightChange" title="_afterHeightChange">_afterHeightChange</a></li> |
|
3529 <li class="protected"><a href="#method__afterVisibleChange" title="_afterVisibleChange">_afterVisibleChange</a></li> |
|
3530 <li class="protected"><a href="#method__afterWidthChange" title="_afterWidthChange">_afterWidthChange</a></li> |
|
3531 <li class="protected"><a href="#method__bindDOMListeners" title="_bindDOMListeners">_bindDOMListeners</a></li> |
|
3532 <li class="protected"><a href="#method__bindUI" title="_bindUI">_bindUI</a></li> |
|
3533 <li class="protected"><a href="#method__defRenderFn" title="_defRenderFn">_defRenderFn</a></li> |
|
3534 <li class=""><a href="#method__getHtmlParser" title="_getHtmlParser">_getHtmlParser</a></li> |
|
3535 <li class="protected"><a href="#method__getStrings" title="_getStrings">_getStrings</a></li> |
|
3536 <li class="private"><a href="#method__moveStyles" title="_moveStyles">_moveStyles</a></li> |
|
3537 <li class="protected"><a href="#method__onDocMouseDown" title="_onDocMouseDown">_onDocMouseDown</a></li> |
|
3538 <li class="protected"><a href="#method__onFocus" title="_onFocus">_onFocus</a></li> |
|
3539 <li class="private"><a href="#method__parseHTML" title="_parseHTML">_parseHTML</a></li> |
|
3540 <li class="private"><a href="#method__renderBox" title="_renderBox">_renderBox</a></li> |
|
3541 <li class="protected"><a href="#method__renderBoxClassNames" title="_renderBoxClassNames">_renderBoxClassNames</a></li> |
|
3542 <li class="protected"><a href="#method__renderUI" title="_renderUI">_renderUI</a></li> |
|
3543 <li class="private"><a href="#method__setBoundingBox" title="_setBoundingBox">_setBoundingBox</a></li> |
|
3544 <li class="private"><a href="#method__setBox" title="_setBox">_setBox</a></li> |
|
3545 <li class="private"><a href="#method__setContentBox" title="_setContentBox">_setContentBox</a></li> |
|
3546 <li class="protected"><a href="#method__setStrings" title="_setStrings">_setStrings</a></li> |
|
3547 <li class="protected"><a href="#method__syncUI" title="_syncUI">_syncUI</a></li> |
|
3548 <li class="protected"><a href="#method__uiSetDisabled" title="_uiSetDisabled">_uiSetDisabled</a></li> |
|
3549 <li class="protected"><a href="#method__uiSetFocused" title="_uiSetFocused">_uiSetFocused</a></li> |
|
3550 <li class="protected"><a href="#method__uiSetHeight" title="_uiSetHeight">_uiSetHeight</a></li> |
|
3551 <li class="protected"><a href="#method__uiSetTabIndex" title="_uiSetTabIndex">_uiSetTabIndex</a></li> |
|
3552 <li class="protected"><a href="#method__uiSetVisible" title="_uiSetVisible">_uiSetVisible</a></li> |
|
3553 <li class="protected"><a href="#method__uiSetWidth" title="_uiSetWidth">_uiSetWidth</a></li> |
|
3554 <li class="protected"><a href="#method_bindUI" title="bindUI">bindUI</a></li> |
|
3555 <li class=""><a href="#method_blur" title="blur">blur</a></li> |
|
3556 <li class="protected"><a href="#method_destructor" title="destructor">destructor</a></li> |
|
3557 <li class=""><a href="#method_disabled" title="disabled">disabled</a></li> |
|
3558 <li class=""><a href="#method_enable" title="enable">enable</a></li> |
|
3559 <li class=""><a href="#method_focus" title="focus">focus</a></li> |
|
3560 <li class=""><a href="#method_getClassName" title="getClassName">getClassName</a></li> |
|
3561 <li class=""><a href="#method_getDefaultLocale" title="getDefaultLocale">getDefaultLocale</a></li> |
|
3562 <li class=""><a href="#method_getString" title="getString">getString</a></li> |
|
3563 <li class=""><a href="#method_getStrings" title="getStrings">getStrings</a></li> |
|
3564 <li class=""><a href="#method_hide" title="hide">hide</a></li> |
|
3565 <li class="protected"><a href="#method_initializer" title="initializer">initializer</a></li> |
|
3566 <li class=""><a href="#method_render" title="render">render</a></li> |
|
3567 <li class="protected"><a href="#method_renderer" title="renderer">renderer</a></li> |
|
3568 <li class="protected"><a href="#method_renderUI" title="renderUI">renderUI</a></li> |
|
3569 <li class=""><a href="#method_show" title="show">show</a></li> |
|
3570 <li class=""><a href="#method_syncUI" title="syncUI">syncUI</a></li> |
|
3571 <li class=""><a href="#method_toString" title="toString">toString</a></li> |
|
3572 <li class=""><a href="#method_Widget.getByNode" title="Widget.getByNode">Widget.getByNode</a></li> |
|
3573 </ul> |
|
3574 </div> |
|
3575 |
|
3576 <div id="eventsList" class="module"> |
|
3577 <h4>Events</h4> |
|
3578 <ul class="content"> |
|
3579 <li class=""><a href="#event_boundingBoxChange" title="boundingBoxChange">boundingBoxChange</a></li> |
|
3580 <li class=""><a href="#event_contentBoxChange" title="contentBoxChange">contentBoxChange</a></li> |
|
3581 <li class=""><a href="#event_disabledChange" title="disabledChange">disabledChange</a></li> |
|
3582 <li class=""><a href="#event_focusedChange" title="focusedChange">focusedChange</a></li> |
|
3583 <li class=""><a href="#event_heightChange" title="heightChange">heightChange</a></li> |
|
3584 <li class=""><a href="#event_localeChange" title="localeChange">localeChange</a></li> |
|
3585 <li class=""><a href="#event_moveStylesChange" title="moveStylesChange">moveStylesChange</a></li> |
|
3586 <li class=""><a href="#event_renderedChange" title="renderedChange">renderedChange</a></li> |
|
3587 <li class=""><a href="#event_stringsChange" title="stringsChange">stringsChange</a></li> |
|
3588 <li class=""><a href="#event_tabIndexChange" title="tabIndexChange">tabIndexChange</a></li> |
|
3589 <li class=""><a href="#event_visibleChange" title="visibleChange">visibleChange</a></li> |
|
3590 <li class=""><a href="#event_widget:contentUpdate" title="widget:contentUpdate">widget:contentUpdate</a></li> |
|
3591 <li class=""><a href="#event_widget:render" title="widget:render">widget:render</a></li> |
|
3592 <li class=""><a href="#event_widthChange" title="widthChange">widthChange</a></li> |
|
3593 </ul> |
|
3594 </div> |
|
3595 |
|
3596 <div id="configList" class="module"> |
|
3597 <h4>Configuration Attributes</h4> |
|
3598 <ul class="content"> |
|
3599 <li class=""><a href="#config_boundingBox" title="boundingBox">boundingBox</a></li> |
|
3600 <li class=""><a href="#config_contentBox" title="contentBox">contentBox</a></li> |
|
3601 <li class=""><a href="#config_disabled" title="disabled">disabled</a></li> |
|
3602 <li class=""><a href="#config_focused" title="focused">focused</a></li> |
|
3603 <li class=""><a href="#config_height" title="height">height</a></li> |
|
3604 <li class=""><a href="#config_locale" title="locale">locale</a></li> |
|
3605 <li class=""><a href="#config_moveStyles" title="moveStyles">moveStyles</a></li> |
|
3606 <li class=""><a href="#config_rendered" title="rendered">rendered</a></li> |
|
3607 <li class=""><a href="#config_strings" title="strings">strings</a></li> |
|
3608 <li class=""><a href="#config_tabIndex" title="tabIndex">tabIndex</a></li> |
|
3609 <li class=""><a href="#config_visible" title="visible">visible</a></li> |
|
3610 <li class=""><a href="#config_width" title="width">width</a></li> |
|
3611 </ul> |
|
3612 </div> |
|
3613 |
|
3614 </div> |
|
3615 </div> |
|
3616 </div> |
|
3617 <div id="ft"> |
|
3618 <hr /> |
|
3619 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
3620 </div> |
|
3621 </div> |
|
3622 <script type="text/javascript"> |
|
3623 ALL_YUI_PROPS = [{"access": "protected", "host": "Widget", "name": "_afterDisabledChange", "url": "Widget.html#method__afterDisabledChange", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_afterFocusedChange", "url": "Widget.html#method__afterFocusedChange", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_afterHeightChange", "url": "Widget.html#method__afterHeightChange", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_afterVisibleChange", "url": "Widget.html#method__afterVisibleChange", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_afterWidthChange", "url": "Widget.html#method__afterWidthChange", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_bindDOMListeners", "url": "Widget.html#method__bindDOMListeners", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_bindUI", "url": "Widget.html#method__bindUI", "type": "method"}, {"access": "protected", "host": "Widget", "name": "bindUI", "url": "Widget.html#method_bindUI", "type": "method"}, {"access": "", "host": "Widget", "name": "blur", "url": "Widget.html#method_blur", "type": "method"}, {"access": "", "host": "Widget", "name": "boundingBox", "url": "Widget.html#config_boundingBox", "type": "config"}, {"access": "", "host": "Widget", "name": "boundingBoxChange", "url": "Widget.html#event_boundingBoxChange", "type": "event"}, {"access": "", "host": "Widget", "name": "BOUNDING_TEMPLATE", "url": "Widget.html#property_BOUNDING_TEMPLATE", "type": "property"}, {"access": "private", "host": "Widget", "name": "_buildCfg", "url": "Widget.html#property__buildCfg", "type": "property"}, {"access": "", "host": "Widget", "name": "contentBox", "url": "Widget.html#config_contentBox", "type": "config"}, {"access": "", "host": "Widget", "name": "contentBoxChange", "url": "Widget.html#event_contentBoxChange", "type": "event"}, {"access": "", "host": "Widget", "name": "CONTENT_TEMPLATE", "url": "Widget.html#property_CONTENT_TEMPLATE", "type": "property"}, {"access": "protected", "host": "Widget", "name": "_defRenderFn", "url": "Widget.html#method__defRenderFn", "type": "method"}, {"access": "", "host": "Widget", "name": "DEF_UNIT", "url": "Widget.html#property_DEF_UNIT", "type": "property"}, {"access": "protected", "host": "Widget", "name": "destructor", "url": "Widget.html#method_destructor", "type": "method"}, {"access": "", "host": "Widget", "name": "disabled", "url": "Widget.html#method_disabled", "type": "method"}, {"access": "", "host": "Widget", "name": "disabled", "url": "Widget.html#config_disabled", "type": "config"}, {"access": "", "host": "Widget", "name": "disabledChange", "url": "Widget.html#event_disabledChange", "type": "event"}, {"access": "", "host": "Widget", "name": "enable", "url": "Widget.html#method_enable", "type": "method"}, {"access": "", "host": "Widget", "name": "focus", "url": "Widget.html#method_focus", "type": "method"}, {"access": "", "host": "Widget", "name": "focused", "url": "Widget.html#config_focused", "type": "config"}, {"access": "", "host": "Widget", "name": "focusedChange", "url": "Widget.html#event_focusedChange", "type": "event"}, {"access": "", "host": "Widget", "name": "getClassName", "url": "Widget.html#method_getClassName", "type": "method"}, {"access": "", "host": "Widget", "name": "getDefaultLocale", "url": "Widget.html#method_getDefaultLocale", "type": "method"}, {"access": "", "host": "Widget", "name": "_getHtmlParser", "url": "Widget.html#method__getHtmlParser", "type": "method"}, {"access": "", "host": "Widget", "name": "getString", "url": "Widget.html#method_getString", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_getStrings", "url": "Widget.html#method__getStrings", "type": "method"}, {"access": "", "host": "Widget", "name": "getStrings", "url": "Widget.html#method_getStrings", "type": "method"}, {"access": "", "host": "Widget", "name": "height", "url": "Widget.html#config_height", "type": "config"}, {"access": "", "host": "Widget", "name": "heightChange", "url": "Widget.html#event_heightChange", "type": "event"}, {"access": "", "host": "Widget", "name": "hide", "url": "Widget.html#method_hide", "type": "method"}, {"access": "protected", "host": "Widget", "name": "initializer", "url": "Widget.html#method_initializer", "type": "method"}, {"access": "", "host": "Widget", "name": "locale", "url": "Widget.html#config_locale", "type": "config"}, {"access": "", "host": "Widget", "name": "localeChange", "url": "Widget.html#event_localeChange", "type": "event"}, {"access": "private", "host": "Widget", "name": "_moveStyles", "url": "Widget.html#method__moveStyles", "type": "method"}, {"access": "", "host": "Widget", "name": "moveStyles", "url": "Widget.html#config_moveStyles", "type": "config"}, {"access": "", "host": "Widget", "name": "moveStylesChange", "url": "Widget.html#event_moveStylesChange", "type": "event"}, {"access": "protected", "host": "Widget", "name": "_onDocMouseDown", "url": "Widget.html#method__onDocMouseDown", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_onFocus", "url": "Widget.html#method__onFocus", "type": "method"}, {"access": "private", "host": "Widget", "name": "_parseHTML", "url": "Widget.html#method__parseHTML", "type": "method"}, {"access": "", "host": "Widget", "name": "render", "url": "Widget.html#method_render", "type": "method"}, {"access": "private", "host": "Widget", "name": "_renderBox", "url": "Widget.html#method__renderBox", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_renderBoxClassNames", "url": "Widget.html#method__renderBoxClassNames", "type": "method"}, {"access": "", "host": "Widget", "name": "rendered", "url": "Widget.html#config_rendered", "type": "config"}, {"access": "", "host": "Widget", "name": "renderedChange", "url": "Widget.html#event_renderedChange", "type": "event"}, {"access": "protected", "host": "Widget", "name": "renderer", "url": "Widget.html#method_renderer", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_renderUI", "url": "Widget.html#method__renderUI", "type": "method"}, {"access": "protected", "host": "Widget", "name": "renderUI", "url": "Widget.html#method_renderUI", "type": "method"}, {"access": "private", "host": "Widget", "name": "_setBoundingBox", "url": "Widget.html#method__setBoundingBox", "type": "method"}, {"access": "private", "host": "Widget", "name": "_setBox", "url": "Widget.html#method__setBox", "type": "method"}, {"access": "private", "host": "Widget", "name": "_setContentBox", "url": "Widget.html#method__setContentBox", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_setStrings", "url": "Widget.html#method__setStrings", "type": "method"}, {"access": "", "host": "Widget", "name": "show", "url": "Widget.html#method_show", "type": "method"}, {"access": "private", "host": "Widget", "name": "_strings", "url": "Widget.html#property__strings", "type": "property"}, {"access": "", "host": "Widget", "name": "strings", "url": "Widget.html#config_strings", "type": "config"}, {"access": "", "host": "Widget", "name": "stringsChange", "url": "Widget.html#event_stringsChange", "type": "event"}, {"access": "protected", "host": "Widget", "name": "_syncUI", "url": "Widget.html#method__syncUI", "type": "method"}, {"access": "", "host": "Widget", "name": "syncUI", "url": "Widget.html#method_syncUI", "type": "method"}, {"access": "", "host": "Widget", "name": "tabIndex", "url": "Widget.html#config_tabIndex", "type": "config"}, {"access": "", "host": "Widget", "name": "tabIndexChange", "url": "Widget.html#event_tabIndexChange", "type": "event"}, {"access": "", "host": "Widget", "name": "toString", "url": "Widget.html#method_toString", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetDisabled", "url": "Widget.html#method__uiSetDisabled", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetFocused", "url": "Widget.html#method__uiSetFocused", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetHeight", "url": "Widget.html#method__uiSetHeight", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetTabIndex", "url": "Widget.html#method__uiSetTabIndex", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetVisible", "url": "Widget.html#method__uiSetVisible", "type": "method"}, {"access": "protected", "host": "Widget", "name": "_uiSetWidth", "url": "Widget.html#method__uiSetWidth", "type": "method"}, {"access": "", "host": "Widget", "name": "visible", "url": "Widget.html#config_visible", "type": "config"}, {"access": "", "host": "Widget", "name": "visibleChange", "url": "Widget.html#event_visibleChange", "type": "event"}, {"access": "", "host": "Widget", "name": "widget:contentUpdate", "url": "Widget.html#event_widget:contentUpdate", "type": "event"}, {"access": "", "host": "Widget", "name": "widget:render", "url": "Widget.html#event_widget:render", "type": "event"}, {"access": "", "host": "Widget", "name": "Widget.ATTRS", "url": "Widget.html#property_Widget.ATTRS", "type": "property"}, {"access": "", "host": "Widget", "name": "Widget.getByNode", "url": "Widget.html#method_Widget.getByNode", "type": "method"}, {"access": "", "host": "Widget", "name": "Widget.HTML_PARSER", "url": "Widget.html#property_Widget.HTML_PARSER", "type": "property"}, {"access": "", "host": "Widget", "name": "Widget.NAME", "url": "Widget.html#property_Widget.NAME", "type": "property"}, {"access": "private", "host": "Widget", "name": "Widget._NAME_LOWERCASE", "url": "Widget.html#property_Widget._NAME_LOWERCASE", "type": "property"}, {"access": "", "host": "Widget", "name": "Widget.UI_SRC", "url": "Widget.html#property_Widget.UI_SRC", "type": "property"}, {"access": "", "host": "Widget", "name": "width", "url": "Widget.html#config_width", "type": "config"}, {"access": "", "host": "Widget", "name": "widthChange", "url": "Widget.html#event_widthChange", "type": "event"}, {"access": "", "host": "Widget", "name": "WRAP_STYLES", "url": "Widget.html#property_WRAP_STYLES", "type": "property"}]; |
|
3624 </script> |
|
3625 </body> |
|
3626 </html> |