|
1 <!DOCTYPE html> |
|
2 <html lang="en"> |
|
3 <head> |
|
4 <meta charset="utf-8"> |
|
5 <title>Plugin.Pjax - YUI 3</title> |
|
6 <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> |
|
7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> |
|
8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> |
|
9 <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> |
|
10 <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> |
|
11 </head> |
|
12 <body class="yui3-skin-sam"> |
|
13 |
|
14 <div id="doc"> |
|
15 <div id="hd" class="yui3-g header"> |
|
16 <div class="yui3-u-3-4"> |
|
17 |
|
18 <h1><img src="../assets/css/logo.png" title="YUI 3"></h1> |
|
19 |
|
20 </div> |
|
21 <div class="yui3-u-1-4 version"> |
|
22 <em>API Docs for: 3.10.3</em> |
|
23 </div> |
|
24 </div> |
|
25 <div id="bd" class="yui3-g"> |
|
26 |
|
27 <div class="yui3-u-1-4"> |
|
28 <div id="docs-sidebar" class="sidebar apidocs"> |
|
29 <div id="api-list"> |
|
30 <h2 class="off-left">APIs</h2> |
|
31 <div id="api-tabview" class="tabview"> |
|
32 <ul class="tabs"> |
|
33 <li><a href="#api-classes">Classes</a></li> |
|
34 <li><a href="#api-modules">Modules</a></li> |
|
35 </ul> |
|
36 |
|
37 <div id="api-tabview-filter"> |
|
38 <input type="search" id="api-filter" placeholder="Type to filter APIs"> |
|
39 </div> |
|
40 |
|
41 <div id="api-tabview-panel"> |
|
42 <ul id="api-classes" class="apis classes"> |
|
43 |
|
44 <li><a href="../classes/Anim.html">Anim</a></li> |
|
45 |
|
46 <li><a href="../classes/App.html">App</a></li> |
|
47 |
|
48 <li><a href="../classes/App.Base.html">App.Base</a></li> |
|
49 |
|
50 <li><a href="../classes/App.Content.html">App.Content</a></li> |
|
51 |
|
52 <li><a href="../classes/App.Transitions.html">App.Transitions</a></li> |
|
53 |
|
54 <li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li> |
|
55 |
|
56 <li><a href="../classes/AreaSeries.html">AreaSeries</a></li> |
|
57 |
|
58 <li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li> |
|
59 |
|
60 <li><a href="../classes/Array.html">Array</a></li> |
|
61 |
|
62 <li><a href="../classes/ArrayList.html">ArrayList</a></li> |
|
63 |
|
64 <li><a href="../classes/ArraySort.html">ArraySort</a></li> |
|
65 |
|
66 <li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li> |
|
67 |
|
68 <li><a href="../classes/Attribute.html">Attribute</a></li> |
|
69 |
|
70 <li><a href="../classes/AttributeCore.html">AttributeCore</a></li> |
|
71 |
|
72 <li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li> |
|
73 |
|
74 <li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li> |
|
75 |
|
76 <li><a href="../classes/AttributeLite.html">AttributeLite</a></li> |
|
77 |
|
78 <li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li> |
|
79 |
|
80 <li><a href="../classes/AutoComplete.html">AutoComplete</a></li> |
|
81 |
|
82 <li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li> |
|
83 |
|
84 <li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li> |
|
85 |
|
86 <li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li> |
|
87 |
|
88 <li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li> |
|
89 |
|
90 <li><a href="../classes/Axis.html">Axis</a></li> |
|
91 |
|
92 <li><a href="../classes/AxisBase.html">AxisBase</a></li> |
|
93 |
|
94 <li><a href="../classes/BarSeries.html">BarSeries</a></li> |
|
95 |
|
96 <li><a href="../classes/Base.html">Base</a></li> |
|
97 |
|
98 <li><a href="../classes/BaseCore.html">BaseCore</a></li> |
|
99 |
|
100 <li><a href="../classes/BaseObservable.html">BaseObservable</a></li> |
|
101 |
|
102 <li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li> |
|
103 |
|
104 <li><a href="../classes/Button.html">Button</a></li> |
|
105 |
|
106 <li><a href="../classes/ButtonCore.html">ButtonCore</a></li> |
|
107 |
|
108 <li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li> |
|
109 |
|
110 <li><a href="../classes/Cache.html">Cache</a></li> |
|
111 |
|
112 <li><a href="../classes/CacheOffline.html">CacheOffline</a></li> |
|
113 |
|
114 <li><a href="../classes/Calendar.html">Calendar</a></li> |
|
115 |
|
116 <li><a href="../classes/CalendarBase.html">CalendarBase</a></li> |
|
117 |
|
118 <li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li> |
|
119 |
|
120 <li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li> |
|
121 |
|
122 <li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li> |
|
123 |
|
124 <li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li> |
|
125 |
|
126 <li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li> |
|
127 |
|
128 <li><a href="../classes/CanvasPath.html">CanvasPath</a></li> |
|
129 |
|
130 <li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li> |
|
131 |
|
132 <li><a href="../classes/CanvasRect.html">CanvasRect</a></li> |
|
133 |
|
134 <li><a href="../classes/CanvasShape.html">CanvasShape</a></li> |
|
135 |
|
136 <li><a href="../classes/CartesianChart.html">CartesianChart</a></li> |
|
137 |
|
138 <li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li> |
|
139 |
|
140 <li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li> |
|
141 |
|
142 <li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li> |
|
143 |
|
144 <li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li> |
|
145 |
|
146 <li><a href="../classes/Chart.html">Chart</a></li> |
|
147 |
|
148 <li><a href="../classes/ChartBase.html">ChartBase</a></li> |
|
149 |
|
150 <li><a href="../classes/ChartLegend.html">ChartLegend</a></li> |
|
151 |
|
152 <li><a href="../classes/Circle.html">Circle</a></li> |
|
153 |
|
154 <li><a href="../classes/CircleGroup.html">CircleGroup</a></li> |
|
155 |
|
156 <li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li> |
|
157 |
|
158 <li><a href="../classes/ClickableRail.html">ClickableRail</a></li> |
|
159 |
|
160 <li><a href="../classes/Color.html">Color</a></li> |
|
161 |
|
162 <li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li> |
|
163 |
|
164 <li><a href="../classes/Color.HSL.html">Color.HSL</a></li> |
|
165 |
|
166 <li><a href="../classes/Color.HSV.html">Color.HSV</a></li> |
|
167 |
|
168 <li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li> |
|
169 |
|
170 <li><a href="../classes/ComboSeries.html">ComboSeries</a></li> |
|
171 |
|
172 <li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li> |
|
173 |
|
174 <li><a href="../classes/config.html">config</a></li> |
|
175 |
|
176 <li><a href="../classes/Console.html">Console</a></li> |
|
177 |
|
178 <li><a href="../classes/Controller.html">Controller</a></li> |
|
179 |
|
180 <li><a href="../classes/Cookie.html">Cookie</a></li> |
|
181 |
|
182 <li><a href="../classes/CurveUtil.html">CurveUtil</a></li> |
|
183 |
|
184 <li><a href="../classes/CustomEvent.html">CustomEvent</a></li> |
|
185 |
|
186 <li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li> |
|
187 |
|
188 <li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li> |
|
189 |
|
190 <li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li> |
|
191 |
|
192 <li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li> |
|
193 |
|
194 <li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li> |
|
195 |
|
196 <li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li> |
|
197 |
|
198 <li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li> |
|
199 |
|
200 <li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li> |
|
201 |
|
202 <li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li> |
|
203 |
|
204 <li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li> |
|
205 |
|
206 <li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li> |
|
207 |
|
208 <li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li> |
|
209 |
|
210 <li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li> |
|
211 |
|
212 <li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li> |
|
213 |
|
214 <li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li> |
|
215 |
|
216 <li><a href="../classes/DataTable.html">DataTable</a></li> |
|
217 |
|
218 <li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li> |
|
219 |
|
220 <li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li> |
|
221 |
|
222 <li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li> |
|
223 |
|
224 <li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li> |
|
225 |
|
226 <li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li> |
|
227 |
|
228 <li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li> |
|
229 |
|
230 <li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li> |
|
231 |
|
232 <li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li> |
|
233 |
|
234 <li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li> |
|
235 |
|
236 <li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li> |
|
237 |
|
238 <li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li> |
|
239 |
|
240 <li><a href="../classes/Date.html">Date</a></li> |
|
241 |
|
242 <li><a href="../classes/DD.DDM.html">DD.DDM</a></li> |
|
243 |
|
244 <li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li> |
|
245 |
|
246 <li><a href="../classes/DD.Drag.html">DD.Drag</a></li> |
|
247 |
|
248 <li><a href="../classes/DD.Drop.html">DD.Drop</a></li> |
|
249 |
|
250 <li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li> |
|
251 |
|
252 <li><a href="../classes/Dial.html">Dial</a></li> |
|
253 |
|
254 <li><a href="../classes/Do.html">Do</a></li> |
|
255 |
|
256 <li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li> |
|
257 |
|
258 <li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li> |
|
259 |
|
260 <li><a href="../classes/Do.Error.html">Do.Error</a></li> |
|
261 |
|
262 <li><a href="../classes/Do.Halt.html">Do.Halt</a></li> |
|
263 |
|
264 <li><a href="../classes/Do.Method.html">Do.Method</a></li> |
|
265 |
|
266 <li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li> |
|
267 |
|
268 <li><a href="../classes/DOM.html">DOM</a></li> |
|
269 |
|
270 <li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li> |
|
271 |
|
272 <li><a href="../classes/Drawing.html">Drawing</a></li> |
|
273 |
|
274 <li><a href="../classes/Easing.html">Easing</a></li> |
|
275 |
|
276 <li><a href="../classes/EditorBase.html">EditorBase</a></li> |
|
277 |
|
278 <li><a href="../classes/EditorSelection.html">EditorSelection</a></li> |
|
279 |
|
280 <li><a href="../classes/Ellipse.html">Ellipse</a></li> |
|
281 |
|
282 <li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li> |
|
283 |
|
284 <li><a href="../classes/Escape.html">Escape</a></li> |
|
285 |
|
286 <li><a href="../classes/Event.html">Event</a></li> |
|
287 |
|
288 <li><a href="../classes/EventFacade.html">EventFacade</a></li> |
|
289 |
|
290 <li><a href="../classes/EventHandle.html">EventHandle</a></li> |
|
291 |
|
292 <li><a href="../classes/EventTarget.html">EventTarget</a></li> |
|
293 |
|
294 <li><a href="../classes/ExecCommand.html">ExecCommand</a></li> |
|
295 |
|
296 <li><a href="../classes/Features.html">Features</a></li> |
|
297 |
|
298 <li><a href="../classes/File.html">File</a></li> |
|
299 |
|
300 <li><a href="../classes/FileFlash.html">FileFlash</a></li> |
|
301 |
|
302 <li><a href="../classes/FileHTML5.html">FileHTML5</a></li> |
|
303 |
|
304 <li><a href="../classes/Fills.html">Fills</a></li> |
|
305 |
|
306 <li><a href="../classes/Frame.html">Frame</a></li> |
|
307 |
|
308 <li><a href="../classes/Get.html">Get</a></li> |
|
309 |
|
310 <li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li> |
|
311 |
|
312 <li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li> |
|
313 |
|
314 <li><a href="../classes/Graph.html">Graph</a></li> |
|
315 |
|
316 <li><a href="../classes/Graphic.html">Graphic</a></li> |
|
317 |
|
318 <li><a href="../classes/GraphicBase.html">GraphicBase</a></li> |
|
319 |
|
320 <li><a href="../classes/Gridlines.html">Gridlines</a></li> |
|
321 |
|
322 <li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li> |
|
323 |
|
324 <li><a href="../classes/GroupRect.html">GroupRect</a></li> |
|
325 |
|
326 <li><a href="../classes/Handlebars.html">Handlebars</a></li> |
|
327 |
|
328 <li><a href="../classes/Highlight.html">Highlight</a></li> |
|
329 |
|
330 <li><a href="../classes/Histogram.html">Histogram</a></li> |
|
331 |
|
332 <li><a href="../classes/HistoryBase.html">HistoryBase</a></li> |
|
333 |
|
334 <li><a href="../classes/HistoryHash.html">HistoryHash</a></li> |
|
335 |
|
336 <li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li> |
|
337 |
|
338 <li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li> |
|
339 |
|
340 <li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li> |
|
341 |
|
342 <li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li> |
|
343 |
|
344 <li><a href="../classes/Intl.html">Intl</a></li> |
|
345 |
|
346 <li><a href="../classes/IO.html">IO</a></li> |
|
347 |
|
348 <li><a href="../classes/JSON.html">JSON</a></li> |
|
349 |
|
350 <li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li> |
|
351 |
|
352 <li><a href="../classes/Lang.html">Lang</a></li> |
|
353 |
|
354 <li><a href="../classes/LazyModelList.html">LazyModelList</a></li> |
|
355 |
|
356 <li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li> |
|
357 |
|
358 <li><a href="../classes/Lines.html">Lines</a></li> |
|
359 |
|
360 <li><a href="../classes/LineSeries.html">LineSeries</a></li> |
|
361 |
|
362 <li><a href="../classes/Loader.html">Loader</a></li> |
|
363 |
|
364 <li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li> |
|
365 |
|
366 <li><a href="../classes/Matrix.html">Matrix</a></li> |
|
367 |
|
368 <li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li> |
|
369 |
|
370 <li><a href="../classes/Model.html">Model</a></li> |
|
371 |
|
372 <li><a href="../classes/ModelList.html">ModelList</a></li> |
|
373 |
|
374 <li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li> |
|
375 |
|
376 <li><a href="../classes/Node.html">Node</a></li> |
|
377 |
|
378 <li><a href="../classes/NodeList.html">NodeList</a></li> |
|
379 |
|
380 <li><a href="../classes/Number.html">Number</a></li> |
|
381 |
|
382 <li><a href="../classes/NumericAxis.html">NumericAxis</a></li> |
|
383 |
|
384 <li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li> |
|
385 |
|
386 <li><a href="../classes/NumericImpl.html">NumericImpl</a></li> |
|
387 |
|
388 <li><a href="../classes/Object.html">Object</a></li> |
|
389 |
|
390 <li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li> |
|
391 |
|
392 <li><a href="../classes/Overlay.html">Overlay</a></li> |
|
393 |
|
394 <li><a href="../classes/Panel.html">Panel</a></li> |
|
395 |
|
396 <li><a href="../classes/Parallel.html">Parallel</a></li> |
|
397 |
|
398 <li><a href="../classes/Path.html">Path</a></li> |
|
399 |
|
400 <li><a href="../classes/PieChart.html">PieChart</a></li> |
|
401 |
|
402 <li><a href="../classes/PieSeries.html">PieSeries</a></li> |
|
403 |
|
404 <li><a href="../classes/Pjax.html">Pjax</a></li> |
|
405 |
|
406 <li><a href="../classes/PjaxBase.html">PjaxBase</a></li> |
|
407 |
|
408 <li><a href="../classes/PjaxContent.html">PjaxContent</a></li> |
|
409 |
|
410 <li><a href="../classes/Plots.html">Plots</a></li> |
|
411 |
|
412 <li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li> |
|
413 |
|
414 <li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li> |
|
415 |
|
416 <li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li> |
|
417 |
|
418 <li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li> |
|
419 |
|
420 <li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li> |
|
421 |
|
422 <li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li> |
|
423 |
|
424 <li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li> |
|
425 |
|
426 <li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li> |
|
427 |
|
428 <li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li> |
|
429 |
|
430 <li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li> |
|
431 |
|
432 <li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li> |
|
433 |
|
434 <li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li> |
|
435 |
|
436 <li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li> |
|
437 |
|
438 <li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li> |
|
439 |
|
440 <li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li> |
|
441 |
|
442 <li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li> |
|
443 |
|
444 <li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li> |
|
445 |
|
446 <li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li> |
|
447 |
|
448 <li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li> |
|
449 |
|
450 <li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li> |
|
451 |
|
452 <li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li> |
|
453 |
|
454 <li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li> |
|
455 |
|
456 <li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li> |
|
457 |
|
458 <li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li> |
|
459 |
|
460 <li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li> |
|
461 |
|
462 <li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li> |
|
463 |
|
464 <li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li> |
|
465 |
|
466 <li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li> |
|
467 |
|
468 <li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li> |
|
469 |
|
470 <li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li> |
|
471 |
|
472 <li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li> |
|
473 |
|
474 <li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li> |
|
475 |
|
476 <li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li> |
|
477 |
|
478 <li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li> |
|
479 |
|
480 <li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li> |
|
481 |
|
482 <li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li> |
|
483 |
|
484 <li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li> |
|
485 |
|
486 <li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li> |
|
487 |
|
488 <li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li> |
|
489 |
|
490 <li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li> |
|
491 |
|
492 <li><a href="../classes/Pollable.html">Pollable</a></li> |
|
493 |
|
494 <li><a href="../classes/Promise.html">Promise</a></li> |
|
495 |
|
496 <li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li> |
|
497 |
|
498 <li><a href="../classes/QueryString.html">QueryString</a></li> |
|
499 |
|
500 <li><a href="../classes/Queue.html">Queue</a></li> |
|
501 |
|
502 <li><a href="../classes/RangeSeries.html">RangeSeries</a></li> |
|
503 |
|
504 <li><a href="../classes/Record.html">Record</a></li> |
|
505 |
|
506 <li><a href="../classes/Recordset.html">Recordset</a></li> |
|
507 |
|
508 <li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li> |
|
509 |
|
510 <li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li> |
|
511 |
|
512 <li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li> |
|
513 |
|
514 <li><a href="../classes/Rect.html">Rect</a></li> |
|
515 |
|
516 <li><a href="../classes/Renderer.html">Renderer</a></li> |
|
517 |
|
518 <li><a href="../classes/Resize.html">Resize</a></li> |
|
519 |
|
520 <li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li> |
|
521 |
|
522 <li><a href="../classes/Router.html">Router</a></li> |
|
523 |
|
524 <li><a href="../classes/ScrollView.html">ScrollView</a></li> |
|
525 |
|
526 <li><a href="../classes/Selector.html">Selector</a></li> |
|
527 |
|
528 <li><a href="../classes/SeriesBase.html">SeriesBase</a></li> |
|
529 |
|
530 <li><a href="../classes/Shape.html">Shape</a></li> |
|
531 |
|
532 <li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li> |
|
533 |
|
534 <li><a href="../classes/Slider.html">Slider</a></li> |
|
535 |
|
536 <li><a href="../classes/SliderBase.html">SliderBase</a></li> |
|
537 |
|
538 <li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li> |
|
539 |
|
540 <li><a href="../classes/soon.html">soon</a></li> |
|
541 |
|
542 <li><a href="../classes/Sortable.html">Sortable</a></li> |
|
543 |
|
544 <li><a href="../classes/SplineSeries.html">SplineSeries</a></li> |
|
545 |
|
546 <li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li> |
|
547 |
|
548 <li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li> |
|
549 |
|
550 <li><a href="../classes/StackedAxis.html">StackedAxis</a></li> |
|
551 |
|
552 <li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li> |
|
553 |
|
554 <li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li> |
|
555 |
|
556 <li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li> |
|
557 |
|
558 <li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li> |
|
559 |
|
560 <li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li> |
|
561 |
|
562 <li><a href="../classes/StackedImpl.html">StackedImpl</a></li> |
|
563 |
|
564 <li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li> |
|
565 |
|
566 <li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li> |
|
567 |
|
568 <li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li> |
|
569 |
|
570 <li><a href="../classes/StackingUtil.html">StackingUtil</a></li> |
|
571 |
|
572 <li><a href="../classes/State.html">State</a></li> |
|
573 |
|
574 <li><a href="../classes/StyleSheet.html">StyleSheet</a></li> |
|
575 |
|
576 <li><a href="../classes/Subscriber.html">Subscriber</a></li> |
|
577 |
|
578 <li><a href="../classes/SVGCircle.html">SVGCircle</a></li> |
|
579 |
|
580 <li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li> |
|
581 |
|
582 <li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li> |
|
583 |
|
584 <li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li> |
|
585 |
|
586 <li><a href="../classes/SVGPath.html">SVGPath</a></li> |
|
587 |
|
588 <li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li> |
|
589 |
|
590 <li><a href="../classes/SVGRect.html">SVGRect</a></li> |
|
591 |
|
592 <li><a href="../classes/SVGShape.html">SVGShape</a></li> |
|
593 |
|
594 <li><a href="../classes/SWF.html">SWF</a></li> |
|
595 |
|
596 <li><a href="../classes/SWFDetect.html">SWFDetect</a></li> |
|
597 |
|
598 <li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li> |
|
599 |
|
600 <li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li> |
|
601 |
|
602 <li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li> |
|
603 |
|
604 <li><a href="../classes/Tab.html">Tab</a></li> |
|
605 |
|
606 <li><a href="../classes/TabView.html">TabView</a></li> |
|
607 |
|
608 <li><a href="../classes/Template.html">Template</a></li> |
|
609 |
|
610 <li><a href="../classes/Template.Micro.html">Template.Micro</a></li> |
|
611 |
|
612 <li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li> |
|
613 |
|
614 <li><a href="../classes/Test.Assert.html">Test.Assert</a></li> |
|
615 |
|
616 <li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li> |
|
617 |
|
618 <li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li> |
|
619 |
|
620 <li><a href="../classes/Test.Console.html">Test.Console</a></li> |
|
621 |
|
622 <li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li> |
|
623 |
|
624 <li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li> |
|
625 |
|
626 <li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li> |
|
627 |
|
628 <li><a href="../classes/Test.Mock.html">Test.Mock</a></li> |
|
629 |
|
630 <li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li> |
|
631 |
|
632 <li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li> |
|
633 |
|
634 <li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li> |
|
635 |
|
636 <li><a href="../classes/Test.Results.html">Test.Results</a></li> |
|
637 |
|
638 <li><a href="../classes/Test.Runner.html">Test.Runner</a></li> |
|
639 |
|
640 <li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li> |
|
641 |
|
642 <li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li> |
|
643 |
|
644 <li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li> |
|
645 |
|
646 <li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li> |
|
647 |
|
648 <li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li> |
|
649 |
|
650 <li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li> |
|
651 |
|
652 <li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li> |
|
653 |
|
654 <li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li> |
|
655 |
|
656 <li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li> |
|
657 |
|
658 <li><a href="../classes/Test.Wait.html">Test.Wait</a></li> |
|
659 |
|
660 <li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li> |
|
661 |
|
662 <li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li> |
|
663 |
|
664 <li><a href="../classes/TimeAxis.html">TimeAxis</a></li> |
|
665 |
|
666 <li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li> |
|
667 |
|
668 <li><a href="../classes/TimeImpl.html">TimeImpl</a></li> |
|
669 |
|
670 <li><a href="../classes/ToggleButton.html">ToggleButton</a></li> |
|
671 |
|
672 <li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li> |
|
673 |
|
674 <li><a href="../classes/Transition.html">Transition</a></li> |
|
675 |
|
676 <li><a href="../classes/Tree.html">Tree</a></li> |
|
677 |
|
678 <li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li> |
|
679 |
|
680 <li><a href="../classes/Tree.Node.html">Tree.Node</a></li> |
|
681 |
|
682 <li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li> |
|
683 |
|
684 <li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li> |
|
685 |
|
686 <li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li> |
|
687 |
|
688 <li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li> |
|
689 |
|
690 <li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li> |
|
691 |
|
692 <li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li> |
|
693 |
|
694 <li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li> |
|
695 |
|
696 <li><a href="../classes/UA.html">UA</a></li> |
|
697 |
|
698 <li><a href="../classes/Uploader.html">Uploader</a></li> |
|
699 |
|
700 <li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li> |
|
701 |
|
702 <li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li> |
|
703 |
|
704 <li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li> |
|
705 |
|
706 <li><a href="../classes/ValueChange.html">ValueChange</a></li> |
|
707 |
|
708 <li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li> |
|
709 |
|
710 <li><a href="../classes/View.html">View</a></li> |
|
711 |
|
712 <li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li> |
|
713 |
|
714 <li><a href="../classes/VMLCircle.html">VMLCircle</a></li> |
|
715 |
|
716 <li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li> |
|
717 |
|
718 <li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li> |
|
719 |
|
720 <li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li> |
|
721 |
|
722 <li><a href="../classes/VMLPath.html">VMLPath</a></li> |
|
723 |
|
724 <li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li> |
|
725 |
|
726 <li><a href="../classes/VMLRect.html">VMLRect</a></li> |
|
727 |
|
728 <li><a href="../classes/VMLShape.html">VMLShape</a></li> |
|
729 |
|
730 <li><a href="../classes/Widget.html">Widget</a></li> |
|
731 |
|
732 <li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li> |
|
733 |
|
734 <li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li> |
|
735 |
|
736 <li><a href="../classes/WidgetChild.html">WidgetChild</a></li> |
|
737 |
|
738 <li><a href="../classes/WidgetModality.html">WidgetModality</a></li> |
|
739 |
|
740 <li><a href="../classes/WidgetParent.html">WidgetParent</a></li> |
|
741 |
|
742 <li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li> |
|
743 |
|
744 <li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li> |
|
745 |
|
746 <li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li> |
|
747 |
|
748 <li><a href="../classes/WidgetStack.html">WidgetStack</a></li> |
|
749 |
|
750 <li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li> |
|
751 |
|
752 <li><a href="../classes/XML.html">XML</a></li> |
|
753 |
|
754 <li><a href="../classes/YQL.html">YQL</a></li> |
|
755 |
|
756 <li><a href="../classes/YQLRequest.html">YQLRequest</a></li> |
|
757 |
|
758 <li><a href="../classes/YUI.html">YUI</a></li> |
|
759 |
|
760 <li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li> |
|
761 |
|
762 </ul> |
|
763 |
|
764 <ul id="api-modules" class="apis modules"> |
|
765 |
|
766 <li><a href="../modules/align-plugin.html">align-plugin</a></li> |
|
767 |
|
768 <li><a href="../modules/anim.html">anim</a></li> |
|
769 |
|
770 <li><a href="../modules/anim-base.html">anim-base</a></li> |
|
771 |
|
772 <li><a href="../modules/anim-color.html">anim-color</a></li> |
|
773 |
|
774 <li><a href="../modules/anim-curve.html">anim-curve</a></li> |
|
775 |
|
776 <li><a href="../modules/anim-easing.html">anim-easing</a></li> |
|
777 |
|
778 <li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li> |
|
779 |
|
780 <li><a href="../modules/anim-scroll.html">anim-scroll</a></li> |
|
781 |
|
782 <li><a href="../modules/anim-shape.html">anim-shape</a></li> |
|
783 |
|
784 <li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li> |
|
785 |
|
786 <li><a href="../modules/anim-xy.html">anim-xy</a></li> |
|
787 |
|
788 <li><a href="../modules/app.html">app</a></li> |
|
789 |
|
790 <li><a href="../modules/app-base.html">app-base</a></li> |
|
791 |
|
792 <li><a href="../modules/app-content.html">app-content</a></li> |
|
793 |
|
794 <li><a href="../modules/app-transitions.html">app-transitions</a></li> |
|
795 |
|
796 <li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li> |
|
797 |
|
798 <li><a href="../modules/array-extras.html">array-extras</a></li> |
|
799 |
|
800 <li><a href="../modules/array-invoke.html">array-invoke</a></li> |
|
801 |
|
802 <li><a href="../modules/arraylist.html">arraylist</a></li> |
|
803 |
|
804 <li><a href="../modules/arraylist-add.html">arraylist-add</a></li> |
|
805 |
|
806 <li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li> |
|
807 |
|
808 <li><a href="../modules/arraysort.html">arraysort</a></li> |
|
809 |
|
810 <li><a href="../modules/async-queue.html">async-queue</a></li> |
|
811 |
|
812 <li><a href="../modules/attribute.html">attribute</a></li> |
|
813 |
|
814 <li><a href="../modules/attribute-base.html">attribute-base</a></li> |
|
815 |
|
816 <li><a href="../modules/attribute-complex.html">attribute-complex</a></li> |
|
817 |
|
818 <li><a href="../modules/attribute-core.html">attribute-core</a></li> |
|
819 |
|
820 <li><a href="../modules/attribute-extras.html">attribute-extras</a></li> |
|
821 |
|
822 <li><a href="../modules/attribute-observable.html">attribute-observable</a></li> |
|
823 |
|
824 <li><a href="../modules/autocomplete.html">autocomplete</a></li> |
|
825 |
|
826 <li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li> |
|
827 |
|
828 <li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li> |
|
829 |
|
830 <li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li> |
|
831 |
|
832 <li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li> |
|
833 |
|
834 <li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li> |
|
835 |
|
836 <li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li> |
|
837 |
|
838 <li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li> |
|
839 |
|
840 <li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li> |
|
841 |
|
842 <li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li> |
|
843 |
|
844 <li><a href="../modules/axis.html">axis</a></li> |
|
845 |
|
846 <li><a href="../modules/axis-base.html">axis-base</a></li> |
|
847 |
|
848 <li><a href="../modules/axis-category.html">axis-category</a></li> |
|
849 |
|
850 <li><a href="../modules/axis-category-base.html">axis-category-base</a></li> |
|
851 |
|
852 <li><a href="../modules/axis-numeric.html">axis-numeric</a></li> |
|
853 |
|
854 <li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li> |
|
855 |
|
856 <li><a href="../modules/axis-stacked.html">axis-stacked</a></li> |
|
857 |
|
858 <li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li> |
|
859 |
|
860 <li><a href="../modules/axis-time.html">axis-time</a></li> |
|
861 |
|
862 <li><a href="../modules/axis-time-base.html">axis-time-base</a></li> |
|
863 |
|
864 <li><a href="../modules/base.html">base</a></li> |
|
865 |
|
866 <li><a href="../modules/base-base.html">base-base</a></li> |
|
867 |
|
868 <li><a href="../modules/base-build.html">base-build</a></li> |
|
869 |
|
870 <li><a href="../modules/base-core.html">base-core</a></li> |
|
871 |
|
872 <li><a href="../modules/base-observable.html">base-observable</a></li> |
|
873 |
|
874 <li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li> |
|
875 |
|
876 <li><a href="../modules/button.html">button</a></li> |
|
877 |
|
878 <li><a href="../modules/button-core.html">button-core</a></li> |
|
879 |
|
880 <li><a href="../modules/button-group.html">button-group</a></li> |
|
881 |
|
882 <li><a href="../modules/button-plugin.html">button-plugin</a></li> |
|
883 |
|
884 <li><a href="../modules/cache.html">cache</a></li> |
|
885 |
|
886 <li><a href="../modules/cache-base.html">cache-base</a></li> |
|
887 |
|
888 <li><a href="../modules/cache-offline.html">cache-offline</a></li> |
|
889 |
|
890 <li><a href="../modules/cache-plugin.html">cache-plugin</a></li> |
|
891 |
|
892 <li><a href="../modules/calendar.html">calendar</a></li> |
|
893 |
|
894 <li><a href="../modules/calendar-base.html">calendar-base</a></li> |
|
895 |
|
896 <li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li> |
|
897 |
|
898 <li><a href="../modules/charts.html">charts</a></li> |
|
899 |
|
900 <li><a href="../modules/charts-base.html">charts-base</a></li> |
|
901 |
|
902 <li><a href="../modules/charts-legend.html">charts-legend</a></li> |
|
903 |
|
904 <li><a href="../modules/classnamemanager.html">classnamemanager</a></li> |
|
905 |
|
906 <li><a href="../modules/clickable-rail.html">clickable-rail</a></li> |
|
907 |
|
908 <li><a href="../modules/collection.html">collection</a></li> |
|
909 |
|
910 <li><a href="../modules/color.html">color</a></li> |
|
911 |
|
912 <li><a href="../modules/color-base.html">color-base</a></li> |
|
913 |
|
914 <li><a href="../modules/color-harmony.html">color-harmony</a></li> |
|
915 |
|
916 <li><a href="../modules/color-hsl.html">color-hsl</a></li> |
|
917 |
|
918 <li><a href="../modules/color-hsv.html">color-hsv</a></li> |
|
919 |
|
920 <li><a href="../modules/console.html">console</a></li> |
|
921 |
|
922 <li><a href="../modules/console-filters.html">console-filters</a></li> |
|
923 |
|
924 <li><a href="../modules/cookie.html">cookie</a></li> |
|
925 |
|
926 <li><a href="../modules/createlink-base.html">createlink-base</a></li> |
|
927 |
|
928 <li><a href="../modules/dataschema.html">dataschema</a></li> |
|
929 |
|
930 <li><a href="../modules/dataschema-array.html">dataschema-array</a></li> |
|
931 |
|
932 <li><a href="../modules/dataschema-base.html">dataschema-base</a></li> |
|
933 |
|
934 <li><a href="../modules/dataschema-json.html">dataschema-json</a></li> |
|
935 |
|
936 <li><a href="../modules/dataschema-text.html">dataschema-text</a></li> |
|
937 |
|
938 <li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li> |
|
939 |
|
940 <li><a href="../modules/datasource.html">datasource</a></li> |
|
941 |
|
942 <li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li> |
|
943 |
|
944 <li><a href="../modules/datasource-cache.html">datasource-cache</a></li> |
|
945 |
|
946 <li><a href="../modules/datasource-function.html">datasource-function</a></li> |
|
947 |
|
948 <li><a href="../modules/datasource-get.html">datasource-get</a></li> |
|
949 |
|
950 <li><a href="../modules/datasource-io.html">datasource-io</a></li> |
|
951 |
|
952 <li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li> |
|
953 |
|
954 <li><a href="../modules/datasource-local.html">datasource-local</a></li> |
|
955 |
|
956 <li><a href="../modules/datasource-polling.html">datasource-polling</a></li> |
|
957 |
|
958 <li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li> |
|
959 |
|
960 <li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li> |
|
961 |
|
962 <li><a href="../modules/datatable.html">datatable</a></li> |
|
963 |
|
964 <li><a href="../modules/datatable-base.html">datatable-base</a></li> |
|
965 |
|
966 <li><a href="../modules/datatable-body.html">datatable-body</a></li> |
|
967 |
|
968 <li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li> |
|
969 |
|
970 <li><a href="../modules/datatable-core.html">datatable-core</a></li> |
|
971 |
|
972 <li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li> |
|
973 |
|
974 <li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li> |
|
975 |
|
976 <li><a href="../modules/datatable-head.html">datatable-head</a></li> |
|
977 |
|
978 <li><a href="../modules/datatable-message.html">datatable-message</a></li> |
|
979 |
|
980 <li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li> |
|
981 |
|
982 <li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li> |
|
983 |
|
984 <li><a href="../modules/datatable-sort.html">datatable-sort</a></li> |
|
985 |
|
986 <li><a href="../modules/datatable-table.html">datatable-table</a></li> |
|
987 |
|
988 <li><a href="../modules/datatype.html">datatype</a></li> |
|
989 |
|
990 <li><a href="../modules/datatype-date.html">datatype-date</a></li> |
|
991 |
|
992 <li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li> |
|
993 |
|
994 <li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li> |
|
995 |
|
996 <li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li> |
|
997 |
|
998 <li><a href="../modules/datatype-number.html">datatype-number</a></li> |
|
999 |
|
1000 <li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li> |
|
1001 |
|
1002 <li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li> |
|
1003 |
|
1004 <li><a href="../modules/datatype-xml.html">datatype-xml</a></li> |
|
1005 |
|
1006 <li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li> |
|
1007 |
|
1008 <li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li> |
|
1009 |
|
1010 <li><a href="../modules/dd.html">dd</a></li> |
|
1011 |
|
1012 <li><a href="../modules/dd-constrain.html">dd-constrain</a></li> |
|
1013 |
|
1014 <li><a href="../modules/dd-ddm.html">dd-ddm</a></li> |
|
1015 |
|
1016 <li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li> |
|
1017 |
|
1018 <li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li> |
|
1019 |
|
1020 <li><a href="../modules/dd-delegate.html">dd-delegate</a></li> |
|
1021 |
|
1022 <li><a href="../modules/dd-drag.html">dd-drag</a></li> |
|
1023 |
|
1024 <li><a href="../modules/dd-drop.html">dd-drop</a></li> |
|
1025 |
|
1026 <li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li> |
|
1027 |
|
1028 <li><a href="../modules/dd-gestures.html">dd-gestures</a></li> |
|
1029 |
|
1030 <li><a href="../modules/dd-plugin.html">dd-plugin</a></li> |
|
1031 |
|
1032 <li><a href="../modules/dd-proxy.html">dd-proxy</a></li> |
|
1033 |
|
1034 <li><a href="../modules/dd-scroll.html">dd-scroll</a></li> |
|
1035 |
|
1036 <li><a href="../modules/dial.html">dial</a></li> |
|
1037 |
|
1038 <li><a href="../modules/dom.html">dom</a></li> |
|
1039 |
|
1040 <li><a href="../modules/dom-base.html">dom-base</a></li> |
|
1041 |
|
1042 <li><a href="../modules/dom-screen.html">dom-screen</a></li> |
|
1043 |
|
1044 <li><a href="../modules/dom-style.html">dom-style</a></li> |
|
1045 |
|
1046 <li><a href="../modules/dump.html">dump</a></li> |
|
1047 |
|
1048 <li><a href="../modules/editor.html">editor</a></li> |
|
1049 |
|
1050 <li><a href="../modules/editor-base.html">editor-base</a></li> |
|
1051 |
|
1052 <li><a href="../modules/editor-bidi.html">editor-bidi</a></li> |
|
1053 |
|
1054 <li><a href="../modules/editor-br.html">editor-br</a></li> |
|
1055 |
|
1056 <li><a href="../modules/editor-lists.html">editor-lists</a></li> |
|
1057 |
|
1058 <li><a href="../modules/editor-para.html">editor-para</a></li> |
|
1059 |
|
1060 <li><a href="../modules/editor-para-base.html">editor-para-base</a></li> |
|
1061 |
|
1062 <li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li> |
|
1063 |
|
1064 <li><a href="../modules/editor-tab.html">editor-tab</a></li> |
|
1065 |
|
1066 <li><a href="../modules/escape.html">escape</a></li> |
|
1067 |
|
1068 <li><a href="../modules/event.html">event</a></li> |
|
1069 |
|
1070 <li><a href="../modules/event-base.html">event-base</a></li> |
|
1071 |
|
1072 <li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li> |
|
1073 |
|
1074 <li><a href="../modules/event-custom.html">event-custom</a></li> |
|
1075 |
|
1076 <li><a href="../modules/event-custom-base.html">event-custom-base</a></li> |
|
1077 |
|
1078 <li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li> |
|
1079 |
|
1080 <li><a href="../modules/event-delegate.html">event-delegate</a></li> |
|
1081 |
|
1082 <li><a href="../modules/event-flick.html">event-flick</a></li> |
|
1083 |
|
1084 <li><a href="../modules/event-focus.html">event-focus</a></li> |
|
1085 |
|
1086 <li><a href="../modules/event-gestures.html">event-gestures</a></li> |
|
1087 |
|
1088 <li><a href="../modules/event-hover.html">event-hover</a></li> |
|
1089 |
|
1090 <li><a href="../modules/event-key.html">event-key</a></li> |
|
1091 |
|
1092 <li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li> |
|
1093 |
|
1094 <li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li> |
|
1095 |
|
1096 <li><a href="../modules/event-move.html">event-move</a></li> |
|
1097 |
|
1098 <li><a href="../modules/event-outside.html">event-outside</a></li> |
|
1099 |
|
1100 <li><a href="../modules/event-resize.html">event-resize</a></li> |
|
1101 |
|
1102 <li><a href="../modules/event-simulate.html">event-simulate</a></li> |
|
1103 |
|
1104 <li><a href="../modules/event-synthetic.html">event-synthetic</a></li> |
|
1105 |
|
1106 <li><a href="../modules/event-tap.html">event-tap</a></li> |
|
1107 |
|
1108 <li><a href="../modules/event-touch.html">event-touch</a></li> |
|
1109 |
|
1110 <li><a href="../modules/event-valuechange.html">event-valuechange</a></li> |
|
1111 |
|
1112 <li><a href="../modules/exec-command.html">exec-command</a></li> |
|
1113 |
|
1114 <li><a href="../modules/features.html">features</a></li> |
|
1115 |
|
1116 <li><a href="../modules/file.html">file</a></li> |
|
1117 |
|
1118 <li><a href="../modules/file-flash.html">file-flash</a></li> |
|
1119 |
|
1120 <li><a href="../modules/file-html5.html">file-html5</a></li> |
|
1121 |
|
1122 <li><a href="../modules/frame.html">frame</a></li> |
|
1123 |
|
1124 <li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li> |
|
1125 |
|
1126 <li><a href="../modules/get.html">get</a></li> |
|
1127 |
|
1128 <li><a href="../modules/get-nodejs.html">get-nodejs</a></li> |
|
1129 |
|
1130 <li><a href="../modules/graphics.html">graphics</a></li> |
|
1131 |
|
1132 <li><a href="../modules/graphics-group.html">graphics-group</a></li> |
|
1133 |
|
1134 <li><a href="../modules/handlebars.html">handlebars</a></li> |
|
1135 |
|
1136 <li><a href="../modules/handlebars-base.html">handlebars-base</a></li> |
|
1137 |
|
1138 <li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li> |
|
1139 |
|
1140 <li><a href="../modules/highlight.html">highlight</a></li> |
|
1141 |
|
1142 <li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li> |
|
1143 |
|
1144 <li><a href="../modules/highlight-base.html">highlight-base</a></li> |
|
1145 |
|
1146 <li><a href="../modules/history.html">history</a></li> |
|
1147 |
|
1148 <li><a href="../modules/history-base.html">history-base</a></li> |
|
1149 |
|
1150 <li><a href="../modules/history-hash.html">history-hash</a></li> |
|
1151 |
|
1152 <li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li> |
|
1153 |
|
1154 <li><a href="../modules/history-html5.html">history-html5</a></li> |
|
1155 |
|
1156 <li><a href="../modules/imageloader.html">imageloader</a></li> |
|
1157 |
|
1158 <li><a href="../modules/intl.html">intl</a></li> |
|
1159 |
|
1160 <li><a href="../modules/io.html">io</a></li> |
|
1161 |
|
1162 <li><a href="../modules/io-base.html">io-base</a></li> |
|
1163 |
|
1164 <li><a href="../modules/io-form.html">io-form</a></li> |
|
1165 |
|
1166 <li><a href="../modules/io-nodejs.html">io-nodejs</a></li> |
|
1167 |
|
1168 <li><a href="../modules/io-queue.html">io-queue</a></li> |
|
1169 |
|
1170 <li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li> |
|
1171 |
|
1172 <li><a href="../modules/io-xdr.html">io-xdr</a></li> |
|
1173 |
|
1174 <li><a href="../modules/json.html">json</a></li> |
|
1175 |
|
1176 <li><a href="../modules/json-parse.html">json-parse</a></li> |
|
1177 |
|
1178 <li><a href="../modules/json-stringify.html">json-stringify</a></li> |
|
1179 |
|
1180 <li><a href="../modules/jsonp.html">jsonp</a></li> |
|
1181 |
|
1182 <li><a href="../modules/jsonp-url.html">jsonp-url</a></li> |
|
1183 |
|
1184 <li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li> |
|
1185 |
|
1186 <li><a href="../modules/loader.html">loader</a></li> |
|
1187 |
|
1188 <li><a href="../modules/loader-base.html">loader-base</a></li> |
|
1189 |
|
1190 <li><a href="../modules/loader-yui3.html">loader-yui3</a></li> |
|
1191 |
|
1192 <li><a href="../modules/matrix.html">matrix</a></li> |
|
1193 |
|
1194 <li><a href="../modules/model.html">model</a></li> |
|
1195 |
|
1196 <li><a href="../modules/model-list.html">model-list</a></li> |
|
1197 |
|
1198 <li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li> |
|
1199 |
|
1200 <li><a href="../modules/node.html">node</a></li> |
|
1201 |
|
1202 <li><a href="../modules/node-base.html">node-base</a></li> |
|
1203 |
|
1204 <li><a href="../modules/node-core.html">node-core</a></li> |
|
1205 |
|
1206 <li><a href="../modules/node-data.html">node-data</a></li> |
|
1207 |
|
1208 <li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li> |
|
1209 |
|
1210 <li><a href="../modules/node-event-html5.html">node-event-html5</a></li> |
|
1211 |
|
1212 <li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li> |
|
1213 |
|
1214 <li><a href="../modules/node-flick.html">node-flick</a></li> |
|
1215 |
|
1216 <li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li> |
|
1217 |
|
1218 <li><a href="../modules/node-load.html">node-load</a></li> |
|
1219 |
|
1220 <li><a href="../modules/node-menunav.html">node-menunav</a></li> |
|
1221 |
|
1222 <li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li> |
|
1223 |
|
1224 <li><a href="../modules/node-screen.html">node-screen</a></li> |
|
1225 |
|
1226 <li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li> |
|
1227 |
|
1228 <li><a href="../modules/node-style.html">node-style</a></li> |
|
1229 |
|
1230 <li><a href="../modules/oop.html">oop</a></li> |
|
1231 |
|
1232 <li><a href="../modules/overlay.html">overlay</a></li> |
|
1233 |
|
1234 <li><a href="../modules/panel.html">panel</a></li> |
|
1235 |
|
1236 <li><a href="../modules/parallel.html">parallel</a></li> |
|
1237 |
|
1238 <li><a href="../modules/pjax.html">pjax</a></li> |
|
1239 |
|
1240 <li><a href="../modules/pjax-base.html">pjax-base</a></li> |
|
1241 |
|
1242 <li><a href="../modules/pjax-content.html">pjax-content</a></li> |
|
1243 |
|
1244 <li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li> |
|
1245 |
|
1246 <li><a href="../modules/plugin.html">plugin</a></li> |
|
1247 |
|
1248 <li><a href="../modules/pluginhost.html">pluginhost</a></li> |
|
1249 |
|
1250 <li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li> |
|
1251 |
|
1252 <li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li> |
|
1253 |
|
1254 <li><a href="../modules/promise.html">promise</a></li> |
|
1255 |
|
1256 <li><a href="../modules/querystring.html">querystring</a></li> |
|
1257 |
|
1258 <li><a href="../modules/querystring-parse.html">querystring-parse</a></li> |
|
1259 |
|
1260 <li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li> |
|
1261 |
|
1262 <li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li> |
|
1263 |
|
1264 <li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li> |
|
1265 |
|
1266 <li><a href="../modules/queue-promote.html">queue-promote</a></li> |
|
1267 |
|
1268 <li><a href="../modules/range-slider.html">range-slider</a></li> |
|
1269 |
|
1270 <li><a href="../modules/recordset.html">recordset</a></li> |
|
1271 |
|
1272 <li><a href="../modules/recordset-base.html">recordset-base</a></li> |
|
1273 |
|
1274 <li><a href="../modules/recordset-filter.html">recordset-filter</a></li> |
|
1275 |
|
1276 <li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li> |
|
1277 |
|
1278 <li><a href="../modules/recordset-sort.html">recordset-sort</a></li> |
|
1279 |
|
1280 <li><a href="../modules/resize.html">resize</a></li> |
|
1281 |
|
1282 <li><a href="../modules/resize-contrain.html">resize-contrain</a></li> |
|
1283 |
|
1284 <li><a href="../modules/resize-plugin.html">resize-plugin</a></li> |
|
1285 |
|
1286 <li><a href="../modules/resize-proxy.html">resize-proxy</a></li> |
|
1287 |
|
1288 <li><a href="../modules/rollup.html">rollup</a></li> |
|
1289 |
|
1290 <li><a href="../modules/router.html">router</a></li> |
|
1291 |
|
1292 <li><a href="../modules/scrollview.html">scrollview</a></li> |
|
1293 |
|
1294 <li><a href="../modules/scrollview-base.html">scrollview-base</a></li> |
|
1295 |
|
1296 <li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li> |
|
1297 |
|
1298 <li><a href="../modules/scrollview-list.html">scrollview-list</a></li> |
|
1299 |
|
1300 <li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li> |
|
1301 |
|
1302 <li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li> |
|
1303 |
|
1304 <li><a href="../modules/selection.html">selection</a></li> |
|
1305 |
|
1306 <li><a href="../modules/selector-css2.html">selector-css2</a></li> |
|
1307 |
|
1308 <li><a href="../modules/selector-css3.html">selector-css3</a></li> |
|
1309 |
|
1310 <li><a href="../modules/selector-native.html">selector-native</a></li> |
|
1311 |
|
1312 <li><a href="../modules/series-area.html">series-area</a></li> |
|
1313 |
|
1314 <li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li> |
|
1315 |
|
1316 <li><a href="../modules/series-areaspline.html">series-areaspline</a></li> |
|
1317 |
|
1318 <li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li> |
|
1319 |
|
1320 <li><a href="../modules/series-bar.html">series-bar</a></li> |
|
1321 |
|
1322 <li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li> |
|
1323 |
|
1324 <li><a href="../modules/series-base.html">series-base</a></li> |
|
1325 |
|
1326 <li><a href="../modules/series-candlestick.html">series-candlestick</a></li> |
|
1327 |
|
1328 <li><a href="../modules/series-cartesian.html">series-cartesian</a></li> |
|
1329 |
|
1330 <li><a href="../modules/series-column.html">series-column</a></li> |
|
1331 |
|
1332 <li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li> |
|
1333 |
|
1334 <li><a href="../modules/series-combo.html">series-combo</a></li> |
|
1335 |
|
1336 <li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li> |
|
1337 |
|
1338 <li><a href="../modules/series-combospline.html">series-combospline</a></li> |
|
1339 |
|
1340 <li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li> |
|
1341 |
|
1342 <li><a href="../modules/series-curve-util.html">series-curve-util</a></li> |
|
1343 |
|
1344 <li><a href="../modules/series-fill-util.html">series-fill-util</a></li> |
|
1345 |
|
1346 <li><a href="../modules/series-histogram.html">series-histogram</a></li> |
|
1347 |
|
1348 <li><a href="../modules/series-line.html">series-line</a></li> |
|
1349 |
|
1350 <li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li> |
|
1351 |
|
1352 <li><a href="../modules/series-line-util.html">series-line-util</a></li> |
|
1353 |
|
1354 <li><a href="../modules/series-marker.html">series-marker</a></li> |
|
1355 |
|
1356 <li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li> |
|
1357 |
|
1358 <li><a href="../modules/series-ohlc.html">series-ohlc</a></li> |
|
1359 |
|
1360 <li><a href="../modules/series-pie.html">series-pie</a></li> |
|
1361 |
|
1362 <li><a href="../modules/series-plot-util.html">series-plot-util</a></li> |
|
1363 |
|
1364 <li><a href="../modules/series-range.html">series-range</a></li> |
|
1365 |
|
1366 <li><a href="../modules/series-spline.html">series-spline</a></li> |
|
1367 |
|
1368 <li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li> |
|
1369 |
|
1370 <li><a href="../modules/series-stacked.html">series-stacked</a></li> |
|
1371 |
|
1372 <li><a href="../modules/shim-plugin.html">shim-plugin</a></li> |
|
1373 |
|
1374 <li><a href="../modules/slider.html">slider</a></li> |
|
1375 |
|
1376 <li><a href="../modules/slider-base.html">slider-base</a></li> |
|
1377 |
|
1378 <li><a href="../modules/slider-value-range.html">slider-value-range</a></li> |
|
1379 |
|
1380 <li><a href="../modules/sortable.html">sortable</a></li> |
|
1381 |
|
1382 <li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li> |
|
1383 |
|
1384 <li><a href="../modules/stylesheet.html">stylesheet</a></li> |
|
1385 |
|
1386 <li><a href="../modules/substitute.html">substitute</a></li> |
|
1387 |
|
1388 <li><a href="../modules/swf.html">swf</a></li> |
|
1389 |
|
1390 <li><a href="../modules/swfdetect.html">swfdetect</a></li> |
|
1391 |
|
1392 <li><a href="../modules/tabview.html">tabview</a></li> |
|
1393 |
|
1394 <li><a href="../modules/template.html">template</a></li> |
|
1395 |
|
1396 <li><a href="../modules/template-base.html">template-base</a></li> |
|
1397 |
|
1398 <li><a href="../modules/template-micro.html">template-micro</a></li> |
|
1399 |
|
1400 <li><a href="../modules/test.html">test</a></li> |
|
1401 |
|
1402 <li><a href="../modules/test-console.html">test-console</a></li> |
|
1403 |
|
1404 <li><a href="../modules/text.html">text</a></li> |
|
1405 |
|
1406 <li><a href="../modules/text-accentfold.html">text-accentfold</a></li> |
|
1407 |
|
1408 <li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li> |
|
1409 |
|
1410 <li><a href="../modules/timers.html">timers</a></li> |
|
1411 |
|
1412 <li><a href="../modules/transition.html">transition</a></li> |
|
1413 |
|
1414 <li><a href="../modules/transition-timer.html">transition-timer</a></li> |
|
1415 |
|
1416 <li><a href="../modules/tree.html">tree</a></li> |
|
1417 |
|
1418 <li><a href="../modules/tree-labelable.html">tree-labelable</a></li> |
|
1419 |
|
1420 <li><a href="../modules/tree-lazy.html">tree-lazy</a></li> |
|
1421 |
|
1422 <li><a href="../modules/tree-node.html">tree-node</a></li> |
|
1423 |
|
1424 <li><a href="../modules/tree-openable.html">tree-openable</a></li> |
|
1425 |
|
1426 <li><a href="../modules/tree-selectable.html">tree-selectable</a></li> |
|
1427 |
|
1428 <li><a href="../modules/tree-sortable.html">tree-sortable</a></li> |
|
1429 |
|
1430 <li><a href="../modules/uploader.html">uploader</a></li> |
|
1431 |
|
1432 <li><a href="../modules/uploader-flash.html">uploader-flash</a></li> |
|
1433 |
|
1434 <li><a href="../modules/uploader-html5.html">uploader-html5</a></li> |
|
1435 |
|
1436 <li><a href="../modules/uploader-queue.html">uploader-queue</a></li> |
|
1437 |
|
1438 <li><a href="../modules/view.html">view</a></li> |
|
1439 |
|
1440 <li><a href="../modules/view-node-map.html">view-node-map</a></li> |
|
1441 |
|
1442 <li><a href="../modules/widget.html">widget</a></li> |
|
1443 |
|
1444 <li><a href="../modules/widget-anim.html">widget-anim</a></li> |
|
1445 |
|
1446 <li><a href="../modules/widget-autohide.html">widget-autohide</a></li> |
|
1447 |
|
1448 <li><a href="../modules/widget-base.html">widget-base</a></li> |
|
1449 |
|
1450 <li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li> |
|
1451 |
|
1452 <li><a href="../modules/widget-buttons.html">widget-buttons</a></li> |
|
1453 |
|
1454 <li><a href="../modules/widget-child.html">widget-child</a></li> |
|
1455 |
|
1456 <li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li> |
|
1457 |
|
1458 <li><a href="../modules/widget-locale.html">widget-locale</a></li> |
|
1459 |
|
1460 <li><a href="../modules/widget-modality.html">widget-modality</a></li> |
|
1461 |
|
1462 <li><a href="../modules/widget-parent.html">widget-parent</a></li> |
|
1463 |
|
1464 <li><a href="../modules/widget-position.html">widget-position</a></li> |
|
1465 |
|
1466 <li><a href="../modules/widget-position-align.html">widget-position-align</a></li> |
|
1467 |
|
1468 <li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li> |
|
1469 |
|
1470 <li><a href="../modules/widget-skin.html">widget-skin</a></li> |
|
1471 |
|
1472 <li><a href="../modules/widget-stack.html">widget-stack</a></li> |
|
1473 |
|
1474 <li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li> |
|
1475 |
|
1476 <li><a href="../modules/widget-uievents.html">widget-uievents</a></li> |
|
1477 |
|
1478 <li><a href="../modules/yql.html">yql</a></li> |
|
1479 |
|
1480 <li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li> |
|
1481 |
|
1482 <li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li> |
|
1483 |
|
1484 <li><a href="../modules/yql-winjs.html">yql-winjs</a></li> |
|
1485 |
|
1486 <li><a href="../modules/yui.html">yui</a></li> |
|
1487 |
|
1488 <li><a href="../modules/yui-base.html">yui-base</a></li> |
|
1489 |
|
1490 <li><a href="../modules/yui-later.html">yui-later</a></li> |
|
1491 |
|
1492 <li><a href="../modules/yui-log.html">yui-log</a></li> |
|
1493 |
|
1494 <li><a href="../modules/yui-throttle.html">yui-throttle</a></li> |
|
1495 |
|
1496 </ul> |
|
1497 </div> |
|
1498 </div> |
|
1499 </div> |
|
1500 |
|
1501 </div> |
|
1502 </div> |
|
1503 <div class="yui3-u-3-4"> |
|
1504 <div id="api-options"> |
|
1505 Show: |
|
1506 <label for="api-show-inherited"> |
|
1507 <input type="checkbox" id="api-show-inherited" checked> |
|
1508 Inherited |
|
1509 </label> |
|
1510 |
|
1511 <label for="api-show-protected"> |
|
1512 <input type="checkbox" id="api-show-protected"> |
|
1513 Protected |
|
1514 </label> |
|
1515 |
|
1516 <label for="api-show-private"> |
|
1517 <input type="checkbox" id="api-show-private"> |
|
1518 Private |
|
1519 </label> |
|
1520 <label for="api-show-deprecated"> |
|
1521 <input type="checkbox" id="api-show-deprecated"> |
|
1522 Deprecated |
|
1523 </label> |
|
1524 |
|
1525 </div> |
|
1526 |
|
1527 |
|
1528 <div class="apidocs"> |
|
1529 <div id="docs-main"> |
|
1530 <div class="content"> |
|
1531 <h1>Plugin.Pjax Class</h1> |
|
1532 <div class="box meta"> |
|
1533 |
|
1534 |
|
1535 |
|
1536 <div class="extends"> |
|
1537 Extends <a href="../classes/Pjax.html" class="crosslink">Pjax</a> |
|
1538 </div> |
|
1539 |
|
1540 |
|
1541 |
|
1542 <div class="foundat"> |
|
1543 Defined in: <a href="../files/pjax_js_pjax-plugin.js.html#l9"><code>pjax/js/pjax-plugin.js:9</code></a> |
|
1544 </div> |
|
1545 |
|
1546 |
|
1547 |
|
1548 |
|
1549 Module: <a href="../modules/pjax-plugin.html">pjax-plugin</a><br> |
|
1550 Parent Module: <a href="../modules/pjax.html">pjax</a> |
|
1551 |
|
1552 |
|
1553 |
|
1554 |
|
1555 <p>Available since 3.5.0</p> |
|
1556 |
|
1557 </div> |
|
1558 |
|
1559 |
|
1560 |
|
1561 <div class="box intro"> |
|
1562 <p>Node plugin that provides seamless, gracefully degrading pjax functionality.</p> |
|
1563 </div> |
|
1564 |
|
1565 |
|
1566 |
|
1567 <div id="classdocs" class="tabview"> |
|
1568 <ul class="api-class-tabs"> |
|
1569 <li class="api-class-tab index"><a href="#index">Index</a></li> |
|
1570 |
|
1571 |
|
1572 <li class="api-class-tab methods"><a href="#methods">Methods</a></li> |
|
1573 |
|
1574 |
|
1575 <li class="api-class-tab properties"><a href="#properties">Properties</a></li> |
|
1576 |
|
1577 |
|
1578 <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> |
|
1579 |
|
1580 |
|
1581 <li class="api-class-tab events"><a href="#events">Events</a></li> |
|
1582 |
|
1583 </ul> |
|
1584 |
|
1585 <div> |
|
1586 <div id="index" class="api-class-tabpanel index"> |
|
1587 <h2 class="off-left">Item Index</h2> |
|
1588 |
|
1589 |
|
1590 <div class="index-section methods"> |
|
1591 <h3>Methods</h3> |
|
1592 |
|
1593 <ul class="index-list methods extends"> |
|
1594 |
|
1595 <li class="index-item method private inherited"> |
|
1596 <a href="#method__addAttrs">_addAttrs</a> |
|
1597 |
|
1598 |
|
1599 |
|
1600 </li> |
|
1601 |
|
1602 <li class="index-item method private inherited"> |
|
1603 <a href="#method__addLazyAttr">_addLazyAttr</a> |
|
1604 |
|
1605 |
|
1606 |
|
1607 </li> |
|
1608 |
|
1609 <li class="index-item method protected inherited"> |
|
1610 <a href="#method__afterHistoryChange">_afterHistoryChange</a> |
|
1611 |
|
1612 |
|
1613 |
|
1614 </li> |
|
1615 |
|
1616 <li class="index-item method private inherited"> |
|
1617 <a href="#method__aggregateAttrs">_aggregateAttrs</a> |
|
1618 |
|
1619 |
|
1620 |
|
1621 </li> |
|
1622 |
|
1623 <li class="index-item method private inherited"> |
|
1624 <a href="#method__attrCfgHash">_attrCfgHash</a> |
|
1625 |
|
1626 |
|
1627 |
|
1628 </li> |
|
1629 |
|
1630 <li class="index-item method private inherited"> |
|
1631 <a href="#method__baseDestroy">_baseDestroy</a> |
|
1632 |
|
1633 |
|
1634 |
|
1635 </li> |
|
1636 |
|
1637 <li class="index-item method private inherited"> |
|
1638 <a href="#method__baseInit">_baseInit</a> |
|
1639 |
|
1640 |
|
1641 |
|
1642 </li> |
|
1643 |
|
1644 <li class="index-item method private inherited"> |
|
1645 <a href="#method__cloneDefaultValue">_cloneDefaultValue</a> |
|
1646 |
|
1647 |
|
1648 |
|
1649 </li> |
|
1650 |
|
1651 <li class="index-item method protected inherited"> |
|
1652 <a href="#method__decode">_decode</a> |
|
1653 |
|
1654 |
|
1655 |
|
1656 </li> |
|
1657 |
|
1658 <li class="index-item method private inherited"> |
|
1659 <a href="#method__defAttrChangeFn">_defAttrChangeFn</a> |
|
1660 |
|
1661 |
|
1662 |
|
1663 </li> |
|
1664 |
|
1665 <li class="index-item method protected inherited"> |
|
1666 <a href="#method__defaultRoute">_defaultRoute</a> |
|
1667 |
|
1668 |
|
1669 |
|
1670 </li> |
|
1671 |
|
1672 <li class="index-item method protected inherited"> |
|
1673 <a href="#method__defCompleteFn">_defCompleteFn</a> |
|
1674 |
|
1675 |
|
1676 |
|
1677 </li> |
|
1678 |
|
1679 <li class="index-item method protected inherited"> |
|
1680 <a href="#method__defDestroyFn">_defDestroyFn</a> |
|
1681 |
|
1682 |
|
1683 |
|
1684 </li> |
|
1685 |
|
1686 <li class="index-item method protected inherited"> |
|
1687 <a href="#method__defInitFn">_defInitFn</a> |
|
1688 |
|
1689 |
|
1690 |
|
1691 </li> |
|
1692 |
|
1693 <li class="index-item method protected inherited"> |
|
1694 <a href="#method__defNavigateFn">_defNavigateFn</a> |
|
1695 |
|
1696 |
|
1697 |
|
1698 </li> |
|
1699 |
|
1700 <li class="index-item method protected inherited"> |
|
1701 <a href="#method__defReadyFn">_defReadyFn</a> |
|
1702 |
|
1703 |
|
1704 |
|
1705 </li> |
|
1706 |
|
1707 <li class="index-item method protected inherited"> |
|
1708 <a href="#method__dequeue">_dequeue</a> |
|
1709 |
|
1710 |
|
1711 |
|
1712 </li> |
|
1713 |
|
1714 <li class="index-item method private inherited"> |
|
1715 <a href="#method__destroyHierarchy">_destroyHierarchy</a> |
|
1716 |
|
1717 |
|
1718 |
|
1719 </li> |
|
1720 |
|
1721 <li class="index-item method protected inherited"> |
|
1722 <a href="#method__dispatch">_dispatch</a> |
|
1723 |
|
1724 |
|
1725 |
|
1726 </li> |
|
1727 |
|
1728 <li class="index-item method private inherited"> |
|
1729 <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a> |
|
1730 |
|
1731 |
|
1732 |
|
1733 </li> |
|
1734 |
|
1735 <li class="index-item method private inherited"> |
|
1736 <a href="#method__filterAttrCfgs">_filterAttrCfgs</a> |
|
1737 |
|
1738 |
|
1739 |
|
1740 </li> |
|
1741 |
|
1742 <li class="index-item method private inherited"> |
|
1743 <a href="#method__fireAttrChange">_fireAttrChange</a> |
|
1744 |
|
1745 |
|
1746 |
|
1747 </li> |
|
1748 |
|
1749 <li class="index-item method protected inherited"> |
|
1750 <a href="#method__getAttr">_getAttr</a> |
|
1751 |
|
1752 |
|
1753 |
|
1754 </li> |
|
1755 |
|
1756 <li class="index-item method protected inherited"> |
|
1757 <a href="#method__getAttrCfg">_getAttrCfg</a> |
|
1758 |
|
1759 |
|
1760 |
|
1761 </li> |
|
1762 |
|
1763 <li class="index-item method protected inherited"> |
|
1764 <a href="#method__getAttrCfgs">_getAttrCfgs</a> |
|
1765 |
|
1766 |
|
1767 |
|
1768 </li> |
|
1769 |
|
1770 <li class="index-item method private inherited"> |
|
1771 <a href="#method__getAttrInitVal">_getAttrInitVal</a> |
|
1772 |
|
1773 |
|
1774 |
|
1775 </li> |
|
1776 |
|
1777 <li class="index-item method protected inherited"> |
|
1778 <a href="#method__getAttrs">_getAttrs</a> |
|
1779 |
|
1780 |
|
1781 |
|
1782 </li> |
|
1783 |
|
1784 <li class="index-item method protected inherited"> |
|
1785 <a href="#method__getClasses">_getClasses</a> |
|
1786 |
|
1787 |
|
1788 |
|
1789 </li> |
|
1790 |
|
1791 <li class="index-item method private inherited"> |
|
1792 <a href="#method__getFullType">_getFullType</a> |
|
1793 |
|
1794 |
|
1795 |
|
1796 </li> |
|
1797 |
|
1798 <li class="index-item method protected inherited"> |
|
1799 <a href="#method__getHashPath">_getHashPath</a> |
|
1800 |
|
1801 |
|
1802 |
|
1803 </li> |
|
1804 |
|
1805 <li class="index-item method protected inherited"> |
|
1806 <a href="#method__getOrigin">_getOrigin</a> |
|
1807 |
|
1808 |
|
1809 |
|
1810 </li> |
|
1811 |
|
1812 <li class="index-item method protected inherited"> |
|
1813 <a href="#method__getPath">_getPath</a> |
|
1814 |
|
1815 |
|
1816 |
|
1817 </li> |
|
1818 |
|
1819 <li class="index-item method protected inherited"> |
|
1820 <a href="#method__getPathRoot">_getPathRoot</a> |
|
1821 |
|
1822 |
|
1823 |
|
1824 </li> |
|
1825 |
|
1826 <li class="index-item method protected inherited"> |
|
1827 <a href="#method__getQuery">_getQuery</a> |
|
1828 |
|
1829 |
|
1830 |
|
1831 </li> |
|
1832 |
|
1833 <li class="index-item method protected inherited"> |
|
1834 <a href="#method__getRegex">_getRegex</a> |
|
1835 |
|
1836 |
|
1837 |
|
1838 </li> |
|
1839 |
|
1840 <li class="index-item method protected inherited"> |
|
1841 <a href="#method__getRequest">_getRequest</a> |
|
1842 |
|
1843 |
|
1844 |
|
1845 </li> |
|
1846 |
|
1847 <li class="index-item method protected inherited"> |
|
1848 <a href="#method__getResponse">_getResponse</a> |
|
1849 |
|
1850 |
|
1851 |
|
1852 </li> |
|
1853 |
|
1854 <li class="index-item method protected inherited"> |
|
1855 <a href="#method__getRoutes">_getRoutes</a> |
|
1856 |
|
1857 |
|
1858 |
|
1859 </li> |
|
1860 |
|
1861 <li class="index-item method private inherited"> |
|
1862 <a href="#method__getStateVal">_getStateVal</a> |
|
1863 |
|
1864 |
|
1865 |
|
1866 </li> |
|
1867 |
|
1868 <li class="index-item method private inherited"> |
|
1869 <a href="#method__getType">_getType</a> |
|
1870 |
|
1871 |
|
1872 |
|
1873 </li> |
|
1874 |
|
1875 <li class="index-item method protected inherited"> |
|
1876 <a href="#method__getURL">_getURL</a> |
|
1877 |
|
1878 |
|
1879 |
|
1880 </li> |
|
1881 |
|
1882 <li class="index-item method protected inherited"> |
|
1883 <a href="#method__hasSameOrigin">_hasSameOrigin</a> |
|
1884 |
|
1885 |
|
1886 |
|
1887 </li> |
|
1888 |
|
1889 <li class="index-item method private inherited"> |
|
1890 <a href="#method__initAttrHost">_initAttrHost</a> |
|
1891 |
|
1892 |
|
1893 |
|
1894 </li> |
|
1895 |
|
1896 <li class="index-item method private inherited inherited"> |
|
1897 <a href="#method__initAttribute">_initAttribute</a> |
|
1898 |
|
1899 |
|
1900 |
|
1901 </li> |
|
1902 |
|
1903 <li class="index-item method protected inherited"> |
|
1904 <a href="#method__initAttrs">_initAttrs</a> |
|
1905 |
|
1906 |
|
1907 |
|
1908 </li> |
|
1909 |
|
1910 <li class="index-item method private inherited"> |
|
1911 <a href="#method__initBase">_initBase</a> |
|
1912 |
|
1913 |
|
1914 |
|
1915 </li> |
|
1916 |
|
1917 <li class="index-item method private inherited"> |
|
1918 <a href="#method__initHierarchy">_initHierarchy</a> |
|
1919 |
|
1920 |
|
1921 |
|
1922 </li> |
|
1923 |
|
1924 <li class="index-item method private inherited"> |
|
1925 <a href="#method__initHierarchyData">_initHierarchyData</a> |
|
1926 |
|
1927 |
|
1928 |
|
1929 </li> |
|
1930 |
|
1931 <li class="index-item method private inherited"> |
|
1932 <a href="#method__isLazyAttr">_isLazyAttr</a> |
|
1933 |
|
1934 |
|
1935 |
|
1936 </li> |
|
1937 |
|
1938 <li class="index-item method protected inherited"> |
|
1939 <a href="#method__isLinkSameOrigin">_isLinkSameOrigin</a> |
|
1940 |
|
1941 |
|
1942 |
|
1943 </li> |
|
1944 |
|
1945 <li class="index-item method protected inherited"> |
|
1946 <a href="#method__joinURL">_joinURL</a> |
|
1947 |
|
1948 |
|
1949 |
|
1950 </li> |
|
1951 |
|
1952 <li class="index-item method private inherited"> |
|
1953 <a href="#method__monitor">_monitor</a> |
|
1954 |
|
1955 |
|
1956 |
|
1957 </li> |
|
1958 |
|
1959 <li class="index-item method protected inherited"> |
|
1960 <a href="#method__navigate">_navigate</a> |
|
1961 |
|
1962 |
|
1963 |
|
1964 </li> |
|
1965 |
|
1966 <li class="index-item method protected inherited"> |
|
1967 <a href="#method__normalizePath">_normalizePath</a> |
|
1968 |
|
1969 |
|
1970 |
|
1971 </li> |
|
1972 |
|
1973 <li class="index-item method private inherited"> |
|
1974 <a href="#method__normAttrVals">_normAttrVals</a> |
|
1975 |
|
1976 |
|
1977 |
|
1978 </li> |
|
1979 |
|
1980 <li class="index-item method protected inherited"> |
|
1981 <a href="#method__onLinkClick">_onLinkClick</a> |
|
1982 |
|
1983 |
|
1984 |
|
1985 </li> |
|
1986 |
|
1987 <li class="index-item method protected inherited"> |
|
1988 <a href="#method__onPjaxIOComplete">_onPjaxIOComplete</a> |
|
1989 |
|
1990 |
|
1991 |
|
1992 </li> |
|
1993 |
|
1994 <li class="index-item method protected inherited"> |
|
1995 <a href="#method__onPjaxIOEnd">_onPjaxIOEnd</a> |
|
1996 |
|
1997 |
|
1998 |
|
1999 </li> |
|
2000 |
|
2001 <li class="index-item method protected inherited"> |
|
2002 <a href="#method__parseQuery">_parseQuery</a> |
|
2003 |
|
2004 |
|
2005 |
|
2006 </li> |
|
2007 |
|
2008 <li class="index-item method private inherited"> |
|
2009 <a href="#method__parseType">_parseType</a> |
|
2010 |
|
2011 |
|
2012 |
|
2013 </li> |
|
2014 |
|
2015 <li class="index-item method protected inherited"> |
|
2016 <a href="#method__pjaxBindUI">_pjaxBindUI</a> |
|
2017 |
|
2018 |
|
2019 |
|
2020 </li> |
|
2021 |
|
2022 <li class="index-item method private inherited"> |
|
2023 <a href="#method__preInitEventCfg">_preInitEventCfg</a> |
|
2024 |
|
2025 |
|
2026 |
|
2027 </li> |
|
2028 |
|
2029 <li class="index-item method protected deprecated inherited"> |
|
2030 <a href="#method__protectAttrs">_protectAttrs</a> |
|
2031 |
|
2032 |
|
2033 |
|
2034 <span class="flag deprecated">deprecated</span> |
|
2035 |
|
2036 </li> |
|
2037 |
|
2038 <li class="index-item method private inherited"> |
|
2039 <a href="#method__publish">_publish</a> |
|
2040 |
|
2041 |
|
2042 |
|
2043 </li> |
|
2044 |
|
2045 <li class="index-item method protected inherited"> |
|
2046 <a href="#method__queue">_queue</a> |
|
2047 |
|
2048 |
|
2049 |
|
2050 </li> |
|
2051 |
|
2052 <li class="index-item method protected inherited"> |
|
2053 <a href="#method__resolvePath">_resolvePath</a> |
|
2054 |
|
2055 |
|
2056 |
|
2057 </li> |
|
2058 |
|
2059 <li class="index-item method protected inherited"> |
|
2060 <a href="#method__resolveURL">_resolveURL</a> |
|
2061 |
|
2062 |
|
2063 |
|
2064 </li> |
|
2065 |
|
2066 <li class="index-item method protected inherited"> |
|
2067 <a href="#method__save">_save</a> |
|
2068 |
|
2069 |
|
2070 |
|
2071 </li> |
|
2072 |
|
2073 <li class="index-item method protected inherited inherited"> |
|
2074 <a href="#method__set">_set</a> |
|
2075 |
|
2076 |
|
2077 |
|
2078 </li> |
|
2079 |
|
2080 <li class="index-item method protected inherited"> |
|
2081 <a href="#method__setAttr">_setAttr</a> |
|
2082 |
|
2083 |
|
2084 |
|
2085 </li> |
|
2086 |
|
2087 <li class="index-item method protected inherited inherited"> |
|
2088 <a href="#method__setAttrs">_setAttrs</a> |
|
2089 |
|
2090 |
|
2091 |
|
2092 </li> |
|
2093 |
|
2094 <li class="index-item method private inherited"> |
|
2095 <a href="#method__setAttrVal">_setAttrVal</a> |
|
2096 |
|
2097 |
|
2098 |
|
2099 </li> |
|
2100 |
|
2101 <li class="index-item method protected inherited"> |
|
2102 <a href="#method__setRoutes">_setRoutes</a> |
|
2103 |
|
2104 |
|
2105 |
|
2106 </li> |
|
2107 |
|
2108 <li class="index-item method private inherited"> |
|
2109 <a href="#method__setStateVal">_setStateVal</a> |
|
2110 |
|
2111 |
|
2112 |
|
2113 </li> |
|
2114 |
|
2115 <li class="index-item method protected inherited"> |
|
2116 <a href="#method__upgradeURL">_upgradeURL</a> |
|
2117 |
|
2118 |
|
2119 |
|
2120 </li> |
|
2121 |
|
2122 <li class="index-item method inherited"> |
|
2123 <a href="#method_addAttr">addAttr</a> |
|
2124 |
|
2125 |
|
2126 |
|
2127 </li> |
|
2128 |
|
2129 <li class="index-item method inherited"> |
|
2130 <a href="#method_addAttrs">addAttrs</a> |
|
2131 |
|
2132 |
|
2133 |
|
2134 </li> |
|
2135 |
|
2136 <li class="index-item method inherited"> |
|
2137 <a href="#method_addTarget">addTarget</a> |
|
2138 |
|
2139 |
|
2140 |
|
2141 </li> |
|
2142 |
|
2143 <li class="index-item method inherited"> |
|
2144 <a href="#method_after">after</a> |
|
2145 |
|
2146 |
|
2147 |
|
2148 </li> |
|
2149 |
|
2150 <li class="index-item method inherited"> |
|
2151 <a href="#method_attrAdded">attrAdded</a> |
|
2152 |
|
2153 |
|
2154 |
|
2155 </li> |
|
2156 |
|
2157 <li class="index-item method inherited"> |
|
2158 <a href="#method_before">before</a> |
|
2159 |
|
2160 |
|
2161 |
|
2162 </li> |
|
2163 |
|
2164 <li class="index-item method inherited"> |
|
2165 <a href="#method_bubble">bubble</a> |
|
2166 |
|
2167 |
|
2168 |
|
2169 </li> |
|
2170 |
|
2171 <li class="index-item method inherited inherited"> |
|
2172 <a href="#method_destroy">destroy</a> |
|
2173 |
|
2174 |
|
2175 |
|
2176 </li> |
|
2177 |
|
2178 <li class="index-item method inherited"> |
|
2179 <a href="#method_detach">detach</a> |
|
2180 |
|
2181 |
|
2182 |
|
2183 </li> |
|
2184 |
|
2185 <li class="index-item method inherited"> |
|
2186 <a href="#method_detachAll">detachAll</a> |
|
2187 |
|
2188 |
|
2189 |
|
2190 </li> |
|
2191 |
|
2192 <li class="index-item method inherited"> |
|
2193 <a href="#method_dispatch">dispatch</a> |
|
2194 |
|
2195 |
|
2196 |
|
2197 </li> |
|
2198 |
|
2199 <li class="index-item method inherited"> |
|
2200 <a href="#method_fire">fire</a> |
|
2201 |
|
2202 |
|
2203 |
|
2204 </li> |
|
2205 |
|
2206 <li class="index-item method inherited"> |
|
2207 <a href="#method_get">get</a> |
|
2208 |
|
2209 |
|
2210 |
|
2211 </li> |
|
2212 |
|
2213 <li class="index-item method inherited"> |
|
2214 <a href="#method_getAttrs">getAttrs</a> |
|
2215 |
|
2216 |
|
2217 |
|
2218 </li> |
|
2219 |
|
2220 <li class="index-item method inherited"> |
|
2221 <a href="#method_getContent">getContent</a> |
|
2222 |
|
2223 |
|
2224 |
|
2225 </li> |
|
2226 |
|
2227 <li class="index-item method inherited"> |
|
2228 <a href="#method_getEvent">getEvent</a> |
|
2229 |
|
2230 |
|
2231 |
|
2232 </li> |
|
2233 |
|
2234 <li class="index-item method inherited"> |
|
2235 <a href="#method_getPath">getPath</a> |
|
2236 |
|
2237 |
|
2238 |
|
2239 </li> |
|
2240 |
|
2241 <li class="index-item method inherited"> |
|
2242 <a href="#method_getTargets">getTargets</a> |
|
2243 |
|
2244 |
|
2245 |
|
2246 </li> |
|
2247 |
|
2248 <li class="index-item method inherited"> |
|
2249 <a href="#method_hasRoute">hasRoute</a> |
|
2250 |
|
2251 |
|
2252 |
|
2253 </li> |
|
2254 |
|
2255 <li class="index-item method inherited inherited"> |
|
2256 <a href="#method_init">init</a> |
|
2257 |
|
2258 |
|
2259 |
|
2260 </li> |
|
2261 |
|
2262 <li class="index-item method inherited"> |
|
2263 <a href="#method_loadContent">loadContent</a> |
|
2264 |
|
2265 |
|
2266 |
|
2267 </li> |
|
2268 |
|
2269 <li class="index-item method inherited"> |
|
2270 <a href="#method_match">match</a> |
|
2271 |
|
2272 |
|
2273 |
|
2274 </li> |
|
2275 |
|
2276 <li class="index-item method inherited"> |
|
2277 <a href="#method_modifyAttr">modifyAttr</a> |
|
2278 |
|
2279 |
|
2280 |
|
2281 </li> |
|
2282 |
|
2283 <li class="index-item method inherited"> |
|
2284 <a href="#method_navigate">navigate</a> |
|
2285 |
|
2286 |
|
2287 |
|
2288 </li> |
|
2289 |
|
2290 <li class="index-item method inherited"> |
|
2291 <a href="#method_on">on</a> |
|
2292 |
|
2293 |
|
2294 |
|
2295 </li> |
|
2296 |
|
2297 <li class="index-item method inherited"> |
|
2298 <a href="#method_once">once</a> |
|
2299 |
|
2300 |
|
2301 |
|
2302 </li> |
|
2303 |
|
2304 <li class="index-item method inherited"> |
|
2305 <a href="#method_onceAfter">onceAfter</a> |
|
2306 |
|
2307 |
|
2308 |
|
2309 </li> |
|
2310 |
|
2311 <li class="index-item method inherited"> |
|
2312 <a href="#method_parseType">parseType</a> |
|
2313 |
|
2314 |
|
2315 |
|
2316 </li> |
|
2317 |
|
2318 <li class="index-item method inherited"> |
|
2319 <a href="#method_publish">publish</a> |
|
2320 |
|
2321 |
|
2322 |
|
2323 </li> |
|
2324 |
|
2325 <li class="index-item method inherited"> |
|
2326 <a href="#method_removeAttr">removeAttr</a> |
|
2327 |
|
2328 |
|
2329 |
|
2330 </li> |
|
2331 |
|
2332 <li class="index-item method inherited"> |
|
2333 <a href="#method_removeQuery">removeQuery</a> |
|
2334 |
|
2335 |
|
2336 |
|
2337 </li> |
|
2338 |
|
2339 <li class="index-item method inherited"> |
|
2340 <a href="#method_removeRoot">removeRoot</a> |
|
2341 |
|
2342 |
|
2343 |
|
2344 </li> |
|
2345 |
|
2346 <li class="index-item method inherited"> |
|
2347 <a href="#method_removeTarget">removeTarget</a> |
|
2348 |
|
2349 |
|
2350 |
|
2351 </li> |
|
2352 |
|
2353 <li class="index-item method inherited"> |
|
2354 <a href="#method_replace">replace</a> |
|
2355 |
|
2356 |
|
2357 |
|
2358 </li> |
|
2359 |
|
2360 <li class="index-item method inherited"> |
|
2361 <a href="#method_reset">reset</a> |
|
2362 |
|
2363 |
|
2364 |
|
2365 </li> |
|
2366 |
|
2367 <li class="index-item method inherited"> |
|
2368 <a href="#method_route">route</a> |
|
2369 |
|
2370 |
|
2371 |
|
2372 </li> |
|
2373 |
|
2374 <li class="index-item method inherited"> |
|
2375 <a href="#method_save">save</a> |
|
2376 |
|
2377 |
|
2378 |
|
2379 </li> |
|
2380 |
|
2381 <li class="index-item method inherited inherited"> |
|
2382 <a href="#method_set">set</a> |
|
2383 |
|
2384 |
|
2385 |
|
2386 </li> |
|
2387 |
|
2388 <li class="index-item method inherited inherited"> |
|
2389 <a href="#method_setAttrs">setAttrs</a> |
|
2390 |
|
2391 |
|
2392 |
|
2393 </li> |
|
2394 |
|
2395 <li class="index-item method deprecated inherited"> |
|
2396 <a href="#method_subscribe">subscribe</a> |
|
2397 |
|
2398 |
|
2399 |
|
2400 <span class="flag deprecated">deprecated</span> |
|
2401 |
|
2402 </li> |
|
2403 |
|
2404 <li class="index-item method inherited"> |
|
2405 <a href="#method_toString">toString</a> |
|
2406 |
|
2407 |
|
2408 |
|
2409 </li> |
|
2410 |
|
2411 <li class="index-item method deprecated inherited"> |
|
2412 <a href="#method_unsubscribe">unsubscribe</a> |
|
2413 |
|
2414 |
|
2415 |
|
2416 <span class="flag deprecated">deprecated</span> |
|
2417 |
|
2418 </li> |
|
2419 |
|
2420 <li class="index-item method deprecated inherited"> |
|
2421 <a href="#method_unsubscribeAll">unsubscribeAll</a> |
|
2422 |
|
2423 |
|
2424 |
|
2425 <span class="flag deprecated">deprecated</span> |
|
2426 |
|
2427 </li> |
|
2428 |
|
2429 <li class="index-item method inherited"> |
|
2430 <a href="#method_upgrade">upgrade</a> |
|
2431 |
|
2432 |
|
2433 |
|
2434 </li> |
|
2435 |
|
2436 </ul> |
|
2437 </div> |
|
2438 |
|
2439 |
|
2440 |
|
2441 <div class="index-section properties"> |
|
2442 <h3>Properties</h3> |
|
2443 |
|
2444 <ul class="index-list properties extends"> |
|
2445 |
|
2446 <li class="index-item property protected inherited"> |
|
2447 <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a> |
|
2448 |
|
2449 |
|
2450 |
|
2451 </li> |
|
2452 |
|
2453 <li class="index-item property protected inherited"> |
|
2454 <a href="#property__dispatched">_dispatched</a> |
|
2455 |
|
2456 |
|
2457 |
|
2458 </li> |
|
2459 |
|
2460 <li class="index-item property protected inherited"> |
|
2461 <a href="#property__dispatching">_dispatching</a> |
|
2462 |
|
2463 |
|
2464 |
|
2465 </li> |
|
2466 |
|
2467 <li class="index-item property protected inherited"> |
|
2468 <a href="#property__historyEvents">_historyEvents</a> |
|
2469 |
|
2470 |
|
2471 |
|
2472 </li> |
|
2473 |
|
2474 <li class="index-item property protected inherited"> |
|
2475 <a href="#property__html5">_html5</a> |
|
2476 |
|
2477 |
|
2478 |
|
2479 </li> |
|
2480 |
|
2481 <li class="index-item property protected inherited"> |
|
2482 <a href="#property__pjaxEvents">_pjaxEvents</a> |
|
2483 |
|
2484 |
|
2485 |
|
2486 </li> |
|
2487 |
|
2488 <li class="index-item property protected inherited"> |
|
2489 <a href="#property__ready">_ready</a> |
|
2490 |
|
2491 |
|
2492 |
|
2493 </li> |
|
2494 |
|
2495 <li class="index-item property protected inherited"> |
|
2496 <a href="#property__regexPathParam">_regexPathParam</a> |
|
2497 |
|
2498 |
|
2499 |
|
2500 </li> |
|
2501 |
|
2502 <li class="index-item property protected inherited"> |
|
2503 <a href="#property__regexURL">_regexURL</a> |
|
2504 |
|
2505 |
|
2506 |
|
2507 </li> |
|
2508 |
|
2509 <li class="index-item property protected inherited"> |
|
2510 <a href="#property__regexUrlOrigin">_regexUrlOrigin</a> |
|
2511 |
|
2512 |
|
2513 |
|
2514 </li> |
|
2515 |
|
2516 <li class="index-item property protected inherited"> |
|
2517 <a href="#property__regexUrlQuery">_regexUrlQuery</a> |
|
2518 |
|
2519 |
|
2520 |
|
2521 </li> |
|
2522 |
|
2523 <li class="index-item property deprecated inherited"> |
|
2524 <a href="#property_name">name</a> |
|
2525 |
|
2526 |
|
2527 |
|
2528 <span class="flag deprecated">deprecated</span> |
|
2529 |
|
2530 </li> |
|
2531 |
|
2532 </ul> |
|
2533 </div> |
|
2534 |
|
2535 |
|
2536 |
|
2537 <div class="index-section attrs"> |
|
2538 <h3>Attributes</h3> |
|
2539 |
|
2540 <ul class="index-list attrs extends"> |
|
2541 |
|
2542 <li class="index-item attr inherited"> |
|
2543 <a href="#attr_addPjaxParam">addPjaxParam</a> |
|
2544 </li> |
|
2545 |
|
2546 <li class="index-item attr inherited"> |
|
2547 <a href="#attr_container">container</a> |
|
2548 </li> |
|
2549 |
|
2550 <li class="index-item attr inherited"> |
|
2551 <a href="#attr_contentSelector">contentSelector</a> |
|
2552 </li> |
|
2553 |
|
2554 <li class="index-item attr inherited"> |
|
2555 <a href="#attr_destroyed">destroyed</a> |
|
2556 </li> |
|
2557 |
|
2558 <li class="index-item attr inherited"> |
|
2559 <a href="#attr_html5">html5</a> |
|
2560 </li> |
|
2561 |
|
2562 <li class="index-item attr inherited"> |
|
2563 <a href="#attr_initialized">initialized</a> |
|
2564 </li> |
|
2565 |
|
2566 <li class="index-item attr inherited"> |
|
2567 <a href="#attr_linkSelector">linkSelector</a> |
|
2568 </li> |
|
2569 |
|
2570 <li class="index-item attr inherited"> |
|
2571 <a href="#attr_navigateOnHash">navigateOnHash</a> |
|
2572 </li> |
|
2573 |
|
2574 <li class="index-item attr inherited"> |
|
2575 <a href="#attr_root">root</a> |
|
2576 </li> |
|
2577 |
|
2578 <li class="index-item attr inherited"> |
|
2579 <a href="#attr_routes">routes</a> |
|
2580 </li> |
|
2581 |
|
2582 <li class="index-item attr inherited"> |
|
2583 <a href="#attr_scrollToTop">scrollToTop</a> |
|
2584 </li> |
|
2585 |
|
2586 <li class="index-item attr inherited"> |
|
2587 <a href="#attr_timeout">timeout</a> |
|
2588 </li> |
|
2589 |
|
2590 <li class="index-item attr inherited"> |
|
2591 <a href="#attr_titleSelector">titleSelector</a> |
|
2592 </li> |
|
2593 |
|
2594 </ul> |
|
2595 </div> |
|
2596 |
|
2597 |
|
2598 |
|
2599 <div class="index-section events"> |
|
2600 <h3>Events</h3> |
|
2601 |
|
2602 <ul class="index-list events extends"> |
|
2603 |
|
2604 <li class="index-item event inherited"> |
|
2605 <a href="#event_destroy">destroy</a> |
|
2606 |
|
2607 |
|
2608 |
|
2609 </li> |
|
2610 |
|
2611 <li class="index-item event inherited"> |
|
2612 <a href="#event_error">error</a> |
|
2613 |
|
2614 |
|
2615 |
|
2616 </li> |
|
2617 |
|
2618 <li class="index-item event inherited"> |
|
2619 <a href="#event_init">init</a> |
|
2620 |
|
2621 |
|
2622 |
|
2623 </li> |
|
2624 |
|
2625 <li class="index-item event inherited"> |
|
2626 <a href="#event_load">load</a> |
|
2627 |
|
2628 |
|
2629 |
|
2630 </li> |
|
2631 |
|
2632 <li class="index-item event inherited"> |
|
2633 <a href="#event_navigate">navigate</a> |
|
2634 |
|
2635 |
|
2636 |
|
2637 </li> |
|
2638 |
|
2639 <li class="index-item event inherited"> |
|
2640 <a href="#event_ready">ready</a> |
|
2641 |
|
2642 |
|
2643 |
|
2644 </li> |
|
2645 |
|
2646 </ul> |
|
2647 </div> |
|
2648 |
|
2649 </div> |
|
2650 |
|
2651 |
|
2652 <div id="methods" class="api-class-tabpanel"> |
|
2653 <h2 class="off-left">Methods</h2> |
|
2654 |
|
2655 |
|
2656 <div id="method__addAttrs" class="method item private inherited"> |
|
2657 <h3 class="name"><code>_addAttrs</code></h3> |
|
2658 |
|
2659 |
|
2660 <div class="args"> |
|
2661 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2662 |
|
2663 <li class="arg"> |
|
2664 |
|
2665 <code>cfgs</code> |
|
2666 |
|
2667 </li> |
|
2668 |
|
2669 <li class="arg"> |
|
2670 |
|
2671 <code>values</code> |
|
2672 |
|
2673 </li> |
|
2674 |
|
2675 <li class="arg"> |
|
2676 |
|
2677 <code>lazy</code> |
|
2678 |
|
2679 </li> |
|
2680 |
|
2681 </ul><span class="paren">)</span> |
|
2682 </div> |
|
2683 |
|
2684 |
|
2685 |
|
2686 |
|
2687 |
|
2688 |
|
2689 |
|
2690 <span class="flag private">private</span> |
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 |
|
2697 |
|
2698 |
|
2699 |
|
2700 |
|
2701 <div class="meta"> |
|
2702 |
|
2703 |
|
2704 <p>Inherited from |
|
2705 <a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>: |
|
2706 |
|
2707 |
|
2708 |
|
2709 <a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a> |
|
2710 |
|
2711 </p> |
|
2712 |
|
2713 |
|
2714 |
|
2715 |
|
2716 |
|
2717 </div> |
|
2718 |
|
2719 <div class="description"> |
|
2720 <p>Implementation behind the public addAttrs method.</p> |
|
2721 |
|
2722 <p>This method is invoked directly by get if it encounters a scenario |
|
2723 in which an attribute's valueFn attempts to obtain the |
|
2724 value an attribute in the same group of attributes, which has not yet |
|
2725 been added (on demand initialization).</p> |
|
2726 </div> |
|
2727 |
|
2728 |
|
2729 <div class="params"> |
|
2730 <h4>Parameters:</h4> |
|
2731 |
|
2732 <ul class="params-list"> |
|
2733 |
|
2734 <li class="param"> |
|
2735 |
|
2736 <code class="param-name">cfgs</code> |
|
2737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2738 |
|
2739 |
|
2740 |
|
2741 |
|
2742 <div class="param-description"> |
|
2743 <p>An object with attribute name/configuration pairs.</p> |
|
2744 </div> |
|
2745 |
|
2746 |
|
2747 </li> |
|
2748 |
|
2749 <li class="param"> |
|
2750 |
|
2751 <code class="param-name">values</code> |
|
2752 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2753 |
|
2754 |
|
2755 |
|
2756 |
|
2757 <div class="param-description"> |
|
2758 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
2759 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
2760 </div> |
|
2761 |
|
2762 |
|
2763 </li> |
|
2764 |
|
2765 <li class="param"> |
|
2766 |
|
2767 <code class="param-name">lazy</code> |
|
2768 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
2769 |
|
2770 |
|
2771 |
|
2772 |
|
2773 <div class="param-description"> |
|
2774 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
2775 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
2776 See <a href="#method_addAttr">addAttr</a>.</p> |
|
2777 </div> |
|
2778 |
|
2779 |
|
2780 </li> |
|
2781 |
|
2782 </ul> |
|
2783 </div> |
|
2784 |
|
2785 |
|
2786 |
|
2787 |
|
2788 |
|
2789 </div> |
|
2790 |
|
2791 |
|
2792 <div id="method__addLazyAttr" class="method item private inherited"> |
|
2793 <h3 class="name"><code>_addLazyAttr</code></h3> |
|
2794 |
|
2795 |
|
2796 <div class="args"> |
|
2797 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2798 |
|
2799 <li class="arg"> |
|
2800 |
|
2801 <code>name</code> |
|
2802 |
|
2803 </li> |
|
2804 |
|
2805 <li class="arg"> |
|
2806 |
|
2807 <code class="optional">[lazyCfg]</code> |
|
2808 |
|
2809 </li> |
|
2810 |
|
2811 </ul><span class="paren">)</span> |
|
2812 </div> |
|
2813 |
|
2814 |
|
2815 |
|
2816 |
|
2817 |
|
2818 |
|
2819 |
|
2820 <span class="flag private">private</span> |
|
2821 |
|
2822 |
|
2823 |
|
2824 |
|
2825 |
|
2826 |
|
2827 |
|
2828 |
|
2829 |
|
2830 |
|
2831 <div class="meta"> |
|
2832 |
|
2833 |
|
2834 <p>Inherited from |
|
2835 <a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>: |
|
2836 |
|
2837 |
|
2838 |
|
2839 <a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a> |
|
2840 |
|
2841 </p> |
|
2842 |
|
2843 |
|
2844 |
|
2845 |
|
2846 |
|
2847 </div> |
|
2848 |
|
2849 <div class="description"> |
|
2850 <p>Finishes initializing an attribute which has been lazily added.</p> |
|
2851 </div> |
|
2852 |
|
2853 |
|
2854 <div class="params"> |
|
2855 <h4>Parameters:</h4> |
|
2856 |
|
2857 <ul class="params-list"> |
|
2858 |
|
2859 <li class="param"> |
|
2860 |
|
2861 <code class="param-name">name</code> |
|
2862 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2863 |
|
2864 |
|
2865 |
|
2866 |
|
2867 <div class="param-description"> |
|
2868 <p>The name of the attribute</p> |
|
2869 </div> |
|
2870 |
|
2871 |
|
2872 </li> |
|
2873 |
|
2874 <li class="param"> |
|
2875 |
|
2876 <code class="param-name optional">[lazyCfg]</code> |
|
2877 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2878 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2879 |
|
2880 |
|
2881 |
|
2882 |
|
2883 <div class="param-description"> |
|
2884 <p>Optional config hash for the attribute. This is added for performance |
|
2885 along the critical path, where the calling method has already obtained lazy config from state.</p> |
|
2886 </div> |
|
2887 |
|
2888 |
|
2889 </li> |
|
2890 |
|
2891 </ul> |
|
2892 </div> |
|
2893 |
|
2894 |
|
2895 |
|
2896 |
|
2897 |
|
2898 </div> |
|
2899 |
|
2900 |
|
2901 <div id="method__afterHistoryChange" class="method item protected inherited"> |
|
2902 <h3 class="name"><code>_afterHistoryChange</code></h3> |
|
2903 |
|
2904 |
|
2905 <div class="args"> |
|
2906 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2907 |
|
2908 <li class="arg"> |
|
2909 |
|
2910 <code>e</code> |
|
2911 |
|
2912 </li> |
|
2913 |
|
2914 </ul><span class="paren">)</span> |
|
2915 </div> |
|
2916 |
|
2917 |
|
2918 |
|
2919 |
|
2920 |
|
2921 |
|
2922 |
|
2923 <span class="flag protected">protected</span> |
|
2924 |
|
2925 |
|
2926 |
|
2927 |
|
2928 |
|
2929 |
|
2930 |
|
2931 |
|
2932 |
|
2933 |
|
2934 <div class="meta"> |
|
2935 |
|
2936 |
|
2937 <p>Inherited from |
|
2938 <a href="../classes/Router.html#method__afterHistoryChange">Router</a>: |
|
2939 |
|
2940 |
|
2941 |
|
2942 <a href="../files/app_js_router.js.html#l1269"><code>app/js/router.js:1269</code></a> |
|
2943 |
|
2944 </p> |
|
2945 |
|
2946 |
|
2947 |
|
2948 |
|
2949 |
|
2950 </div> |
|
2951 |
|
2952 <div class="description"> |
|
2953 <p>Handles <code>history:change</code> and <code>hashchange</code> events.</p> |
|
2954 </div> |
|
2955 |
|
2956 |
|
2957 <div class="params"> |
|
2958 <h4>Parameters:</h4> |
|
2959 |
|
2960 <ul class="params-list"> |
|
2961 |
|
2962 <li class="param"> |
|
2963 |
|
2964 <code class="param-name">e</code> |
|
2965 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
2966 |
|
2967 |
|
2968 |
|
2969 |
|
2970 <div class="param-description"> |
|
2971 |
|
2972 </div> |
|
2973 |
|
2974 |
|
2975 </li> |
|
2976 |
|
2977 </ul> |
|
2978 </div> |
|
2979 |
|
2980 |
|
2981 |
|
2982 |
|
2983 |
|
2984 </div> |
|
2985 |
|
2986 |
|
2987 <div id="method__aggregateAttrs" class="method item private inherited"> |
|
2988 <h3 class="name"><code>_aggregateAttrs</code></h3> |
|
2989 |
|
2990 |
|
2991 <div class="args"> |
|
2992 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2993 |
|
2994 <li class="arg"> |
|
2995 |
|
2996 <code>allAttrs</code> |
|
2997 |
|
2998 </li> |
|
2999 |
|
3000 </ul><span class="paren">)</span> |
|
3001 </div> |
|
3002 |
|
3003 |
|
3004 |
|
3005 <span class="returns-inline"> |
|
3006 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3007 </span> |
|
3008 |
|
3009 |
|
3010 |
|
3011 |
|
3012 |
|
3013 <span class="flag private">private</span> |
|
3014 |
|
3015 |
|
3016 |
|
3017 |
|
3018 |
|
3019 |
|
3020 |
|
3021 |
|
3022 |
|
3023 |
|
3024 <div class="meta"> |
|
3025 |
|
3026 |
|
3027 <p>Inherited from |
|
3028 <a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>: |
|
3029 |
|
3030 |
|
3031 |
|
3032 <a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a> |
|
3033 |
|
3034 </p> |
|
3035 |
|
3036 |
|
3037 |
|
3038 |
|
3039 |
|
3040 </div> |
|
3041 |
|
3042 <div class="description"> |
|
3043 <p>A helper method, used by _initHierarchyData to aggregate |
|
3044 attribute configuration across the instances class hierarchy.</p> |
|
3045 |
|
3046 <p>The method will protect the attribute configuration value to protect the statically defined |
|
3047 default value in ATTRS if required (if the value is an object literal, array or the |
|
3048 attribute configuration has cloneDefaultValue set to shallow or deep).</p> |
|
3049 </div> |
|
3050 |
|
3051 |
|
3052 <div class="params"> |
|
3053 <h4>Parameters:</h4> |
|
3054 |
|
3055 <ul class="params-list"> |
|
3056 |
|
3057 <li class="param"> |
|
3058 |
|
3059 <code class="param-name">allAttrs</code> |
|
3060 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
3061 |
|
3062 |
|
3063 |
|
3064 |
|
3065 <div class="param-description"> |
|
3066 <p>An array of ATTRS definitions across classes in the hierarchy |
|
3067 (subclass first, Base last)</p> |
|
3068 </div> |
|
3069 |
|
3070 |
|
3071 </li> |
|
3072 |
|
3073 </ul> |
|
3074 </div> |
|
3075 |
|
3076 |
|
3077 |
|
3078 <div class="returns"> |
|
3079 <h4>Returns:</h4> |
|
3080 |
|
3081 <div class="returns-description"> |
|
3082 |
|
3083 |
|
3084 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
3085 |
|
3086 The aggregate set of ATTRS definitions for the instance |
|
3087 |
|
3088 </div> |
|
3089 </div> |
|
3090 |
|
3091 |
|
3092 |
|
3093 </div> |
|
3094 |
|
3095 |
|
3096 <div id="method__attrCfgHash" class="method item private inherited"> |
|
3097 <h3 class="name"><code>_attrCfgHash</code></h3> |
|
3098 |
|
3099 |
|
3100 <span class="paren">()</span> |
|
3101 |
|
3102 |
|
3103 |
|
3104 |
|
3105 |
|
3106 |
|
3107 |
|
3108 <span class="flag private">private</span> |
|
3109 |
|
3110 |
|
3111 |
|
3112 |
|
3113 |
|
3114 |
|
3115 |
|
3116 |
|
3117 |
|
3118 |
|
3119 <div class="meta"> |
|
3120 |
|
3121 |
|
3122 <p>Inherited from |
|
3123 <a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>: |
|
3124 |
|
3125 |
|
3126 |
|
3127 <a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a> |
|
3128 |
|
3129 </p> |
|
3130 |
|
3131 |
|
3132 |
|
3133 |
|
3134 |
|
3135 </div> |
|
3136 |
|
3137 <div class="description"> |
|
3138 <p>Utility method to define the attribute hash used to filter/whitelist property mixes for |
|
3139 this class for iteration performance reasons.</p> |
|
3140 </div> |
|
3141 |
|
3142 |
|
3143 |
|
3144 |
|
3145 |
|
3146 |
|
3147 </div> |
|
3148 |
|
3149 |
|
3150 <div id="method__baseDestroy" class="method item private inherited"> |
|
3151 <h3 class="name"><code>_baseDestroy</code></h3> |
|
3152 |
|
3153 |
|
3154 <span class="paren">()</span> |
|
3155 |
|
3156 |
|
3157 |
|
3158 |
|
3159 |
|
3160 |
|
3161 |
|
3162 <span class="flag private">private</span> |
|
3163 |
|
3164 |
|
3165 |
|
3166 |
|
3167 |
|
3168 |
|
3169 |
|
3170 |
|
3171 |
|
3172 |
|
3173 <div class="meta"> |
|
3174 |
|
3175 |
|
3176 <p>Inherited from |
|
3177 <a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>: |
|
3178 |
|
3179 |
|
3180 |
|
3181 <a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a> |
|
3182 |
|
3183 </p> |
|
3184 |
|
3185 |
|
3186 |
|
3187 |
|
3188 |
|
3189 </div> |
|
3190 |
|
3191 <div class="description"> |
|
3192 <p>Internal destroy implementation for BaseCore</p> |
|
3193 </div> |
|
3194 |
|
3195 |
|
3196 |
|
3197 |
|
3198 |
|
3199 |
|
3200 </div> |
|
3201 |
|
3202 |
|
3203 <div id="method__baseInit" class="method item private inherited"> |
|
3204 <h3 class="name"><code>_baseInit</code></h3> |
|
3205 |
|
3206 |
|
3207 <span class="paren">()</span> |
|
3208 |
|
3209 |
|
3210 |
|
3211 |
|
3212 |
|
3213 |
|
3214 |
|
3215 <span class="flag private">private</span> |
|
3216 |
|
3217 |
|
3218 |
|
3219 |
|
3220 |
|
3221 |
|
3222 |
|
3223 |
|
3224 |
|
3225 |
|
3226 <div class="meta"> |
|
3227 |
|
3228 |
|
3229 <p>Inherited from |
|
3230 <a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>: |
|
3231 |
|
3232 |
|
3233 |
|
3234 <a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a> |
|
3235 |
|
3236 </p> |
|
3237 |
|
3238 |
|
3239 |
|
3240 |
|
3241 |
|
3242 </div> |
|
3243 |
|
3244 <div class="description"> |
|
3245 <p>Internal initialization implementation for BaseCore</p> |
|
3246 </div> |
|
3247 |
|
3248 |
|
3249 |
|
3250 |
|
3251 |
|
3252 |
|
3253 </div> |
|
3254 |
|
3255 |
|
3256 <div id="method__cloneDefaultValue" class="method item private inherited"> |
|
3257 <h3 class="name"><code>_cloneDefaultValue</code></h3> |
|
3258 |
|
3259 |
|
3260 <div class="args"> |
|
3261 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3262 |
|
3263 <li class="arg"> |
|
3264 |
|
3265 <code>cfg</code> |
|
3266 |
|
3267 </li> |
|
3268 |
|
3269 </ul><span class="paren">)</span> |
|
3270 </div> |
|
3271 |
|
3272 |
|
3273 |
|
3274 |
|
3275 |
|
3276 |
|
3277 |
|
3278 <span class="flag private">private</span> |
|
3279 |
|
3280 |
|
3281 |
|
3282 |
|
3283 |
|
3284 |
|
3285 |
|
3286 |
|
3287 |
|
3288 |
|
3289 <div class="meta"> |
|
3290 |
|
3291 |
|
3292 <p>Inherited from |
|
3293 <a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>: |
|
3294 |
|
3295 |
|
3296 |
|
3297 <a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a> |
|
3298 |
|
3299 </p> |
|
3300 |
|
3301 |
|
3302 |
|
3303 |
|
3304 |
|
3305 </div> |
|
3306 |
|
3307 <div class="description"> |
|
3308 <p>This method assumes that the value has already been checked to be an object. |
|
3309 Since it's on a critical path, we don't want to re-do the check.</p> |
|
3310 </div> |
|
3311 |
|
3312 |
|
3313 <div class="params"> |
|
3314 <h4>Parameters:</h4> |
|
3315 |
|
3316 <ul class="params-list"> |
|
3317 |
|
3318 <li class="param"> |
|
3319 |
|
3320 <code class="param-name">cfg</code> |
|
3321 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3322 |
|
3323 |
|
3324 |
|
3325 |
|
3326 <div class="param-description"> |
|
3327 |
|
3328 </div> |
|
3329 |
|
3330 |
|
3331 </li> |
|
3332 |
|
3333 </ul> |
|
3334 </div> |
|
3335 |
|
3336 |
|
3337 |
|
3338 |
|
3339 |
|
3340 </div> |
|
3341 |
|
3342 |
|
3343 <div id="method__decode" class="method item protected inherited"> |
|
3344 <h3 class="name"><code>_decode</code></h3> |
|
3345 |
|
3346 |
|
3347 <div class="args"> |
|
3348 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3349 |
|
3350 <li class="arg"> |
|
3351 |
|
3352 <code>string</code> |
|
3353 |
|
3354 </li> |
|
3355 |
|
3356 </ul><span class="paren">)</span> |
|
3357 </div> |
|
3358 |
|
3359 |
|
3360 |
|
3361 <span class="returns-inline"> |
|
3362 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3363 </span> |
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 <span class="flag protected">protected</span> |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 |
|
3375 |
|
3376 |
|
3377 |
|
3378 |
|
3379 |
|
3380 <div class="meta"> |
|
3381 |
|
3382 |
|
3383 <p>Inherited from |
|
3384 <a href="../classes/Router.html#method__decode">Router</a>: |
|
3385 |
|
3386 |
|
3387 |
|
3388 <a href="../files/app_js_router.js.html#l564"><code>app/js/router.js:564</code></a> |
|
3389 |
|
3390 </p> |
|
3391 |
|
3392 |
|
3393 |
|
3394 |
|
3395 |
|
3396 </div> |
|
3397 |
|
3398 <div class="description"> |
|
3399 <p>Wrapper around <code>decodeURIComponent</code> that also converts <code>+</code> chars into |
|
3400 spaces.</p> |
|
3401 </div> |
|
3402 |
|
3403 |
|
3404 <div class="params"> |
|
3405 <h4>Parameters:</h4> |
|
3406 |
|
3407 <ul class="params-list"> |
|
3408 |
|
3409 <li class="param"> |
|
3410 |
|
3411 <code class="param-name">string</code> |
|
3412 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3413 |
|
3414 |
|
3415 |
|
3416 |
|
3417 <div class="param-description"> |
|
3418 <p>String to decode.</p> |
|
3419 </div> |
|
3420 |
|
3421 |
|
3422 </li> |
|
3423 |
|
3424 </ul> |
|
3425 </div> |
|
3426 |
|
3427 |
|
3428 |
|
3429 <div class="returns"> |
|
3430 <h4>Returns:</h4> |
|
3431 |
|
3432 <div class="returns-description"> |
|
3433 |
|
3434 |
|
3435 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
3436 |
|
3437 Decoded string. |
|
3438 |
|
3439 </div> |
|
3440 </div> |
|
3441 |
|
3442 |
|
3443 |
|
3444 </div> |
|
3445 |
|
3446 |
|
3447 <div id="method__defAttrChangeFn" class="method item private inherited"> |
|
3448 <h3 class="name"><code>_defAttrChangeFn</code></h3> |
|
3449 |
|
3450 |
|
3451 <div class="args"> |
|
3452 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3453 |
|
3454 <li class="arg"> |
|
3455 |
|
3456 <code>e</code> |
|
3457 |
|
3458 </li> |
|
3459 |
|
3460 </ul><span class="paren">)</span> |
|
3461 </div> |
|
3462 |
|
3463 |
|
3464 |
|
3465 |
|
3466 |
|
3467 |
|
3468 |
|
3469 <span class="flag private">private</span> |
|
3470 |
|
3471 |
|
3472 |
|
3473 |
|
3474 |
|
3475 |
|
3476 |
|
3477 |
|
3478 |
|
3479 |
|
3480 <div class="meta"> |
|
3481 |
|
3482 |
|
3483 <p>Inherited from |
|
3484 <a href="../classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>: |
|
3485 |
|
3486 |
|
3487 |
|
3488 <a href="../files/attribute_js_AttributeObservable.js.html#l186"><code>attribute/js/AttributeObservable.js:186</code></a> |
|
3489 |
|
3490 </p> |
|
3491 |
|
3492 |
|
3493 |
|
3494 |
|
3495 |
|
3496 </div> |
|
3497 |
|
3498 <div class="description"> |
|
3499 <p>Default function for attribute change events.</p> |
|
3500 </div> |
|
3501 |
|
3502 |
|
3503 <div class="params"> |
|
3504 <h4>Parameters:</h4> |
|
3505 |
|
3506 <ul class="params-list"> |
|
3507 |
|
3508 <li class="param"> |
|
3509 |
|
3510 <code class="param-name">e</code> |
|
3511 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3512 |
|
3513 |
|
3514 |
|
3515 |
|
3516 <div class="param-description"> |
|
3517 <p>The event object for attribute change events.</p> |
|
3518 </div> |
|
3519 |
|
3520 |
|
3521 </li> |
|
3522 |
|
3523 </ul> |
|
3524 </div> |
|
3525 |
|
3526 |
|
3527 |
|
3528 |
|
3529 |
|
3530 </div> |
|
3531 |
|
3532 |
|
3533 <div id="method__defaultRoute" class="method item protected inherited"> |
|
3534 <h3 class="name"><code>_defaultRoute</code></h3> |
|
3535 |
|
3536 |
|
3537 <div class="args"> |
|
3538 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3539 |
|
3540 <li class="arg"> |
|
3541 |
|
3542 <code>req</code> |
|
3543 |
|
3544 </li> |
|
3545 |
|
3546 <li class="arg"> |
|
3547 |
|
3548 <code>res</code> |
|
3549 |
|
3550 </li> |
|
3551 |
|
3552 <li class="arg"> |
|
3553 |
|
3554 <code>next</code> |
|
3555 |
|
3556 </li> |
|
3557 |
|
3558 </ul><span class="paren">)</span> |
|
3559 </div> |
|
3560 |
|
3561 |
|
3562 |
|
3563 |
|
3564 |
|
3565 |
|
3566 |
|
3567 <span class="flag protected">protected</span> |
|
3568 |
|
3569 |
|
3570 |
|
3571 |
|
3572 |
|
3573 |
|
3574 |
|
3575 |
|
3576 |
|
3577 |
|
3578 <div class="meta"> |
|
3579 |
|
3580 |
|
3581 <p>Inherited from |
|
3582 <a href="../classes/Pjax.html#method__defaultRoute">Pjax</a>: |
|
3583 |
|
3584 |
|
3585 |
|
3586 <a href="../files/pjax_js_pjax.js.html#l81"><code>pjax/js/pjax.js:81</code></a> |
|
3587 |
|
3588 </p> |
|
3589 |
|
3590 |
|
3591 |
|
3592 |
|
3593 |
|
3594 <p>Available since 3.5.0</p> |
|
3595 |
|
3596 </div> |
|
3597 |
|
3598 <div class="description"> |
|
3599 <p>Default Pjax route callback. Fires either the <code>load</code> or <code>error</code> event based |
|
3600 on the status of the <code>Y.io</code> request made by the <code>loadContent()</code> middleware.</p> |
|
3601 |
|
3602 <p><strong>Note:</strong> This route callback assumes that it's called after the |
|
3603 <code>loadContent()</code> middleware.</p> |
|
3604 </div> |
|
3605 |
|
3606 |
|
3607 <div class="params"> |
|
3608 <h4>Parameters:</h4> |
|
3609 |
|
3610 <ul class="params-list"> |
|
3611 |
|
3612 <li class="param"> |
|
3613 |
|
3614 <code class="param-name">req</code> |
|
3615 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3616 |
|
3617 |
|
3618 |
|
3619 |
|
3620 <div class="param-description"> |
|
3621 <p>Request object.</p> |
|
3622 </div> |
|
3623 |
|
3624 |
|
3625 </li> |
|
3626 |
|
3627 <li class="param"> |
|
3628 |
|
3629 <code class="param-name">res</code> |
|
3630 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3631 |
|
3632 |
|
3633 |
|
3634 |
|
3635 <div class="param-description"> |
|
3636 <p>Response Object.</p> |
|
3637 </div> |
|
3638 |
|
3639 |
|
3640 </li> |
|
3641 |
|
3642 <li class="param"> |
|
3643 |
|
3644 <code class="param-name">next</code> |
|
3645 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
3646 |
|
3647 |
|
3648 |
|
3649 |
|
3650 <div class="param-description"> |
|
3651 <p>Function to pass control to the next route callback.</p> |
|
3652 </div> |
|
3653 |
|
3654 |
|
3655 </li> |
|
3656 |
|
3657 </ul> |
|
3658 </div> |
|
3659 |
|
3660 |
|
3661 |
|
3662 |
|
3663 |
|
3664 </div> |
|
3665 |
|
3666 |
|
3667 <div id="method__defCompleteFn" class="method item protected inherited"> |
|
3668 <h3 class="name"><code>_defCompleteFn</code></h3> |
|
3669 |
|
3670 |
|
3671 <div class="args"> |
|
3672 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3673 |
|
3674 <li class="arg"> |
|
3675 |
|
3676 <code>e</code> |
|
3677 |
|
3678 </li> |
|
3679 |
|
3680 </ul><span class="paren">)</span> |
|
3681 </div> |
|
3682 |
|
3683 |
|
3684 |
|
3685 |
|
3686 |
|
3687 |
|
3688 |
|
3689 <span class="flag protected">protected</span> |
|
3690 |
|
3691 |
|
3692 |
|
3693 |
|
3694 |
|
3695 |
|
3696 |
|
3697 |
|
3698 |
|
3699 |
|
3700 <div class="meta"> |
|
3701 |
|
3702 |
|
3703 <p>Inherited from |
|
3704 <a href="../classes/Pjax.html#method__defCompleteFn">Pjax</a>: |
|
3705 |
|
3706 |
|
3707 |
|
3708 <a href="../files/pjax_js_pjax.js.html#l113"><code>pjax/js/pjax.js:113</code></a> |
|
3709 |
|
3710 </p> |
|
3711 |
|
3712 |
|
3713 |
|
3714 |
|
3715 |
|
3716 <p>Available since 3.5.0</p> |
|
3717 |
|
3718 </div> |
|
3719 |
|
3720 <div class="description"> |
|
3721 <p>Default event handler for both the <code>error</code> and <code>load</code> events. Attempts to |
|
3722 insert the loaded content into the <code>container</code> node and update the page's |
|
3723 title.</p> |
|
3724 </div> |
|
3725 |
|
3726 |
|
3727 <div class="params"> |
|
3728 <h4>Parameters:</h4> |
|
3729 |
|
3730 <ul class="params-list"> |
|
3731 |
|
3732 <li class="param"> |
|
3733 |
|
3734 <code class="param-name">e</code> |
|
3735 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3736 |
|
3737 |
|
3738 |
|
3739 |
|
3740 <div class="param-description"> |
|
3741 |
|
3742 </div> |
|
3743 |
|
3744 |
|
3745 </li> |
|
3746 |
|
3747 </ul> |
|
3748 </div> |
|
3749 |
|
3750 |
|
3751 |
|
3752 |
|
3753 |
|
3754 </div> |
|
3755 |
|
3756 |
|
3757 <div id="method__defDestroyFn" class="method item protected inherited"> |
|
3758 <h3 class="name"><code>_defDestroyFn</code></h3> |
|
3759 |
|
3760 |
|
3761 <div class="args"> |
|
3762 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3763 |
|
3764 <li class="arg"> |
|
3765 |
|
3766 <code>e</code> |
|
3767 |
|
3768 </li> |
|
3769 |
|
3770 </ul><span class="paren">)</span> |
|
3771 </div> |
|
3772 |
|
3773 |
|
3774 |
|
3775 |
|
3776 |
|
3777 |
|
3778 |
|
3779 <span class="flag protected">protected</span> |
|
3780 |
|
3781 |
|
3782 |
|
3783 |
|
3784 |
|
3785 |
|
3786 |
|
3787 |
|
3788 |
|
3789 |
|
3790 <div class="meta"> |
|
3791 |
|
3792 |
|
3793 <p>Inherited from |
|
3794 <a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>: |
|
3795 |
|
3796 |
|
3797 |
|
3798 <a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a> |
|
3799 |
|
3800 </p> |
|
3801 |
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 </div> |
|
3807 |
|
3808 <div class="description"> |
|
3809 <p>Default destroy event handler</p> |
|
3810 </div> |
|
3811 |
|
3812 |
|
3813 <div class="params"> |
|
3814 <h4>Parameters:</h4> |
|
3815 |
|
3816 <ul class="params-list"> |
|
3817 |
|
3818 <li class="param"> |
|
3819 |
|
3820 <code class="param-name">e</code> |
|
3821 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3822 |
|
3823 |
|
3824 |
|
3825 |
|
3826 <div class="param-description"> |
|
3827 <p>Event object</p> |
|
3828 </div> |
|
3829 |
|
3830 |
|
3831 </li> |
|
3832 |
|
3833 </ul> |
|
3834 </div> |
|
3835 |
|
3836 |
|
3837 |
|
3838 |
|
3839 |
|
3840 </div> |
|
3841 |
|
3842 |
|
3843 <div id="method__defInitFn" class="method item protected inherited"> |
|
3844 <h3 class="name"><code>_defInitFn</code></h3> |
|
3845 |
|
3846 |
|
3847 <div class="args"> |
|
3848 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3849 |
|
3850 <li class="arg"> |
|
3851 |
|
3852 <code>e</code> |
|
3853 |
|
3854 </li> |
|
3855 |
|
3856 </ul><span class="paren">)</span> |
|
3857 </div> |
|
3858 |
|
3859 |
|
3860 |
|
3861 |
|
3862 |
|
3863 |
|
3864 |
|
3865 <span class="flag protected">protected</span> |
|
3866 |
|
3867 |
|
3868 |
|
3869 |
|
3870 |
|
3871 |
|
3872 |
|
3873 |
|
3874 |
|
3875 |
|
3876 <div class="meta"> |
|
3877 |
|
3878 |
|
3879 <p>Inherited from |
|
3880 <a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>: |
|
3881 |
|
3882 |
|
3883 |
|
3884 <a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a> |
|
3885 |
|
3886 </p> |
|
3887 |
|
3888 |
|
3889 |
|
3890 |
|
3891 |
|
3892 </div> |
|
3893 |
|
3894 <div class="description"> |
|
3895 <p>Default init event handler</p> |
|
3896 </div> |
|
3897 |
|
3898 |
|
3899 <div class="params"> |
|
3900 <h4>Parameters:</h4> |
|
3901 |
|
3902 <ul class="params-list"> |
|
3903 |
|
3904 <li class="param"> |
|
3905 |
|
3906 <code class="param-name">e</code> |
|
3907 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3908 |
|
3909 |
|
3910 |
|
3911 |
|
3912 <div class="param-description"> |
|
3913 <p>Event object, with a cfg property which |
|
3914 refers to the configuration object passed to the constructor.</p> |
|
3915 </div> |
|
3916 |
|
3917 |
|
3918 </li> |
|
3919 |
|
3920 </ul> |
|
3921 </div> |
|
3922 |
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 </div> |
|
3928 |
|
3929 |
|
3930 <div id="method__defNavigateFn" class="method item protected inherited"> |
|
3931 <h3 class="name"><code>_defNavigateFn</code></h3> |
|
3932 |
|
3933 |
|
3934 <div class="args"> |
|
3935 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3936 |
|
3937 <li class="arg"> |
|
3938 |
|
3939 <code>e</code> |
|
3940 |
|
3941 </li> |
|
3942 |
|
3943 </ul><span class="paren">)</span> |
|
3944 </div> |
|
3945 |
|
3946 |
|
3947 |
|
3948 |
|
3949 |
|
3950 |
|
3951 |
|
3952 <span class="flag protected">protected</span> |
|
3953 |
|
3954 |
|
3955 |
|
3956 |
|
3957 |
|
3958 |
|
3959 |
|
3960 |
|
3961 |
|
3962 |
|
3963 <div class="meta"> |
|
3964 |
|
3965 |
|
3966 <p>Inherited from |
|
3967 <a href="../classes/PjaxBase.html#method__defNavigateFn">PjaxBase</a>: |
|
3968 |
|
3969 |
|
3970 |
|
3971 <a href="../files/pjax_js_pjax-base.js.html#l300"><code>pjax/js/pjax-base.js:300</code></a> |
|
3972 |
|
3973 </p> |
|
3974 |
|
3975 |
|
3976 |
|
3977 |
|
3978 |
|
3979 <p>Available since 3.5.0</p> |
|
3980 |
|
3981 </div> |
|
3982 |
|
3983 <div class="description"> |
|
3984 <p>Default handler for the <code>navigate</code> event.</p> |
|
3985 |
|
3986 <p>Adds a new history entry or replaces the current entry for the specified URL |
|
3987 and will scroll the page to the top if configured to do so.</p> |
|
3988 </div> |
|
3989 |
|
3990 |
|
3991 <div class="params"> |
|
3992 <h4>Parameters:</h4> |
|
3993 |
|
3994 <ul class="params-list"> |
|
3995 |
|
3996 <li class="param"> |
|
3997 |
|
3998 <code class="param-name">e</code> |
|
3999 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4000 |
|
4001 |
|
4002 |
|
4003 |
|
4004 <div class="param-description"> |
|
4005 |
|
4006 </div> |
|
4007 |
|
4008 |
|
4009 </li> |
|
4010 |
|
4011 </ul> |
|
4012 </div> |
|
4013 |
|
4014 |
|
4015 |
|
4016 |
|
4017 |
|
4018 </div> |
|
4019 |
|
4020 |
|
4021 <div id="method__defReadyFn" class="method item protected inherited"> |
|
4022 <h3 class="name"><code>_defReadyFn</code></h3> |
|
4023 |
|
4024 |
|
4025 <div class="args"> |
|
4026 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4027 |
|
4028 <li class="arg"> |
|
4029 |
|
4030 <code>e</code> |
|
4031 |
|
4032 </li> |
|
4033 |
|
4034 </ul><span class="paren">)</span> |
|
4035 </div> |
|
4036 |
|
4037 |
|
4038 |
|
4039 |
|
4040 |
|
4041 |
|
4042 |
|
4043 <span class="flag protected">protected</span> |
|
4044 |
|
4045 |
|
4046 |
|
4047 |
|
4048 |
|
4049 |
|
4050 |
|
4051 |
|
4052 |
|
4053 |
|
4054 <div class="meta"> |
|
4055 |
|
4056 |
|
4057 <p>Inherited from |
|
4058 <a href="../classes/Router.html#method__defReadyFn">Router</a>: |
|
4059 |
|
4060 |
|
4061 |
|
4062 <a href="../files/app_js_router.js.html#l1300"><code>app/js/router.js:1300</code></a> |
|
4063 |
|
4064 </p> |
|
4065 |
|
4066 |
|
4067 |
|
4068 |
|
4069 |
|
4070 </div> |
|
4071 |
|
4072 <div class="description"> |
|
4073 <p>Default handler for the <code>ready</code> event.</p> |
|
4074 </div> |
|
4075 |
|
4076 |
|
4077 <div class="params"> |
|
4078 <h4>Parameters:</h4> |
|
4079 |
|
4080 <ul class="params-list"> |
|
4081 |
|
4082 <li class="param"> |
|
4083 |
|
4084 <code class="param-name">e</code> |
|
4085 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4086 |
|
4087 |
|
4088 |
|
4089 |
|
4090 <div class="param-description"> |
|
4091 |
|
4092 </div> |
|
4093 |
|
4094 |
|
4095 </li> |
|
4096 |
|
4097 </ul> |
|
4098 </div> |
|
4099 |
|
4100 |
|
4101 |
|
4102 |
|
4103 |
|
4104 </div> |
|
4105 |
|
4106 |
|
4107 <div id="method__dequeue" class="method item protected inherited"> |
|
4108 <h3 class="name"><code>_dequeue</code></h3> |
|
4109 |
|
4110 |
|
4111 <span class="paren">()</span> |
|
4112 |
|
4113 |
|
4114 |
|
4115 |
|
4116 |
|
4117 |
|
4118 |
|
4119 <span class="flag protected">protected</span> |
|
4120 |
|
4121 |
|
4122 |
|
4123 |
|
4124 |
|
4125 |
|
4126 |
|
4127 <span class="flag chainable">chainable</span> |
|
4128 |
|
4129 |
|
4130 |
|
4131 |
|
4132 <div class="meta"> |
|
4133 |
|
4134 |
|
4135 <p>Inherited from |
|
4136 <a href="../classes/Router.html#method__dequeue">Router</a>: |
|
4137 |
|
4138 |
|
4139 |
|
4140 <a href="../files/app_js_router.js.html#l577"><code>app/js/router.js:577</code></a> |
|
4141 |
|
4142 </p> |
|
4143 |
|
4144 |
|
4145 |
|
4146 |
|
4147 |
|
4148 </div> |
|
4149 |
|
4150 <div class="description"> |
|
4151 <p>Shifts the topmost <code>_save()</code> call off the queue and executes it. Does |
|
4152 nothing if the queue is empty.</p> |
|
4153 </div> |
|
4154 |
|
4155 |
|
4156 |
|
4157 |
|
4158 |
|
4159 |
|
4160 </div> |
|
4161 |
|
4162 |
|
4163 <div id="method__destroyHierarchy" class="method item private inherited"> |
|
4164 <h3 class="name"><code>_destroyHierarchy</code></h3> |
|
4165 |
|
4166 |
|
4167 <span class="paren">()</span> |
|
4168 |
|
4169 |
|
4170 |
|
4171 |
|
4172 |
|
4173 |
|
4174 |
|
4175 <span class="flag private">private</span> |
|
4176 |
|
4177 |
|
4178 |
|
4179 |
|
4180 |
|
4181 |
|
4182 |
|
4183 |
|
4184 |
|
4185 |
|
4186 <div class="meta"> |
|
4187 |
|
4188 |
|
4189 <p>Inherited from |
|
4190 <a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>: |
|
4191 |
|
4192 |
|
4193 |
|
4194 <a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a> |
|
4195 |
|
4196 </p> |
|
4197 |
|
4198 |
|
4199 |
|
4200 |
|
4201 |
|
4202 </div> |
|
4203 |
|
4204 <div class="description"> |
|
4205 <p>Destroys the class hierarchy for this instance by invoking |
|
4206 the destructor method on the prototype of each class in the hierarchy.</p> |
|
4207 </div> |
|
4208 |
|
4209 |
|
4210 |
|
4211 |
|
4212 |
|
4213 |
|
4214 </div> |
|
4215 |
|
4216 |
|
4217 <div id="method__dispatch" class="method item protected inherited"> |
|
4218 <h3 class="name"><code>_dispatch</code></h3> |
|
4219 |
|
4220 |
|
4221 <div class="args"> |
|
4222 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4223 |
|
4224 <li class="arg"> |
|
4225 |
|
4226 <code>path</code> |
|
4227 |
|
4228 </li> |
|
4229 |
|
4230 <li class="arg"> |
|
4231 |
|
4232 <code>url</code> |
|
4233 |
|
4234 </li> |
|
4235 |
|
4236 <li class="arg"> |
|
4237 |
|
4238 <code>src</code> |
|
4239 |
|
4240 </li> |
|
4241 |
|
4242 </ul><span class="paren">)</span> |
|
4243 </div> |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 |
|
4250 |
|
4251 <span class="flag protected">protected</span> |
|
4252 |
|
4253 |
|
4254 |
|
4255 |
|
4256 |
|
4257 |
|
4258 |
|
4259 <span class="flag chainable">chainable</span> |
|
4260 |
|
4261 |
|
4262 |
|
4263 |
|
4264 <div class="meta"> |
|
4265 |
|
4266 |
|
4267 <p>Inherited from |
|
4268 <a href="../classes/Router.html#method__dispatch">Router</a>: |
|
4269 |
|
4270 |
|
4271 |
|
4272 <a href="../files/app_js_router.js.html#l605"><code>app/js/router.js:605</code></a> |
|
4273 |
|
4274 </p> |
|
4275 |
|
4276 |
|
4277 |
|
4278 |
|
4279 |
|
4280 </div> |
|
4281 |
|
4282 <div class="description"> |
|
4283 <p>Dispatches to the first route handler that matches the specified <em>path</em>.</p> |
|
4284 |
|
4285 <p>If called before the <code>ready</code> event has fired, the dispatch will be aborted. |
|
4286 This ensures normalized behavior between Chrome (which fires a <code>popstate</code> |
|
4287 event on every pageview) and other browsers (which do not).</p> |
|
4288 </div> |
|
4289 |
|
4290 |
|
4291 <div class="params"> |
|
4292 <h4>Parameters:</h4> |
|
4293 |
|
4294 <ul class="params-list"> |
|
4295 |
|
4296 <li class="param"> |
|
4297 |
|
4298 <code class="param-name">path</code> |
|
4299 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4300 |
|
4301 |
|
4302 |
|
4303 |
|
4304 <div class="param-description"> |
|
4305 <p>URL path.</p> |
|
4306 </div> |
|
4307 |
|
4308 |
|
4309 </li> |
|
4310 |
|
4311 <li class="param"> |
|
4312 |
|
4313 <code class="param-name">url</code> |
|
4314 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4315 |
|
4316 |
|
4317 |
|
4318 |
|
4319 <div class="param-description"> |
|
4320 <p>Full URL.</p> |
|
4321 </div> |
|
4322 |
|
4323 |
|
4324 </li> |
|
4325 |
|
4326 <li class="param"> |
|
4327 |
|
4328 <code class="param-name">src</code> |
|
4329 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4330 |
|
4331 |
|
4332 |
|
4333 |
|
4334 <div class="param-description"> |
|
4335 <p>What initiated the dispatch.</p> |
|
4336 </div> |
|
4337 |
|
4338 |
|
4339 </li> |
|
4340 |
|
4341 </ul> |
|
4342 </div> |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 |
|
4348 </div> |
|
4349 |
|
4350 |
|
4351 <div id="method__filterAdHocAttrs" class="method item private inherited"> |
|
4352 <h3 class="name"><code>_filterAdHocAttrs</code></h3> |
|
4353 |
|
4354 |
|
4355 <div class="args"> |
|
4356 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4357 |
|
4358 <li class="arg"> |
|
4359 |
|
4360 <code>allAttrs</code> |
|
4361 |
|
4362 </li> |
|
4363 |
|
4364 <li class="arg"> |
|
4365 |
|
4366 <code>userVals</code> |
|
4367 |
|
4368 </li> |
|
4369 |
|
4370 </ul><span class="paren">)</span> |
|
4371 </div> |
|
4372 |
|
4373 |
|
4374 |
|
4375 <span class="returns-inline"> |
|
4376 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4377 </span> |
|
4378 |
|
4379 |
|
4380 |
|
4381 |
|
4382 |
|
4383 <span class="flag private">private</span> |
|
4384 |
|
4385 |
|
4386 |
|
4387 |
|
4388 |
|
4389 |
|
4390 |
|
4391 |
|
4392 |
|
4393 |
|
4394 <div class="meta"> |
|
4395 |
|
4396 |
|
4397 <p>Inherited from |
|
4398 <a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>: |
|
4399 |
|
4400 |
|
4401 |
|
4402 <a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a> |
|
4403 |
|
4404 </p> |
|
4405 |
|
4406 |
|
4407 |
|
4408 |
|
4409 |
|
4410 </div> |
|
4411 |
|
4412 <div class="description"> |
|
4413 |
|
4414 </div> |
|
4415 |
|
4416 |
|
4417 <div class="params"> |
|
4418 <h4>Parameters:</h4> |
|
4419 |
|
4420 <ul class="params-list"> |
|
4421 |
|
4422 <li class="param"> |
|
4423 |
|
4424 <code class="param-name">allAttrs</code> |
|
4425 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4426 |
|
4427 |
|
4428 |
|
4429 |
|
4430 <div class="param-description"> |
|
4431 <p>The set of all attribute configurations for this instance. |
|
4432 Attributes will be removed from this set, if they belong to the filtered class, so |
|
4433 that by the time all classes are processed, allCfgs will be empty.</p> |
|
4434 </div> |
|
4435 |
|
4436 |
|
4437 </li> |
|
4438 |
|
4439 <li class="param"> |
|
4440 |
|
4441 <code class="param-name">userVals</code> |
|
4442 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4443 |
|
4444 |
|
4445 |
|
4446 |
|
4447 <div class="param-description"> |
|
4448 <p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p> |
|
4449 </div> |
|
4450 |
|
4451 |
|
4452 </li> |
|
4453 |
|
4454 </ul> |
|
4455 </div> |
|
4456 |
|
4457 |
|
4458 |
|
4459 <div class="returns"> |
|
4460 <h4>Returns:</h4> |
|
4461 |
|
4462 <div class="returns-description"> |
|
4463 |
|
4464 |
|
4465 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
4466 |
|
4467 The set of adhoc attributes passed in, in the form |
|
4468 of an object with attribute name/configuration pairs. |
|
4469 |
|
4470 </div> |
|
4471 </div> |
|
4472 |
|
4473 |
|
4474 |
|
4475 </div> |
|
4476 |
|
4477 |
|
4478 <div id="method__filterAttrCfgs" class="method item private inherited"> |
|
4479 <h3 class="name"><code>_filterAttrCfgs</code></h3> |
|
4480 |
|
4481 |
|
4482 <div class="args"> |
|
4483 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4484 |
|
4485 <li class="arg"> |
|
4486 |
|
4487 <code>clazz</code> |
|
4488 |
|
4489 </li> |
|
4490 |
|
4491 <li class="arg"> |
|
4492 |
|
4493 <code>allCfgs</code> |
|
4494 |
|
4495 </li> |
|
4496 |
|
4497 </ul><span class="paren">)</span> |
|
4498 </div> |
|
4499 |
|
4500 |
|
4501 |
|
4502 <span class="returns-inline"> |
|
4503 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4504 </span> |
|
4505 |
|
4506 |
|
4507 |
|
4508 |
|
4509 |
|
4510 <span class="flag private">private</span> |
|
4511 |
|
4512 |
|
4513 |
|
4514 |
|
4515 |
|
4516 |
|
4517 |
|
4518 |
|
4519 |
|
4520 |
|
4521 <div class="meta"> |
|
4522 |
|
4523 |
|
4524 <p>Inherited from |
|
4525 <a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>: |
|
4526 |
|
4527 |
|
4528 |
|
4529 <a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a> |
|
4530 |
|
4531 </p> |
|
4532 |
|
4533 |
|
4534 |
|
4535 |
|
4536 |
|
4537 </div> |
|
4538 |
|
4539 <div class="description"> |
|
4540 <p>A helper method used when processing ATTRS across the class hierarchy during |
|
4541 initialization. Returns a disposable object with the attributes defined for |
|
4542 the provided class, extracted from the set of all attributes passed in.</p> |
|
4543 </div> |
|
4544 |
|
4545 |
|
4546 <div class="params"> |
|
4547 <h4>Parameters:</h4> |
|
4548 |
|
4549 <ul class="params-list"> |
|
4550 |
|
4551 <li class="param"> |
|
4552 |
|
4553 <code class="param-name">clazz</code> |
|
4554 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
4555 |
|
4556 |
|
4557 |
|
4558 |
|
4559 <div class="param-description"> |
|
4560 <p>The class for which the desired attributes are required.</p> |
|
4561 </div> |
|
4562 |
|
4563 |
|
4564 </li> |
|
4565 |
|
4566 <li class="param"> |
|
4567 |
|
4568 <code class="param-name">allCfgs</code> |
|
4569 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4570 |
|
4571 |
|
4572 |
|
4573 |
|
4574 <div class="param-description"> |
|
4575 <p>The set of all attribute configurations for this instance. |
|
4576 Attributes will be removed from this set, if they belong to the filtered class, so |
|
4577 that by the time all classes are processed, allCfgs will be empty.</p> |
|
4578 </div> |
|
4579 |
|
4580 |
|
4581 </li> |
|
4582 |
|
4583 </ul> |
|
4584 </div> |
|
4585 |
|
4586 |
|
4587 |
|
4588 <div class="returns"> |
|
4589 <h4>Returns:</h4> |
|
4590 |
|
4591 <div class="returns-description"> |
|
4592 |
|
4593 |
|
4594 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
4595 |
|
4596 The set of attributes belonging to the class passed in, in the form |
|
4597 of an object with attribute name/configuration pairs. |
|
4598 |
|
4599 </div> |
|
4600 </div> |
|
4601 |
|
4602 |
|
4603 |
|
4604 </div> |
|
4605 |
|
4606 |
|
4607 <div id="method__fireAttrChange" class="method item private inherited"> |
|
4608 <h3 class="name"><code>_fireAttrChange</code></h3> |
|
4609 |
|
4610 |
|
4611 <div class="args"> |
|
4612 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4613 |
|
4614 <li class="arg"> |
|
4615 |
|
4616 <code>attrName</code> |
|
4617 |
|
4618 </li> |
|
4619 |
|
4620 <li class="arg"> |
|
4621 |
|
4622 <code>subAttrName</code> |
|
4623 |
|
4624 </li> |
|
4625 |
|
4626 <li class="arg"> |
|
4627 |
|
4628 <code>currVal</code> |
|
4629 |
|
4630 </li> |
|
4631 |
|
4632 <li class="arg"> |
|
4633 |
|
4634 <code>newVal</code> |
|
4635 |
|
4636 </li> |
|
4637 |
|
4638 <li class="arg"> |
|
4639 |
|
4640 <code>opts</code> |
|
4641 |
|
4642 </li> |
|
4643 |
|
4644 <li class="arg"> |
|
4645 |
|
4646 <code class="optional">[cfg]</code> |
|
4647 |
|
4648 </li> |
|
4649 |
|
4650 </ul><span class="paren">)</span> |
|
4651 </div> |
|
4652 |
|
4653 |
|
4654 |
|
4655 |
|
4656 |
|
4657 |
|
4658 |
|
4659 <span class="flag private">private</span> |
|
4660 |
|
4661 |
|
4662 |
|
4663 |
|
4664 |
|
4665 |
|
4666 |
|
4667 |
|
4668 |
|
4669 |
|
4670 <div class="meta"> |
|
4671 |
|
4672 |
|
4673 <p>Inherited from |
|
4674 <a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>: |
|
4675 |
|
4676 |
|
4677 |
|
4678 <a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a> |
|
4679 |
|
4680 </p> |
|
4681 |
|
4682 |
|
4683 |
|
4684 |
|
4685 |
|
4686 </div> |
|
4687 |
|
4688 <div class="description"> |
|
4689 <p>Utility method to help setup the event payload and fire the attribute change event.</p> |
|
4690 </div> |
|
4691 |
|
4692 |
|
4693 <div class="params"> |
|
4694 <h4>Parameters:</h4> |
|
4695 |
|
4696 <ul class="params-list"> |
|
4697 |
|
4698 <li class="param"> |
|
4699 |
|
4700 <code class="param-name">attrName</code> |
|
4701 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4702 |
|
4703 |
|
4704 |
|
4705 |
|
4706 <div class="param-description"> |
|
4707 <p>The name of the attribute</p> |
|
4708 </div> |
|
4709 |
|
4710 |
|
4711 </li> |
|
4712 |
|
4713 <li class="param"> |
|
4714 |
|
4715 <code class="param-name">subAttrName</code> |
|
4716 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4717 |
|
4718 |
|
4719 |
|
4720 |
|
4721 <div class="param-description"> |
|
4722 <p>The full path of the property being changed, |
|
4723 if this is a sub-attribute value being change. Otherwise null.</p> |
|
4724 </div> |
|
4725 |
|
4726 |
|
4727 </li> |
|
4728 |
|
4729 <li class="param"> |
|
4730 |
|
4731 <code class="param-name">currVal</code> |
|
4732 <span class="type">Any</span> |
|
4733 |
|
4734 |
|
4735 |
|
4736 |
|
4737 <div class="param-description"> |
|
4738 <p>The current value of the attribute</p> |
|
4739 </div> |
|
4740 |
|
4741 |
|
4742 </li> |
|
4743 |
|
4744 <li class="param"> |
|
4745 |
|
4746 <code class="param-name">newVal</code> |
|
4747 <span class="type">Any</span> |
|
4748 |
|
4749 |
|
4750 |
|
4751 |
|
4752 <div class="param-description"> |
|
4753 <p>The new value of the attribute</p> |
|
4754 </div> |
|
4755 |
|
4756 |
|
4757 </li> |
|
4758 |
|
4759 <li class="param"> |
|
4760 |
|
4761 <code class="param-name">opts</code> |
|
4762 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4763 |
|
4764 |
|
4765 |
|
4766 |
|
4767 <div class="param-description"> |
|
4768 <p>Any additional event data to mix into the attribute change event's event facade.</p> |
|
4769 </div> |
|
4770 |
|
4771 |
|
4772 </li> |
|
4773 |
|
4774 <li class="param"> |
|
4775 |
|
4776 <code class="param-name optional">[cfg]</code> |
|
4777 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4778 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
4779 |
|
4780 |
|
4781 |
|
4782 |
|
4783 <div class="param-description"> |
|
4784 <p>The attribute config stored in State, if already available.</p> |
|
4785 </div> |
|
4786 |
|
4787 |
|
4788 </li> |
|
4789 |
|
4790 </ul> |
|
4791 </div> |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 |
|
4797 </div> |
|
4798 |
|
4799 |
|
4800 <div id="method__getAttr" class="method item protected inherited"> |
|
4801 <h3 class="name"><code>_getAttr</code></h3> |
|
4802 |
|
4803 |
|
4804 <div class="args"> |
|
4805 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4806 |
|
4807 <li class="arg"> |
|
4808 |
|
4809 <code>name</code> |
|
4810 |
|
4811 </li> |
|
4812 |
|
4813 </ul><span class="paren">)</span> |
|
4814 </div> |
|
4815 |
|
4816 |
|
4817 |
|
4818 <span class="returns-inline"> |
|
4819 <span class="type">Any</span> |
|
4820 </span> |
|
4821 |
|
4822 |
|
4823 |
|
4824 |
|
4825 |
|
4826 <span class="flag protected">protected</span> |
|
4827 |
|
4828 |
|
4829 |
|
4830 |
|
4831 |
|
4832 |
|
4833 |
|
4834 <span class="flag chainable">chainable</span> |
|
4835 |
|
4836 |
|
4837 |
|
4838 |
|
4839 <div class="meta"> |
|
4840 |
|
4841 |
|
4842 <p>Inherited from |
|
4843 <a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>: |
|
4844 |
|
4845 |
|
4846 |
|
4847 <a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a> |
|
4848 |
|
4849 </p> |
|
4850 |
|
4851 |
|
4852 |
|
4853 |
|
4854 |
|
4855 </div> |
|
4856 |
|
4857 <div class="description"> |
|
4858 <p>Provides the common implementation for the public get method, |
|
4859 allowing Attribute hosts to over-ride either method.</p> |
|
4860 |
|
4861 <p>See <a href="#method_get">get</a> for argument details.</p> |
|
4862 </div> |
|
4863 |
|
4864 |
|
4865 <div class="params"> |
|
4866 <h4>Parameters:</h4> |
|
4867 |
|
4868 <ul class="params-list"> |
|
4869 |
|
4870 <li class="param"> |
|
4871 |
|
4872 <code class="param-name">name</code> |
|
4873 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4874 |
|
4875 |
|
4876 |
|
4877 |
|
4878 <div class="param-description"> |
|
4879 <p>The name of the attribute.</p> |
|
4880 </div> |
|
4881 |
|
4882 |
|
4883 </li> |
|
4884 |
|
4885 </ul> |
|
4886 </div> |
|
4887 |
|
4888 |
|
4889 |
|
4890 <div class="returns"> |
|
4891 <h4>Returns:</h4> |
|
4892 |
|
4893 <div class="returns-description"> |
|
4894 |
|
4895 |
|
4896 <span class="type">Any</span>: |
|
4897 |
|
4898 The value of the attribute. |
|
4899 |
|
4900 </div> |
|
4901 </div> |
|
4902 |
|
4903 |
|
4904 |
|
4905 </div> |
|
4906 |
|
4907 |
|
4908 <div id="method__getAttrCfg" class="method item protected inherited"> |
|
4909 <h3 class="name"><code>_getAttrCfg</code></h3> |
|
4910 |
|
4911 |
|
4912 <div class="args"> |
|
4913 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4914 |
|
4915 <li class="arg"> |
|
4916 |
|
4917 <code>name</code> |
|
4918 |
|
4919 </li> |
|
4920 |
|
4921 </ul><span class="paren">)</span> |
|
4922 </div> |
|
4923 |
|
4924 |
|
4925 |
|
4926 <span class="returns-inline"> |
|
4927 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4928 </span> |
|
4929 |
|
4930 |
|
4931 |
|
4932 |
|
4933 |
|
4934 <span class="flag protected">protected</span> |
|
4935 |
|
4936 |
|
4937 |
|
4938 |
|
4939 |
|
4940 |
|
4941 |
|
4942 |
|
4943 |
|
4944 |
|
4945 <div class="meta"> |
|
4946 |
|
4947 |
|
4948 <p>Inherited from |
|
4949 <a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>: |
|
4950 |
|
4951 |
|
4952 |
|
4953 <a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a> |
|
4954 |
|
4955 </p> |
|
4956 |
|
4957 |
|
4958 |
|
4959 |
|
4960 |
|
4961 </div> |
|
4962 |
|
4963 <div class="description"> |
|
4964 <p>Returns an object with the configuration properties (and value) |
|
4965 for the given attribute. If attrName is not provided, returns the |
|
4966 configuration properties for all attributes.</p> |
|
4967 </div> |
|
4968 |
|
4969 |
|
4970 <div class="params"> |
|
4971 <h4>Parameters:</h4> |
|
4972 |
|
4973 <ul class="params-list"> |
|
4974 |
|
4975 <li class="param"> |
|
4976 |
|
4977 <code class="param-name">name</code> |
|
4978 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4979 |
|
4980 |
|
4981 |
|
4982 |
|
4983 <div class="param-description"> |
|
4984 <p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p> |
|
4985 </div> |
|
4986 |
|
4987 |
|
4988 </li> |
|
4989 |
|
4990 </ul> |
|
4991 </div> |
|
4992 |
|
4993 |
|
4994 |
|
4995 <div class="returns"> |
|
4996 <h4>Returns:</h4> |
|
4997 |
|
4998 <div class="returns-description"> |
|
4999 |
|
5000 |
|
5001 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5002 |
|
5003 The configuration properties for the given attribute, or all attributes. |
|
5004 |
|
5005 </div> |
|
5006 </div> |
|
5007 |
|
5008 |
|
5009 |
|
5010 </div> |
|
5011 |
|
5012 |
|
5013 <div id="method__getAttrCfgs" class="method item protected inherited"> |
|
5014 <h3 class="name"><code>_getAttrCfgs</code></h3> |
|
5015 |
|
5016 |
|
5017 <span class="paren">()</span> |
|
5018 |
|
5019 |
|
5020 |
|
5021 <span class="returns-inline"> |
|
5022 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5023 </span> |
|
5024 |
|
5025 |
|
5026 |
|
5027 |
|
5028 |
|
5029 <span class="flag protected">protected</span> |
|
5030 |
|
5031 |
|
5032 |
|
5033 |
|
5034 |
|
5035 |
|
5036 |
|
5037 |
|
5038 |
|
5039 |
|
5040 <div class="meta"> |
|
5041 |
|
5042 |
|
5043 <p>Inherited from |
|
5044 <a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>: |
|
5045 |
|
5046 |
|
5047 |
|
5048 <a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a> |
|
5049 |
|
5050 </p> |
|
5051 |
|
5052 |
|
5053 |
|
5054 |
|
5055 |
|
5056 </div> |
|
5057 |
|
5058 <div class="description"> |
|
5059 <p>Returns an aggregated set of attribute configurations, by traversing |
|
5060 the class hierarchy.</p> |
|
5061 </div> |
|
5062 |
|
5063 |
|
5064 |
|
5065 |
|
5066 <div class="returns"> |
|
5067 <h4>Returns:</h4> |
|
5068 |
|
5069 <div class="returns-description"> |
|
5070 |
|
5071 |
|
5072 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5073 |
|
5074 The hash of attribute configurations, aggregated across classes in the hierarchy |
|
5075 This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return |
|
5076 the cached value. |
|
5077 |
|
5078 </div> |
|
5079 </div> |
|
5080 |
|
5081 |
|
5082 |
|
5083 </div> |
|
5084 |
|
5085 |
|
5086 <div id="method__getAttrInitVal" class="method item private inherited"> |
|
5087 <h3 class="name"><code>_getAttrInitVal</code></h3> |
|
5088 |
|
5089 |
|
5090 <div class="args"> |
|
5091 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5092 |
|
5093 <li class="arg"> |
|
5094 |
|
5095 <code>attr</code> |
|
5096 |
|
5097 </li> |
|
5098 |
|
5099 <li class="arg"> |
|
5100 |
|
5101 <code>cfg</code> |
|
5102 |
|
5103 </li> |
|
5104 |
|
5105 <li class="arg"> |
|
5106 |
|
5107 <code>initValues</code> |
|
5108 |
|
5109 </li> |
|
5110 |
|
5111 </ul><span class="paren">)</span> |
|
5112 </div> |
|
5113 |
|
5114 |
|
5115 |
|
5116 <span class="returns-inline"> |
|
5117 <span class="type">Any</span> |
|
5118 </span> |
|
5119 |
|
5120 |
|
5121 |
|
5122 |
|
5123 |
|
5124 <span class="flag private">private</span> |
|
5125 |
|
5126 |
|
5127 |
|
5128 |
|
5129 |
|
5130 |
|
5131 |
|
5132 |
|
5133 |
|
5134 |
|
5135 <div class="meta"> |
|
5136 |
|
5137 |
|
5138 <p>Inherited from |
|
5139 <a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>: |
|
5140 |
|
5141 |
|
5142 |
|
5143 <a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a> |
|
5144 |
|
5145 </p> |
|
5146 |
|
5147 |
|
5148 |
|
5149 |
|
5150 |
|
5151 </div> |
|
5152 |
|
5153 <div class="description"> |
|
5154 <p>Returns the initial value of the given attribute from |
|
5155 either the default configuration provided, or the |
|
5156 over-ridden value if it exists in the set of initValues |
|
5157 provided and the attribute is not read-only.</p> |
|
5158 </div> |
|
5159 |
|
5160 |
|
5161 <div class="params"> |
|
5162 <h4>Parameters:</h4> |
|
5163 |
|
5164 <ul class="params-list"> |
|
5165 |
|
5166 <li class="param"> |
|
5167 |
|
5168 <code class="param-name">attr</code> |
|
5169 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5170 |
|
5171 |
|
5172 |
|
5173 |
|
5174 <div class="param-description"> |
|
5175 <p>The name of the attribute</p> |
|
5176 </div> |
|
5177 |
|
5178 |
|
5179 </li> |
|
5180 |
|
5181 <li class="param"> |
|
5182 |
|
5183 <code class="param-name">cfg</code> |
|
5184 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5185 |
|
5186 |
|
5187 |
|
5188 |
|
5189 <div class="param-description"> |
|
5190 <p>The attribute configuration object</p> |
|
5191 </div> |
|
5192 |
|
5193 |
|
5194 </li> |
|
5195 |
|
5196 <li class="param"> |
|
5197 |
|
5198 <code class="param-name">initValues</code> |
|
5199 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5200 |
|
5201 |
|
5202 |
|
5203 |
|
5204 <div class="param-description"> |
|
5205 <p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p> |
|
5206 </div> |
|
5207 |
|
5208 |
|
5209 </li> |
|
5210 |
|
5211 </ul> |
|
5212 </div> |
|
5213 |
|
5214 |
|
5215 |
|
5216 <div class="returns"> |
|
5217 <h4>Returns:</h4> |
|
5218 |
|
5219 <div class="returns-description"> |
|
5220 |
|
5221 |
|
5222 <span class="type">Any</span>: |
|
5223 |
|
5224 The initial value of the attribute. |
|
5225 |
|
5226 </div> |
|
5227 </div> |
|
5228 |
|
5229 |
|
5230 |
|
5231 </div> |
|
5232 |
|
5233 |
|
5234 <div id="method__getAttrs" class="method item protected inherited"> |
|
5235 <h3 class="name"><code>_getAttrs</code></h3> |
|
5236 |
|
5237 |
|
5238 <div class="args"> |
|
5239 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5240 |
|
5241 <li class="arg"> |
|
5242 |
|
5243 <code>attrs</code> |
|
5244 |
|
5245 </li> |
|
5246 |
|
5247 </ul><span class="paren">)</span> |
|
5248 </div> |
|
5249 |
|
5250 |
|
5251 |
|
5252 <span class="returns-inline"> |
|
5253 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5254 </span> |
|
5255 |
|
5256 |
|
5257 |
|
5258 |
|
5259 |
|
5260 <span class="flag protected">protected</span> |
|
5261 |
|
5262 |
|
5263 |
|
5264 |
|
5265 |
|
5266 |
|
5267 |
|
5268 |
|
5269 |
|
5270 |
|
5271 <div class="meta"> |
|
5272 |
|
5273 |
|
5274 <p>Inherited from |
|
5275 <a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>: |
|
5276 |
|
5277 |
|
5278 |
|
5279 <a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a> |
|
5280 |
|
5281 </p> |
|
5282 |
|
5283 |
|
5284 |
|
5285 |
|
5286 |
|
5287 </div> |
|
5288 |
|
5289 <div class="description"> |
|
5290 <p>Implementation behind the public getAttrs method, to get multiple attribute values.</p> |
|
5291 </div> |
|
5292 |
|
5293 |
|
5294 <div class="params"> |
|
5295 <h4>Parameters:</h4> |
|
5296 |
|
5297 <ul class="params-list"> |
|
5298 |
|
5299 <li class="param"> |
|
5300 |
|
5301 <code class="param-name">attrs</code> |
|
5302 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
5303 |
|
5304 |
|
5305 |
|
5306 |
|
5307 <div class="param-description"> |
|
5308 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
5309 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
5310 </div> |
|
5311 |
|
5312 |
|
5313 </li> |
|
5314 |
|
5315 </ul> |
|
5316 </div> |
|
5317 |
|
5318 |
|
5319 |
|
5320 <div class="returns"> |
|
5321 <h4>Returns:</h4> |
|
5322 |
|
5323 <div class="returns-description"> |
|
5324 |
|
5325 |
|
5326 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5327 |
|
5328 An object with attribute name/value pairs. |
|
5329 |
|
5330 </div> |
|
5331 </div> |
|
5332 |
|
5333 |
|
5334 |
|
5335 </div> |
|
5336 |
|
5337 |
|
5338 <div id="method__getClasses" class="method item protected inherited"> |
|
5339 <h3 class="name"><code>_getClasses</code></h3> |
|
5340 |
|
5341 |
|
5342 <span class="paren">()</span> |
|
5343 |
|
5344 |
|
5345 |
|
5346 <span class="returns-inline"> |
|
5347 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span> |
|
5348 </span> |
|
5349 |
|
5350 |
|
5351 |
|
5352 |
|
5353 |
|
5354 <span class="flag protected">protected</span> |
|
5355 |
|
5356 |
|
5357 |
|
5358 |
|
5359 |
|
5360 |
|
5361 |
|
5362 |
|
5363 |
|
5364 |
|
5365 <div class="meta"> |
|
5366 |
|
5367 |
|
5368 <p>Inherited from |
|
5369 <a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>: |
|
5370 |
|
5371 |
|
5372 |
|
5373 <a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a> |
|
5374 |
|
5375 </p> |
|
5376 |
|
5377 |
|
5378 |
|
5379 |
|
5380 |
|
5381 </div> |
|
5382 |
|
5383 <div class="description"> |
|
5384 <p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p> |
|
5385 </div> |
|
5386 |
|
5387 |
|
5388 |
|
5389 |
|
5390 <div class="returns"> |
|
5391 <h4>Returns:</h4> |
|
5392 |
|
5393 <div class="returns-description"> |
|
5394 |
|
5395 |
|
5396 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>: |
|
5397 |
|
5398 An array of classes (constructor functions), making up the class hierarchy for this object. |
|
5399 This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the |
|
5400 cached value. |
|
5401 |
|
5402 </div> |
|
5403 </div> |
|
5404 |
|
5405 |
|
5406 |
|
5407 </div> |
|
5408 |
|
5409 |
|
5410 <div id="method__getFullType" class="method item private inherited"> |
|
5411 <h3 class="name"><code>_getFullType</code></h3> |
|
5412 |
|
5413 |
|
5414 <div class="args"> |
|
5415 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5416 |
|
5417 <li class="arg"> |
|
5418 |
|
5419 <code>type</code> |
|
5420 |
|
5421 </li> |
|
5422 |
|
5423 </ul><span class="paren">)</span> |
|
5424 </div> |
|
5425 |
|
5426 |
|
5427 |
|
5428 <span class="returns-inline"> |
|
5429 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5430 </span> |
|
5431 |
|
5432 |
|
5433 |
|
5434 |
|
5435 |
|
5436 <span class="flag private">private</span> |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 |
|
5442 |
|
5443 |
|
5444 |
|
5445 |
|
5446 |
|
5447 <div class="meta"> |
|
5448 |
|
5449 |
|
5450 <p>Inherited from |
|
5451 <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>: |
|
5452 |
|
5453 |
|
5454 |
|
5455 <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a> |
|
5456 |
|
5457 </p> |
|
5458 |
|
5459 |
|
5460 |
|
5461 |
|
5462 |
|
5463 </div> |
|
5464 |
|
5465 <div class="description"> |
|
5466 <p>Returns the fully qualified type, given a short type string. |
|
5467 That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p> |
|
5468 |
|
5469 <p>NOTE: This method, unlike _getType, does no checking of the value passed in, and |
|
5470 is designed to be used with the low level _publish() method, for critical path |
|
5471 implementations which need to fast-track publish for performance reasons.</p> |
|
5472 </div> |
|
5473 |
|
5474 |
|
5475 <div class="params"> |
|
5476 <h4>Parameters:</h4> |
|
5477 |
|
5478 <ul class="params-list"> |
|
5479 |
|
5480 <li class="param"> |
|
5481 |
|
5482 <code class="param-name">type</code> |
|
5483 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5484 |
|
5485 |
|
5486 |
|
5487 |
|
5488 <div class="param-description"> |
|
5489 <p>The short type to prefix</p> |
|
5490 </div> |
|
5491 |
|
5492 |
|
5493 </li> |
|
5494 |
|
5495 </ul> |
|
5496 </div> |
|
5497 |
|
5498 |
|
5499 |
|
5500 <div class="returns"> |
|
5501 <h4>Returns:</h4> |
|
5502 |
|
5503 <div class="returns-description"> |
|
5504 |
|
5505 |
|
5506 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5507 |
|
5508 The prefixed type, if a prefix is set, otherwise the type passed in |
|
5509 |
|
5510 </div> |
|
5511 </div> |
|
5512 |
|
5513 |
|
5514 |
|
5515 </div> |
|
5516 |
|
5517 |
|
5518 <div id="method__getHashPath" class="method item protected inherited"> |
|
5519 <h3 class="name"><code>_getHashPath</code></h3> |
|
5520 |
|
5521 |
|
5522 <div class="args"> |
|
5523 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5524 |
|
5525 <li class="arg"> |
|
5526 |
|
5527 <code class="optional">[hash]</code> |
|
5528 |
|
5529 </li> |
|
5530 |
|
5531 </ul><span class="paren">)</span> |
|
5532 </div> |
|
5533 |
|
5534 |
|
5535 |
|
5536 <span class="returns-inline"> |
|
5537 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5538 </span> |
|
5539 |
|
5540 |
|
5541 |
|
5542 |
|
5543 |
|
5544 <span class="flag protected">protected</span> |
|
5545 |
|
5546 |
|
5547 |
|
5548 |
|
5549 |
|
5550 |
|
5551 |
|
5552 |
|
5553 |
|
5554 |
|
5555 <div class="meta"> |
|
5556 |
|
5557 |
|
5558 <p>Inherited from |
|
5559 <a href="../classes/Router.html#method__getHashPath">Router</a>: |
|
5560 |
|
5561 |
|
5562 |
|
5563 <a href="../files/app_js_router.js.html#l697"><code>app/js/router.js:697</code></a> |
|
5564 |
|
5565 </p> |
|
5566 |
|
5567 |
|
5568 |
|
5569 |
|
5570 |
|
5571 </div> |
|
5572 |
|
5573 <div class="description"> |
|
5574 <p>Returns the resolved path from the hash fragment, or an empty string if the |
|
5575 hash is not path-like.</p> |
|
5576 </div> |
|
5577 |
|
5578 |
|
5579 <div class="params"> |
|
5580 <h4>Parameters:</h4> |
|
5581 |
|
5582 <ul class="params-list"> |
|
5583 |
|
5584 <li class="param"> |
|
5585 |
|
5586 <code class="param-name optional">[hash]</code> |
|
5587 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5588 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
5589 |
|
5590 |
|
5591 |
|
5592 |
|
5593 <div class="param-description"> |
|
5594 <p>Hash fragment to resolve into a path. By default this |
|
5595 will be the hash from the current URL.</p> |
|
5596 </div> |
|
5597 |
|
5598 |
|
5599 </li> |
|
5600 |
|
5601 </ul> |
|
5602 </div> |
|
5603 |
|
5604 |
|
5605 |
|
5606 <div class="returns"> |
|
5607 <h4>Returns:</h4> |
|
5608 |
|
5609 <div class="returns-description"> |
|
5610 |
|
5611 |
|
5612 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5613 |
|
5614 Current hash path, or an empty string if the hash is empty. |
|
5615 |
|
5616 </div> |
|
5617 </div> |
|
5618 |
|
5619 |
|
5620 |
|
5621 </div> |
|
5622 |
|
5623 |
|
5624 <div id="method__getOrigin" class="method item protected inherited"> |
|
5625 <h3 class="name"><code>_getOrigin</code></h3> |
|
5626 |
|
5627 |
|
5628 <span class="paren">()</span> |
|
5629 |
|
5630 |
|
5631 |
|
5632 <span class="returns-inline"> |
|
5633 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5634 </span> |
|
5635 |
|
5636 |
|
5637 |
|
5638 |
|
5639 |
|
5640 <span class="flag protected">protected</span> |
|
5641 |
|
5642 |
|
5643 |
|
5644 |
|
5645 |
|
5646 |
|
5647 |
|
5648 |
|
5649 |
|
5650 |
|
5651 <div class="meta"> |
|
5652 |
|
5653 |
|
5654 <p>Inherited from |
|
5655 <a href="../classes/Router.html#method__getOrigin">Router</a>: |
|
5656 |
|
5657 |
|
5658 |
|
5659 <a href="../files/app_js_router.js.html#l718"><code>app/js/router.js:718</code></a> |
|
5660 |
|
5661 </p> |
|
5662 |
|
5663 |
|
5664 |
|
5665 |
|
5666 |
|
5667 </div> |
|
5668 |
|
5669 <div class="description"> |
|
5670 <p>Gets the location origin (i.e., protocol, host, and port) as a URL.</p> |
|
5671 </div> |
|
5672 |
|
5673 |
|
5674 |
|
5675 |
|
5676 <div class="returns"> |
|
5677 <h4>Returns:</h4> |
|
5678 |
|
5679 <div class="returns-description"> |
|
5680 |
|
5681 |
|
5682 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5683 |
|
5684 Location origin (i.e., protocol, host, and port). |
|
5685 |
|
5686 </div> |
|
5687 </div> |
|
5688 |
|
5689 |
|
5690 |
|
5691 <div class="example"> |
|
5692 <h4>Example:</h4> |
|
5693 |
|
5694 <div class="example-content"> |
|
5695 <pre class="code prettyprint"><code>http://example.com |
|
5696 </code></pre> |
|
5697 </div> |
|
5698 </div> |
|
5699 |
|
5700 </div> |
|
5701 |
|
5702 |
|
5703 <div id="method__getPath" class="method item protected inherited"> |
|
5704 <h3 class="name"><code>_getPath</code></h3> |
|
5705 |
|
5706 |
|
5707 <span class="paren">()</span> |
|
5708 |
|
5709 |
|
5710 |
|
5711 <span class="returns-inline"> |
|
5712 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5713 </span> |
|
5714 |
|
5715 |
|
5716 |
|
5717 |
|
5718 |
|
5719 <span class="flag protected">protected</span> |
|
5720 |
|
5721 |
|
5722 |
|
5723 |
|
5724 |
|
5725 |
|
5726 |
|
5727 |
|
5728 |
|
5729 |
|
5730 <div class="meta"> |
|
5731 |
|
5732 |
|
5733 <p>Inherited from |
|
5734 <a href="../classes/Router.html#method__getPath">Router</a>: |
|
5735 |
|
5736 |
|
5737 |
|
5738 <a href="../files/app_js_router.js.html#l733"><code>app/js/router.js:733</code></a> |
|
5739 |
|
5740 </p> |
|
5741 |
|
5742 |
|
5743 |
|
5744 |
|
5745 |
|
5746 </div> |
|
5747 |
|
5748 <div class="description"> |
|
5749 <p>Gets the current route path, relative to the <code>root</code> (if any).</p> |
|
5750 </div> |
|
5751 |
|
5752 |
|
5753 |
|
5754 |
|
5755 <div class="returns"> |
|
5756 <h4>Returns:</h4> |
|
5757 |
|
5758 <div class="returns-description"> |
|
5759 |
|
5760 |
|
5761 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5762 |
|
5763 Current route path. |
|
5764 |
|
5765 </div> |
|
5766 </div> |
|
5767 |
|
5768 |
|
5769 |
|
5770 </div> |
|
5771 |
|
5772 |
|
5773 <div id="method__getPathRoot" class="method item protected inherited"> |
|
5774 <h3 class="name"><code>_getPathRoot</code></h3> |
|
5775 |
|
5776 |
|
5777 <span class="paren">()</span> |
|
5778 |
|
5779 |
|
5780 |
|
5781 <span class="returns-inline"> |
|
5782 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5783 </span> |
|
5784 |
|
5785 |
|
5786 |
|
5787 |
|
5788 |
|
5789 <span class="flag protected">protected</span> |
|
5790 |
|
5791 |
|
5792 |
|
5793 |
|
5794 |
|
5795 |
|
5796 |
|
5797 |
|
5798 |
|
5799 |
|
5800 <div class="meta"> |
|
5801 |
|
5802 |
|
5803 <p>Inherited from |
|
5804 <a href="../classes/Router.html#method__getPathRoot">Router</a>: |
|
5805 |
|
5806 |
|
5807 |
|
5808 <a href="../files/app_js_router.js.html#l747"><code>app/js/router.js:747</code></a> |
|
5809 |
|
5810 </p> |
|
5811 |
|
5812 |
|
5813 |
|
5814 |
|
5815 |
|
5816 <p>Available since 3.5.0</p> |
|
5817 |
|
5818 </div> |
|
5819 |
|
5820 <div class="description"> |
|
5821 <p>Returns the current path root after popping off the last path segment, |
|
5822 making it useful for resolving other URL paths against.</p> |
|
5823 |
|
5824 <p>The path root will always begin and end with a '/'.</p> |
|
5825 </div> |
|
5826 |
|
5827 |
|
5828 |
|
5829 |
|
5830 <div class="returns"> |
|
5831 <h4>Returns:</h4> |
|
5832 |
|
5833 <div class="returns-description"> |
|
5834 |
|
5835 |
|
5836 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5837 |
|
5838 The URL's path root. |
|
5839 |
|
5840 </div> |
|
5841 </div> |
|
5842 |
|
5843 |
|
5844 |
|
5845 </div> |
|
5846 |
|
5847 |
|
5848 <div id="method__getQuery" class="method item protected inherited"> |
|
5849 <h3 class="name"><code>_getQuery</code></h3> |
|
5850 |
|
5851 |
|
5852 <span class="paren">()</span> |
|
5853 |
|
5854 |
|
5855 |
|
5856 <span class="returns-inline"> |
|
5857 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5858 </span> |
|
5859 |
|
5860 |
|
5861 |
|
5862 |
|
5863 |
|
5864 <span class="flag protected">protected</span> |
|
5865 |
|
5866 |
|
5867 |
|
5868 |
|
5869 |
|
5870 |
|
5871 |
|
5872 |
|
5873 |
|
5874 |
|
5875 <div class="meta"> |
|
5876 |
|
5877 |
|
5878 <p>Inherited from |
|
5879 <a href="../classes/Router.html#method__getQuery">Router</a>: |
|
5880 |
|
5881 |
|
5882 |
|
5883 <a href="../files/app_js_router.js.html#l773"><code>app/js/router.js:773</code></a> |
|
5884 |
|
5885 </p> |
|
5886 |
|
5887 |
|
5888 |
|
5889 |
|
5890 |
|
5891 </div> |
|
5892 |
|
5893 <div class="description"> |
|
5894 <p>Gets the current route query string.</p> |
|
5895 </div> |
|
5896 |
|
5897 |
|
5898 |
|
5899 |
|
5900 <div class="returns"> |
|
5901 <h4>Returns:</h4> |
|
5902 |
|
5903 <div class="returns-description"> |
|
5904 |
|
5905 |
|
5906 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
5907 |
|
5908 Current route query string. |
|
5909 |
|
5910 </div> |
|
5911 </div> |
|
5912 |
|
5913 |
|
5914 |
|
5915 </div> |
|
5916 |
|
5917 |
|
5918 <div id="method__getRegex" class="method item protected inherited"> |
|
5919 <h3 class="name"><code>_getRegex</code></h3> |
|
5920 |
|
5921 |
|
5922 <div class="args"> |
|
5923 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5924 |
|
5925 <li class="arg"> |
|
5926 |
|
5927 <code>path</code> |
|
5928 |
|
5929 </li> |
|
5930 |
|
5931 <li class="arg"> |
|
5932 |
|
5933 <code>keys</code> |
|
5934 |
|
5935 </li> |
|
5936 |
|
5937 </ul><span class="paren">)</span> |
|
5938 </div> |
|
5939 |
|
5940 |
|
5941 |
|
5942 <span class="returns-inline"> |
|
5943 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
5944 </span> |
|
5945 |
|
5946 |
|
5947 |
|
5948 |
|
5949 |
|
5950 <span class="flag protected">protected</span> |
|
5951 |
|
5952 |
|
5953 |
|
5954 |
|
5955 |
|
5956 |
|
5957 |
|
5958 |
|
5959 |
|
5960 |
|
5961 <div class="meta"> |
|
5962 |
|
5963 |
|
5964 <p>Inherited from |
|
5965 <a href="../classes/Router.html#method__getRegex">Router</a>: |
|
5966 |
|
5967 |
|
5968 |
|
5969 <a href="../files/app_js_router.js.html#l794"><code>app/js/router.js:794</code></a> |
|
5970 |
|
5971 </p> |
|
5972 |
|
5973 |
|
5974 |
|
5975 |
|
5976 |
|
5977 </div> |
|
5978 |
|
5979 <div class="description"> |
|
5980 <p>Creates a regular expression from the given route specification. If <em>path</em> |
|
5981 is already a regex, it will be returned unmodified.</p> |
|
5982 </div> |
|
5983 |
|
5984 |
|
5985 <div class="params"> |
|
5986 <h4>Parameters:</h4> |
|
5987 |
|
5988 <ul class="params-list"> |
|
5989 |
|
5990 <li class="param"> |
|
5991 |
|
5992 <code class="param-name">path</code> |
|
5993 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
5994 |
|
5995 |
|
5996 |
|
5997 |
|
5998 <div class="param-description"> |
|
5999 <p>Route path specification.</p> |
|
6000 </div> |
|
6001 |
|
6002 |
|
6003 </li> |
|
6004 |
|
6005 <li class="param"> |
|
6006 |
|
6007 <code class="param-name">keys</code> |
|
6008 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
6009 |
|
6010 |
|
6011 |
|
6012 |
|
6013 <div class="param-description"> |
|
6014 <p>Array reference to which route parameter names will be |
|
6015 added.</p> |
|
6016 </div> |
|
6017 |
|
6018 |
|
6019 </li> |
|
6020 |
|
6021 </ul> |
|
6022 </div> |
|
6023 |
|
6024 |
|
6025 |
|
6026 <div class="returns"> |
|
6027 <h4>Returns:</h4> |
|
6028 |
|
6029 <div class="returns-description"> |
|
6030 |
|
6031 |
|
6032 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>: |
|
6033 |
|
6034 Route regex. |
|
6035 |
|
6036 </div> |
|
6037 </div> |
|
6038 |
|
6039 |
|
6040 |
|
6041 </div> |
|
6042 |
|
6043 |
|
6044 <div id="method__getRequest" class="method item protected inherited"> |
|
6045 <h3 class="name"><code>_getRequest</code></h3> |
|
6046 |
|
6047 |
|
6048 <div class="args"> |
|
6049 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6050 |
|
6051 <li class="arg"> |
|
6052 |
|
6053 <code>path</code> |
|
6054 |
|
6055 </li> |
|
6056 |
|
6057 <li class="arg"> |
|
6058 |
|
6059 <code>url</code> |
|
6060 |
|
6061 </li> |
|
6062 |
|
6063 <li class="arg"> |
|
6064 |
|
6065 <code>src</code> |
|
6066 |
|
6067 </li> |
|
6068 |
|
6069 </ul><span class="paren">)</span> |
|
6070 </div> |
|
6071 |
|
6072 |
|
6073 |
|
6074 <span class="returns-inline"> |
|
6075 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6076 </span> |
|
6077 |
|
6078 |
|
6079 |
|
6080 |
|
6081 |
|
6082 <span class="flag protected">protected</span> |
|
6083 |
|
6084 |
|
6085 |
|
6086 |
|
6087 |
|
6088 |
|
6089 |
|
6090 |
|
6091 |
|
6092 |
|
6093 <div class="meta"> |
|
6094 |
|
6095 |
|
6096 <p>Inherited from |
|
6097 <a href="../classes/Router.html#method__getRequest">Router</a>: |
|
6098 |
|
6099 |
|
6100 |
|
6101 <a href="../files/app_js_router.js.html#l829"><code>app/js/router.js:829</code></a> |
|
6102 |
|
6103 </p> |
|
6104 |
|
6105 |
|
6106 |
|
6107 |
|
6108 |
|
6109 </div> |
|
6110 |
|
6111 <div class="description"> |
|
6112 <p>Gets a request object that can be passed to a route handler.</p> |
|
6113 </div> |
|
6114 |
|
6115 |
|
6116 <div class="params"> |
|
6117 <h4>Parameters:</h4> |
|
6118 |
|
6119 <ul class="params-list"> |
|
6120 |
|
6121 <li class="param"> |
|
6122 |
|
6123 <code class="param-name">path</code> |
|
6124 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6125 |
|
6126 |
|
6127 |
|
6128 |
|
6129 <div class="param-description"> |
|
6130 <p>Current path being dispatched.</p> |
|
6131 </div> |
|
6132 |
|
6133 |
|
6134 </li> |
|
6135 |
|
6136 <li class="param"> |
|
6137 |
|
6138 <code class="param-name">url</code> |
|
6139 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6140 |
|
6141 |
|
6142 |
|
6143 |
|
6144 <div class="param-description"> |
|
6145 <p>Current full URL being dispatched.</p> |
|
6146 </div> |
|
6147 |
|
6148 |
|
6149 </li> |
|
6150 |
|
6151 <li class="param"> |
|
6152 |
|
6153 <code class="param-name">src</code> |
|
6154 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6155 |
|
6156 |
|
6157 |
|
6158 |
|
6159 <div class="param-description"> |
|
6160 <p>What initiated the dispatch.</p> |
|
6161 </div> |
|
6162 |
|
6163 |
|
6164 </li> |
|
6165 |
|
6166 </ul> |
|
6167 </div> |
|
6168 |
|
6169 |
|
6170 |
|
6171 <div class="returns"> |
|
6172 <h4>Returns:</h4> |
|
6173 |
|
6174 <div class="returns-description"> |
|
6175 |
|
6176 |
|
6177 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6178 |
|
6179 Request object. |
|
6180 |
|
6181 </div> |
|
6182 </div> |
|
6183 |
|
6184 |
|
6185 |
|
6186 </div> |
|
6187 |
|
6188 |
|
6189 <div id="method__getResponse" class="method item protected inherited"> |
|
6190 <h3 class="name"><code>_getResponse</code></h3> |
|
6191 |
|
6192 |
|
6193 <div class="args"> |
|
6194 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6195 |
|
6196 <li class="arg"> |
|
6197 |
|
6198 <code>req</code> |
|
6199 |
|
6200 </li> |
|
6201 |
|
6202 </ul><span class="paren">)</span> |
|
6203 </div> |
|
6204 |
|
6205 |
|
6206 |
|
6207 <span class="returns-inline"> |
|
6208 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6209 </span> |
|
6210 |
|
6211 |
|
6212 |
|
6213 |
|
6214 |
|
6215 <span class="flag protected">protected</span> |
|
6216 |
|
6217 |
|
6218 |
|
6219 |
|
6220 |
|
6221 |
|
6222 |
|
6223 |
|
6224 |
|
6225 |
|
6226 <div class="meta"> |
|
6227 |
|
6228 |
|
6229 <p>Inherited from |
|
6230 <a href="../classes/Router.html#method__getResponse">Router</a>: |
|
6231 |
|
6232 |
|
6233 |
|
6234 <a href="../files/app_js_router.js.html#l848"><code>app/js/router.js:848</code></a> |
|
6235 |
|
6236 </p> |
|
6237 |
|
6238 |
|
6239 |
|
6240 |
|
6241 |
|
6242 </div> |
|
6243 |
|
6244 <div class="description"> |
|
6245 <p>Gets a response object that can be passed to a route handler.</p> |
|
6246 </div> |
|
6247 |
|
6248 |
|
6249 <div class="params"> |
|
6250 <h4>Parameters:</h4> |
|
6251 |
|
6252 <ul class="params-list"> |
|
6253 |
|
6254 <li class="param"> |
|
6255 |
|
6256 <code class="param-name">req</code> |
|
6257 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6258 |
|
6259 |
|
6260 |
|
6261 |
|
6262 <div class="param-description"> |
|
6263 <p>Request object.</p> |
|
6264 </div> |
|
6265 |
|
6266 |
|
6267 </li> |
|
6268 |
|
6269 </ul> |
|
6270 </div> |
|
6271 |
|
6272 |
|
6273 |
|
6274 <div class="returns"> |
|
6275 <h4>Returns:</h4> |
|
6276 |
|
6277 <div class="returns-description"> |
|
6278 |
|
6279 |
|
6280 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6281 |
|
6282 Response Object. |
|
6283 |
|
6284 </div> |
|
6285 </div> |
|
6286 |
|
6287 |
|
6288 |
|
6289 </div> |
|
6290 |
|
6291 |
|
6292 <div id="method__getRoutes" class="method item protected inherited"> |
|
6293 <h3 class="name"><code>_getRoutes</code></h3> |
|
6294 |
|
6295 |
|
6296 <span class="paren">()</span> |
|
6297 |
|
6298 |
|
6299 |
|
6300 <span class="returns-inline"> |
|
6301 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
6302 </span> |
|
6303 |
|
6304 |
|
6305 |
|
6306 |
|
6307 |
|
6308 <span class="flag protected">protected</span> |
|
6309 |
|
6310 |
|
6311 |
|
6312 |
|
6313 |
|
6314 |
|
6315 |
|
6316 |
|
6317 |
|
6318 |
|
6319 <div class="meta"> |
|
6320 |
|
6321 |
|
6322 <p>Inherited from |
|
6323 <a href="../classes/Router.html#method__getRoutes">Router</a>: |
|
6324 |
|
6325 |
|
6326 |
|
6327 <a href="../files/app_js_router.js.html#l867"><code>app/js/router.js:867</code></a> |
|
6328 |
|
6329 </p> |
|
6330 |
|
6331 |
|
6332 |
|
6333 |
|
6334 |
|
6335 </div> |
|
6336 |
|
6337 <div class="description"> |
|
6338 <p>Getter for the <code>routes</code> attribute.</p> |
|
6339 </div> |
|
6340 |
|
6341 |
|
6342 |
|
6343 |
|
6344 <div class="returns"> |
|
6345 <h4>Returns:</h4> |
|
6346 |
|
6347 <div class="returns-description"> |
|
6348 |
|
6349 |
|
6350 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
6351 |
|
6352 Array of route objects. |
|
6353 |
|
6354 </div> |
|
6355 </div> |
|
6356 |
|
6357 |
|
6358 |
|
6359 </div> |
|
6360 |
|
6361 |
|
6362 <div id="method__getStateVal" class="method item private inherited"> |
|
6363 <h3 class="name"><code>_getStateVal</code></h3> |
|
6364 |
|
6365 |
|
6366 <div class="args"> |
|
6367 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6368 |
|
6369 <li class="arg"> |
|
6370 |
|
6371 <code>name</code> |
|
6372 |
|
6373 </li> |
|
6374 |
|
6375 <li class="arg"> |
|
6376 |
|
6377 <code class="optional">[cfg]</code> |
|
6378 |
|
6379 </li> |
|
6380 |
|
6381 </ul><span class="paren">)</span> |
|
6382 </div> |
|
6383 |
|
6384 |
|
6385 |
|
6386 <span class="returns-inline"> |
|
6387 <span class="type">Any</span> |
|
6388 </span> |
|
6389 |
|
6390 |
|
6391 |
|
6392 |
|
6393 |
|
6394 <span class="flag private">private</span> |
|
6395 |
|
6396 |
|
6397 |
|
6398 |
|
6399 |
|
6400 |
|
6401 |
|
6402 |
|
6403 |
|
6404 |
|
6405 <div class="meta"> |
|
6406 |
|
6407 |
|
6408 <p>Inherited from |
|
6409 <a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>: |
|
6410 |
|
6411 |
|
6412 |
|
6413 <a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a> |
|
6414 |
|
6415 </p> |
|
6416 |
|
6417 |
|
6418 |
|
6419 |
|
6420 |
|
6421 </div> |
|
6422 |
|
6423 <div class="description"> |
|
6424 <p>Gets the stored value for the attribute, from either the |
|
6425 internal state object, or the state proxy if it exits</p> |
|
6426 </div> |
|
6427 |
|
6428 |
|
6429 <div class="params"> |
|
6430 <h4>Parameters:</h4> |
|
6431 |
|
6432 <ul class="params-list"> |
|
6433 |
|
6434 <li class="param"> |
|
6435 |
|
6436 <code class="param-name">name</code> |
|
6437 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6438 |
|
6439 |
|
6440 |
|
6441 |
|
6442 <div class="param-description"> |
|
6443 <p>The name of the attribute</p> |
|
6444 </div> |
|
6445 |
|
6446 |
|
6447 </li> |
|
6448 |
|
6449 <li class="param"> |
|
6450 |
|
6451 <code class="param-name optional">[cfg]</code> |
|
6452 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6453 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6454 |
|
6455 |
|
6456 |
|
6457 |
|
6458 <div class="param-description"> |
|
6459 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
6460 where the calling method has already obtained the config from state.</p> |
|
6461 </div> |
|
6462 |
|
6463 |
|
6464 </li> |
|
6465 |
|
6466 </ul> |
|
6467 </div> |
|
6468 |
|
6469 |
|
6470 |
|
6471 <div class="returns"> |
|
6472 <h4>Returns:</h4> |
|
6473 |
|
6474 <div class="returns-description"> |
|
6475 |
|
6476 |
|
6477 <span class="type">Any</span>: |
|
6478 |
|
6479 The stored value of the attribute |
|
6480 |
|
6481 </div> |
|
6482 </div> |
|
6483 |
|
6484 |
|
6485 |
|
6486 </div> |
|
6487 |
|
6488 |
|
6489 <div id="method__getType" class="method item private inherited"> |
|
6490 <h3 class="name"><code>_getType</code></h3> |
|
6491 |
|
6492 |
|
6493 <span class="paren">()</span> |
|
6494 |
|
6495 |
|
6496 |
|
6497 |
|
6498 |
|
6499 |
|
6500 |
|
6501 <span class="flag private">private</span> |
|
6502 |
|
6503 |
|
6504 |
|
6505 |
|
6506 |
|
6507 |
|
6508 |
|
6509 |
|
6510 |
|
6511 |
|
6512 <div class="meta"> |
|
6513 |
|
6514 |
|
6515 <p>Inherited from |
|
6516 <a href="../classes/EventTarget.html#method__getType">EventTarget</a>: |
|
6517 |
|
6518 |
|
6519 |
|
6520 <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a> |
|
6521 |
|
6522 </p> |
|
6523 |
|
6524 |
|
6525 |
|
6526 |
|
6527 |
|
6528 </div> |
|
6529 |
|
6530 <div class="description"> |
|
6531 <p>If the instance has a prefix attribute and the |
|
6532 event type is not prefixed, the instance prefix is |
|
6533 applied to the supplied type.</p> |
|
6534 </div> |
|
6535 |
|
6536 |
|
6537 |
|
6538 |
|
6539 |
|
6540 |
|
6541 </div> |
|
6542 |
|
6543 |
|
6544 <div id="method__getURL" class="method item protected inherited"> |
|
6545 <h3 class="name"><code>_getURL</code></h3> |
|
6546 |
|
6547 |
|
6548 <span class="paren">()</span> |
|
6549 |
|
6550 |
|
6551 |
|
6552 <span class="returns-inline"> |
|
6553 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6554 </span> |
|
6555 |
|
6556 |
|
6557 |
|
6558 |
|
6559 |
|
6560 <span class="flag protected">protected</span> |
|
6561 |
|
6562 |
|
6563 |
|
6564 |
|
6565 |
|
6566 |
|
6567 |
|
6568 |
|
6569 |
|
6570 |
|
6571 <div class="meta"> |
|
6572 |
|
6573 |
|
6574 <p>Inherited from |
|
6575 <a href="../classes/Router.html#method__getURL">Router</a>: |
|
6576 |
|
6577 |
|
6578 |
|
6579 <a href="../files/app_js_router.js.html#l878"><code>app/js/router.js:878</code></a> |
|
6580 |
|
6581 </p> |
|
6582 |
|
6583 |
|
6584 |
|
6585 |
|
6586 |
|
6587 </div> |
|
6588 |
|
6589 <div class="description"> |
|
6590 <p>Gets the current full URL.</p> |
|
6591 </div> |
|
6592 |
|
6593 |
|
6594 |
|
6595 |
|
6596 <div class="returns"> |
|
6597 <h4>Returns:</h4> |
|
6598 |
|
6599 <div class="returns-description"> |
|
6600 |
|
6601 |
|
6602 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6603 |
|
6604 URL. |
|
6605 |
|
6606 </div> |
|
6607 </div> |
|
6608 |
|
6609 |
|
6610 |
|
6611 </div> |
|
6612 |
|
6613 |
|
6614 <div id="method__hasSameOrigin" class="method item protected inherited"> |
|
6615 <h3 class="name"><code>_hasSameOrigin</code></h3> |
|
6616 |
|
6617 |
|
6618 <div class="args"> |
|
6619 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6620 |
|
6621 <li class="arg"> |
|
6622 |
|
6623 <code>url</code> |
|
6624 |
|
6625 </li> |
|
6626 |
|
6627 </ul><span class="paren">)</span> |
|
6628 </div> |
|
6629 |
|
6630 |
|
6631 |
|
6632 <span class="returns-inline"> |
|
6633 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
6634 </span> |
|
6635 |
|
6636 |
|
6637 |
|
6638 |
|
6639 |
|
6640 <span class="flag protected">protected</span> |
|
6641 |
|
6642 |
|
6643 |
|
6644 |
|
6645 |
|
6646 |
|
6647 |
|
6648 |
|
6649 |
|
6650 |
|
6651 <div class="meta"> |
|
6652 |
|
6653 |
|
6654 <p>Inherited from |
|
6655 <a href="../classes/Router.html#method__hasSameOrigin">Router</a>: |
|
6656 |
|
6657 |
|
6658 |
|
6659 <a href="../files/app_js_router.js.html#l895"><code>app/js/router.js:895</code></a> |
|
6660 |
|
6661 </p> |
|
6662 |
|
6663 |
|
6664 |
|
6665 |
|
6666 |
|
6667 </div> |
|
6668 |
|
6669 <div class="description"> |
|
6670 <p>Returns <code>true</code> when the specified <code>url</code> is from the same origin as the |
|
6671 current URL; i.e., the protocol, host, and port of the URLs are the same.</p> |
|
6672 |
|
6673 <p>All host or path relative URLs are of the same origin. A scheme-relative URL |
|
6674 is first prefixed with the current scheme before being evaluated.</p> |
|
6675 </div> |
|
6676 |
|
6677 |
|
6678 <div class="params"> |
|
6679 <h4>Parameters:</h4> |
|
6680 |
|
6681 <ul class="params-list"> |
|
6682 |
|
6683 <li class="param"> |
|
6684 |
|
6685 <code class="param-name">url</code> |
|
6686 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6687 |
|
6688 |
|
6689 |
|
6690 |
|
6691 <div class="param-description"> |
|
6692 <p>URL to compare origin with the current URL.</p> |
|
6693 </div> |
|
6694 |
|
6695 |
|
6696 </li> |
|
6697 |
|
6698 </ul> |
|
6699 </div> |
|
6700 |
|
6701 |
|
6702 |
|
6703 <div class="returns"> |
|
6704 <h4>Returns:</h4> |
|
6705 |
|
6706 <div class="returns-description"> |
|
6707 |
|
6708 |
|
6709 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
6710 |
|
6711 Whether the URL has the same origin of the current URL. |
|
6712 |
|
6713 </div> |
|
6714 </div> |
|
6715 |
|
6716 |
|
6717 |
|
6718 </div> |
|
6719 |
|
6720 |
|
6721 <div id="method__initAttrHost" class="method item private inherited"> |
|
6722 <h3 class="name"><code>_initAttrHost</code></h3> |
|
6723 |
|
6724 |
|
6725 <div class="args"> |
|
6726 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6727 |
|
6728 <li class="arg"> |
|
6729 |
|
6730 <code>attrs</code> |
|
6731 |
|
6732 </li> |
|
6733 |
|
6734 <li class="arg"> |
|
6735 |
|
6736 <code>values</code> |
|
6737 |
|
6738 </li> |
|
6739 |
|
6740 <li class="arg"> |
|
6741 |
|
6742 <code>lazy</code> |
|
6743 |
|
6744 </li> |
|
6745 |
|
6746 </ul><span class="paren">)</span> |
|
6747 </div> |
|
6748 |
|
6749 |
|
6750 |
|
6751 |
|
6752 |
|
6753 |
|
6754 |
|
6755 <span class="flag private">private</span> |
|
6756 |
|
6757 |
|
6758 |
|
6759 |
|
6760 |
|
6761 |
|
6762 |
|
6763 |
|
6764 |
|
6765 |
|
6766 <div class="meta"> |
|
6767 |
|
6768 |
|
6769 <p>Inherited from |
|
6770 <a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>: |
|
6771 |
|
6772 |
|
6773 |
|
6774 <a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a> |
|
6775 |
|
6776 </p> |
|
6777 |
|
6778 |
|
6779 |
|
6780 |
|
6781 |
|
6782 </div> |
|
6783 |
|
6784 <div class="description"> |
|
6785 <p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the |
|
6786 constructor.</p> |
|
6787 </div> |
|
6788 |
|
6789 |
|
6790 <div class="params"> |
|
6791 <h4>Parameters:</h4> |
|
6792 |
|
6793 <ul class="params-list"> |
|
6794 |
|
6795 <li class="param"> |
|
6796 |
|
6797 <code class="param-name">attrs</code> |
|
6798 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6799 |
|
6800 |
|
6801 |
|
6802 |
|
6803 <div class="param-description"> |
|
6804 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
6805 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
6806 </div> |
|
6807 |
|
6808 |
|
6809 </li> |
|
6810 |
|
6811 <li class="param"> |
|
6812 |
|
6813 <code class="param-name">values</code> |
|
6814 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6815 |
|
6816 |
|
6817 |
|
6818 |
|
6819 <div class="param-description"> |
|
6820 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
6821 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
6822 </div> |
|
6823 |
|
6824 |
|
6825 </li> |
|
6826 |
|
6827 <li class="param"> |
|
6828 |
|
6829 <code class="param-name">lazy</code> |
|
6830 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
6831 |
|
6832 |
|
6833 |
|
6834 |
|
6835 <div class="param-description"> |
|
6836 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
6837 </div> |
|
6838 |
|
6839 |
|
6840 </li> |
|
6841 |
|
6842 </ul> |
|
6843 </div> |
|
6844 |
|
6845 |
|
6846 |
|
6847 |
|
6848 |
|
6849 </div> |
|
6850 |
|
6851 |
|
6852 <div id="method__initAttribute" class="method item private inherited"> |
|
6853 <h3 class="name"><code>_initAttribute</code></h3> |
|
6854 |
|
6855 |
|
6856 <span class="paren">()</span> |
|
6857 |
|
6858 |
|
6859 |
|
6860 |
|
6861 |
|
6862 |
|
6863 |
|
6864 <span class="flag private">private</span> |
|
6865 |
|
6866 |
|
6867 |
|
6868 |
|
6869 |
|
6870 |
|
6871 |
|
6872 |
|
6873 |
|
6874 |
|
6875 <div class="meta"> |
|
6876 |
|
6877 <p>Inherited from |
|
6878 <a href="../classes/BaseObservable.html#method__initAttribute"> |
|
6879 BaseObservable |
|
6880 </a> |
|
6881 |
|
6882 but overwritten in |
|
6883 |
|
6884 |
|
6885 |
|
6886 <a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a> |
|
6887 |
|
6888 </p> |
|
6889 |
|
6890 |
|
6891 |
|
6892 |
|
6893 |
|
6894 </div> |
|
6895 |
|
6896 <div class="description"> |
|
6897 <p>Initializes AttributeCore</p> |
|
6898 </div> |
|
6899 |
|
6900 |
|
6901 |
|
6902 |
|
6903 |
|
6904 |
|
6905 </div> |
|
6906 |
|
6907 |
|
6908 <div id="method__initAttrs" class="method item protected inherited"> |
|
6909 <h3 class="name"><code>_initAttrs</code></h3> |
|
6910 |
|
6911 |
|
6912 <div class="args"> |
|
6913 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6914 |
|
6915 <li class="arg"> |
|
6916 |
|
6917 <code>attrs</code> |
|
6918 |
|
6919 </li> |
|
6920 |
|
6921 <li class="arg"> |
|
6922 |
|
6923 <code>values</code> |
|
6924 |
|
6925 </li> |
|
6926 |
|
6927 <li class="arg"> |
|
6928 |
|
6929 <code>lazy</code> |
|
6930 |
|
6931 </li> |
|
6932 |
|
6933 </ul><span class="paren">)</span> |
|
6934 </div> |
|
6935 |
|
6936 |
|
6937 |
|
6938 |
|
6939 |
|
6940 |
|
6941 |
|
6942 <span class="flag protected">protected</span> |
|
6943 |
|
6944 |
|
6945 |
|
6946 |
|
6947 |
|
6948 |
|
6949 |
|
6950 |
|
6951 |
|
6952 |
|
6953 <div class="meta"> |
|
6954 |
|
6955 |
|
6956 <p>Inherited from |
|
6957 <a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>: |
|
6958 |
|
6959 |
|
6960 |
|
6961 <a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a> |
|
6962 |
|
6963 </p> |
|
6964 |
|
6965 |
|
6966 |
|
6967 |
|
6968 |
|
6969 </div> |
|
6970 |
|
6971 <div class="description"> |
|
6972 <p>Utility method to set up initial attributes defined during construction, |
|
6973 either through the constructor.ATTRS property, or explicitly passed in.</p> |
|
6974 </div> |
|
6975 |
|
6976 |
|
6977 <div class="params"> |
|
6978 <h4>Parameters:</h4> |
|
6979 |
|
6980 <ul class="params-list"> |
|
6981 |
|
6982 <li class="param"> |
|
6983 |
|
6984 <code class="param-name">attrs</code> |
|
6985 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6986 |
|
6987 |
|
6988 |
|
6989 |
|
6990 <div class="param-description"> |
|
6991 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
6992 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
6993 </div> |
|
6994 |
|
6995 |
|
6996 </li> |
|
6997 |
|
6998 <li class="param"> |
|
6999 |
|
7000 <code class="param-name">values</code> |
|
7001 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7002 |
|
7003 |
|
7004 |
|
7005 |
|
7006 <div class="param-description"> |
|
7007 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
7008 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
7009 </div> |
|
7010 |
|
7011 |
|
7012 </li> |
|
7013 |
|
7014 <li class="param"> |
|
7015 |
|
7016 <code class="param-name">lazy</code> |
|
7017 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7018 |
|
7019 |
|
7020 |
|
7021 |
|
7022 <div class="param-description"> |
|
7023 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
7024 </div> |
|
7025 |
|
7026 |
|
7027 </li> |
|
7028 |
|
7029 </ul> |
|
7030 </div> |
|
7031 |
|
7032 |
|
7033 |
|
7034 |
|
7035 |
|
7036 </div> |
|
7037 |
|
7038 |
|
7039 <div id="method__initBase" class="method item private inherited"> |
|
7040 <h3 class="name"><code>_initBase</code></h3> |
|
7041 |
|
7042 |
|
7043 <div class="args"> |
|
7044 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7045 |
|
7046 <li class="arg"> |
|
7047 |
|
7048 <code>config</code> |
|
7049 |
|
7050 </li> |
|
7051 |
|
7052 </ul><span class="paren">)</span> |
|
7053 </div> |
|
7054 |
|
7055 |
|
7056 |
|
7057 |
|
7058 |
|
7059 |
|
7060 |
|
7061 <span class="flag private">private</span> |
|
7062 |
|
7063 |
|
7064 |
|
7065 |
|
7066 |
|
7067 |
|
7068 |
|
7069 |
|
7070 |
|
7071 |
|
7072 <div class="meta"> |
|
7073 |
|
7074 |
|
7075 <p>Inherited from |
|
7076 <a href="../classes/BaseCore.html#method__initBase">BaseCore</a>: |
|
7077 |
|
7078 |
|
7079 |
|
7080 <a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a> |
|
7081 |
|
7082 </p> |
|
7083 |
|
7084 |
|
7085 |
|
7086 |
|
7087 |
|
7088 </div> |
|
7089 |
|
7090 <div class="description"> |
|
7091 <p>Internal construction logic for BaseCore.</p> |
|
7092 </div> |
|
7093 |
|
7094 |
|
7095 <div class="params"> |
|
7096 <h4>Parameters:</h4> |
|
7097 |
|
7098 <ul class="params-list"> |
|
7099 |
|
7100 <li class="param"> |
|
7101 |
|
7102 <code class="param-name">config</code> |
|
7103 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7104 |
|
7105 |
|
7106 |
|
7107 |
|
7108 <div class="param-description"> |
|
7109 <p>The constructor configuration object</p> |
|
7110 </div> |
|
7111 |
|
7112 |
|
7113 </li> |
|
7114 |
|
7115 </ul> |
|
7116 </div> |
|
7117 |
|
7118 |
|
7119 |
|
7120 |
|
7121 |
|
7122 </div> |
|
7123 |
|
7124 |
|
7125 <div id="method__initHierarchy" class="method item private inherited"> |
|
7126 <h3 class="name"><code>_initHierarchy</code></h3> |
|
7127 |
|
7128 |
|
7129 <div class="args"> |
|
7130 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7131 |
|
7132 <li class="arg"> |
|
7133 |
|
7134 <code>userVals</code> |
|
7135 |
|
7136 </li> |
|
7137 |
|
7138 </ul><span class="paren">)</span> |
|
7139 </div> |
|
7140 |
|
7141 |
|
7142 |
|
7143 |
|
7144 |
|
7145 |
|
7146 |
|
7147 <span class="flag private">private</span> |
|
7148 |
|
7149 |
|
7150 |
|
7151 |
|
7152 |
|
7153 |
|
7154 |
|
7155 |
|
7156 |
|
7157 |
|
7158 <div class="meta"> |
|
7159 |
|
7160 |
|
7161 <p>Inherited from |
|
7162 <a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>: |
|
7163 |
|
7164 |
|
7165 |
|
7166 <a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a> |
|
7167 |
|
7168 </p> |
|
7169 |
|
7170 |
|
7171 |
|
7172 |
|
7173 |
|
7174 </div> |
|
7175 |
|
7176 <div class="description"> |
|
7177 <p>Initializes the class hierarchy for the instance, which includes |
|
7178 initializing attributes for each class defined in the class's |
|
7179 static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and |
|
7180 invoking the initializer method on the prototype of each class in the hierarchy.</p> |
|
7181 </div> |
|
7182 |
|
7183 |
|
7184 <div class="params"> |
|
7185 <h4>Parameters:</h4> |
|
7186 |
|
7187 <ul class="params-list"> |
|
7188 |
|
7189 <li class="param"> |
|
7190 |
|
7191 <code class="param-name">userVals</code> |
|
7192 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7193 |
|
7194 |
|
7195 |
|
7196 |
|
7197 <div class="param-description"> |
|
7198 <p>Object with configuration property name/value pairs</p> |
|
7199 </div> |
|
7200 |
|
7201 |
|
7202 </li> |
|
7203 |
|
7204 </ul> |
|
7205 </div> |
|
7206 |
|
7207 |
|
7208 |
|
7209 |
|
7210 |
|
7211 </div> |
|
7212 |
|
7213 |
|
7214 <div id="method__initHierarchyData" class="method item private inherited"> |
|
7215 <h3 class="name"><code>_initHierarchyData</code></h3> |
|
7216 |
|
7217 |
|
7218 <span class="paren">()</span> |
|
7219 |
|
7220 |
|
7221 |
|
7222 |
|
7223 |
|
7224 |
|
7225 |
|
7226 <span class="flag private">private</span> |
|
7227 |
|
7228 |
|
7229 |
|
7230 |
|
7231 |
|
7232 |
|
7233 |
|
7234 |
|
7235 |
|
7236 |
|
7237 <div class="meta"> |
|
7238 |
|
7239 |
|
7240 <p>Inherited from |
|
7241 <a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>: |
|
7242 |
|
7243 |
|
7244 |
|
7245 <a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a> |
|
7246 |
|
7247 </p> |
|
7248 |
|
7249 |
|
7250 |
|
7251 |
|
7252 |
|
7253 </div> |
|
7254 |
|
7255 <div class="description"> |
|
7256 <p>A helper method used by _getClasses and _getAttrCfgs, which determines both |
|
7257 the array of classes and aggregate set of attribute configurations |
|
7258 across the class hierarchy for the instance.</p> |
|
7259 </div> |
|
7260 |
|
7261 |
|
7262 |
|
7263 |
|
7264 |
|
7265 |
|
7266 </div> |
|
7267 |
|
7268 |
|
7269 <div id="method__isLazyAttr" class="method item private inherited"> |
|
7270 <h3 class="name"><code>_isLazyAttr</code></h3> |
|
7271 |
|
7272 |
|
7273 <div class="args"> |
|
7274 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7275 |
|
7276 <li class="arg"> |
|
7277 |
|
7278 <code>name</code> |
|
7279 |
|
7280 </li> |
|
7281 |
|
7282 </ul><span class="paren">)</span> |
|
7283 </div> |
|
7284 |
|
7285 |
|
7286 |
|
7287 <span class="returns-inline"> |
|
7288 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7289 </span> |
|
7290 |
|
7291 |
|
7292 |
|
7293 |
|
7294 |
|
7295 <span class="flag private">private</span> |
|
7296 |
|
7297 |
|
7298 |
|
7299 |
|
7300 |
|
7301 |
|
7302 |
|
7303 |
|
7304 |
|
7305 |
|
7306 <div class="meta"> |
|
7307 |
|
7308 |
|
7309 <p>Inherited from |
|
7310 <a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>: |
|
7311 |
|
7312 |
|
7313 |
|
7314 <a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a> |
|
7315 |
|
7316 </p> |
|
7317 |
|
7318 |
|
7319 |
|
7320 |
|
7321 |
|
7322 </div> |
|
7323 |
|
7324 <div class="description"> |
|
7325 <p>Checks whether or not the attribute is one which has been |
|
7326 added lazily and still requires initialization.</p> |
|
7327 </div> |
|
7328 |
|
7329 |
|
7330 <div class="params"> |
|
7331 <h4>Parameters:</h4> |
|
7332 |
|
7333 <ul class="params-list"> |
|
7334 |
|
7335 <li class="param"> |
|
7336 |
|
7337 <code class="param-name">name</code> |
|
7338 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7339 |
|
7340 |
|
7341 |
|
7342 |
|
7343 <div class="param-description"> |
|
7344 <p>The name of the attribute</p> |
|
7345 </div> |
|
7346 |
|
7347 |
|
7348 </li> |
|
7349 |
|
7350 </ul> |
|
7351 </div> |
|
7352 |
|
7353 |
|
7354 |
|
7355 <div class="returns"> |
|
7356 <h4>Returns:</h4> |
|
7357 |
|
7358 <div class="returns-description"> |
|
7359 |
|
7360 |
|
7361 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7362 |
|
7363 true if it's a lazily added attribute, false otherwise. |
|
7364 |
|
7365 </div> |
|
7366 </div> |
|
7367 |
|
7368 |
|
7369 |
|
7370 </div> |
|
7371 |
|
7372 |
|
7373 <div id="method__isLinkSameOrigin" class="method item protected inherited"> |
|
7374 <h3 class="name"><code>_isLinkSameOrigin</code></h3> |
|
7375 |
|
7376 |
|
7377 <div class="args"> |
|
7378 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7379 |
|
7380 <li class="arg"> |
|
7381 |
|
7382 <code>link</code> |
|
7383 |
|
7384 </li> |
|
7385 |
|
7386 </ul><span class="paren">)</span> |
|
7387 </div> |
|
7388 |
|
7389 |
|
7390 |
|
7391 <span class="returns-inline"> |
|
7392 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7393 </span> |
|
7394 |
|
7395 |
|
7396 |
|
7397 |
|
7398 |
|
7399 <span class="flag protected">protected</span> |
|
7400 |
|
7401 |
|
7402 |
|
7403 |
|
7404 |
|
7405 |
|
7406 |
|
7407 |
|
7408 |
|
7409 |
|
7410 <div class="meta"> |
|
7411 |
|
7412 |
|
7413 <p>Inherited from |
|
7414 <a href="../classes/PjaxBase.html#method__isLinkSameOrigin">PjaxBase</a>: |
|
7415 |
|
7416 |
|
7417 |
|
7418 <a href="../files/pjax_js_pjax-base.js.html#l161"><code>pjax/js/pjax-base.js:161</code></a> |
|
7419 |
|
7420 </p> |
|
7421 |
|
7422 |
|
7423 |
|
7424 |
|
7425 |
|
7426 <p>Available since 3.6.0</p> |
|
7427 |
|
7428 </div> |
|
7429 |
|
7430 <div class="description"> |
|
7431 <p>Utility method to test whether a specified link/anchor node's <code>href</code> is of |
|
7432 the same origin as the page's current location.</p> |
|
7433 |
|
7434 <p>This normalize browser inconsistencies with how the <code>port</code> is reported for |
|
7435 anchor elements (IE reports a value for the default port, e.g. "80").</p> |
|
7436 </div> |
|
7437 |
|
7438 |
|
7439 <div class="params"> |
|
7440 <h4>Parameters:</h4> |
|
7441 |
|
7442 <ul class="params-list"> |
|
7443 |
|
7444 <li class="param"> |
|
7445 |
|
7446 <code class="param-name">link</code> |
|
7447 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7448 |
|
7449 |
|
7450 |
|
7451 |
|
7452 <div class="param-description"> |
|
7453 <p>The anchor element to test whether its <code>href</code> is of the |
|
7454 same origin as the page's current location.</p> |
|
7455 </div> |
|
7456 |
|
7457 |
|
7458 </li> |
|
7459 |
|
7460 </ul> |
|
7461 </div> |
|
7462 |
|
7463 |
|
7464 |
|
7465 <div class="returns"> |
|
7466 <h4>Returns:</h4> |
|
7467 |
|
7468 <div class="returns-description"> |
|
7469 |
|
7470 |
|
7471 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7472 |
|
7473 Whether or not the link's <code>href</code> is of the same origin as |
|
7474 the page's current location. |
|
7475 |
|
7476 </div> |
|
7477 </div> |
|
7478 |
|
7479 |
|
7480 |
|
7481 </div> |
|
7482 |
|
7483 |
|
7484 <div id="method__joinURL" class="method item protected inherited"> |
|
7485 <h3 class="name"><code>_joinURL</code></h3> |
|
7486 |
|
7487 |
|
7488 <div class="args"> |
|
7489 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7490 |
|
7491 <li class="arg"> |
|
7492 |
|
7493 <code>url</code> |
|
7494 |
|
7495 </li> |
|
7496 |
|
7497 </ul><span class="paren">)</span> |
|
7498 </div> |
|
7499 |
|
7500 |
|
7501 |
|
7502 <span class="returns-inline"> |
|
7503 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7504 </span> |
|
7505 |
|
7506 |
|
7507 |
|
7508 |
|
7509 |
|
7510 <span class="flag protected">protected</span> |
|
7511 |
|
7512 |
|
7513 |
|
7514 |
|
7515 |
|
7516 |
|
7517 |
|
7518 |
|
7519 |
|
7520 |
|
7521 <div class="meta"> |
|
7522 |
|
7523 |
|
7524 <p>Inherited from |
|
7525 <a href="../classes/Router.html#method__joinURL">Router</a>: |
|
7526 |
|
7527 |
|
7528 |
|
7529 <a href="../files/app_js_router.js.html#l918"><code>app/js/router.js:918</code></a> |
|
7530 |
|
7531 </p> |
|
7532 |
|
7533 |
|
7534 |
|
7535 |
|
7536 |
|
7537 </div> |
|
7538 |
|
7539 <div class="description"> |
|
7540 <p>Joins the <code>root</code> URL to the specified <em>url</em>, normalizing leading/trailing |
|
7541 <code>/</code> characters.</p> |
|
7542 </div> |
|
7543 |
|
7544 |
|
7545 <div class="params"> |
|
7546 <h4>Parameters:</h4> |
|
7547 |
|
7548 <ul class="params-list"> |
|
7549 |
|
7550 <li class="param"> |
|
7551 |
|
7552 <code class="param-name">url</code> |
|
7553 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7554 |
|
7555 |
|
7556 |
|
7557 |
|
7558 <div class="param-description"> |
|
7559 <p>URL to append to the <code>root</code> URL.</p> |
|
7560 </div> |
|
7561 |
|
7562 |
|
7563 </li> |
|
7564 |
|
7565 </ul> |
|
7566 </div> |
|
7567 |
|
7568 |
|
7569 |
|
7570 <div class="returns"> |
|
7571 <h4>Returns:</h4> |
|
7572 |
|
7573 <div class="returns-description"> |
|
7574 |
|
7575 |
|
7576 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
7577 |
|
7578 Joined URL. |
|
7579 |
|
7580 </div> |
|
7581 </div> |
|
7582 |
|
7583 |
|
7584 |
|
7585 <div class="example"> |
|
7586 <h4>Example:</h4> |
|
7587 |
|
7588 <div class="example-content"> |
|
7589 <pre class="code prettyprint"><code>router.set('root', '/foo'); |
|
7590 router._joinURL('bar'); // => '/foo/bar' |
|
7591 router._joinURL('/bar'); // => '/foo/bar' |
|
7592 |
|
7593 router.set('root', '/foo/'); |
|
7594 router._joinURL('bar'); // => '/foo/bar' |
|
7595 router._joinURL('/bar'); // => '/foo/bar' |
|
7596 </code></pre> |
|
7597 </div> |
|
7598 </div> |
|
7599 |
|
7600 </div> |
|
7601 |
|
7602 |
|
7603 <div id="method__monitor" class="method item private inherited"> |
|
7604 <h3 class="name"><code>_monitor</code></h3> |
|
7605 |
|
7606 |
|
7607 <div class="args"> |
|
7608 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7609 |
|
7610 <li class="arg"> |
|
7611 |
|
7612 <code>what</code> |
|
7613 |
|
7614 </li> |
|
7615 |
|
7616 <li class="arg"> |
|
7617 |
|
7618 <code>eventType</code> |
|
7619 |
|
7620 </li> |
|
7621 |
|
7622 <li class="arg"> |
|
7623 |
|
7624 <code>o</code> |
|
7625 |
|
7626 </li> |
|
7627 |
|
7628 </ul><span class="paren">)</span> |
|
7629 </div> |
|
7630 |
|
7631 |
|
7632 |
|
7633 |
|
7634 |
|
7635 |
|
7636 |
|
7637 <span class="flag private">private</span> |
|
7638 |
|
7639 |
|
7640 |
|
7641 |
|
7642 |
|
7643 |
|
7644 |
|
7645 |
|
7646 |
|
7647 |
|
7648 <div class="meta"> |
|
7649 |
|
7650 |
|
7651 <p>Inherited from |
|
7652 <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>: |
|
7653 |
|
7654 |
|
7655 |
|
7656 <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a> |
|
7657 |
|
7658 </p> |
|
7659 |
|
7660 |
|
7661 |
|
7662 |
|
7663 |
|
7664 </div> |
|
7665 |
|
7666 <div class="description"> |
|
7667 <p>This is the entry point for the event monitoring system. |
|
7668 You can monitor 'attach', 'detach', 'fire', and 'publish'. |
|
7669 When configured, these events generate an event. click -> |
|
7670 click<em>attach, click</em>detach, click_publish -- these can |
|
7671 be subscribed to like other events to monitor the event |
|
7672 system. Inividual published events can have monitoring |
|
7673 turned on or off (publish can't be turned off before it |
|
7674 it published) by setting the events 'monitor' config.</p> |
|
7675 </div> |
|
7676 |
|
7677 |
|
7678 <div class="params"> |
|
7679 <h4>Parameters:</h4> |
|
7680 |
|
7681 <ul class="params-list"> |
|
7682 |
|
7683 <li class="param"> |
|
7684 |
|
7685 <code class="param-name">what</code> |
|
7686 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7687 |
|
7688 |
|
7689 |
|
7690 |
|
7691 <div class="param-description"> |
|
7692 <p>'attach', 'detach', 'fire', or 'publish'</p> |
|
7693 </div> |
|
7694 |
|
7695 |
|
7696 </li> |
|
7697 |
|
7698 <li class="param"> |
|
7699 |
|
7700 <code class="param-name">eventType</code> |
|
7701 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
7702 |
|
7703 |
|
7704 |
|
7705 |
|
7706 <div class="param-description"> |
|
7707 <p>The prefixed name of the event being monitored, or the CustomEvent object.</p> |
|
7708 </div> |
|
7709 |
|
7710 |
|
7711 </li> |
|
7712 |
|
7713 <li class="param"> |
|
7714 |
|
7715 <code class="param-name">o</code> |
|
7716 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7717 |
|
7718 |
|
7719 |
|
7720 |
|
7721 <div class="param-description"> |
|
7722 <p>Information about the event interaction, such as |
|
7723 fire() args, subscription category, publish config</p> |
|
7724 </div> |
|
7725 |
|
7726 |
|
7727 </li> |
|
7728 |
|
7729 </ul> |
|
7730 </div> |
|
7731 |
|
7732 |
|
7733 |
|
7734 |
|
7735 |
|
7736 </div> |
|
7737 |
|
7738 |
|
7739 <div id="method__navigate" class="method item protected inherited"> |
|
7740 <h3 class="name"><code>_navigate</code></h3> |
|
7741 |
|
7742 |
|
7743 <div class="args"> |
|
7744 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7745 |
|
7746 <li class="arg"> |
|
7747 |
|
7748 <code>url</code> |
|
7749 |
|
7750 </li> |
|
7751 |
|
7752 <li class="arg"> |
|
7753 |
|
7754 <code class="optional">[options]</code> |
|
7755 |
|
7756 </li> |
|
7757 |
|
7758 </ul><span class="paren">)</span> |
|
7759 </div> |
|
7760 |
|
7761 |
|
7762 |
|
7763 <span class="returns-inline"> |
|
7764 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7765 </span> |
|
7766 |
|
7767 |
|
7768 |
|
7769 |
|
7770 |
|
7771 <span class="flag protected">protected</span> |
|
7772 |
|
7773 |
|
7774 |
|
7775 |
|
7776 |
|
7777 |
|
7778 |
|
7779 |
|
7780 |
|
7781 |
|
7782 <div class="meta"> |
|
7783 |
|
7784 |
|
7785 <p>Inherited from |
|
7786 <a href="../classes/PjaxBase.html#method__navigate">PjaxBase</a>: |
|
7787 |
|
7788 |
|
7789 |
|
7790 <a href="../files/pjax_js_pjax-base.js.html#l210"><code>pjax/js/pjax-base.js:210</code></a> |
|
7791 |
|
7792 </p> |
|
7793 |
|
7794 |
|
7795 |
|
7796 |
|
7797 |
|
7798 <p>Available since 3.5.0</p> |
|
7799 |
|
7800 </div> |
|
7801 |
|
7802 <div class="description"> |
|
7803 <p>Underlying implementation for <code>navigate()</code>.</p> |
|
7804 </div> |
|
7805 |
|
7806 |
|
7807 <div class="params"> |
|
7808 <h4>Parameters:</h4> |
|
7809 |
|
7810 <ul class="params-list"> |
|
7811 |
|
7812 <li class="param"> |
|
7813 |
|
7814 <code class="param-name">url</code> |
|
7815 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7816 |
|
7817 |
|
7818 |
|
7819 |
|
7820 <div class="param-description"> |
|
7821 <p>The fully-resolved URL that the router should dispatch |
|
7822 to its route handlers to fulfill the enhanced navigation "request", or use |
|
7823 to update <code>window.location</code> in non-HTML5 history capable browsers.</p> |
|
7824 </div> |
|
7825 |
|
7826 |
|
7827 </li> |
|
7828 |
|
7829 <li class="param"> |
|
7830 |
|
7831 <code class="param-name optional">[options]</code> |
|
7832 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7833 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7834 |
|
7835 |
|
7836 |
|
7837 |
|
7838 <div class="param-description"> |
|
7839 <p>Additional options to configure the navigation. |
|
7840 These are mixed into the <code>navigate</code> event facade.</p> |
|
7841 </div> |
|
7842 |
|
7843 |
|
7844 <ul class="params-list"> |
|
7845 |
|
7846 <li class="param"> |
|
7847 |
|
7848 <code class="param-name optional">[replace]</code> |
|
7849 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7850 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7851 |
|
7852 |
|
7853 <div class="param-description"> |
|
7854 <p>Whether or not the current history |
|
7855 entry will be replaced, or a new entry will be created. Will default |
|
7856 to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p> |
|
7857 </div> |
|
7858 |
|
7859 |
|
7860 </li> |
|
7861 |
|
7862 <li class="param"> |
|
7863 |
|
7864 <code class="param-name optional">[force=false]</code> |
|
7865 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7866 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7867 |
|
7868 |
|
7869 <div class="param-description"> |
|
7870 <p>Whether the enhanced navigation |
|
7871 should occur even in browsers without HTML5 history.</p> |
|
7872 </div> |
|
7873 |
|
7874 |
|
7875 </li> |
|
7876 |
|
7877 </ul> |
|
7878 |
|
7879 </li> |
|
7880 |
|
7881 </ul> |
|
7882 </div> |
|
7883 |
|
7884 |
|
7885 |
|
7886 <div class="returns"> |
|
7887 <h4>Returns:</h4> |
|
7888 |
|
7889 <div class="returns-description"> |
|
7890 |
|
7891 |
|
7892 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7893 |
|
7894 <code>true</code> if the URL was navigated to, <code>false</code> otherwise. |
|
7895 |
|
7896 </div> |
|
7897 </div> |
|
7898 |
|
7899 |
|
7900 |
|
7901 </div> |
|
7902 |
|
7903 |
|
7904 <div id="method__normalizePath" class="method item protected inherited"> |
|
7905 <h3 class="name"><code>_normalizePath</code></h3> |
|
7906 |
|
7907 |
|
7908 <div class="args"> |
|
7909 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7910 |
|
7911 <li class="arg"> |
|
7912 |
|
7913 <code>path</code> |
|
7914 |
|
7915 </li> |
|
7916 |
|
7917 </ul><span class="paren">)</span> |
|
7918 </div> |
|
7919 |
|
7920 |
|
7921 |
|
7922 <span class="returns-inline"> |
|
7923 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7924 </span> |
|
7925 |
|
7926 |
|
7927 |
|
7928 |
|
7929 |
|
7930 <span class="flag protected">protected</span> |
|
7931 |
|
7932 |
|
7933 |
|
7934 |
|
7935 |
|
7936 |
|
7937 |
|
7938 |
|
7939 |
|
7940 |
|
7941 <div class="meta"> |
|
7942 |
|
7943 |
|
7944 <p>Inherited from |
|
7945 <a href="../classes/Router.html#method__normalizePath">Router</a>: |
|
7946 |
|
7947 |
|
7948 |
|
7949 <a href="../files/app_js_router.js.html#l951"><code>app/js/router.js:951</code></a> |
|
7950 |
|
7951 </p> |
|
7952 |
|
7953 |
|
7954 |
|
7955 |
|
7956 |
|
7957 <p>Available since 3.5.0</p> |
|
7958 |
|
7959 </div> |
|
7960 |
|
7961 <div class="description"> |
|
7962 <p>Returns a normalized path, ridding it of any '..' segments and properly |
|
7963 handling leading and trailing slashes.</p> |
|
7964 </div> |
|
7965 |
|
7966 |
|
7967 <div class="params"> |
|
7968 <h4>Parameters:</h4> |
|
7969 |
|
7970 <ul class="params-list"> |
|
7971 |
|
7972 <li class="param"> |
|
7973 |
|
7974 <code class="param-name">path</code> |
|
7975 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7976 |
|
7977 |
|
7978 |
|
7979 |
|
7980 <div class="param-description"> |
|
7981 <p>URL path to normalize.</p> |
|
7982 </div> |
|
7983 |
|
7984 |
|
7985 </li> |
|
7986 |
|
7987 </ul> |
|
7988 </div> |
|
7989 |
|
7990 |
|
7991 |
|
7992 <div class="returns"> |
|
7993 <h4>Returns:</h4> |
|
7994 |
|
7995 <div class="returns-description"> |
|
7996 |
|
7997 |
|
7998 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
7999 |
|
8000 Normalized path. |
|
8001 |
|
8002 </div> |
|
8003 </div> |
|
8004 |
|
8005 |
|
8006 |
|
8007 </div> |
|
8008 |
|
8009 |
|
8010 <div id="method__normAttrVals" class="method item private inherited"> |
|
8011 <h3 class="name"><code>_normAttrVals</code></h3> |
|
8012 |
|
8013 |
|
8014 <div class="args"> |
|
8015 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8016 |
|
8017 <li class="arg"> |
|
8018 |
|
8019 <code>valueHash</code> |
|
8020 |
|
8021 </li> |
|
8022 |
|
8023 </ul><span class="paren">)</span> |
|
8024 </div> |
|
8025 |
|
8026 |
|
8027 |
|
8028 <span class="returns-inline"> |
|
8029 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8030 </span> |
|
8031 |
|
8032 |
|
8033 |
|
8034 |
|
8035 |
|
8036 <span class="flag private">private</span> |
|
8037 |
|
8038 |
|
8039 |
|
8040 |
|
8041 |
|
8042 |
|
8043 |
|
8044 |
|
8045 |
|
8046 |
|
8047 <div class="meta"> |
|
8048 |
|
8049 |
|
8050 <p>Inherited from |
|
8051 <a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>: |
|
8052 |
|
8053 |
|
8054 |
|
8055 <a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a> |
|
8056 |
|
8057 </p> |
|
8058 |
|
8059 |
|
8060 |
|
8061 |
|
8062 |
|
8063 </div> |
|
8064 |
|
8065 <div class="description"> |
|
8066 <p>Utility method to normalize attribute values. The base implementation |
|
8067 simply merges the hash to protect the original.</p> |
|
8068 </div> |
|
8069 |
|
8070 |
|
8071 <div class="params"> |
|
8072 <h4>Parameters:</h4> |
|
8073 |
|
8074 <ul class="params-list"> |
|
8075 |
|
8076 <li class="param"> |
|
8077 |
|
8078 <code class="param-name">valueHash</code> |
|
8079 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8080 |
|
8081 |
|
8082 |
|
8083 |
|
8084 <div class="param-description"> |
|
8085 <p>An object with attribute name/value pairs</p> |
|
8086 </div> |
|
8087 |
|
8088 |
|
8089 </li> |
|
8090 |
|
8091 </ul> |
|
8092 </div> |
|
8093 |
|
8094 |
|
8095 |
|
8096 <div class="returns"> |
|
8097 <h4>Returns:</h4> |
|
8098 |
|
8099 <div class="returns-description"> |
|
8100 |
|
8101 |
|
8102 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
8103 |
|
8104 An object literal with 2 properties - "simple" and "complex", |
|
8105 containing simple and complex attribute values respectively keyed |
|
8106 by the top level attribute name, or null, if valueHash is falsey. |
|
8107 |
|
8108 </div> |
|
8109 </div> |
|
8110 |
|
8111 |
|
8112 |
|
8113 </div> |
|
8114 |
|
8115 |
|
8116 <div id="method__onLinkClick" class="method item protected inherited"> |
|
8117 <h3 class="name"><code>_onLinkClick</code></h3> |
|
8118 |
|
8119 |
|
8120 <div class="args"> |
|
8121 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8122 |
|
8123 <li class="arg"> |
|
8124 |
|
8125 <code>e</code> |
|
8126 |
|
8127 </li> |
|
8128 |
|
8129 </ul><span class="paren">)</span> |
|
8130 </div> |
|
8131 |
|
8132 |
|
8133 |
|
8134 |
|
8135 |
|
8136 |
|
8137 |
|
8138 <span class="flag protected">protected</span> |
|
8139 |
|
8140 |
|
8141 |
|
8142 |
|
8143 |
|
8144 |
|
8145 |
|
8146 |
|
8147 |
|
8148 |
|
8149 <div class="meta"> |
|
8150 |
|
8151 |
|
8152 <p>Inherited from |
|
8153 <a href="../classes/PjaxBase.html#method__onLinkClick">PjaxBase</a>: |
|
8154 |
|
8155 |
|
8156 |
|
8157 <a href="../files/pjax_js_pjax-base.js.html#l325"><code>pjax/js/pjax-base.js:325</code></a> |
|
8158 |
|
8159 </p> |
|
8160 |
|
8161 |
|
8162 |
|
8163 |
|
8164 |
|
8165 <p>Available since 3.5.0</p> |
|
8166 |
|
8167 </div> |
|
8168 |
|
8169 <div class="description"> |
|
8170 <p>Handler for delegated link-click events which match the <code>linkSelector</code>.</p> |
|
8171 |
|
8172 <p>This will attempt to enhance the navigation to the link element's <code>href</code> by |
|
8173 passing the URL to the <code>_navigate()</code> method. When the navigation is being |
|
8174 enhanced, the default action is prevented.</p> |
|
8175 |
|
8176 <p>If the user clicks a link with the middle/right mouse buttons, or is holding |
|
8177 down the Ctrl or Command keys, this method's behavior is not applied and |
|
8178 allows the native behavior to occur. Similarly, if the router is not capable |
|
8179 or handling the URL because no route-handlers match, the link click will |
|
8180 behave natively.</p> |
|
8181 </div> |
|
8182 |
|
8183 |
|
8184 <div class="params"> |
|
8185 <h4>Parameters:</h4> |
|
8186 |
|
8187 <ul class="params-list"> |
|
8188 |
|
8189 <li class="param"> |
|
8190 |
|
8191 <code class="param-name">e</code> |
|
8192 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
8193 |
|
8194 |
|
8195 |
|
8196 |
|
8197 <div class="param-description"> |
|
8198 |
|
8199 </div> |
|
8200 |
|
8201 |
|
8202 </li> |
|
8203 |
|
8204 </ul> |
|
8205 </div> |
|
8206 |
|
8207 |
|
8208 |
|
8209 |
|
8210 |
|
8211 </div> |
|
8212 |
|
8213 |
|
8214 <div id="method__onPjaxIOComplete" class="method item protected inherited"> |
|
8215 <h3 class="name"><code>_onPjaxIOComplete</code></h3> |
|
8216 |
|
8217 |
|
8218 <div class="args"> |
|
8219 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8220 |
|
8221 <li class="arg"> |
|
8222 |
|
8223 <code>id</code> |
|
8224 |
|
8225 </li> |
|
8226 |
|
8227 <li class="arg"> |
|
8228 |
|
8229 <code>ioResponse</code> |
|
8230 |
|
8231 </li> |
|
8232 |
|
8233 <li class="arg"> |
|
8234 |
|
8235 <code>details</code> |
|
8236 |
|
8237 </li> |
|
8238 |
|
8239 </ul><span class="paren">)</span> |
|
8240 </div> |
|
8241 |
|
8242 |
|
8243 |
|
8244 |
|
8245 |
|
8246 |
|
8247 |
|
8248 <span class="flag protected">protected</span> |
|
8249 |
|
8250 |
|
8251 |
|
8252 |
|
8253 |
|
8254 |
|
8255 |
|
8256 |
|
8257 |
|
8258 |
|
8259 <div class="meta"> |
|
8260 |
|
8261 |
|
8262 <p>Inherited from |
|
8263 <a href="../classes/PjaxContent.html#method__onPjaxIOComplete">PjaxContent</a>: |
|
8264 |
|
8265 |
|
8266 |
|
8267 <a href="../files/pjax_js_pjax-content.js.html#l159"><code>pjax/js/pjax-content.js:159</code></a> |
|
8268 |
|
8269 </p> |
|
8270 |
|
8271 |
|
8272 |
|
8273 |
|
8274 |
|
8275 <p>Available since 3.7.0</p> |
|
8276 |
|
8277 </div> |
|
8278 |
|
8279 <div class="description"> |
|
8280 <p>Handles IO complete events.</p> |
|
8281 |
|
8282 <p>This parses the content from the <code>Y.io()</code> response and puts it on the |
|
8283 route's response object.</p> |
|
8284 </div> |
|
8285 |
|
8286 |
|
8287 <div class="params"> |
|
8288 <h4>Parameters:</h4> |
|
8289 |
|
8290 <ul class="params-list"> |
|
8291 |
|
8292 <li class="param"> |
|
8293 |
|
8294 <code class="param-name">id</code> |
|
8295 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8296 |
|
8297 |
|
8298 |
|
8299 |
|
8300 <div class="param-description"> |
|
8301 <p>The <code>Y.io</code> transaction id.</p> |
|
8302 </div> |
|
8303 |
|
8304 |
|
8305 </li> |
|
8306 |
|
8307 <li class="param"> |
|
8308 |
|
8309 <code class="param-name">ioResponse</code> |
|
8310 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8311 |
|
8312 |
|
8313 |
|
8314 |
|
8315 <div class="param-description"> |
|
8316 <p>The <code>Y.io</code> response object.</p> |
|
8317 </div> |
|
8318 |
|
8319 |
|
8320 </li> |
|
8321 |
|
8322 <li class="param"> |
|
8323 |
|
8324 <code class="param-name">details</code> |
|
8325 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8326 |
|
8327 |
|
8328 |
|
8329 |
|
8330 <div class="param-description"> |
|
8331 <p>Extra details carried through from <code>loadContent()</code>.</p> |
|
8332 </div> |
|
8333 |
|
8334 |
|
8335 </li> |
|
8336 |
|
8337 </ul> |
|
8338 </div> |
|
8339 |
|
8340 |
|
8341 |
|
8342 |
|
8343 |
|
8344 </div> |
|
8345 |
|
8346 |
|
8347 <div id="method__onPjaxIOEnd" class="method item protected inherited"> |
|
8348 <h3 class="name"><code>_onPjaxIOEnd</code></h3> |
|
8349 |
|
8350 |
|
8351 <div class="args"> |
|
8352 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8353 |
|
8354 <li class="arg"> |
|
8355 |
|
8356 <code>id</code> |
|
8357 |
|
8358 </li> |
|
8359 |
|
8360 <li class="arg"> |
|
8361 |
|
8362 <code>details</code> |
|
8363 |
|
8364 </li> |
|
8365 |
|
8366 </ul><span class="paren">)</span> |
|
8367 </div> |
|
8368 |
|
8369 |
|
8370 |
|
8371 |
|
8372 |
|
8373 |
|
8374 |
|
8375 <span class="flag protected">protected</span> |
|
8376 |
|
8377 |
|
8378 |
|
8379 |
|
8380 |
|
8381 |
|
8382 |
|
8383 |
|
8384 |
|
8385 |
|
8386 <div class="meta"> |
|
8387 |
|
8388 |
|
8389 <p>Inherited from |
|
8390 <a href="../classes/PjaxContent.html#method__onPjaxIOEnd">PjaxContent</a>: |
|
8391 |
|
8392 |
|
8393 |
|
8394 <a href="../files/pjax_js_pjax-content.js.html#l189"><code>pjax/js/pjax-content.js:189</code></a> |
|
8395 |
|
8396 </p> |
|
8397 |
|
8398 |
|
8399 |
|
8400 |
|
8401 |
|
8402 <p>Available since 3.5.0</p> |
|
8403 |
|
8404 </div> |
|
8405 |
|
8406 <div class="description"> |
|
8407 <p>Handles IO end events.</p> |
|
8408 </div> |
|
8409 |
|
8410 |
|
8411 <div class="params"> |
|
8412 <h4>Parameters:</h4> |
|
8413 |
|
8414 <ul class="params-list"> |
|
8415 |
|
8416 <li class="param"> |
|
8417 |
|
8418 <code class="param-name">id</code> |
|
8419 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8420 |
|
8421 |
|
8422 |
|
8423 |
|
8424 <div class="param-description"> |
|
8425 <p>The <code>Y.io</code> transaction id.</p> |
|
8426 </div> |
|
8427 |
|
8428 |
|
8429 </li> |
|
8430 |
|
8431 <li class="param"> |
|
8432 |
|
8433 <code class="param-name">details</code> |
|
8434 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8435 |
|
8436 |
|
8437 |
|
8438 |
|
8439 <div class="param-description"> |
|
8440 <p>Extra details carried through from <code>loadContent()</code>.</p> |
|
8441 </div> |
|
8442 |
|
8443 |
|
8444 </li> |
|
8445 |
|
8446 </ul> |
|
8447 </div> |
|
8448 |
|
8449 |
|
8450 |
|
8451 |
|
8452 |
|
8453 </div> |
|
8454 |
|
8455 |
|
8456 <div id="method__parseQuery" class="method item protected inherited"> |
|
8457 <h3 class="name"><code>_parseQuery</code></h3> |
|
8458 |
|
8459 |
|
8460 <div class="args"> |
|
8461 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8462 |
|
8463 <li class="arg"> |
|
8464 |
|
8465 <code>query</code> |
|
8466 |
|
8467 </li> |
|
8468 |
|
8469 </ul><span class="paren">)</span> |
|
8470 </div> |
|
8471 |
|
8472 |
|
8473 |
|
8474 <span class="returns-inline"> |
|
8475 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8476 </span> |
|
8477 |
|
8478 |
|
8479 |
|
8480 |
|
8481 |
|
8482 <span class="flag protected">protected</span> |
|
8483 |
|
8484 |
|
8485 |
|
8486 |
|
8487 |
|
8488 |
|
8489 |
|
8490 |
|
8491 |
|
8492 |
|
8493 <div class="meta"> |
|
8494 |
|
8495 |
|
8496 <p>Inherited from |
|
8497 <a href="../classes/Router.html#method__parseQuery">Router</a>: |
|
8498 |
|
8499 |
|
8500 |
|
8501 <a href="../files/app_js_router.js.html#l993"><code>app/js/router.js:993</code></a> |
|
8502 |
|
8503 </p> |
|
8504 |
|
8505 |
|
8506 |
|
8507 |
|
8508 |
|
8509 </div> |
|
8510 |
|
8511 <div class="description"> |
|
8512 <p>Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is |
|
8513 available, this method will be an alias to that.</p> |
|
8514 </div> |
|
8515 |
|
8516 |
|
8517 <div class="params"> |
|
8518 <h4>Parameters:</h4> |
|
8519 |
|
8520 <ul class="params-list"> |
|
8521 |
|
8522 <li class="param"> |
|
8523 |
|
8524 <code class="param-name">query</code> |
|
8525 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8526 |
|
8527 |
|
8528 |
|
8529 |
|
8530 <div class="param-description"> |
|
8531 <p>Query string to parse.</p> |
|
8532 </div> |
|
8533 |
|
8534 |
|
8535 </li> |
|
8536 |
|
8537 </ul> |
|
8538 </div> |
|
8539 |
|
8540 |
|
8541 |
|
8542 <div class="returns"> |
|
8543 <h4>Returns:</h4> |
|
8544 |
|
8545 <div class="returns-description"> |
|
8546 |
|
8547 |
|
8548 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
8549 |
|
8550 Hash of key/value pairs for query parameters. |
|
8551 |
|
8552 </div> |
|
8553 </div> |
|
8554 |
|
8555 |
|
8556 |
|
8557 </div> |
|
8558 |
|
8559 |
|
8560 <div id="method__parseType" class="method item private inherited"> |
|
8561 <h3 class="name"><code>_parseType</code></h3> |
|
8562 |
|
8563 |
|
8564 <span class="paren">()</span> |
|
8565 |
|
8566 |
|
8567 |
|
8568 |
|
8569 |
|
8570 |
|
8571 |
|
8572 <span class="flag private">private</span> |
|
8573 |
|
8574 |
|
8575 |
|
8576 |
|
8577 |
|
8578 |
|
8579 |
|
8580 |
|
8581 |
|
8582 |
|
8583 <div class="meta"> |
|
8584 |
|
8585 |
|
8586 <p>Inherited from |
|
8587 <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>: |
|
8588 |
|
8589 |
|
8590 |
|
8591 <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a> |
|
8592 |
|
8593 </p> |
|
8594 |
|
8595 |
|
8596 |
|
8597 |
|
8598 |
|
8599 </div> |
|
8600 |
|
8601 <div class="description"> |
|
8602 <p>Returns an array with the detach key (if provided), |
|
8603 and the prefixed event name from _getType |
|
8604 Y.on('detachcategory| menu:click', fn)</p> |
|
8605 </div> |
|
8606 |
|
8607 |
|
8608 |
|
8609 |
|
8610 |
|
8611 |
|
8612 </div> |
|
8613 |
|
8614 |
|
8615 <div id="method__pjaxBindUI" class="method item protected inherited"> |
|
8616 <h3 class="name"><code>_pjaxBindUI</code></h3> |
|
8617 |
|
8618 |
|
8619 <span class="paren">()</span> |
|
8620 |
|
8621 |
|
8622 |
|
8623 |
|
8624 |
|
8625 |
|
8626 |
|
8627 <span class="flag protected">protected</span> |
|
8628 |
|
8629 |
|
8630 |
|
8631 |
|
8632 |
|
8633 |
|
8634 |
|
8635 |
|
8636 |
|
8637 |
|
8638 <div class="meta"> |
|
8639 |
|
8640 |
|
8641 <p>Inherited from |
|
8642 <a href="../classes/PjaxBase.html#method__pjaxBindUI">PjaxBase</a>: |
|
8643 |
|
8644 |
|
8645 |
|
8646 <a href="../files/pjax_js_pjax-base.js.html#l279"><code>pjax/js/pjax-base.js:279</code></a> |
|
8647 |
|
8648 </p> |
|
8649 |
|
8650 |
|
8651 |
|
8652 |
|
8653 |
|
8654 <p>Available since 3.5.0</p> |
|
8655 |
|
8656 </div> |
|
8657 |
|
8658 <div class="description"> |
|
8659 <p>Binds the delegation of link-click events that match the <code>linkSelector</code> to |
|
8660 the <code>_onLinkClick()</code> handler.</p> |
|
8661 |
|
8662 <p>By default this method will only be called if the browser is capable of |
|
8663 using HTML5 history.</p> |
|
8664 </div> |
|
8665 |
|
8666 |
|
8667 |
|
8668 |
|
8669 |
|
8670 |
|
8671 </div> |
|
8672 |
|
8673 |
|
8674 <div id="method__preInitEventCfg" class="method item private inherited"> |
|
8675 <h3 class="name"><code>_preInitEventCfg</code></h3> |
|
8676 |
|
8677 |
|
8678 <div class="args"> |
|
8679 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8680 |
|
8681 <li class="arg"> |
|
8682 |
|
8683 <code>config</code> |
|
8684 |
|
8685 </li> |
|
8686 |
|
8687 </ul><span class="paren">)</span> |
|
8688 </div> |
|
8689 |
|
8690 |
|
8691 |
|
8692 |
|
8693 |
|
8694 |
|
8695 |
|
8696 <span class="flag private">private</span> |
|
8697 |
|
8698 |
|
8699 |
|
8700 |
|
8701 |
|
8702 |
|
8703 |
|
8704 |
|
8705 |
|
8706 |
|
8707 <div class="meta"> |
|
8708 |
|
8709 |
|
8710 <p>Inherited from |
|
8711 <a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>: |
|
8712 |
|
8713 |
|
8714 |
|
8715 <a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a> |
|
8716 |
|
8717 </p> |
|
8718 |
|
8719 |
|
8720 |
|
8721 |
|
8722 |
|
8723 </div> |
|
8724 |
|
8725 <div class="description"> |
|
8726 <p>Handles the special on, after and target properties which allow the user to |
|
8727 easily configure on and after listeners as well as bubble targets during |
|
8728 construction, prior to init.</p> |
|
8729 </div> |
|
8730 |
|
8731 |
|
8732 <div class="params"> |
|
8733 <h4>Parameters:</h4> |
|
8734 |
|
8735 <ul class="params-list"> |
|
8736 |
|
8737 <li class="param"> |
|
8738 |
|
8739 <code class="param-name">config</code> |
|
8740 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8741 |
|
8742 |
|
8743 |
|
8744 |
|
8745 <div class="param-description"> |
|
8746 <p>The user configuration object</p> |
|
8747 </div> |
|
8748 |
|
8749 |
|
8750 </li> |
|
8751 |
|
8752 </ul> |
|
8753 </div> |
|
8754 |
|
8755 |
|
8756 |
|
8757 |
|
8758 |
|
8759 </div> |
|
8760 |
|
8761 |
|
8762 <div id="method__protectAttrs" class="method item protected deprecated inherited"> |
|
8763 <h3 class="name"><code>_protectAttrs</code></h3> |
|
8764 |
|
8765 |
|
8766 <div class="args"> |
|
8767 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8768 |
|
8769 <li class="arg"> |
|
8770 |
|
8771 <code>attrs</code> |
|
8772 |
|
8773 </li> |
|
8774 |
|
8775 </ul><span class="paren">)</span> |
|
8776 </div> |
|
8777 |
|
8778 |
|
8779 |
|
8780 <span class="returns-inline"> |
|
8781 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8782 </span> |
|
8783 |
|
8784 |
|
8785 |
|
8786 <span class="flag deprecated" title="Use `AttributeCore.protectAttrs()` or |
|
8787 `Attribute.protectAttrs()` which are the same static utility method.">deprecated</span> |
|
8788 |
|
8789 |
|
8790 |
|
8791 <span class="flag protected">protected</span> |
|
8792 |
|
8793 |
|
8794 |
|
8795 |
|
8796 |
|
8797 |
|
8798 |
|
8799 |
|
8800 |
|
8801 |
|
8802 <div class="meta"> |
|
8803 |
|
8804 |
|
8805 <p>Inherited from |
|
8806 <a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>: |
|
8807 |
|
8808 |
|
8809 |
|
8810 <a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a> |
|
8811 |
|
8812 </p> |
|
8813 |
|
8814 |
|
8815 |
|
8816 <p>Deprecated: Use `AttributeCore.protectAttrs()` or |
|
8817 `Attribute.protectAttrs()` which are the same static utility method.</p> |
|
8818 |
|
8819 |
|
8820 |
|
8821 </div> |
|
8822 |
|
8823 <div class="description"> |
|
8824 <p>Utility method to protect an attribute configuration |
|
8825 hash, by merging the entire object and the individual |
|
8826 attr config objects.</p> |
|
8827 </div> |
|
8828 |
|
8829 |
|
8830 <div class="params"> |
|
8831 <h4>Parameters:</h4> |
|
8832 |
|
8833 <ul class="params-list"> |
|
8834 |
|
8835 <li class="param"> |
|
8836 |
|
8837 <code class="param-name">attrs</code> |
|
8838 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8839 |
|
8840 |
|
8841 |
|
8842 |
|
8843 <div class="param-description"> |
|
8844 <p>A hash of attribute to configuration object pairs.</p> |
|
8845 </div> |
|
8846 |
|
8847 |
|
8848 </li> |
|
8849 |
|
8850 </ul> |
|
8851 </div> |
|
8852 |
|
8853 |
|
8854 |
|
8855 <div class="returns"> |
|
8856 <h4>Returns:</h4> |
|
8857 |
|
8858 <div class="returns-description"> |
|
8859 |
|
8860 |
|
8861 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
8862 |
|
8863 A protected version of the attrs argument. |
|
8864 |
|
8865 </div> |
|
8866 </div> |
|
8867 |
|
8868 |
|
8869 |
|
8870 </div> |
|
8871 |
|
8872 |
|
8873 <div id="method__publish" class="method item private inherited"> |
|
8874 <h3 class="name"><code>_publish</code></h3> |
|
8875 |
|
8876 |
|
8877 <div class="args"> |
|
8878 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8879 |
|
8880 <li class="arg"> |
|
8881 |
|
8882 <code>fullType</code> |
|
8883 |
|
8884 </li> |
|
8885 |
|
8886 <li class="arg"> |
|
8887 |
|
8888 <code>etOpts</code> |
|
8889 |
|
8890 </li> |
|
8891 |
|
8892 <li class="arg"> |
|
8893 |
|
8894 <code>ceOpts</code> |
|
8895 |
|
8896 </li> |
|
8897 |
|
8898 </ul><span class="paren">)</span> |
|
8899 </div> |
|
8900 |
|
8901 |
|
8902 |
|
8903 <span class="returns-inline"> |
|
8904 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
8905 </span> |
|
8906 |
|
8907 |
|
8908 |
|
8909 |
|
8910 |
|
8911 <span class="flag private">private</span> |
|
8912 |
|
8913 |
|
8914 |
|
8915 |
|
8916 |
|
8917 |
|
8918 |
|
8919 |
|
8920 |
|
8921 |
|
8922 <div class="meta"> |
|
8923 |
|
8924 |
|
8925 <p>Inherited from |
|
8926 <a href="../classes/EventTarget.html#method__publish">EventTarget</a>: |
|
8927 |
|
8928 |
|
8929 |
|
8930 <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a> |
|
8931 |
|
8932 </p> |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 </div> |
|
8939 |
|
8940 <div class="description"> |
|
8941 <p>The low level event publish implementation. It expects all the massaging to have been done |
|
8942 outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast |
|
8943 path publish, which can be used by critical code paths to improve performance.</p> |
|
8944 </div> |
|
8945 |
|
8946 |
|
8947 <div class="params"> |
|
8948 <h4>Parameters:</h4> |
|
8949 |
|
8950 <ul class="params-list"> |
|
8951 |
|
8952 <li class="param"> |
|
8953 |
|
8954 <code class="param-name">fullType</code> |
|
8955 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8956 |
|
8957 |
|
8958 |
|
8959 |
|
8960 <div class="param-description"> |
|
8961 <p>The prefixed type of the event to publish.</p> |
|
8962 </div> |
|
8963 |
|
8964 |
|
8965 </li> |
|
8966 |
|
8967 <li class="param"> |
|
8968 |
|
8969 <code class="param-name">etOpts</code> |
|
8970 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8971 |
|
8972 |
|
8973 |
|
8974 |
|
8975 <div class="param-description"> |
|
8976 <p>The EventTarget specific configuration to mix into the published event.</p> |
|
8977 </div> |
|
8978 |
|
8979 |
|
8980 </li> |
|
8981 |
|
8982 <li class="param"> |
|
8983 |
|
8984 <code class="param-name">ceOpts</code> |
|
8985 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8986 |
|
8987 |
|
8988 |
|
8989 |
|
8990 <div class="param-description"> |
|
8991 <p>The publish specific configuration to mix into the published event.</p> |
|
8992 </div> |
|
8993 |
|
8994 |
|
8995 </li> |
|
8996 |
|
8997 </ul> |
|
8998 </div> |
|
8999 |
|
9000 |
|
9001 |
|
9002 <div class="returns"> |
|
9003 <h4>Returns:</h4> |
|
9004 |
|
9005 <div class="returns-description"> |
|
9006 |
|
9007 |
|
9008 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
9009 |
|
9010 The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will |
|
9011 be the default <code>CustomEvent</code> instance, and can be configured independently. |
|
9012 |
|
9013 </div> |
|
9014 </div> |
|
9015 |
|
9016 |
|
9017 |
|
9018 </div> |
|
9019 |
|
9020 |
|
9021 <div id="method__queue" class="method item protected inherited"> |
|
9022 <h3 class="name"><code>_queue</code></h3> |
|
9023 |
|
9024 |
|
9025 <span class="paren">()</span> |
|
9026 |
|
9027 |
|
9028 |
|
9029 |
|
9030 |
|
9031 |
|
9032 |
|
9033 <span class="flag protected">protected</span> |
|
9034 |
|
9035 |
|
9036 |
|
9037 |
|
9038 |
|
9039 |
|
9040 |
|
9041 <span class="flag chainable">chainable</span> |
|
9042 |
|
9043 |
|
9044 |
|
9045 |
|
9046 <div class="meta"> |
|
9047 |
|
9048 |
|
9049 <p>Inherited from |
|
9050 <a href="../classes/Router.html#method__queue">Router</a>: |
|
9051 |
|
9052 |
|
9053 |
|
9054 <a href="../files/app_js_router.js.html#l1021"><code>app/js/router.js:1021</code></a> |
|
9055 |
|
9056 </p> |
|
9057 |
|
9058 |
|
9059 |
|
9060 |
|
9061 |
|
9062 </div> |
|
9063 |
|
9064 <div class="description"> |
|
9065 <p>Queues up a <code>_save()</code> call to run after all previously-queued calls have |
|
9066 finished.</p> |
|
9067 |
|
9068 <p>This is necessary because if we make multiple <code>_save()</code> calls before the |
|
9069 first call gets dispatched, then both calls will dispatch to the last call's |
|
9070 URL.</p> |
|
9071 |
|
9072 <p>All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the |
|
9073 queued function is executed.</p> |
|
9074 </div> |
|
9075 |
|
9076 |
|
9077 |
|
9078 |
|
9079 |
|
9080 |
|
9081 </div> |
|
9082 |
|
9083 |
|
9084 <div id="method__resolvePath" class="method item protected inherited"> |
|
9085 <h3 class="name"><code>_resolvePath</code></h3> |
|
9086 |
|
9087 |
|
9088 <div class="args"> |
|
9089 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9090 |
|
9091 <li class="arg"> |
|
9092 |
|
9093 <code>path</code> |
|
9094 |
|
9095 </li> |
|
9096 |
|
9097 </ul><span class="paren">)</span> |
|
9098 </div> |
|
9099 |
|
9100 |
|
9101 |
|
9102 <span class="returns-inline"> |
|
9103 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9104 </span> |
|
9105 |
|
9106 |
|
9107 |
|
9108 |
|
9109 |
|
9110 <span class="flag protected">protected</span> |
|
9111 |
|
9112 |
|
9113 |
|
9114 |
|
9115 |
|
9116 |
|
9117 |
|
9118 |
|
9119 |
|
9120 |
|
9121 <div class="meta"> |
|
9122 |
|
9123 |
|
9124 <p>Inherited from |
|
9125 <a href="../classes/Router.html#method__resolvePath">Router</a>: |
|
9126 |
|
9127 |
|
9128 |
|
9129 <a href="../files/app_js_router.js.html#l1066"><code>app/js/router.js:1066</code></a> |
|
9130 |
|
9131 </p> |
|
9132 |
|
9133 |
|
9134 |
|
9135 |
|
9136 |
|
9137 <p>Available since 3.5.0</p> |
|
9138 |
|
9139 </div> |
|
9140 |
|
9141 <div class="description"> |
|
9142 <p>Returns the normalized result of resolving the <code>path</code> against the current |
|
9143 path. Falsy values for <code>path</code> will return just the current path.</p> |
|
9144 </div> |
|
9145 |
|
9146 |
|
9147 <div class="params"> |
|
9148 <h4>Parameters:</h4> |
|
9149 |
|
9150 <ul class="params-list"> |
|
9151 |
|
9152 <li class="param"> |
|
9153 |
|
9154 <code class="param-name">path</code> |
|
9155 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9156 |
|
9157 |
|
9158 |
|
9159 |
|
9160 <div class="param-description"> |
|
9161 <p>URL path to resolve.</p> |
|
9162 </div> |
|
9163 |
|
9164 |
|
9165 </li> |
|
9166 |
|
9167 </ul> |
|
9168 </div> |
|
9169 |
|
9170 |
|
9171 |
|
9172 <div class="returns"> |
|
9173 <h4>Returns:</h4> |
|
9174 |
|
9175 <div class="returns-description"> |
|
9176 |
|
9177 |
|
9178 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
9179 |
|
9180 Resolved path. |
|
9181 |
|
9182 </div> |
|
9183 </div> |
|
9184 |
|
9185 |
|
9186 |
|
9187 </div> |
|
9188 |
|
9189 |
|
9190 <div id="method__resolveURL" class="method item protected inherited"> |
|
9191 <h3 class="name"><code>_resolveURL</code></h3> |
|
9192 |
|
9193 |
|
9194 <div class="args"> |
|
9195 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9196 |
|
9197 <li class="arg"> |
|
9198 |
|
9199 <code>url</code> |
|
9200 |
|
9201 </li> |
|
9202 |
|
9203 </ul><span class="paren">)</span> |
|
9204 </div> |
|
9205 |
|
9206 |
|
9207 |
|
9208 <span class="returns-inline"> |
|
9209 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9210 </span> |
|
9211 |
|
9212 |
|
9213 |
|
9214 |
|
9215 |
|
9216 <span class="flag protected">protected</span> |
|
9217 |
|
9218 |
|
9219 |
|
9220 |
|
9221 |
|
9222 |
|
9223 |
|
9224 |
|
9225 |
|
9226 |
|
9227 <div class="meta"> |
|
9228 |
|
9229 |
|
9230 <p>Inherited from |
|
9231 <a href="../classes/Router.html#method__resolveURL">Router</a>: |
|
9232 |
|
9233 |
|
9234 |
|
9235 <a href="../files/app_js_router.js.html#l1088"><code>app/js/router.js:1088</code></a> |
|
9236 |
|
9237 </p> |
|
9238 |
|
9239 |
|
9240 |
|
9241 |
|
9242 |
|
9243 <p>Available since 3.5.0</p> |
|
9244 |
|
9245 </div> |
|
9246 |
|
9247 <div class="description"> |
|
9248 <p>Resolves the specified URL against the current URL.</p> |
|
9249 |
|
9250 <p>This method resolves URLs like a browser does and will always return an |
|
9251 absolute URL. When the specified URL is already absolute, it is assumed to |
|
9252 be fully resolved and is simply returned as is. Scheme-relative URLs are |
|
9253 prefixed with the current protocol. Relative URLs are giving the current |
|
9254 URL's origin and are resolved and normalized against the current path root.</p> |
|
9255 </div> |
|
9256 |
|
9257 |
|
9258 <div class="params"> |
|
9259 <h4>Parameters:</h4> |
|
9260 |
|
9261 <ul class="params-list"> |
|
9262 |
|
9263 <li class="param"> |
|
9264 |
|
9265 <code class="param-name">url</code> |
|
9266 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9267 |
|
9268 |
|
9269 |
|
9270 |
|
9271 <div class="param-description"> |
|
9272 <p>URL to resolve.</p> |
|
9273 </div> |
|
9274 |
|
9275 |
|
9276 </li> |
|
9277 |
|
9278 </ul> |
|
9279 </div> |
|
9280 |
|
9281 |
|
9282 |
|
9283 <div class="returns"> |
|
9284 <h4>Returns:</h4> |
|
9285 |
|
9286 <div class="returns-description"> |
|
9287 |
|
9288 |
|
9289 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
9290 |
|
9291 Resolved URL. |
|
9292 |
|
9293 </div> |
|
9294 </div> |
|
9295 |
|
9296 |
|
9297 |
|
9298 </div> |
|
9299 |
|
9300 |
|
9301 <div id="method__save" class="method item protected inherited"> |
|
9302 <h3 class="name"><code>_save</code></h3> |
|
9303 |
|
9304 |
|
9305 <div class="args"> |
|
9306 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9307 |
|
9308 <li class="arg"> |
|
9309 |
|
9310 <code class="optional">[url]</code> |
|
9311 |
|
9312 </li> |
|
9313 |
|
9314 <li class="arg"> |
|
9315 |
|
9316 <code class="optional">[replace=false]</code> |
|
9317 |
|
9318 </li> |
|
9319 |
|
9320 </ul><span class="paren">)</span> |
|
9321 </div> |
|
9322 |
|
9323 |
|
9324 |
|
9325 |
|
9326 |
|
9327 |
|
9328 |
|
9329 <span class="flag protected">protected</span> |
|
9330 |
|
9331 |
|
9332 |
|
9333 |
|
9334 |
|
9335 |
|
9336 |
|
9337 <span class="flag chainable">chainable</span> |
|
9338 |
|
9339 |
|
9340 |
|
9341 |
|
9342 <div class="meta"> |
|
9343 |
|
9344 |
|
9345 <p>Inherited from |
|
9346 <a href="../classes/Router.html#method__save">Router</a>: |
|
9347 |
|
9348 |
|
9349 |
|
9350 <a href="../files/app_js_router.js.html#l1139"><code>app/js/router.js:1139</code></a> |
|
9351 |
|
9352 </p> |
|
9353 |
|
9354 |
|
9355 |
|
9356 |
|
9357 |
|
9358 </div> |
|
9359 |
|
9360 <div class="description"> |
|
9361 <p>Saves a history entry using either <code>pushState()</code> or the location hash.</p> |
|
9362 |
|
9363 <p>This method enforces the same-origin security constraint; attempting to save |
|
9364 a <code>url</code> that is not from the same origin as the current URL will result in |
|
9365 an error.</p> |
|
9366 </div> |
|
9367 |
|
9368 |
|
9369 <div class="params"> |
|
9370 <h4>Parameters:</h4> |
|
9371 |
|
9372 <ul class="params-list"> |
|
9373 |
|
9374 <li class="param"> |
|
9375 |
|
9376 <code class="param-name optional">[url]</code> |
|
9377 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9378 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9379 |
|
9380 |
|
9381 |
|
9382 |
|
9383 <div class="param-description"> |
|
9384 <p>URL for the history entry.</p> |
|
9385 </div> |
|
9386 |
|
9387 |
|
9388 </li> |
|
9389 |
|
9390 <li class="param"> |
|
9391 |
|
9392 <code class="param-name optional">[replace=false]</code> |
|
9393 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
9394 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9395 |
|
9396 |
|
9397 |
|
9398 |
|
9399 <div class="param-description"> |
|
9400 <p>If <code>true</code>, the current history entry will |
|
9401 be replaced instead of a new one being added.</p> |
|
9402 </div> |
|
9403 |
|
9404 |
|
9405 </li> |
|
9406 |
|
9407 </ul> |
|
9408 </div> |
|
9409 |
|
9410 |
|
9411 |
|
9412 |
|
9413 |
|
9414 </div> |
|
9415 |
|
9416 |
|
9417 <div id="method__set" class="method item protected inherited"> |
|
9418 <h3 class="name"><code>_set</code></h3> |
|
9419 |
|
9420 |
|
9421 <div class="args"> |
|
9422 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9423 |
|
9424 <li class="arg"> |
|
9425 |
|
9426 <code>name</code> |
|
9427 |
|
9428 </li> |
|
9429 |
|
9430 <li class="arg"> |
|
9431 |
|
9432 <code>val</code> |
|
9433 |
|
9434 </li> |
|
9435 |
|
9436 <li class="arg"> |
|
9437 |
|
9438 <code class="optional">[opts]</code> |
|
9439 |
|
9440 </li> |
|
9441 |
|
9442 </ul><span class="paren">)</span> |
|
9443 </div> |
|
9444 |
|
9445 |
|
9446 |
|
9447 <span class="returns-inline"> |
|
9448 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9449 </span> |
|
9450 |
|
9451 |
|
9452 |
|
9453 |
|
9454 |
|
9455 <span class="flag protected">protected</span> |
|
9456 |
|
9457 |
|
9458 |
|
9459 |
|
9460 |
|
9461 |
|
9462 |
|
9463 <span class="flag chainable">chainable</span> |
|
9464 |
|
9465 |
|
9466 |
|
9467 |
|
9468 <div class="meta"> |
|
9469 |
|
9470 <p>Inherited from |
|
9471 <a href="../classes/AttributeObservable.html#method__set"> |
|
9472 AttributeObservable |
|
9473 </a> |
|
9474 |
|
9475 but overwritten in |
|
9476 |
|
9477 |
|
9478 |
|
9479 <a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a> |
|
9480 |
|
9481 </p> |
|
9482 |
|
9483 |
|
9484 |
|
9485 |
|
9486 |
|
9487 </div> |
|
9488 |
|
9489 <div class="description"> |
|
9490 <p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p> |
|
9491 </div> |
|
9492 |
|
9493 |
|
9494 <div class="params"> |
|
9495 <h4>Parameters:</h4> |
|
9496 |
|
9497 <ul class="params-list"> |
|
9498 |
|
9499 <li class="param"> |
|
9500 |
|
9501 <code class="param-name">name</code> |
|
9502 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9503 |
|
9504 |
|
9505 |
|
9506 |
|
9507 <div class="param-description"> |
|
9508 <p>The name of the attribute.</p> |
|
9509 </div> |
|
9510 |
|
9511 |
|
9512 </li> |
|
9513 |
|
9514 <li class="param"> |
|
9515 |
|
9516 <code class="param-name">val</code> |
|
9517 <span class="type">Any</span> |
|
9518 |
|
9519 |
|
9520 |
|
9521 |
|
9522 <div class="param-description"> |
|
9523 <p>The value to set the attribute to.</p> |
|
9524 </div> |
|
9525 |
|
9526 |
|
9527 </li> |
|
9528 |
|
9529 <li class="param"> |
|
9530 |
|
9531 <code class="param-name optional">[opts]</code> |
|
9532 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9533 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9534 |
|
9535 |
|
9536 |
|
9537 |
|
9538 <div class="param-description"> |
|
9539 <p>Optional data providing the circumstances for the change.</p> |
|
9540 </div> |
|
9541 |
|
9542 |
|
9543 </li> |
|
9544 |
|
9545 </ul> |
|
9546 </div> |
|
9547 |
|
9548 |
|
9549 |
|
9550 <div class="returns"> |
|
9551 <h4>Returns:</h4> |
|
9552 |
|
9553 <div class="returns-description"> |
|
9554 |
|
9555 |
|
9556 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9557 |
|
9558 A reference to the host object. |
|
9559 |
|
9560 </div> |
|
9561 </div> |
|
9562 |
|
9563 |
|
9564 |
|
9565 </div> |
|
9566 |
|
9567 |
|
9568 <div id="method__setAttr" class="method item protected inherited"> |
|
9569 <h3 class="name"><code>_setAttr</code></h3> |
|
9570 |
|
9571 |
|
9572 <div class="args"> |
|
9573 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9574 |
|
9575 <li class="arg"> |
|
9576 |
|
9577 <code>name</code> |
|
9578 |
|
9579 </li> |
|
9580 |
|
9581 <li class="arg"> |
|
9582 |
|
9583 <code>value</code> |
|
9584 |
|
9585 </li> |
|
9586 |
|
9587 <li class="arg"> |
|
9588 |
|
9589 <code class="optional">[opts]</code> |
|
9590 |
|
9591 </li> |
|
9592 |
|
9593 <li class="arg"> |
|
9594 |
|
9595 <code>force</code> |
|
9596 |
|
9597 </li> |
|
9598 |
|
9599 </ul><span class="paren">)</span> |
|
9600 </div> |
|
9601 |
|
9602 |
|
9603 |
|
9604 <span class="returns-inline"> |
|
9605 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9606 </span> |
|
9607 |
|
9608 |
|
9609 |
|
9610 |
|
9611 |
|
9612 <span class="flag protected">protected</span> |
|
9613 |
|
9614 |
|
9615 |
|
9616 |
|
9617 |
|
9618 |
|
9619 |
|
9620 <span class="flag chainable">chainable</span> |
|
9621 |
|
9622 |
|
9623 |
|
9624 |
|
9625 <div class="meta"> |
|
9626 |
|
9627 |
|
9628 <p>Inherited from |
|
9629 <a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>: |
|
9630 |
|
9631 |
|
9632 |
|
9633 <a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a> |
|
9634 |
|
9635 </p> |
|
9636 |
|
9637 |
|
9638 |
|
9639 |
|
9640 |
|
9641 </div> |
|
9642 |
|
9643 <div class="description"> |
|
9644 <p>Provides the common implementation for the public set and protected _set methods.</p> |
|
9645 |
|
9646 <p>See <a href="#method_set">set</a> for argument details.</p> |
|
9647 </div> |
|
9648 |
|
9649 |
|
9650 <div class="params"> |
|
9651 <h4>Parameters:</h4> |
|
9652 |
|
9653 <ul class="params-list"> |
|
9654 |
|
9655 <li class="param"> |
|
9656 |
|
9657 <code class="param-name">name</code> |
|
9658 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9659 |
|
9660 |
|
9661 |
|
9662 |
|
9663 <div class="param-description"> |
|
9664 <p>The name of the attribute.</p> |
|
9665 </div> |
|
9666 |
|
9667 |
|
9668 </li> |
|
9669 |
|
9670 <li class="param"> |
|
9671 |
|
9672 <code class="param-name">value</code> |
|
9673 <span class="type">Any</span> |
|
9674 |
|
9675 |
|
9676 |
|
9677 |
|
9678 <div class="param-description"> |
|
9679 <p>The value to set the attribute to.</p> |
|
9680 </div> |
|
9681 |
|
9682 |
|
9683 </li> |
|
9684 |
|
9685 <li class="param"> |
|
9686 |
|
9687 <code class="param-name optional">[opts]</code> |
|
9688 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9689 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9690 |
|
9691 |
|
9692 |
|
9693 |
|
9694 <div class="param-description"> |
|
9695 <p>Optional data providing the circumstances for the change.</p> |
|
9696 </div> |
|
9697 |
|
9698 |
|
9699 </li> |
|
9700 |
|
9701 <li class="param"> |
|
9702 |
|
9703 <code class="param-name">force</code> |
|
9704 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
9705 |
|
9706 |
|
9707 |
|
9708 |
|
9709 <div class="param-description"> |
|
9710 <p>If true, allows the caller to set values for |
|
9711 readOnly or writeOnce attributes which have already been set.</p> |
|
9712 </div> |
|
9713 |
|
9714 |
|
9715 </li> |
|
9716 |
|
9717 </ul> |
|
9718 </div> |
|
9719 |
|
9720 |
|
9721 |
|
9722 <div class="returns"> |
|
9723 <h4>Returns:</h4> |
|
9724 |
|
9725 <div class="returns-description"> |
|
9726 |
|
9727 |
|
9728 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9729 |
|
9730 A reference to the host object. |
|
9731 |
|
9732 </div> |
|
9733 </div> |
|
9734 |
|
9735 |
|
9736 |
|
9737 </div> |
|
9738 |
|
9739 |
|
9740 <div id="method__setAttrs" class="method item protected inherited"> |
|
9741 <h3 class="name"><code>_setAttrs</code></h3> |
|
9742 |
|
9743 |
|
9744 <div class="args"> |
|
9745 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9746 |
|
9747 <li class="arg"> |
|
9748 |
|
9749 <code>attrs</code> |
|
9750 |
|
9751 </li> |
|
9752 |
|
9753 <li class="arg"> |
|
9754 |
|
9755 <code class="optional">[opts]</code> |
|
9756 |
|
9757 </li> |
|
9758 |
|
9759 </ul><span class="paren">)</span> |
|
9760 </div> |
|
9761 |
|
9762 |
|
9763 |
|
9764 <span class="returns-inline"> |
|
9765 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9766 </span> |
|
9767 |
|
9768 |
|
9769 |
|
9770 |
|
9771 |
|
9772 <span class="flag protected">protected</span> |
|
9773 |
|
9774 |
|
9775 |
|
9776 |
|
9777 |
|
9778 |
|
9779 |
|
9780 <span class="flag chainable">chainable</span> |
|
9781 |
|
9782 |
|
9783 |
|
9784 |
|
9785 <div class="meta"> |
|
9786 |
|
9787 <p>Inherited from |
|
9788 <a href="../classes/AttributeObservable.html#method__setAttrs"> |
|
9789 AttributeObservable |
|
9790 </a> |
|
9791 |
|
9792 but overwritten in |
|
9793 |
|
9794 |
|
9795 |
|
9796 <a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a> |
|
9797 |
|
9798 </p> |
|
9799 |
|
9800 |
|
9801 |
|
9802 |
|
9803 |
|
9804 </div> |
|
9805 |
|
9806 <div class="description"> |
|
9807 <p>Implementation behind the public setAttrs method, to set multiple attribute values.</p> |
|
9808 </div> |
|
9809 |
|
9810 |
|
9811 <div class="params"> |
|
9812 <h4>Parameters:</h4> |
|
9813 |
|
9814 <ul class="params-list"> |
|
9815 |
|
9816 <li class="param"> |
|
9817 |
|
9818 <code class="param-name">attrs</code> |
|
9819 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9820 |
|
9821 |
|
9822 |
|
9823 |
|
9824 <div class="param-description"> |
|
9825 <p>An object with attributes name/value pairs.</p> |
|
9826 </div> |
|
9827 |
|
9828 |
|
9829 </li> |
|
9830 |
|
9831 <li class="param"> |
|
9832 |
|
9833 <code class="param-name optional">[opts]</code> |
|
9834 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9835 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9836 |
|
9837 |
|
9838 |
|
9839 |
|
9840 <div class="param-description"> |
|
9841 <p>Optional data providing the circumstances for the change</p> |
|
9842 </div> |
|
9843 |
|
9844 |
|
9845 </li> |
|
9846 |
|
9847 </ul> |
|
9848 </div> |
|
9849 |
|
9850 |
|
9851 |
|
9852 <div class="returns"> |
|
9853 <h4>Returns:</h4> |
|
9854 |
|
9855 <div class="returns-description"> |
|
9856 |
|
9857 |
|
9858 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9859 |
|
9860 A reference to the host object. |
|
9861 |
|
9862 </div> |
|
9863 </div> |
|
9864 |
|
9865 |
|
9866 |
|
9867 </div> |
|
9868 |
|
9869 |
|
9870 <div id="method__setAttrVal" class="method item private inherited"> |
|
9871 <h3 class="name"><code>_setAttrVal</code></h3> |
|
9872 |
|
9873 |
|
9874 <div class="args"> |
|
9875 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9876 |
|
9877 <li class="arg"> |
|
9878 |
|
9879 <code>attrName</code> |
|
9880 |
|
9881 </li> |
|
9882 |
|
9883 <li class="arg"> |
|
9884 |
|
9885 <code>subAttrName</code> |
|
9886 |
|
9887 </li> |
|
9888 |
|
9889 <li class="arg"> |
|
9890 |
|
9891 <code>prevVal</code> |
|
9892 |
|
9893 </li> |
|
9894 |
|
9895 <li class="arg"> |
|
9896 |
|
9897 <code>newVal</code> |
|
9898 |
|
9899 </li> |
|
9900 |
|
9901 <li class="arg"> |
|
9902 |
|
9903 <code class="optional">[opts]</code> |
|
9904 |
|
9905 </li> |
|
9906 |
|
9907 <li class="arg"> |
|
9908 |
|
9909 <code class="optional">[attrCfg]</code> |
|
9910 |
|
9911 </li> |
|
9912 |
|
9913 </ul><span class="paren">)</span> |
|
9914 </div> |
|
9915 |
|
9916 |
|
9917 |
|
9918 <span class="returns-inline"> |
|
9919 <span class="type">Booolean</span> |
|
9920 </span> |
|
9921 |
|
9922 |
|
9923 |
|
9924 |
|
9925 |
|
9926 <span class="flag private">private</span> |
|
9927 |
|
9928 |
|
9929 |
|
9930 |
|
9931 |
|
9932 |
|
9933 |
|
9934 |
|
9935 |
|
9936 |
|
9937 <div class="meta"> |
|
9938 |
|
9939 |
|
9940 <p>Inherited from |
|
9941 <a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>: |
|
9942 |
|
9943 |
|
9944 |
|
9945 <a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a> |
|
9946 |
|
9947 </p> |
|
9948 |
|
9949 |
|
9950 |
|
9951 |
|
9952 |
|
9953 </div> |
|
9954 |
|
9955 <div class="description"> |
|
9956 <p>Updates the stored value of the attribute in the privately held State object, |
|
9957 if validation and setter passes.</p> |
|
9958 </div> |
|
9959 |
|
9960 |
|
9961 <div class="params"> |
|
9962 <h4>Parameters:</h4> |
|
9963 |
|
9964 <ul class="params-list"> |
|
9965 |
|
9966 <li class="param"> |
|
9967 |
|
9968 <code class="param-name">attrName</code> |
|
9969 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9970 |
|
9971 |
|
9972 |
|
9973 |
|
9974 <div class="param-description"> |
|
9975 <p>The attribute name.</p> |
|
9976 </div> |
|
9977 |
|
9978 |
|
9979 </li> |
|
9980 |
|
9981 <li class="param"> |
|
9982 |
|
9983 <code class="param-name">subAttrName</code> |
|
9984 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9985 |
|
9986 |
|
9987 |
|
9988 |
|
9989 <div class="param-description"> |
|
9990 <p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p> |
|
9991 </div> |
|
9992 |
|
9993 |
|
9994 </li> |
|
9995 |
|
9996 <li class="param"> |
|
9997 |
|
9998 <code class="param-name">prevVal</code> |
|
9999 <span class="type">Any</span> |
|
10000 |
|
10001 |
|
10002 |
|
10003 |
|
10004 <div class="param-description"> |
|
10005 <p>The currently stored value of the attribute.</p> |
|
10006 </div> |
|
10007 |
|
10008 |
|
10009 </li> |
|
10010 |
|
10011 <li class="param"> |
|
10012 |
|
10013 <code class="param-name">newVal</code> |
|
10014 <span class="type">Any</span> |
|
10015 |
|
10016 |
|
10017 |
|
10018 |
|
10019 <div class="param-description"> |
|
10020 <p>The value which is going to be stored.</p> |
|
10021 </div> |
|
10022 |
|
10023 |
|
10024 </li> |
|
10025 |
|
10026 <li class="param"> |
|
10027 |
|
10028 <code class="param-name optional">[opts]</code> |
|
10029 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10030 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10031 |
|
10032 |
|
10033 |
|
10034 |
|
10035 <div class="param-description"> |
|
10036 <p>Optional data providing the circumstances for the change.</p> |
|
10037 </div> |
|
10038 |
|
10039 |
|
10040 </li> |
|
10041 |
|
10042 <li class="param"> |
|
10043 |
|
10044 <code class="param-name optional">[attrCfg]</code> |
|
10045 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10046 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10047 |
|
10048 |
|
10049 |
|
10050 |
|
10051 <div class="param-description"> |
|
10052 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
10053 where the calling method has already obtained the config from state.</p> |
|
10054 </div> |
|
10055 |
|
10056 |
|
10057 </li> |
|
10058 |
|
10059 </ul> |
|
10060 </div> |
|
10061 |
|
10062 |
|
10063 |
|
10064 <div class="returns"> |
|
10065 <h4>Returns:</h4> |
|
10066 |
|
10067 <div class="returns-description"> |
|
10068 |
|
10069 |
|
10070 <span class="type">Booolean</span>: |
|
10071 |
|
10072 true if the new attribute value was stored, false if not. |
|
10073 |
|
10074 </div> |
|
10075 </div> |
|
10076 |
|
10077 |
|
10078 |
|
10079 </div> |
|
10080 |
|
10081 |
|
10082 <div id="method__setRoutes" class="method item protected inherited"> |
|
10083 <h3 class="name"><code>_setRoutes</code></h3> |
|
10084 |
|
10085 |
|
10086 <div class="args"> |
|
10087 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10088 |
|
10089 <li class="arg"> |
|
10090 |
|
10091 <code>routes</code> |
|
10092 |
|
10093 </li> |
|
10094 |
|
10095 </ul><span class="paren">)</span> |
|
10096 </div> |
|
10097 |
|
10098 |
|
10099 |
|
10100 <span class="returns-inline"> |
|
10101 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
10102 </span> |
|
10103 |
|
10104 |
|
10105 |
|
10106 |
|
10107 |
|
10108 <span class="flag protected">protected</span> |
|
10109 |
|
10110 |
|
10111 |
|
10112 |
|
10113 |
|
10114 |
|
10115 |
|
10116 |
|
10117 |
|
10118 |
|
10119 <div class="meta"> |
|
10120 |
|
10121 |
|
10122 <p>Inherited from |
|
10123 <a href="../classes/Router.html#method__setRoutes">Router</a>: |
|
10124 |
|
10125 |
|
10126 |
|
10127 <a href="../files/app_js_router.js.html#l1203"><code>app/js/router.js:1203</code></a> |
|
10128 |
|
10129 </p> |
|
10130 |
|
10131 |
|
10132 |
|
10133 |
|
10134 |
|
10135 </div> |
|
10136 |
|
10137 <div class="description"> |
|
10138 <p>Setter for the <code>routes</code> attribute.</p> |
|
10139 </div> |
|
10140 |
|
10141 |
|
10142 <div class="params"> |
|
10143 <h4>Parameters:</h4> |
|
10144 |
|
10145 <ul class="params-list"> |
|
10146 |
|
10147 <li class="param"> |
|
10148 |
|
10149 <code class="param-name">routes</code> |
|
10150 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
10151 |
|
10152 |
|
10153 |
|
10154 |
|
10155 <div class="param-description"> |
|
10156 <p>Array of route objects.</p> |
|
10157 </div> |
|
10158 |
|
10159 |
|
10160 </li> |
|
10161 |
|
10162 </ul> |
|
10163 </div> |
|
10164 |
|
10165 |
|
10166 |
|
10167 <div class="returns"> |
|
10168 <h4>Returns:</h4> |
|
10169 |
|
10170 <div class="returns-description"> |
|
10171 |
|
10172 |
|
10173 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
10174 |
|
10175 Array of route objects. |
|
10176 |
|
10177 </div> |
|
10178 </div> |
|
10179 |
|
10180 |
|
10181 |
|
10182 </div> |
|
10183 |
|
10184 |
|
10185 <div id="method__setStateVal" class="method item private inherited"> |
|
10186 <h3 class="name"><code>_setStateVal</code></h3> |
|
10187 |
|
10188 |
|
10189 <div class="args"> |
|
10190 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10191 |
|
10192 <li class="arg"> |
|
10193 |
|
10194 <code>name</code> |
|
10195 |
|
10196 </li> |
|
10197 |
|
10198 <li class="arg"> |
|
10199 |
|
10200 <code>value</code> |
|
10201 |
|
10202 </li> |
|
10203 |
|
10204 </ul><span class="paren">)</span> |
|
10205 </div> |
|
10206 |
|
10207 |
|
10208 |
|
10209 |
|
10210 |
|
10211 |
|
10212 |
|
10213 <span class="flag private">private</span> |
|
10214 |
|
10215 |
|
10216 |
|
10217 |
|
10218 |
|
10219 |
|
10220 |
|
10221 |
|
10222 |
|
10223 |
|
10224 <div class="meta"> |
|
10225 |
|
10226 |
|
10227 <p>Inherited from |
|
10228 <a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>: |
|
10229 |
|
10230 |
|
10231 |
|
10232 <a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a> |
|
10233 |
|
10234 </p> |
|
10235 |
|
10236 |
|
10237 |
|
10238 |
|
10239 |
|
10240 </div> |
|
10241 |
|
10242 <div class="description"> |
|
10243 <p>Sets the stored value for the attribute, in either the |
|
10244 internal state object, or the state proxy if it exits</p> |
|
10245 </div> |
|
10246 |
|
10247 |
|
10248 <div class="params"> |
|
10249 <h4>Parameters:</h4> |
|
10250 |
|
10251 <ul class="params-list"> |
|
10252 |
|
10253 <li class="param"> |
|
10254 |
|
10255 <code class="param-name">name</code> |
|
10256 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10257 |
|
10258 |
|
10259 |
|
10260 |
|
10261 <div class="param-description"> |
|
10262 <p>The name of the attribute</p> |
|
10263 </div> |
|
10264 |
|
10265 |
|
10266 </li> |
|
10267 |
|
10268 <li class="param"> |
|
10269 |
|
10270 <code class="param-name">value</code> |
|
10271 <span class="type">Any</span> |
|
10272 |
|
10273 |
|
10274 |
|
10275 |
|
10276 <div class="param-description"> |
|
10277 <p>The value of the attribute</p> |
|
10278 </div> |
|
10279 |
|
10280 |
|
10281 </li> |
|
10282 |
|
10283 </ul> |
|
10284 </div> |
|
10285 |
|
10286 |
|
10287 |
|
10288 |
|
10289 |
|
10290 </div> |
|
10291 |
|
10292 |
|
10293 <div id="method__upgradeURL" class="method item protected inherited"> |
|
10294 <h3 class="name"><code>_upgradeURL</code></h3> |
|
10295 |
|
10296 |
|
10297 <div class="args"> |
|
10298 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10299 |
|
10300 <li class="arg"> |
|
10301 |
|
10302 <code>url</code> |
|
10303 |
|
10304 </li> |
|
10305 |
|
10306 </ul><span class="paren">)</span> |
|
10307 </div> |
|
10308 |
|
10309 |
|
10310 |
|
10311 <span class="returns-inline"> |
|
10312 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10313 </span> |
|
10314 |
|
10315 |
|
10316 |
|
10317 |
|
10318 |
|
10319 <span class="flag protected">protected</span> |
|
10320 |
|
10321 |
|
10322 |
|
10323 |
|
10324 |
|
10325 |
|
10326 |
|
10327 |
|
10328 |
|
10329 |
|
10330 <div class="meta"> |
|
10331 |
|
10332 |
|
10333 <p>Inherited from |
|
10334 <a href="../classes/Router.html#method__upgradeURL">Router</a>: |
|
10335 |
|
10336 |
|
10337 |
|
10338 <a href="../files/app_js_router.js.html#l1224"><code>app/js/router.js:1224</code></a> |
|
10339 |
|
10340 </p> |
|
10341 |
|
10342 |
|
10343 |
|
10344 |
|
10345 |
|
10346 <p>Available since 3.5.0</p> |
|
10347 |
|
10348 </div> |
|
10349 |
|
10350 <div class="description"> |
|
10351 <p>Upgrades a hash-based URL to a full-path URL, if necessary.</p> |
|
10352 |
|
10353 <p>The specified <code>url</code> will be upgraded if its of the same origin as the |
|
10354 current URL and has a path-like hash. URLs that don't need upgrading will be |
|
10355 returned as-is.</p> |
|
10356 </div> |
|
10357 |
|
10358 |
|
10359 <div class="params"> |
|
10360 <h4>Parameters:</h4> |
|
10361 |
|
10362 <ul class="params-list"> |
|
10363 |
|
10364 <li class="param"> |
|
10365 |
|
10366 <code class="param-name">url</code> |
|
10367 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10368 |
|
10369 |
|
10370 |
|
10371 |
|
10372 <div class="param-description"> |
|
10373 <p>The URL to upgrade from hash-based to full-path.</p> |
|
10374 </div> |
|
10375 |
|
10376 |
|
10377 </li> |
|
10378 |
|
10379 </ul> |
|
10380 </div> |
|
10381 |
|
10382 |
|
10383 |
|
10384 <div class="returns"> |
|
10385 <h4>Returns:</h4> |
|
10386 |
|
10387 <div class="returns-description"> |
|
10388 |
|
10389 |
|
10390 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
10391 |
|
10392 The upgraded URL, or the specified URL untouched. |
|
10393 |
|
10394 </div> |
|
10395 </div> |
|
10396 |
|
10397 |
|
10398 |
|
10399 <div class="example"> |
|
10400 <h4>Example:</h4> |
|
10401 |
|
10402 <div class="example-content"> |
|
10403 <pre class="code prettyprint"><code>app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/'; |
|
10404 </code></pre> |
|
10405 </div> |
|
10406 </div> |
|
10407 |
|
10408 </div> |
|
10409 |
|
10410 |
|
10411 <div id="method_addAttr" class="method item inherited"> |
|
10412 <h3 class="name"><code>addAttr</code></h3> |
|
10413 |
|
10414 |
|
10415 <div class="args"> |
|
10416 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10417 |
|
10418 <li class="arg"> |
|
10419 |
|
10420 <code>name</code> |
|
10421 |
|
10422 </li> |
|
10423 |
|
10424 <li class="arg"> |
|
10425 |
|
10426 <code>config</code> |
|
10427 |
|
10428 </li> |
|
10429 |
|
10430 <li class="arg"> |
|
10431 |
|
10432 <code>lazy</code> |
|
10433 |
|
10434 </li> |
|
10435 |
|
10436 </ul><span class="paren">)</span> |
|
10437 </div> |
|
10438 |
|
10439 |
|
10440 |
|
10441 <span class="returns-inline"> |
|
10442 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10443 </span> |
|
10444 |
|
10445 |
|
10446 |
|
10447 |
|
10448 |
|
10449 |
|
10450 |
|
10451 |
|
10452 |
|
10453 |
|
10454 |
|
10455 <span class="flag chainable">chainable</span> |
|
10456 |
|
10457 |
|
10458 |
|
10459 |
|
10460 <div class="meta"> |
|
10461 |
|
10462 |
|
10463 <p>Inherited from |
|
10464 <a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>: |
|
10465 |
|
10466 |
|
10467 |
|
10468 <a href="../files/attribute_js_AttributeCore.js.html#l157"><code>attribute/js/AttributeCore.js:157</code></a> |
|
10469 |
|
10470 </p> |
|
10471 |
|
10472 |
|
10473 |
|
10474 |
|
10475 |
|
10476 </div> |
|
10477 |
|
10478 <div class="description"> |
|
10479 <p> |
|
10480 Adds an attribute with the provided configuration to the host object. |
|
10481 </p> |
|
10482 |
|
10483 <p> |
|
10484 The config argument object supports the following properties: |
|
10485 </p> |
|
10486 |
|
10487 <dl> |
|
10488 <dt>value <Any></dt> |
|
10489 <dd>The initial value to set on the attribute</dd> |
|
10490 |
|
10491 <dt>valueFn <Function | String></dt> |
|
10492 <dd> |
|
10493 <p>A function, which will return the initial value to set on the attribute. This is useful |
|
10494 for cases where the attribute configuration is defined statically, but needs to |
|
10495 reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, |
|
10496 the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which |
|
10497 case the value property is used.</p> |
|
10498 |
|
10499 <p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> |
|
10500 </dd> |
|
10501 |
|
10502 <dt>readOnly <boolean></dt> |
|
10503 <dd>Whether or not the attribute is read only. Attributes having readOnly set to true |
|
10504 cannot be modified by invoking the set method.</dd> |
|
10505 |
|
10506 <dt>writeOnce <boolean> or <string></dt> |
|
10507 <dd> |
|
10508 Whether or not the attribute is "write once". Attributes having writeOnce set to true, |
|
10509 can only have their values set once, be it through the default configuration, |
|
10510 constructor configuration arguments, or by invoking set. |
|
10511 <p>The writeOnce attribute can also be set to the string "initOnly", |
|
10512 in which case the attribute can only be set during initialization |
|
10513 (when used with Base, this means it can only be set during construction)</p> |
|
10514 </dd> |
|
10515 |
|
10516 <dt>setter <Function | String></dt> |
|
10517 <dd> |
|
10518 <p>The setter function used to massage or normalize the value passed to the set method for the attribute. |
|
10519 The value returned by the setter will be the final stored value. Returning |
|
10520 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent |
|
10521 the value from being stored. |
|
10522 </p> |
|
10523 |
|
10524 <p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> |
|
10525 </dd> |
|
10526 |
|
10527 <dt>getter <Function | String></dt> |
|
10528 <dd> |
|
10529 <p> |
|
10530 The getter function used to massage or normalize the value returned by the get method for the attribute. |
|
10531 The value returned by the getter function is the value which will be returned to the user when they |
|
10532 invoke get. |
|
10533 </p> |
|
10534 |
|
10535 <p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> |
|
10536 </dd> |
|
10537 |
|
10538 <dt>validator <Function | String></dt> |
|
10539 <dd> |
|
10540 <p> |
|
10541 The validator function invoked prior to setting the stored value. Returning |
|
10542 false from the validator function will prevent the value from being stored. |
|
10543 </p> |
|
10544 |
|
10545 <p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> |
|
10546 </dd> |
|
10547 |
|
10548 <dt>lazyAdd <boolean></dt> |
|
10549 <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. |
|
10550 This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through |
|
10551 the <a href="#method_addAttrs">addAttrs</a> method.</dd> |
|
10552 |
|
10553 </dl> |
|
10554 |
|
10555 <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with |
|
10556 the context ("this") set to the host object.</p> |
|
10557 |
|
10558 <p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, |
|
10559 and are not intended for public use.</p> |
|
10560 </div> |
|
10561 |
|
10562 |
|
10563 <div class="params"> |
|
10564 <h4>Parameters:</h4> |
|
10565 |
|
10566 <ul class="params-list"> |
|
10567 |
|
10568 <li class="param"> |
|
10569 |
|
10570 <code class="param-name">name</code> |
|
10571 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10572 |
|
10573 |
|
10574 |
|
10575 |
|
10576 <div class="param-description"> |
|
10577 <p>The name of the attribute.</p> |
|
10578 </div> |
|
10579 |
|
10580 |
|
10581 </li> |
|
10582 |
|
10583 <li class="param"> |
|
10584 |
|
10585 <code class="param-name">config</code> |
|
10586 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10587 |
|
10588 |
|
10589 |
|
10590 |
|
10591 <div class="param-description"> |
|
10592 <p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p> |
|
10593 |
|
10594 <p> |
|
10595 <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need |
|
10596 to protect the original values, you will need to merge the object. |
|
10597 </p> |
|
10598 </div> |
|
10599 |
|
10600 |
|
10601 </li> |
|
10602 |
|
10603 <li class="param"> |
|
10604 |
|
10605 <code class="param-name">lazy</code> |
|
10606 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
10607 |
|
10608 |
|
10609 |
|
10610 |
|
10611 <div class="param-description"> |
|
10612 <p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p> |
|
10613 </div> |
|
10614 |
|
10615 |
|
10616 </li> |
|
10617 |
|
10618 </ul> |
|
10619 </div> |
|
10620 |
|
10621 |
|
10622 |
|
10623 <div class="returns"> |
|
10624 <h4>Returns:</h4> |
|
10625 |
|
10626 <div class="returns-description"> |
|
10627 |
|
10628 |
|
10629 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10630 |
|
10631 A reference to the host object. |
|
10632 |
|
10633 </div> |
|
10634 </div> |
|
10635 |
|
10636 |
|
10637 |
|
10638 </div> |
|
10639 |
|
10640 |
|
10641 <div id="method_addAttrs" class="method item inherited"> |
|
10642 <h3 class="name"><code>addAttrs</code></h3> |
|
10643 |
|
10644 |
|
10645 <div class="args"> |
|
10646 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10647 |
|
10648 <li class="arg"> |
|
10649 |
|
10650 <code>cfgs</code> |
|
10651 |
|
10652 </li> |
|
10653 |
|
10654 <li class="arg"> |
|
10655 |
|
10656 <code>values</code> |
|
10657 |
|
10658 </li> |
|
10659 |
|
10660 <li class="arg"> |
|
10661 |
|
10662 <code>lazy</code> |
|
10663 |
|
10664 </li> |
|
10665 |
|
10666 </ul><span class="paren">)</span> |
|
10667 </div> |
|
10668 |
|
10669 |
|
10670 |
|
10671 <span class="returns-inline"> |
|
10672 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10673 </span> |
|
10674 |
|
10675 |
|
10676 |
|
10677 |
|
10678 |
|
10679 |
|
10680 |
|
10681 |
|
10682 |
|
10683 |
|
10684 |
|
10685 <span class="flag chainable">chainable</span> |
|
10686 |
|
10687 |
|
10688 |
|
10689 |
|
10690 <div class="meta"> |
|
10691 |
|
10692 |
|
10693 <p>Inherited from |
|
10694 <a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>: |
|
10695 |
|
10696 |
|
10697 |
|
10698 <a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a> |
|
10699 |
|
10700 </p> |
|
10701 |
|
10702 |
|
10703 |
|
10704 |
|
10705 |
|
10706 </div> |
|
10707 |
|
10708 <div class="description"> |
|
10709 <p>Configures a group of attributes, and sets initial values.</p> |
|
10710 |
|
10711 <p> |
|
10712 <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. |
|
10713 The caller is responsible for merging/cloning the configuration object if required. |
|
10714 </p> |
|
10715 </div> |
|
10716 |
|
10717 |
|
10718 <div class="params"> |
|
10719 <h4>Parameters:</h4> |
|
10720 |
|
10721 <ul class="params-list"> |
|
10722 |
|
10723 <li class="param"> |
|
10724 |
|
10725 <code class="param-name">cfgs</code> |
|
10726 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10727 |
|
10728 |
|
10729 |
|
10730 |
|
10731 <div class="param-description"> |
|
10732 <p>An object with attribute name/configuration pairs.</p> |
|
10733 </div> |
|
10734 |
|
10735 |
|
10736 </li> |
|
10737 |
|
10738 <li class="param"> |
|
10739 |
|
10740 <code class="param-name">values</code> |
|
10741 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10742 |
|
10743 |
|
10744 |
|
10745 |
|
10746 <div class="param-description"> |
|
10747 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
10748 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
10749 </div> |
|
10750 |
|
10751 |
|
10752 </li> |
|
10753 |
|
10754 <li class="param"> |
|
10755 |
|
10756 <code class="param-name">lazy</code> |
|
10757 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
10758 |
|
10759 |
|
10760 |
|
10761 |
|
10762 <div class="param-description"> |
|
10763 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
10764 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
10765 See <a href="#method_addAttr">addAttr</a>.</p> |
|
10766 </div> |
|
10767 |
|
10768 |
|
10769 </li> |
|
10770 |
|
10771 </ul> |
|
10772 </div> |
|
10773 |
|
10774 |
|
10775 |
|
10776 <div class="returns"> |
|
10777 <h4>Returns:</h4> |
|
10778 |
|
10779 <div class="returns-description"> |
|
10780 |
|
10781 |
|
10782 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10783 |
|
10784 A reference to the host object. |
|
10785 |
|
10786 </div> |
|
10787 </div> |
|
10788 |
|
10789 |
|
10790 |
|
10791 </div> |
|
10792 |
|
10793 |
|
10794 <div id="method_addTarget" class="method item inherited"> |
|
10795 <h3 class="name"><code>addTarget</code></h3> |
|
10796 |
|
10797 |
|
10798 <div class="args"> |
|
10799 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10800 |
|
10801 <li class="arg"> |
|
10802 |
|
10803 <code>o</code> |
|
10804 |
|
10805 </li> |
|
10806 |
|
10807 </ul><span class="paren">)</span> |
|
10808 </div> |
|
10809 |
|
10810 |
|
10811 |
|
10812 |
|
10813 |
|
10814 |
|
10815 |
|
10816 |
|
10817 |
|
10818 |
|
10819 |
|
10820 |
|
10821 |
|
10822 |
|
10823 |
|
10824 |
|
10825 <div class="meta"> |
|
10826 |
|
10827 |
|
10828 <p>Inherited from |
|
10829 <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>: |
|
10830 |
|
10831 |
|
10832 |
|
10833 <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a> |
|
10834 |
|
10835 </p> |
|
10836 |
|
10837 |
|
10838 |
|
10839 |
|
10840 |
|
10841 </div> |
|
10842 |
|
10843 <div class="description"> |
|
10844 <p>Registers another EventTarget as a bubble target. Bubble order |
|
10845 is determined by the order registered. Multiple targets can |
|
10846 be specified.</p> |
|
10847 |
|
10848 <p>Events can only bubble if emitFacade is true.</p> |
|
10849 |
|
10850 <p>Included in the event-custom-complex submodule.</p> |
|
10851 </div> |
|
10852 |
|
10853 |
|
10854 <div class="params"> |
|
10855 <h4>Parameters:</h4> |
|
10856 |
|
10857 <ul class="params-list"> |
|
10858 |
|
10859 <li class="param"> |
|
10860 |
|
10861 <code class="param-name">o</code> |
|
10862 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
10863 |
|
10864 |
|
10865 |
|
10866 |
|
10867 <div class="param-description"> |
|
10868 <p>the target to add</p> |
|
10869 </div> |
|
10870 |
|
10871 |
|
10872 </li> |
|
10873 |
|
10874 </ul> |
|
10875 </div> |
|
10876 |
|
10877 |
|
10878 |
|
10879 |
|
10880 |
|
10881 </div> |
|
10882 |
|
10883 |
|
10884 <div id="method_after" class="method item inherited"> |
|
10885 <h3 class="name"><code>after</code></h3> |
|
10886 |
|
10887 |
|
10888 <div class="args"> |
|
10889 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10890 |
|
10891 <li class="arg"> |
|
10892 |
|
10893 <code>type</code> |
|
10894 |
|
10895 </li> |
|
10896 |
|
10897 <li class="arg"> |
|
10898 |
|
10899 <code>fn</code> |
|
10900 |
|
10901 </li> |
|
10902 |
|
10903 <li class="arg"> |
|
10904 |
|
10905 <code class="optional">[context]</code> |
|
10906 |
|
10907 </li> |
|
10908 |
|
10909 <li class="arg"> |
|
10910 |
|
10911 <code class="optional">[arg*]</code> |
|
10912 |
|
10913 </li> |
|
10914 |
|
10915 </ul><span class="paren">)</span> |
|
10916 </div> |
|
10917 |
|
10918 |
|
10919 |
|
10920 <span class="returns-inline"> |
|
10921 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
10922 </span> |
|
10923 |
|
10924 |
|
10925 |
|
10926 |
|
10927 |
|
10928 |
|
10929 |
|
10930 |
|
10931 |
|
10932 |
|
10933 |
|
10934 |
|
10935 |
|
10936 |
|
10937 <div class="meta"> |
|
10938 |
|
10939 |
|
10940 <p>Inherited from |
|
10941 <a href="../classes/EventTarget.html#method_after">EventTarget</a>: |
|
10942 |
|
10943 |
|
10944 |
|
10945 <a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a> |
|
10946 |
|
10947 </p> |
|
10948 |
|
10949 |
|
10950 |
|
10951 |
|
10952 |
|
10953 </div> |
|
10954 |
|
10955 <div class="description"> |
|
10956 <p>Subscribe to a custom event hosted by this object. The |
|
10957 supplied callback will execute after any listeners add |
|
10958 via the subscribe method, and after the default function, |
|
10959 if configured for the event, has executed.</p> |
|
10960 </div> |
|
10961 |
|
10962 |
|
10963 <div class="params"> |
|
10964 <h4>Parameters:</h4> |
|
10965 |
|
10966 <ul class="params-list"> |
|
10967 |
|
10968 <li class="param"> |
|
10969 |
|
10970 <code class="param-name">type</code> |
|
10971 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10972 |
|
10973 |
|
10974 |
|
10975 |
|
10976 <div class="param-description"> |
|
10977 <p>The name of the event</p> |
|
10978 </div> |
|
10979 |
|
10980 |
|
10981 </li> |
|
10982 |
|
10983 <li class="param"> |
|
10984 |
|
10985 <code class="param-name">fn</code> |
|
10986 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
10987 |
|
10988 |
|
10989 |
|
10990 |
|
10991 <div class="param-description"> |
|
10992 <p>The callback to execute in response to the event</p> |
|
10993 </div> |
|
10994 |
|
10995 |
|
10996 </li> |
|
10997 |
|
10998 <li class="param"> |
|
10999 |
|
11000 <code class="param-name optional">[context]</code> |
|
11001 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11002 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11003 |
|
11004 |
|
11005 |
|
11006 |
|
11007 <div class="param-description"> |
|
11008 <p>Override <code>this</code> object in callback</p> |
|
11009 </div> |
|
11010 |
|
11011 |
|
11012 </li> |
|
11013 |
|
11014 <li class="param"> |
|
11015 |
|
11016 <code class="param-name optional">[arg*]</code> |
|
11017 <span class="type">Any</span> |
|
11018 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11019 |
|
11020 |
|
11021 |
|
11022 |
|
11023 <div class="param-description"> |
|
11024 <p>0..n additional arguments to supply to the subscriber</p> |
|
11025 </div> |
|
11026 |
|
11027 |
|
11028 </li> |
|
11029 |
|
11030 </ul> |
|
11031 </div> |
|
11032 |
|
11033 |
|
11034 |
|
11035 <div class="returns"> |
|
11036 <h4>Returns:</h4> |
|
11037 |
|
11038 <div class="returns-description"> |
|
11039 |
|
11040 |
|
11041 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
11042 |
|
11043 A subscription handle capable of detaching the |
|
11044 subscription |
|
11045 |
|
11046 </div> |
|
11047 </div> |
|
11048 |
|
11049 |
|
11050 |
|
11051 </div> |
|
11052 |
|
11053 |
|
11054 <div id="method_attrAdded" class="method item inherited"> |
|
11055 <h3 class="name"><code>attrAdded</code></h3> |
|
11056 |
|
11057 |
|
11058 <div class="args"> |
|
11059 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11060 |
|
11061 <li class="arg"> |
|
11062 |
|
11063 <code>name</code> |
|
11064 |
|
11065 </li> |
|
11066 |
|
11067 </ul><span class="paren">)</span> |
|
11068 </div> |
|
11069 |
|
11070 |
|
11071 |
|
11072 <span class="returns-inline"> |
|
11073 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11074 </span> |
|
11075 |
|
11076 |
|
11077 |
|
11078 |
|
11079 |
|
11080 |
|
11081 |
|
11082 |
|
11083 |
|
11084 |
|
11085 |
|
11086 |
|
11087 |
|
11088 |
|
11089 <div class="meta"> |
|
11090 |
|
11091 |
|
11092 <p>Inherited from |
|
11093 <a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>: |
|
11094 |
|
11095 |
|
11096 |
|
11097 <a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a> |
|
11098 |
|
11099 </p> |
|
11100 |
|
11101 |
|
11102 |
|
11103 |
|
11104 |
|
11105 </div> |
|
11106 |
|
11107 <div class="description"> |
|
11108 <p>Checks if the given attribute has been added to the host</p> |
|
11109 </div> |
|
11110 |
|
11111 |
|
11112 <div class="params"> |
|
11113 <h4>Parameters:</h4> |
|
11114 |
|
11115 <ul class="params-list"> |
|
11116 |
|
11117 <li class="param"> |
|
11118 |
|
11119 <code class="param-name">name</code> |
|
11120 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11121 |
|
11122 |
|
11123 |
|
11124 |
|
11125 <div class="param-description"> |
|
11126 <p>The name of the attribute to check.</p> |
|
11127 </div> |
|
11128 |
|
11129 |
|
11130 </li> |
|
11131 |
|
11132 </ul> |
|
11133 </div> |
|
11134 |
|
11135 |
|
11136 |
|
11137 <div class="returns"> |
|
11138 <h4>Returns:</h4> |
|
11139 |
|
11140 <div class="returns-description"> |
|
11141 |
|
11142 |
|
11143 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
11144 |
|
11145 true if an attribute with the given name has been added, false if it hasn't. |
|
11146 This method will return true for lazily added attributes. |
|
11147 |
|
11148 </div> |
|
11149 </div> |
|
11150 |
|
11151 |
|
11152 |
|
11153 </div> |
|
11154 |
|
11155 |
|
11156 <div id="method_before" class="method item inherited"> |
|
11157 <h3 class="name"><code>before</code></h3> |
|
11158 |
|
11159 |
|
11160 <span class="paren">()</span> |
|
11161 |
|
11162 |
|
11163 |
|
11164 <span class="returns-inline"> |
|
11165 <span class="type"></span> |
|
11166 </span> |
|
11167 |
|
11168 |
|
11169 |
|
11170 |
|
11171 |
|
11172 |
|
11173 |
|
11174 |
|
11175 |
|
11176 |
|
11177 |
|
11178 |
|
11179 |
|
11180 |
|
11181 <div class="meta"> |
|
11182 |
|
11183 |
|
11184 <p>Inherited from |
|
11185 <a href="../classes/EventTarget.html#method_before">EventTarget</a>: |
|
11186 |
|
11187 |
|
11188 |
|
11189 <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a> |
|
11190 |
|
11191 </p> |
|
11192 |
|
11193 |
|
11194 |
|
11195 |
|
11196 |
|
11197 </div> |
|
11198 |
|
11199 <div class="description"> |
|
11200 <p>Executes the callback before a DOM event, custom event |
|
11201 or method. If the first argument is a function, it |
|
11202 is assumed the target is a method. For DOM and custom |
|
11203 events, this is an alias for Y.on.</p> |
|
11204 |
|
11205 <p>For DOM and custom events: |
|
11206 type, callback, context, 0-n arguments</p> |
|
11207 |
|
11208 <p>For methods: |
|
11209 callback, object (method host), methodName, context, 0-n arguments</p> |
|
11210 </div> |
|
11211 |
|
11212 |
|
11213 |
|
11214 |
|
11215 <div class="returns"> |
|
11216 <h4>Returns:</h4> |
|
11217 |
|
11218 <div class="returns-description"> |
|
11219 |
|
11220 |
|
11221 detach handle |
|
11222 |
|
11223 </div> |
|
11224 </div> |
|
11225 |
|
11226 |
|
11227 |
|
11228 </div> |
|
11229 |
|
11230 |
|
11231 <div id="method_bubble" class="method item inherited"> |
|
11232 <h3 class="name"><code>bubble</code></h3> |
|
11233 |
|
11234 |
|
11235 <div class="args"> |
|
11236 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11237 |
|
11238 <li class="arg"> |
|
11239 |
|
11240 <code>evt</code> |
|
11241 |
|
11242 </li> |
|
11243 |
|
11244 </ul><span class="paren">)</span> |
|
11245 </div> |
|
11246 |
|
11247 |
|
11248 |
|
11249 <span class="returns-inline"> |
|
11250 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11251 </span> |
|
11252 |
|
11253 |
|
11254 |
|
11255 |
|
11256 |
|
11257 |
|
11258 |
|
11259 |
|
11260 |
|
11261 |
|
11262 |
|
11263 |
|
11264 |
|
11265 |
|
11266 <div class="meta"> |
|
11267 |
|
11268 |
|
11269 <p>Inherited from |
|
11270 <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>: |
|
11271 |
|
11272 |
|
11273 |
|
11274 <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a> |
|
11275 |
|
11276 </p> |
|
11277 |
|
11278 |
|
11279 |
|
11280 |
|
11281 |
|
11282 </div> |
|
11283 |
|
11284 <div class="description"> |
|
11285 <p>Propagate an event. Requires the event-custom-complex module.</p> |
|
11286 </div> |
|
11287 |
|
11288 |
|
11289 <div class="params"> |
|
11290 <h4>Parameters:</h4> |
|
11291 |
|
11292 <ul class="params-list"> |
|
11293 |
|
11294 <li class="param"> |
|
11295 |
|
11296 <code class="param-name">evt</code> |
|
11297 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
11298 |
|
11299 |
|
11300 |
|
11301 |
|
11302 <div class="param-description"> |
|
11303 <p>the custom event to propagate</p> |
|
11304 </div> |
|
11305 |
|
11306 |
|
11307 </li> |
|
11308 |
|
11309 </ul> |
|
11310 </div> |
|
11311 |
|
11312 |
|
11313 |
|
11314 <div class="returns"> |
|
11315 <h4>Returns:</h4> |
|
11316 |
|
11317 <div class="returns-description"> |
|
11318 |
|
11319 |
|
11320 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
11321 |
|
11322 the aggregated return value from Event.Custom.fire |
|
11323 |
|
11324 </div> |
|
11325 </div> |
|
11326 |
|
11327 |
|
11328 |
|
11329 </div> |
|
11330 |
|
11331 |
|
11332 <div id="method_destroy" class="method item inherited"> |
|
11333 <h3 class="name"><code>destroy</code></h3> |
|
11334 |
|
11335 |
|
11336 <span class="paren">()</span> |
|
11337 |
|
11338 |
|
11339 |
|
11340 <span class="returns-inline"> |
|
11341 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span> |
|
11342 </span> |
|
11343 |
|
11344 |
|
11345 |
|
11346 |
|
11347 |
|
11348 |
|
11349 |
|
11350 |
|
11351 |
|
11352 |
|
11353 |
|
11354 <span class="flag chainable">chainable</span> |
|
11355 |
|
11356 |
|
11357 |
|
11358 |
|
11359 <div class="meta"> |
|
11360 |
|
11361 <p>Inherited from |
|
11362 <a href="../classes/BaseObservable.html#method_destroy"> |
|
11363 BaseObservable |
|
11364 </a> |
|
11365 |
|
11366 but overwritten in |
|
11367 |
|
11368 |
|
11369 |
|
11370 <a href="../files/base_js_BaseCore.js.html#l297"><code>base/js/BaseCore.js:297</code></a> |
|
11371 |
|
11372 </p> |
|
11373 |
|
11374 |
|
11375 |
|
11376 |
|
11377 |
|
11378 </div> |
|
11379 |
|
11380 <div class="description"> |
|
11381 <p>Destroy lifecycle method. Invokes destructors for the class hierarchy.</p> |
|
11382 </div> |
|
11383 |
|
11384 |
|
11385 |
|
11386 |
|
11387 <div class="returns"> |
|
11388 <h4>Returns:</h4> |
|
11389 |
|
11390 <div class="returns-description"> |
|
11391 |
|
11392 |
|
11393 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>: |
|
11394 |
|
11395 A reference to this object |
|
11396 |
|
11397 </div> |
|
11398 </div> |
|
11399 |
|
11400 |
|
11401 |
|
11402 </div> |
|
11403 |
|
11404 |
|
11405 <div id="method_detach" class="method item inherited"> |
|
11406 <h3 class="name"><code>detach</code></h3> |
|
11407 |
|
11408 |
|
11409 <div class="args"> |
|
11410 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11411 |
|
11412 <li class="arg"> |
|
11413 |
|
11414 <code>type</code> |
|
11415 |
|
11416 </li> |
|
11417 |
|
11418 <li class="arg"> |
|
11419 |
|
11420 <code>fn</code> |
|
11421 |
|
11422 </li> |
|
11423 |
|
11424 <li class="arg"> |
|
11425 |
|
11426 <code>context</code> |
|
11427 |
|
11428 </li> |
|
11429 |
|
11430 </ul><span class="paren">)</span> |
|
11431 </div> |
|
11432 |
|
11433 |
|
11434 |
|
11435 <span class="returns-inline"> |
|
11436 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
11437 </span> |
|
11438 |
|
11439 |
|
11440 |
|
11441 |
|
11442 |
|
11443 |
|
11444 |
|
11445 |
|
11446 |
|
11447 |
|
11448 |
|
11449 |
|
11450 |
|
11451 |
|
11452 <div class="meta"> |
|
11453 |
|
11454 |
|
11455 <p>Inherited from |
|
11456 <a href="../classes/EventTarget.html#method_detach">EventTarget</a>: |
|
11457 |
|
11458 |
|
11459 |
|
11460 <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a> |
|
11461 |
|
11462 </p> |
|
11463 |
|
11464 |
|
11465 |
|
11466 |
|
11467 |
|
11468 </div> |
|
11469 |
|
11470 <div class="description"> |
|
11471 <p>Detach one or more listeners the from the specified event</p> |
|
11472 </div> |
|
11473 |
|
11474 |
|
11475 <div class="params"> |
|
11476 <h4>Parameters:</h4> |
|
11477 |
|
11478 <ul class="params-list"> |
|
11479 |
|
11480 <li class="param"> |
|
11481 |
|
11482 <code class="param-name">type</code> |
|
11483 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11484 |
|
11485 |
|
11486 |
|
11487 |
|
11488 <div class="param-description"> |
|
11489 <p>Either the handle to the subscriber or the |
|
11490 type of event. If the type |
|
11491 is not specified, it will attempt to remove |
|
11492 the listener from all hosted events.</p> |
|
11493 </div> |
|
11494 |
|
11495 |
|
11496 </li> |
|
11497 |
|
11498 <li class="param"> |
|
11499 |
|
11500 <code class="param-name">fn</code> |
|
11501 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
11502 |
|
11503 |
|
11504 |
|
11505 |
|
11506 <div class="param-description"> |
|
11507 <p>The subscribed function to unsubscribe, if not |
|
11508 supplied, all subscribers will be removed.</p> |
|
11509 </div> |
|
11510 |
|
11511 |
|
11512 </li> |
|
11513 |
|
11514 <li class="param"> |
|
11515 |
|
11516 <code class="param-name">context</code> |
|
11517 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11518 |
|
11519 |
|
11520 |
|
11521 |
|
11522 <div class="param-description"> |
|
11523 <p>The custom object passed to subscribe. This is |
|
11524 optional, but if supplied will be used to |
|
11525 disambiguate multiple listeners that are the same |
|
11526 (e.g., you subscribe many object using a function |
|
11527 that lives on the prototype)</p> |
|
11528 </div> |
|
11529 |
|
11530 |
|
11531 </li> |
|
11532 |
|
11533 </ul> |
|
11534 </div> |
|
11535 |
|
11536 |
|
11537 |
|
11538 <div class="returns"> |
|
11539 <h4>Returns:</h4> |
|
11540 |
|
11541 <div class="returns-description"> |
|
11542 |
|
11543 |
|
11544 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
11545 |
|
11546 the host |
|
11547 |
|
11548 </div> |
|
11549 </div> |
|
11550 |
|
11551 |
|
11552 |
|
11553 </div> |
|
11554 |
|
11555 |
|
11556 <div id="method_detachAll" class="method item inherited"> |
|
11557 <h3 class="name"><code>detachAll</code></h3> |
|
11558 |
|
11559 |
|
11560 <div class="args"> |
|
11561 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11562 |
|
11563 <li class="arg"> |
|
11564 |
|
11565 <code>type</code> |
|
11566 |
|
11567 </li> |
|
11568 |
|
11569 </ul><span class="paren">)</span> |
|
11570 </div> |
|
11571 |
|
11572 |
|
11573 |
|
11574 |
|
11575 |
|
11576 |
|
11577 |
|
11578 |
|
11579 |
|
11580 |
|
11581 |
|
11582 |
|
11583 |
|
11584 |
|
11585 |
|
11586 |
|
11587 <div class="meta"> |
|
11588 |
|
11589 |
|
11590 <p>Inherited from |
|
11591 <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>: |
|
11592 |
|
11593 |
|
11594 |
|
11595 <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a> |
|
11596 |
|
11597 </p> |
|
11598 |
|
11599 |
|
11600 |
|
11601 |
|
11602 |
|
11603 </div> |
|
11604 |
|
11605 <div class="description"> |
|
11606 <p>Removes all listeners from the specified event. If the event type |
|
11607 is not specified, all listeners from all hosted custom events will |
|
11608 be removed.</p> |
|
11609 </div> |
|
11610 |
|
11611 |
|
11612 <div class="params"> |
|
11613 <h4>Parameters:</h4> |
|
11614 |
|
11615 <ul class="params-list"> |
|
11616 |
|
11617 <li class="param"> |
|
11618 |
|
11619 <code class="param-name">type</code> |
|
11620 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11621 |
|
11622 |
|
11623 |
|
11624 |
|
11625 <div class="param-description"> |
|
11626 <p>The type, or name of the event</p> |
|
11627 </div> |
|
11628 |
|
11629 |
|
11630 </li> |
|
11631 |
|
11632 </ul> |
|
11633 </div> |
|
11634 |
|
11635 |
|
11636 |
|
11637 |
|
11638 |
|
11639 </div> |
|
11640 |
|
11641 |
|
11642 <div id="method_dispatch" class="method item inherited"> |
|
11643 <h3 class="name"><code>dispatch</code></h3> |
|
11644 |
|
11645 |
|
11646 <span class="paren">()</span> |
|
11647 |
|
11648 |
|
11649 |
|
11650 |
|
11651 |
|
11652 |
|
11653 |
|
11654 |
|
11655 |
|
11656 |
|
11657 |
|
11658 |
|
11659 |
|
11660 <span class="flag chainable">chainable</span> |
|
11661 |
|
11662 |
|
11663 |
|
11664 |
|
11665 <div class="meta"> |
|
11666 |
|
11667 |
|
11668 <p>Inherited from |
|
11669 <a href="../classes/Router.html#method_dispatch">Router</a>: |
|
11670 |
|
11671 |
|
11672 |
|
11673 <a href="../files/app_js_router.js.html#l206"><code>app/js/router.js:206</code></a> |
|
11674 |
|
11675 </p> |
|
11676 |
|
11677 |
|
11678 |
|
11679 |
|
11680 |
|
11681 </div> |
|
11682 |
|
11683 <div class="description"> |
|
11684 <p>Dispatches to the first route handler that matches the current URL, if any.</p> |
|
11685 |
|
11686 <p>If <code>dispatch()</code> is called before the <code>ready</code> event has fired, it will |
|
11687 automatically wait for the <code>ready</code> event before dispatching. Otherwise it |
|
11688 will dispatch immediately.</p> |
|
11689 </div> |
|
11690 |
|
11691 |
|
11692 |
|
11693 |
|
11694 |
|
11695 |
|
11696 </div> |
|
11697 |
|
11698 |
|
11699 <div id="method_fire" class="method item inherited"> |
|
11700 <h3 class="name"><code>fire</code></h3> |
|
11701 |
|
11702 |
|
11703 <div class="args"> |
|
11704 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11705 |
|
11706 <li class="arg"> |
|
11707 |
|
11708 <code>type</code> |
|
11709 |
|
11710 </li> |
|
11711 |
|
11712 <li class="arg"> |
|
11713 |
|
11714 <code>arguments</code> |
|
11715 |
|
11716 </li> |
|
11717 |
|
11718 </ul><span class="paren">)</span> |
|
11719 </div> |
|
11720 |
|
11721 |
|
11722 |
|
11723 <span class="returns-inline"> |
|
11724 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
11725 </span> |
|
11726 |
|
11727 |
|
11728 |
|
11729 |
|
11730 |
|
11731 |
|
11732 |
|
11733 |
|
11734 |
|
11735 |
|
11736 |
|
11737 |
|
11738 |
|
11739 |
|
11740 <div class="meta"> |
|
11741 |
|
11742 |
|
11743 <p>Inherited from |
|
11744 <a href="../classes/EventTarget.html#method_fire">EventTarget</a>: |
|
11745 |
|
11746 |
|
11747 |
|
11748 <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a> |
|
11749 |
|
11750 </p> |
|
11751 |
|
11752 |
|
11753 |
|
11754 |
|
11755 |
|
11756 </div> |
|
11757 |
|
11758 <div class="description"> |
|
11759 <p>Fire a custom event by name. The callback functions will be executed |
|
11760 from the context specified when the event was created, and with the |
|
11761 following parameters.</p> |
|
11762 |
|
11763 <p>If the custom event object hasn't been created, then the event hasn't |
|
11764 been published and it has no subscribers. For performance sake, we |
|
11765 immediate exit in this case. This means the event won't bubble, so |
|
11766 if the intention is that a bubble target be notified, the event must |
|
11767 be published on this object first.</p> |
|
11768 |
|
11769 <p>The first argument is the event type, and any additional arguments are |
|
11770 passed to the listeners as parameters. If the first of these is an |
|
11771 object literal, and the event is configured to emit an event facade, |
|
11772 that object is mixed into the event facade and the facade is provided |
|
11773 in place of the original object.</p> |
|
11774 </div> |
|
11775 |
|
11776 |
|
11777 <div class="params"> |
|
11778 <h4>Parameters:</h4> |
|
11779 |
|
11780 <ul class="params-list"> |
|
11781 |
|
11782 <li class="param"> |
|
11783 |
|
11784 <code class="param-name">type</code> |
|
11785 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11786 |
|
11787 |
|
11788 |
|
11789 |
|
11790 <div class="param-description"> |
|
11791 <p>The type of the event, or an object that contains |
|
11792 a 'type' property.</p> |
|
11793 </div> |
|
11794 |
|
11795 |
|
11796 </li> |
|
11797 |
|
11798 <li class="param"> |
|
11799 |
|
11800 <code class="param-name">arguments</code> |
|
11801 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span> |
|
11802 |
|
11803 |
|
11804 |
|
11805 |
|
11806 <div class="param-description"> |
|
11807 <p>an arbitrary set of parameters to pass to |
|
11808 the handler. If the first of these is an object literal and the event is |
|
11809 configured to emit an event facade, the event facade will replace that |
|
11810 parameter after the properties the object literal contains are copied to |
|
11811 the event facade.</p> |
|
11812 </div> |
|
11813 |
|
11814 |
|
11815 </li> |
|
11816 |
|
11817 </ul> |
|
11818 </div> |
|
11819 |
|
11820 |
|
11821 |
|
11822 <div class="returns"> |
|
11823 <h4>Returns:</h4> |
|
11824 |
|
11825 <div class="returns-description"> |
|
11826 |
|
11827 |
|
11828 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
11829 |
|
11830 the event host |
|
11831 |
|
11832 </div> |
|
11833 </div> |
|
11834 |
|
11835 |
|
11836 |
|
11837 </div> |
|
11838 |
|
11839 |
|
11840 <div id="method_get" class="method item inherited"> |
|
11841 <h3 class="name"><code>get</code></h3> |
|
11842 |
|
11843 |
|
11844 <div class="args"> |
|
11845 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11846 |
|
11847 <li class="arg"> |
|
11848 |
|
11849 <code>name</code> |
|
11850 |
|
11851 </li> |
|
11852 |
|
11853 </ul><span class="paren">)</span> |
|
11854 </div> |
|
11855 |
|
11856 |
|
11857 |
|
11858 <span class="returns-inline"> |
|
11859 <span class="type">Any</span> |
|
11860 </span> |
|
11861 |
|
11862 |
|
11863 |
|
11864 |
|
11865 |
|
11866 |
|
11867 |
|
11868 |
|
11869 |
|
11870 |
|
11871 |
|
11872 |
|
11873 |
|
11874 |
|
11875 <div class="meta"> |
|
11876 |
|
11877 |
|
11878 <p>Inherited from |
|
11879 <a href="../classes/AttributeCore.html#method_get">AttributeCore</a>: |
|
11880 |
|
11881 |
|
11882 |
|
11883 <a href="../files/attribute_js_AttributeCore.js.html#l353"><code>attribute/js/AttributeCore.js:353</code></a> |
|
11884 |
|
11885 </p> |
|
11886 |
|
11887 |
|
11888 |
|
11889 |
|
11890 |
|
11891 </div> |
|
11892 |
|
11893 <div class="description"> |
|
11894 <p>Returns the current value of the attribute. If the attribute |
|
11895 has been configured with a 'getter' function, this method will delegate |
|
11896 to the 'getter' to obtain the value of the attribute.</p> |
|
11897 </div> |
|
11898 |
|
11899 |
|
11900 <div class="params"> |
|
11901 <h4>Parameters:</h4> |
|
11902 |
|
11903 <ul class="params-list"> |
|
11904 |
|
11905 <li class="param"> |
|
11906 |
|
11907 <code class="param-name">name</code> |
|
11908 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11909 |
|
11910 |
|
11911 |
|
11912 |
|
11913 <div class="param-description"> |
|
11914 <p>The name of the attribute. If the value of the attribute is an Object, |
|
11915 dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p> |
|
11916 </div> |
|
11917 |
|
11918 |
|
11919 </li> |
|
11920 |
|
11921 </ul> |
|
11922 </div> |
|
11923 |
|
11924 |
|
11925 |
|
11926 <div class="returns"> |
|
11927 <h4>Returns:</h4> |
|
11928 |
|
11929 <div class="returns-description"> |
|
11930 |
|
11931 |
|
11932 <span class="type">Any</span>: |
|
11933 |
|
11934 The value of the attribute |
|
11935 |
|
11936 </div> |
|
11937 </div> |
|
11938 |
|
11939 |
|
11940 |
|
11941 </div> |
|
11942 |
|
11943 |
|
11944 <div id="method_getAttrs" class="method item inherited"> |
|
11945 <h3 class="name"><code>getAttrs</code></h3> |
|
11946 |
|
11947 |
|
11948 <div class="args"> |
|
11949 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11950 |
|
11951 <li class="arg"> |
|
11952 |
|
11953 <code>attrs</code> |
|
11954 |
|
11955 </li> |
|
11956 |
|
11957 </ul><span class="paren">)</span> |
|
11958 </div> |
|
11959 |
|
11960 |
|
11961 |
|
11962 <span class="returns-inline"> |
|
11963 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11964 </span> |
|
11965 |
|
11966 |
|
11967 |
|
11968 |
|
11969 |
|
11970 |
|
11971 |
|
11972 |
|
11973 |
|
11974 |
|
11975 |
|
11976 |
|
11977 |
|
11978 |
|
11979 <div class="meta"> |
|
11980 |
|
11981 |
|
11982 <p>Inherited from |
|
11983 <a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>: |
|
11984 |
|
11985 |
|
11986 |
|
11987 <a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a> |
|
11988 |
|
11989 </p> |
|
11990 |
|
11991 |
|
11992 |
|
11993 |
|
11994 |
|
11995 </div> |
|
11996 |
|
11997 <div class="description"> |
|
11998 <p>Gets multiple attribute values.</p> |
|
11999 </div> |
|
12000 |
|
12001 |
|
12002 <div class="params"> |
|
12003 <h4>Parameters:</h4> |
|
12004 |
|
12005 <ul class="params-list"> |
|
12006 |
|
12007 <li class="param"> |
|
12008 |
|
12009 <code class="param-name">attrs</code> |
|
12010 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
12011 |
|
12012 |
|
12013 |
|
12014 |
|
12015 <div class="param-description"> |
|
12016 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
12017 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
12018 </div> |
|
12019 |
|
12020 |
|
12021 </li> |
|
12022 |
|
12023 </ul> |
|
12024 </div> |
|
12025 |
|
12026 |
|
12027 |
|
12028 <div class="returns"> |
|
12029 <h4>Returns:</h4> |
|
12030 |
|
12031 <div class="returns-description"> |
|
12032 |
|
12033 |
|
12034 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
12035 |
|
12036 An object with attribute name/value pairs. |
|
12037 |
|
12038 </div> |
|
12039 </div> |
|
12040 |
|
12041 |
|
12042 |
|
12043 </div> |
|
12044 |
|
12045 |
|
12046 <div id="method_getContent" class="method item inherited"> |
|
12047 <h3 class="name"><code>getContent</code></h3> |
|
12048 |
|
12049 |
|
12050 <div class="args"> |
|
12051 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12052 |
|
12053 <li class="arg"> |
|
12054 |
|
12055 <code>responseText</code> |
|
12056 |
|
12057 </li> |
|
12058 |
|
12059 </ul><span class="paren">)</span> |
|
12060 </div> |
|
12061 |
|
12062 |
|
12063 |
|
12064 <span class="returns-inline"> |
|
12065 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12066 </span> |
|
12067 |
|
12068 |
|
12069 |
|
12070 |
|
12071 |
|
12072 |
|
12073 |
|
12074 |
|
12075 |
|
12076 |
|
12077 |
|
12078 |
|
12079 |
|
12080 |
|
12081 <div class="meta"> |
|
12082 |
|
12083 |
|
12084 <p>Inherited from |
|
12085 <a href="../classes/PjaxContent.html#method_getContent">PjaxContent</a>: |
|
12086 |
|
12087 |
|
12088 |
|
12089 <a href="../files/pjax_js_pjax-content.js.html#l38"><code>pjax/js/pjax-content.js:38</code></a> |
|
12090 |
|
12091 </p> |
|
12092 |
|
12093 |
|
12094 |
|
12095 |
|
12096 |
|
12097 <p>Available since 3.5.0</p> |
|
12098 |
|
12099 </div> |
|
12100 |
|
12101 <div class="description"> |
|
12102 <p>Extracts and returns the relevant HTML content from an Ajax response. The |
|
12103 content is extracted using the <code>contentSelector</code> attribute as a CSS |
|
12104 selector. If <code>contentSelector</code> is <code>null</code>, the entire response will be |
|
12105 returned.</p> |
|
12106 |
|
12107 <p>The return value is an object containing two properties:</p> |
|
12108 |
|
12109 <ul> |
|
12110 <li><p><code>node</code>: A <code>Y.Node</code> instance for a document fragment containing the |
|
12111 extracted HTML content.</p></li> |
|
12112 <li><p><code>title</code>: The title of the HTML page, if any, extracted using the |
|
12113 <code>titleSelector</code> attribute (which defaults to looking for a <code><title></code> |
|
12114 element). If <code>titleSelector</code> is not set or if a title could not be |
|
12115 found, this property will be <code>undefined</code>.</p></li> |
|
12116 </ul> |
|
12117 </div> |
|
12118 |
|
12119 |
|
12120 <div class="params"> |
|
12121 <h4>Parameters:</h4> |
|
12122 |
|
12123 <ul class="params-list"> |
|
12124 |
|
12125 <li class="param"> |
|
12126 |
|
12127 <code class="param-name">responseText</code> |
|
12128 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12129 |
|
12130 |
|
12131 |
|
12132 |
|
12133 <div class="param-description"> |
|
12134 <p>Raw Ajax response text.</p> |
|
12135 </div> |
|
12136 |
|
12137 |
|
12138 </li> |
|
12139 |
|
12140 </ul> |
|
12141 </div> |
|
12142 |
|
12143 |
|
12144 |
|
12145 <div class="returns"> |
|
12146 <h4>Returns:</h4> |
|
12147 |
|
12148 <div class="returns-description"> |
|
12149 |
|
12150 |
|
12151 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
12152 |
|
12153 Content object with the properties described above. |
|
12154 |
|
12155 </div> |
|
12156 </div> |
|
12157 |
|
12158 |
|
12159 |
|
12160 </div> |
|
12161 |
|
12162 |
|
12163 <div id="method_getEvent" class="method item inherited"> |
|
12164 <h3 class="name"><code>getEvent</code></h3> |
|
12165 |
|
12166 |
|
12167 <div class="args"> |
|
12168 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12169 |
|
12170 <li class="arg"> |
|
12171 |
|
12172 <code>type</code> |
|
12173 |
|
12174 </li> |
|
12175 |
|
12176 <li class="arg"> |
|
12177 |
|
12178 <code>prefixed</code> |
|
12179 |
|
12180 </li> |
|
12181 |
|
12182 </ul><span class="paren">)</span> |
|
12183 </div> |
|
12184 |
|
12185 |
|
12186 |
|
12187 <span class="returns-inline"> |
|
12188 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
12189 </span> |
|
12190 |
|
12191 |
|
12192 |
|
12193 |
|
12194 |
|
12195 |
|
12196 |
|
12197 |
|
12198 |
|
12199 |
|
12200 |
|
12201 |
|
12202 |
|
12203 |
|
12204 <div class="meta"> |
|
12205 |
|
12206 |
|
12207 <p>Inherited from |
|
12208 <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>: |
|
12209 |
|
12210 |
|
12211 |
|
12212 <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a> |
|
12213 |
|
12214 </p> |
|
12215 |
|
12216 |
|
12217 |
|
12218 |
|
12219 |
|
12220 </div> |
|
12221 |
|
12222 <div class="description"> |
|
12223 <p>Returns the custom event of the provided type has been created, a |
|
12224 falsy value otherwise</p> |
|
12225 </div> |
|
12226 |
|
12227 |
|
12228 <div class="params"> |
|
12229 <h4>Parameters:</h4> |
|
12230 |
|
12231 <ul class="params-list"> |
|
12232 |
|
12233 <li class="param"> |
|
12234 |
|
12235 <code class="param-name">type</code> |
|
12236 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12237 |
|
12238 |
|
12239 |
|
12240 |
|
12241 <div class="param-description"> |
|
12242 <p>the type, or name of the event</p> |
|
12243 </div> |
|
12244 |
|
12245 |
|
12246 </li> |
|
12247 |
|
12248 <li class="param"> |
|
12249 |
|
12250 <code class="param-name">prefixed</code> |
|
12251 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12252 |
|
12253 |
|
12254 |
|
12255 |
|
12256 <div class="param-description"> |
|
12257 <p>if true, the type is prefixed already</p> |
|
12258 </div> |
|
12259 |
|
12260 |
|
12261 </li> |
|
12262 |
|
12263 </ul> |
|
12264 </div> |
|
12265 |
|
12266 |
|
12267 |
|
12268 <div class="returns"> |
|
12269 <h4>Returns:</h4> |
|
12270 |
|
12271 <div class="returns-description"> |
|
12272 |
|
12273 |
|
12274 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
12275 |
|
12276 the custom event or null |
|
12277 |
|
12278 </div> |
|
12279 </div> |
|
12280 |
|
12281 |
|
12282 |
|
12283 </div> |
|
12284 |
|
12285 |
|
12286 <div id="method_getPath" class="method item inherited"> |
|
12287 <h3 class="name"><code>getPath</code></h3> |
|
12288 |
|
12289 |
|
12290 <span class="paren">()</span> |
|
12291 |
|
12292 |
|
12293 |
|
12294 <span class="returns-inline"> |
|
12295 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12296 </span> |
|
12297 |
|
12298 |
|
12299 |
|
12300 |
|
12301 |
|
12302 |
|
12303 |
|
12304 |
|
12305 |
|
12306 |
|
12307 |
|
12308 |
|
12309 |
|
12310 |
|
12311 <div class="meta"> |
|
12312 |
|
12313 |
|
12314 <p>Inherited from |
|
12315 <a href="../classes/Router.html#method_getPath">Router</a>: |
|
12316 |
|
12317 |
|
12318 |
|
12319 <a href="../files/app_js_router.js.html#l228"><code>app/js/router.js:228</code></a> |
|
12320 |
|
12321 </p> |
|
12322 |
|
12323 |
|
12324 |
|
12325 |
|
12326 |
|
12327 </div> |
|
12328 |
|
12329 <div class="description"> |
|
12330 <p>Gets the current route path, relative to the <code>root</code> (if any).</p> |
|
12331 </div> |
|
12332 |
|
12333 |
|
12334 |
|
12335 |
|
12336 <div class="returns"> |
|
12337 <h4>Returns:</h4> |
|
12338 |
|
12339 <div class="returns-description"> |
|
12340 |
|
12341 |
|
12342 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
12343 |
|
12344 Current route path. |
|
12345 |
|
12346 </div> |
|
12347 </div> |
|
12348 |
|
12349 |
|
12350 |
|
12351 </div> |
|
12352 |
|
12353 |
|
12354 <div id="method_getTargets" class="method item inherited"> |
|
12355 <h3 class="name"><code>getTargets</code></h3> |
|
12356 |
|
12357 |
|
12358 <span class="paren">()</span> |
|
12359 |
|
12360 |
|
12361 |
|
12362 <span class="returns-inline"> |
|
12363 <span class="type"></span> |
|
12364 </span> |
|
12365 |
|
12366 |
|
12367 |
|
12368 |
|
12369 |
|
12370 |
|
12371 |
|
12372 |
|
12373 |
|
12374 |
|
12375 |
|
12376 |
|
12377 |
|
12378 |
|
12379 <div class="meta"> |
|
12380 |
|
12381 |
|
12382 <p>Inherited from |
|
12383 <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>: |
|
12384 |
|
12385 |
|
12386 |
|
12387 <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a> |
|
12388 |
|
12389 </p> |
|
12390 |
|
12391 |
|
12392 |
|
12393 |
|
12394 |
|
12395 </div> |
|
12396 |
|
12397 <div class="description"> |
|
12398 <p>Returns an array of bubble targets for this object.</p> |
|
12399 </div> |
|
12400 |
|
12401 |
|
12402 |
|
12403 |
|
12404 <div class="returns"> |
|
12405 <h4>Returns:</h4> |
|
12406 |
|
12407 <div class="returns-description"> |
|
12408 |
|
12409 |
|
12410 EventTarget[] |
|
12411 |
|
12412 </div> |
|
12413 </div> |
|
12414 |
|
12415 |
|
12416 |
|
12417 </div> |
|
12418 |
|
12419 |
|
12420 <div id="method_hasRoute" class="method item inherited"> |
|
12421 <h3 class="name"><code>hasRoute</code></h3> |
|
12422 |
|
12423 |
|
12424 <div class="args"> |
|
12425 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12426 |
|
12427 <li class="arg"> |
|
12428 |
|
12429 <code>url</code> |
|
12430 |
|
12431 </li> |
|
12432 |
|
12433 </ul><span class="paren">)</span> |
|
12434 </div> |
|
12435 |
|
12436 |
|
12437 |
|
12438 <span class="returns-inline"> |
|
12439 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12440 </span> |
|
12441 |
|
12442 |
|
12443 |
|
12444 |
|
12445 |
|
12446 |
|
12447 |
|
12448 |
|
12449 |
|
12450 |
|
12451 |
|
12452 |
|
12453 |
|
12454 |
|
12455 <div class="meta"> |
|
12456 |
|
12457 |
|
12458 <p>Inherited from |
|
12459 <a href="../classes/Router.html#method_hasRoute">Router</a>: |
|
12460 |
|
12461 |
|
12462 |
|
12463 <a href="../files/app_js_router.js.html#l238"><code>app/js/router.js:238</code></a> |
|
12464 |
|
12465 </p> |
|
12466 |
|
12467 |
|
12468 |
|
12469 |
|
12470 |
|
12471 </div> |
|
12472 |
|
12473 <div class="description"> |
|
12474 <p>Returns <code>true</code> if this router has at least one route that matches the |
|
12475 specified URL, <code>false</code> otherwise.</p> |
|
12476 |
|
12477 <p>This method enforces the same-origin security constraint on the specified |
|
12478 <code>url</code>; any URL which is not from the same origin as the current URL will |
|
12479 always return <code>false</code>.</p> |
|
12480 </div> |
|
12481 |
|
12482 |
|
12483 <div class="params"> |
|
12484 <h4>Parameters:</h4> |
|
12485 |
|
12486 <ul class="params-list"> |
|
12487 |
|
12488 <li class="param"> |
|
12489 |
|
12490 <code class="param-name">url</code> |
|
12491 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12492 |
|
12493 |
|
12494 |
|
12495 |
|
12496 <div class="param-description"> |
|
12497 <p>URL to match.</p> |
|
12498 </div> |
|
12499 |
|
12500 |
|
12501 </li> |
|
12502 |
|
12503 </ul> |
|
12504 </div> |
|
12505 |
|
12506 |
|
12507 |
|
12508 <div class="returns"> |
|
12509 <h4>Returns:</h4> |
|
12510 |
|
12511 <div class="returns-description"> |
|
12512 |
|
12513 |
|
12514 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
12515 |
|
12516 <code>true</code> if there's at least one matching route, <code>false</code> |
|
12517 otherwise. |
|
12518 |
|
12519 </div> |
|
12520 </div> |
|
12521 |
|
12522 |
|
12523 |
|
12524 </div> |
|
12525 |
|
12526 |
|
12527 <div id="method_init" class="method item inherited"> |
|
12528 <h3 class="name"><code>init</code></h3> |
|
12529 |
|
12530 |
|
12531 <div class="args"> |
|
12532 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12533 |
|
12534 <li class="arg"> |
|
12535 |
|
12536 <code>cfg</code> |
|
12537 |
|
12538 </li> |
|
12539 |
|
12540 </ul><span class="paren">)</span> |
|
12541 </div> |
|
12542 |
|
12543 |
|
12544 |
|
12545 <span class="returns-inline"> |
|
12546 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span> |
|
12547 </span> |
|
12548 |
|
12549 |
|
12550 |
|
12551 |
|
12552 |
|
12553 |
|
12554 |
|
12555 |
|
12556 |
|
12557 |
|
12558 |
|
12559 <span class="flag chainable">chainable</span> |
|
12560 |
|
12561 |
|
12562 |
|
12563 |
|
12564 <div class="meta"> |
|
12565 |
|
12566 <p>Inherited from |
|
12567 <a href="../classes/BaseObservable.html#method_init"> |
|
12568 BaseObservable |
|
12569 </a> |
|
12570 |
|
12571 but overwritten in |
|
12572 |
|
12573 |
|
12574 |
|
12575 <a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a> |
|
12576 |
|
12577 </p> |
|
12578 |
|
12579 |
|
12580 |
|
12581 |
|
12582 |
|
12583 </div> |
|
12584 |
|
12585 <div class="description"> |
|
12586 <p>Init lifecycle method, invoked during construction. Sets up attributes |
|
12587 and invokes initializers for the class hierarchy.</p> |
|
12588 </div> |
|
12589 |
|
12590 |
|
12591 <div class="params"> |
|
12592 <h4>Parameters:</h4> |
|
12593 |
|
12594 <ul class="params-list"> |
|
12595 |
|
12596 <li class="param"> |
|
12597 |
|
12598 <code class="param-name">cfg</code> |
|
12599 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12600 |
|
12601 |
|
12602 |
|
12603 |
|
12604 <div class="param-description"> |
|
12605 <p>Object with configuration property name/value pairs</p> |
|
12606 </div> |
|
12607 |
|
12608 |
|
12609 </li> |
|
12610 |
|
12611 </ul> |
|
12612 </div> |
|
12613 |
|
12614 |
|
12615 |
|
12616 <div class="returns"> |
|
12617 <h4>Returns:</h4> |
|
12618 |
|
12619 <div class="returns-description"> |
|
12620 |
|
12621 |
|
12622 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>: |
|
12623 |
|
12624 A reference to this object |
|
12625 |
|
12626 </div> |
|
12627 </div> |
|
12628 |
|
12629 |
|
12630 |
|
12631 </div> |
|
12632 |
|
12633 |
|
12634 <div id="method_loadContent" class="method item inherited"> |
|
12635 <h3 class="name"><code>loadContent</code></h3> |
|
12636 |
|
12637 |
|
12638 <div class="args"> |
|
12639 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12640 |
|
12641 <li class="arg"> |
|
12642 |
|
12643 <code>req</code> |
|
12644 |
|
12645 </li> |
|
12646 |
|
12647 <li class="arg"> |
|
12648 |
|
12649 <code>res</code> |
|
12650 |
|
12651 </li> |
|
12652 |
|
12653 <li class="arg"> |
|
12654 |
|
12655 <code>next</code> |
|
12656 |
|
12657 </li> |
|
12658 |
|
12659 </ul><span class="paren">)</span> |
|
12660 </div> |
|
12661 |
|
12662 |
|
12663 |
|
12664 |
|
12665 |
|
12666 |
|
12667 |
|
12668 |
|
12669 |
|
12670 |
|
12671 |
|
12672 |
|
12673 |
|
12674 |
|
12675 |
|
12676 |
|
12677 <div class="meta"> |
|
12678 |
|
12679 |
|
12680 <p>Inherited from |
|
12681 <a href="../classes/PjaxContent.html#method_loadContent">PjaxContent</a>: |
|
12682 |
|
12683 |
|
12684 |
|
12685 <a href="../files/pjax_js_pjax-content.js.html#l83"><code>pjax/js/pjax-content.js:83</code></a> |
|
12686 |
|
12687 </p> |
|
12688 |
|
12689 |
|
12690 |
|
12691 |
|
12692 |
|
12693 <p>Available since 3.7.0</p> |
|
12694 |
|
12695 </div> |
|
12696 |
|
12697 <div class="description"> |
|
12698 <p>Pjax route middleware to load content from a server. This makes an Ajax |
|
12699 request for the requested URL, parses the returned content and puts it on |
|
12700 the route's response object.</p> |
|
12701 |
|
12702 <p>This is route middleware and not intended to be the final callback for a |
|
12703 route. This will add the following information to the route's request and |
|
12704 response objects:</p> |
|
12705 |
|
12706 <ul> |
|
12707 <li><p><code>req.ioURL</code>: The full URL that was used to make the <code>Y.io()</code> XHR. This |
|
12708 may contain <code>"pjax=1"</code> if the <code>addPjaxParam</code> option is set.</p></li> |
|
12709 <li><p><code>res.content</code>: An object containing <code>node</code> and <code>title</code> properties for |
|
12710 the content extracted from the server's response. See <code>getContent()</code> for |
|
12711 more details.</p></li> |
|
12712 <li><p><code>res.ioResponse</code>: The full <code>Y.io()</code> response object. This is useful if |
|
12713 you need access to the XHR's response <code>status</code> or HTTP headers.</p></li> |
|
12714 </ul> |
|
12715 </div> |
|
12716 |
|
12717 |
|
12718 <div class="params"> |
|
12719 <h4>Parameters:</h4> |
|
12720 |
|
12721 <ul class="params-list"> |
|
12722 |
|
12723 <li class="param"> |
|
12724 |
|
12725 <code class="param-name">req</code> |
|
12726 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12727 |
|
12728 |
|
12729 |
|
12730 |
|
12731 <div class="param-description"> |
|
12732 <p>Request object.</p> |
|
12733 </div> |
|
12734 |
|
12735 |
|
12736 </li> |
|
12737 |
|
12738 <li class="param"> |
|
12739 |
|
12740 <code class="param-name">res</code> |
|
12741 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12742 |
|
12743 |
|
12744 |
|
12745 |
|
12746 <div class="param-description"> |
|
12747 <p>Response Object.</p> |
|
12748 </div> |
|
12749 |
|
12750 |
|
12751 </li> |
|
12752 |
|
12753 <li class="param"> |
|
12754 |
|
12755 <code class="param-name">next</code> |
|
12756 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
12757 |
|
12758 |
|
12759 |
|
12760 |
|
12761 <div class="param-description"> |
|
12762 <p>Function to pass control to the next route callback.</p> |
|
12763 </div> |
|
12764 |
|
12765 |
|
12766 </li> |
|
12767 |
|
12768 </ul> |
|
12769 </div> |
|
12770 |
|
12771 |
|
12772 |
|
12773 |
|
12774 |
|
12775 <div class="example"> |
|
12776 <h4>Example:</h4> |
|
12777 |
|
12778 <div class="example-content"> |
|
12779 <pre class="code prettyprint"><code>router.route('/foo/', 'loadContent', function (req, res, next) { |
|
12780 Y.one('container').setHTML(res.content.node); |
|
12781 Y.config.doc.title = res.content.title; |
|
12782 }); |
|
12783 </code></pre> |
|
12784 </div> |
|
12785 </div> |
|
12786 |
|
12787 </div> |
|
12788 |
|
12789 |
|
12790 <div id="method_match" class="method item inherited"> |
|
12791 <h3 class="name"><code>match</code></h3> |
|
12792 |
|
12793 |
|
12794 <div class="args"> |
|
12795 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12796 |
|
12797 <li class="arg"> |
|
12798 |
|
12799 <code>path</code> |
|
12800 |
|
12801 </li> |
|
12802 |
|
12803 </ul><span class="paren">)</span> |
|
12804 </div> |
|
12805 |
|
12806 |
|
12807 |
|
12808 <span class="returns-inline"> |
|
12809 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
12810 </span> |
|
12811 |
|
12812 |
|
12813 |
|
12814 |
|
12815 |
|
12816 |
|
12817 |
|
12818 |
|
12819 |
|
12820 |
|
12821 |
|
12822 |
|
12823 |
|
12824 |
|
12825 <div class="meta"> |
|
12826 |
|
12827 |
|
12828 <p>Inherited from |
|
12829 <a href="../classes/Router.html#method_match">Router</a>: |
|
12830 |
|
12831 |
|
12832 |
|
12833 <a href="../files/app_js_router.js.html#l267"><code>app/js/router.js:267</code></a> |
|
12834 |
|
12835 </p> |
|
12836 |
|
12837 |
|
12838 |
|
12839 |
|
12840 |
|
12841 </div> |
|
12842 |
|
12843 <div class="description"> |
|
12844 <p>Returns an array of route objects that match the specified URL path.</p> |
|
12845 |
|
12846 <p>This method is called internally to determine which routes match the current |
|
12847 path whenever the URL changes. You may override it if you want to customize |
|
12848 the route matching logic, although this usually shouldn't be necessary.</p> |
|
12849 |
|
12850 <p>Each returned route object has the following properties:</p> |
|
12851 |
|
12852 <ul> |
|
12853 <li><p><code>callback</code>: A function or a string representing the name of a function |
|
12854 this router that should be executed when the route is triggered.</p></li> |
|
12855 <li><p><code>keys</code>: An array of strings representing the named parameters defined in |
|
12856 the route's path specification, if any.</p></li> |
|
12857 <li><p><code>path</code>: The route's path specification, which may be either a string or |
|
12858 a regex.</p></li> |
|
12859 <li><p><code>regex</code>: A regular expression version of the route's path specification. |
|
12860 This regex is used to determine whether the route matches a given path.</p></li> |
|
12861 </ul> |
|
12862 </div> |
|
12863 |
|
12864 |
|
12865 <div class="params"> |
|
12866 <h4>Parameters:</h4> |
|
12867 |
|
12868 <ul class="params-list"> |
|
12869 |
|
12870 <li class="param"> |
|
12871 |
|
12872 <code class="param-name">path</code> |
|
12873 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12874 |
|
12875 |
|
12876 |
|
12877 |
|
12878 <div class="param-description"> |
|
12879 <p>URL path to match.</p> |
|
12880 </div> |
|
12881 |
|
12882 |
|
12883 </li> |
|
12884 |
|
12885 </ul> |
|
12886 </div> |
|
12887 |
|
12888 |
|
12889 |
|
12890 <div class="returns"> |
|
12891 <h4>Returns:</h4> |
|
12892 |
|
12893 <div class="returns-description"> |
|
12894 |
|
12895 |
|
12896 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
12897 |
|
12898 Array of route objects that match the specified path. |
|
12899 |
|
12900 </div> |
|
12901 </div> |
|
12902 |
|
12903 |
|
12904 |
|
12905 <div class="example"> |
|
12906 <h4>Example:</h4> |
|
12907 |
|
12908 <div class="example-content"> |
|
12909 <pre class="code prettyprint"><code>router.route('/foo', function () {}); |
|
12910 router.match('/foo'); |
|
12911 // => [{callback: ..., keys: [], path: '/foo', regex: ...}] |
|
12912 </code></pre> |
|
12913 </div> |
|
12914 </div> |
|
12915 |
|
12916 </div> |
|
12917 |
|
12918 |
|
12919 <div id="method_modifyAttr" class="method item inherited"> |
|
12920 <h3 class="name"><code>modifyAttr</code></h3> |
|
12921 |
|
12922 |
|
12923 <div class="args"> |
|
12924 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12925 |
|
12926 <li class="arg"> |
|
12927 |
|
12928 <code>name</code> |
|
12929 |
|
12930 </li> |
|
12931 |
|
12932 <li class="arg"> |
|
12933 |
|
12934 <code>config</code> |
|
12935 |
|
12936 </li> |
|
12937 |
|
12938 </ul><span class="paren">)</span> |
|
12939 </div> |
|
12940 |
|
12941 |
|
12942 |
|
12943 |
|
12944 |
|
12945 |
|
12946 |
|
12947 |
|
12948 |
|
12949 |
|
12950 |
|
12951 |
|
12952 |
|
12953 |
|
12954 |
|
12955 |
|
12956 <div class="meta"> |
|
12957 |
|
12958 |
|
12959 <p>Inherited from |
|
12960 <a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>: |
|
12961 |
|
12962 |
|
12963 |
|
12964 <a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a> |
|
12965 |
|
12966 </p> |
|
12967 |
|
12968 |
|
12969 |
|
12970 |
|
12971 |
|
12972 </div> |
|
12973 |
|
12974 <div class="description"> |
|
12975 <p>Updates the configuration of an attribute which has already been added.</p> |
|
12976 |
|
12977 <p> |
|
12978 The properties which can be modified through this interface are limited |
|
12979 to the following subset of attributes, which can be safely modified |
|
12980 after a value has already been set on the attribute: readOnly, writeOnce, |
|
12981 broadcast and getter. |
|
12982 </p> |
|
12983 </div> |
|
12984 |
|
12985 |
|
12986 <div class="params"> |
|
12987 <h4>Parameters:</h4> |
|
12988 |
|
12989 <ul class="params-list"> |
|
12990 |
|
12991 <li class="param"> |
|
12992 |
|
12993 <code class="param-name">name</code> |
|
12994 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12995 |
|
12996 |
|
12997 |
|
12998 |
|
12999 <div class="param-description"> |
|
13000 <p>The name of the attribute whose configuration is to be updated.</p> |
|
13001 </div> |
|
13002 |
|
13003 |
|
13004 </li> |
|
13005 |
|
13006 <li class="param"> |
|
13007 |
|
13008 <code class="param-name">config</code> |
|
13009 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13010 |
|
13011 |
|
13012 |
|
13013 |
|
13014 <div class="param-description"> |
|
13015 <p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p> |
|
13016 </div> |
|
13017 |
|
13018 |
|
13019 </li> |
|
13020 |
|
13021 </ul> |
|
13022 </div> |
|
13023 |
|
13024 |
|
13025 |
|
13026 |
|
13027 |
|
13028 </div> |
|
13029 |
|
13030 |
|
13031 <div id="method_navigate" class="method item inherited"> |
|
13032 <h3 class="name"><code>navigate</code></h3> |
|
13033 |
|
13034 |
|
13035 <div class="args"> |
|
13036 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13037 |
|
13038 <li class="arg"> |
|
13039 |
|
13040 <code>url</code> |
|
13041 |
|
13042 </li> |
|
13043 |
|
13044 <li class="arg"> |
|
13045 |
|
13046 <code class="optional">[options]</code> |
|
13047 |
|
13048 </li> |
|
13049 |
|
13050 </ul><span class="paren">)</span> |
|
13051 </div> |
|
13052 |
|
13053 |
|
13054 |
|
13055 <span class="returns-inline"> |
|
13056 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
13057 </span> |
|
13058 |
|
13059 |
|
13060 |
|
13061 |
|
13062 |
|
13063 |
|
13064 |
|
13065 |
|
13066 |
|
13067 |
|
13068 |
|
13069 |
|
13070 |
|
13071 |
|
13072 <div class="meta"> |
|
13073 |
|
13074 |
|
13075 <p>Inherited from |
|
13076 <a href="../classes/PjaxBase.html#method_navigate">PjaxBase</a>: |
|
13077 |
|
13078 |
|
13079 |
|
13080 <a href="../files/pjax_js_pjax-base.js.html#l114"><code>pjax/js/pjax-base.js:114</code></a> |
|
13081 |
|
13082 </p> |
|
13083 |
|
13084 |
|
13085 |
|
13086 |
|
13087 |
|
13088 <p>Available since 3.5.0</p> |
|
13089 |
|
13090 </div> |
|
13091 |
|
13092 <div class="description"> |
|
13093 <p>Navigates to the specified URL if there is a route handler that matches. In |
|
13094 browsers capable of using HTML5 history, the navigation will be enhanced by |
|
13095 firing the <code>navigate</code> event and having the router handle the "request". |
|
13096 Non-HTML5 browsers will navigate to the new URL via manipulation of |
|
13097 <code>window.location</code>.</p> |
|
13098 |
|
13099 <p>When there is a route handler for the specified URL and it is being |
|
13100 navigated to, this method will return <code>true</code>, otherwise it will return |
|
13101 <code>false</code>.</p> |
|
13102 |
|
13103 <p><strong>Note:</strong> The specified URL <em>must</em> be of the same origin as the current URL, |
|
13104 otherwise an error will be logged and navigation will not occur. This is |
|
13105 intended as both a security constraint and a purposely imposed limitation as |
|
13106 it does not make sense to tell the router to navigate to a URL on a |
|
13107 different scheme, host, or port.</p> |
|
13108 </div> |
|
13109 |
|
13110 |
|
13111 <div class="params"> |
|
13112 <h4>Parameters:</h4> |
|
13113 |
|
13114 <ul class="params-list"> |
|
13115 |
|
13116 <li class="param"> |
|
13117 |
|
13118 <code class="param-name">url</code> |
|
13119 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13120 |
|
13121 |
|
13122 |
|
13123 |
|
13124 <div class="param-description"> |
|
13125 <p>The URL to navigate to. This must be of the same origin |
|
13126 as the current URL.</p> |
|
13127 </div> |
|
13128 |
|
13129 |
|
13130 </li> |
|
13131 |
|
13132 <li class="param"> |
|
13133 |
|
13134 <code class="param-name optional">[options]</code> |
|
13135 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13136 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13137 |
|
13138 |
|
13139 |
|
13140 |
|
13141 <div class="param-description"> |
|
13142 <p>Additional options to configure the navigation. |
|
13143 These are mixed into the <code>navigate</code> event facade.</p> |
|
13144 </div> |
|
13145 |
|
13146 |
|
13147 <ul class="params-list"> |
|
13148 |
|
13149 <li class="param"> |
|
13150 |
|
13151 <code class="param-name optional">[replace]</code> |
|
13152 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
13153 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13154 |
|
13155 |
|
13156 <div class="param-description"> |
|
13157 <p>Whether or not the current history |
|
13158 entry will be replaced, or a new entry will be created. Will default |
|
13159 to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p> |
|
13160 </div> |
|
13161 |
|
13162 |
|
13163 </li> |
|
13164 |
|
13165 <li class="param"> |
|
13166 |
|
13167 <code class="param-name optional">[force=false]</code> |
|
13168 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
13169 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13170 |
|
13171 |
|
13172 <div class="param-description"> |
|
13173 <p>Whether the enhanced navigation |
|
13174 should occur even in browsers without HTML5 history.</p> |
|
13175 </div> |
|
13176 |
|
13177 |
|
13178 </li> |
|
13179 |
|
13180 </ul> |
|
13181 |
|
13182 </li> |
|
13183 |
|
13184 </ul> |
|
13185 </div> |
|
13186 |
|
13187 |
|
13188 |
|
13189 <div class="returns"> |
|
13190 <h4>Returns:</h4> |
|
13191 |
|
13192 <div class="returns-description"> |
|
13193 |
|
13194 |
|
13195 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
13196 |
|
13197 <code>true</code> if the URL was navigated to, <code>false</code> otherwise. |
|
13198 |
|
13199 </div> |
|
13200 </div> |
|
13201 |
|
13202 |
|
13203 |
|
13204 </div> |
|
13205 |
|
13206 |
|
13207 <div id="method_on" class="method item inherited"> |
|
13208 <h3 class="name"><code>on</code></h3> |
|
13209 |
|
13210 |
|
13211 <div class="args"> |
|
13212 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13213 |
|
13214 <li class="arg"> |
|
13215 |
|
13216 <code>type</code> |
|
13217 |
|
13218 </li> |
|
13219 |
|
13220 <li class="arg"> |
|
13221 |
|
13222 <code>fn</code> |
|
13223 |
|
13224 </li> |
|
13225 |
|
13226 <li class="arg"> |
|
13227 |
|
13228 <code class="optional">[context]</code> |
|
13229 |
|
13230 </li> |
|
13231 |
|
13232 <li class="arg"> |
|
13233 |
|
13234 <code class="optional">[arg*]</code> |
|
13235 |
|
13236 </li> |
|
13237 |
|
13238 </ul><span class="paren">)</span> |
|
13239 </div> |
|
13240 |
|
13241 |
|
13242 |
|
13243 <span class="returns-inline"> |
|
13244 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
13245 </span> |
|
13246 |
|
13247 |
|
13248 |
|
13249 |
|
13250 |
|
13251 |
|
13252 |
|
13253 |
|
13254 |
|
13255 |
|
13256 |
|
13257 |
|
13258 |
|
13259 |
|
13260 <div class="meta"> |
|
13261 |
|
13262 |
|
13263 <p>Inherited from |
|
13264 <a href="../classes/EventTarget.html#method_on">EventTarget</a>: |
|
13265 |
|
13266 |
|
13267 |
|
13268 <a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a> |
|
13269 |
|
13270 </p> |
|
13271 |
|
13272 |
|
13273 |
|
13274 |
|
13275 |
|
13276 </div> |
|
13277 |
|
13278 <div class="description"> |
|
13279 <p>Subscribe a callback function to a custom event fired by this object or |
|
13280 from an object that bubbles its events to this object.</p> |
|
13281 |
|
13282 <p>Callback functions for events published with <code>emitFacade = true</code> will |
|
13283 receive an <code>EventFacade</code> as the first argument (typically named "e"). |
|
13284 These callbacks can then call <code>e.preventDefault()</code> to disable the |
|
13285 behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code> |
|
13286 API for all available properties and methods. Subscribers to |
|
13287 non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code> |
|
13288 after the event name.</p> |
|
13289 |
|
13290 <p>To subscribe to multiple events at once, pass an object as the first |
|
13291 argument, where the key:value pairs correspond to the eventName:callback, |
|
13292 or pass an array of event names as the first argument to subscribe to |
|
13293 all listed events with the same callback.</p> |
|
13294 |
|
13295 <p>Returning <code>false</code> from a callback is supported as an alternative to |
|
13296 calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is |
|
13297 recommended to use the event methods whenever possible.</p> |
|
13298 </div> |
|
13299 |
|
13300 |
|
13301 <div class="params"> |
|
13302 <h4>Parameters:</h4> |
|
13303 |
|
13304 <ul class="params-list"> |
|
13305 |
|
13306 <li class="param"> |
|
13307 |
|
13308 <code class="param-name">type</code> |
|
13309 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13310 |
|
13311 |
|
13312 |
|
13313 |
|
13314 <div class="param-description"> |
|
13315 <p>The name of the event</p> |
|
13316 </div> |
|
13317 |
|
13318 |
|
13319 </li> |
|
13320 |
|
13321 <li class="param"> |
|
13322 |
|
13323 <code class="param-name">fn</code> |
|
13324 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
13325 |
|
13326 |
|
13327 |
|
13328 |
|
13329 <div class="param-description"> |
|
13330 <p>The callback to execute in response to the event</p> |
|
13331 </div> |
|
13332 |
|
13333 |
|
13334 </li> |
|
13335 |
|
13336 <li class="param"> |
|
13337 |
|
13338 <code class="param-name optional">[context]</code> |
|
13339 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13340 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13341 |
|
13342 |
|
13343 |
|
13344 |
|
13345 <div class="param-description"> |
|
13346 <p>Override <code>this</code> object in callback</p> |
|
13347 </div> |
|
13348 |
|
13349 |
|
13350 </li> |
|
13351 |
|
13352 <li class="param"> |
|
13353 |
|
13354 <code class="param-name optional">[arg*]</code> |
|
13355 <span class="type">Any</span> |
|
13356 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13357 |
|
13358 |
|
13359 |
|
13360 |
|
13361 <div class="param-description"> |
|
13362 <p>0..n additional arguments to supply to the subscriber</p> |
|
13363 </div> |
|
13364 |
|
13365 |
|
13366 </li> |
|
13367 |
|
13368 </ul> |
|
13369 </div> |
|
13370 |
|
13371 |
|
13372 |
|
13373 <div class="returns"> |
|
13374 <h4>Returns:</h4> |
|
13375 |
|
13376 <div class="returns-description"> |
|
13377 |
|
13378 |
|
13379 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
13380 |
|
13381 A subscription handle capable of detaching that |
|
13382 subscription |
|
13383 |
|
13384 </div> |
|
13385 </div> |
|
13386 |
|
13387 |
|
13388 |
|
13389 </div> |
|
13390 |
|
13391 |
|
13392 <div id="method_once" class="method item inherited"> |
|
13393 <h3 class="name"><code>once</code></h3> |
|
13394 |
|
13395 |
|
13396 <div class="args"> |
|
13397 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13398 |
|
13399 <li class="arg"> |
|
13400 |
|
13401 <code>type</code> |
|
13402 |
|
13403 </li> |
|
13404 |
|
13405 <li class="arg"> |
|
13406 |
|
13407 <code>fn</code> |
|
13408 |
|
13409 </li> |
|
13410 |
|
13411 <li class="arg"> |
|
13412 |
|
13413 <code class="optional">[context]</code> |
|
13414 |
|
13415 </li> |
|
13416 |
|
13417 <li class="arg"> |
|
13418 |
|
13419 <code class="optional">[arg*]</code> |
|
13420 |
|
13421 </li> |
|
13422 |
|
13423 </ul><span class="paren">)</span> |
|
13424 </div> |
|
13425 |
|
13426 |
|
13427 |
|
13428 <span class="returns-inline"> |
|
13429 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
13430 </span> |
|
13431 |
|
13432 |
|
13433 |
|
13434 |
|
13435 |
|
13436 |
|
13437 |
|
13438 |
|
13439 |
|
13440 |
|
13441 |
|
13442 |
|
13443 |
|
13444 |
|
13445 <div class="meta"> |
|
13446 |
|
13447 |
|
13448 <p>Inherited from |
|
13449 <a href="../classes/EventTarget.html#method_once">EventTarget</a>: |
|
13450 |
|
13451 |
|
13452 |
|
13453 <a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a> |
|
13454 |
|
13455 </p> |
|
13456 |
|
13457 |
|
13458 |
|
13459 |
|
13460 |
|
13461 </div> |
|
13462 |
|
13463 <div class="description"> |
|
13464 <p>Listen to a custom event hosted by this object one time. |
|
13465 This is the equivalent to <code>on</code> except the |
|
13466 listener is immediatelly detached when it is executed.</p> |
|
13467 </div> |
|
13468 |
|
13469 |
|
13470 <div class="params"> |
|
13471 <h4>Parameters:</h4> |
|
13472 |
|
13473 <ul class="params-list"> |
|
13474 |
|
13475 <li class="param"> |
|
13476 |
|
13477 <code class="param-name">type</code> |
|
13478 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13479 |
|
13480 |
|
13481 |
|
13482 |
|
13483 <div class="param-description"> |
|
13484 <p>The name of the event</p> |
|
13485 </div> |
|
13486 |
|
13487 |
|
13488 </li> |
|
13489 |
|
13490 <li class="param"> |
|
13491 |
|
13492 <code class="param-name">fn</code> |
|
13493 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
13494 |
|
13495 |
|
13496 |
|
13497 |
|
13498 <div class="param-description"> |
|
13499 <p>The callback to execute in response to the event</p> |
|
13500 </div> |
|
13501 |
|
13502 |
|
13503 </li> |
|
13504 |
|
13505 <li class="param"> |
|
13506 |
|
13507 <code class="param-name optional">[context]</code> |
|
13508 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13509 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13510 |
|
13511 |
|
13512 |
|
13513 |
|
13514 <div class="param-description"> |
|
13515 <p>Override <code>this</code> object in callback</p> |
|
13516 </div> |
|
13517 |
|
13518 |
|
13519 </li> |
|
13520 |
|
13521 <li class="param"> |
|
13522 |
|
13523 <code class="param-name optional">[arg*]</code> |
|
13524 <span class="type">Any</span> |
|
13525 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13526 |
|
13527 |
|
13528 |
|
13529 |
|
13530 <div class="param-description"> |
|
13531 <p>0..n additional arguments to supply to the subscriber</p> |
|
13532 </div> |
|
13533 |
|
13534 |
|
13535 </li> |
|
13536 |
|
13537 </ul> |
|
13538 </div> |
|
13539 |
|
13540 |
|
13541 |
|
13542 <div class="returns"> |
|
13543 <h4>Returns:</h4> |
|
13544 |
|
13545 <div class="returns-description"> |
|
13546 |
|
13547 |
|
13548 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
13549 |
|
13550 A subscription handle capable of detaching the |
|
13551 subscription |
|
13552 |
|
13553 </div> |
|
13554 </div> |
|
13555 |
|
13556 |
|
13557 |
|
13558 </div> |
|
13559 |
|
13560 |
|
13561 <div id="method_onceAfter" class="method item inherited"> |
|
13562 <h3 class="name"><code>onceAfter</code></h3> |
|
13563 |
|
13564 |
|
13565 <div class="args"> |
|
13566 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13567 |
|
13568 <li class="arg"> |
|
13569 |
|
13570 <code>type</code> |
|
13571 |
|
13572 </li> |
|
13573 |
|
13574 <li class="arg"> |
|
13575 |
|
13576 <code>fn</code> |
|
13577 |
|
13578 </li> |
|
13579 |
|
13580 <li class="arg"> |
|
13581 |
|
13582 <code class="optional">[context]</code> |
|
13583 |
|
13584 </li> |
|
13585 |
|
13586 <li class="arg"> |
|
13587 |
|
13588 <code class="optional">[arg*]</code> |
|
13589 |
|
13590 </li> |
|
13591 |
|
13592 </ul><span class="paren">)</span> |
|
13593 </div> |
|
13594 |
|
13595 |
|
13596 |
|
13597 <span class="returns-inline"> |
|
13598 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
13599 </span> |
|
13600 |
|
13601 |
|
13602 |
|
13603 |
|
13604 |
|
13605 |
|
13606 |
|
13607 |
|
13608 |
|
13609 |
|
13610 |
|
13611 |
|
13612 |
|
13613 |
|
13614 <div class="meta"> |
|
13615 |
|
13616 |
|
13617 <p>Inherited from |
|
13618 <a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>: |
|
13619 |
|
13620 |
|
13621 |
|
13622 <a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a> |
|
13623 |
|
13624 </p> |
|
13625 |
|
13626 |
|
13627 |
|
13628 |
|
13629 |
|
13630 </div> |
|
13631 |
|
13632 <div class="description"> |
|
13633 <p>Listen to a custom event hosted by this object one time. |
|
13634 This is the equivalent to <code>after</code> except the |
|
13635 listener is immediatelly detached when it is executed.</p> |
|
13636 </div> |
|
13637 |
|
13638 |
|
13639 <div class="params"> |
|
13640 <h4>Parameters:</h4> |
|
13641 |
|
13642 <ul class="params-list"> |
|
13643 |
|
13644 <li class="param"> |
|
13645 |
|
13646 <code class="param-name">type</code> |
|
13647 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13648 |
|
13649 |
|
13650 |
|
13651 |
|
13652 <div class="param-description"> |
|
13653 <p>The name of the event</p> |
|
13654 </div> |
|
13655 |
|
13656 |
|
13657 </li> |
|
13658 |
|
13659 <li class="param"> |
|
13660 |
|
13661 <code class="param-name">fn</code> |
|
13662 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
13663 |
|
13664 |
|
13665 |
|
13666 |
|
13667 <div class="param-description"> |
|
13668 <p>The callback to execute in response to the event</p> |
|
13669 </div> |
|
13670 |
|
13671 |
|
13672 </li> |
|
13673 |
|
13674 <li class="param"> |
|
13675 |
|
13676 <code class="param-name optional">[context]</code> |
|
13677 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13678 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13679 |
|
13680 |
|
13681 |
|
13682 |
|
13683 <div class="param-description"> |
|
13684 <p>Override <code>this</code> object in callback</p> |
|
13685 </div> |
|
13686 |
|
13687 |
|
13688 </li> |
|
13689 |
|
13690 <li class="param"> |
|
13691 |
|
13692 <code class="param-name optional">[arg*]</code> |
|
13693 <span class="type">Any</span> |
|
13694 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13695 |
|
13696 |
|
13697 |
|
13698 |
|
13699 <div class="param-description"> |
|
13700 <p>0..n additional arguments to supply to the subscriber</p> |
|
13701 </div> |
|
13702 |
|
13703 |
|
13704 </li> |
|
13705 |
|
13706 </ul> |
|
13707 </div> |
|
13708 |
|
13709 |
|
13710 |
|
13711 <div class="returns"> |
|
13712 <h4>Returns:</h4> |
|
13713 |
|
13714 <div class="returns-description"> |
|
13715 |
|
13716 |
|
13717 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
13718 |
|
13719 A subscription handle capable of detaching that |
|
13720 subscription |
|
13721 |
|
13722 </div> |
|
13723 </div> |
|
13724 |
|
13725 |
|
13726 |
|
13727 </div> |
|
13728 |
|
13729 |
|
13730 <div id="method_parseType" class="method item inherited"> |
|
13731 <h3 class="name"><code>parseType</code></h3> |
|
13732 |
|
13733 |
|
13734 <div class="args"> |
|
13735 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13736 |
|
13737 <li class="arg"> |
|
13738 |
|
13739 <code>type</code> |
|
13740 |
|
13741 </li> |
|
13742 |
|
13743 <li class="arg"> |
|
13744 |
|
13745 <code class="optional">[pre=this._yuievt.config.prefix]</code> |
|
13746 |
|
13747 </li> |
|
13748 |
|
13749 </ul><span class="paren">)</span> |
|
13750 </div> |
|
13751 |
|
13752 |
|
13753 |
|
13754 <span class="returns-inline"> |
|
13755 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
13756 </span> |
|
13757 |
|
13758 |
|
13759 |
|
13760 |
|
13761 |
|
13762 |
|
13763 |
|
13764 |
|
13765 |
|
13766 |
|
13767 |
|
13768 |
|
13769 |
|
13770 |
|
13771 <div class="meta"> |
|
13772 |
|
13773 |
|
13774 <p>Inherited from |
|
13775 <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>: |
|
13776 |
|
13777 |
|
13778 |
|
13779 <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a> |
|
13780 |
|
13781 </p> |
|
13782 |
|
13783 |
|
13784 |
|
13785 |
|
13786 |
|
13787 <p>Available since 3.3.0</p> |
|
13788 |
|
13789 </div> |
|
13790 |
|
13791 <div class="description"> |
|
13792 <p>Takes the type parameter passed to 'on' and parses out the |
|
13793 various pieces that could be included in the type. If the |
|
13794 event type is passed without a prefix, it will be expanded |
|
13795 to include the prefix one is supplied or the event target |
|
13796 is configured with a default prefix.</p> |
|
13797 </div> |
|
13798 |
|
13799 |
|
13800 <div class="params"> |
|
13801 <h4>Parameters:</h4> |
|
13802 |
|
13803 <ul class="params-list"> |
|
13804 |
|
13805 <li class="param"> |
|
13806 |
|
13807 <code class="param-name">type</code> |
|
13808 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13809 |
|
13810 |
|
13811 |
|
13812 |
|
13813 <div class="param-description"> |
|
13814 <p>the type</p> |
|
13815 </div> |
|
13816 |
|
13817 |
|
13818 </li> |
|
13819 |
|
13820 <li class="param"> |
|
13821 |
|
13822 <code class="param-name optional">[pre=this._yuievt.config.prefix]</code> |
|
13823 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13824 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13825 |
|
13826 |
|
13827 |
|
13828 |
|
13829 <div class="param-description"> |
|
13830 <p>the prefix</p> |
|
13831 </div> |
|
13832 |
|
13833 |
|
13834 </li> |
|
13835 |
|
13836 </ul> |
|
13837 </div> |
|
13838 |
|
13839 |
|
13840 |
|
13841 <div class="returns"> |
|
13842 <h4>Returns:</h4> |
|
13843 |
|
13844 <div class="returns-description"> |
|
13845 |
|
13846 |
|
13847 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>: |
|
13848 |
|
13849 an array containing: |
|
13850 * the detach category, if supplied, |
|
13851 * the prefixed event type, |
|
13852 * whether or not this is an after listener, |
|
13853 * the supplied event type |
|
13854 |
|
13855 </div> |
|
13856 </div> |
|
13857 |
|
13858 |
|
13859 |
|
13860 </div> |
|
13861 |
|
13862 |
|
13863 <div id="method_publish" class="method item inherited"> |
|
13864 <h3 class="name"><code>publish</code></h3> |
|
13865 |
|
13866 |
|
13867 <div class="args"> |
|
13868 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13869 |
|
13870 <li class="arg"> |
|
13871 |
|
13872 <code>type</code> |
|
13873 |
|
13874 </li> |
|
13875 |
|
13876 <li class="arg"> |
|
13877 |
|
13878 <code>opts</code> |
|
13879 |
|
13880 </li> |
|
13881 |
|
13882 </ul><span class="paren">)</span> |
|
13883 </div> |
|
13884 |
|
13885 |
|
13886 |
|
13887 <span class="returns-inline"> |
|
13888 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
13889 </span> |
|
13890 |
|
13891 |
|
13892 |
|
13893 |
|
13894 |
|
13895 |
|
13896 |
|
13897 |
|
13898 |
|
13899 |
|
13900 |
|
13901 |
|
13902 |
|
13903 |
|
13904 <div class="meta"> |
|
13905 |
|
13906 |
|
13907 <p>Inherited from |
|
13908 <a href="../classes/EventTarget.html#method_publish">EventTarget</a>: |
|
13909 |
|
13910 |
|
13911 |
|
13912 <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a> |
|
13913 |
|
13914 </p> |
|
13915 |
|
13916 |
|
13917 |
|
13918 |
|
13919 |
|
13920 </div> |
|
13921 |
|
13922 <div class="description"> |
|
13923 <p>Creates a new custom event of the specified type. If a custom event |
|
13924 by that name already exists, it will not be re-created. In either |
|
13925 case the custom event is returned.</p> |
|
13926 </div> |
|
13927 |
|
13928 |
|
13929 <div class="params"> |
|
13930 <h4>Parameters:</h4> |
|
13931 |
|
13932 <ul class="params-list"> |
|
13933 |
|
13934 <li class="param"> |
|
13935 |
|
13936 <code class="param-name">type</code> |
|
13937 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13938 |
|
13939 |
|
13940 |
|
13941 |
|
13942 <div class="param-description"> |
|
13943 <p>the type, or name of the event</p> |
|
13944 </div> |
|
13945 |
|
13946 |
|
13947 </li> |
|
13948 |
|
13949 <li class="param"> |
|
13950 |
|
13951 <code class="param-name">opts</code> |
|
13952 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13953 |
|
13954 |
|
13955 |
|
13956 |
|
13957 <div class="param-description"> |
|
13958 <p>optional config params. Valid properties are:</p> |
|
13959 |
|
13960 <p><ul> |
|
13961 <li> |
|
13962 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false) |
|
13963 </li> |
|
13964 <li> |
|
13965 'bubbles': whether or not this event bubbles (true) |
|
13966 Events can only bubble if emitFacade is true. |
|
13967 </li> |
|
13968 <li> |
|
13969 'context': the default execution context for the listeners (this) |
|
13970 </li> |
|
13971 <li> |
|
13972 'defaultFn': the default function to execute when this event fires if preventDefault was not called |
|
13973 </li> |
|
13974 <li> |
|
13975 'emitFacade': whether or not this event emits a facade (false) |
|
13976 </li> |
|
13977 <li> |
|
13978 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' |
|
13979 </li> |
|
13980 <li> |
|
13981 'fireOnce': if an event is configured to fire once, new subscribers after |
|
13982 the fire will be notified immediately. |
|
13983 </li> |
|
13984 <li> |
|
13985 'async': fireOnce event listeners will fire synchronously if the event has already |
|
13986 fired unless async is true. |
|
13987 </li> |
|
13988 <li> |
|
13989 'preventable': whether or not preventDefault() has an effect (true) |
|
13990 </li> |
|
13991 <li> |
|
13992 'preventedFn': a function that is executed when preventDefault is called |
|
13993 </li> |
|
13994 <li> |
|
13995 'queuable': whether or not this event can be queued during bubbling (false) |
|
13996 </li> |
|
13997 <li> |
|
13998 'silent': if silent is true, debug messages are not provided for this event. |
|
13999 </li> |
|
14000 <li> |
|
14001 'stoppedFn': a function that is executed when stopPropagation is called |
|
14002 </li></p> |
|
14003 |
|
14004 <p><li> |
|
14005 'monitored': specifies whether or not this event should send notifications about |
|
14006 when the event has been attached, detached, or published. |
|
14007 </li> |
|
14008 <li> |
|
14009 'type': the event type (valid option if not provided as the first parameter to publish) |
|
14010 </li> |
|
14011 </ul></p> |
|
14012 </div> |
|
14013 |
|
14014 |
|
14015 </li> |
|
14016 |
|
14017 </ul> |
|
14018 </div> |
|
14019 |
|
14020 |
|
14021 |
|
14022 <div class="returns"> |
|
14023 <h4>Returns:</h4> |
|
14024 |
|
14025 <div class="returns-description"> |
|
14026 |
|
14027 |
|
14028 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
14029 |
|
14030 the custom event |
|
14031 |
|
14032 </div> |
|
14033 </div> |
|
14034 |
|
14035 |
|
14036 |
|
14037 </div> |
|
14038 |
|
14039 |
|
14040 <div id="method_removeAttr" class="method item inherited"> |
|
14041 <h3 class="name"><code>removeAttr</code></h3> |
|
14042 |
|
14043 |
|
14044 <div class="args"> |
|
14045 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14046 |
|
14047 <li class="arg"> |
|
14048 |
|
14049 <code>name</code> |
|
14050 |
|
14051 </li> |
|
14052 |
|
14053 </ul><span class="paren">)</span> |
|
14054 </div> |
|
14055 |
|
14056 |
|
14057 |
|
14058 |
|
14059 |
|
14060 |
|
14061 |
|
14062 |
|
14063 |
|
14064 |
|
14065 |
|
14066 |
|
14067 |
|
14068 |
|
14069 |
|
14070 |
|
14071 <div class="meta"> |
|
14072 |
|
14073 |
|
14074 <p>Inherited from |
|
14075 <a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>: |
|
14076 |
|
14077 |
|
14078 |
|
14079 <a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a> |
|
14080 |
|
14081 </p> |
|
14082 |
|
14083 |
|
14084 |
|
14085 |
|
14086 |
|
14087 </div> |
|
14088 |
|
14089 <div class="description"> |
|
14090 <p>Removes an attribute from the host object</p> |
|
14091 </div> |
|
14092 |
|
14093 |
|
14094 <div class="params"> |
|
14095 <h4>Parameters:</h4> |
|
14096 |
|
14097 <ul class="params-list"> |
|
14098 |
|
14099 <li class="param"> |
|
14100 |
|
14101 <code class="param-name">name</code> |
|
14102 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14103 |
|
14104 |
|
14105 |
|
14106 |
|
14107 <div class="param-description"> |
|
14108 <p>The name of the attribute to be removed.</p> |
|
14109 </div> |
|
14110 |
|
14111 |
|
14112 </li> |
|
14113 |
|
14114 </ul> |
|
14115 </div> |
|
14116 |
|
14117 |
|
14118 |
|
14119 |
|
14120 |
|
14121 </div> |
|
14122 |
|
14123 |
|
14124 <div id="method_removeQuery" class="method item inherited"> |
|
14125 <h3 class="name"><code>removeQuery</code></h3> |
|
14126 |
|
14127 |
|
14128 <div class="args"> |
|
14129 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14130 |
|
14131 <li class="arg"> |
|
14132 |
|
14133 <code>url</code> |
|
14134 |
|
14135 </li> |
|
14136 |
|
14137 </ul><span class="paren">)</span> |
|
14138 </div> |
|
14139 |
|
14140 |
|
14141 |
|
14142 <span class="returns-inline"> |
|
14143 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14144 </span> |
|
14145 |
|
14146 |
|
14147 |
|
14148 |
|
14149 |
|
14150 |
|
14151 |
|
14152 |
|
14153 |
|
14154 |
|
14155 |
|
14156 |
|
14157 |
|
14158 |
|
14159 <div class="meta"> |
|
14160 |
|
14161 |
|
14162 <p>Inherited from |
|
14163 <a href="../classes/Router.html#method_removeQuery">Router</a>: |
|
14164 |
|
14165 |
|
14166 |
|
14167 <a href="../files/app_js_router.js.html#l325"><code>app/js/router.js:325</code></a> |
|
14168 |
|
14169 </p> |
|
14170 |
|
14171 |
|
14172 |
|
14173 |
|
14174 |
|
14175 </div> |
|
14176 |
|
14177 <div class="description"> |
|
14178 <p>Removes a query string from the end of the <em>url</em> (if one exists) and returns |
|
14179 the result.</p> |
|
14180 </div> |
|
14181 |
|
14182 |
|
14183 <div class="params"> |
|
14184 <h4>Parameters:</h4> |
|
14185 |
|
14186 <ul class="params-list"> |
|
14187 |
|
14188 <li class="param"> |
|
14189 |
|
14190 <code class="param-name">url</code> |
|
14191 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14192 |
|
14193 |
|
14194 |
|
14195 |
|
14196 <div class="param-description"> |
|
14197 <p>URL.</p> |
|
14198 </div> |
|
14199 |
|
14200 |
|
14201 </li> |
|
14202 |
|
14203 </ul> |
|
14204 </div> |
|
14205 |
|
14206 |
|
14207 |
|
14208 <div class="returns"> |
|
14209 <h4>Returns:</h4> |
|
14210 |
|
14211 <div class="returns-description"> |
|
14212 |
|
14213 |
|
14214 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
14215 |
|
14216 Queryless path. |
|
14217 |
|
14218 </div> |
|
14219 </div> |
|
14220 |
|
14221 |
|
14222 |
|
14223 </div> |
|
14224 |
|
14225 |
|
14226 <div id="method_removeRoot" class="method item inherited"> |
|
14227 <h3 class="name"><code>removeRoot</code></h3> |
|
14228 |
|
14229 |
|
14230 <div class="args"> |
|
14231 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14232 |
|
14233 <li class="arg"> |
|
14234 |
|
14235 <code>url</code> |
|
14236 |
|
14237 </li> |
|
14238 |
|
14239 </ul><span class="paren">)</span> |
|
14240 </div> |
|
14241 |
|
14242 |
|
14243 |
|
14244 <span class="returns-inline"> |
|
14245 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14246 </span> |
|
14247 |
|
14248 |
|
14249 |
|
14250 |
|
14251 |
|
14252 |
|
14253 |
|
14254 |
|
14255 |
|
14256 |
|
14257 |
|
14258 |
|
14259 |
|
14260 |
|
14261 <div class="meta"> |
|
14262 |
|
14263 |
|
14264 <p>Inherited from |
|
14265 <a href="../classes/Router.html#method_removeRoot">Router</a>: |
|
14266 |
|
14267 |
|
14268 |
|
14269 <a href="../files/app_js_router.js.html#l303"><code>app/js/router.js:303</code></a> |
|
14270 |
|
14271 </p> |
|
14272 |
|
14273 |
|
14274 |
|
14275 |
|
14276 |
|
14277 </div> |
|
14278 |
|
14279 <div class="description"> |
|
14280 <p>Removes the <code>root</code> URL from the front of <em>url</em> (if it's there) and returns |
|
14281 the result. The returned path will always have a leading <code>/</code>.</p> |
|
14282 </div> |
|
14283 |
|
14284 |
|
14285 <div class="params"> |
|
14286 <h4>Parameters:</h4> |
|
14287 |
|
14288 <ul class="params-list"> |
|
14289 |
|
14290 <li class="param"> |
|
14291 |
|
14292 <code class="param-name">url</code> |
|
14293 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14294 |
|
14295 |
|
14296 |
|
14297 |
|
14298 <div class="param-description"> |
|
14299 <p>URL.</p> |
|
14300 </div> |
|
14301 |
|
14302 |
|
14303 </li> |
|
14304 |
|
14305 </ul> |
|
14306 </div> |
|
14307 |
|
14308 |
|
14309 |
|
14310 <div class="returns"> |
|
14311 <h4>Returns:</h4> |
|
14312 |
|
14313 <div class="returns-description"> |
|
14314 |
|
14315 |
|
14316 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
14317 |
|
14318 Rootless path. |
|
14319 |
|
14320 </div> |
|
14321 </div> |
|
14322 |
|
14323 |
|
14324 |
|
14325 </div> |
|
14326 |
|
14327 |
|
14328 <div id="method_removeTarget" class="method item inherited"> |
|
14329 <h3 class="name"><code>removeTarget</code></h3> |
|
14330 |
|
14331 |
|
14332 <div class="args"> |
|
14333 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14334 |
|
14335 <li class="arg"> |
|
14336 |
|
14337 <code>o</code> |
|
14338 |
|
14339 </li> |
|
14340 |
|
14341 </ul><span class="paren">)</span> |
|
14342 </div> |
|
14343 |
|
14344 |
|
14345 |
|
14346 |
|
14347 |
|
14348 |
|
14349 |
|
14350 |
|
14351 |
|
14352 |
|
14353 |
|
14354 |
|
14355 |
|
14356 |
|
14357 |
|
14358 |
|
14359 <div class="meta"> |
|
14360 |
|
14361 |
|
14362 <p>Inherited from |
|
14363 <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>: |
|
14364 |
|
14365 |
|
14366 |
|
14367 <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a> |
|
14368 |
|
14369 </p> |
|
14370 |
|
14371 |
|
14372 |
|
14373 |
|
14374 |
|
14375 </div> |
|
14376 |
|
14377 <div class="description"> |
|
14378 <p>Removes a bubble target</p> |
|
14379 </div> |
|
14380 |
|
14381 |
|
14382 <div class="params"> |
|
14383 <h4>Parameters:</h4> |
|
14384 |
|
14385 <ul class="params-list"> |
|
14386 |
|
14387 <li class="param"> |
|
14388 |
|
14389 <code class="param-name">o</code> |
|
14390 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
14391 |
|
14392 |
|
14393 |
|
14394 |
|
14395 <div class="param-description"> |
|
14396 <p>the target to remove</p> |
|
14397 </div> |
|
14398 |
|
14399 |
|
14400 </li> |
|
14401 |
|
14402 </ul> |
|
14403 </div> |
|
14404 |
|
14405 |
|
14406 |
|
14407 |
|
14408 |
|
14409 </div> |
|
14410 |
|
14411 |
|
14412 <div id="method_replace" class="method item inherited"> |
|
14413 <h3 class="name"><code>replace</code></h3> |
|
14414 |
|
14415 |
|
14416 <div class="args"> |
|
14417 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14418 |
|
14419 <li class="arg"> |
|
14420 |
|
14421 <code class="optional">[url]</code> |
|
14422 |
|
14423 </li> |
|
14424 |
|
14425 </ul><span class="paren">)</span> |
|
14426 </div> |
|
14427 |
|
14428 |
|
14429 |
|
14430 |
|
14431 |
|
14432 |
|
14433 |
|
14434 |
|
14435 |
|
14436 |
|
14437 |
|
14438 |
|
14439 |
|
14440 <span class="flag chainable">chainable</span> |
|
14441 |
|
14442 |
|
14443 |
|
14444 |
|
14445 <div class="meta"> |
|
14446 |
|
14447 |
|
14448 <p>Inherited from |
|
14449 <a href="../classes/Router.html#method_replace">Router</a>: |
|
14450 |
|
14451 |
|
14452 |
|
14453 <a href="../files/app_js_router.js.html#l337"><code>app/js/router.js:337</code></a> |
|
14454 |
|
14455 </p> |
|
14456 |
|
14457 |
|
14458 |
|
14459 |
|
14460 |
|
14461 </div> |
|
14462 |
|
14463 <div class="description"> |
|
14464 <p>Replaces the current browser history entry with a new one, and dispatches to |
|
14465 the first matching route handler, if any.</p> |
|
14466 |
|
14467 <p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that |
|
14468 support it (or the location hash in older browsers and IE) to change the |
|
14469 URL.</p> |
|
14470 |
|
14471 <p>The specified URL must share the same origin (i.e., protocol, host, and |
|
14472 port) as the current page, or an error will occur.</p> |
|
14473 </div> |
|
14474 |
|
14475 |
|
14476 <div class="params"> |
|
14477 <h4>Parameters:</h4> |
|
14478 |
|
14479 <ul class="params-list"> |
|
14480 |
|
14481 <li class="param"> |
|
14482 |
|
14483 <code class="param-name optional">[url]</code> |
|
14484 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14485 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14486 |
|
14487 |
|
14488 |
|
14489 |
|
14490 <div class="param-description"> |
|
14491 <p>URL to set. This URL needs to be of the same origin as |
|
14492 the current URL. This can be a URL relative to the router's <code>root</code> |
|
14493 attribute. If no URL is specified, the page's current URL will be used.</p> |
|
14494 </div> |
|
14495 |
|
14496 |
|
14497 </li> |
|
14498 |
|
14499 </ul> |
|
14500 </div> |
|
14501 |
|
14502 |
|
14503 |
|
14504 |
|
14505 |
|
14506 <div class="example"> |
|
14507 <h4>Example:</h4> |
|
14508 |
|
14509 <div class="example-content"> |
|
14510 <pre class="code prettyprint"><code>// Starting URL: http://example.com/ |
|
14511 |
|
14512 router.replace('/path/'); |
|
14513 // New URL: http://example.com/path/ |
|
14514 |
|
14515 router.replace('/path?foo=bar'); |
|
14516 // New URL: http://example.com/path?foo=bar |
|
14517 |
|
14518 router.replace('/'); |
|
14519 // New URL: http://example.com/ |
|
14520 </code></pre> |
|
14521 </div> |
|
14522 </div> |
|
14523 |
|
14524 </div> |
|
14525 |
|
14526 |
|
14527 <div id="method_reset" class="method item inherited"> |
|
14528 <h3 class="name"><code>reset</code></h3> |
|
14529 |
|
14530 |
|
14531 <div class="args"> |
|
14532 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14533 |
|
14534 <li class="arg"> |
|
14535 |
|
14536 <code>name</code> |
|
14537 |
|
14538 </li> |
|
14539 |
|
14540 </ul><span class="paren">)</span> |
|
14541 </div> |
|
14542 |
|
14543 |
|
14544 |
|
14545 <span class="returns-inline"> |
|
14546 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14547 </span> |
|
14548 |
|
14549 |
|
14550 |
|
14551 |
|
14552 |
|
14553 |
|
14554 |
|
14555 |
|
14556 |
|
14557 |
|
14558 |
|
14559 <span class="flag chainable">chainable</span> |
|
14560 |
|
14561 |
|
14562 |
|
14563 |
|
14564 <div class="meta"> |
|
14565 |
|
14566 |
|
14567 <p>Inherited from |
|
14568 <a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>: |
|
14569 |
|
14570 |
|
14571 |
|
14572 <a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a> |
|
14573 |
|
14574 </p> |
|
14575 |
|
14576 |
|
14577 |
|
14578 |
|
14579 |
|
14580 </div> |
|
14581 |
|
14582 <div class="description"> |
|
14583 <p>Resets the attribute (or all attributes) to its initial value, as long as |
|
14584 the attribute is not readOnly, or writeOnce.</p> |
|
14585 </div> |
|
14586 |
|
14587 |
|
14588 <div class="params"> |
|
14589 <h4>Parameters:</h4> |
|
14590 |
|
14591 <ul class="params-list"> |
|
14592 |
|
14593 <li class="param"> |
|
14594 |
|
14595 <code class="param-name">name</code> |
|
14596 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14597 |
|
14598 |
|
14599 |
|
14600 |
|
14601 <div class="param-description"> |
|
14602 <p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p> |
|
14603 </div> |
|
14604 |
|
14605 |
|
14606 </li> |
|
14607 |
|
14608 </ul> |
|
14609 </div> |
|
14610 |
|
14611 |
|
14612 |
|
14613 <div class="returns"> |
|
14614 <h4>Returns:</h4> |
|
14615 |
|
14616 <div class="returns-description"> |
|
14617 |
|
14618 |
|
14619 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
14620 |
|
14621 A reference to the host object. |
|
14622 |
|
14623 </div> |
|
14624 </div> |
|
14625 |
|
14626 |
|
14627 |
|
14628 </div> |
|
14629 |
|
14630 |
|
14631 <div id="method_route" class="method item inherited"> |
|
14632 <h3 class="name"><code>route</code></h3> |
|
14633 |
|
14634 |
|
14635 <div class="args"> |
|
14636 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14637 |
|
14638 <li class="arg"> |
|
14639 |
|
14640 <code>path</code> |
|
14641 |
|
14642 </li> |
|
14643 |
|
14644 <li class="arg"> |
|
14645 |
|
14646 <code>callbacks</code> |
|
14647 |
|
14648 </li> |
|
14649 |
|
14650 </ul><span class="paren">)</span> |
|
14651 </div> |
|
14652 |
|
14653 |
|
14654 |
|
14655 |
|
14656 |
|
14657 |
|
14658 |
|
14659 |
|
14660 |
|
14661 |
|
14662 |
|
14663 |
|
14664 |
|
14665 <span class="flag chainable">chainable</span> |
|
14666 |
|
14667 |
|
14668 |
|
14669 |
|
14670 <div class="meta"> |
|
14671 |
|
14672 |
|
14673 <p>Inherited from |
|
14674 <a href="../classes/Router.html#method_route">Router</a>: |
|
14675 |
|
14676 |
|
14677 |
|
14678 <a href="../files/app_js_router.js.html#l371"><code>app/js/router.js:371</code></a> |
|
14679 |
|
14680 </p> |
|
14681 |
|
14682 |
|
14683 |
|
14684 |
|
14685 |
|
14686 </div> |
|
14687 |
|
14688 <div class="description"> |
|
14689 <p>Adds a route handler for the specified URL <em>path</em>.</p> |
|
14690 |
|
14691 <p>The <em>path</em> parameter may be either a string or a regular expression. If it's |
|
14692 a string, it may contain named parameters: <code>:param</code> will match any single |
|
14693 part of a URL path (not including <code>/</code> characters), and <code>*param</code> will match |
|
14694 any number of parts of a URL path (including <code>/</code> characters). These named |
|
14695 parameters will be made available as keys on the <code>req.params</code> object that's |
|
14696 passed to route handlers.</p> |
|
14697 |
|
14698 <p>If the <em>path</em> parameter is a regex, all pattern matches will be made |
|
14699 available as numbered keys on <code>req.params</code>, starting with <code>0</code> for the full |
|
14700 match, then <code>1</code> for the first subpattern match, and so on.</p> |
|
14701 |
|
14702 <p>Here's a set of sample routes along with URL paths that they match:</p> |
|
14703 |
|
14704 <ul> |
|
14705 <li><p>Route: <code>/photos/:tag/:page</code></p> |
|
14706 |
|
14707 <ul><li>URL: <code>/photos/kittens/1</code>, params: <code>{tag: 'kittens', page: '1'}</code></li> |
|
14708 <li>URL: <code>/photos/puppies/2</code>, params: <code>{tag: 'puppies', page: '2'}</code></li></ul></li> |
|
14709 <li><p>Route: <code>/file/*path</code></p> |
|
14710 |
|
14711 <ul><li>URL: <code>/file/foo/bar/baz.txt</code>, params: <code>{path: 'foo/bar/baz.txt'}</code></li> |
|
14712 <li>URL: <code>/file/foo</code>, params: <code>{path: 'foo'}</code></li></ul></li> |
|
14713 </ul> |
|
14714 |
|
14715 <p><strong>Middleware</strong>: Routes also support an arbitrary number of callback |
|
14716 functions. This allows you to easily reuse parts of your route-handling code |
|
14717 with different route. This method is liberal in how it processes the |
|
14718 specified <code>callbacks</code>, you can specify them as separate arguments, or as |
|
14719 arrays, or both.</p> |
|
14720 |
|
14721 <p>If multiple route match a given URL, they will be executed in the order they |
|
14722 were added. The first route that was added will be the first to be executed.</p> |
|
14723 |
|
14724 <p><strong>Passing Control</strong>: Invoking the <code>next()</code> function within a route callback |
|
14725 will pass control to the next callback function (if any) or route handler |
|
14726 (if any). If a value is passed to <code>next()</code>, it's assumed to be an error, |
|
14727 therefore stopping the dispatch chain, unless that value is: <code>"route"</code>, |
|
14728 which is special case and dispatching will skip to the next route handler. |
|
14729 This allows middleware to skip any remaining middleware for a particular |
|
14730 route.</p> |
|
14731 </div> |
|
14732 |
|
14733 |
|
14734 <div class="params"> |
|
14735 <h4>Parameters:</h4> |
|
14736 |
|
14737 <ul class="params-list"> |
|
14738 |
|
14739 <li class="param"> |
|
14740 |
|
14741 <code class="param-name">path</code> |
|
14742 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
14743 |
|
14744 |
|
14745 |
|
14746 |
|
14747 <div class="param-description"> |
|
14748 <p>Path to match. May be a string or a regular |
|
14749 expression.</p> |
|
14750 </div> |
|
14751 |
|
14752 |
|
14753 </li> |
|
14754 |
|
14755 <li class="param"> |
|
14756 |
|
14757 <code class="param-name">callbacks</code> |
|
14758 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14759 |
|
14760 |
|
14761 |
|
14762 <span class="flag multiple" title="This argument may occur one or more times.">multiple</span> |
|
14763 |
|
14764 |
|
14765 <div class="param-description"> |
|
14766 <p>Callback functions to call |
|
14767 whenever this route is triggered. These can be specified as separate |
|
14768 arguments, or in arrays, or both. If a callback is specified as a |
|
14769 string, the named function will be called on this router instance.</p> |
|
14770 </div> |
|
14771 |
|
14772 |
|
14773 <ul class="params-list"> |
|
14774 |
|
14775 <li class="param"> |
|
14776 |
|
14777 <code class="param-name">req</code> |
|
14778 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14779 |
|
14780 |
|
14781 <div class="param-description"> |
|
14782 <p>Request object containing information about |
|
14783 the request. It contains the following properties.</p> |
|
14784 </div> |
|
14785 |
|
14786 |
|
14787 <ul class="params-list"> |
|
14788 |
|
14789 <li class="param"> |
|
14790 |
|
14791 <code class="param-name">params</code> |
|
14792 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14793 |
|
14794 |
|
14795 <div class="param-description"> |
|
14796 Captured parameters matched by |
|
14797 the route path specification. If a string path was used and contained |
|
14798 named parameters, then this will be a key/value hash mapping parameter |
|
14799 names to their matched values. If a regex path was used, this will be |
|
14800 an array of subpattern matches starting at index 0 for the full match, |
|
14801 then 1 for the first subpattern match, and so on. |
|
14802 </div> |
|
14803 </li> |
|
14804 |
|
14805 <li class="param"> |
|
14806 |
|
14807 <code class="param-name">path</code> |
|
14808 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14809 |
|
14810 |
|
14811 <div class="param-description"> |
|
14812 The current URL path. |
|
14813 </div> |
|
14814 </li> |
|
14815 |
|
14816 <li class="param"> |
|
14817 |
|
14818 <code class="param-name">pendingCallbacks</code> |
|
14819 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
14820 |
|
14821 |
|
14822 <div class="param-description"> |
|
14823 Number of remaining |
|
14824 callbacks the route handler has after this one in the dispatch chain. |
|
14825 </div> |
|
14826 </li> |
|
14827 |
|
14828 <li class="param"> |
|
14829 |
|
14830 <code class="param-name">pendingRoutes</code> |
|
14831 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
14832 |
|
14833 |
|
14834 <div class="param-description"> |
|
14835 Number of matching routes |
|
14836 after this one in the dispatch chain. |
|
14837 </div> |
|
14838 </li> |
|
14839 |
|
14840 <li class="param"> |
|
14841 |
|
14842 <code class="param-name">query</code> |
|
14843 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14844 |
|
14845 |
|
14846 <div class="param-description"> |
|
14847 Query hash representing the URL |
|
14848 query string, if any. Parameter names are keys, and are mapped to |
|
14849 parameter values. |
|
14850 </div> |
|
14851 </li> |
|
14852 |
|
14853 <li class="param"> |
|
14854 |
|
14855 <code class="param-name">url</code> |
|
14856 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14857 |
|
14858 |
|
14859 <div class="param-description"> |
|
14860 The full URL. |
|
14861 </div> |
|
14862 </li> |
|
14863 |
|
14864 <li class="param"> |
|
14865 |
|
14866 <code class="param-name">src</code> |
|
14867 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14868 |
|
14869 |
|
14870 <div class="param-description"> |
|
14871 What initiated the dispatch. In an |
|
14872 HTML5 browser, when the back/forward buttons are used, this property |
|
14873 will have a value of "popstate". |
|
14874 </div> |
|
14875 </li> |
|
14876 |
|
14877 </ul> |
|
14878 |
|
14879 </li> |
|
14880 |
|
14881 <li class="param"> |
|
14882 |
|
14883 <code class="param-name">res</code> |
|
14884 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14885 |
|
14886 |
|
14887 <div class="param-description"> |
|
14888 <p>Response object containing methods and |
|
14889 information that relate to responding to a request. It contains the |
|
14890 following properties.</p> |
|
14891 </div> |
|
14892 |
|
14893 |
|
14894 <ul class="params-list"> |
|
14895 |
|
14896 <li class="param"> |
|
14897 |
|
14898 <code class="param-name">req</code> |
|
14899 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14900 |
|
14901 |
|
14902 <div class="param-description"> |
|
14903 Reference to the request object. |
|
14904 </div> |
|
14905 </li> |
|
14906 |
|
14907 </ul> |
|
14908 |
|
14909 </li> |
|
14910 |
|
14911 <li class="param"> |
|
14912 |
|
14913 <code class="param-name">next</code> |
|
14914 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
14915 |
|
14916 |
|
14917 <div class="param-description"> |
|
14918 <p>Function to pass control to the next |
|
14919 callback or the next matching route if no more callbacks (middleware) |
|
14920 exist for the current route handler. If you don't call this function, |
|
14921 then no further callbacks or route handlers will be executed, even if |
|
14922 there are more that match. If you do call this function, then the next |
|
14923 callback (if any) or matching route handler (if any) will be called. |
|
14924 All of these functions will receive the same <code>req</code> and <code>res</code> objects |
|
14925 that were passed to this route (so you can use these objects to pass |
|
14926 data along to subsequent callbacks and routes).</p> |
|
14927 </div> |
|
14928 |
|
14929 |
|
14930 <ul class="params-list"> |
|
14931 |
|
14932 <li class="param"> |
|
14933 |
|
14934 <code class="param-name optional">[err]</code> |
|
14935 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14936 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14937 |
|
14938 |
|
14939 <div class="param-description"> |
|
14940 Optional error which will stop the |
|
14941 dispatch chaining for this <code>req</code>, unless the value is <code>"route"</code>, which |
|
14942 is special cased to jump skip past any callbacks for the current route |
|
14943 and pass control the next route handler. |
|
14944 </div> |
|
14945 </li> |
|
14946 |
|
14947 </ul> |
|
14948 |
|
14949 </li> |
|
14950 |
|
14951 </ul> |
|
14952 |
|
14953 </li> |
|
14954 |
|
14955 </ul> |
|
14956 </div> |
|
14957 |
|
14958 |
|
14959 |
|
14960 |
|
14961 |
|
14962 <div class="example"> |
|
14963 <h4>Example:</h4> |
|
14964 |
|
14965 <div class="example-content"> |
|
14966 <pre class="code prettyprint"><code>router.route('/photos/:tag/:page', function (req, res, next) { |
|
14967 Y.log('Current tag: ' + req.params.tag); |
|
14968 Y.log('Current page number: ' + req.params.page); |
|
14969 }); |
|
14970 |
|
14971 // Using middleware. |
|
14972 |
|
14973 router.findUser = function (req, res, next) { |
|
14974 req.user = this.get('users').findById(req.params.user); |
|
14975 next(); |
|
14976 }; |
|
14977 |
|
14978 router.route('/users/:user', 'findUser', function (req, res, next) { |
|
14979 // The <code>findUser</code> middleware puts the <code>user</code> object on the <code>req</code>. |
|
14980 Y.log('Current user:' req.user.get('name')); |
|
14981 }); |
|
14982 </code></pre> |
|
14983 </div> |
|
14984 </div> |
|
14985 |
|
14986 </div> |
|
14987 |
|
14988 |
|
14989 <div id="method_save" class="method item inherited"> |
|
14990 <h3 class="name"><code>save</code></h3> |
|
14991 |
|
14992 |
|
14993 <div class="args"> |
|
14994 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14995 |
|
14996 <li class="arg"> |
|
14997 |
|
14998 <code class="optional">[url]</code> |
|
14999 |
|
15000 </li> |
|
15001 |
|
15002 </ul><span class="paren">)</span> |
|
15003 </div> |
|
15004 |
|
15005 |
|
15006 |
|
15007 |
|
15008 |
|
15009 |
|
15010 |
|
15011 |
|
15012 |
|
15013 |
|
15014 |
|
15015 |
|
15016 |
|
15017 <span class="flag chainable">chainable</span> |
|
15018 |
|
15019 |
|
15020 |
|
15021 |
|
15022 <div class="meta"> |
|
15023 |
|
15024 |
|
15025 <p>Inherited from |
|
15026 <a href="../classes/Router.html#method_save">Router</a>: |
|
15027 |
|
15028 |
|
15029 |
|
15030 <a href="../files/app_js_router.js.html#l498"><code>app/js/router.js:498</code></a> |
|
15031 |
|
15032 </p> |
|
15033 |
|
15034 |
|
15035 |
|
15036 |
|
15037 |
|
15038 </div> |
|
15039 |
|
15040 <div class="description"> |
|
15041 <p>Saves a new browser history entry and dispatches to the first matching route |
|
15042 handler, if any.</p> |
|
15043 |
|
15044 <p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that |
|
15045 support it (or the location hash in older browsers and IE) to change the |
|
15046 URL and create a history entry.</p> |
|
15047 |
|
15048 <p>The specified URL must share the same origin (i.e., protocol, host, and |
|
15049 port) as the current page, or an error will occur.</p> |
|
15050 </div> |
|
15051 |
|
15052 |
|
15053 <div class="params"> |
|
15054 <h4>Parameters:</h4> |
|
15055 |
|
15056 <ul class="params-list"> |
|
15057 |
|
15058 <li class="param"> |
|
15059 |
|
15060 <code class="param-name optional">[url]</code> |
|
15061 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15062 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15063 |
|
15064 |
|
15065 |
|
15066 |
|
15067 <div class="param-description"> |
|
15068 <p>URL to set. This URL needs to be of the same origin as |
|
15069 the current URL. This can be a URL relative to the router's <code>root</code> |
|
15070 attribute. If no URL is specified, the page's current URL will be used.</p> |
|
15071 </div> |
|
15072 |
|
15073 |
|
15074 </li> |
|
15075 |
|
15076 </ul> |
|
15077 </div> |
|
15078 |
|
15079 |
|
15080 |
|
15081 |
|
15082 |
|
15083 <div class="example"> |
|
15084 <h4>Example:</h4> |
|
15085 |
|
15086 <div class="example-content"> |
|
15087 <pre class="code prettyprint"><code>// Starting URL: http://example.com/ |
|
15088 |
|
15089 router.save('/path/'); |
|
15090 // New URL: http://example.com/path/ |
|
15091 |
|
15092 router.save('/path?foo=bar'); |
|
15093 // New URL: http://example.com/path?foo=bar |
|
15094 |
|
15095 router.save('/'); |
|
15096 // New URL: http://example.com/ |
|
15097 </code></pre> |
|
15098 </div> |
|
15099 </div> |
|
15100 |
|
15101 </div> |
|
15102 |
|
15103 |
|
15104 <div id="method_set" class="method item inherited"> |
|
15105 <h3 class="name"><code>set</code></h3> |
|
15106 |
|
15107 |
|
15108 <div class="args"> |
|
15109 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15110 |
|
15111 <li class="arg"> |
|
15112 |
|
15113 <code>name</code> |
|
15114 |
|
15115 </li> |
|
15116 |
|
15117 <li class="arg"> |
|
15118 |
|
15119 <code>value</code> |
|
15120 |
|
15121 </li> |
|
15122 |
|
15123 <li class="arg"> |
|
15124 |
|
15125 <code class="optional">[opts]</code> |
|
15126 |
|
15127 </li> |
|
15128 |
|
15129 </ul><span class="paren">)</span> |
|
15130 </div> |
|
15131 |
|
15132 |
|
15133 |
|
15134 <span class="returns-inline"> |
|
15135 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15136 </span> |
|
15137 |
|
15138 |
|
15139 |
|
15140 |
|
15141 |
|
15142 |
|
15143 |
|
15144 |
|
15145 |
|
15146 |
|
15147 |
|
15148 <span class="flag chainable">chainable</span> |
|
15149 |
|
15150 |
|
15151 |
|
15152 |
|
15153 <div class="meta"> |
|
15154 |
|
15155 <p>Inherited from |
|
15156 <a href="../classes/AttributeObservable.html#method_set"> |
|
15157 AttributeObservable |
|
15158 </a> |
|
15159 |
|
15160 but overwritten in |
|
15161 |
|
15162 |
|
15163 |
|
15164 <a href="../files/attribute_js_AttributeCore.js.html#l410"><code>attribute/js/AttributeCore.js:410</code></a> |
|
15165 |
|
15166 </p> |
|
15167 |
|
15168 |
|
15169 |
|
15170 |
|
15171 |
|
15172 </div> |
|
15173 |
|
15174 <div class="description"> |
|
15175 <p>Sets the value of an attribute.</p> |
|
15176 </div> |
|
15177 |
|
15178 |
|
15179 <div class="params"> |
|
15180 <h4>Parameters:</h4> |
|
15181 |
|
15182 <ul class="params-list"> |
|
15183 |
|
15184 <li class="param"> |
|
15185 |
|
15186 <code class="param-name">name</code> |
|
15187 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15188 |
|
15189 |
|
15190 |
|
15191 |
|
15192 <div class="param-description"> |
|
15193 <p>The name of the attribute. If the |
|
15194 current value of the attribute is an Object, dot notation can be used |
|
15195 to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p> |
|
15196 </div> |
|
15197 |
|
15198 |
|
15199 </li> |
|
15200 |
|
15201 <li class="param"> |
|
15202 |
|
15203 <code class="param-name">value</code> |
|
15204 <span class="type">Any</span> |
|
15205 |
|
15206 |
|
15207 |
|
15208 |
|
15209 <div class="param-description"> |
|
15210 <p>The value to set the attribute to.</p> |
|
15211 </div> |
|
15212 |
|
15213 |
|
15214 </li> |
|
15215 |
|
15216 <li class="param"> |
|
15217 |
|
15218 <code class="param-name optional">[opts]</code> |
|
15219 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15220 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15221 |
|
15222 |
|
15223 |
|
15224 |
|
15225 <div class="param-description"> |
|
15226 <p>Optional data providing the circumstances for the change.</p> |
|
15227 </div> |
|
15228 |
|
15229 |
|
15230 </li> |
|
15231 |
|
15232 </ul> |
|
15233 </div> |
|
15234 |
|
15235 |
|
15236 |
|
15237 <div class="returns"> |
|
15238 <h4>Returns:</h4> |
|
15239 |
|
15240 <div class="returns-description"> |
|
15241 |
|
15242 |
|
15243 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15244 |
|
15245 A reference to the host object. |
|
15246 |
|
15247 </div> |
|
15248 </div> |
|
15249 |
|
15250 |
|
15251 |
|
15252 </div> |
|
15253 |
|
15254 |
|
15255 <div id="method_setAttrs" class="method item inherited"> |
|
15256 <h3 class="name"><code>setAttrs</code></h3> |
|
15257 |
|
15258 |
|
15259 <div class="args"> |
|
15260 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15261 |
|
15262 <li class="arg"> |
|
15263 |
|
15264 <code>attrs</code> |
|
15265 |
|
15266 </li> |
|
15267 |
|
15268 <li class="arg"> |
|
15269 |
|
15270 <code class="optional">[opts]</code> |
|
15271 |
|
15272 </li> |
|
15273 |
|
15274 </ul><span class="paren">)</span> |
|
15275 </div> |
|
15276 |
|
15277 |
|
15278 |
|
15279 <span class="returns-inline"> |
|
15280 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15281 </span> |
|
15282 |
|
15283 |
|
15284 |
|
15285 |
|
15286 |
|
15287 |
|
15288 |
|
15289 |
|
15290 |
|
15291 |
|
15292 |
|
15293 <span class="flag chainable">chainable</span> |
|
15294 |
|
15295 |
|
15296 |
|
15297 |
|
15298 <div class="meta"> |
|
15299 |
|
15300 <p>Inherited from |
|
15301 <a href="../classes/AttributeObservable.html#method_setAttrs"> |
|
15302 AttributeObservable |
|
15303 </a> |
|
15304 |
|
15305 but overwritten in |
|
15306 |
|
15307 |
|
15308 |
|
15309 <a href="../files/attribute_js_AttributeCore.js.html#l729"><code>attribute/js/AttributeCore.js:729</code></a> |
|
15310 |
|
15311 </p> |
|
15312 |
|
15313 |
|
15314 |
|
15315 |
|
15316 |
|
15317 </div> |
|
15318 |
|
15319 <div class="description"> |
|
15320 <p>Sets multiple attribute values.</p> |
|
15321 </div> |
|
15322 |
|
15323 |
|
15324 <div class="params"> |
|
15325 <h4>Parameters:</h4> |
|
15326 |
|
15327 <ul class="params-list"> |
|
15328 |
|
15329 <li class="param"> |
|
15330 |
|
15331 <code class="param-name">attrs</code> |
|
15332 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15333 |
|
15334 |
|
15335 |
|
15336 |
|
15337 <div class="param-description"> |
|
15338 <p>An object with attributes name/value pairs.</p> |
|
15339 </div> |
|
15340 |
|
15341 |
|
15342 </li> |
|
15343 |
|
15344 <li class="param"> |
|
15345 |
|
15346 <code class="param-name optional">[opts]</code> |
|
15347 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15348 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15349 |
|
15350 |
|
15351 |
|
15352 |
|
15353 <div class="param-description"> |
|
15354 <p>Optional data providing the circumstances for the change.</p> |
|
15355 </div> |
|
15356 |
|
15357 |
|
15358 </li> |
|
15359 |
|
15360 </ul> |
|
15361 </div> |
|
15362 |
|
15363 |
|
15364 |
|
15365 <div class="returns"> |
|
15366 <h4>Returns:</h4> |
|
15367 |
|
15368 <div class="returns-description"> |
|
15369 |
|
15370 |
|
15371 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15372 |
|
15373 A reference to the host object. |
|
15374 |
|
15375 </div> |
|
15376 </div> |
|
15377 |
|
15378 |
|
15379 |
|
15380 </div> |
|
15381 |
|
15382 |
|
15383 <div id="method_subscribe" class="method item deprecated inherited"> |
|
15384 <h3 class="name"><code>subscribe</code></h3> |
|
15385 |
|
15386 |
|
15387 <span class="paren">()</span> |
|
15388 |
|
15389 |
|
15390 |
|
15391 |
|
15392 |
|
15393 <span class="flag deprecated" title="use on">deprecated</span> |
|
15394 |
|
15395 |
|
15396 |
|
15397 |
|
15398 |
|
15399 |
|
15400 |
|
15401 |
|
15402 |
|
15403 |
|
15404 |
|
15405 |
|
15406 <div class="meta"> |
|
15407 |
|
15408 |
|
15409 <p>Inherited from |
|
15410 <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>: |
|
15411 |
|
15412 |
|
15413 |
|
15414 <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a> |
|
15415 |
|
15416 </p> |
|
15417 |
|
15418 |
|
15419 |
|
15420 <p>Deprecated: use on</p> |
|
15421 |
|
15422 |
|
15423 |
|
15424 </div> |
|
15425 |
|
15426 <div class="description"> |
|
15427 <p>subscribe to an event</p> |
|
15428 </div> |
|
15429 |
|
15430 |
|
15431 |
|
15432 |
|
15433 |
|
15434 |
|
15435 </div> |
|
15436 |
|
15437 |
|
15438 <div id="method_toString" class="method item inherited"> |
|
15439 <h3 class="name"><code>toString</code></h3> |
|
15440 |
|
15441 |
|
15442 <span class="paren">()</span> |
|
15443 |
|
15444 |
|
15445 |
|
15446 <span class="returns-inline"> |
|
15447 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15448 </span> |
|
15449 |
|
15450 |
|
15451 |
|
15452 |
|
15453 |
|
15454 |
|
15455 |
|
15456 |
|
15457 |
|
15458 |
|
15459 |
|
15460 |
|
15461 |
|
15462 |
|
15463 <div class="meta"> |
|
15464 |
|
15465 |
|
15466 <p>Inherited from |
|
15467 <a href="../classes/BaseCore.html#method_toString">BaseCore</a>: |
|
15468 |
|
15469 |
|
15470 |
|
15471 <a href="../files/base_js_BaseCore.js.html#l754"><code>base/js/BaseCore.js:754</code></a> |
|
15472 |
|
15473 </p> |
|
15474 |
|
15475 |
|
15476 |
|
15477 |
|
15478 |
|
15479 </div> |
|
15480 |
|
15481 <div class="description"> |
|
15482 <p>Default toString implementation. Provides the constructor NAME |
|
15483 and the instance guid, if set.</p> |
|
15484 </div> |
|
15485 |
|
15486 |
|
15487 |
|
15488 |
|
15489 <div class="returns"> |
|
15490 <h4>Returns:</h4> |
|
15491 |
|
15492 <div class="returns-description"> |
|
15493 |
|
15494 |
|
15495 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
15496 |
|
15497 String representation for this object |
|
15498 |
|
15499 </div> |
|
15500 </div> |
|
15501 |
|
15502 |
|
15503 |
|
15504 </div> |
|
15505 |
|
15506 |
|
15507 <div id="method_unsubscribe" class="method item deprecated inherited"> |
|
15508 <h3 class="name"><code>unsubscribe</code></h3> |
|
15509 |
|
15510 |
|
15511 <span class="paren">()</span> |
|
15512 |
|
15513 |
|
15514 |
|
15515 |
|
15516 |
|
15517 <span class="flag deprecated" title="use detach">deprecated</span> |
|
15518 |
|
15519 |
|
15520 |
|
15521 |
|
15522 |
|
15523 |
|
15524 |
|
15525 |
|
15526 |
|
15527 |
|
15528 |
|
15529 |
|
15530 <div class="meta"> |
|
15531 |
|
15532 |
|
15533 <p>Inherited from |
|
15534 <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>: |
|
15535 |
|
15536 |
|
15537 |
|
15538 <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a> |
|
15539 |
|
15540 </p> |
|
15541 |
|
15542 |
|
15543 |
|
15544 <p>Deprecated: use detach</p> |
|
15545 |
|
15546 |
|
15547 |
|
15548 </div> |
|
15549 |
|
15550 <div class="description"> |
|
15551 <p>detach a listener</p> |
|
15552 </div> |
|
15553 |
|
15554 |
|
15555 |
|
15556 |
|
15557 |
|
15558 |
|
15559 </div> |
|
15560 |
|
15561 |
|
15562 <div id="method_unsubscribeAll" class="method item deprecated inherited"> |
|
15563 <h3 class="name"><code>unsubscribeAll</code></h3> |
|
15564 |
|
15565 |
|
15566 <div class="args"> |
|
15567 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15568 |
|
15569 <li class="arg"> |
|
15570 |
|
15571 <code>type</code> |
|
15572 |
|
15573 </li> |
|
15574 |
|
15575 </ul><span class="paren">)</span> |
|
15576 </div> |
|
15577 |
|
15578 |
|
15579 |
|
15580 |
|
15581 |
|
15582 <span class="flag deprecated" title="use detachAll">deprecated</span> |
|
15583 |
|
15584 |
|
15585 |
|
15586 |
|
15587 |
|
15588 |
|
15589 |
|
15590 |
|
15591 |
|
15592 |
|
15593 |
|
15594 |
|
15595 <div class="meta"> |
|
15596 |
|
15597 |
|
15598 <p>Inherited from |
|
15599 <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>: |
|
15600 |
|
15601 |
|
15602 |
|
15603 <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a> |
|
15604 |
|
15605 </p> |
|
15606 |
|
15607 |
|
15608 |
|
15609 <p>Deprecated: use detachAll</p> |
|
15610 |
|
15611 |
|
15612 |
|
15613 </div> |
|
15614 |
|
15615 <div class="description"> |
|
15616 <p>Removes all listeners from the specified event. If the event type |
|
15617 is not specified, all listeners from all hosted custom events will |
|
15618 be removed.</p> |
|
15619 </div> |
|
15620 |
|
15621 |
|
15622 <div class="params"> |
|
15623 <h4>Parameters:</h4> |
|
15624 |
|
15625 <ul class="params-list"> |
|
15626 |
|
15627 <li class="param"> |
|
15628 |
|
15629 <code class="param-name">type</code> |
|
15630 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15631 |
|
15632 |
|
15633 |
|
15634 |
|
15635 <div class="param-description"> |
|
15636 <p>The type, or name of the event</p> |
|
15637 </div> |
|
15638 |
|
15639 |
|
15640 </li> |
|
15641 |
|
15642 </ul> |
|
15643 </div> |
|
15644 |
|
15645 |
|
15646 |
|
15647 |
|
15648 |
|
15649 </div> |
|
15650 |
|
15651 |
|
15652 <div id="method_upgrade" class="method item inherited"> |
|
15653 <h3 class="name"><code>upgrade</code></h3> |
|
15654 |
|
15655 |
|
15656 <span class="paren">()</span> |
|
15657 |
|
15658 |
|
15659 |
|
15660 <span class="returns-inline"> |
|
15661 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15662 </span> |
|
15663 |
|
15664 |
|
15665 |
|
15666 |
|
15667 |
|
15668 |
|
15669 |
|
15670 |
|
15671 |
|
15672 |
|
15673 |
|
15674 |
|
15675 |
|
15676 |
|
15677 <div class="meta"> |
|
15678 |
|
15679 |
|
15680 <p>Inherited from |
|
15681 <a href="../classes/Router.html#method_upgrade">Router</a>: |
|
15682 |
|
15683 |
|
15684 |
|
15685 <a href="../files/app_js_router.js.html#l532"><code>app/js/router.js:532</code></a> |
|
15686 |
|
15687 </p> |
|
15688 |
|
15689 |
|
15690 |
|
15691 |
|
15692 |
|
15693 </div> |
|
15694 |
|
15695 <div class="description"> |
|
15696 <p>Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5 |
|
15697 browsers, this method is a noop.</p> |
|
15698 </div> |
|
15699 |
|
15700 |
|
15701 |
|
15702 |
|
15703 <div class="returns"> |
|
15704 <h4>Returns:</h4> |
|
15705 |
|
15706 <div class="returns-description"> |
|
15707 |
|
15708 |
|
15709 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
15710 |
|
15711 <code>true</code> if the URL was upgraded, <code>false</code> otherwise. |
|
15712 |
|
15713 </div> |
|
15714 </div> |
|
15715 |
|
15716 |
|
15717 |
|
15718 </div> |
|
15719 |
|
15720 |
|
15721 </div> |
|
15722 |
|
15723 |
|
15724 |
|
15725 <div id="properties" class="api-class-tabpanel"> |
|
15726 <h2 class="off-left">Properties</h2> |
|
15727 |
|
15728 |
|
15729 <div id="property__allowAdHocAttrs" class="property item protected inherited"> |
|
15730 <h3 class="name"><code>_allowAdHocAttrs</code></h3> |
|
15731 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15732 |
|
15733 |
|
15734 |
|
15735 |
|
15736 <span class="flag protected">protected</span> |
|
15737 |
|
15738 |
|
15739 |
|
15740 |
|
15741 |
|
15742 |
|
15743 <div class="meta"> |
|
15744 |
|
15745 |
|
15746 <p>Inherited from |
|
15747 <a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>: |
|
15748 |
|
15749 |
|
15750 |
|
15751 <a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a> |
|
15752 |
|
15753 </p> |
|
15754 |
|
15755 |
|
15756 |
|
15757 |
|
15758 </div> |
|
15759 |
|
15760 <div class="description"> |
|
15761 <p>This property controls whether or not instances of this class should |
|
15762 allow users to add ad-hoc attributes through the constructor configuration |
|
15763 hash.</p> |
|
15764 |
|
15765 <p>AdHoc attributes are attributes which are not defined by the class, and are |
|
15766 not handled by the MyClass.<em>NON</em>ATTRS_CFG</p> |
|
15767 </div> |
|
15768 |
|
15769 |
|
15770 <p><strong>Default:</strong> undefined (false)</p> |
|
15771 |
|
15772 |
|
15773 |
|
15774 |
|
15775 |
|
15776 </div> |
|
15777 |
|
15778 |
|
15779 <div id="property__dispatched" class="property item protected inherited"> |
|
15780 <h3 class="name"><code>_dispatched</code></h3> |
|
15781 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15782 |
|
15783 |
|
15784 |
|
15785 |
|
15786 <span class="flag protected">protected</span> |
|
15787 |
|
15788 |
|
15789 |
|
15790 |
|
15791 |
|
15792 |
|
15793 <div class="meta"> |
|
15794 |
|
15795 |
|
15796 <p>Inherited from |
|
15797 <a href="../classes/Router.html#property__dispatched">Router</a>: |
|
15798 |
|
15799 |
|
15800 |
|
15801 <a href="../files/app_js_router.js.html#l64"><code>app/js/router.js:64</code></a> |
|
15802 |
|
15803 </p> |
|
15804 |
|
15805 |
|
15806 |
|
15807 |
|
15808 </div> |
|
15809 |
|
15810 <div class="description"> |
|
15811 <p>Whether or not <code>_dispatch()</code> has been called since this router was |
|
15812 instantiated.</p> |
|
15813 </div> |
|
15814 |
|
15815 |
|
15816 <p><strong>Default:</strong> undefined</p> |
|
15817 |
|
15818 |
|
15819 |
|
15820 |
|
15821 |
|
15822 </div> |
|
15823 |
|
15824 |
|
15825 <div id="property__dispatching" class="property item protected inherited"> |
|
15826 <h3 class="name"><code>_dispatching</code></h3> |
|
15827 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15828 |
|
15829 |
|
15830 |
|
15831 |
|
15832 <span class="flag protected">protected</span> |
|
15833 |
|
15834 |
|
15835 |
|
15836 |
|
15837 |
|
15838 |
|
15839 <div class="meta"> |
|
15840 |
|
15841 |
|
15842 <p>Inherited from |
|
15843 <a href="../classes/Router.html#property__dispatching">Router</a>: |
|
15844 |
|
15845 |
|
15846 |
|
15847 <a href="../files/app_js_router.js.html#l74"><code>app/js/router.js:74</code></a> |
|
15848 |
|
15849 </p> |
|
15850 |
|
15851 |
|
15852 |
|
15853 |
|
15854 </div> |
|
15855 |
|
15856 <div class="description"> |
|
15857 <p>Whether or not we're currently in the process of dispatching to routes.</p> |
|
15858 </div> |
|
15859 |
|
15860 |
|
15861 <p><strong>Default:</strong> undefined</p> |
|
15862 |
|
15863 |
|
15864 |
|
15865 |
|
15866 |
|
15867 </div> |
|
15868 |
|
15869 |
|
15870 <div id="property__historyEvents" class="property item protected inherited"> |
|
15871 <h3 class="name"><code>_historyEvents</code></h3> |
|
15872 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
15873 |
|
15874 |
|
15875 |
|
15876 |
|
15877 <span class="flag protected">protected</span> |
|
15878 |
|
15879 |
|
15880 |
|
15881 |
|
15882 |
|
15883 |
|
15884 <div class="meta"> |
|
15885 |
|
15886 |
|
15887 <p>Inherited from |
|
15888 <a href="../classes/Router.html#property__historyEvents">Router</a>: |
|
15889 |
|
15890 |
|
15891 |
|
15892 <a href="../files/app_js_router.js.html#l83"><code>app/js/router.js:83</code></a> |
|
15893 |
|
15894 </p> |
|
15895 |
|
15896 |
|
15897 |
|
15898 |
|
15899 </div> |
|
15900 |
|
15901 <div class="description"> |
|
15902 <p>History event handle for the <code>history:change</code> or <code>hashchange</code> event |
|
15903 subscription.</p> |
|
15904 </div> |
|
15905 |
|
15906 |
|
15907 |
|
15908 |
|
15909 |
|
15910 |
|
15911 </div> |
|
15912 |
|
15913 |
|
15914 <div id="property__html5" class="property item protected inherited"> |
|
15915 <h3 class="name"><code>_html5</code></h3> |
|
15916 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
15917 |
|
15918 |
|
15919 |
|
15920 |
|
15921 <span class="flag protected">protected</span> |
|
15922 |
|
15923 |
|
15924 |
|
15925 |
|
15926 |
|
15927 |
|
15928 <div class="meta"> |
|
15929 |
|
15930 |
|
15931 <p>Inherited from |
|
15932 <a href="../classes/Router.html#property__html5">Router</a>: |
|
15933 |
|
15934 |
|
15935 |
|
15936 <a href="../files/app_js_router.js.html#l92"><code>app/js/router.js:92</code></a> |
|
15937 |
|
15938 </p> |
|
15939 |
|
15940 |
|
15941 |
|
15942 |
|
15943 </div> |
|
15944 |
|
15945 <div class="description"> |
|
15946 <p>Cached copy of the <code>html5</code> attribute for internal use.</p> |
|
15947 </div> |
|
15948 |
|
15949 |
|
15950 |
|
15951 |
|
15952 |
|
15953 |
|
15954 </div> |
|
15955 |
|
15956 |
|
15957 <div id="property__pjaxEvents" class="property item protected inherited"> |
|
15958 <h3 class="name"><code>_pjaxEvents</code></h3> |
|
15959 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
15960 |
|
15961 |
|
15962 |
|
15963 |
|
15964 <span class="flag protected">protected</span> |
|
15965 |
|
15966 |
|
15967 |
|
15968 |
|
15969 |
|
15970 |
|
15971 <div class="meta"> |
|
15972 |
|
15973 |
|
15974 <p>Inherited from |
|
15975 <a href="../classes/PjaxBase.html#property__pjaxEvents">PjaxBase</a>: |
|
15976 |
|
15977 |
|
15978 |
|
15979 <a href="../files/pjax_js_pjax-base.js.html#l69"><code>pjax/js/pjax-base.js:69</code></a> |
|
15980 |
|
15981 </p> |
|
15982 |
|
15983 |
|
15984 |
|
15985 |
|
15986 <p>Available since 3.5.0</p> |
|
15987 |
|
15988 </div> |
|
15989 |
|
15990 <div class="description"> |
|
15991 <p>Holds the delegated pjax-link click handler.</p> |
|
15992 </div> |
|
15993 |
|
15994 |
|
15995 |
|
15996 |
|
15997 |
|
15998 |
|
15999 </div> |
|
16000 |
|
16001 |
|
16002 <div id="property__ready" class="property item protected inherited"> |
|
16003 <h3 class="name"><code>_ready</code></h3> |
|
16004 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16005 |
|
16006 |
|
16007 |
|
16008 |
|
16009 <span class="flag protected">protected</span> |
|
16010 |
|
16011 |
|
16012 |
|
16013 |
|
16014 |
|
16015 |
|
16016 <div class="meta"> |
|
16017 |
|
16018 |
|
16019 <p>Inherited from |
|
16020 <a href="../classes/Router.html#property__ready">Router</a>: |
|
16021 |
|
16022 |
|
16023 |
|
16024 <a href="../files/app_js_router.js.html#l100"><code>app/js/router.js:100</code></a> |
|
16025 |
|
16026 </p> |
|
16027 |
|
16028 |
|
16029 |
|
16030 |
|
16031 </div> |
|
16032 |
|
16033 <div class="description"> |
|
16034 <p>Whether or not the <code>ready</code> event has fired yet.</p> |
|
16035 </div> |
|
16036 |
|
16037 |
|
16038 <p><strong>Default:</strong> undefined</p> |
|
16039 |
|
16040 |
|
16041 |
|
16042 |
|
16043 |
|
16044 </div> |
|
16045 |
|
16046 |
|
16047 <div id="property__regexPathParam" class="property item protected inherited"> |
|
16048 <h3 class="name"><code>_regexPathParam</code></h3> |
|
16049 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
16050 |
|
16051 |
|
16052 |
|
16053 |
|
16054 <span class="flag protected">protected</span> |
|
16055 |
|
16056 |
|
16057 |
|
16058 |
|
16059 |
|
16060 |
|
16061 <div class="meta"> |
|
16062 |
|
16063 |
|
16064 <p>Inherited from |
|
16065 <a href="../classes/Router.html#property__regexPathParam">Router</a>: |
|
16066 |
|
16067 |
|
16068 |
|
16069 <a href="../files/app_js_router.js.html#l109"><code>app/js/router.js:109</code></a> |
|
16070 |
|
16071 </p> |
|
16072 |
|
16073 |
|
16074 |
|
16075 |
|
16076 </div> |
|
16077 |
|
16078 <div class="description"> |
|
16079 <p>Regex used to match parameter placeholders in route paths.</p> |
|
16080 |
|
16081 <p>Subpattern captures:</p> |
|
16082 |
|
16083 <ol> |
|
16084 <li><p>Parameter prefix character. Either a <code>:</code> for subpath parameters that |
|
16085 should only match a single level of a path, or <code>*</code> for splat parameters |
|
16086 that should match any number of path levels.</p></li> |
|
16087 <li><p>Parameter name, if specified, otherwise it is a wildcard match.</p></li> |
|
16088 </ol> |
|
16089 </div> |
|
16090 |
|
16091 |
|
16092 |
|
16093 |
|
16094 |
|
16095 |
|
16096 </div> |
|
16097 |
|
16098 |
|
16099 <div id="property__regexURL" class="property item protected inherited"> |
|
16100 <h3 class="name"><code>_regexURL</code></h3> |
|
16101 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
16102 |
|
16103 |
|
16104 |
|
16105 |
|
16106 <span class="flag protected">protected</span> |
|
16107 |
|
16108 |
|
16109 |
|
16110 |
|
16111 |
|
16112 |
|
16113 <div class="meta"> |
|
16114 |
|
16115 |
|
16116 <p>Inherited from |
|
16117 <a href="../classes/PjaxBase.html#property__regexURL">PjaxBase</a>: |
|
16118 |
|
16119 |
|
16120 |
|
16121 <a href="../files/pjax_js_pjax-base.js.html#l78"><code>pjax/js/pjax-base.js:78</code></a> |
|
16122 |
|
16123 </p> |
|
16124 |
|
16125 |
|
16126 |
|
16127 |
|
16128 <p>Available since 3.5.0</p> |
|
16129 |
|
16130 </div> |
|
16131 |
|
16132 <div class="description"> |
|
16133 <p>Regex used to break up a URL string around the URL's path.</p> |
|
16134 |
|
16135 <p>Subpattern captures:</p> |
|
16136 |
|
16137 <ol> |
|
16138 <li>Origin, everything before the URL's path-part.</li> |
|
16139 <li>The URL's path-part.</li> |
|
16140 <li>Suffix, everything after the URL's path-part.</li> |
|
16141 </ol> |
|
16142 </div> |
|
16143 |
|
16144 |
|
16145 |
|
16146 |
|
16147 |
|
16148 |
|
16149 </div> |
|
16150 |
|
16151 |
|
16152 <div id="property__regexUrlOrigin" class="property item protected inherited"> |
|
16153 <h3 class="name"><code>_regexUrlOrigin</code></h3> |
|
16154 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
16155 |
|
16156 |
|
16157 |
|
16158 |
|
16159 <span class="flag protected">protected</span> |
|
16160 |
|
16161 |
|
16162 |
|
16163 |
|
16164 |
|
16165 |
|
16166 <div class="meta"> |
|
16167 |
|
16168 |
|
16169 <p>Inherited from |
|
16170 <a href="../classes/Router.html#property__regexUrlOrigin">Router</a>: |
|
16171 |
|
16172 |
|
16173 |
|
16174 <a href="../files/app_js_router.js.html#l136"><code>app/js/router.js:136</code></a> |
|
16175 |
|
16176 </p> |
|
16177 |
|
16178 |
|
16179 |
|
16180 |
|
16181 </div> |
|
16182 |
|
16183 <div class="description"> |
|
16184 <p>Regex that matches everything before the path portion of a URL (the origin). |
|
16185 This will be used to strip this part of the URL from a string when we |
|
16186 only want the path.</p> |
|
16187 </div> |
|
16188 |
|
16189 |
|
16190 |
|
16191 |
|
16192 |
|
16193 |
|
16194 </div> |
|
16195 |
|
16196 |
|
16197 <div id="property__regexUrlQuery" class="property item protected inherited"> |
|
16198 <h3 class="name"><code>_regexUrlQuery</code></h3> |
|
16199 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
16200 |
|
16201 |
|
16202 |
|
16203 |
|
16204 <span class="flag protected">protected</span> |
|
16205 |
|
16206 |
|
16207 |
|
16208 |
|
16209 |
|
16210 |
|
16211 <div class="meta"> |
|
16212 |
|
16213 |
|
16214 <p>Inherited from |
|
16215 <a href="../classes/Router.html#property__regexUrlQuery">Router</a>: |
|
16216 |
|
16217 |
|
16218 |
|
16219 <a href="../files/app_js_router.js.html#l126"><code>app/js/router.js:126</code></a> |
|
16220 |
|
16221 </p> |
|
16222 |
|
16223 |
|
16224 |
|
16225 |
|
16226 </div> |
|
16227 |
|
16228 <div class="description"> |
|
16229 <p>Regex that matches and captures the query portion of a URL, minus the |
|
16230 preceding <code>?</code> character, and discarding the hash portion of the URL if any.</p> |
|
16231 </div> |
|
16232 |
|
16233 |
|
16234 |
|
16235 |
|
16236 |
|
16237 |
|
16238 </div> |
|
16239 |
|
16240 |
|
16241 <div id="property_name" class="property item deprecated inherited"> |
|
16242 <h3 class="name"><code>name</code></h3> |
|
16243 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16244 |
|
16245 |
|
16246 <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span> |
|
16247 |
|
16248 |
|
16249 |
|
16250 |
|
16251 |
|
16252 |
|
16253 |
|
16254 |
|
16255 <div class="meta"> |
|
16256 |
|
16257 |
|
16258 <p>Inherited from |
|
16259 <a href="../classes/BaseCore.html#property_name">BaseCore</a>: |
|
16260 |
|
16261 |
|
16262 |
|
16263 <a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a> |
|
16264 |
|
16265 </p> |
|
16266 |
|
16267 |
|
16268 <p>Deprecated: Use this.constructor.NAME</p> |
|
16269 |
|
16270 |
|
16271 |
|
16272 </div> |
|
16273 |
|
16274 <div class="description"> |
|
16275 <p>The string used to identify the class of this object.</p> |
|
16276 </div> |
|
16277 |
|
16278 |
|
16279 |
|
16280 |
|
16281 |
|
16282 |
|
16283 </div> |
|
16284 |
|
16285 |
|
16286 </div> |
|
16287 |
|
16288 |
|
16289 |
|
16290 <div id="attrs" class="api-class-tabpanel"> |
|
16291 <h2 class="off-left">Attributes</h2> |
|
16292 |
|
16293 |
|
16294 <div id="attr_addPjaxParam" class="attr item inherited"> |
|
16295 <a name="config_addPjaxParam"></a> |
|
16296 <h3 class="name"><code>addPjaxParam</code></h3> |
|
16297 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16298 |
|
16299 |
|
16300 |
|
16301 |
|
16302 |
|
16303 |
|
16304 |
|
16305 |
|
16306 |
|
16307 |
|
16308 |
|
16309 |
|
16310 |
|
16311 |
|
16312 |
|
16313 <div class="meta"> |
|
16314 |
|
16315 |
|
16316 <p>Inherited from |
|
16317 <a href="../classes/PjaxContent.html#attr_addPjaxParam">PjaxContent</a>: |
|
16318 |
|
16319 |
|
16320 |
|
16321 <a href="../files/pjax_js_pjax-content.js.html#l204"><code>pjax/js/pjax-content.js:204</code></a> |
|
16322 |
|
16323 </p> |
|
16324 |
|
16325 |
|
16326 |
|
16327 |
|
16328 <p>Available since 3.5.0</p> |
|
16329 |
|
16330 </div> |
|
16331 |
|
16332 <div class="description"> |
|
16333 <p>If <code>true</code>, a "pjax=1" query parameter will be appended to all URLs |
|
16334 requested via Pjax.</p> |
|
16335 |
|
16336 <p>Browsers ignore HTTP request headers when caching content, so if the |
|
16337 same URL is used to request a partial Pjax page and a full page, the |
|
16338 browser will cache them under the same key and may later load the |
|
16339 cached partial page when the user actually requests a full page (or vice |
|
16340 versa).</p> |
|
16341 |
|
16342 <p>To prevent this, we can add a bogus query parameter to the URL so that |
|
16343 Pjax URLs will always be cached separately from non-Pjax URLs.</p> |
|
16344 </div> |
|
16345 |
|
16346 |
|
16347 <p><strong>Default:</strong> true</p> |
|
16348 |
|
16349 |
|
16350 |
|
16351 <div class="emits box"> |
|
16352 <h4>Fires event <code>addPjaxParamChange</code></h4> |
|
16353 |
|
16354 <p> |
|
16355 Fires when the value for the configuration attribute <code>addPjaxParam</code> is |
|
16356 changed. You can listen for the event using the <code>on</code> method if you |
|
16357 wish to be notified before the attribute's value has changed, or |
|
16358 using the <code>after</code> method if you wish to be notified after the |
|
16359 attribute's value has changed. |
|
16360 </p> |
|
16361 |
|
16362 <div class="params"> |
|
16363 <h4>Parameters:</h4> |
|
16364 |
|
16365 <ul class="params-list"> |
|
16366 <li class="param"> |
|
16367 <code class="param-name">e</code> |
|
16368 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16369 |
|
16370 <div class="param-description"> |
|
16371 An Event Facade object with the following |
|
16372 attribute-specific properties added: |
|
16373 </div> |
|
16374 |
|
16375 <ul class="params-list"> |
|
16376 <li class="param"> |
|
16377 <code class="param-name">prevVal</code> |
|
16378 <span class="type">Any</span> |
|
16379 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16380 </li> |
|
16381 <li class="param"> |
|
16382 <code class="param-name">newVal</code> |
|
16383 <span class="type">Any</span> |
|
16384 <div class="param-description">The value the attribute is to be set to.</div> |
|
16385 </li> |
|
16386 <li class="param"> |
|
16387 <code class="param-name">attrName</code> |
|
16388 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16389 <div class="param-description">The name of the attribute being set.</div> |
|
16390 </li> |
|
16391 <li class="param"> |
|
16392 <code class="param-name">subAttrName</code> |
|
16393 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16394 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16395 </li> |
|
16396 </ul> |
|
16397 </li> |
|
16398 </ul> |
|
16399 </div> |
|
16400 </div> |
|
16401 |
|
16402 |
|
16403 |
|
16404 </div> |
|
16405 |
|
16406 |
|
16407 <div id="attr_container" class="attr item inherited"> |
|
16408 <a name="config_container"></a> |
|
16409 <h3 class="name"><code>container</code></h3> |
|
16410 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
16411 |
|
16412 |
|
16413 |
|
16414 |
|
16415 |
|
16416 |
|
16417 |
|
16418 |
|
16419 |
|
16420 |
|
16421 |
|
16422 |
|
16423 |
|
16424 |
|
16425 |
|
16426 <div class="meta"> |
|
16427 |
|
16428 |
|
16429 <p>Inherited from |
|
16430 <a href="../classes/Pjax.html#attr_container">Pjax</a>: |
|
16431 |
|
16432 |
|
16433 |
|
16434 <a href="../files/pjax_js_pjax.js.html#l137"><code>pjax/js/pjax.js:137</code></a> |
|
16435 |
|
16436 </p> |
|
16437 |
|
16438 |
|
16439 |
|
16440 |
|
16441 <p>Available since 3.5.0</p> |
|
16442 |
|
16443 </div> |
|
16444 |
|
16445 <div class="description"> |
|
16446 <p>Node into which content should be inserted when a page is loaded via |
|
16447 Pjax. This node's existing contents will be removed to make way for the |
|
16448 new content.</p> |
|
16449 |
|
16450 <p>If not set, loaded content will not be automatically inserted into the |
|
16451 page.</p> |
|
16452 </div> |
|
16453 |
|
16454 |
|
16455 <p><strong>Default:</strong> null</p> |
|
16456 |
|
16457 |
|
16458 |
|
16459 <div class="emits box"> |
|
16460 <h4>Fires event <code>containerChange</code></h4> |
|
16461 |
|
16462 <p> |
|
16463 Fires when the value for the configuration attribute <code>container</code> is |
|
16464 changed. You can listen for the event using the <code>on</code> method if you |
|
16465 wish to be notified before the attribute's value has changed, or |
|
16466 using the <code>after</code> method if you wish to be notified after the |
|
16467 attribute's value has changed. |
|
16468 </p> |
|
16469 |
|
16470 <div class="params"> |
|
16471 <h4>Parameters:</h4> |
|
16472 |
|
16473 <ul class="params-list"> |
|
16474 <li class="param"> |
|
16475 <code class="param-name">e</code> |
|
16476 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16477 |
|
16478 <div class="param-description"> |
|
16479 An Event Facade object with the following |
|
16480 attribute-specific properties added: |
|
16481 </div> |
|
16482 |
|
16483 <ul class="params-list"> |
|
16484 <li class="param"> |
|
16485 <code class="param-name">prevVal</code> |
|
16486 <span class="type">Any</span> |
|
16487 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16488 </li> |
|
16489 <li class="param"> |
|
16490 <code class="param-name">newVal</code> |
|
16491 <span class="type">Any</span> |
|
16492 <div class="param-description">The value the attribute is to be set to.</div> |
|
16493 </li> |
|
16494 <li class="param"> |
|
16495 <code class="param-name">attrName</code> |
|
16496 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16497 <div class="param-description">The name of the attribute being set.</div> |
|
16498 </li> |
|
16499 <li class="param"> |
|
16500 <code class="param-name">subAttrName</code> |
|
16501 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16502 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16503 </li> |
|
16504 </ul> |
|
16505 </li> |
|
16506 </ul> |
|
16507 </div> |
|
16508 </div> |
|
16509 |
|
16510 |
|
16511 |
|
16512 </div> |
|
16513 |
|
16514 |
|
16515 <div id="attr_contentSelector" class="attr item inherited"> |
|
16516 <a name="config_contentSelector"></a> |
|
16517 <h3 class="name"><code>contentSelector</code></h3> |
|
16518 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16519 |
|
16520 |
|
16521 |
|
16522 |
|
16523 |
|
16524 |
|
16525 |
|
16526 |
|
16527 |
|
16528 |
|
16529 |
|
16530 |
|
16531 |
|
16532 |
|
16533 |
|
16534 <div class="meta"> |
|
16535 |
|
16536 |
|
16537 <p>Inherited from |
|
16538 <a href="../classes/PjaxContent.html#attr_contentSelector">PjaxContent</a>: |
|
16539 |
|
16540 |
|
16541 |
|
16542 <a href="../files/pjax_js_pjax-content.js.html#l226"><code>pjax/js/pjax-content.js:226</code></a> |
|
16543 |
|
16544 </p> |
|
16545 |
|
16546 |
|
16547 |
|
16548 |
|
16549 <p>Available since 3.5.0</p> |
|
16550 |
|
16551 </div> |
|
16552 |
|
16553 <div class="description"> |
|
16554 <p>CSS selector used to extract a specific portion of the content of a page |
|
16555 loaded via Pjax.</p> |
|
16556 |
|
16557 <p>For example, if you wanted to load the page <code>example.html</code> but only use |
|
16558 the content within an element with the id "pjax-content", you'd set |
|
16559 <code>contentSelector</code> to "#pjax-content".</p> |
|
16560 |
|
16561 <p>If not set, the entire page will be used.</p> |
|
16562 </div> |
|
16563 |
|
16564 |
|
16565 <p><strong>Default:</strong> null</p> |
|
16566 |
|
16567 |
|
16568 |
|
16569 <div class="emits box"> |
|
16570 <h4>Fires event <code>contentSelectorChange</code></h4> |
|
16571 |
|
16572 <p> |
|
16573 Fires when the value for the configuration attribute <code>contentSelector</code> is |
|
16574 changed. You can listen for the event using the <code>on</code> method if you |
|
16575 wish to be notified before the attribute's value has changed, or |
|
16576 using the <code>after</code> method if you wish to be notified after the |
|
16577 attribute's value has changed. |
|
16578 </p> |
|
16579 |
|
16580 <div class="params"> |
|
16581 <h4>Parameters:</h4> |
|
16582 |
|
16583 <ul class="params-list"> |
|
16584 <li class="param"> |
|
16585 <code class="param-name">e</code> |
|
16586 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16587 |
|
16588 <div class="param-description"> |
|
16589 An Event Facade object with the following |
|
16590 attribute-specific properties added: |
|
16591 </div> |
|
16592 |
|
16593 <ul class="params-list"> |
|
16594 <li class="param"> |
|
16595 <code class="param-name">prevVal</code> |
|
16596 <span class="type">Any</span> |
|
16597 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16598 </li> |
|
16599 <li class="param"> |
|
16600 <code class="param-name">newVal</code> |
|
16601 <span class="type">Any</span> |
|
16602 <div class="param-description">The value the attribute is to be set to.</div> |
|
16603 </li> |
|
16604 <li class="param"> |
|
16605 <code class="param-name">attrName</code> |
|
16606 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16607 <div class="param-description">The name of the attribute being set.</div> |
|
16608 </li> |
|
16609 <li class="param"> |
|
16610 <code class="param-name">subAttrName</code> |
|
16611 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16612 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16613 </li> |
|
16614 </ul> |
|
16615 </li> |
|
16616 </ul> |
|
16617 </div> |
|
16618 </div> |
|
16619 |
|
16620 |
|
16621 |
|
16622 </div> |
|
16623 |
|
16624 |
|
16625 <div id="attr_destroyed" class="attr item inherited"> |
|
16626 <a name="config_destroyed"></a> |
|
16627 <h3 class="name"><code>destroyed</code></h3> |
|
16628 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16629 |
|
16630 |
|
16631 |
|
16632 |
|
16633 |
|
16634 |
|
16635 |
|
16636 |
|
16637 |
|
16638 |
|
16639 |
|
16640 |
|
16641 |
|
16642 |
|
16643 <span class="flag readonly">readonly</span> |
|
16644 |
|
16645 |
|
16646 <div class="meta"> |
|
16647 |
|
16648 |
|
16649 <p>Inherited from |
|
16650 <a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>: |
|
16651 |
|
16652 |
|
16653 |
|
16654 <a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a> |
|
16655 |
|
16656 </p> |
|
16657 |
|
16658 |
|
16659 |
|
16660 |
|
16661 </div> |
|
16662 |
|
16663 <div class="description"> |
|
16664 <p>Flag indicating whether or not this object |
|
16665 has been through the destroy lifecycle phase.</p> |
|
16666 </div> |
|
16667 |
|
16668 |
|
16669 <p><strong>Default:</strong> false</p> |
|
16670 |
|
16671 |
|
16672 |
|
16673 <div class="emits box"> |
|
16674 <h4>Fires event <code>destroyedChange</code></h4> |
|
16675 |
|
16676 <p> |
|
16677 Fires when the value for the configuration attribute <code>destroyed</code> is |
|
16678 changed. You can listen for the event using the <code>on</code> method if you |
|
16679 wish to be notified before the attribute's value has changed, or |
|
16680 using the <code>after</code> method if you wish to be notified after the |
|
16681 attribute's value has changed. |
|
16682 </p> |
|
16683 |
|
16684 <div class="params"> |
|
16685 <h4>Parameters:</h4> |
|
16686 |
|
16687 <ul class="params-list"> |
|
16688 <li class="param"> |
|
16689 <code class="param-name">e</code> |
|
16690 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16691 |
|
16692 <div class="param-description"> |
|
16693 An Event Facade object with the following |
|
16694 attribute-specific properties added: |
|
16695 </div> |
|
16696 |
|
16697 <ul class="params-list"> |
|
16698 <li class="param"> |
|
16699 <code class="param-name">prevVal</code> |
|
16700 <span class="type">Any</span> |
|
16701 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16702 </li> |
|
16703 <li class="param"> |
|
16704 <code class="param-name">newVal</code> |
|
16705 <span class="type">Any</span> |
|
16706 <div class="param-description">The value the attribute is to be set to.</div> |
|
16707 </li> |
|
16708 <li class="param"> |
|
16709 <code class="param-name">attrName</code> |
|
16710 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16711 <div class="param-description">The name of the attribute being set.</div> |
|
16712 </li> |
|
16713 <li class="param"> |
|
16714 <code class="param-name">subAttrName</code> |
|
16715 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16716 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16717 </li> |
|
16718 </ul> |
|
16719 </li> |
|
16720 </ul> |
|
16721 </div> |
|
16722 </div> |
|
16723 |
|
16724 |
|
16725 |
|
16726 </div> |
|
16727 |
|
16728 |
|
16729 <div id="attr_html5" class="attr item inherited"> |
|
16730 <a name="config_html5"></a> |
|
16731 <h3 class="name"><code>html5</code></h3> |
|
16732 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16733 |
|
16734 |
|
16735 |
|
16736 |
|
16737 |
|
16738 |
|
16739 |
|
16740 |
|
16741 |
|
16742 |
|
16743 |
|
16744 |
|
16745 |
|
16746 |
|
16747 |
|
16748 <div class="meta"> |
|
16749 |
|
16750 |
|
16751 <p>Inherited from |
|
16752 <a href="../classes/Router.html#attr_html5">Router</a>: |
|
16753 |
|
16754 |
|
16755 |
|
16756 <a href="../files/app_js_router.js.html#l1315"><code>app/js/router.js:1315</code></a> |
|
16757 |
|
16758 </p> |
|
16759 |
|
16760 |
|
16761 |
|
16762 |
|
16763 </div> |
|
16764 |
|
16765 <div class="description"> |
|
16766 <p>Whether or not this browser is capable of using HTML5 history.</p> |
|
16767 |
|
16768 <p>Setting this to <code>false</code> will force the use of hash-based history even on |
|
16769 HTML5 browsers, but please don't do this unless you understand the |
|
16770 consequences.</p> |
|
16771 </div> |
|
16772 |
|
16773 |
|
16774 |
|
16775 |
|
16776 <div class="emits box"> |
|
16777 <h4>Fires event <code>html5Change</code></h4> |
|
16778 |
|
16779 <p> |
|
16780 Fires when the value for the configuration attribute <code>html5</code> is |
|
16781 changed. You can listen for the event using the <code>on</code> method if you |
|
16782 wish to be notified before the attribute's value has changed, or |
|
16783 using the <code>after</code> method if you wish to be notified after the |
|
16784 attribute's value has changed. |
|
16785 </p> |
|
16786 |
|
16787 <div class="params"> |
|
16788 <h4>Parameters:</h4> |
|
16789 |
|
16790 <ul class="params-list"> |
|
16791 <li class="param"> |
|
16792 <code class="param-name">e</code> |
|
16793 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16794 |
|
16795 <div class="param-description"> |
|
16796 An Event Facade object with the following |
|
16797 attribute-specific properties added: |
|
16798 </div> |
|
16799 |
|
16800 <ul class="params-list"> |
|
16801 <li class="param"> |
|
16802 <code class="param-name">prevVal</code> |
|
16803 <span class="type">Any</span> |
|
16804 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16805 </li> |
|
16806 <li class="param"> |
|
16807 <code class="param-name">newVal</code> |
|
16808 <span class="type">Any</span> |
|
16809 <div class="param-description">The value the attribute is to be set to.</div> |
|
16810 </li> |
|
16811 <li class="param"> |
|
16812 <code class="param-name">attrName</code> |
|
16813 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16814 <div class="param-description">The name of the attribute being set.</div> |
|
16815 </li> |
|
16816 <li class="param"> |
|
16817 <code class="param-name">subAttrName</code> |
|
16818 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16819 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16820 </li> |
|
16821 </ul> |
|
16822 </li> |
|
16823 </ul> |
|
16824 </div> |
|
16825 </div> |
|
16826 |
|
16827 |
|
16828 |
|
16829 </div> |
|
16830 |
|
16831 |
|
16832 <div id="attr_initialized" class="attr item inherited"> |
|
16833 <a name="config_initialized"></a> |
|
16834 <h3 class="name"><code>initialized</code></h3> |
|
16835 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16836 |
|
16837 |
|
16838 |
|
16839 |
|
16840 |
|
16841 |
|
16842 |
|
16843 |
|
16844 |
|
16845 |
|
16846 |
|
16847 |
|
16848 |
|
16849 |
|
16850 <span class="flag readonly">readonly</span> |
|
16851 |
|
16852 |
|
16853 <div class="meta"> |
|
16854 |
|
16855 |
|
16856 <p>Inherited from |
|
16857 <a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>: |
|
16858 |
|
16859 |
|
16860 |
|
16861 <a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a> |
|
16862 |
|
16863 </p> |
|
16864 |
|
16865 |
|
16866 |
|
16867 |
|
16868 </div> |
|
16869 |
|
16870 <div class="description"> |
|
16871 <p>Flag indicating whether or not this object |
|
16872 has been through the init lifecycle phase.</p> |
|
16873 </div> |
|
16874 |
|
16875 |
|
16876 <p><strong>Default:</strong> false</p> |
|
16877 |
|
16878 |
|
16879 |
|
16880 <div class="emits box"> |
|
16881 <h4>Fires event <code>initializedChange</code></h4> |
|
16882 |
|
16883 <p> |
|
16884 Fires when the value for the configuration attribute <code>initialized</code> is |
|
16885 changed. You can listen for the event using the <code>on</code> method if you |
|
16886 wish to be notified before the attribute's value has changed, or |
|
16887 using the <code>after</code> method if you wish to be notified after the |
|
16888 attribute's value has changed. |
|
16889 </p> |
|
16890 |
|
16891 <div class="params"> |
|
16892 <h4>Parameters:</h4> |
|
16893 |
|
16894 <ul class="params-list"> |
|
16895 <li class="param"> |
|
16896 <code class="param-name">e</code> |
|
16897 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
16898 |
|
16899 <div class="param-description"> |
|
16900 An Event Facade object with the following |
|
16901 attribute-specific properties added: |
|
16902 </div> |
|
16903 |
|
16904 <ul class="params-list"> |
|
16905 <li class="param"> |
|
16906 <code class="param-name">prevVal</code> |
|
16907 <span class="type">Any</span> |
|
16908 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
16909 </li> |
|
16910 <li class="param"> |
|
16911 <code class="param-name">newVal</code> |
|
16912 <span class="type">Any</span> |
|
16913 <div class="param-description">The value the attribute is to be set to.</div> |
|
16914 </li> |
|
16915 <li class="param"> |
|
16916 <code class="param-name">attrName</code> |
|
16917 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16918 <div class="param-description">The name of the attribute being set.</div> |
|
16919 </li> |
|
16920 <li class="param"> |
|
16921 <code class="param-name">subAttrName</code> |
|
16922 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16923 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
16924 </li> |
|
16925 </ul> |
|
16926 </li> |
|
16927 </ul> |
|
16928 </div> |
|
16929 </div> |
|
16930 |
|
16931 |
|
16932 |
|
16933 </div> |
|
16934 |
|
16935 |
|
16936 <div id="attr_linkSelector" class="attr item inherited"> |
|
16937 <a name="config_linkSelector"></a> |
|
16938 <h3 class="name"><code>linkSelector</code></h3> |
|
16939 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
16940 |
|
16941 |
|
16942 |
|
16943 |
|
16944 |
|
16945 |
|
16946 |
|
16947 |
|
16948 |
|
16949 |
|
16950 |
|
16951 |
|
16952 |
|
16953 |
|
16954 |
|
16955 <div class="meta"> |
|
16956 |
|
16957 |
|
16958 <p>Inherited from |
|
16959 <a href="../classes/PjaxBase.html#attr_linkSelector">PjaxBase</a>: |
|
16960 |
|
16961 |
|
16962 |
|
16963 <a href="../files/pjax_js_pjax-base.js.html#l381"><code>pjax/js/pjax-base.js:381</code></a> |
|
16964 |
|
16965 </p> |
|
16966 |
|
16967 |
|
16968 |
|
16969 |
|
16970 <p>Available since 3.5.0</p> |
|
16971 |
|
16972 </div> |
|
16973 |
|
16974 <div class="description"> |
|
16975 <p>CSS selector string used to filter link click events so that only the links |
|
16976 which match it will have the enhanced navigation behavior of Pjax applied.</p> |
|
16977 |
|
16978 <p>When a link is clicked and that link matches this selector, Pjax will |
|
16979 attempt to dispatch to any route handlers matching the link's <code>href</code> URL. If |
|
16980 HTML5 history is not supported or if no route handlers match, the link click |
|
16981 will be handled by the browser just like any old link.</p> |
|
16982 </div> |
|
16983 |
|
16984 |
|
16985 <p><strong>Default:</strong> "a.yui3-pjax"</p> |
|
16986 |
|
16987 |
|
16988 |
|
16989 <div class="emits box"> |
|
16990 <h4>Fires event <code>linkSelectorChange</code></h4> |
|
16991 |
|
16992 <p> |
|
16993 Fires when the value for the configuration attribute <code>linkSelector</code> is |
|
16994 changed. You can listen for the event using the <code>on</code> method if you |
|
16995 wish to be notified before the attribute's value has changed, or |
|
16996 using the <code>after</code> method if you wish to be notified after the |
|
16997 attribute's value has changed. |
|
16998 </p> |
|
16999 |
|
17000 <div class="params"> |
|
17001 <h4>Parameters:</h4> |
|
17002 |
|
17003 <ul class="params-list"> |
|
17004 <li class="param"> |
|
17005 <code class="param-name">e</code> |
|
17006 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17007 |
|
17008 <div class="param-description"> |
|
17009 An Event Facade object with the following |
|
17010 attribute-specific properties added: |
|
17011 </div> |
|
17012 |
|
17013 <ul class="params-list"> |
|
17014 <li class="param"> |
|
17015 <code class="param-name">prevVal</code> |
|
17016 <span class="type">Any</span> |
|
17017 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17018 </li> |
|
17019 <li class="param"> |
|
17020 <code class="param-name">newVal</code> |
|
17021 <span class="type">Any</span> |
|
17022 <div class="param-description">The value the attribute is to be set to.</div> |
|
17023 </li> |
|
17024 <li class="param"> |
|
17025 <code class="param-name">attrName</code> |
|
17026 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17027 <div class="param-description">The name of the attribute being set.</div> |
|
17028 </li> |
|
17029 <li class="param"> |
|
17030 <code class="param-name">subAttrName</code> |
|
17031 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17032 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17033 </li> |
|
17034 </ul> |
|
17035 </li> |
|
17036 </ul> |
|
17037 </div> |
|
17038 </div> |
|
17039 |
|
17040 |
|
17041 |
|
17042 </div> |
|
17043 |
|
17044 |
|
17045 <div id="attr_navigateOnHash" class="attr item inherited"> |
|
17046 <a name="config_navigateOnHash"></a> |
|
17047 <h3 class="name"><code>navigateOnHash</code></h3> |
|
17048 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17049 |
|
17050 |
|
17051 |
|
17052 |
|
17053 |
|
17054 |
|
17055 |
|
17056 |
|
17057 |
|
17058 |
|
17059 |
|
17060 |
|
17061 |
|
17062 |
|
17063 |
|
17064 <div class="meta"> |
|
17065 |
|
17066 |
|
17067 <p>Inherited from |
|
17068 <a href="../classes/PjaxBase.html#attr_navigateOnHash">PjaxBase</a>: |
|
17069 |
|
17070 |
|
17071 |
|
17072 <a href="../files/pjax_js_pjax-base.js.html#l401"><code>pjax/js/pjax-base.js:401</code></a> |
|
17073 |
|
17074 </p> |
|
17075 |
|
17076 |
|
17077 |
|
17078 |
|
17079 <p>Available since 3.5.0</p> |
|
17080 |
|
17081 </div> |
|
17082 |
|
17083 <div class="description"> |
|
17084 <p>Whether navigating to a hash-fragment identifier on the current page should |
|
17085 be enhanced and cause the <code>navigate</code> event to fire.</p> |
|
17086 |
|
17087 <p>By default Pjax allows the browser to perform its default action when a user |
|
17088 is navigating within a page by clicking in-page links |
|
17089 (e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or |
|
17090 enhance in-page navigation.</p> |
|
17091 </div> |
|
17092 |
|
17093 |
|
17094 <p><strong>Default:</strong> false</p> |
|
17095 |
|
17096 |
|
17097 |
|
17098 <div class="emits box"> |
|
17099 <h4>Fires event <code>navigateOnHashChange</code></h4> |
|
17100 |
|
17101 <p> |
|
17102 Fires when the value for the configuration attribute <code>navigateOnHash</code> is |
|
17103 changed. You can listen for the event using the <code>on</code> method if you |
|
17104 wish to be notified before the attribute's value has changed, or |
|
17105 using the <code>after</code> method if you wish to be notified after the |
|
17106 attribute's value has changed. |
|
17107 </p> |
|
17108 |
|
17109 <div class="params"> |
|
17110 <h4>Parameters:</h4> |
|
17111 |
|
17112 <ul class="params-list"> |
|
17113 <li class="param"> |
|
17114 <code class="param-name">e</code> |
|
17115 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17116 |
|
17117 <div class="param-description"> |
|
17118 An Event Facade object with the following |
|
17119 attribute-specific properties added: |
|
17120 </div> |
|
17121 |
|
17122 <ul class="params-list"> |
|
17123 <li class="param"> |
|
17124 <code class="param-name">prevVal</code> |
|
17125 <span class="type">Any</span> |
|
17126 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17127 </li> |
|
17128 <li class="param"> |
|
17129 <code class="param-name">newVal</code> |
|
17130 <span class="type">Any</span> |
|
17131 <div class="param-description">The value the attribute is to be set to.</div> |
|
17132 </li> |
|
17133 <li class="param"> |
|
17134 <code class="param-name">attrName</code> |
|
17135 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17136 <div class="param-description">The name of the attribute being set.</div> |
|
17137 </li> |
|
17138 <li class="param"> |
|
17139 <code class="param-name">subAttrName</code> |
|
17140 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17141 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17142 </li> |
|
17143 </ul> |
|
17144 </li> |
|
17145 </ul> |
|
17146 </div> |
|
17147 </div> |
|
17148 |
|
17149 |
|
17150 |
|
17151 </div> |
|
17152 |
|
17153 |
|
17154 <div id="attr_root" class="attr item inherited"> |
|
17155 <a name="config_root"></a> |
|
17156 <h3 class="name"><code>root</code></h3> |
|
17157 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17158 |
|
17159 |
|
17160 |
|
17161 |
|
17162 |
|
17163 |
|
17164 |
|
17165 |
|
17166 |
|
17167 |
|
17168 |
|
17169 |
|
17170 |
|
17171 |
|
17172 |
|
17173 <div class="meta"> |
|
17174 |
|
17175 |
|
17176 <p>Inherited from |
|
17177 <a href="../classes/Router.html#attr_root">Router</a>: |
|
17178 |
|
17179 |
|
17180 |
|
17181 <a href="../files/app_js_router.js.html#l1336"><code>app/js/router.js:1336</code></a> |
|
17182 |
|
17183 </p> |
|
17184 |
|
17185 |
|
17186 |
|
17187 |
|
17188 </div> |
|
17189 |
|
17190 <div class="description"> |
|
17191 <p>Absolute root path from which all routes should be evaluated.</p> |
|
17192 |
|
17193 <p>For example, if your router is running on a page at |
|
17194 <code>http://example.com/myapp/</code> and you add a route with the path <code>/</code>, your |
|
17195 route will never execute, because the path will always be preceded by |
|
17196 <code>/myapp</code>. Setting <code>root</code> to <code>/myapp</code> would cause all routes to be |
|
17197 evaluated relative to that root URL, so the <code>/</code> route would then execute |
|
17198 when the user browses to <code>http://example.com/myapp/</code>.</p> |
|
17199 </div> |
|
17200 |
|
17201 |
|
17202 <p><strong>Default:</strong> `''`</p> |
|
17203 |
|
17204 |
|
17205 |
|
17206 <div class="emits box"> |
|
17207 <h4>Fires event <code>rootChange</code></h4> |
|
17208 |
|
17209 <p> |
|
17210 Fires when the value for the configuration attribute <code>root</code> is |
|
17211 changed. You can listen for the event using the <code>on</code> method if you |
|
17212 wish to be notified before the attribute's value has changed, or |
|
17213 using the <code>after</code> method if you wish to be notified after the |
|
17214 attribute's value has changed. |
|
17215 </p> |
|
17216 |
|
17217 <div class="params"> |
|
17218 <h4>Parameters:</h4> |
|
17219 |
|
17220 <ul class="params-list"> |
|
17221 <li class="param"> |
|
17222 <code class="param-name">e</code> |
|
17223 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17224 |
|
17225 <div class="param-description"> |
|
17226 An Event Facade object with the following |
|
17227 attribute-specific properties added: |
|
17228 </div> |
|
17229 |
|
17230 <ul class="params-list"> |
|
17231 <li class="param"> |
|
17232 <code class="param-name">prevVal</code> |
|
17233 <span class="type">Any</span> |
|
17234 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17235 </li> |
|
17236 <li class="param"> |
|
17237 <code class="param-name">newVal</code> |
|
17238 <span class="type">Any</span> |
|
17239 <div class="param-description">The value the attribute is to be set to.</div> |
|
17240 </li> |
|
17241 <li class="param"> |
|
17242 <code class="param-name">attrName</code> |
|
17243 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17244 <div class="param-description">The name of the attribute being set.</div> |
|
17245 </li> |
|
17246 <li class="param"> |
|
17247 <code class="param-name">subAttrName</code> |
|
17248 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17249 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17250 </li> |
|
17251 </ul> |
|
17252 </li> |
|
17253 </ul> |
|
17254 </div> |
|
17255 </div> |
|
17256 |
|
17257 |
|
17258 |
|
17259 </div> |
|
17260 |
|
17261 |
|
17262 <div id="attr_routes" class="attr item inherited"> |
|
17263 <a name="config_routes"></a> |
|
17264 <h3 class="name"><code>routes</code></h3> |
|
17265 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
17266 |
|
17267 |
|
17268 |
|
17269 |
|
17270 |
|
17271 |
|
17272 |
|
17273 |
|
17274 |
|
17275 |
|
17276 |
|
17277 |
|
17278 |
|
17279 |
|
17280 |
|
17281 <div class="meta"> |
|
17282 |
|
17283 |
|
17284 <p>Inherited from |
|
17285 <a href="../classes/Router.html#attr_routes">Router</a>: |
|
17286 |
|
17287 |
|
17288 |
|
17289 <a href="../files/app_js_router.js.html#l1354"><code>app/js/router.js:1354</code></a> |
|
17290 |
|
17291 </p> |
|
17292 |
|
17293 |
|
17294 |
|
17295 |
|
17296 </div> |
|
17297 |
|
17298 <div class="description"> |
|
17299 <p>Array of route objects.</p> |
|
17300 |
|
17301 <p>Each item in the array must be an object with the following properties:</p> |
|
17302 |
|
17303 <ul> |
|
17304 <li><p><code>path</code>: String or regex representing the path to match. See the docs |
|
17305 for the <code>route()</code> method for more details.</p></li> |
|
17306 <li><p><code>callbacks</code>: Function or a string representing the name of a |
|
17307 function on this router instance that should be called when the |
|
17308 route is triggered. An array of functions and/or strings may also be |
|
17309 provided. See the docs for the <code>route()</code> method for more details.</p></li> |
|
17310 </ul> |
|
17311 |
|
17312 <p>This attribute is intended to be used to set routes at init time, or to |
|
17313 completely reset all routes after init. To add routes after init without |
|
17314 resetting all existing routes, use the <code>route()</code> method.</p> |
|
17315 </div> |
|
17316 |
|
17317 |
|
17318 <p><strong>Default:</strong> `[]`</p> |
|
17319 |
|
17320 |
|
17321 |
|
17322 <div class="emits box"> |
|
17323 <h4>Fires event <code>routesChange</code></h4> |
|
17324 |
|
17325 <p> |
|
17326 Fires when the value for the configuration attribute <code>routes</code> is |
|
17327 changed. You can listen for the event using the <code>on</code> method if you |
|
17328 wish to be notified before the attribute's value has changed, or |
|
17329 using the <code>after</code> method if you wish to be notified after the |
|
17330 attribute's value has changed. |
|
17331 </p> |
|
17332 |
|
17333 <div class="params"> |
|
17334 <h4>Parameters:</h4> |
|
17335 |
|
17336 <ul class="params-list"> |
|
17337 <li class="param"> |
|
17338 <code class="param-name">e</code> |
|
17339 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17340 |
|
17341 <div class="param-description"> |
|
17342 An Event Facade object with the following |
|
17343 attribute-specific properties added: |
|
17344 </div> |
|
17345 |
|
17346 <ul class="params-list"> |
|
17347 <li class="param"> |
|
17348 <code class="param-name">prevVal</code> |
|
17349 <span class="type">Any</span> |
|
17350 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17351 </li> |
|
17352 <li class="param"> |
|
17353 <code class="param-name">newVal</code> |
|
17354 <span class="type">Any</span> |
|
17355 <div class="param-description">The value the attribute is to be set to.</div> |
|
17356 </li> |
|
17357 <li class="param"> |
|
17358 <code class="param-name">attrName</code> |
|
17359 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17360 <div class="param-description">The name of the attribute being set.</div> |
|
17361 </li> |
|
17362 <li class="param"> |
|
17363 <code class="param-name">subAttrName</code> |
|
17364 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17365 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17366 </li> |
|
17367 </ul> |
|
17368 </li> |
|
17369 </ul> |
|
17370 </div> |
|
17371 </div> |
|
17372 |
|
17373 |
|
17374 |
|
17375 </div> |
|
17376 |
|
17377 |
|
17378 <div id="attr_scrollToTop" class="attr item inherited"> |
|
17379 <a name="config_scrollToTop"></a> |
|
17380 <h3 class="name"><code>scrollToTop</code></h3> |
|
17381 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17382 |
|
17383 |
|
17384 |
|
17385 |
|
17386 |
|
17387 |
|
17388 |
|
17389 |
|
17390 |
|
17391 |
|
17392 |
|
17393 |
|
17394 |
|
17395 |
|
17396 |
|
17397 <div class="meta"> |
|
17398 |
|
17399 |
|
17400 <p>Inherited from |
|
17401 <a href="../classes/PjaxBase.html#attr_scrollToTop">PjaxBase</a>: |
|
17402 |
|
17403 |
|
17404 |
|
17405 <a href="../files/pjax_js_pjax-base.js.html#l419"><code>pjax/js/pjax-base.js:419</code></a> |
|
17406 |
|
17407 </p> |
|
17408 |
|
17409 |
|
17410 |
|
17411 |
|
17412 <p>Available since 3.5.0</p> |
|
17413 |
|
17414 </div> |
|
17415 |
|
17416 <div class="description"> |
|
17417 <p>Whether the page should be scrolled to the top after navigating to a URL.</p> |
|
17418 |
|
17419 <p>When the user clicks the browser's back button, the previous scroll position |
|
17420 will be maintained.</p> |
|
17421 </div> |
|
17422 |
|
17423 |
|
17424 <p><strong>Default:</strong> true</p> |
|
17425 |
|
17426 |
|
17427 |
|
17428 <div class="emits box"> |
|
17429 <h4>Fires event <code>scrollToTopChange</code></h4> |
|
17430 |
|
17431 <p> |
|
17432 Fires when the value for the configuration attribute <code>scrollToTop</code> is |
|
17433 changed. You can listen for the event using the <code>on</code> method if you |
|
17434 wish to be notified before the attribute's value has changed, or |
|
17435 using the <code>after</code> method if you wish to be notified after the |
|
17436 attribute's value has changed. |
|
17437 </p> |
|
17438 |
|
17439 <div class="params"> |
|
17440 <h4>Parameters:</h4> |
|
17441 |
|
17442 <ul class="params-list"> |
|
17443 <li class="param"> |
|
17444 <code class="param-name">e</code> |
|
17445 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17446 |
|
17447 <div class="param-description"> |
|
17448 An Event Facade object with the following |
|
17449 attribute-specific properties added: |
|
17450 </div> |
|
17451 |
|
17452 <ul class="params-list"> |
|
17453 <li class="param"> |
|
17454 <code class="param-name">prevVal</code> |
|
17455 <span class="type">Any</span> |
|
17456 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17457 </li> |
|
17458 <li class="param"> |
|
17459 <code class="param-name">newVal</code> |
|
17460 <span class="type">Any</span> |
|
17461 <div class="param-description">The value the attribute is to be set to.</div> |
|
17462 </li> |
|
17463 <li class="param"> |
|
17464 <code class="param-name">attrName</code> |
|
17465 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17466 <div class="param-description">The name of the attribute being set.</div> |
|
17467 </li> |
|
17468 <li class="param"> |
|
17469 <code class="param-name">subAttrName</code> |
|
17470 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17471 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17472 </li> |
|
17473 </ul> |
|
17474 </li> |
|
17475 </ul> |
|
17476 </div> |
|
17477 </div> |
|
17478 |
|
17479 |
|
17480 |
|
17481 </div> |
|
17482 |
|
17483 |
|
17484 <div id="attr_timeout" class="attr item inherited"> |
|
17485 <a name="config_timeout"></a> |
|
17486 <h3 class="name"><code>timeout</code></h3> |
|
17487 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
17488 |
|
17489 |
|
17490 |
|
17491 |
|
17492 |
|
17493 |
|
17494 |
|
17495 |
|
17496 |
|
17497 |
|
17498 |
|
17499 |
|
17500 |
|
17501 |
|
17502 |
|
17503 <div class="meta"> |
|
17504 |
|
17505 |
|
17506 <p>Inherited from |
|
17507 <a href="../classes/PjaxContent.html#attr_timeout">PjaxContent</a>: |
|
17508 |
|
17509 |
|
17510 |
|
17511 <a href="../files/pjax_js_pjax-content.js.html#l263"><code>pjax/js/pjax-content.js:263</code></a> |
|
17512 |
|
17513 </p> |
|
17514 |
|
17515 |
|
17516 |
|
17517 |
|
17518 <p>Available since 3.5.0</p> |
|
17519 |
|
17520 </div> |
|
17521 |
|
17522 <div class="description"> |
|
17523 <p>Time in milliseconds after which an Ajax request should time out.</p> |
|
17524 </div> |
|
17525 |
|
17526 |
|
17527 <p><strong>Default:</strong> 30000</p> |
|
17528 |
|
17529 |
|
17530 |
|
17531 <div class="emits box"> |
|
17532 <h4>Fires event <code>timeoutChange</code></h4> |
|
17533 |
|
17534 <p> |
|
17535 Fires when the value for the configuration attribute <code>timeout</code> is |
|
17536 changed. You can listen for the event using the <code>on</code> method if you |
|
17537 wish to be notified before the attribute's value has changed, or |
|
17538 using the <code>after</code> method if you wish to be notified after the |
|
17539 attribute's value has changed. |
|
17540 </p> |
|
17541 |
|
17542 <div class="params"> |
|
17543 <h4>Parameters:</h4> |
|
17544 |
|
17545 <ul class="params-list"> |
|
17546 <li class="param"> |
|
17547 <code class="param-name">e</code> |
|
17548 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17549 |
|
17550 <div class="param-description"> |
|
17551 An Event Facade object with the following |
|
17552 attribute-specific properties added: |
|
17553 </div> |
|
17554 |
|
17555 <ul class="params-list"> |
|
17556 <li class="param"> |
|
17557 <code class="param-name">prevVal</code> |
|
17558 <span class="type">Any</span> |
|
17559 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17560 </li> |
|
17561 <li class="param"> |
|
17562 <code class="param-name">newVal</code> |
|
17563 <span class="type">Any</span> |
|
17564 <div class="param-description">The value the attribute is to be set to.</div> |
|
17565 </li> |
|
17566 <li class="param"> |
|
17567 <code class="param-name">attrName</code> |
|
17568 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17569 <div class="param-description">The name of the attribute being set.</div> |
|
17570 </li> |
|
17571 <li class="param"> |
|
17572 <code class="param-name">subAttrName</code> |
|
17573 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17574 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17575 </li> |
|
17576 </ul> |
|
17577 </li> |
|
17578 </ul> |
|
17579 </div> |
|
17580 </div> |
|
17581 |
|
17582 |
|
17583 |
|
17584 </div> |
|
17585 |
|
17586 |
|
17587 <div id="attr_titleSelector" class="attr item inherited"> |
|
17588 <a name="config_titleSelector"></a> |
|
17589 <h3 class="name"><code>titleSelector</code></h3> |
|
17590 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17591 |
|
17592 |
|
17593 |
|
17594 |
|
17595 |
|
17596 |
|
17597 |
|
17598 |
|
17599 |
|
17600 |
|
17601 |
|
17602 |
|
17603 |
|
17604 |
|
17605 |
|
17606 <div class="meta"> |
|
17607 |
|
17608 |
|
17609 <p>Inherited from |
|
17610 <a href="../classes/PjaxContent.html#attr_titleSelector">PjaxContent</a>: |
|
17611 |
|
17612 |
|
17613 |
|
17614 <a href="../files/pjax_js_pjax-content.js.html#l245"><code>pjax/js/pjax-content.js:245</code></a> |
|
17615 |
|
17616 </p> |
|
17617 |
|
17618 |
|
17619 |
|
17620 |
|
17621 <p>Available since 3.5.0</p> |
|
17622 |
|
17623 </div> |
|
17624 |
|
17625 <div class="description"> |
|
17626 <p>CSS selector used to extract a page title from the content of a page |
|
17627 loaded via Pjax.</p> |
|
17628 |
|
17629 <p>By default this is set to extract the title from the <code><title></code> element, |
|
17630 but you could customize it to extract the title from an <code><h1></code>, or from |
|
17631 any other element, if that's more appropriate for the content you're |
|
17632 loading.</p> |
|
17633 </div> |
|
17634 |
|
17635 |
|
17636 <p><strong>Default:</strong> "title"</p> |
|
17637 |
|
17638 |
|
17639 |
|
17640 <div class="emits box"> |
|
17641 <h4>Fires event <code>titleSelectorChange</code></h4> |
|
17642 |
|
17643 <p> |
|
17644 Fires when the value for the configuration attribute <code>titleSelector</code> is |
|
17645 changed. You can listen for the event using the <code>on</code> method if you |
|
17646 wish to be notified before the attribute's value has changed, or |
|
17647 using the <code>after</code> method if you wish to be notified after the |
|
17648 attribute's value has changed. |
|
17649 </p> |
|
17650 |
|
17651 <div class="params"> |
|
17652 <h4>Parameters:</h4> |
|
17653 |
|
17654 <ul class="params-list"> |
|
17655 <li class="param"> |
|
17656 <code class="param-name">e</code> |
|
17657 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17658 |
|
17659 <div class="param-description"> |
|
17660 An Event Facade object with the following |
|
17661 attribute-specific properties added: |
|
17662 </div> |
|
17663 |
|
17664 <ul class="params-list"> |
|
17665 <li class="param"> |
|
17666 <code class="param-name">prevVal</code> |
|
17667 <span class="type">Any</span> |
|
17668 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
17669 </li> |
|
17670 <li class="param"> |
|
17671 <code class="param-name">newVal</code> |
|
17672 <span class="type">Any</span> |
|
17673 <div class="param-description">The value the attribute is to be set to.</div> |
|
17674 </li> |
|
17675 <li class="param"> |
|
17676 <code class="param-name">attrName</code> |
|
17677 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17678 <div class="param-description">The name of the attribute being set.</div> |
|
17679 </li> |
|
17680 <li class="param"> |
|
17681 <code class="param-name">subAttrName</code> |
|
17682 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17683 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
17684 </li> |
|
17685 </ul> |
|
17686 </li> |
|
17687 </ul> |
|
17688 </div> |
|
17689 </div> |
|
17690 |
|
17691 |
|
17692 |
|
17693 </div> |
|
17694 |
|
17695 |
|
17696 </div> |
|
17697 |
|
17698 |
|
17699 |
|
17700 <div id="events" class="api-class-tabpanel"> |
|
17701 <h2 class="off-left">Events</h2> |
|
17702 |
|
17703 |
|
17704 <div id="event_destroy" class="events item inherited"> |
|
17705 <h3 class="name"><code>destroy</code></h3> |
|
17706 <span class="type"></span> |
|
17707 |
|
17708 |
|
17709 |
|
17710 |
|
17711 |
|
17712 |
|
17713 |
|
17714 |
|
17715 |
|
17716 <div class="meta"> |
|
17717 |
|
17718 |
|
17719 <p>Inherited from |
|
17720 <a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>: |
|
17721 |
|
17722 |
|
17723 |
|
17724 <a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a> |
|
17725 |
|
17726 </p> |
|
17727 |
|
17728 |
|
17729 |
|
17730 |
|
17731 </div> |
|
17732 |
|
17733 <div class="description"> |
|
17734 <p> |
|
17735 Lifecycle event for the destroy phase, |
|
17736 fired prior to destruction. Invoking the preventDefault |
|
17737 method on the event object provided to subscribers will |
|
17738 prevent destruction from proceeding. |
|
17739 </p> |
|
17740 |
|
17741 <p> |
|
17742 Subscribers to the "after" moment of this event, will be notified |
|
17743 after destruction is complete (and as a result cannot prevent |
|
17744 destruction). |
|
17745 </p> |
|
17746 </div> |
|
17747 |
|
17748 |
|
17749 <div class="params"> |
|
17750 <h4>Event Payload:</h4> |
|
17751 |
|
17752 <ul class="params-list"> |
|
17753 |
|
17754 <li class="param"> |
|
17755 |
|
17756 <code class="param-name">e</code> |
|
17757 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17758 |
|
17759 |
|
17760 |
|
17761 |
|
17762 <div class="param-description"> |
|
17763 <p>Event object</p> |
|
17764 </div> |
|
17765 |
|
17766 |
|
17767 </li> |
|
17768 |
|
17769 </ul> |
|
17770 </div> |
|
17771 |
|
17772 |
|
17773 |
|
17774 |
|
17775 </div> |
|
17776 |
|
17777 |
|
17778 <div id="event_error" class="events item inherited"> |
|
17779 <h3 class="name"><code>error</code></h3> |
|
17780 <span class="type"></span> |
|
17781 |
|
17782 |
|
17783 |
|
17784 |
|
17785 |
|
17786 |
|
17787 |
|
17788 |
|
17789 |
|
17790 <div class="meta"> |
|
17791 |
|
17792 |
|
17793 <p>Inherited from |
|
17794 <a href="../classes/Pjax.html#event_error">Pjax</a>: |
|
17795 |
|
17796 |
|
17797 |
|
17798 <a href="../files/pjax_js_pjax.js.html#l22"><code>pjax/js/pjax.js:22</code></a> |
|
17799 |
|
17800 </p> |
|
17801 |
|
17802 |
|
17803 |
|
17804 |
|
17805 <p>Available since 3.5.0</p> |
|
17806 |
|
17807 </div> |
|
17808 |
|
17809 <div class="description"> |
|
17810 <p>Fired when an error occurs while attempting to load a URL via Ajax.</p> |
|
17811 </div> |
|
17812 |
|
17813 |
|
17814 <div class="params"> |
|
17815 <h4>Event Payload:</h4> |
|
17816 |
|
17817 <ul class="params-list"> |
|
17818 |
|
17819 <li class="param"> |
|
17820 |
|
17821 <code class="param-name">content</code> |
|
17822 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
17823 |
|
17824 |
|
17825 |
|
17826 |
|
17827 <div class="param-description"> |
|
17828 <p>Content extracted from the response, if any.</p> |
|
17829 </div> |
|
17830 |
|
17831 |
|
17832 <ul class="params-list"> |
|
17833 |
|
17834 <li class="param"> |
|
17835 |
|
17836 <code class="param-name">node</code> |
|
17837 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
17838 |
|
17839 |
|
17840 <div class="param-description"> |
|
17841 <p>A <code>Y.Node</code> instance for a document fragment |
|
17842 containing the extracted HTML content.</p> |
|
17843 </div> |
|
17844 |
|
17845 |
|
17846 </li> |
|
17847 |
|
17848 <li class="param"> |
|
17849 |
|
17850 <code class="param-name optional">[title]</code> |
|
17851 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17852 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
17853 |
|
17854 |
|
17855 <div class="param-description"> |
|
17856 <p>The title of the HTML page, if any, |
|
17857 extracted using the <code>titleSelector</code> attribute. If <code>titleSelector</code> is |
|
17858 not set or if a title could not be found, this property will be |
|
17859 <code>undefined</code>.</p> |
|
17860 </div> |
|
17861 |
|
17862 |
|
17863 </li> |
|
17864 |
|
17865 </ul> |
|
17866 |
|
17867 </li> |
|
17868 |
|
17869 <li class="param"> |
|
17870 |
|
17871 <code class="param-name">responseText</code> |
|
17872 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17873 |
|
17874 |
|
17875 |
|
17876 |
|
17877 <div class="param-description"> |
|
17878 <p>Raw Ajax response text.</p> |
|
17879 </div> |
|
17880 |
|
17881 |
|
17882 </li> |
|
17883 |
|
17884 <li class="param"> |
|
17885 |
|
17886 <code class="param-name">status</code> |
|
17887 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
17888 |
|
17889 |
|
17890 |
|
17891 |
|
17892 <div class="param-description"> |
|
17893 <p>HTTP status code for the Ajax response.</p> |
|
17894 </div> |
|
17895 |
|
17896 |
|
17897 </li> |
|
17898 |
|
17899 <li class="param"> |
|
17900 |
|
17901 <code class="param-name">url</code> |
|
17902 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17903 |
|
17904 |
|
17905 |
|
17906 |
|
17907 <div class="param-description"> |
|
17908 <p>The absolute URL that failed to load.</p> |
|
17909 </div> |
|
17910 |
|
17911 |
|
17912 </li> |
|
17913 |
|
17914 </ul> |
|
17915 </div> |
|
17916 |
|
17917 |
|
17918 |
|
17919 |
|
17920 </div> |
|
17921 |
|
17922 |
|
17923 <div id="event_init" class="events item inherited"> |
|
17924 <h3 class="name"><code>init</code></h3> |
|
17925 <span class="type"></span> |
|
17926 |
|
17927 |
|
17928 |
|
17929 |
|
17930 |
|
17931 |
|
17932 |
|
17933 |
|
17934 |
|
17935 <div class="meta"> |
|
17936 |
|
17937 |
|
17938 <p>Inherited from |
|
17939 <a href="../classes/BaseObservable.html#event_init">BaseObservable</a>: |
|
17940 |
|
17941 |
|
17942 |
|
17943 <a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a> |
|
17944 |
|
17945 </p> |
|
17946 |
|
17947 |
|
17948 |
|
17949 |
|
17950 </div> |
|
17951 |
|
17952 <div class="description"> |
|
17953 <p> |
|
17954 Lifecycle event for the init phase, fired prior to initialization. |
|
17955 Invoking the preventDefault() method on the event object provided |
|
17956 to subscribers will prevent initialization from occuring. |
|
17957 </p> |
|
17958 |
|
17959 <p> |
|
17960 Subscribers to the "after" momemt of this event, will be notified |
|
17961 after initialization of the object is complete (and therefore |
|
17962 cannot prevent initialization). |
|
17963 </p> |
|
17964 </div> |
|
17965 |
|
17966 |
|
17967 <div class="params"> |
|
17968 <h4>Event Payload:</h4> |
|
17969 |
|
17970 <ul class="params-list"> |
|
17971 |
|
17972 <li class="param"> |
|
17973 |
|
17974 <code class="param-name">e</code> |
|
17975 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
17976 |
|
17977 |
|
17978 |
|
17979 |
|
17980 <div class="param-description"> |
|
17981 <p>Event object, with a cfg property which |
|
17982 refers to the configuration object passed to the constructor.</p> |
|
17983 </div> |
|
17984 |
|
17985 |
|
17986 </li> |
|
17987 |
|
17988 </ul> |
|
17989 </div> |
|
17990 |
|
17991 |
|
17992 |
|
17993 |
|
17994 </div> |
|
17995 |
|
17996 |
|
17997 <div id="event_load" class="events item inherited"> |
|
17998 <h3 class="name"><code>load</code></h3> |
|
17999 <span class="type"></span> |
|
18000 |
|
18001 |
|
18002 |
|
18003 |
|
18004 |
|
18005 |
|
18006 |
|
18007 |
|
18008 |
|
18009 <div class="meta"> |
|
18010 |
|
18011 |
|
18012 <p>Inherited from |
|
18013 <a href="../classes/Pjax.html#event_load">Pjax</a>: |
|
18014 |
|
18015 |
|
18016 |
|
18017 <a href="../files/pjax_js_pjax.js.html#l40"><code>pjax/js/pjax.js:40</code></a> |
|
18018 |
|
18019 </p> |
|
18020 |
|
18021 |
|
18022 |
|
18023 |
|
18024 <p>Available since 3.5.0</p> |
|
18025 |
|
18026 </div> |
|
18027 |
|
18028 <div class="description"> |
|
18029 <p>Fired when a URL is successfully loaded via Ajax.</p> |
|
18030 </div> |
|
18031 |
|
18032 |
|
18033 <div class="params"> |
|
18034 <h4>Event Payload:</h4> |
|
18035 |
|
18036 <ul class="params-list"> |
|
18037 |
|
18038 <li class="param"> |
|
18039 |
|
18040 <code class="param-name">content</code> |
|
18041 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
18042 |
|
18043 |
|
18044 |
|
18045 |
|
18046 <div class="param-description"> |
|
18047 <p>Content extracted from the response, if any.</p> |
|
18048 </div> |
|
18049 |
|
18050 |
|
18051 <ul class="params-list"> |
|
18052 |
|
18053 <li class="param"> |
|
18054 |
|
18055 <code class="param-name">node</code> |
|
18056 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
18057 |
|
18058 |
|
18059 <div class="param-description"> |
|
18060 <p>A <code>Y.Node</code> instance for a document fragment |
|
18061 containing the extracted HTML content.</p> |
|
18062 </div> |
|
18063 |
|
18064 |
|
18065 </li> |
|
18066 |
|
18067 <li class="param"> |
|
18068 |
|
18069 <code class="param-name optional">[title]</code> |
|
18070 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18071 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
18072 |
|
18073 |
|
18074 <div class="param-description"> |
|
18075 <p>The title of the HTML page, if any, |
|
18076 extracted using the <code>titleSelector</code> attribute. If <code>titleSelector</code> is |
|
18077 not set or if a title could not be found, this property will be |
|
18078 <code>undefined</code>.</p> |
|
18079 </div> |
|
18080 |
|
18081 |
|
18082 </li> |
|
18083 |
|
18084 </ul> |
|
18085 |
|
18086 </li> |
|
18087 |
|
18088 <li class="param"> |
|
18089 |
|
18090 <code class="param-name">responseText</code> |
|
18091 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18092 |
|
18093 |
|
18094 |
|
18095 |
|
18096 <div class="param-description"> |
|
18097 <p>Raw Ajax response text.</p> |
|
18098 </div> |
|
18099 |
|
18100 |
|
18101 </li> |
|
18102 |
|
18103 <li class="param"> |
|
18104 |
|
18105 <code class="param-name">status</code> |
|
18106 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
18107 |
|
18108 |
|
18109 |
|
18110 |
|
18111 <div class="param-description"> |
|
18112 <p>HTTP status code for the Ajax response.</p> |
|
18113 </div> |
|
18114 |
|
18115 |
|
18116 </li> |
|
18117 |
|
18118 <li class="param"> |
|
18119 |
|
18120 <code class="param-name">url</code> |
|
18121 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18122 |
|
18123 |
|
18124 |
|
18125 |
|
18126 <div class="param-description"> |
|
18127 <p>The absolute URL that was loaded.</p> |
|
18128 </div> |
|
18129 |
|
18130 |
|
18131 </li> |
|
18132 |
|
18133 </ul> |
|
18134 </div> |
|
18135 |
|
18136 |
|
18137 |
|
18138 |
|
18139 </div> |
|
18140 |
|
18141 |
|
18142 <div id="event_navigate" class="events item inherited"> |
|
18143 <h3 class="name"><code>navigate</code></h3> |
|
18144 <span class="type"></span> |
|
18145 |
|
18146 |
|
18147 |
|
18148 |
|
18149 |
|
18150 |
|
18151 |
|
18152 |
|
18153 |
|
18154 <div class="meta"> |
|
18155 |
|
18156 |
|
18157 <p>Inherited from |
|
18158 <a href="../classes/PjaxBase.html#event_navigate">PjaxBase</a>: |
|
18159 |
|
18160 |
|
18161 |
|
18162 <a href="../files/pjax_js_pjax-base.js.html#l16"><code>pjax/js/pjax-base.js:16</code></a> |
|
18163 |
|
18164 </p> |
|
18165 |
|
18166 |
|
18167 |
|
18168 |
|
18169 <p>Available since 3.5.0</p> |
|
18170 |
|
18171 </div> |
|
18172 |
|
18173 <div class="description"> |
|
18174 <p>Fired when navigating to a URL via Pjax.</p> |
|
18175 |
|
18176 <p>When the <code>navigate()</code> method is called or a pjax link is clicked, this event |
|
18177 will be fired if the browser supports HTML5 history <em>and</em> the router has a |
|
18178 route handler for the specified URL.</p> |
|
18179 |
|
18180 <p>This is a useful event to listen to for adding a visual loading indicator |
|
18181 while the route handlers are busy handling the URL change.</p> |
|
18182 </div> |
|
18183 |
|
18184 |
|
18185 <div class="params"> |
|
18186 <h4>Event Payload:</h4> |
|
18187 |
|
18188 <ul class="params-list"> |
|
18189 |
|
18190 <li class="param"> |
|
18191 |
|
18192 <code class="param-name">url</code> |
|
18193 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18194 |
|
18195 |
|
18196 |
|
18197 |
|
18198 <div class="param-description"> |
|
18199 <p>The URL that the router will dispatch to its route |
|
18200 handlers in order to fulfill the enhanced navigation "request".</p> |
|
18201 </div> |
|
18202 |
|
18203 |
|
18204 </li> |
|
18205 |
|
18206 <li class="param"> |
|
18207 |
|
18208 <code class="param-name optional">[force=false]</code> |
|
18209 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18210 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
18211 |
|
18212 |
|
18213 |
|
18214 |
|
18215 <div class="param-description"> |
|
18216 <p>Whether the enhanced navigation should occur |
|
18217 even in browsers without HTML5 history.</p> |
|
18218 </div> |
|
18219 |
|
18220 |
|
18221 </li> |
|
18222 |
|
18223 <li class="param"> |
|
18224 |
|
18225 <code class="param-name optional">[hash]</code> |
|
18226 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18227 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
18228 |
|
18229 |
|
18230 |
|
18231 |
|
18232 <div class="param-description"> |
|
18233 <p>The hash-fragment (including "#") of the <code>url</code>. This |
|
18234 will be present when the <code>url</code> differs from the current URL only by its |
|
18235 hash and <code>navigateOnHash</code> has been set to <code>true</code>.</p> |
|
18236 </div> |
|
18237 |
|
18238 |
|
18239 </li> |
|
18240 |
|
18241 <li class="param"> |
|
18242 |
|
18243 <code class="param-name optional">[originEvent]</code> |
|
18244 <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span> |
|
18245 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
18246 |
|
18247 |
|
18248 |
|
18249 |
|
18250 <div class="param-description"> |
|
18251 <p>The event that caused the navigation. Usually |
|
18252 this would be a click event from a "pjax" anchor element.</p> |
|
18253 </div> |
|
18254 |
|
18255 |
|
18256 </li> |
|
18257 |
|
18258 <li class="param"> |
|
18259 |
|
18260 <code class="param-name optional">[replace]</code> |
|
18261 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18262 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
18263 |
|
18264 |
|
18265 |
|
18266 |
|
18267 <div class="param-description"> |
|
18268 <p>Whether or not the current history entry will be |
|
18269 replaced, or a new entry will be created. Will default to <code>true</code> if the |
|
18270 specified <code>url</code> is the same as the current URL.</p> |
|
18271 </div> |
|
18272 |
|
18273 |
|
18274 </li> |
|
18275 |
|
18276 </ul> |
|
18277 </div> |
|
18278 |
|
18279 |
|
18280 |
|
18281 |
|
18282 </div> |
|
18283 |
|
18284 |
|
18285 <div id="event_ready" class="events item inherited"> |
|
18286 <h3 class="name"><code>ready</code></h3> |
|
18287 <span class="type"></span> |
|
18288 |
|
18289 |
|
18290 |
|
18291 |
|
18292 |
|
18293 |
|
18294 |
|
18295 |
|
18296 |
|
18297 <div class="meta"> |
|
18298 |
|
18299 |
|
18300 <p>Inherited from |
|
18301 <a href="../classes/Router.html#event_ready">Router</a>: |
|
18302 |
|
18303 |
|
18304 |
|
18305 <a href="../files/app_js_router.js.html#l24"><code>app/js/router.js:24</code></a> |
|
18306 |
|
18307 </p> |
|
18308 |
|
18309 |
|
18310 |
|
18311 |
|
18312 </div> |
|
18313 |
|
18314 <div class="description"> |
|
18315 <p>Fired when the router is ready to begin dispatching to route handlers.</p> |
|
18316 |
|
18317 <p>You shouldn't need to wait for this event unless you plan to implement some |
|
18318 kind of custom dispatching logic. It's used internally in order to avoid |
|
18319 dispatching to an initial route if a browser history change occurs first.</p> |
|
18320 </div> |
|
18321 |
|
18322 |
|
18323 <div class="params"> |
|
18324 <h4>Event Payload:</h4> |
|
18325 |
|
18326 <ul class="params-list"> |
|
18327 |
|
18328 <li class="param"> |
|
18329 |
|
18330 <code class="param-name">dispatched</code> |
|
18331 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18332 |
|
18333 |
|
18334 |
|
18335 |
|
18336 <div class="param-description"> |
|
18337 <p><code>true</code> if routes have already been dispatched |
|
18338 (most likely due to a history change).</p> |
|
18339 </div> |
|
18340 |
|
18341 |
|
18342 </li> |
|
18343 |
|
18344 </ul> |
|
18345 </div> |
|
18346 |
|
18347 |
|
18348 |
|
18349 |
|
18350 </div> |
|
18351 |
|
18352 |
|
18353 </div> |
|
18354 |
|
18355 </div> |
|
18356 </div> |
|
18357 |
|
18358 </div> |
|
18359 </div> |
|
18360 </div> |
|
18361 </div> |
|
18362 </div> |
|
18363 </div> |
|
18364 <script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
18365 <script>prettyPrint();</script> |
|
18366 <script src="../assets/js/yui-prettify.js"></script> |
|
18367 <script src="../assets/../api.js"></script> |
|
18368 <script src="../assets/js/api-filter.js"></script> |
|
18369 <script src="../assets/js/api-list.js"></script> |
|
18370 <script src="../assets/js/api-search.js"></script> |
|
18371 <script src="../assets/js/apidocs.js"></script> |
|
18372 </body> |
|
18373 </html> |