|
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.js (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 |
|
23 > plugin.js (source view) |
|
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 <div id="srcout"> |
|
47 <style> |
|
48 #doc3 .classopts { display:none; } |
|
49 </style> |
|
50 <div class="highlight" ><pre> <span class="c">/**</span> |
|
51 <span class="c"> * Provides the base Plugin class, which plugin developers should extend, when creating custom plugins</span> |
|
52 <span class="c"> *</span> |
|
53 <span class="c"> * @module plugin</span> |
|
54 <span class="c"> */</span> |
|
55 |
|
56 <span class="c">/**</span> |
|
57 <span class="c"> * The base class for all Plugin instances.</span> |
|
58 <span class="c"> *</span> |
|
59 <span class="c"> * @class Plugin.Base </span> |
|
60 <span class="c"> * @extends Base</span> |
|
61 <span class="c"> * @param {Object} config Configuration object with property name/value pairs.</span> |
|
62 <span class="c"> */</span> |
|
63 <span class="k">function</span> <span class="nx">Plugin</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
64 <span class="nx">Plugin</span><span class="o">.</span><span class="nx">superclass</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">apply</span><span class="o">(</span><span class="k">this</span><span class="o">,</span> <span class="nx">arguments</span><span class="o">);</span> |
|
65 <span class="o">}</span> |
|
66 |
|
67 <span class="c">/**</span> |
|
68 <span class="c"> * Object defining the set of attributes supported by the Plugin.Base class</span> |
|
69 <span class="c"> * </span> |
|
70 <span class="c"> * @property Plugin.Base.ATTRS</span> |
|
71 <span class="c"> * @type Object</span> |
|
72 <span class="c"> * @static</span> |
|
73 <span class="c"> */</span> |
|
74 <span class="nx">Plugin</span><span class="o">.</span><span class="nx">ATTRS</span> <span class="o">=</span> <span class="o">{</span> |
|
75 |
|
76 <span class="c">/**</span> |
|
77 <span class="c"> * The plugin's host object.</span> |
|
78 <span class="c"> *</span> |
|
79 <span class="c"> * @attribute host</span> |
|
80 <span class="c"> * @writeonce</span> |
|
81 <span class="c"> * @type Plugin.Host</span> |
|
82 <span class="c"> */</span> |
|
83 <span class="nx">host</span> <span class="o">:</span> <span class="o">{</span> |
|
84 <span class="nx">writeOnce</span><span class="o">:</span> <span class="kc">true</span> |
|
85 <span class="o">}</span> |
|
86 <span class="o">};</span> |
|
87 |
|
88 <span class="c">/**</span> |
|
89 <span class="c"> * The string identifying the Plugin.Base class. Plugins extending</span> |
|
90 <span class="c"> * Plugin.Base should set their own NAME value.</span> |
|
91 <span class="c"> *</span> |
|
92 <span class="c"> * @property Plugin.Base.NAME</span> |
|
93 <span class="c"> * @type String</span> |
|
94 <span class="c"> * @static</span> |
|
95 <span class="c"> */</span> |
|
96 <span class="nx">Plugin</span><span class="o">.</span><span class="nx">NAME</span> <span class="o">=</span> <span class="s1">'plugin'</span><span class="o">;</span> |
|
97 |
|
98 <span class="c">/**</span> |
|
99 <span class="c"> * The name of the property the the plugin will be attached to</span> |
|
100 <span class="c"> * when plugged into a Plugin Host. Plugins extending Plugin.Base,</span> |
|
101 <span class="c"> * should set their own NS value.</span> |
|
102 <span class="c"> *</span> |
|
103 <span class="c"> * @property Plugin.NS</span> |
|
104 <span class="c"> * @type String</span> |
|
105 <span class="c"> * @static</span> |
|
106 <span class="c"> */</span> |
|
107 <span class="nx">Plugin</span><span class="o">.</span><span class="nx">NS</span> <span class="o">=</span> <span class="s1">'plugin'</span><span class="o">;</span> |
|
108 |
|
109 <span class="nx">Y</span><span class="o">.</span><span class="nx">extend</span><span class="o">(</span><span class="nx">Plugin</span><span class="o">,</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Base</span><span class="o">,</span> <span class="o">{</span> |
|
110 |
|
111 <span class="c">/**</span> |
|
112 <span class="c"> * The list of event handles for event listeners or AOP injected methods</span> |
|
113 <span class="c"> * applied by the plugin to the host object.</span> |
|
114 <span class="c"> *</span> |
|
115 <span class="c"> * @property _handles</span> |
|
116 <span class="c"> * @private</span> |
|
117 <span class="c"> * @type Array</span> |
|
118 <span class="c"> * @value null</span> |
|
119 <span class="c"> */</span> |
|
120 <span class="nx">_handles</span><span class="o">:</span> <span class="kc">null</span><span class="o">,</span> |
|
121 |
|
122 <span class="c">/**</span> |
|
123 <span class="c"> * Initializer lifecycle implementation.</span> |
|
124 <span class="c"> *</span> |
|
125 <span class="c"> * @method initializer</span> |
|
126 <span class="c"> * @param {Object} config Configuration object with property name/value pairs.</span> |
|
127 <span class="c"> */</span> |
|
128 <span class="nx">initializer</span> <span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">config</span><span class="o">)</span> <span class="o">{</span> |
|
129 <span class="k">this</span><span class="o">.</span><span class="nx">_handles</span> <span class="o">=</span> <span class="o">[];</span> |
|
130 <span class="k">if</span> <span class="o">(!</span><span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"host"</span><span class="o">))</span> <span class="o">{</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'No host defined for plugin '</span> <span class="o">+</span> <span class="k">this</span><span class="o">,</span> <span class="s1">'warn'</span><span class="o">,</span> <span class="s1">'Plugin'</span><span class="o">);}</span> |
|
131 <span class="nx">Y</span><span class="o">.</span><span class="nx">log</span><span class="o">(</span><span class="s1">'Initializing: '</span> <span class="o">+</span> <span class="k">this</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">NAME</span><span class="o">,</span> <span class="s1">'info'</span><span class="o">,</span> <span class="s1">'Plugin'</span><span class="o">);</span> |
|
132 <span class="o">},</span> |
|
133 |
|
134 <span class="c">/**</span> |
|
135 <span class="c"> * Destructor lifecycle implementation.</span> |
|
136 <span class="c"> *</span> |
|
137 <span class="c"> * Removes any event listeners or injected methods applied by the Plugin</span> |
|
138 <span class="c"> *</span> |
|
139 <span class="c"> * @method destructor</span> |
|
140 <span class="c"> */</span> |
|
141 <span class="nx">destructor</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
142 <span class="c">// remove all handles</span> |
|
143 <span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">_handles</span><span class="o">)</span> <span class="o">{</span> |
|
144 <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">l</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">_handles</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">l</span><span class="o">;</span> <span class="nx">i</span><span class="o">++)</span> <span class="o">{</span> |
|
145 <span class="k">this</span><span class="o">.</span><span class="nx">_handles</span><span class="o">[</span><span class="nx">i</span><span class="o">].</span><span class="nx">detach</span><span class="o">();</span> |
|
146 <span class="o">}</span> |
|
147 <span class="o">}</span> |
|
148 <span class="o">},</span> |
|
149 |
|
150 <span class="c">/**</span> |
|
151 <span class="c"> * Listens for the "on" moment of events fired by the host, </span> |
|
152 <span class="c"> * or injects code "before" a given method on the host.</span> |
|
153 <span class="c"> *</span> |
|
154 <span class="c"> * @method doBefore</span> |
|
155 <span class="c"> *</span> |
|
156 <span class="c"> * @param sFn {String} The event to listen for, or method to inject logic before.</span> |
|
157 <span class="c"> * @param fn {Function} The handler function. For events, the "on" moment listener. For methods, the function to execute before the given method is executed.</span> |
|
158 <span class="c"> * @param context {Object} An optional context to call the handler with. The default context is the plugin instance.</span> |
|
159 <span class="c"> * @return handle {EventHandle} The detach handle for the handler.</span> |
|
160 <span class="c"> */</span> |
|
161 <span class="nx">doBefore</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">sFn</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">context</span><span class="o">)</span> <span class="o">{</span> |
|
162 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"host"</span><span class="o">),</span> |
|
163 <span class="nx">handle</span><span class="o">;</span> |
|
164 |
|
165 <span class="nx">context</span> <span class="o">=</span> <span class="nx">context</span> <span class="o">||</span> <span class="k">this</span><span class="o">;</span> |
|
166 |
|
167 <span class="k">if</span> <span class="o">(</span><span class="nx">sFn</span> <span class="k">in</span> <span class="nx">host</span><span class="o">)</span> <span class="o">{</span> <span class="c">// method</span> |
|
168 <span class="c"></span> <span class="nx">handle</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">before</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">host</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">context</span><span class="o">);</span> |
|
169 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">on</span><span class="o">)</span> <span class="o">{</span> <span class="c">// event</span> |
|
170 <span class="c"></span> <span class="nx">handle</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">on</span><span class="o">(</span><span class="nx">sFn</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">context</span><span class="o">);</span> |
|
171 <span class="o">}</span> |
|
172 |
|
173 <span class="k">this</span><span class="o">.</span><span class="nx">_handles</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">handle</span><span class="o">);</span> |
|
174 <span class="k">return</span> <span class="nx">handle</span><span class="o">;</span> |
|
175 <span class="o">},</span> |
|
176 |
|
177 <span class="c">/**</span> |
|
178 <span class="c"> * Listens for the "after" moment of events fired by the host, </span> |
|
179 <span class="c"> * or injects code "after" a given method on the host.</span> |
|
180 <span class="c"> *</span> |
|
181 <span class="c"> * @method doAfter</span> |
|
182 <span class="c"> *</span> |
|
183 <span class="c"> * @param sFn {String} The event to listen for, or method to inject logic after.</span> |
|
184 <span class="c"> * @param fn {Function} The handler function. For events, the "after" moment listener. For methods, the function to execute after the given method is executed.</span> |
|
185 <span class="c"> * @param context {Object} An optional context to call the handler with. The default context is the plugin instance.</span> |
|
186 <span class="c"> * @return handle {EventHandle} The detach handle for the handler.</span> |
|
187 <span class="c"> */</span> |
|
188 <span class="nx">doAfter</span><span class="o">:</span> <span class="k">function</span><span class="o">(</span><span class="nx">sFn</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">context</span><span class="o">)</span> <span class="o">{</span> |
|
189 <span class="k">var</span> <span class="nx">host</span> <span class="o">=</span> <span class="k">this</span><span class="o">.</span><span class="nx">get</span><span class="o">(</span><span class="s2">"host"</span><span class="o">),</span> |
|
190 <span class="nx">handle</span><span class="o">;</span> |
|
191 |
|
192 <span class="nx">context</span> <span class="o">=</span> <span class="nx">context</span> <span class="o">||</span> <span class="k">this</span><span class="o">;</span> |
|
193 |
|
194 <span class="k">if</span> <span class="o">(</span><span class="nx">sFn</span> <span class="k">in</span> <span class="nx">host</span><span class="o">)</span> <span class="o">{</span> <span class="c">// method</span> |
|
195 <span class="c"></span> <span class="nx">handle</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Do</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="nx">fn</span><span class="o">,</span> <span class="nx">host</span><span class="o">,</span> <span class="nx">sFn</span><span class="o">,</span> <span class="nx">context</span><span class="o">);</span> |
|
196 <span class="o">}</span> <span class="k">else</span> <span class="k">if</span> <span class="o">(</span><span class="nx">host</span><span class="o">.</span><span class="nx">after</span><span class="o">)</span> <span class="o">{</span> <span class="c">// event</span> |
|
197 <span class="c"></span> <span class="nx">handle</span> <span class="o">=</span> <span class="nx">host</span><span class="o">.</span><span class="nx">after</span><span class="o">(</span><span class="nx">sFn</span><span class="o">,</span> <span class="nx">fn</span><span class="o">,</span> <span class="nx">context</span><span class="o">);</span> |
|
198 <span class="o">}</span> |
|
199 |
|
200 <span class="k">this</span><span class="o">.</span><span class="nx">_handles</span><span class="o">.</span><span class="nx">push</span><span class="o">(</span><span class="nx">handle</span><span class="o">);</span> |
|
201 <span class="k">return</span> <span class="nx">handle</span><span class="o">;</span> |
|
202 <span class="o">},</span> |
|
203 |
|
204 <span class="nx">toString</span><span class="o">:</span> <span class="k">function</span><span class="o">()</span> <span class="o">{</span> |
|
205 <span class="k">return</span> <span class="k">this</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">NAME</span> <span class="o">+</span> <span class="s1">'['</span> <span class="o">+</span> <span class="k">this</span><span class="o">.</span><span class="nx">constructor</span><span class="o">.</span><span class="nx">NS</span> <span class="o">+</span> <span class="s1">']'</span><span class="o">;</span> |
|
206 <span class="o">}</span> |
|
207 <span class="o">});</span> |
|
208 |
|
209 <span class="nx">Y</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">"Plugin"</span><span class="o">).</span><span class="nx">Base</span> <span class="o">=</span> <span class="nx">Plugin</span><span class="o">;</span> |
|
210 </pre></div> |
|
211 |
|
212 </div> |
|
213 </div> |
|
214 </div> |
|
215 <div class="yui-b"> |
|
216 <div class="nav"> |
|
217 |
|
218 <div id="moduleList" class="module"> |
|
219 <h4>Modules</h4> |
|
220 <ul class="content"> |
|
221 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
222 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
223 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
224 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
225 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
226 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
227 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
228 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
229 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
230 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
231 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
232 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
233 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
234 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
235 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
236 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
237 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
238 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
239 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
240 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
241 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
242 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
243 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
244 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
245 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
246 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
247 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
248 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
249 <li class="selected"><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
250 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
251 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
252 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
253 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
254 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
255 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
256 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
257 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
258 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
259 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
260 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
261 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
262 </ul> |
|
263 </div> |
|
264 |
|
265 <div id="classList" class="module"> |
|
266 <h4>Classes</h4> |
|
267 <ul class="content"> |
|
268 <li class=""><a href="Plugin.Base.html" title="Plugin.Base">Plugin.Base</a></li> |
|
269 </ul> |
|
270 </div> |
|
271 |
|
272 <div id="fileList" class="module"> |
|
273 <h4>Files</h4> |
|
274 <ul class="content"> |
|
275 <li class="selected"><a href="plugin.js.html" title="plugin.js">plugin.js</a></li> |
|
276 </ul> |
|
277 </div> |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 |
|
283 </div> |
|
284 </div> |
|
285 </div> |
|
286 <div id="ft"> |
|
287 <hr /> |
|
288 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
289 </div> |
|
290 </div> |
|
291 <script type="text/javascript"> |
|
292 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"}]; |
|
293 </script> |
|
294 </body> |
|
295 </html> |