|
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: plugin Plugin.Base (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>plugin <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_plugin.html" title="plugin">plugin</a> |
|
22 > Plugin.Base |
|
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">Plugin.Base</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="DataSourceXMLSchema.html"> |
|
63 <a href="DataSourceXMLSchema.html" property="yui:name" title="DataSourceXMLSchema">DataSourceXMLSchema</a> |
|
64 </span> |
|
65 <span rel="yui:subclass" resource="DataSourceArraySchema.html"> |
|
66 <a href="DataSourceArraySchema.html" property="yui:name" title="DataSourceArraySchema">DataSourceArraySchema</a> |
|
67 </span> |
|
68 <span rel="yui:subclass" resource="DataSourceJSONSchema.html"> |
|
69 <a href="DataSourceJSONSchema.html" property="yui:name" title="DataSourceJSONSchema">DataSourceJSONSchema</a> |
|
70 </span> |
|
71 <span rel="yui:subclass" resource="Cache.html"> |
|
72 <a href="Cache.html" property="yui:name" title="Cache">Cache</a> |
|
73 </span> |
|
74 <span rel="yui:subclass" resource="DataSourceTextSchema.html"> |
|
75 <a href="DataSourceTextSchema.html" property="yui:name" title="DataSourceTextSchema">DataSourceTextSchema</a> |
|
76 </span> |
|
77 </dd> |
|
78 </dl> |
|
79 |
|
80 |
|
81 |
|
82 <div class="summary description" property="yui:description"> |
|
83 The base class for all Plugin instances. |
|
84 </div> |
|
85 |
|
86 |
|
87 <div rel="yui:properties" resource="#properties"> |
|
88 <div class="section field details"> |
|
89 <h3 id="properties">Properties</h3> |
|
90 <div class="content"> |
|
91 <div class="private" rel="yui:property" resource="#property__handles"> |
|
92 <h4><a name="property__handles" property="yui:name">_handles</a> |
|
93 - <code>private <span property="yui:type">Array</span></code> |
|
94 </h4> |
|
95 <div class="detail"> |
|
96 <div class="description" property="yui:description"> |
|
97 The list of event handles for event listeners or AOP injected methods |
|
98 applied by the plugin to the host object. |
|
99 </div> |
|
100 </div> |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 <hr /> |
|
106 </div> |
|
107 <div class="" rel="yui:property" resource="#property_Plugin.Base.ATTRS"> |
|
108 <h4><a name="property_Plugin.Base.ATTRS" property="yui:name">Plugin.Base.ATTRS</a> |
|
109 - <code>static <span property="yui:type">Object</span></code> |
|
110 </h4> |
|
111 <div class="detail"> |
|
112 <div class="description" property="yui:description"> |
|
113 Object defining the set of attributes supported by the Plugin.Base class |
|
114 </div> |
|
115 </div> |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 <hr /> |
|
121 </div> |
|
122 <div class="" rel="yui:property" resource="#property_Plugin.Base.NAME"> |
|
123 <h4><a name="property_Plugin.Base.NAME" property="yui:name">Plugin.Base.NAME</a> |
|
124 - <code>static <span property="yui:type">String</span></code> |
|
125 </h4> |
|
126 <div class="detail"> |
|
127 <div class="description" property="yui:description"> |
|
128 The string identifying the Plugin.Base class. Plugins extending |
|
129 Plugin.Base should set their own NAME value. |
|
130 </div> |
|
131 </div> |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 <hr /> |
|
137 </div> |
|
138 <div class="" rel="yui:property" resource="#property_Plugin.NS"> |
|
139 <h4><a name="property_Plugin.NS" property="yui:name">Plugin.NS</a> |
|
140 - <code>static <span property="yui:type">String</span></code> |
|
141 </h4> |
|
142 <div class="detail"> |
|
143 <div class="description" property="yui:description"> |
|
144 The name of the property the the plugin will be attached to |
|
145 when plugged into a Plugin Host. Plugins extending Plugin.Base, |
|
146 should set their own NS value. |
|
147 </div> |
|
148 </div> |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 <hr /> |
|
154 </div> |
|
155 </div> |
|
156 </div> |
|
157 |
|
158 <div rel="yui:inheritance"> |
|
159 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
160 <h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
161 <div class="content" rel="yui:properties"> |
|
162 <code> |
|
163 |
|
164 </code> |
|
165 </div> |
|
166 </div> |
|
167 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
168 <h4>Properties inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
169 <div class="content" rel="yui:properties"> |
|
170 <code> |
|
171 |
|
172 <span rel="yui:property" resource="Base.html#property_name"> |
|
173 <a class=" deprecated" href="Base.html#property_name" property="yui:name" title="name">name</a> |
|
174 </span> |
|
175 |
|
176 </code> |
|
177 </div> |
|
178 </div> |
|
179 </div> |
|
180 </div> |
|
181 |
|
182 <div rel="yui:methods" resource="#methods"> |
|
183 <div class="section method details"> |
|
184 <h3 id="methods">Methods</h3> |
|
185 <div class="content"> |
|
186 <div class="" rel="yui:method" resource="#method_destructor"> |
|
187 <h4> |
|
188 <a name="method_destructor">destructor</a></h4> |
|
189 <div class="detail" > |
|
190 <code> |
|
191 |
|
192 |
|
193 |
|
194 void |
|
195 <strong property="yui:name">destructor</strong> |
|
196 ( |
|
197 ) |
|
198 </code> |
|
199 |
|
200 <div class="description" property="yui:description"> |
|
201 Destructor lifecycle implementation. |
|
202 Removes any event listeners or injected methods applied by the Plugin |
|
203 </div> |
|
204 |
|
205 <div class="description"> |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 </div> |
|
213 |
|
214 </div> |
|
215 <hr /> |
|
216 </div> |
|
217 <div class="" rel="yui:method" resource="#method_doAfter"> |
|
218 <h4> |
|
219 <a name="method_doAfter">doAfter</a></h4> |
|
220 <div class="detail" > |
|
221 <code> |
|
222 |
|
223 |
|
224 |
|
225 EventHandle |
|
226 <strong property="yui:name">doAfter</strong> |
|
227 ( |
|
228 |
|
229 |
|
230 sFn |
|
231 |
|
232 |
|
233 , |
|
234 fn |
|
235 |
|
236 |
|
237 , |
|
238 context |
|
239 |
|
240 |
|
241 ) |
|
242 </code> |
|
243 |
|
244 <div class="description" property="yui:description"> |
|
245 Listens for the "after" moment of events fired by the host, |
|
246 or injects code "after" a given method on the host. |
|
247 </div> |
|
248 |
|
249 <div class="description"> |
|
250 |
|
251 <dl rel="yui:parameters"> |
|
252 <dt>Parameters:</dt> |
|
253 <dd rel="yui:parameter"> |
|
254 <code><span property="yui:name">sFn</span> |
|
255 <<span property="yui:type">String</span>> |
|
256 </code> |
|
257 <span property="yui:description"> The event to listen for, or method to inject logic after.</span> |
|
258 </dd> |
|
259 <dd rel="yui:parameter"> |
|
260 <code><span property="yui:name">fn</span> |
|
261 <<span property="yui:type">Function</span>> |
|
262 </code> |
|
263 <span property="yui:description"> The handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed.</span> |
|
264 </dd> |
|
265 <dd rel="yui:parameter"> |
|
266 <code><span property="yui:name">context</span> |
|
267 <<span property="yui:type">Object</span>> |
|
268 </code> |
|
269 <span property="yui:description"> An optional context to call the handler with. The default context is the plugin instance.</span> |
|
270 </dd> |
|
271 </dl> |
|
272 |
|
273 <dl> |
|
274 <dt>Returns: |
|
275 <code property="yui:return"> |
|
276 EventHandle |
|
277 </code></dt> |
|
278 <dd property="yui:returnInfo">handle The detach handle for the handler.</dd> |
|
279 </dl> |
|
280 |
|
281 |
|
282 |
|
283 |
|
284 </div> |
|
285 |
|
286 </div> |
|
287 <hr /> |
|
288 </div> |
|
289 <div class="" rel="yui:method" resource="#method_doBefore"> |
|
290 <h4> |
|
291 <a name="method_doBefore">doBefore</a></h4> |
|
292 <div class="detail" > |
|
293 <code> |
|
294 |
|
295 |
|
296 |
|
297 EventHandle |
|
298 <strong property="yui:name">doBefore</strong> |
|
299 ( |
|
300 |
|
301 |
|
302 sFn |
|
303 |
|
304 |
|
305 , |
|
306 fn |
|
307 |
|
308 |
|
309 , |
|
310 context |
|
311 |
|
312 |
|
313 ) |
|
314 </code> |
|
315 |
|
316 <div class="description" property="yui:description"> |
|
317 Listens for the "on" moment of events fired by the host, |
|
318 or injects code "before" a given method on the host. |
|
319 </div> |
|
320 |
|
321 <div class="description"> |
|
322 |
|
323 <dl rel="yui:parameters"> |
|
324 <dt>Parameters:</dt> |
|
325 <dd rel="yui:parameter"> |
|
326 <code><span property="yui:name">sFn</span> |
|
327 <<span property="yui:type">String</span>> |
|
328 </code> |
|
329 <span property="yui:description"> The event to listen for, or method to inject logic before.</span> |
|
330 </dd> |
|
331 <dd rel="yui:parameter"> |
|
332 <code><span property="yui:name">fn</span> |
|
333 <<span property="yui:type">Function</span>> |
|
334 </code> |
|
335 <span property="yui:description"> The handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.</span> |
|
336 </dd> |
|
337 <dd rel="yui:parameter"> |
|
338 <code><span property="yui:name">context</span> |
|
339 <<span property="yui:type">Object</span>> |
|
340 </code> |
|
341 <span property="yui:description"> An optional context to call the handler with. The default context is the plugin instance.</span> |
|
342 </dd> |
|
343 </dl> |
|
344 |
|
345 <dl> |
|
346 <dt>Returns: |
|
347 <code property="yui:return"> |
|
348 EventHandle |
|
349 </code></dt> |
|
350 <dd property="yui:returnInfo">handle The detach handle for the handler.</dd> |
|
351 </dl> |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 </div> |
|
357 |
|
358 </div> |
|
359 <hr /> |
|
360 </div> |
|
361 <div class="" rel="yui:method" resource="#method_initializer"> |
|
362 <h4> |
|
363 <a name="method_initializer">initializer</a></h4> |
|
364 <div class="detail" > |
|
365 <code> |
|
366 |
|
367 |
|
368 |
|
369 void |
|
370 <strong property="yui:name">initializer</strong> |
|
371 ( |
|
372 |
|
373 |
|
374 config |
|
375 |
|
376 |
|
377 ) |
|
378 </code> |
|
379 |
|
380 <div class="description" property="yui:description"> |
|
381 Initializer lifecycle implementation. |
|
382 </div> |
|
383 |
|
384 <div class="description"> |
|
385 |
|
386 <dl rel="yui:parameters"> |
|
387 <dt>Parameters:</dt> |
|
388 <dd rel="yui:parameter"> |
|
389 <code><span property="yui:name">config</span> |
|
390 <<span property="yui:type">Object</span>> |
|
391 </code> |
|
392 <span property="yui:description"> Configuration object with property name/value pairs.</span> |
|
393 </dd> |
|
394 </dl> |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 </div> |
|
401 |
|
402 </div> |
|
403 <hr /> |
|
404 </div> |
|
405 </div> |
|
406 </div> |
|
407 |
|
408 <div rel="yui:inheritance"> |
|
409 <div class="section field inheritance" rel="yui:superclass" resource="EventTarget.html"> |
|
410 <h4>Methods inherited from <a href="EventTarget.html" property="yui:name" title="EventTarget">EventTarget</a>:</h4> |
|
411 <div class="content" rel="yui:methods"> |
|
412 <code> |
|
413 <span rel="yui:method" resource="EventTarget.html#method__getType"> |
|
414 <a class="private" href="EventTarget.html#method__getType" property="yui:name" title="_getType">_getType</a><span class="private">,</span> |
|
415 </span> |
|
416 <span rel="yui:method" resource="EventTarget.html#method__parseType"> |
|
417 <a class="private" href="EventTarget.html#method__parseType" property="yui:name" title="_parseType">_parseType</a><span class="private">,</span> |
|
418 </span> |
|
419 <span rel="yui:method" resource="EventTarget.html#method_addTarget"> |
|
420 <a class="" href="EventTarget.html#method_addTarget" property="yui:name" title="addTarget">addTarget</a><span class="">,</span> |
|
421 </span> |
|
422 <span rel="yui:method" resource="EventTarget.html#method_after"> |
|
423 <a class="" href="EventTarget.html#method_after" property="yui:name" title="after">after</a><span class="">,</span> |
|
424 </span> |
|
425 <span rel="yui:method" resource="EventTarget.html#method_before"> |
|
426 <a class=" deprecated" href="EventTarget.html#method_before" property="yui:name" title="before">before</a><span class=" deprecated">,</span> |
|
427 </span> |
|
428 <span rel="yui:method" resource="EventTarget.html#method_bubble"> |
|
429 <a class="" href="EventTarget.html#method_bubble" property="yui:name" title="bubble">bubble</a><span class="">,</span> |
|
430 </span> |
|
431 <span rel="yui:method" resource="EventTarget.html#method_detach"> |
|
432 <a class="" href="EventTarget.html#method_detach" property="yui:name" title="detach">detach</a><span class="">,</span> |
|
433 </span> |
|
434 <span rel="yui:method" resource="EventTarget.html#method_detachAll"> |
|
435 <a class="" href="EventTarget.html#method_detachAll" property="yui:name" title="detachAll">detachAll</a><span class="">,</span> |
|
436 </span> |
|
437 <span rel="yui:method" resource="EventTarget.html#method_fire"> |
|
438 <a class="" href="EventTarget.html#method_fire" property="yui:name" title="fire">fire</a><span class="">,</span> |
|
439 </span> |
|
440 <span rel="yui:method" resource="EventTarget.html#method_getEvent"> |
|
441 <a class="" href="EventTarget.html#method_getEvent" property="yui:name" title="getEvent">getEvent</a><span class="">,</span> |
|
442 </span> |
|
443 <span rel="yui:method" resource="EventTarget.html#method_on"> |
|
444 <a class="" href="EventTarget.html#method_on" property="yui:name" title="on">on</a><span class="">,</span> |
|
445 </span> |
|
446 <span rel="yui:method" resource="EventTarget.html#method_publish"> |
|
447 <a class="" href="EventTarget.html#method_publish" property="yui:name" title="publish">publish</a><span class="">,</span> |
|
448 </span> |
|
449 <span rel="yui:method" resource="EventTarget.html#method_removeTarget"> |
|
450 <a class="" href="EventTarget.html#method_removeTarget" property="yui:name" title="removeTarget">removeTarget</a><span class="">,</span> |
|
451 </span> |
|
452 <span rel="yui:method" resource="EventTarget.html#method_subscribe"> |
|
453 <a class=" deprecated" href="EventTarget.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a><span class=" deprecated">,</span> |
|
454 </span> |
|
455 <span rel="yui:method" resource="EventTarget.html#method_unsubscribe"> |
|
456 <a class=" deprecated" href="EventTarget.html#method_unsubscribe" property="yui:name" title="unsubscribe">unsubscribe</a><span class=" deprecated">,</span> |
|
457 </span> |
|
458 <span rel="yui:method" resource="EventTarget.html#method_unsubscribeAll"> |
|
459 <a class=" deprecated" href="EventTarget.html#method_unsubscribeAll" property="yui:name" title="unsubscribeAll">unsubscribeAll</a> |
|
460 </span> |
|
461 </code> |
|
462 </div> |
|
463 </div> |
|
464 <div class="section field inheritance" rel="yui:superclass" resource="Attribute.html"> |
|
465 <h4>Methods inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4> |
|
466 <div class="content" rel="yui:methods"> |
|
467 <code> |
|
468 <span rel="yui:method" resource="Attribute.html#method__addAttrs"> |
|
469 <a class="private" href="Attribute.html#method__addAttrs" property="yui:name" title="_addAttrs">_addAttrs</a><span class="private">,</span> |
|
470 </span> |
|
471 <span rel="yui:method" resource="Attribute.html#method__addLazyAttr"> |
|
472 <a class="private" href="Attribute.html#method__addLazyAttr" property="yui:name" title="_addLazyAttr">_addLazyAttr</a><span class="private">,</span> |
|
473 </span> |
|
474 <span rel="yui:method" resource="Attribute.html#method__defAttrChangeFn"> |
|
475 <a class="private" href="Attribute.html#method__defAttrChangeFn" property="yui:name" title="_defAttrChangeFn">_defAttrChangeFn</a><span class="private">,</span> |
|
476 </span> |
|
477 <span rel="yui:method" resource="Attribute.html#method__fireAttrChange"> |
|
478 <a class="private" href="Attribute.html#method__fireAttrChange" property="yui:name" title="_fireAttrChange">_fireAttrChange</a><span class="private">,</span> |
|
479 </span> |
|
480 <span rel="yui:method" resource="Attribute.html#method__getAttr"> |
|
481 <a class="protected" href="Attribute.html#method__getAttr" property="yui:name" title="_getAttr">_getAttr</a><span class="protected">,</span> |
|
482 </span> |
|
483 <span rel="yui:method" resource="Attribute.html#method__getAttrInitVal"> |
|
484 <a class="private" href="Attribute.html#method__getAttrInitVal" property="yui:name" title="_getAttrInitVal">_getAttrInitVal</a><span class="private">,</span> |
|
485 </span> |
|
486 <span rel="yui:method" resource="Attribute.html#method__getAttrs"> |
|
487 <a class="protected" href="Attribute.html#method__getAttrs" property="yui:name" title="_getAttrs">_getAttrs</a><span class="protected">,</span> |
|
488 </span> |
|
489 <span rel="yui:method" resource="Attribute.html#method__getStateVal"> |
|
490 <a class="private" href="Attribute.html#method__getStateVal" property="yui:name" title="_getStateVal">_getStateVal</a><span class="private">,</span> |
|
491 </span> |
|
492 <span rel="yui:method" resource="Attribute.html#method__isLazyAttr"> |
|
493 <a class="private" href="Attribute.html#method__isLazyAttr" property="yui:name" title="_isLazyAttr">_isLazyAttr</a><span class="private">,</span> |
|
494 </span> |
|
495 <span rel="yui:method" resource="Attribute.html#method__normAttrVals"> |
|
496 <a class="private" href="Attribute.html#method__normAttrVals" property="yui:name" title="_normAttrVals">_normAttrVals</a><span class="private">,</span> |
|
497 </span> |
|
498 <span rel="yui:method" resource="Attribute.html#method__protectAttrs"> |
|
499 <a class="protected" href="Attribute.html#method__protectAttrs" property="yui:name" title="_protectAttrs">_protectAttrs</a><span class="protected">,</span> |
|
500 </span> |
|
501 <span rel="yui:method" resource="Attribute.html#method__set"> |
|
502 <a class="protected" href="Attribute.html#method__set" property="yui:name" title="_set">_set</a><span class="protected">,</span> |
|
503 </span> |
|
504 <span rel="yui:method" resource="Attribute.html#method__setAttr"> |
|
505 <a class="protected" href="Attribute.html#method__setAttr" property="yui:name" title="_setAttr">_setAttr</a><span class="protected">,</span> |
|
506 </span> |
|
507 <span rel="yui:method" resource="Attribute.html#method__setAttrs"> |
|
508 <a class="protected" href="Attribute.html#method__setAttrs" property="yui:name" title="_setAttrs">_setAttrs</a><span class="protected">,</span> |
|
509 </span> |
|
510 <span rel="yui:method" resource="Attribute.html#method__setAttrVal"> |
|
511 <a class="private" href="Attribute.html#method__setAttrVal" property="yui:name" title="_setAttrVal">_setAttrVal</a><span class="private">,</span> |
|
512 </span> |
|
513 <span rel="yui:method" resource="Attribute.html#method__setStateVal"> |
|
514 <a class="private" href="Attribute.html#method__setStateVal" property="yui:name" title="_setStateVal">_setStateVal</a><span class="private">,</span> |
|
515 </span> |
|
516 <span rel="yui:method" resource="Attribute.html#method_addAttr"> |
|
517 <a class="" href="Attribute.html#method_addAttr" property="yui:name" title="addAttr">addAttr</a><span class="">,</span> |
|
518 </span> |
|
519 <span rel="yui:method" resource="Attribute.html#method_addAttrs"> |
|
520 <a class="" href="Attribute.html#method_addAttrs" property="yui:name" title="addAttrs">addAttrs</a><span class="">,</span> |
|
521 </span> |
|
522 <span rel="yui:method" resource="Attribute.html#method_attrAdded"> |
|
523 <a class="" href="Attribute.html#method_attrAdded" property="yui:name" title="attrAdded">attrAdded</a><span class="">,</span> |
|
524 </span> |
|
525 <span rel="yui:method" resource="Attribute.html#method_get"> |
|
526 <a class="" href="Attribute.html#method_get" property="yui:name" title="get">get</a><span class="">,</span> |
|
527 </span> |
|
528 <span rel="yui:method" resource="Attribute.html#method_getAttrs"> |
|
529 <a class="" href="Attribute.html#method_getAttrs" property="yui:name" title="getAttrs">getAttrs</a><span class="">,</span> |
|
530 </span> |
|
531 <span rel="yui:method" resource="Attribute.html#method_modifyAttr"> |
|
532 <a class="" href="Attribute.html#method_modifyAttr" property="yui:name" title="modifyAttr">modifyAttr</a><span class="">,</span> |
|
533 </span> |
|
534 <span rel="yui:method" resource="Attribute.html#method_removeAttr"> |
|
535 <a class="" href="Attribute.html#method_removeAttr" property="yui:name" title="removeAttr">removeAttr</a><span class="">,</span> |
|
536 </span> |
|
537 <span rel="yui:method" resource="Attribute.html#method_reset"> |
|
538 <a class="" href="Attribute.html#method_reset" property="yui:name" title="reset">reset</a><span class="">,</span> |
|
539 </span> |
|
540 <span rel="yui:method" resource="Attribute.html#method_set"> |
|
541 <a class="" href="Attribute.html#method_set" property="yui:name" title="set">set</a><span class="">,</span> |
|
542 </span> |
|
543 <span rel="yui:method" resource="Attribute.html#method_setAttrs"> |
|
544 <a class="" href="Attribute.html#method_setAttrs" property="yui:name" title="setAttrs">setAttrs</a> |
|
545 </span> |
|
546 </code> |
|
547 </div> |
|
548 </div> |
|
549 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
550 <h4>Methods inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
551 <div class="content" rel="yui:methods"> |
|
552 <code> |
|
553 <span rel="yui:method" resource="Base.html#method__aggregateAttrs"> |
|
554 <a class="private" href="Base.html#method__aggregateAttrs" property="yui:name" title="_aggregateAttrs">_aggregateAttrs</a><span class="private">,</span> |
|
555 </span> |
|
556 <span rel="yui:method" resource="Base.html#method__defDestroyFn"> |
|
557 <a class="protected" href="Base.html#method__defDestroyFn" property="yui:name" title="_defDestroyFn">_defDestroyFn</a><span class="protected">,</span> |
|
558 </span> |
|
559 <span rel="yui:method" resource="Base.html#method__defInitFn"> |
|
560 <a class="protected" href="Base.html#method__defInitFn" property="yui:name" title="_defInitFn">_defInitFn</a><span class="protected">,</span> |
|
561 </span> |
|
562 <span rel="yui:method" resource="Base.html#method__destroyHierarchy"> |
|
563 <a class="private" href="Base.html#method__destroyHierarchy" property="yui:name" title="_destroyHierarchy">_destroyHierarchy</a><span class="private">,</span> |
|
564 </span> |
|
565 <span rel="yui:method" resource="Base.html#method__filterAttrCfs"> |
|
566 <a class="private" href="Base.html#method__filterAttrCfs" property="yui:name" title="_filterAttrCfs">_filterAttrCfs</a><span class="private">,</span> |
|
567 </span> |
|
568 <span rel="yui:method" resource="Base.html#method__getAttrCfgs"> |
|
569 <a class="protected" href="Base.html#method__getAttrCfgs" property="yui:name" title="_getAttrCfgs">_getAttrCfgs</a><span class="protected">,</span> |
|
570 </span> |
|
571 <span rel="yui:method" resource="Base.html#method__getClasses"> |
|
572 <a class="protected" href="Base.html#method__getClasses" property="yui:name" title="_getClasses">_getClasses</a><span class="protected">,</span> |
|
573 </span> |
|
574 <span rel="yui:method" resource="Base.html#method__initHierarchy"> |
|
575 <a class="private" href="Base.html#method__initHierarchy" property="yui:name" title="_initHierarchy">_initHierarchy</a><span class="private">,</span> |
|
576 </span> |
|
577 <span rel="yui:method" resource="Base.html#method__initHierarchyData"> |
|
578 <a class="private" href="Base.html#method__initHierarchyData" property="yui:name" title="_initHierarchyData">_initHierarchyData</a><span class="private">,</span> |
|
579 </span> |
|
580 <span rel="yui:method" resource="Base.html#method_destroy"> |
|
581 <a class="" href="Base.html#method_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
582 </span> |
|
583 <span rel="yui:method" resource="Base.html#method_init"> |
|
584 <a class="" href="Base.html#method_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
585 </span> |
|
586 <span rel="yui:method" resource="Base.html#method_toString"> |
|
587 <a class="" href="Base.html#method_toString" property="yui:name" title="toString">toString</a> |
|
588 </span> |
|
589 </code> |
|
590 </div> |
|
591 </div> |
|
592 </div> |
|
593 </div> |
|
594 |
|
595 <div rel="yui:events" resource="#events"> |
|
596 <div class="section method details"> |
|
597 <h3 id="events">Events</h3> |
|
598 <div class="content"> |
|
599 <div class="" rel="yui:event" resource="#event_hostChange"> |
|
600 <h4> |
|
601 <a name="event_hostChange">hostChange</a></h4> |
|
602 <div class="detail"> |
|
603 <code> |
|
604 |
|
605 |
|
606 |
|
607 <strong property="yui:name">hostChange</strong> |
|
608 |
|
609 ( |
|
610 |
|
611 |
|
612 event |
|
613 |
|
614 |
|
615 ) |
|
616 |
|
617 </code> |
|
618 |
|
619 <div class="description" property="yui:description"> |
|
620 Fires when the value for the configuration attribute 'host' 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. |
|
621 </div> |
|
622 |
|
623 <div class="description"> |
|
624 |
|
625 |
|
626 <dl rel="yui:parameters"> |
|
627 <dt>Parameters:</dt> |
|
628 <dd rel="yui:parameter"> |
|
629 <code><span property="yui:name">event</span> |
|
630 <<span property="yui:type">Event.Facade</span>> |
|
631 </code> |
|
632 <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> |
|
633 </dd> |
|
634 |
|
635 </dl> |
|
636 |
|
637 |
|
638 </div> |
|
639 |
|
640 </div> |
|
641 <hr /> |
|
642 </div> |
|
643 </div> |
|
644 </div> |
|
645 |
|
646 |
|
647 <div rel="yui:inheritance"> |
|
648 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
649 <h4>Events inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
650 <div class="content" rel="yui:events"> |
|
651 <code> |
|
652 <span rel="yui:event" resource="Base.html#event_destroy"> |
|
653 <a class="" href="Base.html#event_destroy" property="yui:name" title="destroy">destroy</a><span class="">,</span> |
|
654 </span> |
|
655 <span rel="yui:event" resource="Base.html#event_destroyedChange"> |
|
656 <a class="" href="Base.html#event_destroyedChange" property="yui:name" title="destroyedChange">destroyedChange</a><span class="">,</span> |
|
657 </span> |
|
658 <span rel="yui:event" resource="Base.html#event_init"> |
|
659 <a class="" href="Base.html#event_init" property="yui:name" title="init">init</a><span class="">,</span> |
|
660 </span> |
|
661 <span rel="yui:event" resource="Base.html#event_initializedChange"> |
|
662 <a class="" href="Base.html#event_initializedChange" property="yui:name" title="initializedChange">initializedChange</a><span class="">,</span> |
|
663 </span> |
|
664 |
|
665 </code> |
|
666 </div> |
|
667 </div> |
|
668 </div> |
|
669 </div> |
|
670 |
|
671 <div rel="yui:attributes" resource="#configattributes"> |
|
672 <div class="section field details"> |
|
673 <h3 id="configattributes">Configuration Attributes</h3> |
|
674 <div class="content"> |
|
675 <div class="" rel="yui:attribute" resource="#config_host"> |
|
676 <h4><a name="config_host">host</a> |
|
677 <code>- writeonce <span property="yui:type">Plugin.Host</span></code> |
|
678 </h4> |
|
679 <div class="detail"> |
|
680 <div class="description" property="yui:description"> |
|
681 The plugin's host object. |
|
682 </div> |
|
683 </div> |
|
684 |
|
685 |
|
686 |
|
687 <hr /> |
|
688 </div> |
|
689 |
|
690 </div> |
|
691 </div> |
|
692 |
|
693 <div rel="yui:inheritance"> |
|
694 <div class="section field inheritance" rel="yui:superclass" resource="Base.html"> |
|
695 <h4>Configuration attributes inherited from <a href="Base.html" property="yui:name" title="Base">Base</a>:</h4> |
|
696 <div class="content" rel="yui:attributes"> |
|
697 <code> |
|
698 <span rel="yui:attribute" resource="Base.html#config_destroyed"> |
|
699 <a class="" href="Base.html#config_destroyed" property="yui:name" title="destroyed">destroyed</a><span class="">,</span> |
|
700 </span> |
|
701 <span rel="yui:attribute" resource="Base.html#config_initialized"> |
|
702 <a class="" href="Base.html#config_initialized" property="yui:name" title="initialized">initialized</a><span class="">,</span> |
|
703 </span> |
|
704 |
|
705 </code> |
|
706 </div> |
|
707 </div> |
|
708 </div> |
|
709 </div> |
|
710 |
|
711 </div> |
|
712 </div> |
|
713 <div class="yui-b"> |
|
714 <div class="nav"> |
|
715 |
|
716 <div id="moduleList" class="module"> |
|
717 <h4>Modules</h4> |
|
718 <ul class="content"> |
|
719 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
720 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
721 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
722 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
723 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
724 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
725 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
726 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
727 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
728 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
729 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
730 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
731 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
732 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
733 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
734 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
735 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
736 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
737 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
738 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
739 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
740 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
741 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
742 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
743 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
744 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
745 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
746 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
747 <li class="selected"><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
748 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
749 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
750 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
751 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
752 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
753 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
754 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
755 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
756 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
757 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
758 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
759 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
760 </ul> |
|
761 </div> |
|
762 |
|
763 <div id="classList" class="module"> |
|
764 <h4>Classes</h4> |
|
765 <ul class="content"> |
|
766 <li class="selected"><a href="Plugin.Base.html" title="Plugin.Base">Plugin.Base</a></li> |
|
767 </ul> |
|
768 </div> |
|
769 |
|
770 <div id="fileList" class="module"> |
|
771 <h4>Files</h4> |
|
772 <ul class="content"> |
|
773 <li class=""><a href="plugin.js.html" title="plugin.js">plugin.js</a></li> |
|
774 </ul> |
|
775 </div> |
|
776 |
|
777 <div id="propertyList" class="module"> |
|
778 <h4>Properties</h4> |
|
779 <ul class="content"> |
|
780 <li class="private"><a href="#property__handles" title="_handles">_handles</a></li> |
|
781 <li class=""><a href="#property_Plugin.Base.ATTRS" title="Plugin.Base.ATTRS">Plugin.Base.ATTRS</a></li> |
|
782 <li class=""><a href="#property_Plugin.Base.NAME" title="Plugin.Base.NAME">Plugin.Base.NAME</a></li> |
|
783 <li class=""><a href="#property_Plugin.NS" title="Plugin.NS">Plugin.NS</a></li> |
|
784 </ul> |
|
785 </div> |
|
786 |
|
787 <div id="methodsList" class="module"> |
|
788 <h4>Methods</h4> |
|
789 <ul class="content"> |
|
790 <li class=""><a href="#method_destructor" title="destructor">destructor</a></li> |
|
791 <li class=""><a href="#method_doAfter" title="doAfter">doAfter</a></li> |
|
792 <li class=""><a href="#method_doBefore" title="doBefore">doBefore</a></li> |
|
793 <li class=""><a href="#method_initializer" title="initializer">initializer</a></li> |
|
794 </ul> |
|
795 </div> |
|
796 |
|
797 <div id="eventsList" class="module"> |
|
798 <h4>Events</h4> |
|
799 <ul class="content"> |
|
800 <li class=""><a href="#event_hostChange" title="hostChange">hostChange</a></li> |
|
801 </ul> |
|
802 </div> |
|
803 |
|
804 <div id="configList" class="module"> |
|
805 <h4>Configuration Attributes</h4> |
|
806 <ul class="content"> |
|
807 <li class=""><a href="#config_host" title="host">host</a></li> |
|
808 </ul> |
|
809 </div> |
|
810 |
|
811 </div> |
|
812 </div> |
|
813 </div> |
|
814 <div id="ft"> |
|
815 <hr /> |
|
816 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
817 </div> |
|
818 </div> |
|
819 <script type="text/javascript"> |
|
820 ALL_YUI_PROPS = [{"access": "", "host": "Plugin.Base", "name": "destructor", "url": "Plugin.Base.html#method_destructor", "type": "method"}, {"access": "", "host": "Plugin.Base", "name": "doAfter", "url": "Plugin.Base.html#method_doAfter", "type": "method"}, {"access": "", "host": "Plugin.Base", "name": "doBefore", "url": "Plugin.Base.html#method_doBefore", "type": "method"}, {"access": "private", "host": "Plugin.Base", "name": "_handles", "url": "Plugin.Base.html#property__handles", "type": "property"}, {"access": "", "host": "Plugin.Base", "name": "host", "url": "Plugin.Base.html#config_host", "type": "config"}, {"access": "", "host": "Plugin.Base", "name": "hostChange", "url": "Plugin.Base.html#event_hostChange", "type": "event"}, {"access": "", "host": "Plugin.Base", "name": "initializer", "url": "Plugin.Base.html#method_initializer", "type": "method"}, {"access": "", "host": "Plugin.Base", "name": "Plugin.Base.ATTRS", "url": "Plugin.Base.html#property_Plugin.Base.ATTRS", "type": "property"}, {"access": "", "host": "Plugin.Base", "name": "Plugin.Base.NAME", "url": "Plugin.Base.html#property_Plugin.Base.NAME", "type": "property"}, {"access": "", "host": "Plugin.Base", "name": "Plugin.NS", "url": "Plugin.Base.html#property_Plugin.NS", "type": "property"}]; |
|
821 </script> |
|
822 </body> |
|
823 </html> |