|
1 <!DOCTYPE html> |
|
2 <html lang="en"> |
|
3 <head> |
|
4 <meta charset="utf-8"> |
|
5 <title>App.Base - 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>App.Base Class</h1> |
|
1532 <div class="box meta"> |
|
1533 |
|
1534 <div class="uses"> |
|
1535 Uses |
|
1536 <ul class="inline commas"> |
|
1537 |
|
1538 <li><a href="View.html">View</a></li> |
|
1539 |
|
1540 <li><a href="Router.html">Router</a></li> |
|
1541 |
|
1542 <li><a href="PjaxBase.html">PjaxBase</a></li> |
|
1543 |
|
1544 </ul> |
|
1545 </div> |
|
1546 |
|
1547 |
|
1548 |
|
1549 <div class="extends"> |
|
1550 Extends <a href="../classes/Base.html" class="crosslink">Base</a> |
|
1551 </div> |
|
1552 |
|
1553 |
|
1554 |
|
1555 <div class="foundat"> |
|
1556 Defined in: <a href="../files/app_js_app-base.js.html#l51"><code>app/js/app-base.js:51</code></a> |
|
1557 </div> |
|
1558 |
|
1559 |
|
1560 |
|
1561 |
|
1562 Module: <a href="../modules/app-base.html">app-base</a><br> |
|
1563 Parent Module: <a href="../modules/app.html">app</a> |
|
1564 |
|
1565 |
|
1566 |
|
1567 |
|
1568 <p>Available since 3.5.0</p> |
|
1569 |
|
1570 </div> |
|
1571 |
|
1572 |
|
1573 |
|
1574 <div class="box intro"> |
|
1575 <p>Provides a top-level application component which manages navigation and views.</p> |
|
1576 |
|
1577 <p>This gives you a foundation and structure on which to build your application; it |
|
1578 combines robust URL navigation with powerful routing and flexible view |
|
1579 management.</p> |
|
1580 </div> |
|
1581 |
|
1582 |
|
1583 <div class="constructor"> |
|
1584 <h2>Constructor</h2> |
|
1585 <div id="method_App.Base" class="method item"> |
|
1586 <h3 class="name"><code>App.Base</code></h3> |
|
1587 |
|
1588 |
|
1589 <div class="args"> |
|
1590 <span class="paren">(</span><ul class="args-list inline commas"> |
|
1591 |
|
1592 <li class="arg"> |
|
1593 |
|
1594 <code class="optional">[config]</code> |
|
1595 |
|
1596 </li> |
|
1597 |
|
1598 </ul><span class="paren">)</span> |
|
1599 </div> |
|
1600 |
|
1601 |
|
1602 |
|
1603 |
|
1604 |
|
1605 |
|
1606 |
|
1607 |
|
1608 |
|
1609 |
|
1610 |
|
1611 |
|
1612 |
|
1613 |
|
1614 |
|
1615 |
|
1616 <div class="meta"> |
|
1617 |
|
1618 |
|
1619 |
|
1620 <p> |
|
1621 |
|
1622 Defined in |
|
1623 |
|
1624 |
|
1625 |
|
1626 |
|
1627 <a href="../files/app_js_app-base.js.html#l51"><code>app/js/app-base.js:51</code></a> |
|
1628 |
|
1629 </p> |
|
1630 |
|
1631 |
|
1632 |
|
1633 |
|
1634 |
|
1635 <p>Available since 3.5.0</p> |
|
1636 |
|
1637 </div> |
|
1638 |
|
1639 <div class="description"> |
|
1640 |
|
1641 </div> |
|
1642 |
|
1643 |
|
1644 <div class="params"> |
|
1645 <h4>Parameters:</h4> |
|
1646 |
|
1647 <ul class="params-list"> |
|
1648 |
|
1649 <li class="param"> |
|
1650 |
|
1651 <code class="param-name optional">[config]</code> |
|
1652 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
1653 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
1654 |
|
1655 |
|
1656 |
|
1657 |
|
1658 <div class="param-description"> |
|
1659 <p>The following are configuration properties that can be |
|
1660 specified <em>in addition</em> to default attribute values and the non-attribute |
|
1661 properties provided by <code>Y.Base</code>:</p> |
|
1662 </div> |
|
1663 |
|
1664 |
|
1665 <ul class="params-list"> |
|
1666 |
|
1667 <li class="param"> |
|
1668 |
|
1669 <code class="param-name optional">[views]</code> |
|
1670 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
1671 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
1672 |
|
1673 |
|
1674 <div class="param-description"> |
|
1675 <p>Hash of view-name to metadata used to |
|
1676 declaratively describe an application's views and their relationship with |
|
1677 the app and other views. The views specified here will override any defaults |
|
1678 provided by the <code>views</code> object on the <code>prototype</code>.</p> |
|
1679 </div> |
|
1680 |
|
1681 |
|
1682 </li> |
|
1683 |
|
1684 </ul> |
|
1685 |
|
1686 </li> |
|
1687 |
|
1688 </ul> |
|
1689 </div> |
|
1690 |
|
1691 |
|
1692 |
|
1693 |
|
1694 |
|
1695 </div> |
|
1696 |
|
1697 </div> |
|
1698 |
|
1699 |
|
1700 <div id="classdocs" class="tabview"> |
|
1701 <ul class="api-class-tabs"> |
|
1702 <li class="api-class-tab index"><a href="#index">Index</a></li> |
|
1703 |
|
1704 |
|
1705 <li class="api-class-tab methods"><a href="#methods">Methods</a></li> |
|
1706 |
|
1707 |
|
1708 <li class="api-class-tab properties"><a href="#properties">Properties</a></li> |
|
1709 |
|
1710 |
|
1711 <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> |
|
1712 |
|
1713 |
|
1714 <li class="api-class-tab events"><a href="#events">Events</a></li> |
|
1715 |
|
1716 </ul> |
|
1717 |
|
1718 <div> |
|
1719 <div id="index" class="api-class-tabpanel index"> |
|
1720 <h2 class="off-left">Item Index</h2> |
|
1721 |
|
1722 |
|
1723 <div class="index-section methods"> |
|
1724 <h3>Methods</h3> |
|
1725 |
|
1726 <ul class="index-list methods extends"> |
|
1727 |
|
1728 <li class="index-item method private inherited"> |
|
1729 <a href="#method__addAttrs">_addAttrs</a> |
|
1730 |
|
1731 |
|
1732 |
|
1733 </li> |
|
1734 |
|
1735 <li class="index-item method private inherited"> |
|
1736 <a href="#method__addLazyAttr">_addLazyAttr</a> |
|
1737 |
|
1738 |
|
1739 |
|
1740 </li> |
|
1741 |
|
1742 <li class="index-item method protected"> |
|
1743 <a href="#method__afterActiveViewChange">_afterActiveViewChange</a> |
|
1744 |
|
1745 |
|
1746 |
|
1747 </li> |
|
1748 |
|
1749 <li class="index-item method protected inherited"> |
|
1750 <a href="#method__afterContainerChange">_afterContainerChange</a> |
|
1751 |
|
1752 |
|
1753 |
|
1754 </li> |
|
1755 |
|
1756 <li class="index-item method protected inherited"> |
|
1757 <a href="#method__afterHistoryChange">_afterHistoryChange</a> |
|
1758 |
|
1759 |
|
1760 |
|
1761 </li> |
|
1762 |
|
1763 <li class="index-item method private inherited"> |
|
1764 <a href="#method__aggregateAttrs">_aggregateAttrs</a> |
|
1765 |
|
1766 |
|
1767 |
|
1768 </li> |
|
1769 |
|
1770 <li class="index-item method protected"> |
|
1771 <a href="#method__attachView">_attachView</a> |
|
1772 |
|
1773 |
|
1774 |
|
1775 </li> |
|
1776 |
|
1777 <li class="index-item method private inherited"> |
|
1778 <a href="#method__attrCfgHash">_attrCfgHash</a> |
|
1779 |
|
1780 |
|
1781 |
|
1782 </li> |
|
1783 |
|
1784 <li class="index-item method private inherited"> |
|
1785 <a href="#method__baseDestroy">_baseDestroy</a> |
|
1786 |
|
1787 |
|
1788 |
|
1789 </li> |
|
1790 |
|
1791 <li class="index-item method private inherited"> |
|
1792 <a href="#method__baseInit">_baseInit</a> |
|
1793 |
|
1794 |
|
1795 |
|
1796 </li> |
|
1797 |
|
1798 <li class="index-item method private inherited"> |
|
1799 <a href="#method__cloneDefaultValue">_cloneDefaultValue</a> |
|
1800 |
|
1801 |
|
1802 |
|
1803 </li> |
|
1804 |
|
1805 <li class="index-item method protected inherited"> |
|
1806 <a href="#method__decode">_decode</a> |
|
1807 |
|
1808 |
|
1809 |
|
1810 </li> |
|
1811 |
|
1812 <li class="index-item method private inherited"> |
|
1813 <a href="#method__defAttrChangeFn">_defAttrChangeFn</a> |
|
1814 |
|
1815 |
|
1816 |
|
1817 </li> |
|
1818 |
|
1819 <li class="index-item method protected inherited"> |
|
1820 <a href="#method__defDestroyFn">_defDestroyFn</a> |
|
1821 |
|
1822 |
|
1823 |
|
1824 </li> |
|
1825 |
|
1826 <li class="index-item method protected inherited"> |
|
1827 <a href="#method__defInitFn">_defInitFn</a> |
|
1828 |
|
1829 |
|
1830 |
|
1831 </li> |
|
1832 |
|
1833 <li class="index-item method protected inherited"> |
|
1834 <a href="#method__defNavigateFn">_defNavigateFn</a> |
|
1835 |
|
1836 |
|
1837 |
|
1838 </li> |
|
1839 |
|
1840 <li class="index-item method protected inherited"> |
|
1841 <a href="#method__defReadyFn">_defReadyFn</a> |
|
1842 |
|
1843 |
|
1844 |
|
1845 </li> |
|
1846 |
|
1847 <li class="index-item method protected inherited"> |
|
1848 <a href="#method__dequeue">_dequeue</a> |
|
1849 |
|
1850 |
|
1851 |
|
1852 </li> |
|
1853 |
|
1854 <li class="index-item method protected inherited"> |
|
1855 <a href="#method__destroyContainer">_destroyContainer</a> |
|
1856 |
|
1857 |
|
1858 |
|
1859 </li> |
|
1860 |
|
1861 <li class="index-item method private inherited"> |
|
1862 <a href="#method__destroyHierarchy">_destroyHierarchy</a> |
|
1863 |
|
1864 |
|
1865 |
|
1866 </li> |
|
1867 |
|
1868 <li class="index-item method protected"> |
|
1869 <a href="#method__detachView">_detachView</a> |
|
1870 |
|
1871 |
|
1872 |
|
1873 </li> |
|
1874 |
|
1875 <li class="index-item method protected inherited"> |
|
1876 <a href="#method__dispatch">_dispatch</a> |
|
1877 |
|
1878 |
|
1879 |
|
1880 </li> |
|
1881 |
|
1882 <li class="index-item method private inherited"> |
|
1883 <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a> |
|
1884 |
|
1885 |
|
1886 |
|
1887 </li> |
|
1888 |
|
1889 <li class="index-item method private inherited"> |
|
1890 <a href="#method__filterAttrCfgs">_filterAttrCfgs</a> |
|
1891 |
|
1892 |
|
1893 |
|
1894 </li> |
|
1895 |
|
1896 <li class="index-item method private inherited"> |
|
1897 <a href="#method__fireAttrChange">_fireAttrChange</a> |
|
1898 |
|
1899 |
|
1900 |
|
1901 </li> |
|
1902 |
|
1903 <li class="index-item method protected inherited"> |
|
1904 <a href="#method__getAttr">_getAttr</a> |
|
1905 |
|
1906 |
|
1907 |
|
1908 </li> |
|
1909 |
|
1910 <li class="index-item method protected inherited"> |
|
1911 <a href="#method__getAttrCfg">_getAttrCfg</a> |
|
1912 |
|
1913 |
|
1914 |
|
1915 </li> |
|
1916 |
|
1917 <li class="index-item method protected inherited"> |
|
1918 <a href="#method__getAttrCfgs">_getAttrCfgs</a> |
|
1919 |
|
1920 |
|
1921 |
|
1922 </li> |
|
1923 |
|
1924 <li class="index-item method private inherited"> |
|
1925 <a href="#method__getAttrInitVal">_getAttrInitVal</a> |
|
1926 |
|
1927 |
|
1928 |
|
1929 </li> |
|
1930 |
|
1931 <li class="index-item method protected inherited"> |
|
1932 <a href="#method__getAttrs">_getAttrs</a> |
|
1933 |
|
1934 |
|
1935 |
|
1936 </li> |
|
1937 |
|
1938 <li class="index-item method protected inherited"> |
|
1939 <a href="#method__getClasses">_getClasses</a> |
|
1940 |
|
1941 |
|
1942 |
|
1943 </li> |
|
1944 |
|
1945 <li class="index-item method protected inherited"> |
|
1946 <a href="#method__getContainer">_getContainer</a> |
|
1947 |
|
1948 |
|
1949 |
|
1950 </li> |
|
1951 |
|
1952 <li class="index-item method private inherited"> |
|
1953 <a href="#method__getFullType">_getFullType</a> |
|
1954 |
|
1955 |
|
1956 |
|
1957 </li> |
|
1958 |
|
1959 <li class="index-item method protected inherited"> |
|
1960 <a href="#method__getHashPath">_getHashPath</a> |
|
1961 |
|
1962 |
|
1963 |
|
1964 </li> |
|
1965 |
|
1966 <li class="index-item method protected inherited"> |
|
1967 <a href="#method__getOrigin">_getOrigin</a> |
|
1968 |
|
1969 |
|
1970 |
|
1971 </li> |
|
1972 |
|
1973 <li class="index-item method protected inherited"> |
|
1974 <a href="#method__getPath">_getPath</a> |
|
1975 |
|
1976 |
|
1977 |
|
1978 </li> |
|
1979 |
|
1980 <li class="index-item method protected inherited"> |
|
1981 <a href="#method__getPathRoot">_getPathRoot</a> |
|
1982 |
|
1983 |
|
1984 |
|
1985 </li> |
|
1986 |
|
1987 <li class="index-item method protected inherited"> |
|
1988 <a href="#method__getQuery">_getQuery</a> |
|
1989 |
|
1990 |
|
1991 |
|
1992 </li> |
|
1993 |
|
1994 <li class="index-item method protected inherited"> |
|
1995 <a href="#method__getRegex">_getRegex</a> |
|
1996 |
|
1997 |
|
1998 |
|
1999 </li> |
|
2000 |
|
2001 <li class="index-item method protected inherited"> |
|
2002 <a href="#method__getRequest">_getRequest</a> |
|
2003 |
|
2004 |
|
2005 |
|
2006 </li> |
|
2007 |
|
2008 <li class="index-item method protected inherited"> |
|
2009 <a href="#method__getResponse">_getResponse</a> |
|
2010 |
|
2011 |
|
2012 |
|
2013 </li> |
|
2014 |
|
2015 <li class="index-item method protected inherited"> |
|
2016 <a href="#method__getRoutes">_getRoutes</a> |
|
2017 |
|
2018 |
|
2019 |
|
2020 </li> |
|
2021 |
|
2022 <li class="index-item method private inherited"> |
|
2023 <a href="#method__getStateVal">_getStateVal</a> |
|
2024 |
|
2025 |
|
2026 |
|
2027 </li> |
|
2028 |
|
2029 <li class="index-item method private inherited"> |
|
2030 <a href="#method__getType">_getType</a> |
|
2031 |
|
2032 |
|
2033 |
|
2034 </li> |
|
2035 |
|
2036 <li class="index-item method protected inherited"> |
|
2037 <a href="#method__getURL">_getURL</a> |
|
2038 |
|
2039 |
|
2040 |
|
2041 </li> |
|
2042 |
|
2043 <li class="index-item method protected"> |
|
2044 <a href="#method__getViewContainer">_getViewContainer</a> |
|
2045 |
|
2046 |
|
2047 |
|
2048 </li> |
|
2049 |
|
2050 <li class="index-item method protected inherited"> |
|
2051 <a href="#method__hasSameOrigin">_hasSameOrigin</a> |
|
2052 |
|
2053 |
|
2054 |
|
2055 </li> |
|
2056 |
|
2057 <li class="index-item method private inherited"> |
|
2058 <a href="#method__initAttrHost">_initAttrHost</a> |
|
2059 |
|
2060 |
|
2061 |
|
2062 </li> |
|
2063 |
|
2064 <li class="index-item method private inherited inherited"> |
|
2065 <a href="#method__initAttribute">_initAttribute</a> |
|
2066 |
|
2067 |
|
2068 |
|
2069 </li> |
|
2070 |
|
2071 <li class="index-item method protected inherited"> |
|
2072 <a href="#method__initAttrs">_initAttrs</a> |
|
2073 |
|
2074 |
|
2075 |
|
2076 </li> |
|
2077 |
|
2078 <li class="index-item method private inherited"> |
|
2079 <a href="#method__initBase">_initBase</a> |
|
2080 |
|
2081 |
|
2082 |
|
2083 </li> |
|
2084 |
|
2085 <li class="index-item method private inherited"> |
|
2086 <a href="#method__initHierarchy">_initHierarchy</a> |
|
2087 |
|
2088 |
|
2089 |
|
2090 </li> |
|
2091 |
|
2092 <li class="index-item method private inherited"> |
|
2093 <a href="#method__initHierarchyData">_initHierarchyData</a> |
|
2094 |
|
2095 |
|
2096 |
|
2097 </li> |
|
2098 |
|
2099 <li class="index-item method protected"> |
|
2100 <a href="#method__initHtml5">_initHtml5</a> |
|
2101 |
|
2102 |
|
2103 |
|
2104 </li> |
|
2105 |
|
2106 <li class="index-item method protected"> |
|
2107 <a href="#method__isChildView">_isChildView</a> |
|
2108 |
|
2109 |
|
2110 |
|
2111 </li> |
|
2112 |
|
2113 <li class="index-item method private inherited"> |
|
2114 <a href="#method__isLazyAttr">_isLazyAttr</a> |
|
2115 |
|
2116 |
|
2117 |
|
2118 </li> |
|
2119 |
|
2120 <li class="index-item method protected inherited"> |
|
2121 <a href="#method__isLinkSameOrigin">_isLinkSameOrigin</a> |
|
2122 |
|
2123 |
|
2124 |
|
2125 </li> |
|
2126 |
|
2127 <li class="index-item method protected"> |
|
2128 <a href="#method__isParentView">_isParentView</a> |
|
2129 |
|
2130 |
|
2131 |
|
2132 </li> |
|
2133 |
|
2134 <li class="index-item method protected inherited"> |
|
2135 <a href="#method__joinURL">_joinURL</a> |
|
2136 |
|
2137 |
|
2138 |
|
2139 </li> |
|
2140 |
|
2141 <li class="index-item method private inherited"> |
|
2142 <a href="#method__monitor">_monitor</a> |
|
2143 |
|
2144 |
|
2145 |
|
2146 </li> |
|
2147 |
|
2148 <li class="index-item method protected inherited"> |
|
2149 <a href="#method__navigate">_navigate</a> |
|
2150 |
|
2151 |
|
2152 |
|
2153 </li> |
|
2154 |
|
2155 <li class="index-item method protected inherited"> |
|
2156 <a href="#method__normalizePath">_normalizePath</a> |
|
2157 |
|
2158 |
|
2159 |
|
2160 </li> |
|
2161 |
|
2162 <li class="index-item method private inherited"> |
|
2163 <a href="#method__normAttrVals">_normAttrVals</a> |
|
2164 |
|
2165 |
|
2166 |
|
2167 </li> |
|
2168 |
|
2169 <li class="index-item method protected inherited"> |
|
2170 <a href="#method__onLinkClick">_onLinkClick</a> |
|
2171 |
|
2172 |
|
2173 |
|
2174 </li> |
|
2175 |
|
2176 <li class="index-item method protected inherited"> |
|
2177 <a href="#method__parseQuery">_parseQuery</a> |
|
2178 |
|
2179 |
|
2180 |
|
2181 </li> |
|
2182 |
|
2183 <li class="index-item method private inherited"> |
|
2184 <a href="#method__parseType">_parseType</a> |
|
2185 |
|
2186 |
|
2187 |
|
2188 </li> |
|
2189 |
|
2190 <li class="index-item method protected inherited"> |
|
2191 <a href="#method__pjaxBindUI">_pjaxBindUI</a> |
|
2192 |
|
2193 |
|
2194 |
|
2195 </li> |
|
2196 |
|
2197 <li class="index-item method private inherited"> |
|
2198 <a href="#method__preInitEventCfg">_preInitEventCfg</a> |
|
2199 |
|
2200 |
|
2201 |
|
2202 </li> |
|
2203 |
|
2204 <li class="index-item method protected deprecated inherited"> |
|
2205 <a href="#method__protectAttrs">_protectAttrs</a> |
|
2206 |
|
2207 |
|
2208 |
|
2209 <span class="flag deprecated">deprecated</span> |
|
2210 |
|
2211 </li> |
|
2212 |
|
2213 <li class="index-item method private inherited"> |
|
2214 <a href="#method__publish">_publish</a> |
|
2215 |
|
2216 |
|
2217 |
|
2218 </li> |
|
2219 |
|
2220 <li class="index-item method protected inherited"> |
|
2221 <a href="#method__queue">_queue</a> |
|
2222 |
|
2223 |
|
2224 |
|
2225 </li> |
|
2226 |
|
2227 <li class="index-item method protected inherited"> |
|
2228 <a href="#method__resolvePath">_resolvePath</a> |
|
2229 |
|
2230 |
|
2231 |
|
2232 </li> |
|
2233 |
|
2234 <li class="index-item method protected inherited"> |
|
2235 <a href="#method__resolveURL">_resolveURL</a> |
|
2236 |
|
2237 |
|
2238 |
|
2239 </li> |
|
2240 |
|
2241 <li class="index-item method protected inherited"> |
|
2242 <a href="#method__save">_save</a> |
|
2243 |
|
2244 |
|
2245 |
|
2246 </li> |
|
2247 |
|
2248 <li class="index-item method protected inherited inherited"> |
|
2249 <a href="#method__set">_set</a> |
|
2250 |
|
2251 |
|
2252 |
|
2253 </li> |
|
2254 |
|
2255 <li class="index-item method protected inherited"> |
|
2256 <a href="#method__setAttr">_setAttr</a> |
|
2257 |
|
2258 |
|
2259 |
|
2260 </li> |
|
2261 |
|
2262 <li class="index-item method protected inherited inherited"> |
|
2263 <a href="#method__setAttrs">_setAttrs</a> |
|
2264 |
|
2265 |
|
2266 |
|
2267 </li> |
|
2268 |
|
2269 <li class="index-item method private inherited"> |
|
2270 <a href="#method__setAttrVal">_setAttrVal</a> |
|
2271 |
|
2272 |
|
2273 |
|
2274 </li> |
|
2275 |
|
2276 <li class="index-item method protected inherited"> |
|
2277 <a href="#method__setRoutes">_setRoutes</a> |
|
2278 |
|
2279 |
|
2280 |
|
2281 </li> |
|
2282 |
|
2283 <li class="index-item method private inherited"> |
|
2284 <a href="#method__setStateVal">_setStateVal</a> |
|
2285 |
|
2286 |
|
2287 |
|
2288 </li> |
|
2289 |
|
2290 <li class="index-item method protected"> |
|
2291 <a href="#method__uiSetActiveView">_uiSetActiveView</a> |
|
2292 |
|
2293 |
|
2294 |
|
2295 </li> |
|
2296 |
|
2297 <li class="index-item method protected inherited"> |
|
2298 <a href="#method__upgradeURL">_upgradeURL</a> |
|
2299 |
|
2300 |
|
2301 |
|
2302 </li> |
|
2303 |
|
2304 <li class="index-item method inherited"> |
|
2305 <a href="#method_addAttr">addAttr</a> |
|
2306 |
|
2307 |
|
2308 |
|
2309 </li> |
|
2310 |
|
2311 <li class="index-item method inherited"> |
|
2312 <a href="#method_addAttrs">addAttrs</a> |
|
2313 |
|
2314 |
|
2315 |
|
2316 </li> |
|
2317 |
|
2318 <li class="index-item method inherited"> |
|
2319 <a href="#method_addTarget">addTarget</a> |
|
2320 |
|
2321 |
|
2322 |
|
2323 </li> |
|
2324 |
|
2325 <li class="index-item method inherited"> |
|
2326 <a href="#method_after">after</a> |
|
2327 |
|
2328 |
|
2329 |
|
2330 </li> |
|
2331 |
|
2332 <li class="index-item method inherited"> |
|
2333 <a href="#method_attachEvents">attachEvents</a> |
|
2334 |
|
2335 |
|
2336 |
|
2337 </li> |
|
2338 |
|
2339 <li class="index-item method inherited"> |
|
2340 <a href="#method_attrAdded">attrAdded</a> |
|
2341 |
|
2342 |
|
2343 |
|
2344 </li> |
|
2345 |
|
2346 <li class="index-item method inherited"> |
|
2347 <a href="#method_before">before</a> |
|
2348 |
|
2349 |
|
2350 |
|
2351 </li> |
|
2352 |
|
2353 <li class="index-item method inherited"> |
|
2354 <a href="#method_bubble">bubble</a> |
|
2355 |
|
2356 |
|
2357 |
|
2358 </li> |
|
2359 |
|
2360 <li class="index-item method inherited"> |
|
2361 <a href="#method_create">create</a> |
|
2362 |
|
2363 |
|
2364 |
|
2365 </li> |
|
2366 |
|
2367 <li class="index-item method"> |
|
2368 <a href="#method_createView">createView</a> |
|
2369 |
|
2370 |
|
2371 |
|
2372 </li> |
|
2373 |
|
2374 <li class="index-item method inherited inherited"> |
|
2375 <a href="#method_destroy">destroy</a> |
|
2376 |
|
2377 |
|
2378 |
|
2379 </li> |
|
2380 |
|
2381 <li class="index-item method inherited"> |
|
2382 <a href="#method_detach">detach</a> |
|
2383 |
|
2384 |
|
2385 |
|
2386 </li> |
|
2387 |
|
2388 <li class="index-item method inherited"> |
|
2389 <a href="#method_detachAll">detachAll</a> |
|
2390 |
|
2391 |
|
2392 |
|
2393 </li> |
|
2394 |
|
2395 <li class="index-item method inherited"> |
|
2396 <a href="#method_detachEvents">detachEvents</a> |
|
2397 |
|
2398 |
|
2399 |
|
2400 </li> |
|
2401 |
|
2402 <li class="index-item method inherited"> |
|
2403 <a href="#method_dispatch">dispatch</a> |
|
2404 |
|
2405 |
|
2406 |
|
2407 </li> |
|
2408 |
|
2409 <li class="index-item method inherited"> |
|
2410 <a href="#method_fire">fire</a> |
|
2411 |
|
2412 |
|
2413 |
|
2414 </li> |
|
2415 |
|
2416 <li class="index-item method inherited"> |
|
2417 <a href="#method_get">get</a> |
|
2418 |
|
2419 |
|
2420 |
|
2421 </li> |
|
2422 |
|
2423 <li class="index-item method inherited"> |
|
2424 <a href="#method_getAttrs">getAttrs</a> |
|
2425 |
|
2426 |
|
2427 |
|
2428 </li> |
|
2429 |
|
2430 <li class="index-item method inherited"> |
|
2431 <a href="#method_getEvent">getEvent</a> |
|
2432 |
|
2433 |
|
2434 |
|
2435 </li> |
|
2436 |
|
2437 <li class="index-item method inherited"> |
|
2438 <a href="#method_getPath">getPath</a> |
|
2439 |
|
2440 |
|
2441 |
|
2442 </li> |
|
2443 |
|
2444 <li class="index-item method inherited"> |
|
2445 <a href="#method_getTargets">getTargets</a> |
|
2446 |
|
2447 |
|
2448 |
|
2449 </li> |
|
2450 |
|
2451 <li class="index-item method"> |
|
2452 <a href="#method_getViewInfo">getViewInfo</a> |
|
2453 |
|
2454 |
|
2455 |
|
2456 </li> |
|
2457 |
|
2458 <li class="index-item method inherited"> |
|
2459 <a href="#method_hasRoute">hasRoute</a> |
|
2460 |
|
2461 |
|
2462 |
|
2463 </li> |
|
2464 |
|
2465 <li class="index-item method inherited inherited"> |
|
2466 <a href="#method_init">init</a> |
|
2467 |
|
2468 |
|
2469 |
|
2470 </li> |
|
2471 |
|
2472 <li class="index-item method inherited"> |
|
2473 <a href="#method_match">match</a> |
|
2474 |
|
2475 |
|
2476 |
|
2477 </li> |
|
2478 |
|
2479 <li class="index-item method inherited"> |
|
2480 <a href="#method_modifyAttr">modifyAttr</a> |
|
2481 |
|
2482 |
|
2483 |
|
2484 </li> |
|
2485 |
|
2486 <li class="index-item method inherited"> |
|
2487 <a href="#method_navigate">navigate</a> |
|
2488 |
|
2489 |
|
2490 |
|
2491 </li> |
|
2492 |
|
2493 <li class="index-item method inherited"> |
|
2494 <a href="#method_on">on</a> |
|
2495 |
|
2496 |
|
2497 |
|
2498 </li> |
|
2499 |
|
2500 <li class="index-item method inherited"> |
|
2501 <a href="#method_once">once</a> |
|
2502 |
|
2503 |
|
2504 |
|
2505 </li> |
|
2506 |
|
2507 <li class="index-item method inherited"> |
|
2508 <a href="#method_onceAfter">onceAfter</a> |
|
2509 |
|
2510 |
|
2511 |
|
2512 </li> |
|
2513 |
|
2514 <li class="index-item method inherited"> |
|
2515 <a href="#method_parseType">parseType</a> |
|
2516 |
|
2517 |
|
2518 |
|
2519 </li> |
|
2520 |
|
2521 <li class="index-item method inherited"> |
|
2522 <a href="#method_publish">publish</a> |
|
2523 |
|
2524 |
|
2525 |
|
2526 </li> |
|
2527 |
|
2528 <li class="index-item method inherited"> |
|
2529 <a href="#method_remove">remove</a> |
|
2530 |
|
2531 |
|
2532 |
|
2533 </li> |
|
2534 |
|
2535 <li class="index-item method inherited"> |
|
2536 <a href="#method_removeAttr">removeAttr</a> |
|
2537 |
|
2538 |
|
2539 |
|
2540 </li> |
|
2541 |
|
2542 <li class="index-item method inherited"> |
|
2543 <a href="#method_removeQuery">removeQuery</a> |
|
2544 |
|
2545 |
|
2546 |
|
2547 </li> |
|
2548 |
|
2549 <li class="index-item method inherited"> |
|
2550 <a href="#method_removeRoot">removeRoot</a> |
|
2551 |
|
2552 |
|
2553 |
|
2554 </li> |
|
2555 |
|
2556 <li class="index-item method inherited"> |
|
2557 <a href="#method_removeTarget">removeTarget</a> |
|
2558 |
|
2559 |
|
2560 |
|
2561 </li> |
|
2562 |
|
2563 <li class="index-item method inherited"> |
|
2564 <a href="#method_render">render</a> |
|
2565 |
|
2566 |
|
2567 |
|
2568 </li> |
|
2569 |
|
2570 <li class="index-item method inherited"> |
|
2571 <a href="#method_replace">replace</a> |
|
2572 |
|
2573 |
|
2574 |
|
2575 </li> |
|
2576 |
|
2577 <li class="index-item method inherited"> |
|
2578 <a href="#method_reset">reset</a> |
|
2579 |
|
2580 |
|
2581 |
|
2582 </li> |
|
2583 |
|
2584 <li class="index-item method inherited"> |
|
2585 <a href="#method_route">route</a> |
|
2586 |
|
2587 |
|
2588 |
|
2589 </li> |
|
2590 |
|
2591 <li class="index-item method inherited"> |
|
2592 <a href="#method_save">save</a> |
|
2593 |
|
2594 |
|
2595 |
|
2596 </li> |
|
2597 |
|
2598 <li class="index-item method inherited inherited"> |
|
2599 <a href="#method_set">set</a> |
|
2600 |
|
2601 |
|
2602 |
|
2603 </li> |
|
2604 |
|
2605 <li class="index-item method inherited inherited"> |
|
2606 <a href="#method_setAttrs">setAttrs</a> |
|
2607 |
|
2608 |
|
2609 |
|
2610 </li> |
|
2611 |
|
2612 <li class="index-item method"> |
|
2613 <a href="#method_showView">showView</a> |
|
2614 |
|
2615 |
|
2616 |
|
2617 </li> |
|
2618 |
|
2619 <li class="index-item method deprecated inherited"> |
|
2620 <a href="#method_subscribe">subscribe</a> |
|
2621 |
|
2622 |
|
2623 |
|
2624 <span class="flag deprecated">deprecated</span> |
|
2625 |
|
2626 </li> |
|
2627 |
|
2628 <li class="index-item method inherited"> |
|
2629 <a href="#method_toString">toString</a> |
|
2630 |
|
2631 |
|
2632 |
|
2633 </li> |
|
2634 |
|
2635 <li class="index-item method deprecated inherited"> |
|
2636 <a href="#method_unsubscribe">unsubscribe</a> |
|
2637 |
|
2638 |
|
2639 |
|
2640 <span class="flag deprecated">deprecated</span> |
|
2641 |
|
2642 </li> |
|
2643 |
|
2644 <li class="index-item method deprecated inherited"> |
|
2645 <a href="#method_unsubscribeAll">unsubscribeAll</a> |
|
2646 |
|
2647 |
|
2648 |
|
2649 <span class="flag deprecated">deprecated</span> |
|
2650 |
|
2651 </li> |
|
2652 |
|
2653 <li class="index-item method inherited"> |
|
2654 <a href="#method_upgrade">upgrade</a> |
|
2655 |
|
2656 |
|
2657 |
|
2658 </li> |
|
2659 |
|
2660 </ul> |
|
2661 </div> |
|
2662 |
|
2663 |
|
2664 |
|
2665 <div class="index-section properties"> |
|
2666 <h3>Properties</h3> |
|
2667 |
|
2668 <ul class="index-list properties extends"> |
|
2669 |
|
2670 <li class="index-item property protected inherited inherited"> |
|
2671 <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a> |
|
2672 |
|
2673 |
|
2674 |
|
2675 </li> |
|
2676 |
|
2677 <li class="index-item property protected inherited"> |
|
2678 <a href="#property__dispatched">_dispatched</a> |
|
2679 |
|
2680 |
|
2681 |
|
2682 </li> |
|
2683 |
|
2684 <li class="index-item property protected inherited"> |
|
2685 <a href="#property__dispatching">_dispatching</a> |
|
2686 |
|
2687 |
|
2688 |
|
2689 </li> |
|
2690 |
|
2691 <li class="index-item property protected inherited"> |
|
2692 <a href="#property__historyEvents">_historyEvents</a> |
|
2693 |
|
2694 |
|
2695 |
|
2696 </li> |
|
2697 |
|
2698 <li class="index-item property protected inherited"> |
|
2699 <a href="#property__html5">_html5</a> |
|
2700 |
|
2701 |
|
2702 |
|
2703 </li> |
|
2704 |
|
2705 <li class="index-item property protected"> |
|
2706 <a href="#property__NON_ATTRS_CFG">_NON_ATTRS_CFG</a> |
|
2707 |
|
2708 |
|
2709 <span class="flag static">static</span> |
|
2710 |
|
2711 |
|
2712 </li> |
|
2713 |
|
2714 <li class="index-item property protected inherited"> |
|
2715 <a href="#property__pjaxEvents">_pjaxEvents</a> |
|
2716 |
|
2717 |
|
2718 |
|
2719 </li> |
|
2720 |
|
2721 <li class="index-item property protected inherited"> |
|
2722 <a href="#property__ready">_ready</a> |
|
2723 |
|
2724 |
|
2725 |
|
2726 </li> |
|
2727 |
|
2728 <li class="index-item property protected inherited"> |
|
2729 <a href="#property__regexPathParam">_regexPathParam</a> |
|
2730 |
|
2731 |
|
2732 |
|
2733 </li> |
|
2734 |
|
2735 <li class="index-item property protected inherited"> |
|
2736 <a href="#property__regexURL">_regexURL</a> |
|
2737 |
|
2738 |
|
2739 |
|
2740 </li> |
|
2741 |
|
2742 <li class="index-item property protected inherited"> |
|
2743 <a href="#property__regexUrlOrigin">_regexUrlOrigin</a> |
|
2744 |
|
2745 |
|
2746 |
|
2747 </li> |
|
2748 |
|
2749 <li class="index-item property protected inherited"> |
|
2750 <a href="#property__regexUrlQuery">_regexUrlQuery</a> |
|
2751 |
|
2752 |
|
2753 |
|
2754 </li> |
|
2755 |
|
2756 <li class="index-item property protected"> |
|
2757 <a href="#property__viewInfoMap">_viewInfoMap</a> |
|
2758 |
|
2759 |
|
2760 |
|
2761 </li> |
|
2762 |
|
2763 <li class="index-item property inherited"> |
|
2764 <a href="#property_containerTemplate">containerTemplate</a> |
|
2765 |
|
2766 |
|
2767 |
|
2768 </li> |
|
2769 |
|
2770 <li class="index-item property inherited"> |
|
2771 <a href="#property_events">events</a> |
|
2772 |
|
2773 |
|
2774 |
|
2775 </li> |
|
2776 |
|
2777 <li class="index-item property deprecated inherited"> |
|
2778 <a href="#property_name">name</a> |
|
2779 |
|
2780 |
|
2781 |
|
2782 <span class="flag deprecated">deprecated</span> |
|
2783 |
|
2784 </li> |
|
2785 |
|
2786 <li class="index-item property inherited"> |
|
2787 <a href="#property_template">template</a> |
|
2788 |
|
2789 |
|
2790 |
|
2791 </li> |
|
2792 |
|
2793 <li class="index-item property"> |
|
2794 <a href="#property_views">views</a> |
|
2795 |
|
2796 |
|
2797 |
|
2798 </li> |
|
2799 |
|
2800 </ul> |
|
2801 </div> |
|
2802 |
|
2803 |
|
2804 |
|
2805 <div class="index-section attrs"> |
|
2806 <h3>Attributes</h3> |
|
2807 |
|
2808 <ul class="index-list attrs extends"> |
|
2809 |
|
2810 <li class="index-item attr"> |
|
2811 <a href="#attr_activeView">activeView</a> |
|
2812 </li> |
|
2813 |
|
2814 <li class="index-item attr inherited"> |
|
2815 <a href="#attr_container">container</a> |
|
2816 </li> |
|
2817 |
|
2818 <li class="index-item attr inherited"> |
|
2819 <a href="#attr_destroyed">destroyed</a> |
|
2820 </li> |
|
2821 |
|
2822 <li class="index-item attr inherited"> |
|
2823 <a href="#attr_html5">html5</a> |
|
2824 </li> |
|
2825 |
|
2826 <li class="index-item attr inherited"> |
|
2827 <a href="#attr_initialized">initialized</a> |
|
2828 </li> |
|
2829 |
|
2830 <li class="index-item attr inherited"> |
|
2831 <a href="#attr_linkSelector">linkSelector</a> |
|
2832 </li> |
|
2833 |
|
2834 <li class="index-item attr inherited"> |
|
2835 <a href="#attr_navigateOnHash">navigateOnHash</a> |
|
2836 </li> |
|
2837 |
|
2838 <li class="index-item attr inherited"> |
|
2839 <a href="#attr_root">root</a> |
|
2840 </li> |
|
2841 |
|
2842 <li class="index-item attr inherited"> |
|
2843 <a href="#attr_routes">routes</a> |
|
2844 </li> |
|
2845 |
|
2846 <li class="index-item attr inherited"> |
|
2847 <a href="#attr_scrollToTop">scrollToTop</a> |
|
2848 </li> |
|
2849 |
|
2850 <li class="index-item attr"> |
|
2851 <a href="#attr_serverRouting">serverRouting</a> |
|
2852 </li> |
|
2853 |
|
2854 <li class="index-item attr"> |
|
2855 <a href="#attr_viewContainer">viewContainer</a> |
|
2856 </li> |
|
2857 |
|
2858 </ul> |
|
2859 </div> |
|
2860 |
|
2861 |
|
2862 |
|
2863 <div class="index-section events"> |
|
2864 <h3>Events</h3> |
|
2865 |
|
2866 <ul class="index-list events extends"> |
|
2867 |
|
2868 <li class="index-item event inherited"> |
|
2869 <a href="#event_destroy">destroy</a> |
|
2870 |
|
2871 |
|
2872 |
|
2873 </li> |
|
2874 |
|
2875 <li class="index-item event inherited"> |
|
2876 <a href="#event_init">init</a> |
|
2877 |
|
2878 |
|
2879 |
|
2880 </li> |
|
2881 |
|
2882 <li class="index-item event inherited"> |
|
2883 <a href="#event_navigate">navigate</a> |
|
2884 |
|
2885 |
|
2886 |
|
2887 </li> |
|
2888 |
|
2889 <li class="index-item event inherited"> |
|
2890 <a href="#event_ready">ready</a> |
|
2891 |
|
2892 |
|
2893 |
|
2894 </li> |
|
2895 |
|
2896 </ul> |
|
2897 </div> |
|
2898 |
|
2899 </div> |
|
2900 |
|
2901 |
|
2902 <div id="methods" class="api-class-tabpanel"> |
|
2903 <h2 class="off-left">Methods</h2> |
|
2904 |
|
2905 |
|
2906 <div id="method__addAttrs" class="method item private inherited"> |
|
2907 <h3 class="name"><code>_addAttrs</code></h3> |
|
2908 |
|
2909 |
|
2910 <div class="args"> |
|
2911 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2912 |
|
2913 <li class="arg"> |
|
2914 |
|
2915 <code>cfgs</code> |
|
2916 |
|
2917 </li> |
|
2918 |
|
2919 <li class="arg"> |
|
2920 |
|
2921 <code>values</code> |
|
2922 |
|
2923 </li> |
|
2924 |
|
2925 <li class="arg"> |
|
2926 |
|
2927 <code>lazy</code> |
|
2928 |
|
2929 </li> |
|
2930 |
|
2931 </ul><span class="paren">)</span> |
|
2932 </div> |
|
2933 |
|
2934 |
|
2935 |
|
2936 |
|
2937 |
|
2938 |
|
2939 |
|
2940 <span class="flag private">private</span> |
|
2941 |
|
2942 |
|
2943 |
|
2944 |
|
2945 |
|
2946 |
|
2947 |
|
2948 |
|
2949 |
|
2950 |
|
2951 <div class="meta"> |
|
2952 |
|
2953 |
|
2954 <p>Inherited from |
|
2955 <a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>: |
|
2956 |
|
2957 |
|
2958 |
|
2959 <a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a> |
|
2960 |
|
2961 </p> |
|
2962 |
|
2963 |
|
2964 |
|
2965 |
|
2966 |
|
2967 </div> |
|
2968 |
|
2969 <div class="description"> |
|
2970 <p>Implementation behind the public addAttrs method.</p> |
|
2971 |
|
2972 <p>This method is invoked directly by get if it encounters a scenario |
|
2973 in which an attribute's valueFn attempts to obtain the |
|
2974 value an attribute in the same group of attributes, which has not yet |
|
2975 been added (on demand initialization).</p> |
|
2976 </div> |
|
2977 |
|
2978 |
|
2979 <div class="params"> |
|
2980 <h4>Parameters:</h4> |
|
2981 |
|
2982 <ul class="params-list"> |
|
2983 |
|
2984 <li class="param"> |
|
2985 |
|
2986 <code class="param-name">cfgs</code> |
|
2987 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2988 |
|
2989 |
|
2990 |
|
2991 |
|
2992 <div class="param-description"> |
|
2993 <p>An object with attribute name/configuration pairs.</p> |
|
2994 </div> |
|
2995 |
|
2996 |
|
2997 </li> |
|
2998 |
|
2999 <li class="param"> |
|
3000 |
|
3001 <code class="param-name">values</code> |
|
3002 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3003 |
|
3004 |
|
3005 |
|
3006 |
|
3007 <div class="param-description"> |
|
3008 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
3009 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
3010 </div> |
|
3011 |
|
3012 |
|
3013 </li> |
|
3014 |
|
3015 <li class="param"> |
|
3016 |
|
3017 <code class="param-name">lazy</code> |
|
3018 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
3019 |
|
3020 |
|
3021 |
|
3022 |
|
3023 <div class="param-description"> |
|
3024 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
3025 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
3026 See <a href="#method_addAttr">addAttr</a>.</p> |
|
3027 </div> |
|
3028 |
|
3029 |
|
3030 </li> |
|
3031 |
|
3032 </ul> |
|
3033 </div> |
|
3034 |
|
3035 |
|
3036 |
|
3037 |
|
3038 |
|
3039 </div> |
|
3040 |
|
3041 |
|
3042 <div id="method__addLazyAttr" class="method item private inherited"> |
|
3043 <h3 class="name"><code>_addLazyAttr</code></h3> |
|
3044 |
|
3045 |
|
3046 <div class="args"> |
|
3047 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3048 |
|
3049 <li class="arg"> |
|
3050 |
|
3051 <code>name</code> |
|
3052 |
|
3053 </li> |
|
3054 |
|
3055 <li class="arg"> |
|
3056 |
|
3057 <code class="optional">[lazyCfg]</code> |
|
3058 |
|
3059 </li> |
|
3060 |
|
3061 </ul><span class="paren">)</span> |
|
3062 </div> |
|
3063 |
|
3064 |
|
3065 |
|
3066 |
|
3067 |
|
3068 |
|
3069 |
|
3070 <span class="flag private">private</span> |
|
3071 |
|
3072 |
|
3073 |
|
3074 |
|
3075 |
|
3076 |
|
3077 |
|
3078 |
|
3079 |
|
3080 |
|
3081 <div class="meta"> |
|
3082 |
|
3083 |
|
3084 <p>Inherited from |
|
3085 <a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>: |
|
3086 |
|
3087 |
|
3088 |
|
3089 <a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a> |
|
3090 |
|
3091 </p> |
|
3092 |
|
3093 |
|
3094 |
|
3095 |
|
3096 |
|
3097 </div> |
|
3098 |
|
3099 <div class="description"> |
|
3100 <p>Finishes initializing an attribute which has been lazily added.</p> |
|
3101 </div> |
|
3102 |
|
3103 |
|
3104 <div class="params"> |
|
3105 <h4>Parameters:</h4> |
|
3106 |
|
3107 <ul class="params-list"> |
|
3108 |
|
3109 <li class="param"> |
|
3110 |
|
3111 <code class="param-name">name</code> |
|
3112 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3113 |
|
3114 |
|
3115 |
|
3116 |
|
3117 <div class="param-description"> |
|
3118 <p>The name of the attribute</p> |
|
3119 </div> |
|
3120 |
|
3121 |
|
3122 </li> |
|
3123 |
|
3124 <li class="param"> |
|
3125 |
|
3126 <code class="param-name optional">[lazyCfg]</code> |
|
3127 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3128 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3129 |
|
3130 |
|
3131 |
|
3132 |
|
3133 <div class="param-description"> |
|
3134 <p>Optional config hash for the attribute. This is added for performance |
|
3135 along the critical path, where the calling method has already obtained lazy config from state.</p> |
|
3136 </div> |
|
3137 |
|
3138 |
|
3139 </li> |
|
3140 |
|
3141 </ul> |
|
3142 </div> |
|
3143 |
|
3144 |
|
3145 |
|
3146 |
|
3147 |
|
3148 </div> |
|
3149 |
|
3150 |
|
3151 <div id="method__afterActiveViewChange" class="method item protected"> |
|
3152 <h3 class="name"><code>_afterActiveViewChange</code></h3> |
|
3153 |
|
3154 |
|
3155 <div class="args"> |
|
3156 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3157 |
|
3158 <li class="arg"> |
|
3159 |
|
3160 <code>e</code> |
|
3161 |
|
3162 </li> |
|
3163 |
|
3164 </ul><span class="paren">)</span> |
|
3165 </div> |
|
3166 |
|
3167 |
|
3168 |
|
3169 |
|
3170 |
|
3171 |
|
3172 |
|
3173 <span class="flag protected">protected</span> |
|
3174 |
|
3175 |
|
3176 |
|
3177 |
|
3178 |
|
3179 |
|
3180 |
|
3181 |
|
3182 |
|
3183 |
|
3184 <div class="meta"> |
|
3185 |
|
3186 |
|
3187 |
|
3188 <p> |
|
3189 |
|
3190 Defined in |
|
3191 |
|
3192 |
|
3193 |
|
3194 |
|
3195 <a href="../files/app_js_app-base.js.html#l801"><code>app/js/app-base.js:801</code></a> |
|
3196 |
|
3197 </p> |
|
3198 |
|
3199 |
|
3200 |
|
3201 |
|
3202 |
|
3203 <p>Available since 3.5.0</p> |
|
3204 |
|
3205 </div> |
|
3206 |
|
3207 <div class="description"> |
|
3208 <p>Handles the application's <code>activeViewChange</code> event (which is fired when the |
|
3209 <code>activeView</code> attribute changes) by detaching the old view, attaching the new |
|
3210 view.</p> |
|
3211 |
|
3212 <p>The <code>activeView</code> attribute is read-only, so the public API to change its |
|
3213 value is through the <code>showView()</code> method.</p> |
|
3214 </div> |
|
3215 |
|
3216 |
|
3217 <div class="params"> |
|
3218 <h4>Parameters:</h4> |
|
3219 |
|
3220 <ul class="params-list"> |
|
3221 |
|
3222 <li class="param"> |
|
3223 |
|
3224 <code class="param-name">e</code> |
|
3225 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3226 |
|
3227 |
|
3228 |
|
3229 |
|
3230 <div class="param-description"> |
|
3231 |
|
3232 </div> |
|
3233 |
|
3234 |
|
3235 </li> |
|
3236 |
|
3237 </ul> |
|
3238 </div> |
|
3239 |
|
3240 |
|
3241 |
|
3242 |
|
3243 |
|
3244 </div> |
|
3245 |
|
3246 |
|
3247 <div id="method__afterContainerChange" class="method item protected inherited"> |
|
3248 <h3 class="name"><code>_afterContainerChange</code></h3> |
|
3249 |
|
3250 |
|
3251 <span class="paren">()</span> |
|
3252 |
|
3253 |
|
3254 |
|
3255 |
|
3256 |
|
3257 |
|
3258 |
|
3259 <span class="flag protected">protected</span> |
|
3260 |
|
3261 |
|
3262 |
|
3263 |
|
3264 |
|
3265 |
|
3266 |
|
3267 |
|
3268 |
|
3269 |
|
3270 <div class="meta"> |
|
3271 |
|
3272 |
|
3273 <p>Inherited from |
|
3274 <a href="../classes/View.html#method__afterContainerChange">View</a>: |
|
3275 |
|
3276 |
|
3277 |
|
3278 <a href="../files/app_js_view.js.html#l357"><code>app/js/view.js:357</code></a> |
|
3279 |
|
3280 </p> |
|
3281 |
|
3282 |
|
3283 |
|
3284 |
|
3285 |
|
3286 <p>Available since 3.5.0</p> |
|
3287 |
|
3288 </div> |
|
3289 |
|
3290 <div class="description"> |
|
3291 <p>Handles <code>containerChange</code> events. Detaches event handlers from the old |
|
3292 container (if any) and attaches them to the new container.</p> |
|
3293 |
|
3294 <p>Right now the <code>container</code> attr is initOnly so this event should only ever |
|
3295 fire the first time the container is created, but in the future (once Y.App |
|
3296 can handle it) we may allow runtime container changes.</p> |
|
3297 </div> |
|
3298 |
|
3299 |
|
3300 |
|
3301 |
|
3302 |
|
3303 |
|
3304 </div> |
|
3305 |
|
3306 |
|
3307 <div id="method__afterHistoryChange" class="method item protected inherited"> |
|
3308 <h3 class="name"><code>_afterHistoryChange</code></h3> |
|
3309 |
|
3310 |
|
3311 <div class="args"> |
|
3312 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3313 |
|
3314 <li class="arg"> |
|
3315 |
|
3316 <code>e</code> |
|
3317 |
|
3318 </li> |
|
3319 |
|
3320 </ul><span class="paren">)</span> |
|
3321 </div> |
|
3322 |
|
3323 |
|
3324 |
|
3325 |
|
3326 |
|
3327 |
|
3328 |
|
3329 <span class="flag protected">protected</span> |
|
3330 |
|
3331 |
|
3332 |
|
3333 |
|
3334 |
|
3335 |
|
3336 |
|
3337 |
|
3338 |
|
3339 |
|
3340 <div class="meta"> |
|
3341 |
|
3342 |
|
3343 <p>Inherited from |
|
3344 <a href="../classes/Router.html#method__afterHistoryChange">Router</a>: |
|
3345 |
|
3346 |
|
3347 |
|
3348 <a href="../files/app_js_router.js.html#l1269"><code>app/js/router.js:1269</code></a> |
|
3349 |
|
3350 </p> |
|
3351 |
|
3352 |
|
3353 |
|
3354 |
|
3355 |
|
3356 </div> |
|
3357 |
|
3358 <div class="description"> |
|
3359 <p>Handles <code>history:change</code> and <code>hashchange</code> events.</p> |
|
3360 </div> |
|
3361 |
|
3362 |
|
3363 <div class="params"> |
|
3364 <h4>Parameters:</h4> |
|
3365 |
|
3366 <ul class="params-list"> |
|
3367 |
|
3368 <li class="param"> |
|
3369 |
|
3370 <code class="param-name">e</code> |
|
3371 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3372 |
|
3373 |
|
3374 |
|
3375 |
|
3376 <div class="param-description"> |
|
3377 |
|
3378 </div> |
|
3379 |
|
3380 |
|
3381 </li> |
|
3382 |
|
3383 </ul> |
|
3384 </div> |
|
3385 |
|
3386 |
|
3387 |
|
3388 |
|
3389 |
|
3390 </div> |
|
3391 |
|
3392 |
|
3393 <div id="method__aggregateAttrs" class="method item private inherited"> |
|
3394 <h3 class="name"><code>_aggregateAttrs</code></h3> |
|
3395 |
|
3396 |
|
3397 <div class="args"> |
|
3398 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3399 |
|
3400 <li class="arg"> |
|
3401 |
|
3402 <code>allAttrs</code> |
|
3403 |
|
3404 </li> |
|
3405 |
|
3406 </ul><span class="paren">)</span> |
|
3407 </div> |
|
3408 |
|
3409 |
|
3410 |
|
3411 <span class="returns-inline"> |
|
3412 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3413 </span> |
|
3414 |
|
3415 |
|
3416 |
|
3417 |
|
3418 |
|
3419 <span class="flag private">private</span> |
|
3420 |
|
3421 |
|
3422 |
|
3423 |
|
3424 |
|
3425 |
|
3426 |
|
3427 |
|
3428 |
|
3429 |
|
3430 <div class="meta"> |
|
3431 |
|
3432 |
|
3433 <p>Inherited from |
|
3434 <a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>: |
|
3435 |
|
3436 |
|
3437 |
|
3438 <a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a> |
|
3439 |
|
3440 </p> |
|
3441 |
|
3442 |
|
3443 |
|
3444 |
|
3445 |
|
3446 </div> |
|
3447 |
|
3448 <div class="description"> |
|
3449 <p>A helper method, used by _initHierarchyData to aggregate |
|
3450 attribute configuration across the instances class hierarchy.</p> |
|
3451 |
|
3452 <p>The method will protect the attribute configuration value to protect the statically defined |
|
3453 default value in ATTRS if required (if the value is an object literal, array or the |
|
3454 attribute configuration has cloneDefaultValue set to shallow or deep).</p> |
|
3455 </div> |
|
3456 |
|
3457 |
|
3458 <div class="params"> |
|
3459 <h4>Parameters:</h4> |
|
3460 |
|
3461 <ul class="params-list"> |
|
3462 |
|
3463 <li class="param"> |
|
3464 |
|
3465 <code class="param-name">allAttrs</code> |
|
3466 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
3467 |
|
3468 |
|
3469 |
|
3470 |
|
3471 <div class="param-description"> |
|
3472 <p>An array of ATTRS definitions across classes in the hierarchy |
|
3473 (subclass first, Base last)</p> |
|
3474 </div> |
|
3475 |
|
3476 |
|
3477 </li> |
|
3478 |
|
3479 </ul> |
|
3480 </div> |
|
3481 |
|
3482 |
|
3483 |
|
3484 <div class="returns"> |
|
3485 <h4>Returns:</h4> |
|
3486 |
|
3487 <div class="returns-description"> |
|
3488 |
|
3489 |
|
3490 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
3491 |
|
3492 The aggregate set of ATTRS definitions for the instance |
|
3493 |
|
3494 </div> |
|
3495 </div> |
|
3496 |
|
3497 |
|
3498 |
|
3499 </div> |
|
3500 |
|
3501 |
|
3502 <div id="method__attachView" class="method item protected"> |
|
3503 <h3 class="name"><code>_attachView</code></h3> |
|
3504 |
|
3505 |
|
3506 <div class="args"> |
|
3507 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3508 |
|
3509 <li class="arg"> |
|
3510 |
|
3511 <code>view</code> |
|
3512 |
|
3513 </li> |
|
3514 |
|
3515 <li class="arg"> |
|
3516 |
|
3517 <code>prepend=false</code> |
|
3518 |
|
3519 </li> |
|
3520 |
|
3521 </ul><span class="paren">)</span> |
|
3522 </div> |
|
3523 |
|
3524 |
|
3525 |
|
3526 |
|
3527 |
|
3528 |
|
3529 |
|
3530 <span class="flag protected">protected</span> |
|
3531 |
|
3532 |
|
3533 |
|
3534 |
|
3535 |
|
3536 |
|
3537 |
|
3538 |
|
3539 |
|
3540 |
|
3541 <div class="meta"> |
|
3542 |
|
3543 |
|
3544 |
|
3545 <p> |
|
3546 |
|
3547 Defined in |
|
3548 |
|
3549 |
|
3550 |
|
3551 |
|
3552 <a href="../files/app_js_app-base.js.html#l434"><code>app/js/app-base.js:434</code></a> |
|
3553 |
|
3554 </p> |
|
3555 |
|
3556 |
|
3557 |
|
3558 |
|
3559 |
|
3560 <p>Available since 3.5.0</p> |
|
3561 |
|
3562 </div> |
|
3563 |
|
3564 <div class="description"> |
|
3565 <p>Helper method to attach the view instance to the application by making the |
|
3566 app a bubble target of the view, append the view to the <code>viewContainer</code>, and |
|
3567 assign it to the <code>instance</code> property of the associated view info metadata.</p> |
|
3568 </div> |
|
3569 |
|
3570 |
|
3571 <div class="params"> |
|
3572 <h4>Parameters:</h4> |
|
3573 |
|
3574 <ul class="params-list"> |
|
3575 |
|
3576 <li class="param"> |
|
3577 |
|
3578 <code class="param-name">view</code> |
|
3579 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
3580 |
|
3581 |
|
3582 |
|
3583 |
|
3584 <div class="param-description"> |
|
3585 <p>View to attach.</p> |
|
3586 </div> |
|
3587 |
|
3588 |
|
3589 </li> |
|
3590 |
|
3591 <li class="param"> |
|
3592 |
|
3593 <code class="param-name">prepend=false</code> |
|
3594 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
3595 |
|
3596 |
|
3597 |
|
3598 |
|
3599 <div class="param-description"> |
|
3600 <p>Whether the view should be prepended instead |
|
3601 of appended to the <code>viewContainer</code>.</p> |
|
3602 </div> |
|
3603 |
|
3604 |
|
3605 </li> |
|
3606 |
|
3607 </ul> |
|
3608 </div> |
|
3609 |
|
3610 |
|
3611 |
|
3612 |
|
3613 |
|
3614 </div> |
|
3615 |
|
3616 |
|
3617 <div id="method__attrCfgHash" class="method item private inherited"> |
|
3618 <h3 class="name"><code>_attrCfgHash</code></h3> |
|
3619 |
|
3620 |
|
3621 <span class="paren">()</span> |
|
3622 |
|
3623 |
|
3624 |
|
3625 |
|
3626 |
|
3627 |
|
3628 |
|
3629 <span class="flag private">private</span> |
|
3630 |
|
3631 |
|
3632 |
|
3633 |
|
3634 |
|
3635 |
|
3636 |
|
3637 |
|
3638 |
|
3639 |
|
3640 <div class="meta"> |
|
3641 |
|
3642 |
|
3643 <p>Inherited from |
|
3644 <a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>: |
|
3645 |
|
3646 |
|
3647 |
|
3648 <a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a> |
|
3649 |
|
3650 </p> |
|
3651 |
|
3652 |
|
3653 |
|
3654 |
|
3655 |
|
3656 </div> |
|
3657 |
|
3658 <div class="description"> |
|
3659 <p>Utility method to define the attribute hash used to filter/whitelist property mixes for |
|
3660 this class for iteration performance reasons.</p> |
|
3661 </div> |
|
3662 |
|
3663 |
|
3664 |
|
3665 |
|
3666 |
|
3667 |
|
3668 </div> |
|
3669 |
|
3670 |
|
3671 <div id="method__baseDestroy" class="method item private inherited"> |
|
3672 <h3 class="name"><code>_baseDestroy</code></h3> |
|
3673 |
|
3674 |
|
3675 <span class="paren">()</span> |
|
3676 |
|
3677 |
|
3678 |
|
3679 |
|
3680 |
|
3681 |
|
3682 |
|
3683 <span class="flag private">private</span> |
|
3684 |
|
3685 |
|
3686 |
|
3687 |
|
3688 |
|
3689 |
|
3690 |
|
3691 |
|
3692 |
|
3693 |
|
3694 <div class="meta"> |
|
3695 |
|
3696 |
|
3697 <p>Inherited from |
|
3698 <a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>: |
|
3699 |
|
3700 |
|
3701 |
|
3702 <a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a> |
|
3703 |
|
3704 </p> |
|
3705 |
|
3706 |
|
3707 |
|
3708 |
|
3709 |
|
3710 </div> |
|
3711 |
|
3712 <div class="description"> |
|
3713 <p>Internal destroy implementation for BaseCore</p> |
|
3714 </div> |
|
3715 |
|
3716 |
|
3717 |
|
3718 |
|
3719 |
|
3720 |
|
3721 </div> |
|
3722 |
|
3723 |
|
3724 <div id="method__baseInit" class="method item private inherited"> |
|
3725 <h3 class="name"><code>_baseInit</code></h3> |
|
3726 |
|
3727 |
|
3728 <span class="paren">()</span> |
|
3729 |
|
3730 |
|
3731 |
|
3732 |
|
3733 |
|
3734 |
|
3735 |
|
3736 <span class="flag private">private</span> |
|
3737 |
|
3738 |
|
3739 |
|
3740 |
|
3741 |
|
3742 |
|
3743 |
|
3744 |
|
3745 |
|
3746 |
|
3747 <div class="meta"> |
|
3748 |
|
3749 |
|
3750 <p>Inherited from |
|
3751 <a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>: |
|
3752 |
|
3753 |
|
3754 |
|
3755 <a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a> |
|
3756 |
|
3757 </p> |
|
3758 |
|
3759 |
|
3760 |
|
3761 |
|
3762 |
|
3763 </div> |
|
3764 |
|
3765 <div class="description"> |
|
3766 <p>Internal initialization implementation for BaseCore</p> |
|
3767 </div> |
|
3768 |
|
3769 |
|
3770 |
|
3771 |
|
3772 |
|
3773 |
|
3774 </div> |
|
3775 |
|
3776 |
|
3777 <div id="method__cloneDefaultValue" class="method item private inherited"> |
|
3778 <h3 class="name"><code>_cloneDefaultValue</code></h3> |
|
3779 |
|
3780 |
|
3781 <div class="args"> |
|
3782 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3783 |
|
3784 <li class="arg"> |
|
3785 |
|
3786 <code>cfg</code> |
|
3787 |
|
3788 </li> |
|
3789 |
|
3790 </ul><span class="paren">)</span> |
|
3791 </div> |
|
3792 |
|
3793 |
|
3794 |
|
3795 |
|
3796 |
|
3797 |
|
3798 |
|
3799 <span class="flag private">private</span> |
|
3800 |
|
3801 |
|
3802 |
|
3803 |
|
3804 |
|
3805 |
|
3806 |
|
3807 |
|
3808 |
|
3809 |
|
3810 <div class="meta"> |
|
3811 |
|
3812 |
|
3813 <p>Inherited from |
|
3814 <a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>: |
|
3815 |
|
3816 |
|
3817 |
|
3818 <a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a> |
|
3819 |
|
3820 </p> |
|
3821 |
|
3822 |
|
3823 |
|
3824 |
|
3825 |
|
3826 </div> |
|
3827 |
|
3828 <div class="description"> |
|
3829 <p>This method assumes that the value has already been checked to be an object. |
|
3830 Since it's on a critical path, we don't want to re-do the check.</p> |
|
3831 </div> |
|
3832 |
|
3833 |
|
3834 <div class="params"> |
|
3835 <h4>Parameters:</h4> |
|
3836 |
|
3837 <ul class="params-list"> |
|
3838 |
|
3839 <li class="param"> |
|
3840 |
|
3841 <code class="param-name">cfg</code> |
|
3842 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3843 |
|
3844 |
|
3845 |
|
3846 |
|
3847 <div class="param-description"> |
|
3848 |
|
3849 </div> |
|
3850 |
|
3851 |
|
3852 </li> |
|
3853 |
|
3854 </ul> |
|
3855 </div> |
|
3856 |
|
3857 |
|
3858 |
|
3859 |
|
3860 |
|
3861 </div> |
|
3862 |
|
3863 |
|
3864 <div id="method__decode" class="method item protected inherited"> |
|
3865 <h3 class="name"><code>_decode</code></h3> |
|
3866 |
|
3867 |
|
3868 <div class="args"> |
|
3869 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3870 |
|
3871 <li class="arg"> |
|
3872 |
|
3873 <code>string</code> |
|
3874 |
|
3875 </li> |
|
3876 |
|
3877 </ul><span class="paren">)</span> |
|
3878 </div> |
|
3879 |
|
3880 |
|
3881 |
|
3882 <span class="returns-inline"> |
|
3883 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3884 </span> |
|
3885 |
|
3886 |
|
3887 |
|
3888 |
|
3889 |
|
3890 <span class="flag protected">protected</span> |
|
3891 |
|
3892 |
|
3893 |
|
3894 |
|
3895 |
|
3896 |
|
3897 |
|
3898 |
|
3899 |
|
3900 |
|
3901 <div class="meta"> |
|
3902 |
|
3903 |
|
3904 <p>Inherited from |
|
3905 <a href="../classes/Router.html#method__decode">Router</a>: |
|
3906 |
|
3907 |
|
3908 |
|
3909 <a href="../files/app_js_router.js.html#l564"><code>app/js/router.js:564</code></a> |
|
3910 |
|
3911 </p> |
|
3912 |
|
3913 |
|
3914 |
|
3915 |
|
3916 |
|
3917 </div> |
|
3918 |
|
3919 <div class="description"> |
|
3920 <p>Wrapper around <code>decodeURIComponent</code> that also converts <code>+</code> chars into |
|
3921 spaces.</p> |
|
3922 </div> |
|
3923 |
|
3924 |
|
3925 <div class="params"> |
|
3926 <h4>Parameters:</h4> |
|
3927 |
|
3928 <ul class="params-list"> |
|
3929 |
|
3930 <li class="param"> |
|
3931 |
|
3932 <code class="param-name">string</code> |
|
3933 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3934 |
|
3935 |
|
3936 |
|
3937 |
|
3938 <div class="param-description"> |
|
3939 <p>String to decode.</p> |
|
3940 </div> |
|
3941 |
|
3942 |
|
3943 </li> |
|
3944 |
|
3945 </ul> |
|
3946 </div> |
|
3947 |
|
3948 |
|
3949 |
|
3950 <div class="returns"> |
|
3951 <h4>Returns:</h4> |
|
3952 |
|
3953 <div class="returns-description"> |
|
3954 |
|
3955 |
|
3956 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
3957 |
|
3958 Decoded string. |
|
3959 |
|
3960 </div> |
|
3961 </div> |
|
3962 |
|
3963 |
|
3964 |
|
3965 </div> |
|
3966 |
|
3967 |
|
3968 <div id="method__defAttrChangeFn" class="method item private inherited"> |
|
3969 <h3 class="name"><code>_defAttrChangeFn</code></h3> |
|
3970 |
|
3971 |
|
3972 <div class="args"> |
|
3973 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3974 |
|
3975 <li class="arg"> |
|
3976 |
|
3977 <code>e</code> |
|
3978 |
|
3979 </li> |
|
3980 |
|
3981 </ul><span class="paren">)</span> |
|
3982 </div> |
|
3983 |
|
3984 |
|
3985 |
|
3986 |
|
3987 |
|
3988 |
|
3989 |
|
3990 <span class="flag private">private</span> |
|
3991 |
|
3992 |
|
3993 |
|
3994 |
|
3995 |
|
3996 |
|
3997 |
|
3998 |
|
3999 |
|
4000 |
|
4001 <div class="meta"> |
|
4002 |
|
4003 |
|
4004 <p>Inherited from |
|
4005 <a href="../classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>: |
|
4006 |
|
4007 |
|
4008 |
|
4009 <a href="../files/attribute_js_AttributeObservable.js.html#l186"><code>attribute/js/AttributeObservable.js:186</code></a> |
|
4010 |
|
4011 </p> |
|
4012 |
|
4013 |
|
4014 |
|
4015 |
|
4016 |
|
4017 </div> |
|
4018 |
|
4019 <div class="description"> |
|
4020 <p>Default function for attribute change events.</p> |
|
4021 </div> |
|
4022 |
|
4023 |
|
4024 <div class="params"> |
|
4025 <h4>Parameters:</h4> |
|
4026 |
|
4027 <ul class="params-list"> |
|
4028 |
|
4029 <li class="param"> |
|
4030 |
|
4031 <code class="param-name">e</code> |
|
4032 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4033 |
|
4034 |
|
4035 |
|
4036 |
|
4037 <div class="param-description"> |
|
4038 <p>The event object for attribute change events.</p> |
|
4039 </div> |
|
4040 |
|
4041 |
|
4042 </li> |
|
4043 |
|
4044 </ul> |
|
4045 </div> |
|
4046 |
|
4047 |
|
4048 |
|
4049 |
|
4050 |
|
4051 </div> |
|
4052 |
|
4053 |
|
4054 <div id="method__defDestroyFn" class="method item protected inherited"> |
|
4055 <h3 class="name"><code>_defDestroyFn</code></h3> |
|
4056 |
|
4057 |
|
4058 <div class="args"> |
|
4059 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4060 |
|
4061 <li class="arg"> |
|
4062 |
|
4063 <code>e</code> |
|
4064 |
|
4065 </li> |
|
4066 |
|
4067 </ul><span class="paren">)</span> |
|
4068 </div> |
|
4069 |
|
4070 |
|
4071 |
|
4072 |
|
4073 |
|
4074 |
|
4075 |
|
4076 <span class="flag protected">protected</span> |
|
4077 |
|
4078 |
|
4079 |
|
4080 |
|
4081 |
|
4082 |
|
4083 |
|
4084 |
|
4085 |
|
4086 |
|
4087 <div class="meta"> |
|
4088 |
|
4089 |
|
4090 <p>Inherited from |
|
4091 <a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>: |
|
4092 |
|
4093 |
|
4094 |
|
4095 <a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a> |
|
4096 |
|
4097 </p> |
|
4098 |
|
4099 |
|
4100 |
|
4101 |
|
4102 |
|
4103 </div> |
|
4104 |
|
4105 <div class="description"> |
|
4106 <p>Default destroy event handler</p> |
|
4107 </div> |
|
4108 |
|
4109 |
|
4110 <div class="params"> |
|
4111 <h4>Parameters:</h4> |
|
4112 |
|
4113 <ul class="params-list"> |
|
4114 |
|
4115 <li class="param"> |
|
4116 |
|
4117 <code class="param-name">e</code> |
|
4118 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4119 |
|
4120 |
|
4121 |
|
4122 |
|
4123 <div class="param-description"> |
|
4124 <p>Event object</p> |
|
4125 </div> |
|
4126 |
|
4127 |
|
4128 </li> |
|
4129 |
|
4130 </ul> |
|
4131 </div> |
|
4132 |
|
4133 |
|
4134 |
|
4135 |
|
4136 |
|
4137 </div> |
|
4138 |
|
4139 |
|
4140 <div id="method__defInitFn" class="method item protected inherited"> |
|
4141 <h3 class="name"><code>_defInitFn</code></h3> |
|
4142 |
|
4143 |
|
4144 <div class="args"> |
|
4145 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4146 |
|
4147 <li class="arg"> |
|
4148 |
|
4149 <code>e</code> |
|
4150 |
|
4151 </li> |
|
4152 |
|
4153 </ul><span class="paren">)</span> |
|
4154 </div> |
|
4155 |
|
4156 |
|
4157 |
|
4158 |
|
4159 |
|
4160 |
|
4161 |
|
4162 <span class="flag protected">protected</span> |
|
4163 |
|
4164 |
|
4165 |
|
4166 |
|
4167 |
|
4168 |
|
4169 |
|
4170 |
|
4171 |
|
4172 |
|
4173 <div class="meta"> |
|
4174 |
|
4175 |
|
4176 <p>Inherited from |
|
4177 <a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>: |
|
4178 |
|
4179 |
|
4180 |
|
4181 <a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a> |
|
4182 |
|
4183 </p> |
|
4184 |
|
4185 |
|
4186 |
|
4187 |
|
4188 |
|
4189 </div> |
|
4190 |
|
4191 <div class="description"> |
|
4192 <p>Default init event handler</p> |
|
4193 </div> |
|
4194 |
|
4195 |
|
4196 <div class="params"> |
|
4197 <h4>Parameters:</h4> |
|
4198 |
|
4199 <ul class="params-list"> |
|
4200 |
|
4201 <li class="param"> |
|
4202 |
|
4203 <code class="param-name">e</code> |
|
4204 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4205 |
|
4206 |
|
4207 |
|
4208 |
|
4209 <div class="param-description"> |
|
4210 <p>Event object, with a cfg property which |
|
4211 refers to the configuration object passed to the constructor.</p> |
|
4212 </div> |
|
4213 |
|
4214 |
|
4215 </li> |
|
4216 |
|
4217 </ul> |
|
4218 </div> |
|
4219 |
|
4220 |
|
4221 |
|
4222 |
|
4223 |
|
4224 </div> |
|
4225 |
|
4226 |
|
4227 <div id="method__defNavigateFn" class="method item protected inherited"> |
|
4228 <h3 class="name"><code>_defNavigateFn</code></h3> |
|
4229 |
|
4230 |
|
4231 <div class="args"> |
|
4232 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4233 |
|
4234 <li class="arg"> |
|
4235 |
|
4236 <code>e</code> |
|
4237 |
|
4238 </li> |
|
4239 |
|
4240 </ul><span class="paren">)</span> |
|
4241 </div> |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 |
|
4247 |
|
4248 |
|
4249 <span class="flag protected">protected</span> |
|
4250 |
|
4251 |
|
4252 |
|
4253 |
|
4254 |
|
4255 |
|
4256 |
|
4257 |
|
4258 |
|
4259 |
|
4260 <div class="meta"> |
|
4261 |
|
4262 |
|
4263 <p>Inherited from |
|
4264 <a href="../classes/PjaxBase.html#method__defNavigateFn">PjaxBase</a>: |
|
4265 |
|
4266 |
|
4267 |
|
4268 <a href="../files/pjax_js_pjax-base.js.html#l300"><code>pjax/js/pjax-base.js:300</code></a> |
|
4269 |
|
4270 </p> |
|
4271 |
|
4272 |
|
4273 |
|
4274 |
|
4275 |
|
4276 <p>Available since 3.5.0</p> |
|
4277 |
|
4278 </div> |
|
4279 |
|
4280 <div class="description"> |
|
4281 <p>Default handler for the <code>navigate</code> event.</p> |
|
4282 |
|
4283 <p>Adds a new history entry or replaces the current entry for the specified URL |
|
4284 and will scroll the page to the top if configured to do so.</p> |
|
4285 </div> |
|
4286 |
|
4287 |
|
4288 <div class="params"> |
|
4289 <h4>Parameters:</h4> |
|
4290 |
|
4291 <ul class="params-list"> |
|
4292 |
|
4293 <li class="param"> |
|
4294 |
|
4295 <code class="param-name">e</code> |
|
4296 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4297 |
|
4298 |
|
4299 |
|
4300 |
|
4301 <div class="param-description"> |
|
4302 |
|
4303 </div> |
|
4304 |
|
4305 |
|
4306 </li> |
|
4307 |
|
4308 </ul> |
|
4309 </div> |
|
4310 |
|
4311 |
|
4312 |
|
4313 |
|
4314 |
|
4315 </div> |
|
4316 |
|
4317 |
|
4318 <div id="method__defReadyFn" class="method item protected inherited"> |
|
4319 <h3 class="name"><code>_defReadyFn</code></h3> |
|
4320 |
|
4321 |
|
4322 <div class="args"> |
|
4323 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4324 |
|
4325 <li class="arg"> |
|
4326 |
|
4327 <code>e</code> |
|
4328 |
|
4329 </li> |
|
4330 |
|
4331 </ul><span class="paren">)</span> |
|
4332 </div> |
|
4333 |
|
4334 |
|
4335 |
|
4336 |
|
4337 |
|
4338 |
|
4339 |
|
4340 <span class="flag protected">protected</span> |
|
4341 |
|
4342 |
|
4343 |
|
4344 |
|
4345 |
|
4346 |
|
4347 |
|
4348 |
|
4349 |
|
4350 |
|
4351 <div class="meta"> |
|
4352 |
|
4353 |
|
4354 <p>Inherited from |
|
4355 <a href="../classes/Router.html#method__defReadyFn">Router</a>: |
|
4356 |
|
4357 |
|
4358 |
|
4359 <a href="../files/app_js_router.js.html#l1300"><code>app/js/router.js:1300</code></a> |
|
4360 |
|
4361 </p> |
|
4362 |
|
4363 |
|
4364 |
|
4365 |
|
4366 |
|
4367 </div> |
|
4368 |
|
4369 <div class="description"> |
|
4370 <p>Default handler for the <code>ready</code> event.</p> |
|
4371 </div> |
|
4372 |
|
4373 |
|
4374 <div class="params"> |
|
4375 <h4>Parameters:</h4> |
|
4376 |
|
4377 <ul class="params-list"> |
|
4378 |
|
4379 <li class="param"> |
|
4380 |
|
4381 <code class="param-name">e</code> |
|
4382 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
4383 |
|
4384 |
|
4385 |
|
4386 |
|
4387 <div class="param-description"> |
|
4388 |
|
4389 </div> |
|
4390 |
|
4391 |
|
4392 </li> |
|
4393 |
|
4394 </ul> |
|
4395 </div> |
|
4396 |
|
4397 |
|
4398 |
|
4399 |
|
4400 |
|
4401 </div> |
|
4402 |
|
4403 |
|
4404 <div id="method__dequeue" class="method item protected inherited"> |
|
4405 <h3 class="name"><code>_dequeue</code></h3> |
|
4406 |
|
4407 |
|
4408 <span class="paren">()</span> |
|
4409 |
|
4410 |
|
4411 |
|
4412 |
|
4413 |
|
4414 |
|
4415 |
|
4416 <span class="flag protected">protected</span> |
|
4417 |
|
4418 |
|
4419 |
|
4420 |
|
4421 |
|
4422 |
|
4423 |
|
4424 <span class="flag chainable">chainable</span> |
|
4425 |
|
4426 |
|
4427 |
|
4428 |
|
4429 <div class="meta"> |
|
4430 |
|
4431 |
|
4432 <p>Inherited from |
|
4433 <a href="../classes/Router.html#method__dequeue">Router</a>: |
|
4434 |
|
4435 |
|
4436 |
|
4437 <a href="../files/app_js_router.js.html#l577"><code>app/js/router.js:577</code></a> |
|
4438 |
|
4439 </p> |
|
4440 |
|
4441 |
|
4442 |
|
4443 |
|
4444 |
|
4445 </div> |
|
4446 |
|
4447 <div class="description"> |
|
4448 <p>Shifts the topmost <code>_save()</code> call off the queue and executes it. Does |
|
4449 nothing if the queue is empty.</p> |
|
4450 </div> |
|
4451 |
|
4452 |
|
4453 |
|
4454 |
|
4455 |
|
4456 |
|
4457 </div> |
|
4458 |
|
4459 |
|
4460 <div id="method__destroyContainer" class="method item protected"> |
|
4461 <h3 class="name"><code>_destroyContainer</code></h3> |
|
4462 |
|
4463 |
|
4464 <span class="paren">()</span> |
|
4465 |
|
4466 |
|
4467 |
|
4468 |
|
4469 |
|
4470 |
|
4471 |
|
4472 <span class="flag protected">protected</span> |
|
4473 |
|
4474 |
|
4475 |
|
4476 |
|
4477 |
|
4478 |
|
4479 |
|
4480 |
|
4481 |
|
4482 |
|
4483 <div class="meta"> |
|
4484 |
|
4485 <p>Inherited from |
|
4486 <a href="../classes/View.html#method__destroyContainer"> |
|
4487 View |
|
4488 </a> |
|
4489 |
|
4490 but overwritten in |
|
4491 |
|
4492 |
|
4493 |
|
4494 <a href="../files/app_js_app-base.js.html#l472"><code>app/js/app-base.js:472</code></a> |
|
4495 |
|
4496 </p> |
|
4497 |
|
4498 |
|
4499 |
|
4500 |
|
4501 |
|
4502 </div> |
|
4503 |
|
4504 <div class="description"> |
|
4505 <p>Overrides View's container destruction to deal with the <code>viewContainer</code> and |
|
4506 checks to make sure not to remove and purge the <code><body></code>.</p> |
|
4507 </div> |
|
4508 |
|
4509 |
|
4510 |
|
4511 |
|
4512 |
|
4513 |
|
4514 </div> |
|
4515 |
|
4516 |
|
4517 <div id="method__destroyHierarchy" class="method item private inherited"> |
|
4518 <h3 class="name"><code>_destroyHierarchy</code></h3> |
|
4519 |
|
4520 |
|
4521 <span class="paren">()</span> |
|
4522 |
|
4523 |
|
4524 |
|
4525 |
|
4526 |
|
4527 |
|
4528 |
|
4529 <span class="flag private">private</span> |
|
4530 |
|
4531 |
|
4532 |
|
4533 |
|
4534 |
|
4535 |
|
4536 |
|
4537 |
|
4538 |
|
4539 |
|
4540 <div class="meta"> |
|
4541 |
|
4542 |
|
4543 <p>Inherited from |
|
4544 <a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>: |
|
4545 |
|
4546 |
|
4547 |
|
4548 <a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a> |
|
4549 |
|
4550 </p> |
|
4551 |
|
4552 |
|
4553 |
|
4554 |
|
4555 |
|
4556 </div> |
|
4557 |
|
4558 <div class="description"> |
|
4559 <p>Destroys the class hierarchy for this instance by invoking |
|
4560 the destructor method on the prototype of each class in the hierarchy.</p> |
|
4561 </div> |
|
4562 |
|
4563 |
|
4564 |
|
4565 |
|
4566 |
|
4567 |
|
4568 </div> |
|
4569 |
|
4570 |
|
4571 <div id="method__detachView" class="method item protected"> |
|
4572 <h3 class="name"><code>_detachView</code></h3> |
|
4573 |
|
4574 |
|
4575 <div class="args"> |
|
4576 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4577 |
|
4578 <li class="arg"> |
|
4579 |
|
4580 <code>view</code> |
|
4581 |
|
4582 </li> |
|
4583 |
|
4584 </ul><span class="paren">)</span> |
|
4585 </div> |
|
4586 |
|
4587 |
|
4588 |
|
4589 |
|
4590 |
|
4591 |
|
4592 |
|
4593 <span class="flag protected">protected</span> |
|
4594 |
|
4595 |
|
4596 |
|
4597 |
|
4598 |
|
4599 |
|
4600 |
|
4601 |
|
4602 |
|
4603 |
|
4604 <div class="meta"> |
|
4605 |
|
4606 |
|
4607 |
|
4608 <p> |
|
4609 |
|
4610 Defined in |
|
4611 |
|
4612 |
|
4613 |
|
4614 |
|
4615 <a href="../files/app_js_app-base.js.html#l514"><code>app/js/app-base.js:514</code></a> |
|
4616 |
|
4617 </p> |
|
4618 |
|
4619 |
|
4620 |
|
4621 |
|
4622 |
|
4623 <p>Available since 3.5.0</p> |
|
4624 |
|
4625 </div> |
|
4626 |
|
4627 <div class="description"> |
|
4628 <p>Helper method to detach the view instance from the application by removing |
|
4629 the application as a bubble target of the view, and either just removing the |
|
4630 view if it is intended to be preserved, or destroying the instance |
|
4631 completely.</p> |
|
4632 </div> |
|
4633 |
|
4634 |
|
4635 <div class="params"> |
|
4636 <h4>Parameters:</h4> |
|
4637 |
|
4638 <ul class="params-list"> |
|
4639 |
|
4640 <li class="param"> |
|
4641 |
|
4642 <code class="param-name">view</code> |
|
4643 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
4644 |
|
4645 |
|
4646 |
|
4647 |
|
4648 <div class="param-description"> |
|
4649 <p>View to detach.</p> |
|
4650 </div> |
|
4651 |
|
4652 |
|
4653 </li> |
|
4654 |
|
4655 </ul> |
|
4656 </div> |
|
4657 |
|
4658 |
|
4659 |
|
4660 |
|
4661 |
|
4662 </div> |
|
4663 |
|
4664 |
|
4665 <div id="method__dispatch" class="method item protected inherited"> |
|
4666 <h3 class="name"><code>_dispatch</code></h3> |
|
4667 |
|
4668 |
|
4669 <div class="args"> |
|
4670 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4671 |
|
4672 <li class="arg"> |
|
4673 |
|
4674 <code>path</code> |
|
4675 |
|
4676 </li> |
|
4677 |
|
4678 <li class="arg"> |
|
4679 |
|
4680 <code>url</code> |
|
4681 |
|
4682 </li> |
|
4683 |
|
4684 <li class="arg"> |
|
4685 |
|
4686 <code>src</code> |
|
4687 |
|
4688 </li> |
|
4689 |
|
4690 </ul><span class="paren">)</span> |
|
4691 </div> |
|
4692 |
|
4693 |
|
4694 |
|
4695 |
|
4696 |
|
4697 |
|
4698 |
|
4699 <span class="flag protected">protected</span> |
|
4700 |
|
4701 |
|
4702 |
|
4703 |
|
4704 |
|
4705 |
|
4706 |
|
4707 <span class="flag chainable">chainable</span> |
|
4708 |
|
4709 |
|
4710 |
|
4711 |
|
4712 <div class="meta"> |
|
4713 |
|
4714 |
|
4715 <p>Inherited from |
|
4716 <a href="../classes/Router.html#method__dispatch">Router</a>: |
|
4717 |
|
4718 |
|
4719 |
|
4720 <a href="../files/app_js_router.js.html#l605"><code>app/js/router.js:605</code></a> |
|
4721 |
|
4722 </p> |
|
4723 |
|
4724 |
|
4725 |
|
4726 |
|
4727 |
|
4728 </div> |
|
4729 |
|
4730 <div class="description"> |
|
4731 <p>Dispatches to the first route handler that matches the specified <em>path</em>.</p> |
|
4732 |
|
4733 <p>If called before the <code>ready</code> event has fired, the dispatch will be aborted. |
|
4734 This ensures normalized behavior between Chrome (which fires a <code>popstate</code> |
|
4735 event on every pageview) and other browsers (which do not).</p> |
|
4736 </div> |
|
4737 |
|
4738 |
|
4739 <div class="params"> |
|
4740 <h4>Parameters:</h4> |
|
4741 |
|
4742 <ul class="params-list"> |
|
4743 |
|
4744 <li class="param"> |
|
4745 |
|
4746 <code class="param-name">path</code> |
|
4747 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4748 |
|
4749 |
|
4750 |
|
4751 |
|
4752 <div class="param-description"> |
|
4753 <p>URL path.</p> |
|
4754 </div> |
|
4755 |
|
4756 |
|
4757 </li> |
|
4758 |
|
4759 <li class="param"> |
|
4760 |
|
4761 <code class="param-name">url</code> |
|
4762 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4763 |
|
4764 |
|
4765 |
|
4766 |
|
4767 <div class="param-description"> |
|
4768 <p>Full URL.</p> |
|
4769 </div> |
|
4770 |
|
4771 |
|
4772 </li> |
|
4773 |
|
4774 <li class="param"> |
|
4775 |
|
4776 <code class="param-name">src</code> |
|
4777 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4778 |
|
4779 |
|
4780 |
|
4781 |
|
4782 <div class="param-description"> |
|
4783 <p>What initiated the dispatch.</p> |
|
4784 </div> |
|
4785 |
|
4786 |
|
4787 </li> |
|
4788 |
|
4789 </ul> |
|
4790 </div> |
|
4791 |
|
4792 |
|
4793 |
|
4794 |
|
4795 |
|
4796 </div> |
|
4797 |
|
4798 |
|
4799 <div id="method__filterAdHocAttrs" class="method item private inherited"> |
|
4800 <h3 class="name"><code>_filterAdHocAttrs</code></h3> |
|
4801 |
|
4802 |
|
4803 <div class="args"> |
|
4804 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4805 |
|
4806 <li class="arg"> |
|
4807 |
|
4808 <code>allAttrs</code> |
|
4809 |
|
4810 </li> |
|
4811 |
|
4812 <li class="arg"> |
|
4813 |
|
4814 <code>userVals</code> |
|
4815 |
|
4816 </li> |
|
4817 |
|
4818 </ul><span class="paren">)</span> |
|
4819 </div> |
|
4820 |
|
4821 |
|
4822 |
|
4823 <span class="returns-inline"> |
|
4824 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4825 </span> |
|
4826 |
|
4827 |
|
4828 |
|
4829 |
|
4830 |
|
4831 <span class="flag private">private</span> |
|
4832 |
|
4833 |
|
4834 |
|
4835 |
|
4836 |
|
4837 |
|
4838 |
|
4839 |
|
4840 |
|
4841 |
|
4842 <div class="meta"> |
|
4843 |
|
4844 |
|
4845 <p>Inherited from |
|
4846 <a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>: |
|
4847 |
|
4848 |
|
4849 |
|
4850 <a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a> |
|
4851 |
|
4852 </p> |
|
4853 |
|
4854 |
|
4855 |
|
4856 |
|
4857 |
|
4858 </div> |
|
4859 |
|
4860 <div class="description"> |
|
4861 |
|
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">allAttrs</code> |
|
4873 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4874 |
|
4875 |
|
4876 |
|
4877 |
|
4878 <div class="param-description"> |
|
4879 <p>The set of all attribute configurations for this instance. |
|
4880 Attributes will be removed from this set, if they belong to the filtered class, so |
|
4881 that by the time all classes are processed, allCfgs will be empty.</p> |
|
4882 </div> |
|
4883 |
|
4884 |
|
4885 </li> |
|
4886 |
|
4887 <li class="param"> |
|
4888 |
|
4889 <code class="param-name">userVals</code> |
|
4890 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4891 |
|
4892 |
|
4893 |
|
4894 |
|
4895 <div class="param-description"> |
|
4896 <p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p> |
|
4897 </div> |
|
4898 |
|
4899 |
|
4900 </li> |
|
4901 |
|
4902 </ul> |
|
4903 </div> |
|
4904 |
|
4905 |
|
4906 |
|
4907 <div class="returns"> |
|
4908 <h4>Returns:</h4> |
|
4909 |
|
4910 <div class="returns-description"> |
|
4911 |
|
4912 |
|
4913 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
4914 |
|
4915 The set of adhoc attributes passed in, in the form |
|
4916 of an object with attribute name/configuration pairs. |
|
4917 |
|
4918 </div> |
|
4919 </div> |
|
4920 |
|
4921 |
|
4922 |
|
4923 </div> |
|
4924 |
|
4925 |
|
4926 <div id="method__filterAttrCfgs" class="method item private inherited"> |
|
4927 <h3 class="name"><code>_filterAttrCfgs</code></h3> |
|
4928 |
|
4929 |
|
4930 <div class="args"> |
|
4931 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4932 |
|
4933 <li class="arg"> |
|
4934 |
|
4935 <code>clazz</code> |
|
4936 |
|
4937 </li> |
|
4938 |
|
4939 <li class="arg"> |
|
4940 |
|
4941 <code>allCfgs</code> |
|
4942 |
|
4943 </li> |
|
4944 |
|
4945 </ul><span class="paren">)</span> |
|
4946 </div> |
|
4947 |
|
4948 |
|
4949 |
|
4950 <span class="returns-inline"> |
|
4951 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4952 </span> |
|
4953 |
|
4954 |
|
4955 |
|
4956 |
|
4957 |
|
4958 <span class="flag private">private</span> |
|
4959 |
|
4960 |
|
4961 |
|
4962 |
|
4963 |
|
4964 |
|
4965 |
|
4966 |
|
4967 |
|
4968 |
|
4969 <div class="meta"> |
|
4970 |
|
4971 |
|
4972 <p>Inherited from |
|
4973 <a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>: |
|
4974 |
|
4975 |
|
4976 |
|
4977 <a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a> |
|
4978 |
|
4979 </p> |
|
4980 |
|
4981 |
|
4982 |
|
4983 |
|
4984 |
|
4985 </div> |
|
4986 |
|
4987 <div class="description"> |
|
4988 <p>A helper method used when processing ATTRS across the class hierarchy during |
|
4989 initialization. Returns a disposable object with the attributes defined for |
|
4990 the provided class, extracted from the set of all attributes passed in.</p> |
|
4991 </div> |
|
4992 |
|
4993 |
|
4994 <div class="params"> |
|
4995 <h4>Parameters:</h4> |
|
4996 |
|
4997 <ul class="params-list"> |
|
4998 |
|
4999 <li class="param"> |
|
5000 |
|
5001 <code class="param-name">clazz</code> |
|
5002 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
5003 |
|
5004 |
|
5005 |
|
5006 |
|
5007 <div class="param-description"> |
|
5008 <p>The class for which the desired attributes are required.</p> |
|
5009 </div> |
|
5010 |
|
5011 |
|
5012 </li> |
|
5013 |
|
5014 <li class="param"> |
|
5015 |
|
5016 <code class="param-name">allCfgs</code> |
|
5017 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5018 |
|
5019 |
|
5020 |
|
5021 |
|
5022 <div class="param-description"> |
|
5023 <p>The set of all attribute configurations for this instance. |
|
5024 Attributes will be removed from this set, if they belong to the filtered class, so |
|
5025 that by the time all classes are processed, allCfgs will be empty.</p> |
|
5026 </div> |
|
5027 |
|
5028 |
|
5029 </li> |
|
5030 |
|
5031 </ul> |
|
5032 </div> |
|
5033 |
|
5034 |
|
5035 |
|
5036 <div class="returns"> |
|
5037 <h4>Returns:</h4> |
|
5038 |
|
5039 <div class="returns-description"> |
|
5040 |
|
5041 |
|
5042 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5043 |
|
5044 The set of attributes belonging to the class passed in, in the form |
|
5045 of an object with attribute name/configuration pairs. |
|
5046 |
|
5047 </div> |
|
5048 </div> |
|
5049 |
|
5050 |
|
5051 |
|
5052 </div> |
|
5053 |
|
5054 |
|
5055 <div id="method__fireAttrChange" class="method item private inherited"> |
|
5056 <h3 class="name"><code>_fireAttrChange</code></h3> |
|
5057 |
|
5058 |
|
5059 <div class="args"> |
|
5060 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5061 |
|
5062 <li class="arg"> |
|
5063 |
|
5064 <code>attrName</code> |
|
5065 |
|
5066 </li> |
|
5067 |
|
5068 <li class="arg"> |
|
5069 |
|
5070 <code>subAttrName</code> |
|
5071 |
|
5072 </li> |
|
5073 |
|
5074 <li class="arg"> |
|
5075 |
|
5076 <code>currVal</code> |
|
5077 |
|
5078 </li> |
|
5079 |
|
5080 <li class="arg"> |
|
5081 |
|
5082 <code>newVal</code> |
|
5083 |
|
5084 </li> |
|
5085 |
|
5086 <li class="arg"> |
|
5087 |
|
5088 <code>opts</code> |
|
5089 |
|
5090 </li> |
|
5091 |
|
5092 <li class="arg"> |
|
5093 |
|
5094 <code class="optional">[cfg]</code> |
|
5095 |
|
5096 </li> |
|
5097 |
|
5098 </ul><span class="paren">)</span> |
|
5099 </div> |
|
5100 |
|
5101 |
|
5102 |
|
5103 |
|
5104 |
|
5105 |
|
5106 |
|
5107 <span class="flag private">private</span> |
|
5108 |
|
5109 |
|
5110 |
|
5111 |
|
5112 |
|
5113 |
|
5114 |
|
5115 |
|
5116 |
|
5117 |
|
5118 <div class="meta"> |
|
5119 |
|
5120 |
|
5121 <p>Inherited from |
|
5122 <a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>: |
|
5123 |
|
5124 |
|
5125 |
|
5126 <a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a> |
|
5127 |
|
5128 </p> |
|
5129 |
|
5130 |
|
5131 |
|
5132 |
|
5133 |
|
5134 </div> |
|
5135 |
|
5136 <div class="description"> |
|
5137 <p>Utility method to help setup the event payload and fire the attribute change event.</p> |
|
5138 </div> |
|
5139 |
|
5140 |
|
5141 <div class="params"> |
|
5142 <h4>Parameters:</h4> |
|
5143 |
|
5144 <ul class="params-list"> |
|
5145 |
|
5146 <li class="param"> |
|
5147 |
|
5148 <code class="param-name">attrName</code> |
|
5149 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5150 |
|
5151 |
|
5152 |
|
5153 |
|
5154 <div class="param-description"> |
|
5155 <p>The name of the attribute</p> |
|
5156 </div> |
|
5157 |
|
5158 |
|
5159 </li> |
|
5160 |
|
5161 <li class="param"> |
|
5162 |
|
5163 <code class="param-name">subAttrName</code> |
|
5164 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5165 |
|
5166 |
|
5167 |
|
5168 |
|
5169 <div class="param-description"> |
|
5170 <p>The full path of the property being changed, |
|
5171 if this is a sub-attribute value being change. Otherwise null.</p> |
|
5172 </div> |
|
5173 |
|
5174 |
|
5175 </li> |
|
5176 |
|
5177 <li class="param"> |
|
5178 |
|
5179 <code class="param-name">currVal</code> |
|
5180 <span class="type">Any</span> |
|
5181 |
|
5182 |
|
5183 |
|
5184 |
|
5185 <div class="param-description"> |
|
5186 <p>The current value of the attribute</p> |
|
5187 </div> |
|
5188 |
|
5189 |
|
5190 </li> |
|
5191 |
|
5192 <li class="param"> |
|
5193 |
|
5194 <code class="param-name">newVal</code> |
|
5195 <span class="type">Any</span> |
|
5196 |
|
5197 |
|
5198 |
|
5199 |
|
5200 <div class="param-description"> |
|
5201 <p>The new value of the attribute</p> |
|
5202 </div> |
|
5203 |
|
5204 |
|
5205 </li> |
|
5206 |
|
5207 <li class="param"> |
|
5208 |
|
5209 <code class="param-name">opts</code> |
|
5210 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5211 |
|
5212 |
|
5213 |
|
5214 |
|
5215 <div class="param-description"> |
|
5216 <p>Any additional event data to mix into the attribute change event's event facade.</p> |
|
5217 </div> |
|
5218 |
|
5219 |
|
5220 </li> |
|
5221 |
|
5222 <li class="param"> |
|
5223 |
|
5224 <code class="param-name optional">[cfg]</code> |
|
5225 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5226 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
5227 |
|
5228 |
|
5229 |
|
5230 |
|
5231 <div class="param-description"> |
|
5232 <p>The attribute config stored in State, if already available.</p> |
|
5233 </div> |
|
5234 |
|
5235 |
|
5236 </li> |
|
5237 |
|
5238 </ul> |
|
5239 </div> |
|
5240 |
|
5241 |
|
5242 |
|
5243 |
|
5244 |
|
5245 </div> |
|
5246 |
|
5247 |
|
5248 <div id="method__getAttr" class="method item protected inherited"> |
|
5249 <h3 class="name"><code>_getAttr</code></h3> |
|
5250 |
|
5251 |
|
5252 <div class="args"> |
|
5253 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5254 |
|
5255 <li class="arg"> |
|
5256 |
|
5257 <code>name</code> |
|
5258 |
|
5259 </li> |
|
5260 |
|
5261 </ul><span class="paren">)</span> |
|
5262 </div> |
|
5263 |
|
5264 |
|
5265 |
|
5266 <span class="returns-inline"> |
|
5267 <span class="type">Any</span> |
|
5268 </span> |
|
5269 |
|
5270 |
|
5271 |
|
5272 |
|
5273 |
|
5274 <span class="flag protected">protected</span> |
|
5275 |
|
5276 |
|
5277 |
|
5278 |
|
5279 |
|
5280 |
|
5281 |
|
5282 <span class="flag chainable">chainable</span> |
|
5283 |
|
5284 |
|
5285 |
|
5286 |
|
5287 <div class="meta"> |
|
5288 |
|
5289 |
|
5290 <p>Inherited from |
|
5291 <a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>: |
|
5292 |
|
5293 |
|
5294 |
|
5295 <a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a> |
|
5296 |
|
5297 </p> |
|
5298 |
|
5299 |
|
5300 |
|
5301 |
|
5302 |
|
5303 </div> |
|
5304 |
|
5305 <div class="description"> |
|
5306 <p>Provides the common implementation for the public get method, |
|
5307 allowing Attribute hosts to over-ride either method.</p> |
|
5308 |
|
5309 <p>See <a href="#method_get">get</a> for argument details.</p> |
|
5310 </div> |
|
5311 |
|
5312 |
|
5313 <div class="params"> |
|
5314 <h4>Parameters:</h4> |
|
5315 |
|
5316 <ul class="params-list"> |
|
5317 |
|
5318 <li class="param"> |
|
5319 |
|
5320 <code class="param-name">name</code> |
|
5321 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5322 |
|
5323 |
|
5324 |
|
5325 |
|
5326 <div class="param-description"> |
|
5327 <p>The name of the attribute.</p> |
|
5328 </div> |
|
5329 |
|
5330 |
|
5331 </li> |
|
5332 |
|
5333 </ul> |
|
5334 </div> |
|
5335 |
|
5336 |
|
5337 |
|
5338 <div class="returns"> |
|
5339 <h4>Returns:</h4> |
|
5340 |
|
5341 <div class="returns-description"> |
|
5342 |
|
5343 |
|
5344 <span class="type">Any</span>: |
|
5345 |
|
5346 The value of the attribute. |
|
5347 |
|
5348 </div> |
|
5349 </div> |
|
5350 |
|
5351 |
|
5352 |
|
5353 </div> |
|
5354 |
|
5355 |
|
5356 <div id="method__getAttrCfg" class="method item protected inherited"> |
|
5357 <h3 class="name"><code>_getAttrCfg</code></h3> |
|
5358 |
|
5359 |
|
5360 <div class="args"> |
|
5361 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5362 |
|
5363 <li class="arg"> |
|
5364 |
|
5365 <code>name</code> |
|
5366 |
|
5367 </li> |
|
5368 |
|
5369 </ul><span class="paren">)</span> |
|
5370 </div> |
|
5371 |
|
5372 |
|
5373 |
|
5374 <span class="returns-inline"> |
|
5375 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5376 </span> |
|
5377 |
|
5378 |
|
5379 |
|
5380 |
|
5381 |
|
5382 <span class="flag protected">protected</span> |
|
5383 |
|
5384 |
|
5385 |
|
5386 |
|
5387 |
|
5388 |
|
5389 |
|
5390 |
|
5391 |
|
5392 |
|
5393 <div class="meta"> |
|
5394 |
|
5395 |
|
5396 <p>Inherited from |
|
5397 <a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>: |
|
5398 |
|
5399 |
|
5400 |
|
5401 <a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a> |
|
5402 |
|
5403 </p> |
|
5404 |
|
5405 |
|
5406 |
|
5407 |
|
5408 |
|
5409 </div> |
|
5410 |
|
5411 <div class="description"> |
|
5412 <p>Returns an object with the configuration properties (and value) |
|
5413 for the given attribute. If attrName is not provided, returns the |
|
5414 configuration properties for all attributes.</p> |
|
5415 </div> |
|
5416 |
|
5417 |
|
5418 <div class="params"> |
|
5419 <h4>Parameters:</h4> |
|
5420 |
|
5421 <ul class="params-list"> |
|
5422 |
|
5423 <li class="param"> |
|
5424 |
|
5425 <code class="param-name">name</code> |
|
5426 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5427 |
|
5428 |
|
5429 |
|
5430 |
|
5431 <div class="param-description"> |
|
5432 <p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p> |
|
5433 </div> |
|
5434 |
|
5435 |
|
5436 </li> |
|
5437 |
|
5438 </ul> |
|
5439 </div> |
|
5440 |
|
5441 |
|
5442 |
|
5443 <div class="returns"> |
|
5444 <h4>Returns:</h4> |
|
5445 |
|
5446 <div class="returns-description"> |
|
5447 |
|
5448 |
|
5449 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5450 |
|
5451 The configuration properties for the given attribute, or all attributes. |
|
5452 |
|
5453 </div> |
|
5454 </div> |
|
5455 |
|
5456 |
|
5457 |
|
5458 </div> |
|
5459 |
|
5460 |
|
5461 <div id="method__getAttrCfgs" class="method item protected inherited"> |
|
5462 <h3 class="name"><code>_getAttrCfgs</code></h3> |
|
5463 |
|
5464 |
|
5465 <span class="paren">()</span> |
|
5466 |
|
5467 |
|
5468 |
|
5469 <span class="returns-inline"> |
|
5470 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5471 </span> |
|
5472 |
|
5473 |
|
5474 |
|
5475 |
|
5476 |
|
5477 <span class="flag protected">protected</span> |
|
5478 |
|
5479 |
|
5480 |
|
5481 |
|
5482 |
|
5483 |
|
5484 |
|
5485 |
|
5486 |
|
5487 |
|
5488 <div class="meta"> |
|
5489 |
|
5490 |
|
5491 <p>Inherited from |
|
5492 <a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>: |
|
5493 |
|
5494 |
|
5495 |
|
5496 <a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a> |
|
5497 |
|
5498 </p> |
|
5499 |
|
5500 |
|
5501 |
|
5502 |
|
5503 |
|
5504 </div> |
|
5505 |
|
5506 <div class="description"> |
|
5507 <p>Returns an aggregated set of attribute configurations, by traversing |
|
5508 the class hierarchy.</p> |
|
5509 </div> |
|
5510 |
|
5511 |
|
5512 |
|
5513 |
|
5514 <div class="returns"> |
|
5515 <h4>Returns:</h4> |
|
5516 |
|
5517 <div class="returns-description"> |
|
5518 |
|
5519 |
|
5520 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5521 |
|
5522 The hash of attribute configurations, aggregated across classes in the hierarchy |
|
5523 This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return |
|
5524 the cached value. |
|
5525 |
|
5526 </div> |
|
5527 </div> |
|
5528 |
|
5529 |
|
5530 |
|
5531 </div> |
|
5532 |
|
5533 |
|
5534 <div id="method__getAttrInitVal" class="method item private inherited"> |
|
5535 <h3 class="name"><code>_getAttrInitVal</code></h3> |
|
5536 |
|
5537 |
|
5538 <div class="args"> |
|
5539 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5540 |
|
5541 <li class="arg"> |
|
5542 |
|
5543 <code>attr</code> |
|
5544 |
|
5545 </li> |
|
5546 |
|
5547 <li class="arg"> |
|
5548 |
|
5549 <code>cfg</code> |
|
5550 |
|
5551 </li> |
|
5552 |
|
5553 <li class="arg"> |
|
5554 |
|
5555 <code>initValues</code> |
|
5556 |
|
5557 </li> |
|
5558 |
|
5559 </ul><span class="paren">)</span> |
|
5560 </div> |
|
5561 |
|
5562 |
|
5563 |
|
5564 <span class="returns-inline"> |
|
5565 <span class="type">Any</span> |
|
5566 </span> |
|
5567 |
|
5568 |
|
5569 |
|
5570 |
|
5571 |
|
5572 <span class="flag private">private</span> |
|
5573 |
|
5574 |
|
5575 |
|
5576 |
|
5577 |
|
5578 |
|
5579 |
|
5580 |
|
5581 |
|
5582 |
|
5583 <div class="meta"> |
|
5584 |
|
5585 |
|
5586 <p>Inherited from |
|
5587 <a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>: |
|
5588 |
|
5589 |
|
5590 |
|
5591 <a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a> |
|
5592 |
|
5593 </p> |
|
5594 |
|
5595 |
|
5596 |
|
5597 |
|
5598 |
|
5599 </div> |
|
5600 |
|
5601 <div class="description"> |
|
5602 <p>Returns the initial value of the given attribute from |
|
5603 either the default configuration provided, or the |
|
5604 over-ridden value if it exists in the set of initValues |
|
5605 provided and the attribute is not read-only.</p> |
|
5606 </div> |
|
5607 |
|
5608 |
|
5609 <div class="params"> |
|
5610 <h4>Parameters:</h4> |
|
5611 |
|
5612 <ul class="params-list"> |
|
5613 |
|
5614 <li class="param"> |
|
5615 |
|
5616 <code class="param-name">attr</code> |
|
5617 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5618 |
|
5619 |
|
5620 |
|
5621 |
|
5622 <div class="param-description"> |
|
5623 <p>The name of the attribute</p> |
|
5624 </div> |
|
5625 |
|
5626 |
|
5627 </li> |
|
5628 |
|
5629 <li class="param"> |
|
5630 |
|
5631 <code class="param-name">cfg</code> |
|
5632 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5633 |
|
5634 |
|
5635 |
|
5636 |
|
5637 <div class="param-description"> |
|
5638 <p>The attribute configuration object</p> |
|
5639 </div> |
|
5640 |
|
5641 |
|
5642 </li> |
|
5643 |
|
5644 <li class="param"> |
|
5645 |
|
5646 <code class="param-name">initValues</code> |
|
5647 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5648 |
|
5649 |
|
5650 |
|
5651 |
|
5652 <div class="param-description"> |
|
5653 <p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p> |
|
5654 </div> |
|
5655 |
|
5656 |
|
5657 </li> |
|
5658 |
|
5659 </ul> |
|
5660 </div> |
|
5661 |
|
5662 |
|
5663 |
|
5664 <div class="returns"> |
|
5665 <h4>Returns:</h4> |
|
5666 |
|
5667 <div class="returns-description"> |
|
5668 |
|
5669 |
|
5670 <span class="type">Any</span>: |
|
5671 |
|
5672 The initial value of the attribute. |
|
5673 |
|
5674 </div> |
|
5675 </div> |
|
5676 |
|
5677 |
|
5678 |
|
5679 </div> |
|
5680 |
|
5681 |
|
5682 <div id="method__getAttrs" class="method item protected inherited"> |
|
5683 <h3 class="name"><code>_getAttrs</code></h3> |
|
5684 |
|
5685 |
|
5686 <div class="args"> |
|
5687 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5688 |
|
5689 <li class="arg"> |
|
5690 |
|
5691 <code>attrs</code> |
|
5692 |
|
5693 </li> |
|
5694 |
|
5695 </ul><span class="paren">)</span> |
|
5696 </div> |
|
5697 |
|
5698 |
|
5699 |
|
5700 <span class="returns-inline"> |
|
5701 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5702 </span> |
|
5703 |
|
5704 |
|
5705 |
|
5706 |
|
5707 |
|
5708 <span class="flag protected">protected</span> |
|
5709 |
|
5710 |
|
5711 |
|
5712 |
|
5713 |
|
5714 |
|
5715 |
|
5716 |
|
5717 |
|
5718 |
|
5719 <div class="meta"> |
|
5720 |
|
5721 |
|
5722 <p>Inherited from |
|
5723 <a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>: |
|
5724 |
|
5725 |
|
5726 |
|
5727 <a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a> |
|
5728 |
|
5729 </p> |
|
5730 |
|
5731 |
|
5732 |
|
5733 |
|
5734 |
|
5735 </div> |
|
5736 |
|
5737 <div class="description"> |
|
5738 <p>Implementation behind the public getAttrs method, to get multiple attribute values.</p> |
|
5739 </div> |
|
5740 |
|
5741 |
|
5742 <div class="params"> |
|
5743 <h4>Parameters:</h4> |
|
5744 |
|
5745 <ul class="params-list"> |
|
5746 |
|
5747 <li class="param"> |
|
5748 |
|
5749 <code class="param-name">attrs</code> |
|
5750 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
5751 |
|
5752 |
|
5753 |
|
5754 |
|
5755 <div class="param-description"> |
|
5756 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
5757 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
5758 </div> |
|
5759 |
|
5760 |
|
5761 </li> |
|
5762 |
|
5763 </ul> |
|
5764 </div> |
|
5765 |
|
5766 |
|
5767 |
|
5768 <div class="returns"> |
|
5769 <h4>Returns:</h4> |
|
5770 |
|
5771 <div class="returns-description"> |
|
5772 |
|
5773 |
|
5774 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5775 |
|
5776 An object with attribute name/value pairs. |
|
5777 |
|
5778 </div> |
|
5779 </div> |
|
5780 |
|
5781 |
|
5782 |
|
5783 </div> |
|
5784 |
|
5785 |
|
5786 <div id="method__getClasses" class="method item protected inherited"> |
|
5787 <h3 class="name"><code>_getClasses</code></h3> |
|
5788 |
|
5789 |
|
5790 <span class="paren">()</span> |
|
5791 |
|
5792 |
|
5793 |
|
5794 <span class="returns-inline"> |
|
5795 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span> |
|
5796 </span> |
|
5797 |
|
5798 |
|
5799 |
|
5800 |
|
5801 |
|
5802 <span class="flag protected">protected</span> |
|
5803 |
|
5804 |
|
5805 |
|
5806 |
|
5807 |
|
5808 |
|
5809 |
|
5810 |
|
5811 |
|
5812 |
|
5813 <div class="meta"> |
|
5814 |
|
5815 |
|
5816 <p>Inherited from |
|
5817 <a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>: |
|
5818 |
|
5819 |
|
5820 |
|
5821 <a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a> |
|
5822 |
|
5823 </p> |
|
5824 |
|
5825 |
|
5826 |
|
5827 |
|
5828 |
|
5829 </div> |
|
5830 |
|
5831 <div class="description"> |
|
5832 <p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p> |
|
5833 </div> |
|
5834 |
|
5835 |
|
5836 |
|
5837 |
|
5838 <div class="returns"> |
|
5839 <h4>Returns:</h4> |
|
5840 |
|
5841 <div class="returns-description"> |
|
5842 |
|
5843 |
|
5844 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>: |
|
5845 |
|
5846 An array of classes (constructor functions), making up the class hierarchy for this object. |
|
5847 This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the |
|
5848 cached value. |
|
5849 |
|
5850 </div> |
|
5851 </div> |
|
5852 |
|
5853 |
|
5854 |
|
5855 </div> |
|
5856 |
|
5857 |
|
5858 <div id="method__getContainer" class="method item protected inherited"> |
|
5859 <h3 class="name"><code>_getContainer</code></h3> |
|
5860 |
|
5861 |
|
5862 <div class="args"> |
|
5863 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5864 |
|
5865 <li class="arg"> |
|
5866 |
|
5867 <code>value</code> |
|
5868 |
|
5869 </li> |
|
5870 |
|
5871 </ul><span class="paren">)</span> |
|
5872 </div> |
|
5873 |
|
5874 |
|
5875 |
|
5876 <span class="returns-inline"> |
|
5877 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
5878 </span> |
|
5879 |
|
5880 |
|
5881 |
|
5882 |
|
5883 |
|
5884 <span class="flag protected">protected</span> |
|
5885 |
|
5886 |
|
5887 |
|
5888 |
|
5889 |
|
5890 |
|
5891 |
|
5892 |
|
5893 |
|
5894 |
|
5895 <div class="meta"> |
|
5896 |
|
5897 |
|
5898 <p>Inherited from |
|
5899 <a href="../classes/View.html#method__getContainer">View</a>: |
|
5900 |
|
5901 |
|
5902 |
|
5903 <a href="../files/app_js_view.js.html#l323"><code>app/js/view.js:323</code></a> |
|
5904 |
|
5905 </p> |
|
5906 |
|
5907 |
|
5908 |
|
5909 |
|
5910 |
|
5911 <p>Available since 3.5.0</p> |
|
5912 |
|
5913 </div> |
|
5914 |
|
5915 <div class="description"> |
|
5916 <p>Getter for the <code>container</code> attribute.</p> |
|
5917 </div> |
|
5918 |
|
5919 |
|
5920 <div class="params"> |
|
5921 <h4>Parameters:</h4> |
|
5922 |
|
5923 <ul class="params-list"> |
|
5924 |
|
5925 <li class="param"> |
|
5926 |
|
5927 <code class="param-name">value</code> |
|
5928 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span> |
|
5929 |
|
5930 |
|
5931 |
|
5932 |
|
5933 <div class="param-description"> |
|
5934 <p>Current attribute value.</p> |
|
5935 </div> |
|
5936 |
|
5937 |
|
5938 </li> |
|
5939 |
|
5940 </ul> |
|
5941 </div> |
|
5942 |
|
5943 |
|
5944 |
|
5945 <div class="returns"> |
|
5946 <h4>Returns:</h4> |
|
5947 |
|
5948 <div class="returns-description"> |
|
5949 |
|
5950 |
|
5951 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
5952 |
|
5953 Container node. |
|
5954 |
|
5955 </div> |
|
5956 </div> |
|
5957 |
|
5958 |
|
5959 |
|
5960 </div> |
|
5961 |
|
5962 |
|
5963 <div id="method__getFullType" class="method item private inherited"> |
|
5964 <h3 class="name"><code>_getFullType</code></h3> |
|
5965 |
|
5966 |
|
5967 <div class="args"> |
|
5968 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5969 |
|
5970 <li class="arg"> |
|
5971 |
|
5972 <code>type</code> |
|
5973 |
|
5974 </li> |
|
5975 |
|
5976 </ul><span class="paren">)</span> |
|
5977 </div> |
|
5978 |
|
5979 |
|
5980 |
|
5981 <span class="returns-inline"> |
|
5982 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5983 </span> |
|
5984 |
|
5985 |
|
5986 |
|
5987 |
|
5988 |
|
5989 <span class="flag private">private</span> |
|
5990 |
|
5991 |
|
5992 |
|
5993 |
|
5994 |
|
5995 |
|
5996 |
|
5997 |
|
5998 |
|
5999 |
|
6000 <div class="meta"> |
|
6001 |
|
6002 |
|
6003 <p>Inherited from |
|
6004 <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>: |
|
6005 |
|
6006 |
|
6007 |
|
6008 <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a> |
|
6009 |
|
6010 </p> |
|
6011 |
|
6012 |
|
6013 |
|
6014 |
|
6015 |
|
6016 </div> |
|
6017 |
|
6018 <div class="description"> |
|
6019 <p>Returns the fully qualified type, given a short type string. |
|
6020 That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p> |
|
6021 |
|
6022 <p>NOTE: This method, unlike _getType, does no checking of the value passed in, and |
|
6023 is designed to be used with the low level _publish() method, for critical path |
|
6024 implementations which need to fast-track publish for performance reasons.</p> |
|
6025 </div> |
|
6026 |
|
6027 |
|
6028 <div class="params"> |
|
6029 <h4>Parameters:</h4> |
|
6030 |
|
6031 <ul class="params-list"> |
|
6032 |
|
6033 <li class="param"> |
|
6034 |
|
6035 <code class="param-name">type</code> |
|
6036 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6037 |
|
6038 |
|
6039 |
|
6040 |
|
6041 <div class="param-description"> |
|
6042 <p>The short type to prefix</p> |
|
6043 </div> |
|
6044 |
|
6045 |
|
6046 </li> |
|
6047 |
|
6048 </ul> |
|
6049 </div> |
|
6050 |
|
6051 |
|
6052 |
|
6053 <div class="returns"> |
|
6054 <h4>Returns:</h4> |
|
6055 |
|
6056 <div class="returns-description"> |
|
6057 |
|
6058 |
|
6059 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6060 |
|
6061 The prefixed type, if a prefix is set, otherwise the type passed in |
|
6062 |
|
6063 </div> |
|
6064 </div> |
|
6065 |
|
6066 |
|
6067 |
|
6068 </div> |
|
6069 |
|
6070 |
|
6071 <div id="method__getHashPath" class="method item protected inherited"> |
|
6072 <h3 class="name"><code>_getHashPath</code></h3> |
|
6073 |
|
6074 |
|
6075 <div class="args"> |
|
6076 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6077 |
|
6078 <li class="arg"> |
|
6079 |
|
6080 <code class="optional">[hash]</code> |
|
6081 |
|
6082 </li> |
|
6083 |
|
6084 </ul><span class="paren">)</span> |
|
6085 </div> |
|
6086 |
|
6087 |
|
6088 |
|
6089 <span class="returns-inline"> |
|
6090 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6091 </span> |
|
6092 |
|
6093 |
|
6094 |
|
6095 |
|
6096 |
|
6097 <span class="flag protected">protected</span> |
|
6098 |
|
6099 |
|
6100 |
|
6101 |
|
6102 |
|
6103 |
|
6104 |
|
6105 |
|
6106 |
|
6107 |
|
6108 <div class="meta"> |
|
6109 |
|
6110 |
|
6111 <p>Inherited from |
|
6112 <a href="../classes/Router.html#method__getHashPath">Router</a>: |
|
6113 |
|
6114 |
|
6115 |
|
6116 <a href="../files/app_js_router.js.html#l697"><code>app/js/router.js:697</code></a> |
|
6117 |
|
6118 </p> |
|
6119 |
|
6120 |
|
6121 |
|
6122 |
|
6123 |
|
6124 </div> |
|
6125 |
|
6126 <div class="description"> |
|
6127 <p>Returns the resolved path from the hash fragment, or an empty string if the |
|
6128 hash is not path-like.</p> |
|
6129 </div> |
|
6130 |
|
6131 |
|
6132 <div class="params"> |
|
6133 <h4>Parameters:</h4> |
|
6134 |
|
6135 <ul class="params-list"> |
|
6136 |
|
6137 <li class="param"> |
|
6138 |
|
6139 <code class="param-name optional">[hash]</code> |
|
6140 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6141 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6142 |
|
6143 |
|
6144 |
|
6145 |
|
6146 <div class="param-description"> |
|
6147 <p>Hash fragment to resolve into a path. By default this |
|
6148 will be the hash from the current URL.</p> |
|
6149 </div> |
|
6150 |
|
6151 |
|
6152 </li> |
|
6153 |
|
6154 </ul> |
|
6155 </div> |
|
6156 |
|
6157 |
|
6158 |
|
6159 <div class="returns"> |
|
6160 <h4>Returns:</h4> |
|
6161 |
|
6162 <div class="returns-description"> |
|
6163 |
|
6164 |
|
6165 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6166 |
|
6167 Current hash path, or an empty string if the hash is empty. |
|
6168 |
|
6169 </div> |
|
6170 </div> |
|
6171 |
|
6172 |
|
6173 |
|
6174 </div> |
|
6175 |
|
6176 |
|
6177 <div id="method__getOrigin" class="method item protected inherited"> |
|
6178 <h3 class="name"><code>_getOrigin</code></h3> |
|
6179 |
|
6180 |
|
6181 <span class="paren">()</span> |
|
6182 |
|
6183 |
|
6184 |
|
6185 <span class="returns-inline"> |
|
6186 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6187 </span> |
|
6188 |
|
6189 |
|
6190 |
|
6191 |
|
6192 |
|
6193 <span class="flag protected">protected</span> |
|
6194 |
|
6195 |
|
6196 |
|
6197 |
|
6198 |
|
6199 |
|
6200 |
|
6201 |
|
6202 |
|
6203 |
|
6204 <div class="meta"> |
|
6205 |
|
6206 |
|
6207 <p>Inherited from |
|
6208 <a href="../classes/Router.html#method__getOrigin">Router</a>: |
|
6209 |
|
6210 |
|
6211 |
|
6212 <a href="../files/app_js_router.js.html#l718"><code>app/js/router.js:718</code></a> |
|
6213 |
|
6214 </p> |
|
6215 |
|
6216 |
|
6217 |
|
6218 |
|
6219 |
|
6220 </div> |
|
6221 |
|
6222 <div class="description"> |
|
6223 <p>Gets the location origin (i.e., protocol, host, and port) as a URL.</p> |
|
6224 </div> |
|
6225 |
|
6226 |
|
6227 |
|
6228 |
|
6229 <div class="returns"> |
|
6230 <h4>Returns:</h4> |
|
6231 |
|
6232 <div class="returns-description"> |
|
6233 |
|
6234 |
|
6235 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6236 |
|
6237 Location origin (i.e., protocol, host, and port). |
|
6238 |
|
6239 </div> |
|
6240 </div> |
|
6241 |
|
6242 |
|
6243 |
|
6244 <div class="example"> |
|
6245 <h4>Example:</h4> |
|
6246 |
|
6247 <div class="example-content"> |
|
6248 <pre class="code prettyprint"><code>http://example.com |
|
6249 </code></pre> |
|
6250 </div> |
|
6251 </div> |
|
6252 |
|
6253 </div> |
|
6254 |
|
6255 |
|
6256 <div id="method__getPath" class="method item protected inherited"> |
|
6257 <h3 class="name"><code>_getPath</code></h3> |
|
6258 |
|
6259 |
|
6260 <span class="paren">()</span> |
|
6261 |
|
6262 |
|
6263 |
|
6264 <span class="returns-inline"> |
|
6265 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6266 </span> |
|
6267 |
|
6268 |
|
6269 |
|
6270 |
|
6271 |
|
6272 <span class="flag protected">protected</span> |
|
6273 |
|
6274 |
|
6275 |
|
6276 |
|
6277 |
|
6278 |
|
6279 |
|
6280 |
|
6281 |
|
6282 |
|
6283 <div class="meta"> |
|
6284 |
|
6285 |
|
6286 <p>Inherited from |
|
6287 <a href="../classes/Router.html#method__getPath">Router</a>: |
|
6288 |
|
6289 |
|
6290 |
|
6291 <a href="../files/app_js_router.js.html#l733"><code>app/js/router.js:733</code></a> |
|
6292 |
|
6293 </p> |
|
6294 |
|
6295 |
|
6296 |
|
6297 |
|
6298 |
|
6299 </div> |
|
6300 |
|
6301 <div class="description"> |
|
6302 <p>Gets the current route path, relative to the <code>root</code> (if any).</p> |
|
6303 </div> |
|
6304 |
|
6305 |
|
6306 |
|
6307 |
|
6308 <div class="returns"> |
|
6309 <h4>Returns:</h4> |
|
6310 |
|
6311 <div class="returns-description"> |
|
6312 |
|
6313 |
|
6314 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6315 |
|
6316 Current route path. |
|
6317 |
|
6318 </div> |
|
6319 </div> |
|
6320 |
|
6321 |
|
6322 |
|
6323 </div> |
|
6324 |
|
6325 |
|
6326 <div id="method__getPathRoot" class="method item protected inherited"> |
|
6327 <h3 class="name"><code>_getPathRoot</code></h3> |
|
6328 |
|
6329 |
|
6330 <span class="paren">()</span> |
|
6331 |
|
6332 |
|
6333 |
|
6334 <span class="returns-inline"> |
|
6335 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6336 </span> |
|
6337 |
|
6338 |
|
6339 |
|
6340 |
|
6341 |
|
6342 <span class="flag protected">protected</span> |
|
6343 |
|
6344 |
|
6345 |
|
6346 |
|
6347 |
|
6348 |
|
6349 |
|
6350 |
|
6351 |
|
6352 |
|
6353 <div class="meta"> |
|
6354 |
|
6355 |
|
6356 <p>Inherited from |
|
6357 <a href="../classes/Router.html#method__getPathRoot">Router</a>: |
|
6358 |
|
6359 |
|
6360 |
|
6361 <a href="../files/app_js_router.js.html#l747"><code>app/js/router.js:747</code></a> |
|
6362 |
|
6363 </p> |
|
6364 |
|
6365 |
|
6366 |
|
6367 |
|
6368 |
|
6369 <p>Available since 3.5.0</p> |
|
6370 |
|
6371 </div> |
|
6372 |
|
6373 <div class="description"> |
|
6374 <p>Returns the current path root after popping off the last path segment, |
|
6375 making it useful for resolving other URL paths against.</p> |
|
6376 |
|
6377 <p>The path root will always begin and end with a '/'.</p> |
|
6378 </div> |
|
6379 |
|
6380 |
|
6381 |
|
6382 |
|
6383 <div class="returns"> |
|
6384 <h4>Returns:</h4> |
|
6385 |
|
6386 <div class="returns-description"> |
|
6387 |
|
6388 |
|
6389 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6390 |
|
6391 The URL's path root. |
|
6392 |
|
6393 </div> |
|
6394 </div> |
|
6395 |
|
6396 |
|
6397 |
|
6398 </div> |
|
6399 |
|
6400 |
|
6401 <div id="method__getQuery" class="method item protected inherited"> |
|
6402 <h3 class="name"><code>_getQuery</code></h3> |
|
6403 |
|
6404 |
|
6405 <span class="paren">()</span> |
|
6406 |
|
6407 |
|
6408 |
|
6409 <span class="returns-inline"> |
|
6410 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6411 </span> |
|
6412 |
|
6413 |
|
6414 |
|
6415 |
|
6416 |
|
6417 <span class="flag protected">protected</span> |
|
6418 |
|
6419 |
|
6420 |
|
6421 |
|
6422 |
|
6423 |
|
6424 |
|
6425 |
|
6426 |
|
6427 |
|
6428 <div class="meta"> |
|
6429 |
|
6430 |
|
6431 <p>Inherited from |
|
6432 <a href="../classes/Router.html#method__getQuery">Router</a>: |
|
6433 |
|
6434 |
|
6435 |
|
6436 <a href="../files/app_js_router.js.html#l773"><code>app/js/router.js:773</code></a> |
|
6437 |
|
6438 </p> |
|
6439 |
|
6440 |
|
6441 |
|
6442 |
|
6443 |
|
6444 </div> |
|
6445 |
|
6446 <div class="description"> |
|
6447 <p>Gets the current route query string.</p> |
|
6448 </div> |
|
6449 |
|
6450 |
|
6451 |
|
6452 |
|
6453 <div class="returns"> |
|
6454 <h4>Returns:</h4> |
|
6455 |
|
6456 <div class="returns-description"> |
|
6457 |
|
6458 |
|
6459 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
6460 |
|
6461 Current route query string. |
|
6462 |
|
6463 </div> |
|
6464 </div> |
|
6465 |
|
6466 |
|
6467 |
|
6468 </div> |
|
6469 |
|
6470 |
|
6471 <div id="method__getRegex" class="method item protected inherited"> |
|
6472 <h3 class="name"><code>_getRegex</code></h3> |
|
6473 |
|
6474 |
|
6475 <div class="args"> |
|
6476 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6477 |
|
6478 <li class="arg"> |
|
6479 |
|
6480 <code>path</code> |
|
6481 |
|
6482 </li> |
|
6483 |
|
6484 <li class="arg"> |
|
6485 |
|
6486 <code>keys</code> |
|
6487 |
|
6488 </li> |
|
6489 |
|
6490 </ul><span class="paren">)</span> |
|
6491 </div> |
|
6492 |
|
6493 |
|
6494 |
|
6495 <span class="returns-inline"> |
|
6496 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
6497 </span> |
|
6498 |
|
6499 |
|
6500 |
|
6501 |
|
6502 |
|
6503 <span class="flag protected">protected</span> |
|
6504 |
|
6505 |
|
6506 |
|
6507 |
|
6508 |
|
6509 |
|
6510 |
|
6511 |
|
6512 |
|
6513 |
|
6514 <div class="meta"> |
|
6515 |
|
6516 |
|
6517 <p>Inherited from |
|
6518 <a href="../classes/Router.html#method__getRegex">Router</a>: |
|
6519 |
|
6520 |
|
6521 |
|
6522 <a href="../files/app_js_router.js.html#l794"><code>app/js/router.js:794</code></a> |
|
6523 |
|
6524 </p> |
|
6525 |
|
6526 |
|
6527 |
|
6528 |
|
6529 |
|
6530 </div> |
|
6531 |
|
6532 <div class="description"> |
|
6533 <p>Creates a regular expression from the given route specification. If <em>path</em> |
|
6534 is already a regex, it will be returned unmodified.</p> |
|
6535 </div> |
|
6536 |
|
6537 |
|
6538 <div class="params"> |
|
6539 <h4>Parameters:</h4> |
|
6540 |
|
6541 <ul class="params-list"> |
|
6542 |
|
6543 <li class="param"> |
|
6544 |
|
6545 <code class="param-name">path</code> |
|
6546 <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> |
|
6547 |
|
6548 |
|
6549 |
|
6550 |
|
6551 <div class="param-description"> |
|
6552 <p>Route path specification.</p> |
|
6553 </div> |
|
6554 |
|
6555 |
|
6556 </li> |
|
6557 |
|
6558 <li class="param"> |
|
6559 |
|
6560 <code class="param-name">keys</code> |
|
6561 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
6562 |
|
6563 |
|
6564 |
|
6565 |
|
6566 <div class="param-description"> |
|
6567 <p>Array reference to which route parameter names will be |
|
6568 added.</p> |
|
6569 </div> |
|
6570 |
|
6571 |
|
6572 </li> |
|
6573 |
|
6574 </ul> |
|
6575 </div> |
|
6576 |
|
6577 |
|
6578 |
|
6579 <div class="returns"> |
|
6580 <h4>Returns:</h4> |
|
6581 |
|
6582 <div class="returns-description"> |
|
6583 |
|
6584 |
|
6585 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>: |
|
6586 |
|
6587 Route regex. |
|
6588 |
|
6589 </div> |
|
6590 </div> |
|
6591 |
|
6592 |
|
6593 |
|
6594 </div> |
|
6595 |
|
6596 |
|
6597 <div id="method__getRequest" class="method item protected inherited"> |
|
6598 <h3 class="name"><code>_getRequest</code></h3> |
|
6599 |
|
6600 |
|
6601 <div class="args"> |
|
6602 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6603 |
|
6604 <li class="arg"> |
|
6605 |
|
6606 <code>path</code> |
|
6607 |
|
6608 </li> |
|
6609 |
|
6610 <li class="arg"> |
|
6611 |
|
6612 <code>url</code> |
|
6613 |
|
6614 </li> |
|
6615 |
|
6616 <li class="arg"> |
|
6617 |
|
6618 <code>src</code> |
|
6619 |
|
6620 </li> |
|
6621 |
|
6622 </ul><span class="paren">)</span> |
|
6623 </div> |
|
6624 |
|
6625 |
|
6626 |
|
6627 <span class="returns-inline"> |
|
6628 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6629 </span> |
|
6630 |
|
6631 |
|
6632 |
|
6633 |
|
6634 |
|
6635 <span class="flag protected">protected</span> |
|
6636 |
|
6637 |
|
6638 |
|
6639 |
|
6640 |
|
6641 |
|
6642 |
|
6643 |
|
6644 |
|
6645 |
|
6646 <div class="meta"> |
|
6647 |
|
6648 |
|
6649 <p>Inherited from |
|
6650 <a href="../classes/Router.html#method__getRequest">Router</a>: |
|
6651 |
|
6652 |
|
6653 |
|
6654 <a href="../files/app_js_router.js.html#l829"><code>app/js/router.js:829</code></a> |
|
6655 |
|
6656 </p> |
|
6657 |
|
6658 |
|
6659 |
|
6660 |
|
6661 |
|
6662 </div> |
|
6663 |
|
6664 <div class="description"> |
|
6665 <p>Gets a request object that can be passed to a route handler.</p> |
|
6666 </div> |
|
6667 |
|
6668 |
|
6669 <div class="params"> |
|
6670 <h4>Parameters:</h4> |
|
6671 |
|
6672 <ul class="params-list"> |
|
6673 |
|
6674 <li class="param"> |
|
6675 |
|
6676 <code class="param-name">path</code> |
|
6677 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6678 |
|
6679 |
|
6680 |
|
6681 |
|
6682 <div class="param-description"> |
|
6683 <p>Current path being dispatched.</p> |
|
6684 </div> |
|
6685 |
|
6686 |
|
6687 </li> |
|
6688 |
|
6689 <li class="param"> |
|
6690 |
|
6691 <code class="param-name">url</code> |
|
6692 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6693 |
|
6694 |
|
6695 |
|
6696 |
|
6697 <div class="param-description"> |
|
6698 <p>Current full URL being dispatched.</p> |
|
6699 </div> |
|
6700 |
|
6701 |
|
6702 </li> |
|
6703 |
|
6704 <li class="param"> |
|
6705 |
|
6706 <code class="param-name">src</code> |
|
6707 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6708 |
|
6709 |
|
6710 |
|
6711 |
|
6712 <div class="param-description"> |
|
6713 <p>What initiated the dispatch.</p> |
|
6714 </div> |
|
6715 |
|
6716 |
|
6717 </li> |
|
6718 |
|
6719 </ul> |
|
6720 </div> |
|
6721 |
|
6722 |
|
6723 |
|
6724 <div class="returns"> |
|
6725 <h4>Returns:</h4> |
|
6726 |
|
6727 <div class="returns-description"> |
|
6728 |
|
6729 |
|
6730 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6731 |
|
6732 Request object. |
|
6733 |
|
6734 </div> |
|
6735 </div> |
|
6736 |
|
6737 |
|
6738 |
|
6739 </div> |
|
6740 |
|
6741 |
|
6742 <div id="method__getResponse" class="method item protected inherited"> |
|
6743 <h3 class="name"><code>_getResponse</code></h3> |
|
6744 |
|
6745 |
|
6746 <div class="args"> |
|
6747 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6748 |
|
6749 <li class="arg"> |
|
6750 |
|
6751 <code>req</code> |
|
6752 |
|
6753 </li> |
|
6754 |
|
6755 </ul><span class="paren">)</span> |
|
6756 </div> |
|
6757 |
|
6758 |
|
6759 |
|
6760 <span class="returns-inline"> |
|
6761 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6762 </span> |
|
6763 |
|
6764 |
|
6765 |
|
6766 |
|
6767 |
|
6768 <span class="flag protected">protected</span> |
|
6769 |
|
6770 |
|
6771 |
|
6772 |
|
6773 |
|
6774 |
|
6775 |
|
6776 |
|
6777 |
|
6778 |
|
6779 <div class="meta"> |
|
6780 |
|
6781 |
|
6782 <p>Inherited from |
|
6783 <a href="../classes/Router.html#method__getResponse">Router</a>: |
|
6784 |
|
6785 |
|
6786 |
|
6787 <a href="../files/app_js_router.js.html#l848"><code>app/js/router.js:848</code></a> |
|
6788 |
|
6789 </p> |
|
6790 |
|
6791 |
|
6792 |
|
6793 |
|
6794 |
|
6795 </div> |
|
6796 |
|
6797 <div class="description"> |
|
6798 <p>Gets a response object that can be passed to a route handler.</p> |
|
6799 </div> |
|
6800 |
|
6801 |
|
6802 <div class="params"> |
|
6803 <h4>Parameters:</h4> |
|
6804 |
|
6805 <ul class="params-list"> |
|
6806 |
|
6807 <li class="param"> |
|
6808 |
|
6809 <code class="param-name">req</code> |
|
6810 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6811 |
|
6812 |
|
6813 |
|
6814 |
|
6815 <div class="param-description"> |
|
6816 <p>Request object.</p> |
|
6817 </div> |
|
6818 |
|
6819 |
|
6820 </li> |
|
6821 |
|
6822 </ul> |
|
6823 </div> |
|
6824 |
|
6825 |
|
6826 |
|
6827 <div class="returns"> |
|
6828 <h4>Returns:</h4> |
|
6829 |
|
6830 <div class="returns-description"> |
|
6831 |
|
6832 |
|
6833 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6834 |
|
6835 Response Object. |
|
6836 |
|
6837 </div> |
|
6838 </div> |
|
6839 |
|
6840 |
|
6841 |
|
6842 </div> |
|
6843 |
|
6844 |
|
6845 <div id="method__getRoutes" class="method item protected inherited"> |
|
6846 <h3 class="name"><code>_getRoutes</code></h3> |
|
6847 |
|
6848 |
|
6849 <span class="paren">()</span> |
|
6850 |
|
6851 |
|
6852 |
|
6853 <span class="returns-inline"> |
|
6854 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
6855 </span> |
|
6856 |
|
6857 |
|
6858 |
|
6859 |
|
6860 |
|
6861 <span class="flag protected">protected</span> |
|
6862 |
|
6863 |
|
6864 |
|
6865 |
|
6866 |
|
6867 |
|
6868 |
|
6869 |
|
6870 |
|
6871 |
|
6872 <div class="meta"> |
|
6873 |
|
6874 |
|
6875 <p>Inherited from |
|
6876 <a href="../classes/Router.html#method__getRoutes">Router</a>: |
|
6877 |
|
6878 |
|
6879 |
|
6880 <a href="../files/app_js_router.js.html#l867"><code>app/js/router.js:867</code></a> |
|
6881 |
|
6882 </p> |
|
6883 |
|
6884 |
|
6885 |
|
6886 |
|
6887 |
|
6888 </div> |
|
6889 |
|
6890 <div class="description"> |
|
6891 <p>Getter for the <code>routes</code> attribute.</p> |
|
6892 </div> |
|
6893 |
|
6894 |
|
6895 |
|
6896 |
|
6897 <div class="returns"> |
|
6898 <h4>Returns:</h4> |
|
6899 |
|
6900 <div class="returns-description"> |
|
6901 |
|
6902 |
|
6903 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
6904 |
|
6905 Array of route objects. |
|
6906 |
|
6907 </div> |
|
6908 </div> |
|
6909 |
|
6910 |
|
6911 |
|
6912 </div> |
|
6913 |
|
6914 |
|
6915 <div id="method__getStateVal" class="method item private inherited"> |
|
6916 <h3 class="name"><code>_getStateVal</code></h3> |
|
6917 |
|
6918 |
|
6919 <div class="args"> |
|
6920 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6921 |
|
6922 <li class="arg"> |
|
6923 |
|
6924 <code>name</code> |
|
6925 |
|
6926 </li> |
|
6927 |
|
6928 <li class="arg"> |
|
6929 |
|
6930 <code class="optional">[cfg]</code> |
|
6931 |
|
6932 </li> |
|
6933 |
|
6934 </ul><span class="paren">)</span> |
|
6935 </div> |
|
6936 |
|
6937 |
|
6938 |
|
6939 <span class="returns-inline"> |
|
6940 <span class="type">Any</span> |
|
6941 </span> |
|
6942 |
|
6943 |
|
6944 |
|
6945 |
|
6946 |
|
6947 <span class="flag private">private</span> |
|
6948 |
|
6949 |
|
6950 |
|
6951 |
|
6952 |
|
6953 |
|
6954 |
|
6955 |
|
6956 |
|
6957 |
|
6958 <div class="meta"> |
|
6959 |
|
6960 |
|
6961 <p>Inherited from |
|
6962 <a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>: |
|
6963 |
|
6964 |
|
6965 |
|
6966 <a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a> |
|
6967 |
|
6968 </p> |
|
6969 |
|
6970 |
|
6971 |
|
6972 |
|
6973 |
|
6974 </div> |
|
6975 |
|
6976 <div class="description"> |
|
6977 <p>Gets the stored value for the attribute, from either the |
|
6978 internal state object, or the state proxy if it exits</p> |
|
6979 </div> |
|
6980 |
|
6981 |
|
6982 <div class="params"> |
|
6983 <h4>Parameters:</h4> |
|
6984 |
|
6985 <ul class="params-list"> |
|
6986 |
|
6987 <li class="param"> |
|
6988 |
|
6989 <code class="param-name">name</code> |
|
6990 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6991 |
|
6992 |
|
6993 |
|
6994 |
|
6995 <div class="param-description"> |
|
6996 <p>The name of the attribute</p> |
|
6997 </div> |
|
6998 |
|
6999 |
|
7000 </li> |
|
7001 |
|
7002 <li class="param"> |
|
7003 |
|
7004 <code class="param-name optional">[cfg]</code> |
|
7005 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7006 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7007 |
|
7008 |
|
7009 |
|
7010 |
|
7011 <div class="param-description"> |
|
7012 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
7013 where the calling method has already obtained the config from state.</p> |
|
7014 </div> |
|
7015 |
|
7016 |
|
7017 </li> |
|
7018 |
|
7019 </ul> |
|
7020 </div> |
|
7021 |
|
7022 |
|
7023 |
|
7024 <div class="returns"> |
|
7025 <h4>Returns:</h4> |
|
7026 |
|
7027 <div class="returns-description"> |
|
7028 |
|
7029 |
|
7030 <span class="type">Any</span>: |
|
7031 |
|
7032 The stored value of the attribute |
|
7033 |
|
7034 </div> |
|
7035 </div> |
|
7036 |
|
7037 |
|
7038 |
|
7039 </div> |
|
7040 |
|
7041 |
|
7042 <div id="method__getType" class="method item private inherited"> |
|
7043 <h3 class="name"><code>_getType</code></h3> |
|
7044 |
|
7045 |
|
7046 <span class="paren">()</span> |
|
7047 |
|
7048 |
|
7049 |
|
7050 |
|
7051 |
|
7052 |
|
7053 |
|
7054 <span class="flag private">private</span> |
|
7055 |
|
7056 |
|
7057 |
|
7058 |
|
7059 |
|
7060 |
|
7061 |
|
7062 |
|
7063 |
|
7064 |
|
7065 <div class="meta"> |
|
7066 |
|
7067 |
|
7068 <p>Inherited from |
|
7069 <a href="../classes/EventTarget.html#method__getType">EventTarget</a>: |
|
7070 |
|
7071 |
|
7072 |
|
7073 <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a> |
|
7074 |
|
7075 </p> |
|
7076 |
|
7077 |
|
7078 |
|
7079 |
|
7080 |
|
7081 </div> |
|
7082 |
|
7083 <div class="description"> |
|
7084 <p>If the instance has a prefix attribute and the |
|
7085 event type is not prefixed, the instance prefix is |
|
7086 applied to the supplied type.</p> |
|
7087 </div> |
|
7088 |
|
7089 |
|
7090 |
|
7091 |
|
7092 |
|
7093 |
|
7094 </div> |
|
7095 |
|
7096 |
|
7097 <div id="method__getURL" class="method item protected inherited"> |
|
7098 <h3 class="name"><code>_getURL</code></h3> |
|
7099 |
|
7100 |
|
7101 <span class="paren">()</span> |
|
7102 |
|
7103 |
|
7104 |
|
7105 <span class="returns-inline"> |
|
7106 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7107 </span> |
|
7108 |
|
7109 |
|
7110 |
|
7111 |
|
7112 |
|
7113 <span class="flag protected">protected</span> |
|
7114 |
|
7115 |
|
7116 |
|
7117 |
|
7118 |
|
7119 |
|
7120 |
|
7121 |
|
7122 |
|
7123 |
|
7124 <div class="meta"> |
|
7125 |
|
7126 |
|
7127 <p>Inherited from |
|
7128 <a href="../classes/Router.html#method__getURL">Router</a>: |
|
7129 |
|
7130 |
|
7131 |
|
7132 <a href="../files/app_js_router.js.html#l878"><code>app/js/router.js:878</code></a> |
|
7133 |
|
7134 </p> |
|
7135 |
|
7136 |
|
7137 |
|
7138 |
|
7139 |
|
7140 </div> |
|
7141 |
|
7142 <div class="description"> |
|
7143 <p>Gets the current full URL.</p> |
|
7144 </div> |
|
7145 |
|
7146 |
|
7147 |
|
7148 |
|
7149 <div class="returns"> |
|
7150 <h4>Returns:</h4> |
|
7151 |
|
7152 <div class="returns-description"> |
|
7153 |
|
7154 |
|
7155 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
7156 |
|
7157 URL. |
|
7158 |
|
7159 </div> |
|
7160 </div> |
|
7161 |
|
7162 |
|
7163 |
|
7164 </div> |
|
7165 |
|
7166 |
|
7167 <div id="method__getViewContainer" class="method item protected"> |
|
7168 <h3 class="name"><code>_getViewContainer</code></h3> |
|
7169 |
|
7170 |
|
7171 <div class="args"> |
|
7172 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7173 |
|
7174 <li class="arg"> |
|
7175 |
|
7176 <code>value</code> |
|
7177 |
|
7178 </li> |
|
7179 |
|
7180 </ul><span class="paren">)</span> |
|
7181 </div> |
|
7182 |
|
7183 |
|
7184 |
|
7185 <span class="returns-inline"> |
|
7186 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
7187 </span> |
|
7188 |
|
7189 |
|
7190 |
|
7191 |
|
7192 |
|
7193 <span class="flag protected">protected</span> |
|
7194 |
|
7195 |
|
7196 |
|
7197 |
|
7198 |
|
7199 |
|
7200 |
|
7201 |
|
7202 |
|
7203 |
|
7204 <div class="meta"> |
|
7205 |
|
7206 |
|
7207 |
|
7208 <p> |
|
7209 |
|
7210 Defined in |
|
7211 |
|
7212 |
|
7213 |
|
7214 |
|
7215 <a href="../files/app_js_app-base.js.html#l555"><code>app/js/app-base.js:555</code></a> |
|
7216 |
|
7217 </p> |
|
7218 |
|
7219 |
|
7220 |
|
7221 |
|
7222 |
|
7223 <p>Available since 3.5.0</p> |
|
7224 |
|
7225 </div> |
|
7226 |
|
7227 <div class="description"> |
|
7228 <p>Getter for the <code>viewContainer</code> attribute.</p> |
|
7229 </div> |
|
7230 |
|
7231 |
|
7232 <div class="params"> |
|
7233 <h4>Parameters:</h4> |
|
7234 |
|
7235 <ul class="params-list"> |
|
7236 |
|
7237 <li class="param"> |
|
7238 |
|
7239 <code class="param-name">value</code> |
|
7240 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span> |
|
7241 |
|
7242 |
|
7243 |
|
7244 |
|
7245 <div class="param-description"> |
|
7246 <p>Current attribute value.</p> |
|
7247 </div> |
|
7248 |
|
7249 |
|
7250 </li> |
|
7251 |
|
7252 </ul> |
|
7253 </div> |
|
7254 |
|
7255 |
|
7256 |
|
7257 <div class="returns"> |
|
7258 <h4>Returns:</h4> |
|
7259 |
|
7260 <div class="returns-description"> |
|
7261 |
|
7262 |
|
7263 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
7264 |
|
7265 View container node. |
|
7266 |
|
7267 </div> |
|
7268 </div> |
|
7269 |
|
7270 |
|
7271 |
|
7272 </div> |
|
7273 |
|
7274 |
|
7275 <div id="method__hasSameOrigin" class="method item protected inherited"> |
|
7276 <h3 class="name"><code>_hasSameOrigin</code></h3> |
|
7277 |
|
7278 |
|
7279 <div class="args"> |
|
7280 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7281 |
|
7282 <li class="arg"> |
|
7283 |
|
7284 <code>url</code> |
|
7285 |
|
7286 </li> |
|
7287 |
|
7288 </ul><span class="paren">)</span> |
|
7289 </div> |
|
7290 |
|
7291 |
|
7292 |
|
7293 <span class="returns-inline"> |
|
7294 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7295 </span> |
|
7296 |
|
7297 |
|
7298 |
|
7299 |
|
7300 |
|
7301 <span class="flag protected">protected</span> |
|
7302 |
|
7303 |
|
7304 |
|
7305 |
|
7306 |
|
7307 |
|
7308 |
|
7309 |
|
7310 |
|
7311 |
|
7312 <div class="meta"> |
|
7313 |
|
7314 |
|
7315 <p>Inherited from |
|
7316 <a href="../classes/Router.html#method__hasSameOrigin">Router</a>: |
|
7317 |
|
7318 |
|
7319 |
|
7320 <a href="../files/app_js_router.js.html#l895"><code>app/js/router.js:895</code></a> |
|
7321 |
|
7322 </p> |
|
7323 |
|
7324 |
|
7325 |
|
7326 |
|
7327 |
|
7328 </div> |
|
7329 |
|
7330 <div class="description"> |
|
7331 <p>Returns <code>true</code> when the specified <code>url</code> is from the same origin as the |
|
7332 current URL; i.e., the protocol, host, and port of the URLs are the same.</p> |
|
7333 |
|
7334 <p>All host or path relative URLs are of the same origin. A scheme-relative URL |
|
7335 is first prefixed with the current scheme before being evaluated.</p> |
|
7336 </div> |
|
7337 |
|
7338 |
|
7339 <div class="params"> |
|
7340 <h4>Parameters:</h4> |
|
7341 |
|
7342 <ul class="params-list"> |
|
7343 |
|
7344 <li class="param"> |
|
7345 |
|
7346 <code class="param-name">url</code> |
|
7347 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7348 |
|
7349 |
|
7350 |
|
7351 |
|
7352 <div class="param-description"> |
|
7353 <p>URL to compare origin with the current URL.</p> |
|
7354 </div> |
|
7355 |
|
7356 |
|
7357 </li> |
|
7358 |
|
7359 </ul> |
|
7360 </div> |
|
7361 |
|
7362 |
|
7363 |
|
7364 <div class="returns"> |
|
7365 <h4>Returns:</h4> |
|
7366 |
|
7367 <div class="returns-description"> |
|
7368 |
|
7369 |
|
7370 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7371 |
|
7372 Whether the URL has the same origin of the current URL. |
|
7373 |
|
7374 </div> |
|
7375 </div> |
|
7376 |
|
7377 |
|
7378 |
|
7379 </div> |
|
7380 |
|
7381 |
|
7382 <div id="method__initAttrHost" class="method item private inherited"> |
|
7383 <h3 class="name"><code>_initAttrHost</code></h3> |
|
7384 |
|
7385 |
|
7386 <div class="args"> |
|
7387 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7388 |
|
7389 <li class="arg"> |
|
7390 |
|
7391 <code>attrs</code> |
|
7392 |
|
7393 </li> |
|
7394 |
|
7395 <li class="arg"> |
|
7396 |
|
7397 <code>values</code> |
|
7398 |
|
7399 </li> |
|
7400 |
|
7401 <li class="arg"> |
|
7402 |
|
7403 <code>lazy</code> |
|
7404 |
|
7405 </li> |
|
7406 |
|
7407 </ul><span class="paren">)</span> |
|
7408 </div> |
|
7409 |
|
7410 |
|
7411 |
|
7412 |
|
7413 |
|
7414 |
|
7415 |
|
7416 <span class="flag private">private</span> |
|
7417 |
|
7418 |
|
7419 |
|
7420 |
|
7421 |
|
7422 |
|
7423 |
|
7424 |
|
7425 |
|
7426 |
|
7427 <div class="meta"> |
|
7428 |
|
7429 |
|
7430 <p>Inherited from |
|
7431 <a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>: |
|
7432 |
|
7433 |
|
7434 |
|
7435 <a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a> |
|
7436 |
|
7437 </p> |
|
7438 |
|
7439 |
|
7440 |
|
7441 |
|
7442 |
|
7443 </div> |
|
7444 |
|
7445 <div class="description"> |
|
7446 <p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the |
|
7447 constructor.</p> |
|
7448 </div> |
|
7449 |
|
7450 |
|
7451 <div class="params"> |
|
7452 <h4>Parameters:</h4> |
|
7453 |
|
7454 <ul class="params-list"> |
|
7455 |
|
7456 <li class="param"> |
|
7457 |
|
7458 <code class="param-name">attrs</code> |
|
7459 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7460 |
|
7461 |
|
7462 |
|
7463 |
|
7464 <div class="param-description"> |
|
7465 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
7466 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
7467 </div> |
|
7468 |
|
7469 |
|
7470 </li> |
|
7471 |
|
7472 <li class="param"> |
|
7473 |
|
7474 <code class="param-name">values</code> |
|
7475 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7476 |
|
7477 |
|
7478 |
|
7479 |
|
7480 <div class="param-description"> |
|
7481 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
7482 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
7483 </div> |
|
7484 |
|
7485 |
|
7486 </li> |
|
7487 |
|
7488 <li class="param"> |
|
7489 |
|
7490 <code class="param-name">lazy</code> |
|
7491 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7492 |
|
7493 |
|
7494 |
|
7495 |
|
7496 <div class="param-description"> |
|
7497 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
7498 </div> |
|
7499 |
|
7500 |
|
7501 </li> |
|
7502 |
|
7503 </ul> |
|
7504 </div> |
|
7505 |
|
7506 |
|
7507 |
|
7508 |
|
7509 |
|
7510 </div> |
|
7511 |
|
7512 |
|
7513 <div id="method__initAttribute" class="method item private inherited"> |
|
7514 <h3 class="name"><code>_initAttribute</code></h3> |
|
7515 |
|
7516 |
|
7517 <span class="paren">()</span> |
|
7518 |
|
7519 |
|
7520 |
|
7521 |
|
7522 |
|
7523 |
|
7524 |
|
7525 <span class="flag private">private</span> |
|
7526 |
|
7527 |
|
7528 |
|
7529 |
|
7530 |
|
7531 |
|
7532 |
|
7533 |
|
7534 |
|
7535 |
|
7536 <div class="meta"> |
|
7537 |
|
7538 <p>Inherited from |
|
7539 <a href="../classes/BaseObservable.html#method__initAttribute"> |
|
7540 BaseObservable |
|
7541 </a> |
|
7542 |
|
7543 but overwritten in |
|
7544 |
|
7545 |
|
7546 |
|
7547 <a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a> |
|
7548 |
|
7549 </p> |
|
7550 |
|
7551 |
|
7552 |
|
7553 |
|
7554 |
|
7555 </div> |
|
7556 |
|
7557 <div class="description"> |
|
7558 <p>Initializes AttributeCore</p> |
|
7559 </div> |
|
7560 |
|
7561 |
|
7562 |
|
7563 |
|
7564 |
|
7565 |
|
7566 </div> |
|
7567 |
|
7568 |
|
7569 <div id="method__initAttrs" class="method item protected inherited"> |
|
7570 <h3 class="name"><code>_initAttrs</code></h3> |
|
7571 |
|
7572 |
|
7573 <div class="args"> |
|
7574 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7575 |
|
7576 <li class="arg"> |
|
7577 |
|
7578 <code>attrs</code> |
|
7579 |
|
7580 </li> |
|
7581 |
|
7582 <li class="arg"> |
|
7583 |
|
7584 <code>values</code> |
|
7585 |
|
7586 </li> |
|
7587 |
|
7588 <li class="arg"> |
|
7589 |
|
7590 <code>lazy</code> |
|
7591 |
|
7592 </li> |
|
7593 |
|
7594 </ul><span class="paren">)</span> |
|
7595 </div> |
|
7596 |
|
7597 |
|
7598 |
|
7599 |
|
7600 |
|
7601 |
|
7602 |
|
7603 <span class="flag protected">protected</span> |
|
7604 |
|
7605 |
|
7606 |
|
7607 |
|
7608 |
|
7609 |
|
7610 |
|
7611 |
|
7612 |
|
7613 |
|
7614 <div class="meta"> |
|
7615 |
|
7616 |
|
7617 <p>Inherited from |
|
7618 <a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>: |
|
7619 |
|
7620 |
|
7621 |
|
7622 <a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a> |
|
7623 |
|
7624 </p> |
|
7625 |
|
7626 |
|
7627 |
|
7628 |
|
7629 |
|
7630 </div> |
|
7631 |
|
7632 <div class="description"> |
|
7633 <p>Utility method to set up initial attributes defined during construction, |
|
7634 either through the constructor.ATTRS property, or explicitly passed in.</p> |
|
7635 </div> |
|
7636 |
|
7637 |
|
7638 <div class="params"> |
|
7639 <h4>Parameters:</h4> |
|
7640 |
|
7641 <ul class="params-list"> |
|
7642 |
|
7643 <li class="param"> |
|
7644 |
|
7645 <code class="param-name">attrs</code> |
|
7646 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7647 |
|
7648 |
|
7649 |
|
7650 |
|
7651 <div class="param-description"> |
|
7652 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
7653 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
7654 </div> |
|
7655 |
|
7656 |
|
7657 </li> |
|
7658 |
|
7659 <li class="param"> |
|
7660 |
|
7661 <code class="param-name">values</code> |
|
7662 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7663 |
|
7664 |
|
7665 |
|
7666 |
|
7667 <div class="param-description"> |
|
7668 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
7669 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
7670 </div> |
|
7671 |
|
7672 |
|
7673 </li> |
|
7674 |
|
7675 <li class="param"> |
|
7676 |
|
7677 <code class="param-name">lazy</code> |
|
7678 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7679 |
|
7680 |
|
7681 |
|
7682 |
|
7683 <div class="param-description"> |
|
7684 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
7685 </div> |
|
7686 |
|
7687 |
|
7688 </li> |
|
7689 |
|
7690 </ul> |
|
7691 </div> |
|
7692 |
|
7693 |
|
7694 |
|
7695 |
|
7696 |
|
7697 </div> |
|
7698 |
|
7699 |
|
7700 <div id="method__initBase" class="method item private inherited"> |
|
7701 <h3 class="name"><code>_initBase</code></h3> |
|
7702 |
|
7703 |
|
7704 <div class="args"> |
|
7705 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7706 |
|
7707 <li class="arg"> |
|
7708 |
|
7709 <code>config</code> |
|
7710 |
|
7711 </li> |
|
7712 |
|
7713 </ul><span class="paren">)</span> |
|
7714 </div> |
|
7715 |
|
7716 |
|
7717 |
|
7718 |
|
7719 |
|
7720 |
|
7721 |
|
7722 <span class="flag private">private</span> |
|
7723 |
|
7724 |
|
7725 |
|
7726 |
|
7727 |
|
7728 |
|
7729 |
|
7730 |
|
7731 |
|
7732 |
|
7733 <div class="meta"> |
|
7734 |
|
7735 |
|
7736 <p>Inherited from |
|
7737 <a href="../classes/BaseCore.html#method__initBase">BaseCore</a>: |
|
7738 |
|
7739 |
|
7740 |
|
7741 <a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a> |
|
7742 |
|
7743 </p> |
|
7744 |
|
7745 |
|
7746 |
|
7747 |
|
7748 |
|
7749 </div> |
|
7750 |
|
7751 <div class="description"> |
|
7752 <p>Internal construction logic for BaseCore.</p> |
|
7753 </div> |
|
7754 |
|
7755 |
|
7756 <div class="params"> |
|
7757 <h4>Parameters:</h4> |
|
7758 |
|
7759 <ul class="params-list"> |
|
7760 |
|
7761 <li class="param"> |
|
7762 |
|
7763 <code class="param-name">config</code> |
|
7764 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7765 |
|
7766 |
|
7767 |
|
7768 |
|
7769 <div class="param-description"> |
|
7770 <p>The constructor configuration object</p> |
|
7771 </div> |
|
7772 |
|
7773 |
|
7774 </li> |
|
7775 |
|
7776 </ul> |
|
7777 </div> |
|
7778 |
|
7779 |
|
7780 |
|
7781 |
|
7782 |
|
7783 </div> |
|
7784 |
|
7785 |
|
7786 <div id="method__initHierarchy" class="method item private inherited"> |
|
7787 <h3 class="name"><code>_initHierarchy</code></h3> |
|
7788 |
|
7789 |
|
7790 <div class="args"> |
|
7791 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7792 |
|
7793 <li class="arg"> |
|
7794 |
|
7795 <code>userVals</code> |
|
7796 |
|
7797 </li> |
|
7798 |
|
7799 </ul><span class="paren">)</span> |
|
7800 </div> |
|
7801 |
|
7802 |
|
7803 |
|
7804 |
|
7805 |
|
7806 |
|
7807 |
|
7808 <span class="flag private">private</span> |
|
7809 |
|
7810 |
|
7811 |
|
7812 |
|
7813 |
|
7814 |
|
7815 |
|
7816 |
|
7817 |
|
7818 |
|
7819 <div class="meta"> |
|
7820 |
|
7821 |
|
7822 <p>Inherited from |
|
7823 <a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>: |
|
7824 |
|
7825 |
|
7826 |
|
7827 <a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a> |
|
7828 |
|
7829 </p> |
|
7830 |
|
7831 |
|
7832 |
|
7833 |
|
7834 |
|
7835 </div> |
|
7836 |
|
7837 <div class="description"> |
|
7838 <p>Initializes the class hierarchy for the instance, which includes |
|
7839 initializing attributes for each class defined in the class's |
|
7840 static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and |
|
7841 invoking the initializer method on the prototype of each class in the hierarchy.</p> |
|
7842 </div> |
|
7843 |
|
7844 |
|
7845 <div class="params"> |
|
7846 <h4>Parameters:</h4> |
|
7847 |
|
7848 <ul class="params-list"> |
|
7849 |
|
7850 <li class="param"> |
|
7851 |
|
7852 <code class="param-name">userVals</code> |
|
7853 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7854 |
|
7855 |
|
7856 |
|
7857 |
|
7858 <div class="param-description"> |
|
7859 <p>Object with configuration property name/value pairs</p> |
|
7860 </div> |
|
7861 |
|
7862 |
|
7863 </li> |
|
7864 |
|
7865 </ul> |
|
7866 </div> |
|
7867 |
|
7868 |
|
7869 |
|
7870 |
|
7871 |
|
7872 </div> |
|
7873 |
|
7874 |
|
7875 <div id="method__initHierarchyData" class="method item private inherited"> |
|
7876 <h3 class="name"><code>_initHierarchyData</code></h3> |
|
7877 |
|
7878 |
|
7879 <span class="paren">()</span> |
|
7880 |
|
7881 |
|
7882 |
|
7883 |
|
7884 |
|
7885 |
|
7886 |
|
7887 <span class="flag private">private</span> |
|
7888 |
|
7889 |
|
7890 |
|
7891 |
|
7892 |
|
7893 |
|
7894 |
|
7895 |
|
7896 |
|
7897 |
|
7898 <div class="meta"> |
|
7899 |
|
7900 |
|
7901 <p>Inherited from |
|
7902 <a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>: |
|
7903 |
|
7904 |
|
7905 |
|
7906 <a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a> |
|
7907 |
|
7908 </p> |
|
7909 |
|
7910 |
|
7911 |
|
7912 |
|
7913 |
|
7914 </div> |
|
7915 |
|
7916 <div class="description"> |
|
7917 <p>A helper method used by _getClasses and _getAttrCfgs, which determines both |
|
7918 the array of classes and aggregate set of attribute configurations |
|
7919 across the class hierarchy for the instance.</p> |
|
7920 </div> |
|
7921 |
|
7922 |
|
7923 |
|
7924 |
|
7925 |
|
7926 |
|
7927 </div> |
|
7928 |
|
7929 |
|
7930 <div id="method__initHtml5" class="method item protected"> |
|
7931 <h3 class="name"><code>_initHtml5</code></h3> |
|
7932 |
|
7933 |
|
7934 <span class="paren">()</span> |
|
7935 |
|
7936 |
|
7937 |
|
7938 <span class="returns-inline"> |
|
7939 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7940 </span> |
|
7941 |
|
7942 |
|
7943 |
|
7944 |
|
7945 |
|
7946 <span class="flag protected">protected</span> |
|
7947 |
|
7948 |
|
7949 |
|
7950 |
|
7951 |
|
7952 |
|
7953 |
|
7954 |
|
7955 |
|
7956 |
|
7957 <div class="meta"> |
|
7958 |
|
7959 |
|
7960 |
|
7961 <p> |
|
7962 |
|
7963 Defined in |
|
7964 |
|
7965 |
|
7966 |
|
7967 |
|
7968 <a href="../files/app_js_app-base.js.html#l580"><code>app/js/app-base.js:580</code></a> |
|
7969 |
|
7970 </p> |
|
7971 |
|
7972 |
|
7973 |
|
7974 |
|
7975 |
|
7976 <p>Available since 3.5.0</p> |
|
7977 |
|
7978 </div> |
|
7979 |
|
7980 <div class="description"> |
|
7981 <p>Provides the default value for the <code>html5</code> attribute.</p> |
|
7982 |
|
7983 <p>The value returned is dependent on the value of the <code>serverRouting</code> |
|
7984 attribute. When <code>serverRouting</code> is explicit set to <code>false</code> (not just falsy), |
|
7985 the default value for <code>html5</code> will be set to <code>false</code> for <em>all</em> browsers.</p> |
|
7986 |
|
7987 <p>When <code>serverRouting</code> is <code>true</code> or <code>undefined</code> the returned value will be |
|
7988 dependent on the browser's capability of using HTML5 history.</p> |
|
7989 </div> |
|
7990 |
|
7991 |
|
7992 |
|
7993 |
|
7994 <div class="returns"> |
|
7995 <h4>Returns:</h4> |
|
7996 |
|
7997 <div class="returns-description"> |
|
7998 |
|
7999 |
|
8000 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
8001 |
|
8002 Whether or not HTML5 history should be used. |
|
8003 |
|
8004 </div> |
|
8005 </div> |
|
8006 |
|
8007 |
|
8008 |
|
8009 </div> |
|
8010 |
|
8011 |
|
8012 <div id="method__isChildView" class="method item protected"> |
|
8013 <h3 class="name"><code>_isChildView</code></h3> |
|
8014 |
|
8015 |
|
8016 <div class="args"> |
|
8017 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8018 |
|
8019 <li class="arg"> |
|
8020 |
|
8021 <code>view</code> |
|
8022 |
|
8023 </li> |
|
8024 |
|
8025 <li class="arg"> |
|
8026 |
|
8027 <code>parent</code> |
|
8028 |
|
8029 </li> |
|
8030 |
|
8031 </ul><span class="paren">)</span> |
|
8032 </div> |
|
8033 |
|
8034 |
|
8035 |
|
8036 <span class="returns-inline"> |
|
8037 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8038 </span> |
|
8039 |
|
8040 |
|
8041 |
|
8042 |
|
8043 |
|
8044 <span class="flag protected">protected</span> |
|
8045 |
|
8046 |
|
8047 |
|
8048 |
|
8049 |
|
8050 |
|
8051 |
|
8052 |
|
8053 |
|
8054 |
|
8055 <div class="meta"> |
|
8056 |
|
8057 |
|
8058 |
|
8059 <p> |
|
8060 |
|
8061 Defined in |
|
8062 |
|
8063 |
|
8064 |
|
8065 |
|
8066 <a href="../files/app_js_app-base.js.html#l606"><code>app/js/app-base.js:606</code></a> |
|
8067 |
|
8068 </p> |
|
8069 |
|
8070 |
|
8071 |
|
8072 |
|
8073 |
|
8074 <p>Available since 3.5.0</p> |
|
8075 |
|
8076 </div> |
|
8077 |
|
8078 <div class="description"> |
|
8079 <p>Determines if the specified <code>view</code> is configured as a child of the specified |
|
8080 <code>parent</code> view. This requires both views to be either named-views, or view |
|
8081 instances created using configuration data that exists in the <code>views</code> |
|
8082 object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p> |
|
8083 </div> |
|
8084 |
|
8085 |
|
8086 <div class="params"> |
|
8087 <h4>Parameters:</h4> |
|
8088 |
|
8089 <ul class="params-list"> |
|
8090 |
|
8091 <li class="param"> |
|
8092 |
|
8093 <code class="param-name">view</code> |
|
8094 <span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8095 |
|
8096 |
|
8097 |
|
8098 |
|
8099 <div class="param-description"> |
|
8100 <p>The name of a view defined in the <code>views</code> object, |
|
8101 or a view instance.</p> |
|
8102 </div> |
|
8103 |
|
8104 |
|
8105 </li> |
|
8106 |
|
8107 <li class="param"> |
|
8108 |
|
8109 <code class="param-name">parent</code> |
|
8110 <span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8111 |
|
8112 |
|
8113 |
|
8114 |
|
8115 <div class="param-description"> |
|
8116 <p>The name of a view defined in the <code>views</code> |
|
8117 object, or a view instance.</p> |
|
8118 </div> |
|
8119 |
|
8120 |
|
8121 </li> |
|
8122 |
|
8123 </ul> |
|
8124 </div> |
|
8125 |
|
8126 |
|
8127 |
|
8128 <div class="returns"> |
|
8129 <h4>Returns:</h4> |
|
8130 |
|
8131 <div class="returns-description"> |
|
8132 |
|
8133 |
|
8134 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
8135 |
|
8136 Whether the view is configured as a child of the parent. |
|
8137 |
|
8138 </div> |
|
8139 </div> |
|
8140 |
|
8141 |
|
8142 |
|
8143 </div> |
|
8144 |
|
8145 |
|
8146 <div id="method__isLazyAttr" class="method item private inherited"> |
|
8147 <h3 class="name"><code>_isLazyAttr</code></h3> |
|
8148 |
|
8149 |
|
8150 <div class="args"> |
|
8151 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8152 |
|
8153 <li class="arg"> |
|
8154 |
|
8155 <code>name</code> |
|
8156 |
|
8157 </li> |
|
8158 |
|
8159 </ul><span class="paren">)</span> |
|
8160 </div> |
|
8161 |
|
8162 |
|
8163 |
|
8164 <span class="returns-inline"> |
|
8165 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8166 </span> |
|
8167 |
|
8168 |
|
8169 |
|
8170 |
|
8171 |
|
8172 <span class="flag private">private</span> |
|
8173 |
|
8174 |
|
8175 |
|
8176 |
|
8177 |
|
8178 |
|
8179 |
|
8180 |
|
8181 |
|
8182 |
|
8183 <div class="meta"> |
|
8184 |
|
8185 |
|
8186 <p>Inherited from |
|
8187 <a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>: |
|
8188 |
|
8189 |
|
8190 |
|
8191 <a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a> |
|
8192 |
|
8193 </p> |
|
8194 |
|
8195 |
|
8196 |
|
8197 |
|
8198 |
|
8199 </div> |
|
8200 |
|
8201 <div class="description"> |
|
8202 <p>Checks whether or not the attribute is one which has been |
|
8203 added lazily and still requires initialization.</p> |
|
8204 </div> |
|
8205 |
|
8206 |
|
8207 <div class="params"> |
|
8208 <h4>Parameters:</h4> |
|
8209 |
|
8210 <ul class="params-list"> |
|
8211 |
|
8212 <li class="param"> |
|
8213 |
|
8214 <code class="param-name">name</code> |
|
8215 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8216 |
|
8217 |
|
8218 |
|
8219 |
|
8220 <div class="param-description"> |
|
8221 <p>The name of the attribute</p> |
|
8222 </div> |
|
8223 |
|
8224 |
|
8225 </li> |
|
8226 |
|
8227 </ul> |
|
8228 </div> |
|
8229 |
|
8230 |
|
8231 |
|
8232 <div class="returns"> |
|
8233 <h4>Returns:</h4> |
|
8234 |
|
8235 <div class="returns-description"> |
|
8236 |
|
8237 |
|
8238 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
8239 |
|
8240 true if it's a lazily added attribute, false otherwise. |
|
8241 |
|
8242 </div> |
|
8243 </div> |
|
8244 |
|
8245 |
|
8246 |
|
8247 </div> |
|
8248 |
|
8249 |
|
8250 <div id="method__isLinkSameOrigin" class="method item protected inherited"> |
|
8251 <h3 class="name"><code>_isLinkSameOrigin</code></h3> |
|
8252 |
|
8253 |
|
8254 <div class="args"> |
|
8255 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8256 |
|
8257 <li class="arg"> |
|
8258 |
|
8259 <code>link</code> |
|
8260 |
|
8261 </li> |
|
8262 |
|
8263 </ul><span class="paren">)</span> |
|
8264 </div> |
|
8265 |
|
8266 |
|
8267 |
|
8268 <span class="returns-inline"> |
|
8269 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8270 </span> |
|
8271 |
|
8272 |
|
8273 |
|
8274 |
|
8275 |
|
8276 <span class="flag protected">protected</span> |
|
8277 |
|
8278 |
|
8279 |
|
8280 |
|
8281 |
|
8282 |
|
8283 |
|
8284 |
|
8285 |
|
8286 |
|
8287 <div class="meta"> |
|
8288 |
|
8289 |
|
8290 <p>Inherited from |
|
8291 <a href="../classes/PjaxBase.html#method__isLinkSameOrigin">PjaxBase</a>: |
|
8292 |
|
8293 |
|
8294 |
|
8295 <a href="../files/pjax_js_pjax-base.js.html#l161"><code>pjax/js/pjax-base.js:161</code></a> |
|
8296 |
|
8297 </p> |
|
8298 |
|
8299 |
|
8300 |
|
8301 |
|
8302 |
|
8303 <p>Available since 3.6.0</p> |
|
8304 |
|
8305 </div> |
|
8306 |
|
8307 <div class="description"> |
|
8308 <p>Utility method to test whether a specified link/anchor node's <code>href</code> is of |
|
8309 the same origin as the page's current location.</p> |
|
8310 |
|
8311 <p>This normalize browser inconsistencies with how the <code>port</code> is reported for |
|
8312 anchor elements (IE reports a value for the default port, e.g. "80").</p> |
|
8313 </div> |
|
8314 |
|
8315 |
|
8316 <div class="params"> |
|
8317 <h4>Parameters:</h4> |
|
8318 |
|
8319 <ul class="params-list"> |
|
8320 |
|
8321 <li class="param"> |
|
8322 |
|
8323 <code class="param-name">link</code> |
|
8324 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
8325 |
|
8326 |
|
8327 |
|
8328 |
|
8329 <div class="param-description"> |
|
8330 <p>The anchor element to test whether its <code>href</code> is of the |
|
8331 same origin as the page's current location.</p> |
|
8332 </div> |
|
8333 |
|
8334 |
|
8335 </li> |
|
8336 |
|
8337 </ul> |
|
8338 </div> |
|
8339 |
|
8340 |
|
8341 |
|
8342 <div class="returns"> |
|
8343 <h4>Returns:</h4> |
|
8344 |
|
8345 <div class="returns-description"> |
|
8346 |
|
8347 |
|
8348 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
8349 |
|
8350 Whether or not the link's <code>href</code> is of the same origin as |
|
8351 the page's current location. |
|
8352 |
|
8353 </div> |
|
8354 </div> |
|
8355 |
|
8356 |
|
8357 |
|
8358 </div> |
|
8359 |
|
8360 |
|
8361 <div id="method__isParentView" class="method item protected"> |
|
8362 <h3 class="name"><code>_isParentView</code></h3> |
|
8363 |
|
8364 |
|
8365 <div class="args"> |
|
8366 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8367 |
|
8368 <li class="arg"> |
|
8369 |
|
8370 <code>view</code> |
|
8371 |
|
8372 </li> |
|
8373 |
|
8374 <li class="arg"> |
|
8375 |
|
8376 <code>parent</code> |
|
8377 |
|
8378 </li> |
|
8379 |
|
8380 </ul><span class="paren">)</span> |
|
8381 </div> |
|
8382 |
|
8383 |
|
8384 |
|
8385 <span class="returns-inline"> |
|
8386 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8387 </span> |
|
8388 |
|
8389 |
|
8390 |
|
8391 |
|
8392 |
|
8393 <span class="flag protected">protected</span> |
|
8394 |
|
8395 |
|
8396 |
|
8397 |
|
8398 |
|
8399 |
|
8400 |
|
8401 |
|
8402 |
|
8403 |
|
8404 <div class="meta"> |
|
8405 |
|
8406 |
|
8407 |
|
8408 <p> |
|
8409 |
|
8410 Defined in |
|
8411 |
|
8412 |
|
8413 |
|
8414 |
|
8415 <a href="../files/app_js_app-base.js.html#l632"><code>app/js/app-base.js:632</code></a> |
|
8416 |
|
8417 </p> |
|
8418 |
|
8419 |
|
8420 |
|
8421 |
|
8422 |
|
8423 <p>Available since 3.5.0</p> |
|
8424 |
|
8425 </div> |
|
8426 |
|
8427 <div class="description"> |
|
8428 <p>Determines if the specified <code>view</code> is configured as the parent of the |
|
8429 specified <code>child</code> view. This requires both views to be either named-views, |
|
8430 or view instances created using configuration data that exists in the |
|
8431 <code>views</code> object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p> |
|
8432 </div> |
|
8433 |
|
8434 |
|
8435 <div class="params"> |
|
8436 <h4>Parameters:</h4> |
|
8437 |
|
8438 <ul class="params-list"> |
|
8439 |
|
8440 <li class="param"> |
|
8441 |
|
8442 <code class="param-name">view</code> |
|
8443 <span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8444 |
|
8445 |
|
8446 |
|
8447 |
|
8448 <div class="param-description"> |
|
8449 <p>The name of a view defined in the <code>views</code> object, |
|
8450 or a view instance.</p> |
|
8451 </div> |
|
8452 |
|
8453 |
|
8454 </li> |
|
8455 |
|
8456 <li class="param"> |
|
8457 |
|
8458 <code class="param-name">parent</code> |
|
8459 <span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8460 |
|
8461 |
|
8462 |
|
8463 |
|
8464 <div class="param-description"> |
|
8465 <p>The name of a view defined in the <code>views</code> |
|
8466 object, or a view instance.</p> |
|
8467 </div> |
|
8468 |
|
8469 |
|
8470 </li> |
|
8471 |
|
8472 </ul> |
|
8473 </div> |
|
8474 |
|
8475 |
|
8476 |
|
8477 <div class="returns"> |
|
8478 <h4>Returns:</h4> |
|
8479 |
|
8480 <div class="returns-description"> |
|
8481 |
|
8482 |
|
8483 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
8484 |
|
8485 Whether the view is configured as the parent of the child. |
|
8486 |
|
8487 </div> |
|
8488 </div> |
|
8489 |
|
8490 |
|
8491 |
|
8492 </div> |
|
8493 |
|
8494 |
|
8495 <div id="method__joinURL" class="method item protected inherited"> |
|
8496 <h3 class="name"><code>_joinURL</code></h3> |
|
8497 |
|
8498 |
|
8499 <div class="args"> |
|
8500 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8501 |
|
8502 <li class="arg"> |
|
8503 |
|
8504 <code>url</code> |
|
8505 |
|
8506 </li> |
|
8507 |
|
8508 </ul><span class="paren">)</span> |
|
8509 </div> |
|
8510 |
|
8511 |
|
8512 |
|
8513 <span class="returns-inline"> |
|
8514 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8515 </span> |
|
8516 |
|
8517 |
|
8518 |
|
8519 |
|
8520 |
|
8521 <span class="flag protected">protected</span> |
|
8522 |
|
8523 |
|
8524 |
|
8525 |
|
8526 |
|
8527 |
|
8528 |
|
8529 |
|
8530 |
|
8531 |
|
8532 <div class="meta"> |
|
8533 |
|
8534 |
|
8535 <p>Inherited from |
|
8536 <a href="../classes/Router.html#method__joinURL">Router</a>: |
|
8537 |
|
8538 |
|
8539 |
|
8540 <a href="../files/app_js_router.js.html#l918"><code>app/js/router.js:918</code></a> |
|
8541 |
|
8542 </p> |
|
8543 |
|
8544 |
|
8545 |
|
8546 |
|
8547 |
|
8548 </div> |
|
8549 |
|
8550 <div class="description"> |
|
8551 <p>Joins the <code>root</code> URL to the specified <em>url</em>, normalizing leading/trailing |
|
8552 <code>/</code> characters.</p> |
|
8553 </div> |
|
8554 |
|
8555 |
|
8556 <div class="params"> |
|
8557 <h4>Parameters:</h4> |
|
8558 |
|
8559 <ul class="params-list"> |
|
8560 |
|
8561 <li class="param"> |
|
8562 |
|
8563 <code class="param-name">url</code> |
|
8564 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8565 |
|
8566 |
|
8567 |
|
8568 |
|
8569 <div class="param-description"> |
|
8570 <p>URL to append to the <code>root</code> URL.</p> |
|
8571 </div> |
|
8572 |
|
8573 |
|
8574 </li> |
|
8575 |
|
8576 </ul> |
|
8577 </div> |
|
8578 |
|
8579 |
|
8580 |
|
8581 <div class="returns"> |
|
8582 <h4>Returns:</h4> |
|
8583 |
|
8584 <div class="returns-description"> |
|
8585 |
|
8586 |
|
8587 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
8588 |
|
8589 Joined URL. |
|
8590 |
|
8591 </div> |
|
8592 </div> |
|
8593 |
|
8594 |
|
8595 |
|
8596 <div class="example"> |
|
8597 <h4>Example:</h4> |
|
8598 |
|
8599 <div class="example-content"> |
|
8600 <pre class="code prettyprint"><code>router.set('root', '/foo'); |
|
8601 router._joinURL('bar'); // => '/foo/bar' |
|
8602 router._joinURL('/bar'); // => '/foo/bar' |
|
8603 |
|
8604 router.set('root', '/foo/'); |
|
8605 router._joinURL('bar'); // => '/foo/bar' |
|
8606 router._joinURL('/bar'); // => '/foo/bar' |
|
8607 </code></pre> |
|
8608 </div> |
|
8609 </div> |
|
8610 |
|
8611 </div> |
|
8612 |
|
8613 |
|
8614 <div id="method__monitor" class="method item private inherited"> |
|
8615 <h3 class="name"><code>_monitor</code></h3> |
|
8616 |
|
8617 |
|
8618 <div class="args"> |
|
8619 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8620 |
|
8621 <li class="arg"> |
|
8622 |
|
8623 <code>what</code> |
|
8624 |
|
8625 </li> |
|
8626 |
|
8627 <li class="arg"> |
|
8628 |
|
8629 <code>eventType</code> |
|
8630 |
|
8631 </li> |
|
8632 |
|
8633 <li class="arg"> |
|
8634 |
|
8635 <code>o</code> |
|
8636 |
|
8637 </li> |
|
8638 |
|
8639 </ul><span class="paren">)</span> |
|
8640 </div> |
|
8641 |
|
8642 |
|
8643 |
|
8644 |
|
8645 |
|
8646 |
|
8647 |
|
8648 <span class="flag private">private</span> |
|
8649 |
|
8650 |
|
8651 |
|
8652 |
|
8653 |
|
8654 |
|
8655 |
|
8656 |
|
8657 |
|
8658 |
|
8659 <div class="meta"> |
|
8660 |
|
8661 |
|
8662 <p>Inherited from |
|
8663 <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>: |
|
8664 |
|
8665 |
|
8666 |
|
8667 <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a> |
|
8668 |
|
8669 </p> |
|
8670 |
|
8671 |
|
8672 |
|
8673 |
|
8674 |
|
8675 </div> |
|
8676 |
|
8677 <div class="description"> |
|
8678 <p>This is the entry point for the event monitoring system. |
|
8679 You can monitor 'attach', 'detach', 'fire', and 'publish'. |
|
8680 When configured, these events generate an event. click -> |
|
8681 click<em>attach, click</em>detach, click_publish -- these can |
|
8682 be subscribed to like other events to monitor the event |
|
8683 system. Inividual published events can have monitoring |
|
8684 turned on or off (publish can't be turned off before it |
|
8685 it published) by setting the events 'monitor' config.</p> |
|
8686 </div> |
|
8687 |
|
8688 |
|
8689 <div class="params"> |
|
8690 <h4>Parameters:</h4> |
|
8691 |
|
8692 <ul class="params-list"> |
|
8693 |
|
8694 <li class="param"> |
|
8695 |
|
8696 <code class="param-name">what</code> |
|
8697 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8698 |
|
8699 |
|
8700 |
|
8701 |
|
8702 <div class="param-description"> |
|
8703 <p>'attach', 'detach', 'fire', or 'publish'</p> |
|
8704 </div> |
|
8705 |
|
8706 |
|
8707 </li> |
|
8708 |
|
8709 <li class="param"> |
|
8710 |
|
8711 <code class="param-name">eventType</code> |
|
8712 <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> |
|
8713 |
|
8714 |
|
8715 |
|
8716 |
|
8717 <div class="param-description"> |
|
8718 <p>The prefixed name of the event being monitored, or the CustomEvent object.</p> |
|
8719 </div> |
|
8720 |
|
8721 |
|
8722 </li> |
|
8723 |
|
8724 <li class="param"> |
|
8725 |
|
8726 <code class="param-name">o</code> |
|
8727 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8728 |
|
8729 |
|
8730 |
|
8731 |
|
8732 <div class="param-description"> |
|
8733 <p>Information about the event interaction, such as |
|
8734 fire() args, subscription category, publish config</p> |
|
8735 </div> |
|
8736 |
|
8737 |
|
8738 </li> |
|
8739 |
|
8740 </ul> |
|
8741 </div> |
|
8742 |
|
8743 |
|
8744 |
|
8745 |
|
8746 |
|
8747 </div> |
|
8748 |
|
8749 |
|
8750 <div id="method__navigate" class="method item protected"> |
|
8751 <h3 class="name"><code>_navigate</code></h3> |
|
8752 |
|
8753 |
|
8754 <div class="args"> |
|
8755 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8756 |
|
8757 <li class="arg"> |
|
8758 |
|
8759 <code>url</code> |
|
8760 |
|
8761 </li> |
|
8762 |
|
8763 <li class="arg"> |
|
8764 |
|
8765 <code class="optional">[options]</code> |
|
8766 |
|
8767 </li> |
|
8768 |
|
8769 </ul><span class="paren">)</span> |
|
8770 </div> |
|
8771 |
|
8772 |
|
8773 |
|
8774 |
|
8775 |
|
8776 |
|
8777 |
|
8778 <span class="flag protected">protected</span> |
|
8779 |
|
8780 |
|
8781 |
|
8782 |
|
8783 |
|
8784 |
|
8785 |
|
8786 |
|
8787 |
|
8788 |
|
8789 <div class="meta"> |
|
8790 |
|
8791 <p>Inherited from |
|
8792 <a href="../classes/PjaxBase.html#method__navigate"> |
|
8793 PjaxBase |
|
8794 </a> |
|
8795 |
|
8796 but overwritten in |
|
8797 |
|
8798 |
|
8799 |
|
8800 <a href="../files/app_js_app-base.js.html#l658"><code>app/js/app-base.js:658</code></a> |
|
8801 |
|
8802 </p> |
|
8803 |
|
8804 |
|
8805 |
|
8806 |
|
8807 |
|
8808 </div> |
|
8809 |
|
8810 <div class="description"> |
|
8811 <p>Underlying implementation for <code>navigate()</code>.</p> |
|
8812 </div> |
|
8813 |
|
8814 |
|
8815 <div class="params"> |
|
8816 <h4>Parameters:</h4> |
|
8817 |
|
8818 <ul class="params-list"> |
|
8819 |
|
8820 <li class="param"> |
|
8821 |
|
8822 <code class="param-name">url</code> |
|
8823 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8824 |
|
8825 |
|
8826 |
|
8827 |
|
8828 <div class="param-description"> |
|
8829 <p>The fully-resolved URL that the app should dispatch to |
|
8830 its route handlers to fulfill the enhanced navigation "request", or use to |
|
8831 update <code>window.location</code> in non-HTML5 history capable browsers when |
|
8832 <code>serverRouting</code> is <code>true</code>.</p> |
|
8833 </div> |
|
8834 |
|
8835 |
|
8836 </li> |
|
8837 |
|
8838 <li class="param"> |
|
8839 |
|
8840 <code class="param-name optional">[options]</code> |
|
8841 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8842 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
8843 |
|
8844 |
|
8845 |
|
8846 |
|
8847 <div class="param-description"> |
|
8848 <p>Additional options to configure the navigation. |
|
8849 These are mixed into the <code>navigate</code> event facade.</p> |
|
8850 </div> |
|
8851 |
|
8852 |
|
8853 <ul class="params-list"> |
|
8854 |
|
8855 <li class="param"> |
|
8856 |
|
8857 <code class="param-name optional">[replace]</code> |
|
8858 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8859 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
8860 |
|
8861 |
|
8862 <div class="param-description"> |
|
8863 <p>Whether or not the current history |
|
8864 entry will be replaced, or a new entry will be created. Will default |
|
8865 to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p> |
|
8866 </div> |
|
8867 |
|
8868 |
|
8869 </li> |
|
8870 |
|
8871 <li class="param"> |
|
8872 |
|
8873 <code class="param-name optional">[force]</code> |
|
8874 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
8875 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
8876 |
|
8877 |
|
8878 <div class="param-description"> |
|
8879 <p>Whether the enhanced navigation |
|
8880 should occur even in browsers without HTML5 history. Will default to |
|
8881 <code>true</code> when <code>serverRouting</code> is falsy.</p> |
|
8882 </div> |
|
8883 |
|
8884 |
|
8885 </li> |
|
8886 |
|
8887 </ul> |
|
8888 |
|
8889 </li> |
|
8890 |
|
8891 </ul> |
|
8892 </div> |
|
8893 |
|
8894 |
|
8895 |
|
8896 |
|
8897 |
|
8898 </div> |
|
8899 |
|
8900 |
|
8901 <div id="method__normalizePath" class="method item protected inherited"> |
|
8902 <h3 class="name"><code>_normalizePath</code></h3> |
|
8903 |
|
8904 |
|
8905 <div class="args"> |
|
8906 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8907 |
|
8908 <li class="arg"> |
|
8909 |
|
8910 <code>path</code> |
|
8911 |
|
8912 </li> |
|
8913 |
|
8914 </ul><span class="paren">)</span> |
|
8915 </div> |
|
8916 |
|
8917 |
|
8918 |
|
8919 <span class="returns-inline"> |
|
8920 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8921 </span> |
|
8922 |
|
8923 |
|
8924 |
|
8925 |
|
8926 |
|
8927 <span class="flag protected">protected</span> |
|
8928 |
|
8929 |
|
8930 |
|
8931 |
|
8932 |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 <div class="meta"> |
|
8939 |
|
8940 |
|
8941 <p>Inherited from |
|
8942 <a href="../classes/Router.html#method__normalizePath">Router</a>: |
|
8943 |
|
8944 |
|
8945 |
|
8946 <a href="../files/app_js_router.js.html#l951"><code>app/js/router.js:951</code></a> |
|
8947 |
|
8948 </p> |
|
8949 |
|
8950 |
|
8951 |
|
8952 |
|
8953 |
|
8954 <p>Available since 3.5.0</p> |
|
8955 |
|
8956 </div> |
|
8957 |
|
8958 <div class="description"> |
|
8959 <p>Returns a normalized path, ridding it of any '..' segments and properly |
|
8960 handling leading and trailing slashes.</p> |
|
8961 </div> |
|
8962 |
|
8963 |
|
8964 <div class="params"> |
|
8965 <h4>Parameters:</h4> |
|
8966 |
|
8967 <ul class="params-list"> |
|
8968 |
|
8969 <li class="param"> |
|
8970 |
|
8971 <code class="param-name">path</code> |
|
8972 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8973 |
|
8974 |
|
8975 |
|
8976 |
|
8977 <div class="param-description"> |
|
8978 <p>URL path to normalize.</p> |
|
8979 </div> |
|
8980 |
|
8981 |
|
8982 </li> |
|
8983 |
|
8984 </ul> |
|
8985 </div> |
|
8986 |
|
8987 |
|
8988 |
|
8989 <div class="returns"> |
|
8990 <h4>Returns:</h4> |
|
8991 |
|
8992 <div class="returns-description"> |
|
8993 |
|
8994 |
|
8995 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
8996 |
|
8997 Normalized path. |
|
8998 |
|
8999 </div> |
|
9000 </div> |
|
9001 |
|
9002 |
|
9003 |
|
9004 </div> |
|
9005 |
|
9006 |
|
9007 <div id="method__normAttrVals" class="method item private inherited"> |
|
9008 <h3 class="name"><code>_normAttrVals</code></h3> |
|
9009 |
|
9010 |
|
9011 <div class="args"> |
|
9012 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9013 |
|
9014 <li class="arg"> |
|
9015 |
|
9016 <code>valueHash</code> |
|
9017 |
|
9018 </li> |
|
9019 |
|
9020 </ul><span class="paren">)</span> |
|
9021 </div> |
|
9022 |
|
9023 |
|
9024 |
|
9025 <span class="returns-inline"> |
|
9026 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9027 </span> |
|
9028 |
|
9029 |
|
9030 |
|
9031 |
|
9032 |
|
9033 <span class="flag private">private</span> |
|
9034 |
|
9035 |
|
9036 |
|
9037 |
|
9038 |
|
9039 |
|
9040 |
|
9041 |
|
9042 |
|
9043 |
|
9044 <div class="meta"> |
|
9045 |
|
9046 |
|
9047 <p>Inherited from |
|
9048 <a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>: |
|
9049 |
|
9050 |
|
9051 |
|
9052 <a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a> |
|
9053 |
|
9054 </p> |
|
9055 |
|
9056 |
|
9057 |
|
9058 |
|
9059 |
|
9060 </div> |
|
9061 |
|
9062 <div class="description"> |
|
9063 <p>Utility method to normalize attribute values. The base implementation |
|
9064 simply merges the hash to protect the original.</p> |
|
9065 </div> |
|
9066 |
|
9067 |
|
9068 <div class="params"> |
|
9069 <h4>Parameters:</h4> |
|
9070 |
|
9071 <ul class="params-list"> |
|
9072 |
|
9073 <li class="param"> |
|
9074 |
|
9075 <code class="param-name">valueHash</code> |
|
9076 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9077 |
|
9078 |
|
9079 |
|
9080 |
|
9081 <div class="param-description"> |
|
9082 <p>An object with attribute name/value pairs</p> |
|
9083 </div> |
|
9084 |
|
9085 |
|
9086 </li> |
|
9087 |
|
9088 </ul> |
|
9089 </div> |
|
9090 |
|
9091 |
|
9092 |
|
9093 <div class="returns"> |
|
9094 <h4>Returns:</h4> |
|
9095 |
|
9096 <div class="returns-description"> |
|
9097 |
|
9098 |
|
9099 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9100 |
|
9101 An object literal with 2 properties - "simple" and "complex", |
|
9102 containing simple and complex attribute values respectively keyed |
|
9103 by the top level attribute name, or null, if valueHash is falsey. |
|
9104 |
|
9105 </div> |
|
9106 </div> |
|
9107 |
|
9108 |
|
9109 |
|
9110 </div> |
|
9111 |
|
9112 |
|
9113 <div id="method__onLinkClick" class="method item protected inherited"> |
|
9114 <h3 class="name"><code>_onLinkClick</code></h3> |
|
9115 |
|
9116 |
|
9117 <div class="args"> |
|
9118 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9119 |
|
9120 <li class="arg"> |
|
9121 |
|
9122 <code>e</code> |
|
9123 |
|
9124 </li> |
|
9125 |
|
9126 </ul><span class="paren">)</span> |
|
9127 </div> |
|
9128 |
|
9129 |
|
9130 |
|
9131 |
|
9132 |
|
9133 |
|
9134 |
|
9135 <span class="flag protected">protected</span> |
|
9136 |
|
9137 |
|
9138 |
|
9139 |
|
9140 |
|
9141 |
|
9142 |
|
9143 |
|
9144 |
|
9145 |
|
9146 <div class="meta"> |
|
9147 |
|
9148 |
|
9149 <p>Inherited from |
|
9150 <a href="../classes/PjaxBase.html#method__onLinkClick">PjaxBase</a>: |
|
9151 |
|
9152 |
|
9153 |
|
9154 <a href="../files/pjax_js_pjax-base.js.html#l325"><code>pjax/js/pjax-base.js:325</code></a> |
|
9155 |
|
9156 </p> |
|
9157 |
|
9158 |
|
9159 |
|
9160 |
|
9161 |
|
9162 <p>Available since 3.5.0</p> |
|
9163 |
|
9164 </div> |
|
9165 |
|
9166 <div class="description"> |
|
9167 <p>Handler for delegated link-click events which match the <code>linkSelector</code>.</p> |
|
9168 |
|
9169 <p>This will attempt to enhance the navigation to the link element's <code>href</code> by |
|
9170 passing the URL to the <code>_navigate()</code> method. When the navigation is being |
|
9171 enhanced, the default action is prevented.</p> |
|
9172 |
|
9173 <p>If the user clicks a link with the middle/right mouse buttons, or is holding |
|
9174 down the Ctrl or Command keys, this method's behavior is not applied and |
|
9175 allows the native behavior to occur. Similarly, if the router is not capable |
|
9176 or handling the URL because no route-handlers match, the link click will |
|
9177 behave natively.</p> |
|
9178 </div> |
|
9179 |
|
9180 |
|
9181 <div class="params"> |
|
9182 <h4>Parameters:</h4> |
|
9183 |
|
9184 <ul class="params-list"> |
|
9185 |
|
9186 <li class="param"> |
|
9187 |
|
9188 <code class="param-name">e</code> |
|
9189 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
9190 |
|
9191 |
|
9192 |
|
9193 |
|
9194 <div class="param-description"> |
|
9195 |
|
9196 </div> |
|
9197 |
|
9198 |
|
9199 </li> |
|
9200 |
|
9201 </ul> |
|
9202 </div> |
|
9203 |
|
9204 |
|
9205 |
|
9206 |
|
9207 |
|
9208 </div> |
|
9209 |
|
9210 |
|
9211 <div id="method__parseQuery" class="method item protected inherited"> |
|
9212 <h3 class="name"><code>_parseQuery</code></h3> |
|
9213 |
|
9214 |
|
9215 <div class="args"> |
|
9216 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9217 |
|
9218 <li class="arg"> |
|
9219 |
|
9220 <code>query</code> |
|
9221 |
|
9222 </li> |
|
9223 |
|
9224 </ul><span class="paren">)</span> |
|
9225 </div> |
|
9226 |
|
9227 |
|
9228 |
|
9229 <span class="returns-inline"> |
|
9230 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9231 </span> |
|
9232 |
|
9233 |
|
9234 |
|
9235 |
|
9236 |
|
9237 <span class="flag protected">protected</span> |
|
9238 |
|
9239 |
|
9240 |
|
9241 |
|
9242 |
|
9243 |
|
9244 |
|
9245 |
|
9246 |
|
9247 |
|
9248 <div class="meta"> |
|
9249 |
|
9250 |
|
9251 <p>Inherited from |
|
9252 <a href="../classes/Router.html#method__parseQuery">Router</a>: |
|
9253 |
|
9254 |
|
9255 |
|
9256 <a href="../files/app_js_router.js.html#l993"><code>app/js/router.js:993</code></a> |
|
9257 |
|
9258 </p> |
|
9259 |
|
9260 |
|
9261 |
|
9262 |
|
9263 |
|
9264 </div> |
|
9265 |
|
9266 <div class="description"> |
|
9267 <p>Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is |
|
9268 available, this method will be an alias to that.</p> |
|
9269 </div> |
|
9270 |
|
9271 |
|
9272 <div class="params"> |
|
9273 <h4>Parameters:</h4> |
|
9274 |
|
9275 <ul class="params-list"> |
|
9276 |
|
9277 <li class="param"> |
|
9278 |
|
9279 <code class="param-name">query</code> |
|
9280 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9281 |
|
9282 |
|
9283 |
|
9284 |
|
9285 <div class="param-description"> |
|
9286 <p>Query string to parse.</p> |
|
9287 </div> |
|
9288 |
|
9289 |
|
9290 </li> |
|
9291 |
|
9292 </ul> |
|
9293 </div> |
|
9294 |
|
9295 |
|
9296 |
|
9297 <div class="returns"> |
|
9298 <h4>Returns:</h4> |
|
9299 |
|
9300 <div class="returns-description"> |
|
9301 |
|
9302 |
|
9303 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9304 |
|
9305 Hash of key/value pairs for query parameters. |
|
9306 |
|
9307 </div> |
|
9308 </div> |
|
9309 |
|
9310 |
|
9311 |
|
9312 </div> |
|
9313 |
|
9314 |
|
9315 <div id="method__parseType" class="method item private inherited"> |
|
9316 <h3 class="name"><code>_parseType</code></h3> |
|
9317 |
|
9318 |
|
9319 <span class="paren">()</span> |
|
9320 |
|
9321 |
|
9322 |
|
9323 |
|
9324 |
|
9325 |
|
9326 |
|
9327 <span class="flag private">private</span> |
|
9328 |
|
9329 |
|
9330 |
|
9331 |
|
9332 |
|
9333 |
|
9334 |
|
9335 |
|
9336 |
|
9337 |
|
9338 <div class="meta"> |
|
9339 |
|
9340 |
|
9341 <p>Inherited from |
|
9342 <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>: |
|
9343 |
|
9344 |
|
9345 |
|
9346 <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a> |
|
9347 |
|
9348 </p> |
|
9349 |
|
9350 |
|
9351 |
|
9352 |
|
9353 |
|
9354 </div> |
|
9355 |
|
9356 <div class="description"> |
|
9357 <p>Returns an array with the detach key (if provided), |
|
9358 and the prefixed event name from _getType |
|
9359 Y.on('detachcategory| menu:click', fn)</p> |
|
9360 </div> |
|
9361 |
|
9362 |
|
9363 |
|
9364 |
|
9365 |
|
9366 |
|
9367 </div> |
|
9368 |
|
9369 |
|
9370 <div id="method__pjaxBindUI" class="method item protected inherited"> |
|
9371 <h3 class="name"><code>_pjaxBindUI</code></h3> |
|
9372 |
|
9373 |
|
9374 <span class="paren">()</span> |
|
9375 |
|
9376 |
|
9377 |
|
9378 |
|
9379 |
|
9380 |
|
9381 |
|
9382 <span class="flag protected">protected</span> |
|
9383 |
|
9384 |
|
9385 |
|
9386 |
|
9387 |
|
9388 |
|
9389 |
|
9390 |
|
9391 |
|
9392 |
|
9393 <div class="meta"> |
|
9394 |
|
9395 |
|
9396 <p>Inherited from |
|
9397 <a href="../classes/PjaxBase.html#method__pjaxBindUI">PjaxBase</a>: |
|
9398 |
|
9399 |
|
9400 |
|
9401 <a href="../files/pjax_js_pjax-base.js.html#l279"><code>pjax/js/pjax-base.js:279</code></a> |
|
9402 |
|
9403 </p> |
|
9404 |
|
9405 |
|
9406 |
|
9407 |
|
9408 |
|
9409 <p>Available since 3.5.0</p> |
|
9410 |
|
9411 </div> |
|
9412 |
|
9413 <div class="description"> |
|
9414 <p>Binds the delegation of link-click events that match the <code>linkSelector</code> to |
|
9415 the <code>_onLinkClick()</code> handler.</p> |
|
9416 |
|
9417 <p>By default this method will only be called if the browser is capable of |
|
9418 using HTML5 history.</p> |
|
9419 </div> |
|
9420 |
|
9421 |
|
9422 |
|
9423 |
|
9424 |
|
9425 |
|
9426 </div> |
|
9427 |
|
9428 |
|
9429 <div id="method__preInitEventCfg" class="method item private inherited"> |
|
9430 <h3 class="name"><code>_preInitEventCfg</code></h3> |
|
9431 |
|
9432 |
|
9433 <div class="args"> |
|
9434 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9435 |
|
9436 <li class="arg"> |
|
9437 |
|
9438 <code>config</code> |
|
9439 |
|
9440 </li> |
|
9441 |
|
9442 </ul><span class="paren">)</span> |
|
9443 </div> |
|
9444 |
|
9445 |
|
9446 |
|
9447 |
|
9448 |
|
9449 |
|
9450 |
|
9451 <span class="flag private">private</span> |
|
9452 |
|
9453 |
|
9454 |
|
9455 |
|
9456 |
|
9457 |
|
9458 |
|
9459 |
|
9460 |
|
9461 |
|
9462 <div class="meta"> |
|
9463 |
|
9464 |
|
9465 <p>Inherited from |
|
9466 <a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>: |
|
9467 |
|
9468 |
|
9469 |
|
9470 <a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a> |
|
9471 |
|
9472 </p> |
|
9473 |
|
9474 |
|
9475 |
|
9476 |
|
9477 |
|
9478 </div> |
|
9479 |
|
9480 <div class="description"> |
|
9481 <p>Handles the special on, after and target properties which allow the user to |
|
9482 easily configure on and after listeners as well as bubble targets during |
|
9483 construction, prior to init.</p> |
|
9484 </div> |
|
9485 |
|
9486 |
|
9487 <div class="params"> |
|
9488 <h4>Parameters:</h4> |
|
9489 |
|
9490 <ul class="params-list"> |
|
9491 |
|
9492 <li class="param"> |
|
9493 |
|
9494 <code class="param-name">config</code> |
|
9495 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9496 |
|
9497 |
|
9498 |
|
9499 |
|
9500 <div class="param-description"> |
|
9501 <p>The user configuration object</p> |
|
9502 </div> |
|
9503 |
|
9504 |
|
9505 </li> |
|
9506 |
|
9507 </ul> |
|
9508 </div> |
|
9509 |
|
9510 |
|
9511 |
|
9512 |
|
9513 |
|
9514 </div> |
|
9515 |
|
9516 |
|
9517 <div id="method__protectAttrs" class="method item protected deprecated inherited"> |
|
9518 <h3 class="name"><code>_protectAttrs</code></h3> |
|
9519 |
|
9520 |
|
9521 <div class="args"> |
|
9522 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9523 |
|
9524 <li class="arg"> |
|
9525 |
|
9526 <code>attrs</code> |
|
9527 |
|
9528 </li> |
|
9529 |
|
9530 </ul><span class="paren">)</span> |
|
9531 </div> |
|
9532 |
|
9533 |
|
9534 |
|
9535 <span class="returns-inline"> |
|
9536 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9537 </span> |
|
9538 |
|
9539 |
|
9540 |
|
9541 <span class="flag deprecated" title="Use `AttributeCore.protectAttrs()` or |
|
9542 `Attribute.protectAttrs()` which are the same static utility method.">deprecated</span> |
|
9543 |
|
9544 |
|
9545 |
|
9546 <span class="flag protected">protected</span> |
|
9547 |
|
9548 |
|
9549 |
|
9550 |
|
9551 |
|
9552 |
|
9553 |
|
9554 |
|
9555 |
|
9556 |
|
9557 <div class="meta"> |
|
9558 |
|
9559 |
|
9560 <p>Inherited from |
|
9561 <a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>: |
|
9562 |
|
9563 |
|
9564 |
|
9565 <a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a> |
|
9566 |
|
9567 </p> |
|
9568 |
|
9569 |
|
9570 |
|
9571 <p>Deprecated: Use `AttributeCore.protectAttrs()` or |
|
9572 `Attribute.protectAttrs()` which are the same static utility method.</p> |
|
9573 |
|
9574 |
|
9575 |
|
9576 </div> |
|
9577 |
|
9578 <div class="description"> |
|
9579 <p>Utility method to protect an attribute configuration |
|
9580 hash, by merging the entire object and the individual |
|
9581 attr config objects.</p> |
|
9582 </div> |
|
9583 |
|
9584 |
|
9585 <div class="params"> |
|
9586 <h4>Parameters:</h4> |
|
9587 |
|
9588 <ul class="params-list"> |
|
9589 |
|
9590 <li class="param"> |
|
9591 |
|
9592 <code class="param-name">attrs</code> |
|
9593 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9594 |
|
9595 |
|
9596 |
|
9597 |
|
9598 <div class="param-description"> |
|
9599 <p>A hash of attribute to configuration object pairs.</p> |
|
9600 </div> |
|
9601 |
|
9602 |
|
9603 </li> |
|
9604 |
|
9605 </ul> |
|
9606 </div> |
|
9607 |
|
9608 |
|
9609 |
|
9610 <div class="returns"> |
|
9611 <h4>Returns:</h4> |
|
9612 |
|
9613 <div class="returns-description"> |
|
9614 |
|
9615 |
|
9616 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
9617 |
|
9618 A protected version of the attrs argument. |
|
9619 |
|
9620 </div> |
|
9621 </div> |
|
9622 |
|
9623 |
|
9624 |
|
9625 </div> |
|
9626 |
|
9627 |
|
9628 <div id="method__publish" class="method item private inherited"> |
|
9629 <h3 class="name"><code>_publish</code></h3> |
|
9630 |
|
9631 |
|
9632 <div class="args"> |
|
9633 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9634 |
|
9635 <li class="arg"> |
|
9636 |
|
9637 <code>fullType</code> |
|
9638 |
|
9639 </li> |
|
9640 |
|
9641 <li class="arg"> |
|
9642 |
|
9643 <code>etOpts</code> |
|
9644 |
|
9645 </li> |
|
9646 |
|
9647 <li class="arg"> |
|
9648 |
|
9649 <code>ceOpts</code> |
|
9650 |
|
9651 </li> |
|
9652 |
|
9653 </ul><span class="paren">)</span> |
|
9654 </div> |
|
9655 |
|
9656 |
|
9657 |
|
9658 <span class="returns-inline"> |
|
9659 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
9660 </span> |
|
9661 |
|
9662 |
|
9663 |
|
9664 |
|
9665 |
|
9666 <span class="flag private">private</span> |
|
9667 |
|
9668 |
|
9669 |
|
9670 |
|
9671 |
|
9672 |
|
9673 |
|
9674 |
|
9675 |
|
9676 |
|
9677 <div class="meta"> |
|
9678 |
|
9679 |
|
9680 <p>Inherited from |
|
9681 <a href="../classes/EventTarget.html#method__publish">EventTarget</a>: |
|
9682 |
|
9683 |
|
9684 |
|
9685 <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a> |
|
9686 |
|
9687 </p> |
|
9688 |
|
9689 |
|
9690 |
|
9691 |
|
9692 |
|
9693 </div> |
|
9694 |
|
9695 <div class="description"> |
|
9696 <p>The low level event publish implementation. It expects all the massaging to have been done |
|
9697 outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast |
|
9698 path publish, which can be used by critical code paths to improve performance.</p> |
|
9699 </div> |
|
9700 |
|
9701 |
|
9702 <div class="params"> |
|
9703 <h4>Parameters:</h4> |
|
9704 |
|
9705 <ul class="params-list"> |
|
9706 |
|
9707 <li class="param"> |
|
9708 |
|
9709 <code class="param-name">fullType</code> |
|
9710 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9711 |
|
9712 |
|
9713 |
|
9714 |
|
9715 <div class="param-description"> |
|
9716 <p>The prefixed type of the event to publish.</p> |
|
9717 </div> |
|
9718 |
|
9719 |
|
9720 </li> |
|
9721 |
|
9722 <li class="param"> |
|
9723 |
|
9724 <code class="param-name">etOpts</code> |
|
9725 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9726 |
|
9727 |
|
9728 |
|
9729 |
|
9730 <div class="param-description"> |
|
9731 <p>The EventTarget specific configuration to mix into the published event.</p> |
|
9732 </div> |
|
9733 |
|
9734 |
|
9735 </li> |
|
9736 |
|
9737 <li class="param"> |
|
9738 |
|
9739 <code class="param-name">ceOpts</code> |
|
9740 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9741 |
|
9742 |
|
9743 |
|
9744 |
|
9745 <div class="param-description"> |
|
9746 <p>The publish specific configuration to mix into the published event.</p> |
|
9747 </div> |
|
9748 |
|
9749 |
|
9750 </li> |
|
9751 |
|
9752 </ul> |
|
9753 </div> |
|
9754 |
|
9755 |
|
9756 |
|
9757 <div class="returns"> |
|
9758 <h4>Returns:</h4> |
|
9759 |
|
9760 <div class="returns-description"> |
|
9761 |
|
9762 |
|
9763 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
9764 |
|
9765 The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will |
|
9766 be the default <code>CustomEvent</code> instance, and can be configured independently. |
|
9767 |
|
9768 </div> |
|
9769 </div> |
|
9770 |
|
9771 |
|
9772 |
|
9773 </div> |
|
9774 |
|
9775 |
|
9776 <div id="method__queue" class="method item protected inherited"> |
|
9777 <h3 class="name"><code>_queue</code></h3> |
|
9778 |
|
9779 |
|
9780 <span class="paren">()</span> |
|
9781 |
|
9782 |
|
9783 |
|
9784 |
|
9785 |
|
9786 |
|
9787 |
|
9788 <span class="flag protected">protected</span> |
|
9789 |
|
9790 |
|
9791 |
|
9792 |
|
9793 |
|
9794 |
|
9795 |
|
9796 <span class="flag chainable">chainable</span> |
|
9797 |
|
9798 |
|
9799 |
|
9800 |
|
9801 <div class="meta"> |
|
9802 |
|
9803 |
|
9804 <p>Inherited from |
|
9805 <a href="../classes/Router.html#method__queue">Router</a>: |
|
9806 |
|
9807 |
|
9808 |
|
9809 <a href="../files/app_js_router.js.html#l1021"><code>app/js/router.js:1021</code></a> |
|
9810 |
|
9811 </p> |
|
9812 |
|
9813 |
|
9814 |
|
9815 |
|
9816 |
|
9817 </div> |
|
9818 |
|
9819 <div class="description"> |
|
9820 <p>Queues up a <code>_save()</code> call to run after all previously-queued calls have |
|
9821 finished.</p> |
|
9822 |
|
9823 <p>This is necessary because if we make multiple <code>_save()</code> calls before the |
|
9824 first call gets dispatched, then both calls will dispatch to the last call's |
|
9825 URL.</p> |
|
9826 |
|
9827 <p>All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the |
|
9828 queued function is executed.</p> |
|
9829 </div> |
|
9830 |
|
9831 |
|
9832 |
|
9833 |
|
9834 |
|
9835 |
|
9836 </div> |
|
9837 |
|
9838 |
|
9839 <div id="method__resolvePath" class="method item protected inherited"> |
|
9840 <h3 class="name"><code>_resolvePath</code></h3> |
|
9841 |
|
9842 |
|
9843 <div class="args"> |
|
9844 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9845 |
|
9846 <li class="arg"> |
|
9847 |
|
9848 <code>path</code> |
|
9849 |
|
9850 </li> |
|
9851 |
|
9852 </ul><span class="paren">)</span> |
|
9853 </div> |
|
9854 |
|
9855 |
|
9856 |
|
9857 <span class="returns-inline"> |
|
9858 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9859 </span> |
|
9860 |
|
9861 |
|
9862 |
|
9863 |
|
9864 |
|
9865 <span class="flag protected">protected</span> |
|
9866 |
|
9867 |
|
9868 |
|
9869 |
|
9870 |
|
9871 |
|
9872 |
|
9873 |
|
9874 |
|
9875 |
|
9876 <div class="meta"> |
|
9877 |
|
9878 |
|
9879 <p>Inherited from |
|
9880 <a href="../classes/Router.html#method__resolvePath">Router</a>: |
|
9881 |
|
9882 |
|
9883 |
|
9884 <a href="../files/app_js_router.js.html#l1066"><code>app/js/router.js:1066</code></a> |
|
9885 |
|
9886 </p> |
|
9887 |
|
9888 |
|
9889 |
|
9890 |
|
9891 |
|
9892 <p>Available since 3.5.0</p> |
|
9893 |
|
9894 </div> |
|
9895 |
|
9896 <div class="description"> |
|
9897 <p>Returns the normalized result of resolving the <code>path</code> against the current |
|
9898 path. Falsy values for <code>path</code> will return just the current path.</p> |
|
9899 </div> |
|
9900 |
|
9901 |
|
9902 <div class="params"> |
|
9903 <h4>Parameters:</h4> |
|
9904 |
|
9905 <ul class="params-list"> |
|
9906 |
|
9907 <li class="param"> |
|
9908 |
|
9909 <code class="param-name">path</code> |
|
9910 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9911 |
|
9912 |
|
9913 |
|
9914 |
|
9915 <div class="param-description"> |
|
9916 <p>URL path to resolve.</p> |
|
9917 </div> |
|
9918 |
|
9919 |
|
9920 </li> |
|
9921 |
|
9922 </ul> |
|
9923 </div> |
|
9924 |
|
9925 |
|
9926 |
|
9927 <div class="returns"> |
|
9928 <h4>Returns:</h4> |
|
9929 |
|
9930 <div class="returns-description"> |
|
9931 |
|
9932 |
|
9933 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
9934 |
|
9935 Resolved path. |
|
9936 |
|
9937 </div> |
|
9938 </div> |
|
9939 |
|
9940 |
|
9941 |
|
9942 </div> |
|
9943 |
|
9944 |
|
9945 <div id="method__resolveURL" class="method item protected inherited"> |
|
9946 <h3 class="name"><code>_resolveURL</code></h3> |
|
9947 |
|
9948 |
|
9949 <div class="args"> |
|
9950 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9951 |
|
9952 <li class="arg"> |
|
9953 |
|
9954 <code>url</code> |
|
9955 |
|
9956 </li> |
|
9957 |
|
9958 </ul><span class="paren">)</span> |
|
9959 </div> |
|
9960 |
|
9961 |
|
9962 |
|
9963 <span class="returns-inline"> |
|
9964 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9965 </span> |
|
9966 |
|
9967 |
|
9968 |
|
9969 |
|
9970 |
|
9971 <span class="flag protected">protected</span> |
|
9972 |
|
9973 |
|
9974 |
|
9975 |
|
9976 |
|
9977 |
|
9978 |
|
9979 |
|
9980 |
|
9981 |
|
9982 <div class="meta"> |
|
9983 |
|
9984 |
|
9985 <p>Inherited from |
|
9986 <a href="../classes/Router.html#method__resolveURL">Router</a>: |
|
9987 |
|
9988 |
|
9989 |
|
9990 <a href="../files/app_js_router.js.html#l1088"><code>app/js/router.js:1088</code></a> |
|
9991 |
|
9992 </p> |
|
9993 |
|
9994 |
|
9995 |
|
9996 |
|
9997 |
|
9998 <p>Available since 3.5.0</p> |
|
9999 |
|
10000 </div> |
|
10001 |
|
10002 <div class="description"> |
|
10003 <p>Resolves the specified URL against the current URL.</p> |
|
10004 |
|
10005 <p>This method resolves URLs like a browser does and will always return an |
|
10006 absolute URL. When the specified URL is already absolute, it is assumed to |
|
10007 be fully resolved and is simply returned as is. Scheme-relative URLs are |
|
10008 prefixed with the current protocol. Relative URLs are giving the current |
|
10009 URL's origin and are resolved and normalized against the current path root.</p> |
|
10010 </div> |
|
10011 |
|
10012 |
|
10013 <div class="params"> |
|
10014 <h4>Parameters:</h4> |
|
10015 |
|
10016 <ul class="params-list"> |
|
10017 |
|
10018 <li class="param"> |
|
10019 |
|
10020 <code class="param-name">url</code> |
|
10021 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10022 |
|
10023 |
|
10024 |
|
10025 |
|
10026 <div class="param-description"> |
|
10027 <p>URL to resolve.</p> |
|
10028 </div> |
|
10029 |
|
10030 |
|
10031 </li> |
|
10032 |
|
10033 </ul> |
|
10034 </div> |
|
10035 |
|
10036 |
|
10037 |
|
10038 <div class="returns"> |
|
10039 <h4>Returns:</h4> |
|
10040 |
|
10041 <div class="returns-description"> |
|
10042 |
|
10043 |
|
10044 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
10045 |
|
10046 Resolved URL. |
|
10047 |
|
10048 </div> |
|
10049 </div> |
|
10050 |
|
10051 |
|
10052 |
|
10053 </div> |
|
10054 |
|
10055 |
|
10056 <div id="method__save" class="method item protected"> |
|
10057 <h3 class="name"><code>_save</code></h3> |
|
10058 |
|
10059 |
|
10060 <div class="args"> |
|
10061 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10062 |
|
10063 <li class="arg"> |
|
10064 |
|
10065 <code class="optional">[url]</code> |
|
10066 |
|
10067 </li> |
|
10068 |
|
10069 <li class="arg"> |
|
10070 |
|
10071 <code class="optional">[replace=false]</code> |
|
10072 |
|
10073 </li> |
|
10074 |
|
10075 </ul><span class="paren">)</span> |
|
10076 </div> |
|
10077 |
|
10078 |
|
10079 |
|
10080 |
|
10081 |
|
10082 |
|
10083 |
|
10084 <span class="flag protected">protected</span> |
|
10085 |
|
10086 |
|
10087 |
|
10088 |
|
10089 |
|
10090 |
|
10091 |
|
10092 <span class="flag chainable">chainable</span> |
|
10093 |
|
10094 |
|
10095 |
|
10096 |
|
10097 <div class="meta"> |
|
10098 |
|
10099 <p>Inherited from |
|
10100 <a href="../classes/Router.html#method__save"> |
|
10101 Router |
|
10102 </a> |
|
10103 |
|
10104 but overwritten in |
|
10105 |
|
10106 |
|
10107 |
|
10108 <a href="../files/app_js_app-base.js.html#l688"><code>app/js/app-base.js:688</code></a> |
|
10109 |
|
10110 </p> |
|
10111 |
|
10112 |
|
10113 |
|
10114 |
|
10115 |
|
10116 </div> |
|
10117 |
|
10118 <div class="description"> |
|
10119 <p>Will either save a history entry using <code>pushState()</code> or the location hash, |
|
10120 or gracefully-degrade to sending a request to the server causing a full-page |
|
10121 reload.</p> |
|
10122 |
|
10123 <p>Overrides Router's <code>_save()</code> method to preform graceful-degradation when the |
|
10124 app's <code>serverRouting</code> is <code>true</code> and <code>html5</code> is <code>false</code> by updating the full |
|
10125 URL via standard assignment to <code>window.location</code> or by calling |
|
10126 <code>window.location.replace()</code>; both of which will cause a request to the |
|
10127 server resulting in a full-page reload.</p> |
|
10128 |
|
10129 <p>Otherwise this will just delegate off to Router's <code>_save()</code> method allowing |
|
10130 the client-side enhanced routing to occur.</p> |
|
10131 </div> |
|
10132 |
|
10133 |
|
10134 <div class="params"> |
|
10135 <h4>Parameters:</h4> |
|
10136 |
|
10137 <ul class="params-list"> |
|
10138 |
|
10139 <li class="param"> |
|
10140 |
|
10141 <code class="param-name optional">[url]</code> |
|
10142 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10143 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10144 |
|
10145 |
|
10146 |
|
10147 |
|
10148 <div class="param-description"> |
|
10149 <p>URL for the history entry.</p> |
|
10150 </div> |
|
10151 |
|
10152 |
|
10153 </li> |
|
10154 |
|
10155 <li class="param"> |
|
10156 |
|
10157 <code class="param-name optional">[replace=false]</code> |
|
10158 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
10159 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10160 |
|
10161 |
|
10162 |
|
10163 |
|
10164 <div class="param-description"> |
|
10165 <p>If <code>true</code>, the current history entry will |
|
10166 be replaced instead of a new one being added.</p> |
|
10167 </div> |
|
10168 |
|
10169 |
|
10170 </li> |
|
10171 |
|
10172 </ul> |
|
10173 </div> |
|
10174 |
|
10175 |
|
10176 |
|
10177 |
|
10178 |
|
10179 </div> |
|
10180 |
|
10181 |
|
10182 <div id="method__set" class="method item protected inherited"> |
|
10183 <h3 class="name"><code>_set</code></h3> |
|
10184 |
|
10185 |
|
10186 <div class="args"> |
|
10187 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10188 |
|
10189 <li class="arg"> |
|
10190 |
|
10191 <code>name</code> |
|
10192 |
|
10193 </li> |
|
10194 |
|
10195 <li class="arg"> |
|
10196 |
|
10197 <code>val</code> |
|
10198 |
|
10199 </li> |
|
10200 |
|
10201 <li class="arg"> |
|
10202 |
|
10203 <code class="optional">[opts]</code> |
|
10204 |
|
10205 </li> |
|
10206 |
|
10207 </ul><span class="paren">)</span> |
|
10208 </div> |
|
10209 |
|
10210 |
|
10211 |
|
10212 <span class="returns-inline"> |
|
10213 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10214 </span> |
|
10215 |
|
10216 |
|
10217 |
|
10218 |
|
10219 |
|
10220 <span class="flag protected">protected</span> |
|
10221 |
|
10222 |
|
10223 |
|
10224 |
|
10225 |
|
10226 |
|
10227 |
|
10228 <span class="flag chainable">chainable</span> |
|
10229 |
|
10230 |
|
10231 |
|
10232 |
|
10233 <div class="meta"> |
|
10234 |
|
10235 <p>Inherited from |
|
10236 <a href="../classes/AttributeObservable.html#method__set"> |
|
10237 AttributeObservable |
|
10238 </a> |
|
10239 |
|
10240 but overwritten in |
|
10241 |
|
10242 |
|
10243 |
|
10244 <a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a> |
|
10245 |
|
10246 </p> |
|
10247 |
|
10248 |
|
10249 |
|
10250 |
|
10251 |
|
10252 </div> |
|
10253 |
|
10254 <div class="description"> |
|
10255 <p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p> |
|
10256 </div> |
|
10257 |
|
10258 |
|
10259 <div class="params"> |
|
10260 <h4>Parameters:</h4> |
|
10261 |
|
10262 <ul class="params-list"> |
|
10263 |
|
10264 <li class="param"> |
|
10265 |
|
10266 <code class="param-name">name</code> |
|
10267 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10268 |
|
10269 |
|
10270 |
|
10271 |
|
10272 <div class="param-description"> |
|
10273 <p>The name of the attribute.</p> |
|
10274 </div> |
|
10275 |
|
10276 |
|
10277 </li> |
|
10278 |
|
10279 <li class="param"> |
|
10280 |
|
10281 <code class="param-name">val</code> |
|
10282 <span class="type">Any</span> |
|
10283 |
|
10284 |
|
10285 |
|
10286 |
|
10287 <div class="param-description"> |
|
10288 <p>The value to set the attribute to.</p> |
|
10289 </div> |
|
10290 |
|
10291 |
|
10292 </li> |
|
10293 |
|
10294 <li class="param"> |
|
10295 |
|
10296 <code class="param-name optional">[opts]</code> |
|
10297 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10298 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10299 |
|
10300 |
|
10301 |
|
10302 |
|
10303 <div class="param-description"> |
|
10304 <p>Optional data providing the circumstances for the change.</p> |
|
10305 </div> |
|
10306 |
|
10307 |
|
10308 </li> |
|
10309 |
|
10310 </ul> |
|
10311 </div> |
|
10312 |
|
10313 |
|
10314 |
|
10315 <div class="returns"> |
|
10316 <h4>Returns:</h4> |
|
10317 |
|
10318 <div class="returns-description"> |
|
10319 |
|
10320 |
|
10321 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10322 |
|
10323 A reference to the host object. |
|
10324 |
|
10325 </div> |
|
10326 </div> |
|
10327 |
|
10328 |
|
10329 |
|
10330 </div> |
|
10331 |
|
10332 |
|
10333 <div id="method__setAttr" class="method item protected inherited"> |
|
10334 <h3 class="name"><code>_setAttr</code></h3> |
|
10335 |
|
10336 |
|
10337 <div class="args"> |
|
10338 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10339 |
|
10340 <li class="arg"> |
|
10341 |
|
10342 <code>name</code> |
|
10343 |
|
10344 </li> |
|
10345 |
|
10346 <li class="arg"> |
|
10347 |
|
10348 <code>value</code> |
|
10349 |
|
10350 </li> |
|
10351 |
|
10352 <li class="arg"> |
|
10353 |
|
10354 <code class="optional">[opts]</code> |
|
10355 |
|
10356 </li> |
|
10357 |
|
10358 <li class="arg"> |
|
10359 |
|
10360 <code>force</code> |
|
10361 |
|
10362 </li> |
|
10363 |
|
10364 </ul><span class="paren">)</span> |
|
10365 </div> |
|
10366 |
|
10367 |
|
10368 |
|
10369 <span class="returns-inline"> |
|
10370 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10371 </span> |
|
10372 |
|
10373 |
|
10374 |
|
10375 |
|
10376 |
|
10377 <span class="flag protected">protected</span> |
|
10378 |
|
10379 |
|
10380 |
|
10381 |
|
10382 |
|
10383 |
|
10384 |
|
10385 <span class="flag chainable">chainable</span> |
|
10386 |
|
10387 |
|
10388 |
|
10389 |
|
10390 <div class="meta"> |
|
10391 |
|
10392 |
|
10393 <p>Inherited from |
|
10394 <a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>: |
|
10395 |
|
10396 |
|
10397 |
|
10398 <a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a> |
|
10399 |
|
10400 </p> |
|
10401 |
|
10402 |
|
10403 |
|
10404 |
|
10405 |
|
10406 </div> |
|
10407 |
|
10408 <div class="description"> |
|
10409 <p>Provides the common implementation for the public set and protected _set methods.</p> |
|
10410 |
|
10411 <p>See <a href="#method_set">set</a> for argument details.</p> |
|
10412 </div> |
|
10413 |
|
10414 |
|
10415 <div class="params"> |
|
10416 <h4>Parameters:</h4> |
|
10417 |
|
10418 <ul class="params-list"> |
|
10419 |
|
10420 <li class="param"> |
|
10421 |
|
10422 <code class="param-name">name</code> |
|
10423 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10424 |
|
10425 |
|
10426 |
|
10427 |
|
10428 <div class="param-description"> |
|
10429 <p>The name of the attribute.</p> |
|
10430 </div> |
|
10431 |
|
10432 |
|
10433 </li> |
|
10434 |
|
10435 <li class="param"> |
|
10436 |
|
10437 <code class="param-name">value</code> |
|
10438 <span class="type">Any</span> |
|
10439 |
|
10440 |
|
10441 |
|
10442 |
|
10443 <div class="param-description"> |
|
10444 <p>The value to set the attribute to.</p> |
|
10445 </div> |
|
10446 |
|
10447 |
|
10448 </li> |
|
10449 |
|
10450 <li class="param"> |
|
10451 |
|
10452 <code class="param-name optional">[opts]</code> |
|
10453 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10454 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10455 |
|
10456 |
|
10457 |
|
10458 |
|
10459 <div class="param-description"> |
|
10460 <p>Optional data providing the circumstances for the change.</p> |
|
10461 </div> |
|
10462 |
|
10463 |
|
10464 </li> |
|
10465 |
|
10466 <li class="param"> |
|
10467 |
|
10468 <code class="param-name">force</code> |
|
10469 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
10470 |
|
10471 |
|
10472 |
|
10473 |
|
10474 <div class="param-description"> |
|
10475 <p>If true, allows the caller to set values for |
|
10476 readOnly or writeOnce attributes which have already been set.</p> |
|
10477 </div> |
|
10478 |
|
10479 |
|
10480 </li> |
|
10481 |
|
10482 </ul> |
|
10483 </div> |
|
10484 |
|
10485 |
|
10486 |
|
10487 <div class="returns"> |
|
10488 <h4>Returns:</h4> |
|
10489 |
|
10490 <div class="returns-description"> |
|
10491 |
|
10492 |
|
10493 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10494 |
|
10495 A reference to the host object. |
|
10496 |
|
10497 </div> |
|
10498 </div> |
|
10499 |
|
10500 |
|
10501 |
|
10502 </div> |
|
10503 |
|
10504 |
|
10505 <div id="method__setAttrs" class="method item protected inherited"> |
|
10506 <h3 class="name"><code>_setAttrs</code></h3> |
|
10507 |
|
10508 |
|
10509 <div class="args"> |
|
10510 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10511 |
|
10512 <li class="arg"> |
|
10513 |
|
10514 <code>attrs</code> |
|
10515 |
|
10516 </li> |
|
10517 |
|
10518 <li class="arg"> |
|
10519 |
|
10520 <code class="optional">[opts]</code> |
|
10521 |
|
10522 </li> |
|
10523 |
|
10524 </ul><span class="paren">)</span> |
|
10525 </div> |
|
10526 |
|
10527 |
|
10528 |
|
10529 <span class="returns-inline"> |
|
10530 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10531 </span> |
|
10532 |
|
10533 |
|
10534 |
|
10535 |
|
10536 |
|
10537 <span class="flag protected">protected</span> |
|
10538 |
|
10539 |
|
10540 |
|
10541 |
|
10542 |
|
10543 |
|
10544 |
|
10545 <span class="flag chainable">chainable</span> |
|
10546 |
|
10547 |
|
10548 |
|
10549 |
|
10550 <div class="meta"> |
|
10551 |
|
10552 <p>Inherited from |
|
10553 <a href="../classes/AttributeObservable.html#method__setAttrs"> |
|
10554 AttributeObservable |
|
10555 </a> |
|
10556 |
|
10557 but overwritten in |
|
10558 |
|
10559 |
|
10560 |
|
10561 <a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a> |
|
10562 |
|
10563 </p> |
|
10564 |
|
10565 |
|
10566 |
|
10567 |
|
10568 |
|
10569 </div> |
|
10570 |
|
10571 <div class="description"> |
|
10572 <p>Implementation behind the public setAttrs method, to set multiple attribute values.</p> |
|
10573 </div> |
|
10574 |
|
10575 |
|
10576 <div class="params"> |
|
10577 <h4>Parameters:</h4> |
|
10578 |
|
10579 <ul class="params-list"> |
|
10580 |
|
10581 <li class="param"> |
|
10582 |
|
10583 <code class="param-name">attrs</code> |
|
10584 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10585 |
|
10586 |
|
10587 |
|
10588 |
|
10589 <div class="param-description"> |
|
10590 <p>An object with attributes name/value pairs.</p> |
|
10591 </div> |
|
10592 |
|
10593 |
|
10594 </li> |
|
10595 |
|
10596 <li class="param"> |
|
10597 |
|
10598 <code class="param-name optional">[opts]</code> |
|
10599 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10600 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10601 |
|
10602 |
|
10603 |
|
10604 |
|
10605 <div class="param-description"> |
|
10606 <p>Optional data providing the circumstances for the change</p> |
|
10607 </div> |
|
10608 |
|
10609 |
|
10610 </li> |
|
10611 |
|
10612 </ul> |
|
10613 </div> |
|
10614 |
|
10615 |
|
10616 |
|
10617 <div class="returns"> |
|
10618 <h4>Returns:</h4> |
|
10619 |
|
10620 <div class="returns-description"> |
|
10621 |
|
10622 |
|
10623 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10624 |
|
10625 A reference to the host object. |
|
10626 |
|
10627 </div> |
|
10628 </div> |
|
10629 |
|
10630 |
|
10631 |
|
10632 </div> |
|
10633 |
|
10634 |
|
10635 <div id="method__setAttrVal" class="method item private inherited"> |
|
10636 <h3 class="name"><code>_setAttrVal</code></h3> |
|
10637 |
|
10638 |
|
10639 <div class="args"> |
|
10640 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10641 |
|
10642 <li class="arg"> |
|
10643 |
|
10644 <code>attrName</code> |
|
10645 |
|
10646 </li> |
|
10647 |
|
10648 <li class="arg"> |
|
10649 |
|
10650 <code>subAttrName</code> |
|
10651 |
|
10652 </li> |
|
10653 |
|
10654 <li class="arg"> |
|
10655 |
|
10656 <code>prevVal</code> |
|
10657 |
|
10658 </li> |
|
10659 |
|
10660 <li class="arg"> |
|
10661 |
|
10662 <code>newVal</code> |
|
10663 |
|
10664 </li> |
|
10665 |
|
10666 <li class="arg"> |
|
10667 |
|
10668 <code class="optional">[opts]</code> |
|
10669 |
|
10670 </li> |
|
10671 |
|
10672 <li class="arg"> |
|
10673 |
|
10674 <code class="optional">[attrCfg]</code> |
|
10675 |
|
10676 </li> |
|
10677 |
|
10678 </ul><span class="paren">)</span> |
|
10679 </div> |
|
10680 |
|
10681 |
|
10682 |
|
10683 <span class="returns-inline"> |
|
10684 <span class="type">Booolean</span> |
|
10685 </span> |
|
10686 |
|
10687 |
|
10688 |
|
10689 |
|
10690 |
|
10691 <span class="flag private">private</span> |
|
10692 |
|
10693 |
|
10694 |
|
10695 |
|
10696 |
|
10697 |
|
10698 |
|
10699 |
|
10700 |
|
10701 |
|
10702 <div class="meta"> |
|
10703 |
|
10704 |
|
10705 <p>Inherited from |
|
10706 <a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>: |
|
10707 |
|
10708 |
|
10709 |
|
10710 <a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a> |
|
10711 |
|
10712 </p> |
|
10713 |
|
10714 |
|
10715 |
|
10716 |
|
10717 |
|
10718 </div> |
|
10719 |
|
10720 <div class="description"> |
|
10721 <p>Updates the stored value of the attribute in the privately held State object, |
|
10722 if validation and setter passes.</p> |
|
10723 </div> |
|
10724 |
|
10725 |
|
10726 <div class="params"> |
|
10727 <h4>Parameters:</h4> |
|
10728 |
|
10729 <ul class="params-list"> |
|
10730 |
|
10731 <li class="param"> |
|
10732 |
|
10733 <code class="param-name">attrName</code> |
|
10734 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10735 |
|
10736 |
|
10737 |
|
10738 |
|
10739 <div class="param-description"> |
|
10740 <p>The attribute name.</p> |
|
10741 </div> |
|
10742 |
|
10743 |
|
10744 </li> |
|
10745 |
|
10746 <li class="param"> |
|
10747 |
|
10748 <code class="param-name">subAttrName</code> |
|
10749 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10750 |
|
10751 |
|
10752 |
|
10753 |
|
10754 <div class="param-description"> |
|
10755 <p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p> |
|
10756 </div> |
|
10757 |
|
10758 |
|
10759 </li> |
|
10760 |
|
10761 <li class="param"> |
|
10762 |
|
10763 <code class="param-name">prevVal</code> |
|
10764 <span class="type">Any</span> |
|
10765 |
|
10766 |
|
10767 |
|
10768 |
|
10769 <div class="param-description"> |
|
10770 <p>The currently stored value of the attribute.</p> |
|
10771 </div> |
|
10772 |
|
10773 |
|
10774 </li> |
|
10775 |
|
10776 <li class="param"> |
|
10777 |
|
10778 <code class="param-name">newVal</code> |
|
10779 <span class="type">Any</span> |
|
10780 |
|
10781 |
|
10782 |
|
10783 |
|
10784 <div class="param-description"> |
|
10785 <p>The value which is going to be stored.</p> |
|
10786 </div> |
|
10787 |
|
10788 |
|
10789 </li> |
|
10790 |
|
10791 <li class="param"> |
|
10792 |
|
10793 <code class="param-name optional">[opts]</code> |
|
10794 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10795 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10796 |
|
10797 |
|
10798 |
|
10799 |
|
10800 <div class="param-description"> |
|
10801 <p>Optional data providing the circumstances for the change.</p> |
|
10802 </div> |
|
10803 |
|
10804 |
|
10805 </li> |
|
10806 |
|
10807 <li class="param"> |
|
10808 |
|
10809 <code class="param-name optional">[attrCfg]</code> |
|
10810 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10811 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10812 |
|
10813 |
|
10814 |
|
10815 |
|
10816 <div class="param-description"> |
|
10817 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
10818 where the calling method has already obtained the config from state.</p> |
|
10819 </div> |
|
10820 |
|
10821 |
|
10822 </li> |
|
10823 |
|
10824 </ul> |
|
10825 </div> |
|
10826 |
|
10827 |
|
10828 |
|
10829 <div class="returns"> |
|
10830 <h4>Returns:</h4> |
|
10831 |
|
10832 <div class="returns-description"> |
|
10833 |
|
10834 |
|
10835 <span class="type">Booolean</span>: |
|
10836 |
|
10837 true if the new attribute value was stored, false if not. |
|
10838 |
|
10839 </div> |
|
10840 </div> |
|
10841 |
|
10842 |
|
10843 |
|
10844 </div> |
|
10845 |
|
10846 |
|
10847 <div id="method__setRoutes" class="method item protected inherited"> |
|
10848 <h3 class="name"><code>_setRoutes</code></h3> |
|
10849 |
|
10850 |
|
10851 <div class="args"> |
|
10852 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10853 |
|
10854 <li class="arg"> |
|
10855 |
|
10856 <code>routes</code> |
|
10857 |
|
10858 </li> |
|
10859 |
|
10860 </ul><span class="paren">)</span> |
|
10861 </div> |
|
10862 |
|
10863 |
|
10864 |
|
10865 <span class="returns-inline"> |
|
10866 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
10867 </span> |
|
10868 |
|
10869 |
|
10870 |
|
10871 |
|
10872 |
|
10873 <span class="flag protected">protected</span> |
|
10874 |
|
10875 |
|
10876 |
|
10877 |
|
10878 |
|
10879 |
|
10880 |
|
10881 |
|
10882 |
|
10883 |
|
10884 <div class="meta"> |
|
10885 |
|
10886 |
|
10887 <p>Inherited from |
|
10888 <a href="../classes/Router.html#method__setRoutes">Router</a>: |
|
10889 |
|
10890 |
|
10891 |
|
10892 <a href="../files/app_js_router.js.html#l1203"><code>app/js/router.js:1203</code></a> |
|
10893 |
|
10894 </p> |
|
10895 |
|
10896 |
|
10897 |
|
10898 |
|
10899 |
|
10900 </div> |
|
10901 |
|
10902 <div class="description"> |
|
10903 <p>Setter for the <code>routes</code> attribute.</p> |
|
10904 </div> |
|
10905 |
|
10906 |
|
10907 <div class="params"> |
|
10908 <h4>Parameters:</h4> |
|
10909 |
|
10910 <ul class="params-list"> |
|
10911 |
|
10912 <li class="param"> |
|
10913 |
|
10914 <code class="param-name">routes</code> |
|
10915 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
10916 |
|
10917 |
|
10918 |
|
10919 |
|
10920 <div class="param-description"> |
|
10921 <p>Array of route objects.</p> |
|
10922 </div> |
|
10923 |
|
10924 |
|
10925 </li> |
|
10926 |
|
10927 </ul> |
|
10928 </div> |
|
10929 |
|
10930 |
|
10931 |
|
10932 <div class="returns"> |
|
10933 <h4>Returns:</h4> |
|
10934 |
|
10935 <div class="returns-description"> |
|
10936 |
|
10937 |
|
10938 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
10939 |
|
10940 Array of route objects. |
|
10941 |
|
10942 </div> |
|
10943 </div> |
|
10944 |
|
10945 |
|
10946 |
|
10947 </div> |
|
10948 |
|
10949 |
|
10950 <div id="method__setStateVal" class="method item private inherited"> |
|
10951 <h3 class="name"><code>_setStateVal</code></h3> |
|
10952 |
|
10953 |
|
10954 <div class="args"> |
|
10955 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10956 |
|
10957 <li class="arg"> |
|
10958 |
|
10959 <code>name</code> |
|
10960 |
|
10961 </li> |
|
10962 |
|
10963 <li class="arg"> |
|
10964 |
|
10965 <code>value</code> |
|
10966 |
|
10967 </li> |
|
10968 |
|
10969 </ul><span class="paren">)</span> |
|
10970 </div> |
|
10971 |
|
10972 |
|
10973 |
|
10974 |
|
10975 |
|
10976 |
|
10977 |
|
10978 <span class="flag private">private</span> |
|
10979 |
|
10980 |
|
10981 |
|
10982 |
|
10983 |
|
10984 |
|
10985 |
|
10986 |
|
10987 |
|
10988 |
|
10989 <div class="meta"> |
|
10990 |
|
10991 |
|
10992 <p>Inherited from |
|
10993 <a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>: |
|
10994 |
|
10995 |
|
10996 |
|
10997 <a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a> |
|
10998 |
|
10999 </p> |
|
11000 |
|
11001 |
|
11002 |
|
11003 |
|
11004 |
|
11005 </div> |
|
11006 |
|
11007 <div class="description"> |
|
11008 <p>Sets the stored value for the attribute, in either the |
|
11009 internal state object, or the state proxy if it exits</p> |
|
11010 </div> |
|
11011 |
|
11012 |
|
11013 <div class="params"> |
|
11014 <h4>Parameters:</h4> |
|
11015 |
|
11016 <ul class="params-list"> |
|
11017 |
|
11018 <li class="param"> |
|
11019 |
|
11020 <code class="param-name">name</code> |
|
11021 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11022 |
|
11023 |
|
11024 |
|
11025 |
|
11026 <div class="param-description"> |
|
11027 <p>The name of the attribute</p> |
|
11028 </div> |
|
11029 |
|
11030 |
|
11031 </li> |
|
11032 |
|
11033 <li class="param"> |
|
11034 |
|
11035 <code class="param-name">value</code> |
|
11036 <span class="type">Any</span> |
|
11037 |
|
11038 |
|
11039 |
|
11040 |
|
11041 <div class="param-description"> |
|
11042 <p>The value of the attribute</p> |
|
11043 </div> |
|
11044 |
|
11045 |
|
11046 </li> |
|
11047 |
|
11048 </ul> |
|
11049 </div> |
|
11050 |
|
11051 |
|
11052 |
|
11053 |
|
11054 |
|
11055 </div> |
|
11056 |
|
11057 |
|
11058 <div id="method__uiSetActiveView" class="method item protected"> |
|
11059 <h3 class="name"><code>_uiSetActiveView</code></h3> |
|
11060 |
|
11061 |
|
11062 <div class="args"> |
|
11063 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11064 |
|
11065 <li class="arg"> |
|
11066 |
|
11067 <code>newView</code> |
|
11068 |
|
11069 </li> |
|
11070 |
|
11071 <li class="arg"> |
|
11072 |
|
11073 <code class="optional">[oldView]</code> |
|
11074 |
|
11075 </li> |
|
11076 |
|
11077 <li class="arg"> |
|
11078 |
|
11079 <code class="optional">[options]</code> |
|
11080 |
|
11081 </li> |
|
11082 |
|
11083 </ul><span class="paren">)</span> |
|
11084 </div> |
|
11085 |
|
11086 |
|
11087 |
|
11088 |
|
11089 |
|
11090 |
|
11091 |
|
11092 <span class="flag protected">protected</span> |
|
11093 |
|
11094 |
|
11095 |
|
11096 |
|
11097 |
|
11098 |
|
11099 |
|
11100 |
|
11101 |
|
11102 |
|
11103 <div class="meta"> |
|
11104 |
|
11105 |
|
11106 |
|
11107 <p> |
|
11108 |
|
11109 Defined in |
|
11110 |
|
11111 |
|
11112 |
|
11113 |
|
11114 <a href="../files/app_js_app-base.js.html#l741"><code>app/js/app-base.js:741</code></a> |
|
11115 |
|
11116 </p> |
|
11117 |
|
11118 |
|
11119 |
|
11120 |
|
11121 |
|
11122 <p>Available since 3.5.0</p> |
|
11123 |
|
11124 </div> |
|
11125 |
|
11126 <div class="description"> |
|
11127 <p>Performs the actual change of this app's <code>activeView</code> by attaching the |
|
11128 <code>newView</code> to this app, and detaching the <code>oldView</code> from this app using any |
|
11129 specified <code>options</code>.</p> |
|
11130 |
|
11131 <p>The <code>newView</code> is attached to the app by rendering it to the <code>viewContainer</code>, |
|
11132 and making this app a bubble target of its events.</p> |
|
11133 |
|
11134 <p>The <code>oldView</code> is detached from the app by removing it from the |
|
11135 <code>viewContainer</code>, and removing this app as a bubble target for its events. |
|
11136 The <code>oldView</code> will either be preserved or properly destroyed.</p> |
|
11137 |
|
11138 <p><strong>Note:</strong> The <code>activeView</code> attribute is read-only and can be changed by |
|
11139 calling the <code>showView()</code> method.</p> |
|
11140 </div> |
|
11141 |
|
11142 |
|
11143 <div class="params"> |
|
11144 <h4>Parameters:</h4> |
|
11145 |
|
11146 <ul class="params-list"> |
|
11147 |
|
11148 <li class="param"> |
|
11149 |
|
11150 <code class="param-name">newView</code> |
|
11151 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
11152 |
|
11153 |
|
11154 |
|
11155 |
|
11156 <div class="param-description"> |
|
11157 <p>The View which is now this app's <code>activeView</code>.</p> |
|
11158 </div> |
|
11159 |
|
11160 |
|
11161 </li> |
|
11162 |
|
11163 <li class="param"> |
|
11164 |
|
11165 <code class="param-name optional">[oldView]</code> |
|
11166 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
11167 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11168 |
|
11169 |
|
11170 |
|
11171 |
|
11172 <div class="param-description"> |
|
11173 <p>The View which was this app's <code>activeView</code>.</p> |
|
11174 </div> |
|
11175 |
|
11176 |
|
11177 </li> |
|
11178 |
|
11179 <li class="param"> |
|
11180 |
|
11181 <code class="param-name optional">[options]</code> |
|
11182 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11183 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11184 |
|
11185 |
|
11186 |
|
11187 |
|
11188 <div class="param-description"> |
|
11189 <p>Optional object containing any of the following |
|
11190 properties:</p> |
|
11191 </div> |
|
11192 |
|
11193 |
|
11194 <ul class="params-list"> |
|
11195 |
|
11196 <li class="param"> |
|
11197 |
|
11198 <code class="param-name optional">[callback]</code> |
|
11199 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
11200 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11201 |
|
11202 |
|
11203 <div class="param-description"> |
|
11204 <p>Optional callback function to call |
|
11205 after new <code>activeView</code> is ready to use, the function will be passed:</p> |
|
11206 </div> |
|
11207 |
|
11208 |
|
11209 <ul class="params-list"> |
|
11210 |
|
11211 <li class="param"> |
|
11212 |
|
11213 <code class="param-name">view</code> |
|
11214 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
11215 |
|
11216 |
|
11217 <div class="param-description"> |
|
11218 A reference to the new |
|
11219 <code>activeView</code>. |
|
11220 </div> |
|
11221 </li> |
|
11222 |
|
11223 </ul> |
|
11224 |
|
11225 </li> |
|
11226 |
|
11227 <li class="param"> |
|
11228 |
|
11229 <code class="param-name optional">[prepend=false]</code> |
|
11230 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11231 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11232 |
|
11233 |
|
11234 <div class="param-description"> |
|
11235 <p>Whether the <code>view</code> should be |
|
11236 prepended instead of appended to the <code>viewContainer</code>.</p> |
|
11237 </div> |
|
11238 |
|
11239 |
|
11240 </li> |
|
11241 |
|
11242 <li class="param"> |
|
11243 |
|
11244 <code class="param-name optional">[render]</code> |
|
11245 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11246 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11247 |
|
11248 |
|
11249 <div class="param-description"> |
|
11250 <p>Whether the <code>view</code> should be rendered. |
|
11251 <strong>Note:</strong> If no value is specified, a view instance will only be |
|
11252 rendered if it's newly created by this method.</p> |
|
11253 </div> |
|
11254 |
|
11255 |
|
11256 </li> |
|
11257 |
|
11258 <li class="param"> |
|
11259 |
|
11260 <code class="param-name optional">[update=false]</code> |
|
11261 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11262 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11263 |
|
11264 |
|
11265 <div class="param-description"> |
|
11266 <p>Whether an existing view should |
|
11267 have its attributes updated by passing the <code>config</code> object to its |
|
11268 <code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if |
|
11269 the <code>view</code> instance is created as a result of calling this method.</p> |
|
11270 </div> |
|
11271 |
|
11272 |
|
11273 </li> |
|
11274 |
|
11275 </ul> |
|
11276 |
|
11277 </li> |
|
11278 |
|
11279 </ul> |
|
11280 </div> |
|
11281 |
|
11282 |
|
11283 |
|
11284 |
|
11285 |
|
11286 </div> |
|
11287 |
|
11288 |
|
11289 <div id="method__upgradeURL" class="method item protected inherited"> |
|
11290 <h3 class="name"><code>_upgradeURL</code></h3> |
|
11291 |
|
11292 |
|
11293 <div class="args"> |
|
11294 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11295 |
|
11296 <li class="arg"> |
|
11297 |
|
11298 <code>url</code> |
|
11299 |
|
11300 </li> |
|
11301 |
|
11302 </ul><span class="paren">)</span> |
|
11303 </div> |
|
11304 |
|
11305 |
|
11306 |
|
11307 <span class="returns-inline"> |
|
11308 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11309 </span> |
|
11310 |
|
11311 |
|
11312 |
|
11313 |
|
11314 |
|
11315 <span class="flag protected">protected</span> |
|
11316 |
|
11317 |
|
11318 |
|
11319 |
|
11320 |
|
11321 |
|
11322 |
|
11323 |
|
11324 |
|
11325 |
|
11326 <div class="meta"> |
|
11327 |
|
11328 |
|
11329 <p>Inherited from |
|
11330 <a href="../classes/Router.html#method__upgradeURL">Router</a>: |
|
11331 |
|
11332 |
|
11333 |
|
11334 <a href="../files/app_js_router.js.html#l1224"><code>app/js/router.js:1224</code></a> |
|
11335 |
|
11336 </p> |
|
11337 |
|
11338 |
|
11339 |
|
11340 |
|
11341 |
|
11342 <p>Available since 3.5.0</p> |
|
11343 |
|
11344 </div> |
|
11345 |
|
11346 <div class="description"> |
|
11347 <p>Upgrades a hash-based URL to a full-path URL, if necessary.</p> |
|
11348 |
|
11349 <p>The specified <code>url</code> will be upgraded if its of the same origin as the |
|
11350 current URL and has a path-like hash. URLs that don't need upgrading will be |
|
11351 returned as-is.</p> |
|
11352 </div> |
|
11353 |
|
11354 |
|
11355 <div class="params"> |
|
11356 <h4>Parameters:</h4> |
|
11357 |
|
11358 <ul class="params-list"> |
|
11359 |
|
11360 <li class="param"> |
|
11361 |
|
11362 <code class="param-name">url</code> |
|
11363 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11364 |
|
11365 |
|
11366 |
|
11367 |
|
11368 <div class="param-description"> |
|
11369 <p>The URL to upgrade from hash-based to full-path.</p> |
|
11370 </div> |
|
11371 |
|
11372 |
|
11373 </li> |
|
11374 |
|
11375 </ul> |
|
11376 </div> |
|
11377 |
|
11378 |
|
11379 |
|
11380 <div class="returns"> |
|
11381 <h4>Returns:</h4> |
|
11382 |
|
11383 <div class="returns-description"> |
|
11384 |
|
11385 |
|
11386 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
11387 |
|
11388 The upgraded URL, or the specified URL untouched. |
|
11389 |
|
11390 </div> |
|
11391 </div> |
|
11392 |
|
11393 |
|
11394 |
|
11395 <div class="example"> |
|
11396 <h4>Example:</h4> |
|
11397 |
|
11398 <div class="example-content"> |
|
11399 <pre class="code prettyprint"><code>app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/'; |
|
11400 </code></pre> |
|
11401 </div> |
|
11402 </div> |
|
11403 |
|
11404 </div> |
|
11405 |
|
11406 |
|
11407 <div id="method_addAttr" class="method item inherited"> |
|
11408 <h3 class="name"><code>addAttr</code></h3> |
|
11409 |
|
11410 |
|
11411 <div class="args"> |
|
11412 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11413 |
|
11414 <li class="arg"> |
|
11415 |
|
11416 <code>name</code> |
|
11417 |
|
11418 </li> |
|
11419 |
|
11420 <li class="arg"> |
|
11421 |
|
11422 <code>config</code> |
|
11423 |
|
11424 </li> |
|
11425 |
|
11426 <li class="arg"> |
|
11427 |
|
11428 <code>lazy</code> |
|
11429 |
|
11430 </li> |
|
11431 |
|
11432 </ul><span class="paren">)</span> |
|
11433 </div> |
|
11434 |
|
11435 |
|
11436 |
|
11437 <span class="returns-inline"> |
|
11438 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11439 </span> |
|
11440 |
|
11441 |
|
11442 |
|
11443 |
|
11444 |
|
11445 |
|
11446 |
|
11447 |
|
11448 |
|
11449 |
|
11450 |
|
11451 <span class="flag chainable">chainable</span> |
|
11452 |
|
11453 |
|
11454 |
|
11455 |
|
11456 <div class="meta"> |
|
11457 |
|
11458 |
|
11459 <p>Inherited from |
|
11460 <a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>: |
|
11461 |
|
11462 |
|
11463 |
|
11464 <a href="../files/attribute_js_AttributeCore.js.html#l157"><code>attribute/js/AttributeCore.js:157</code></a> |
|
11465 |
|
11466 </p> |
|
11467 |
|
11468 |
|
11469 |
|
11470 |
|
11471 |
|
11472 </div> |
|
11473 |
|
11474 <div class="description"> |
|
11475 <p> |
|
11476 Adds an attribute with the provided configuration to the host object. |
|
11477 </p> |
|
11478 |
|
11479 <p> |
|
11480 The config argument object supports the following properties: |
|
11481 </p> |
|
11482 |
|
11483 <dl> |
|
11484 <dt>value <Any></dt> |
|
11485 <dd>The initial value to set on the attribute</dd> |
|
11486 |
|
11487 <dt>valueFn <Function | String></dt> |
|
11488 <dd> |
|
11489 <p>A function, which will return the initial value to set on the attribute. This is useful |
|
11490 for cases where the attribute configuration is defined statically, but needs to |
|
11491 reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, |
|
11492 the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which |
|
11493 case the value property is used.</p> |
|
11494 |
|
11495 <p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p> |
|
11496 </dd> |
|
11497 |
|
11498 <dt>readOnly <boolean></dt> |
|
11499 <dd>Whether or not the attribute is read only. Attributes having readOnly set to true |
|
11500 cannot be modified by invoking the set method.</dd> |
|
11501 |
|
11502 <dt>writeOnce <boolean> or <string></dt> |
|
11503 <dd> |
|
11504 Whether or not the attribute is "write once". Attributes having writeOnce set to true, |
|
11505 can only have their values set once, be it through the default configuration, |
|
11506 constructor configuration arguments, or by invoking set. |
|
11507 <p>The writeOnce attribute can also be set to the string "initOnly", |
|
11508 in which case the attribute can only be set during initialization |
|
11509 (when used with Base, this means it can only be set during construction)</p> |
|
11510 </dd> |
|
11511 |
|
11512 <dt>setter <Function | String></dt> |
|
11513 <dd> |
|
11514 <p>The setter function used to massage or normalize the value passed to the set method for the attribute. |
|
11515 The value returned by the setter will be the final stored value. Returning |
|
11516 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent |
|
11517 the value from being stored. |
|
11518 </p> |
|
11519 |
|
11520 <p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p> |
|
11521 </dd> |
|
11522 |
|
11523 <dt>getter <Function | String></dt> |
|
11524 <dd> |
|
11525 <p> |
|
11526 The getter function used to massage or normalize the value returned by the get method for the attribute. |
|
11527 The value returned by the getter function is the value which will be returned to the user when they |
|
11528 invoke get. |
|
11529 </p> |
|
11530 |
|
11531 <p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p> |
|
11532 </dd> |
|
11533 |
|
11534 <dt>validator <Function | String></dt> |
|
11535 <dd> |
|
11536 <p> |
|
11537 The validator function invoked prior to setting the stored value. Returning |
|
11538 false from the validator function will prevent the value from being stored. |
|
11539 </p> |
|
11540 |
|
11541 <p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p> |
|
11542 </dd> |
|
11543 |
|
11544 <dt>lazyAdd <boolean></dt> |
|
11545 <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. |
|
11546 This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through |
|
11547 the <a href="#method_addAttrs">addAttrs</a> method.</dd> |
|
11548 |
|
11549 </dl> |
|
11550 |
|
11551 <p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with |
|
11552 the context ("this") set to the host object.</p> |
|
11553 |
|
11554 <p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, |
|
11555 and are not intended for public use.</p> |
|
11556 </div> |
|
11557 |
|
11558 |
|
11559 <div class="params"> |
|
11560 <h4>Parameters:</h4> |
|
11561 |
|
11562 <ul class="params-list"> |
|
11563 |
|
11564 <li class="param"> |
|
11565 |
|
11566 <code class="param-name">name</code> |
|
11567 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11568 |
|
11569 |
|
11570 |
|
11571 |
|
11572 <div class="param-description"> |
|
11573 <p>The name of the attribute.</p> |
|
11574 </div> |
|
11575 |
|
11576 |
|
11577 </li> |
|
11578 |
|
11579 <li class="param"> |
|
11580 |
|
11581 <code class="param-name">config</code> |
|
11582 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11583 |
|
11584 |
|
11585 |
|
11586 |
|
11587 <div class="param-description"> |
|
11588 <p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p> |
|
11589 |
|
11590 <p> |
|
11591 <strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need |
|
11592 to protect the original values, you will need to merge the object. |
|
11593 </p> |
|
11594 </div> |
|
11595 |
|
11596 |
|
11597 </li> |
|
11598 |
|
11599 <li class="param"> |
|
11600 |
|
11601 <code class="param-name">lazy</code> |
|
11602 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11603 |
|
11604 |
|
11605 |
|
11606 |
|
11607 <div class="param-description"> |
|
11608 <p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p> |
|
11609 </div> |
|
11610 |
|
11611 |
|
11612 </li> |
|
11613 |
|
11614 </ul> |
|
11615 </div> |
|
11616 |
|
11617 |
|
11618 |
|
11619 <div class="returns"> |
|
11620 <h4>Returns:</h4> |
|
11621 |
|
11622 <div class="returns-description"> |
|
11623 |
|
11624 |
|
11625 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
11626 |
|
11627 A reference to the host object. |
|
11628 |
|
11629 </div> |
|
11630 </div> |
|
11631 |
|
11632 |
|
11633 |
|
11634 </div> |
|
11635 |
|
11636 |
|
11637 <div id="method_addAttrs" class="method item inherited"> |
|
11638 <h3 class="name"><code>addAttrs</code></h3> |
|
11639 |
|
11640 |
|
11641 <div class="args"> |
|
11642 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11643 |
|
11644 <li class="arg"> |
|
11645 |
|
11646 <code>cfgs</code> |
|
11647 |
|
11648 </li> |
|
11649 |
|
11650 <li class="arg"> |
|
11651 |
|
11652 <code>values</code> |
|
11653 |
|
11654 </li> |
|
11655 |
|
11656 <li class="arg"> |
|
11657 |
|
11658 <code>lazy</code> |
|
11659 |
|
11660 </li> |
|
11661 |
|
11662 </ul><span class="paren">)</span> |
|
11663 </div> |
|
11664 |
|
11665 |
|
11666 |
|
11667 <span class="returns-inline"> |
|
11668 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11669 </span> |
|
11670 |
|
11671 |
|
11672 |
|
11673 |
|
11674 |
|
11675 |
|
11676 |
|
11677 |
|
11678 |
|
11679 |
|
11680 |
|
11681 <span class="flag chainable">chainable</span> |
|
11682 |
|
11683 |
|
11684 |
|
11685 |
|
11686 <div class="meta"> |
|
11687 |
|
11688 |
|
11689 <p>Inherited from |
|
11690 <a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>: |
|
11691 |
|
11692 |
|
11693 |
|
11694 <a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a> |
|
11695 |
|
11696 </p> |
|
11697 |
|
11698 |
|
11699 |
|
11700 |
|
11701 |
|
11702 </div> |
|
11703 |
|
11704 <div class="description"> |
|
11705 <p>Configures a group of attributes, and sets initial values.</p> |
|
11706 |
|
11707 <p> |
|
11708 <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. |
|
11709 The caller is responsible for merging/cloning the configuration object if required. |
|
11710 </p> |
|
11711 </div> |
|
11712 |
|
11713 |
|
11714 <div class="params"> |
|
11715 <h4>Parameters:</h4> |
|
11716 |
|
11717 <ul class="params-list"> |
|
11718 |
|
11719 <li class="param"> |
|
11720 |
|
11721 <code class="param-name">cfgs</code> |
|
11722 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11723 |
|
11724 |
|
11725 |
|
11726 |
|
11727 <div class="param-description"> |
|
11728 <p>An object with attribute name/configuration pairs.</p> |
|
11729 </div> |
|
11730 |
|
11731 |
|
11732 </li> |
|
11733 |
|
11734 <li class="param"> |
|
11735 |
|
11736 <code class="param-name">values</code> |
|
11737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11738 |
|
11739 |
|
11740 |
|
11741 |
|
11742 <div class="param-description"> |
|
11743 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
11744 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
11745 </div> |
|
11746 |
|
11747 |
|
11748 </li> |
|
11749 |
|
11750 <li class="param"> |
|
11751 |
|
11752 <code class="param-name">lazy</code> |
|
11753 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11754 |
|
11755 |
|
11756 |
|
11757 |
|
11758 <div class="param-description"> |
|
11759 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
11760 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
11761 See <a href="#method_addAttr">addAttr</a>.</p> |
|
11762 </div> |
|
11763 |
|
11764 |
|
11765 </li> |
|
11766 |
|
11767 </ul> |
|
11768 </div> |
|
11769 |
|
11770 |
|
11771 |
|
11772 <div class="returns"> |
|
11773 <h4>Returns:</h4> |
|
11774 |
|
11775 <div class="returns-description"> |
|
11776 |
|
11777 |
|
11778 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
11779 |
|
11780 A reference to the host object. |
|
11781 |
|
11782 </div> |
|
11783 </div> |
|
11784 |
|
11785 |
|
11786 |
|
11787 </div> |
|
11788 |
|
11789 |
|
11790 <div id="method_addTarget" class="method item inherited"> |
|
11791 <h3 class="name"><code>addTarget</code></h3> |
|
11792 |
|
11793 |
|
11794 <div class="args"> |
|
11795 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11796 |
|
11797 <li class="arg"> |
|
11798 |
|
11799 <code>o</code> |
|
11800 |
|
11801 </li> |
|
11802 |
|
11803 </ul><span class="paren">)</span> |
|
11804 </div> |
|
11805 |
|
11806 |
|
11807 |
|
11808 |
|
11809 |
|
11810 |
|
11811 |
|
11812 |
|
11813 |
|
11814 |
|
11815 |
|
11816 |
|
11817 |
|
11818 |
|
11819 |
|
11820 |
|
11821 <div class="meta"> |
|
11822 |
|
11823 |
|
11824 <p>Inherited from |
|
11825 <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>: |
|
11826 |
|
11827 |
|
11828 |
|
11829 <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a> |
|
11830 |
|
11831 </p> |
|
11832 |
|
11833 |
|
11834 |
|
11835 |
|
11836 |
|
11837 </div> |
|
11838 |
|
11839 <div class="description"> |
|
11840 <p>Registers another EventTarget as a bubble target. Bubble order |
|
11841 is determined by the order registered. Multiple targets can |
|
11842 be specified.</p> |
|
11843 |
|
11844 <p>Events can only bubble if emitFacade is true.</p> |
|
11845 |
|
11846 <p>Included in the event-custom-complex submodule.</p> |
|
11847 </div> |
|
11848 |
|
11849 |
|
11850 <div class="params"> |
|
11851 <h4>Parameters:</h4> |
|
11852 |
|
11853 <ul class="params-list"> |
|
11854 |
|
11855 <li class="param"> |
|
11856 |
|
11857 <code class="param-name">o</code> |
|
11858 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
11859 |
|
11860 |
|
11861 |
|
11862 |
|
11863 <div class="param-description"> |
|
11864 <p>the target to add</p> |
|
11865 </div> |
|
11866 |
|
11867 |
|
11868 </li> |
|
11869 |
|
11870 </ul> |
|
11871 </div> |
|
11872 |
|
11873 |
|
11874 |
|
11875 |
|
11876 |
|
11877 </div> |
|
11878 |
|
11879 |
|
11880 <div id="method_after" class="method item inherited"> |
|
11881 <h3 class="name"><code>after</code></h3> |
|
11882 |
|
11883 |
|
11884 <div class="args"> |
|
11885 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11886 |
|
11887 <li class="arg"> |
|
11888 |
|
11889 <code>type</code> |
|
11890 |
|
11891 </li> |
|
11892 |
|
11893 <li class="arg"> |
|
11894 |
|
11895 <code>fn</code> |
|
11896 |
|
11897 </li> |
|
11898 |
|
11899 <li class="arg"> |
|
11900 |
|
11901 <code class="optional">[context]</code> |
|
11902 |
|
11903 </li> |
|
11904 |
|
11905 <li class="arg"> |
|
11906 |
|
11907 <code class="optional">[arg*]</code> |
|
11908 |
|
11909 </li> |
|
11910 |
|
11911 </ul><span class="paren">)</span> |
|
11912 </div> |
|
11913 |
|
11914 |
|
11915 |
|
11916 <span class="returns-inline"> |
|
11917 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
11918 </span> |
|
11919 |
|
11920 |
|
11921 |
|
11922 |
|
11923 |
|
11924 |
|
11925 |
|
11926 |
|
11927 |
|
11928 |
|
11929 |
|
11930 |
|
11931 |
|
11932 |
|
11933 <div class="meta"> |
|
11934 |
|
11935 |
|
11936 <p>Inherited from |
|
11937 <a href="../classes/EventTarget.html#method_after">EventTarget</a>: |
|
11938 |
|
11939 |
|
11940 |
|
11941 <a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a> |
|
11942 |
|
11943 </p> |
|
11944 |
|
11945 |
|
11946 |
|
11947 |
|
11948 |
|
11949 </div> |
|
11950 |
|
11951 <div class="description"> |
|
11952 <p>Subscribe to a custom event hosted by this object. The |
|
11953 supplied callback will execute after any listeners add |
|
11954 via the subscribe method, and after the default function, |
|
11955 if configured for the event, has executed.</p> |
|
11956 </div> |
|
11957 |
|
11958 |
|
11959 <div class="params"> |
|
11960 <h4>Parameters:</h4> |
|
11961 |
|
11962 <ul class="params-list"> |
|
11963 |
|
11964 <li class="param"> |
|
11965 |
|
11966 <code class="param-name">type</code> |
|
11967 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11968 |
|
11969 |
|
11970 |
|
11971 |
|
11972 <div class="param-description"> |
|
11973 <p>The name of the event</p> |
|
11974 </div> |
|
11975 |
|
11976 |
|
11977 </li> |
|
11978 |
|
11979 <li class="param"> |
|
11980 |
|
11981 <code class="param-name">fn</code> |
|
11982 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
11983 |
|
11984 |
|
11985 |
|
11986 |
|
11987 <div class="param-description"> |
|
11988 <p>The callback to execute in response to the event</p> |
|
11989 </div> |
|
11990 |
|
11991 |
|
11992 </li> |
|
11993 |
|
11994 <li class="param"> |
|
11995 |
|
11996 <code class="param-name optional">[context]</code> |
|
11997 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11998 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11999 |
|
12000 |
|
12001 |
|
12002 |
|
12003 <div class="param-description"> |
|
12004 <p>Override <code>this</code> object in callback</p> |
|
12005 </div> |
|
12006 |
|
12007 |
|
12008 </li> |
|
12009 |
|
12010 <li class="param"> |
|
12011 |
|
12012 <code class="param-name optional">[arg*]</code> |
|
12013 <span class="type">Any</span> |
|
12014 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12015 |
|
12016 |
|
12017 |
|
12018 |
|
12019 <div class="param-description"> |
|
12020 <p>0..n additional arguments to supply to the subscriber</p> |
|
12021 </div> |
|
12022 |
|
12023 |
|
12024 </li> |
|
12025 |
|
12026 </ul> |
|
12027 </div> |
|
12028 |
|
12029 |
|
12030 |
|
12031 <div class="returns"> |
|
12032 <h4>Returns:</h4> |
|
12033 |
|
12034 <div class="returns-description"> |
|
12035 |
|
12036 |
|
12037 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
12038 |
|
12039 A subscription handle capable of detaching the |
|
12040 subscription |
|
12041 |
|
12042 </div> |
|
12043 </div> |
|
12044 |
|
12045 |
|
12046 |
|
12047 </div> |
|
12048 |
|
12049 |
|
12050 <div id="method_attachEvents" class="method item inherited"> |
|
12051 <h3 class="name"><code>attachEvents</code></h3> |
|
12052 |
|
12053 |
|
12054 <div class="args"> |
|
12055 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12056 |
|
12057 <li class="arg"> |
|
12058 |
|
12059 <code class="optional">[events]</code> |
|
12060 |
|
12061 </li> |
|
12062 |
|
12063 </ul><span class="paren">)</span> |
|
12064 </div> |
|
12065 |
|
12066 |
|
12067 |
|
12068 |
|
12069 |
|
12070 |
|
12071 |
|
12072 |
|
12073 |
|
12074 |
|
12075 |
|
12076 |
|
12077 |
|
12078 <span class="flag chainable">chainable</span> |
|
12079 |
|
12080 |
|
12081 |
|
12082 |
|
12083 <div class="meta"> |
|
12084 |
|
12085 |
|
12086 <p>Inherited from |
|
12087 <a href="../classes/View.html#method_attachEvents">View</a>: |
|
12088 |
|
12089 |
|
12090 |
|
12091 <a href="../files/app_js_view.js.html#l181"><code>app/js/view.js:181</code></a> |
|
12092 |
|
12093 </p> |
|
12094 |
|
12095 |
|
12096 |
|
12097 |
|
12098 |
|
12099 </div> |
|
12100 |
|
12101 <div class="description"> |
|
12102 <p>Attaches delegated event handlers to this view's container element. This |
|
12103 method is called internally to subscribe to events configured in the |
|
12104 <code>events</code> attribute when the view is initialized.</p> |
|
12105 |
|
12106 <p>You may override this method to customize the event attaching logic.</p> |
|
12107 </div> |
|
12108 |
|
12109 |
|
12110 <div class="params"> |
|
12111 <h4>Parameters:</h4> |
|
12112 |
|
12113 <ul class="params-list"> |
|
12114 |
|
12115 <li class="param"> |
|
12116 |
|
12117 <code class="param-name optional">[events]</code> |
|
12118 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12119 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12120 |
|
12121 |
|
12122 |
|
12123 |
|
12124 <div class="param-description"> |
|
12125 <p>Hash of events to attach. See the docs for the |
|
12126 <code>events</code> attribute for details on the format. If not specified, this |
|
12127 view's <code>events</code> property will be used.</p> |
|
12128 </div> |
|
12129 |
|
12130 |
|
12131 </li> |
|
12132 |
|
12133 </ul> |
|
12134 </div> |
|
12135 |
|
12136 |
|
12137 |
|
12138 |
|
12139 |
|
12140 </div> |
|
12141 |
|
12142 |
|
12143 <div id="method_attrAdded" class="method item inherited"> |
|
12144 <h3 class="name"><code>attrAdded</code></h3> |
|
12145 |
|
12146 |
|
12147 <div class="args"> |
|
12148 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12149 |
|
12150 <li class="arg"> |
|
12151 |
|
12152 <code>name</code> |
|
12153 |
|
12154 </li> |
|
12155 |
|
12156 </ul><span class="paren">)</span> |
|
12157 </div> |
|
12158 |
|
12159 |
|
12160 |
|
12161 <span class="returns-inline"> |
|
12162 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12163 </span> |
|
12164 |
|
12165 |
|
12166 |
|
12167 |
|
12168 |
|
12169 |
|
12170 |
|
12171 |
|
12172 |
|
12173 |
|
12174 |
|
12175 |
|
12176 |
|
12177 |
|
12178 <div class="meta"> |
|
12179 |
|
12180 |
|
12181 <p>Inherited from |
|
12182 <a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>: |
|
12183 |
|
12184 |
|
12185 |
|
12186 <a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a> |
|
12187 |
|
12188 </p> |
|
12189 |
|
12190 |
|
12191 |
|
12192 |
|
12193 |
|
12194 </div> |
|
12195 |
|
12196 <div class="description"> |
|
12197 <p>Checks if the given attribute has been added to the host</p> |
|
12198 </div> |
|
12199 |
|
12200 |
|
12201 <div class="params"> |
|
12202 <h4>Parameters:</h4> |
|
12203 |
|
12204 <ul class="params-list"> |
|
12205 |
|
12206 <li class="param"> |
|
12207 |
|
12208 <code class="param-name">name</code> |
|
12209 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12210 |
|
12211 |
|
12212 |
|
12213 |
|
12214 <div class="param-description"> |
|
12215 <p>The name of the attribute to check.</p> |
|
12216 </div> |
|
12217 |
|
12218 |
|
12219 </li> |
|
12220 |
|
12221 </ul> |
|
12222 </div> |
|
12223 |
|
12224 |
|
12225 |
|
12226 <div class="returns"> |
|
12227 <h4>Returns:</h4> |
|
12228 |
|
12229 <div class="returns-description"> |
|
12230 |
|
12231 |
|
12232 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
12233 |
|
12234 true if an attribute with the given name has been added, false if it hasn't. |
|
12235 This method will return true for lazily added attributes. |
|
12236 |
|
12237 </div> |
|
12238 </div> |
|
12239 |
|
12240 |
|
12241 |
|
12242 </div> |
|
12243 |
|
12244 |
|
12245 <div id="method_before" class="method item inherited"> |
|
12246 <h3 class="name"><code>before</code></h3> |
|
12247 |
|
12248 |
|
12249 <span class="paren">()</span> |
|
12250 |
|
12251 |
|
12252 |
|
12253 <span class="returns-inline"> |
|
12254 <span class="type"></span> |
|
12255 </span> |
|
12256 |
|
12257 |
|
12258 |
|
12259 |
|
12260 |
|
12261 |
|
12262 |
|
12263 |
|
12264 |
|
12265 |
|
12266 |
|
12267 |
|
12268 |
|
12269 |
|
12270 <div class="meta"> |
|
12271 |
|
12272 |
|
12273 <p>Inherited from |
|
12274 <a href="../classes/EventTarget.html#method_before">EventTarget</a>: |
|
12275 |
|
12276 |
|
12277 |
|
12278 <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a> |
|
12279 |
|
12280 </p> |
|
12281 |
|
12282 |
|
12283 |
|
12284 |
|
12285 |
|
12286 </div> |
|
12287 |
|
12288 <div class="description"> |
|
12289 <p>Executes the callback before a DOM event, custom event |
|
12290 or method. If the first argument is a function, it |
|
12291 is assumed the target is a method. For DOM and custom |
|
12292 events, this is an alias for Y.on.</p> |
|
12293 |
|
12294 <p>For DOM and custom events: |
|
12295 type, callback, context, 0-n arguments</p> |
|
12296 |
|
12297 <p>For methods: |
|
12298 callback, object (method host), methodName, context, 0-n arguments</p> |
|
12299 </div> |
|
12300 |
|
12301 |
|
12302 |
|
12303 |
|
12304 <div class="returns"> |
|
12305 <h4>Returns:</h4> |
|
12306 |
|
12307 <div class="returns-description"> |
|
12308 |
|
12309 |
|
12310 detach handle |
|
12311 |
|
12312 </div> |
|
12313 </div> |
|
12314 |
|
12315 |
|
12316 |
|
12317 </div> |
|
12318 |
|
12319 |
|
12320 <div id="method_bubble" class="method item inherited"> |
|
12321 <h3 class="name"><code>bubble</code></h3> |
|
12322 |
|
12323 |
|
12324 <div class="args"> |
|
12325 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12326 |
|
12327 <li class="arg"> |
|
12328 |
|
12329 <code>evt</code> |
|
12330 |
|
12331 </li> |
|
12332 |
|
12333 </ul><span class="paren">)</span> |
|
12334 </div> |
|
12335 |
|
12336 |
|
12337 |
|
12338 <span class="returns-inline"> |
|
12339 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12340 </span> |
|
12341 |
|
12342 |
|
12343 |
|
12344 |
|
12345 |
|
12346 |
|
12347 |
|
12348 |
|
12349 |
|
12350 |
|
12351 |
|
12352 |
|
12353 |
|
12354 |
|
12355 <div class="meta"> |
|
12356 |
|
12357 |
|
12358 <p>Inherited from |
|
12359 <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>: |
|
12360 |
|
12361 |
|
12362 |
|
12363 <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a> |
|
12364 |
|
12365 </p> |
|
12366 |
|
12367 |
|
12368 |
|
12369 |
|
12370 |
|
12371 </div> |
|
12372 |
|
12373 <div class="description"> |
|
12374 <p>Propagate an event. Requires the event-custom-complex module.</p> |
|
12375 </div> |
|
12376 |
|
12377 |
|
12378 <div class="params"> |
|
12379 <h4>Parameters:</h4> |
|
12380 |
|
12381 <ul class="params-list"> |
|
12382 |
|
12383 <li class="param"> |
|
12384 |
|
12385 <code class="param-name">evt</code> |
|
12386 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
12387 |
|
12388 |
|
12389 |
|
12390 |
|
12391 <div class="param-description"> |
|
12392 <p>the custom event to propagate</p> |
|
12393 </div> |
|
12394 |
|
12395 |
|
12396 </li> |
|
12397 |
|
12398 </ul> |
|
12399 </div> |
|
12400 |
|
12401 |
|
12402 |
|
12403 <div class="returns"> |
|
12404 <h4>Returns:</h4> |
|
12405 |
|
12406 <div class="returns-description"> |
|
12407 |
|
12408 |
|
12409 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
12410 |
|
12411 the aggregated return value from Event.Custom.fire |
|
12412 |
|
12413 </div> |
|
12414 </div> |
|
12415 |
|
12416 |
|
12417 |
|
12418 </div> |
|
12419 |
|
12420 |
|
12421 <div id="method_create" class="method item inherited"> |
|
12422 <h3 class="name"><code>create</code></h3> |
|
12423 |
|
12424 |
|
12425 <div class="args"> |
|
12426 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12427 |
|
12428 <li class="arg"> |
|
12429 |
|
12430 <code class="optional">[container]</code> |
|
12431 |
|
12432 </li> |
|
12433 |
|
12434 </ul><span class="paren">)</span> |
|
12435 </div> |
|
12436 |
|
12437 |
|
12438 |
|
12439 <span class="returns-inline"> |
|
12440 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span> |
|
12441 </span> |
|
12442 |
|
12443 |
|
12444 |
|
12445 |
|
12446 |
|
12447 |
|
12448 |
|
12449 |
|
12450 |
|
12451 |
|
12452 |
|
12453 |
|
12454 |
|
12455 |
|
12456 <div class="meta"> |
|
12457 |
|
12458 |
|
12459 <p>Inherited from |
|
12460 <a href="../classes/View.html#method_create">View</a>: |
|
12461 |
|
12462 |
|
12463 |
|
12464 <a href="../files/app_js_view.js.html#l233"><code>app/js/view.js:233</code></a> |
|
12465 |
|
12466 </p> |
|
12467 |
|
12468 |
|
12469 |
|
12470 |
|
12471 |
|
12472 </div> |
|
12473 |
|
12474 <div class="description"> |
|
12475 <p>Creates and returns a container node for this view.</p> |
|
12476 |
|
12477 <p>By default, the container is created from the HTML template specified in the |
|
12478 <code>containerTemplate</code> property, and is <em>not</em> added to the DOM automatically.</p> |
|
12479 |
|
12480 <p>You may override this method to customize how the container node is created |
|
12481 (such as by rendering it from a custom template format). Your method must |
|
12482 return a <code>Y.Node</code> instance.</p> |
|
12483 </div> |
|
12484 |
|
12485 |
|
12486 <div class="params"> |
|
12487 <h4>Parameters:</h4> |
|
12488 |
|
12489 <ul class="params-list"> |
|
12490 |
|
12491 <li class="param"> |
|
12492 |
|
12493 <code class="param-name optional">[container]</code> |
|
12494 <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12495 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12496 |
|
12497 |
|
12498 |
|
12499 |
|
12500 <div class="param-description"> |
|
12501 <p>Selector string, <code>Y.Node</code> |
|
12502 instance, or DOM element to use at the container node.</p> |
|
12503 </div> |
|
12504 |
|
12505 |
|
12506 </li> |
|
12507 |
|
12508 </ul> |
|
12509 </div> |
|
12510 |
|
12511 |
|
12512 |
|
12513 <div class="returns"> |
|
12514 <h4>Returns:</h4> |
|
12515 |
|
12516 <div class="returns-description"> |
|
12517 |
|
12518 |
|
12519 <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>: |
|
12520 |
|
12521 Node instance of the created container node. |
|
12522 |
|
12523 </div> |
|
12524 </div> |
|
12525 |
|
12526 |
|
12527 |
|
12528 </div> |
|
12529 |
|
12530 |
|
12531 <div id="method_createView" class="method item"> |
|
12532 <h3 class="name"><code>createView</code></h3> |
|
12533 |
|
12534 |
|
12535 <div class="args"> |
|
12536 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12537 |
|
12538 <li class="arg"> |
|
12539 |
|
12540 <code>name</code> |
|
12541 |
|
12542 </li> |
|
12543 |
|
12544 <li class="arg"> |
|
12545 |
|
12546 <code class="optional">[config]</code> |
|
12547 |
|
12548 </li> |
|
12549 |
|
12550 </ul><span class="paren">)</span> |
|
12551 </div> |
|
12552 |
|
12553 |
|
12554 |
|
12555 <span class="returns-inline"> |
|
12556 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
12557 </span> |
|
12558 |
|
12559 |
|
12560 |
|
12561 |
|
12562 |
|
12563 |
|
12564 |
|
12565 |
|
12566 |
|
12567 |
|
12568 |
|
12569 |
|
12570 |
|
12571 |
|
12572 <div class="meta"> |
|
12573 |
|
12574 |
|
12575 |
|
12576 <p> |
|
12577 |
|
12578 Defined in |
|
12579 |
|
12580 |
|
12581 |
|
12582 |
|
12583 <a href="../files/app_js_app-base.js.html#l185"><code>app/js/app-base.js:185</code></a> |
|
12584 |
|
12585 </p> |
|
12586 |
|
12587 |
|
12588 |
|
12589 |
|
12590 |
|
12591 <p>Available since 3.5.0</p> |
|
12592 |
|
12593 </div> |
|
12594 |
|
12595 <div class="description"> |
|
12596 <p>Creates and returns a new view instance using the provided <code>name</code> to look up |
|
12597 the view info metadata defined in the <code>views</code> object. The passed-in <code>config</code> |
|
12598 object is passed to the view constructor function.</p> |
|
12599 |
|
12600 <p>This function also maps a view instance back to its view info metadata.</p> |
|
12601 </div> |
|
12602 |
|
12603 |
|
12604 <div class="params"> |
|
12605 <h4>Parameters:</h4> |
|
12606 |
|
12607 <ul class="params-list"> |
|
12608 |
|
12609 <li class="param"> |
|
12610 |
|
12611 <code class="param-name">name</code> |
|
12612 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12613 |
|
12614 |
|
12615 |
|
12616 |
|
12617 <div class="param-description"> |
|
12618 <p>The name of a view defined on the <code>views</code> object.</p> |
|
12619 </div> |
|
12620 |
|
12621 |
|
12622 </li> |
|
12623 |
|
12624 <li class="param"> |
|
12625 |
|
12626 <code class="param-name optional">[config]</code> |
|
12627 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12628 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12629 |
|
12630 |
|
12631 |
|
12632 |
|
12633 <div class="param-description"> |
|
12634 <p>The configuration object passed to the view |
|
12635 constructor function when creating the new view instance.</p> |
|
12636 </div> |
|
12637 |
|
12638 |
|
12639 </li> |
|
12640 |
|
12641 </ul> |
|
12642 </div> |
|
12643 |
|
12644 |
|
12645 |
|
12646 <div class="returns"> |
|
12647 <h4>Returns:</h4> |
|
12648 |
|
12649 <div class="returns-description"> |
|
12650 |
|
12651 |
|
12652 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>: |
|
12653 |
|
12654 The new view instance. |
|
12655 |
|
12656 </div> |
|
12657 </div> |
|
12658 |
|
12659 |
|
12660 |
|
12661 </div> |
|
12662 |
|
12663 |
|
12664 <div id="method_destroy" class="method item inherited"> |
|
12665 <h3 class="name"><code>destroy</code></h3> |
|
12666 |
|
12667 |
|
12668 <div class="args"> |
|
12669 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12670 |
|
12671 <li class="arg"> |
|
12672 |
|
12673 <code class="optional">[options]</code> |
|
12674 |
|
12675 </li> |
|
12676 |
|
12677 </ul><span class="paren">)</span> |
|
12678 </div> |
|
12679 |
|
12680 |
|
12681 |
|
12682 |
|
12683 |
|
12684 |
|
12685 |
|
12686 |
|
12687 |
|
12688 |
|
12689 |
|
12690 |
|
12691 |
|
12692 <span class="flag chainable">chainable</span> |
|
12693 |
|
12694 |
|
12695 |
|
12696 |
|
12697 <div class="meta"> |
|
12698 |
|
12699 <p>Inherited from |
|
12700 <a href="../classes/BaseObservable.html#method_destroy"> |
|
12701 BaseObservable |
|
12702 </a> |
|
12703 |
|
12704 but overwritten in |
|
12705 |
|
12706 |
|
12707 |
|
12708 <a href="../files/app_js_view.js.html#l146"><code>app/js/view.js:146</code></a> |
|
12709 |
|
12710 </p> |
|
12711 |
|
12712 |
|
12713 |
|
12714 |
|
12715 |
|
12716 </div> |
|
12717 |
|
12718 <div class="description"> |
|
12719 <p>Destroys this View, detaching any DOM events and optionally also destroying |
|
12720 its container node.</p> |
|
12721 |
|
12722 <p>By default, the container node will not be destroyed. Pass an <em>options</em> |
|
12723 object with a truthy <code>remove</code> property to destroy the container as well.</p> |
|
12724 </div> |
|
12725 |
|
12726 |
|
12727 <div class="params"> |
|
12728 <h4>Parameters:</h4> |
|
12729 |
|
12730 <ul class="params-list"> |
|
12731 |
|
12732 <li class="param"> |
|
12733 |
|
12734 <code class="param-name optional">[options]</code> |
|
12735 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12736 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12737 |
|
12738 |
|
12739 |
|
12740 |
|
12741 <div class="param-description"> |
|
12742 <p>Options.</p> |
|
12743 </div> |
|
12744 |
|
12745 |
|
12746 <ul class="params-list"> |
|
12747 |
|
12748 <li class="param"> |
|
12749 |
|
12750 <code class="param-name optional">[remove=false]</code> |
|
12751 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12752 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12753 |
|
12754 |
|
12755 <div class="param-description"> |
|
12756 <p>If <code>true</code>, this View's container |
|
12757 will be removed from the DOM and destroyed as well.</p> |
|
12758 </div> |
|
12759 |
|
12760 |
|
12761 </li> |
|
12762 |
|
12763 </ul> |
|
12764 |
|
12765 </li> |
|
12766 |
|
12767 </ul> |
|
12768 </div> |
|
12769 |
|
12770 |
|
12771 |
|
12772 |
|
12773 |
|
12774 </div> |
|
12775 |
|
12776 |
|
12777 <div id="method_detach" class="method item inherited"> |
|
12778 <h3 class="name"><code>detach</code></h3> |
|
12779 |
|
12780 |
|
12781 <div class="args"> |
|
12782 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12783 |
|
12784 <li class="arg"> |
|
12785 |
|
12786 <code>type</code> |
|
12787 |
|
12788 </li> |
|
12789 |
|
12790 <li class="arg"> |
|
12791 |
|
12792 <code>fn</code> |
|
12793 |
|
12794 </li> |
|
12795 |
|
12796 <li class="arg"> |
|
12797 |
|
12798 <code>context</code> |
|
12799 |
|
12800 </li> |
|
12801 |
|
12802 </ul><span class="paren">)</span> |
|
12803 </div> |
|
12804 |
|
12805 |
|
12806 |
|
12807 <span class="returns-inline"> |
|
12808 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
12809 </span> |
|
12810 |
|
12811 |
|
12812 |
|
12813 |
|
12814 |
|
12815 |
|
12816 |
|
12817 |
|
12818 |
|
12819 |
|
12820 |
|
12821 |
|
12822 |
|
12823 |
|
12824 <div class="meta"> |
|
12825 |
|
12826 |
|
12827 <p>Inherited from |
|
12828 <a href="../classes/EventTarget.html#method_detach">EventTarget</a>: |
|
12829 |
|
12830 |
|
12831 |
|
12832 <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a> |
|
12833 |
|
12834 </p> |
|
12835 |
|
12836 |
|
12837 |
|
12838 |
|
12839 |
|
12840 </div> |
|
12841 |
|
12842 <div class="description"> |
|
12843 <p>Detach one or more listeners the from the specified event</p> |
|
12844 </div> |
|
12845 |
|
12846 |
|
12847 <div class="params"> |
|
12848 <h4>Parameters:</h4> |
|
12849 |
|
12850 <ul class="params-list"> |
|
12851 |
|
12852 <li class="param"> |
|
12853 |
|
12854 <code class="param-name">type</code> |
|
12855 <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> |
|
12856 |
|
12857 |
|
12858 |
|
12859 |
|
12860 <div class="param-description"> |
|
12861 <p>Either the handle to the subscriber or the |
|
12862 type of event. If the type |
|
12863 is not specified, it will attempt to remove |
|
12864 the listener from all hosted events.</p> |
|
12865 </div> |
|
12866 |
|
12867 |
|
12868 </li> |
|
12869 |
|
12870 <li class="param"> |
|
12871 |
|
12872 <code class="param-name">fn</code> |
|
12873 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
12874 |
|
12875 |
|
12876 |
|
12877 |
|
12878 <div class="param-description"> |
|
12879 <p>The subscribed function to unsubscribe, if not |
|
12880 supplied, all subscribers will be removed.</p> |
|
12881 </div> |
|
12882 |
|
12883 |
|
12884 </li> |
|
12885 |
|
12886 <li class="param"> |
|
12887 |
|
12888 <code class="param-name">context</code> |
|
12889 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12890 |
|
12891 |
|
12892 |
|
12893 |
|
12894 <div class="param-description"> |
|
12895 <p>The custom object passed to subscribe. This is |
|
12896 optional, but if supplied will be used to |
|
12897 disambiguate multiple listeners that are the same |
|
12898 (e.g., you subscribe many object using a function |
|
12899 that lives on the prototype)</p> |
|
12900 </div> |
|
12901 |
|
12902 |
|
12903 </li> |
|
12904 |
|
12905 </ul> |
|
12906 </div> |
|
12907 |
|
12908 |
|
12909 |
|
12910 <div class="returns"> |
|
12911 <h4>Returns:</h4> |
|
12912 |
|
12913 <div class="returns-description"> |
|
12914 |
|
12915 |
|
12916 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
12917 |
|
12918 the host |
|
12919 |
|
12920 </div> |
|
12921 </div> |
|
12922 |
|
12923 |
|
12924 |
|
12925 </div> |
|
12926 |
|
12927 |
|
12928 <div id="method_detachAll" class="method item inherited"> |
|
12929 <h3 class="name"><code>detachAll</code></h3> |
|
12930 |
|
12931 |
|
12932 <div class="args"> |
|
12933 <span class="paren">(</span><ul class="args-list inline commas"> |
|
12934 |
|
12935 <li class="arg"> |
|
12936 |
|
12937 <code>type</code> |
|
12938 |
|
12939 </li> |
|
12940 |
|
12941 </ul><span class="paren">)</span> |
|
12942 </div> |
|
12943 |
|
12944 |
|
12945 |
|
12946 |
|
12947 |
|
12948 |
|
12949 |
|
12950 |
|
12951 |
|
12952 |
|
12953 |
|
12954 |
|
12955 |
|
12956 |
|
12957 |
|
12958 |
|
12959 <div class="meta"> |
|
12960 |
|
12961 |
|
12962 <p>Inherited from |
|
12963 <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>: |
|
12964 |
|
12965 |
|
12966 |
|
12967 <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a> |
|
12968 |
|
12969 </p> |
|
12970 |
|
12971 |
|
12972 |
|
12973 |
|
12974 |
|
12975 </div> |
|
12976 |
|
12977 <div class="description"> |
|
12978 <p>Removes all listeners from the specified event. If the event type |
|
12979 is not specified, all listeners from all hosted custom events will |
|
12980 be removed.</p> |
|
12981 </div> |
|
12982 |
|
12983 |
|
12984 <div class="params"> |
|
12985 <h4>Parameters:</h4> |
|
12986 |
|
12987 <ul class="params-list"> |
|
12988 |
|
12989 <li class="param"> |
|
12990 |
|
12991 <code class="param-name">type</code> |
|
12992 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12993 |
|
12994 |
|
12995 |
|
12996 |
|
12997 <div class="param-description"> |
|
12998 <p>The type, or name of the event</p> |
|
12999 </div> |
|
13000 |
|
13001 |
|
13002 </li> |
|
13003 |
|
13004 </ul> |
|
13005 </div> |
|
13006 |
|
13007 |
|
13008 |
|
13009 |
|
13010 |
|
13011 </div> |
|
13012 |
|
13013 |
|
13014 <div id="method_detachEvents" class="method item inherited"> |
|
13015 <h3 class="name"><code>detachEvents</code></h3> |
|
13016 |
|
13017 |
|
13018 <span class="paren">()</span> |
|
13019 |
|
13020 |
|
13021 |
|
13022 |
|
13023 |
|
13024 |
|
13025 |
|
13026 |
|
13027 |
|
13028 |
|
13029 |
|
13030 |
|
13031 |
|
13032 <span class="flag chainable">chainable</span> |
|
13033 |
|
13034 |
|
13035 |
|
13036 |
|
13037 <div class="meta"> |
|
13038 |
|
13039 |
|
13040 <p>Inherited from |
|
13041 <a href="../classes/View.html#method_detachEvents">View</a>: |
|
13042 |
|
13043 |
|
13044 |
|
13045 <a href="../files/app_js_view.js.html#l253"><code>app/js/view.js:253</code></a> |
|
13046 |
|
13047 </p> |
|
13048 |
|
13049 |
|
13050 |
|
13051 |
|
13052 |
|
13053 </div> |
|
13054 |
|
13055 <div class="description"> |
|
13056 <p>Detaches DOM events that have previously been attached to the container by |
|
13057 <code>attachEvents()</code>.</p> |
|
13058 </div> |
|
13059 |
|
13060 |
|
13061 |
|
13062 |
|
13063 |
|
13064 |
|
13065 </div> |
|
13066 |
|
13067 |
|
13068 <div id="method_dispatch" class="method item inherited"> |
|
13069 <h3 class="name"><code>dispatch</code></h3> |
|
13070 |
|
13071 |
|
13072 <span class="paren">()</span> |
|
13073 |
|
13074 |
|
13075 |
|
13076 |
|
13077 |
|
13078 |
|
13079 |
|
13080 |
|
13081 |
|
13082 |
|
13083 |
|
13084 |
|
13085 |
|
13086 <span class="flag chainable">chainable</span> |
|
13087 |
|
13088 |
|
13089 |
|
13090 |
|
13091 <div class="meta"> |
|
13092 |
|
13093 |
|
13094 <p>Inherited from |
|
13095 <a href="../classes/Router.html#method_dispatch">Router</a>: |
|
13096 |
|
13097 |
|
13098 |
|
13099 <a href="../files/app_js_router.js.html#l206"><code>app/js/router.js:206</code></a> |
|
13100 |
|
13101 </p> |
|
13102 |
|
13103 |
|
13104 |
|
13105 |
|
13106 |
|
13107 </div> |
|
13108 |
|
13109 <div class="description"> |
|
13110 <p>Dispatches to the first route handler that matches the current URL, if any.</p> |
|
13111 |
|
13112 <p>If <code>dispatch()</code> is called before the <code>ready</code> event has fired, it will |
|
13113 automatically wait for the <code>ready</code> event before dispatching. Otherwise it |
|
13114 will dispatch immediately.</p> |
|
13115 </div> |
|
13116 |
|
13117 |
|
13118 |
|
13119 |
|
13120 |
|
13121 |
|
13122 </div> |
|
13123 |
|
13124 |
|
13125 <div id="method_fire" class="method item inherited"> |
|
13126 <h3 class="name"><code>fire</code></h3> |
|
13127 |
|
13128 |
|
13129 <div class="args"> |
|
13130 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13131 |
|
13132 <li class="arg"> |
|
13133 |
|
13134 <code>type</code> |
|
13135 |
|
13136 </li> |
|
13137 |
|
13138 <li class="arg"> |
|
13139 |
|
13140 <code>arguments</code> |
|
13141 |
|
13142 </li> |
|
13143 |
|
13144 </ul><span class="paren">)</span> |
|
13145 </div> |
|
13146 |
|
13147 |
|
13148 |
|
13149 <span class="returns-inline"> |
|
13150 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
13151 </span> |
|
13152 |
|
13153 |
|
13154 |
|
13155 |
|
13156 |
|
13157 |
|
13158 |
|
13159 |
|
13160 |
|
13161 |
|
13162 |
|
13163 |
|
13164 |
|
13165 |
|
13166 <div class="meta"> |
|
13167 |
|
13168 |
|
13169 <p>Inherited from |
|
13170 <a href="../classes/EventTarget.html#method_fire">EventTarget</a>: |
|
13171 |
|
13172 |
|
13173 |
|
13174 <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a> |
|
13175 |
|
13176 </p> |
|
13177 |
|
13178 |
|
13179 |
|
13180 |
|
13181 |
|
13182 </div> |
|
13183 |
|
13184 <div class="description"> |
|
13185 <p>Fire a custom event by name. The callback functions will be executed |
|
13186 from the context specified when the event was created, and with the |
|
13187 following parameters.</p> |
|
13188 |
|
13189 <p>If the custom event object hasn't been created, then the event hasn't |
|
13190 been published and it has no subscribers. For performance sake, we |
|
13191 immediate exit in this case. This means the event won't bubble, so |
|
13192 if the intention is that a bubble target be notified, the event must |
|
13193 be published on this object first.</p> |
|
13194 |
|
13195 <p>The first argument is the event type, and any additional arguments are |
|
13196 passed to the listeners as parameters. If the first of these is an |
|
13197 object literal, and the event is configured to emit an event facade, |
|
13198 that object is mixed into the event facade and the facade is provided |
|
13199 in place of the original object.</p> |
|
13200 </div> |
|
13201 |
|
13202 |
|
13203 <div class="params"> |
|
13204 <h4>Parameters:</h4> |
|
13205 |
|
13206 <ul class="params-list"> |
|
13207 |
|
13208 <li class="param"> |
|
13209 |
|
13210 <code class="param-name">type</code> |
|
13211 <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> |
|
13212 |
|
13213 |
|
13214 |
|
13215 |
|
13216 <div class="param-description"> |
|
13217 <p>The type of the event, or an object that contains |
|
13218 a 'type' property.</p> |
|
13219 </div> |
|
13220 |
|
13221 |
|
13222 </li> |
|
13223 |
|
13224 <li class="param"> |
|
13225 |
|
13226 <code class="param-name">arguments</code> |
|
13227 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span> |
|
13228 |
|
13229 |
|
13230 |
|
13231 |
|
13232 <div class="param-description"> |
|
13233 <p>an arbitrary set of parameters to pass to |
|
13234 the handler. If the first of these is an object literal and the event is |
|
13235 configured to emit an event facade, the event facade will replace that |
|
13236 parameter after the properties the object literal contains are copied to |
|
13237 the event facade.</p> |
|
13238 </div> |
|
13239 |
|
13240 |
|
13241 </li> |
|
13242 |
|
13243 </ul> |
|
13244 </div> |
|
13245 |
|
13246 |
|
13247 |
|
13248 <div class="returns"> |
|
13249 <h4>Returns:</h4> |
|
13250 |
|
13251 <div class="returns-description"> |
|
13252 |
|
13253 |
|
13254 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
13255 |
|
13256 the event host |
|
13257 |
|
13258 </div> |
|
13259 </div> |
|
13260 |
|
13261 |
|
13262 |
|
13263 </div> |
|
13264 |
|
13265 |
|
13266 <div id="method_get" class="method item inherited"> |
|
13267 <h3 class="name"><code>get</code></h3> |
|
13268 |
|
13269 |
|
13270 <div class="args"> |
|
13271 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13272 |
|
13273 <li class="arg"> |
|
13274 |
|
13275 <code>name</code> |
|
13276 |
|
13277 </li> |
|
13278 |
|
13279 </ul><span class="paren">)</span> |
|
13280 </div> |
|
13281 |
|
13282 |
|
13283 |
|
13284 <span class="returns-inline"> |
|
13285 <span class="type">Any</span> |
|
13286 </span> |
|
13287 |
|
13288 |
|
13289 |
|
13290 |
|
13291 |
|
13292 |
|
13293 |
|
13294 |
|
13295 |
|
13296 |
|
13297 |
|
13298 |
|
13299 |
|
13300 |
|
13301 <div class="meta"> |
|
13302 |
|
13303 |
|
13304 <p>Inherited from |
|
13305 <a href="../classes/AttributeCore.html#method_get">AttributeCore</a>: |
|
13306 |
|
13307 |
|
13308 |
|
13309 <a href="../files/attribute_js_AttributeCore.js.html#l353"><code>attribute/js/AttributeCore.js:353</code></a> |
|
13310 |
|
13311 </p> |
|
13312 |
|
13313 |
|
13314 |
|
13315 |
|
13316 |
|
13317 </div> |
|
13318 |
|
13319 <div class="description"> |
|
13320 <p>Returns the current value of the attribute. If the attribute |
|
13321 has been configured with a 'getter' function, this method will delegate |
|
13322 to the 'getter' to obtain the value of the attribute.</p> |
|
13323 </div> |
|
13324 |
|
13325 |
|
13326 <div class="params"> |
|
13327 <h4>Parameters:</h4> |
|
13328 |
|
13329 <ul class="params-list"> |
|
13330 |
|
13331 <li class="param"> |
|
13332 |
|
13333 <code class="param-name">name</code> |
|
13334 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13335 |
|
13336 |
|
13337 |
|
13338 |
|
13339 <div class="param-description"> |
|
13340 <p>The name of the attribute. If the value of the attribute is an Object, |
|
13341 dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p> |
|
13342 </div> |
|
13343 |
|
13344 |
|
13345 </li> |
|
13346 |
|
13347 </ul> |
|
13348 </div> |
|
13349 |
|
13350 |
|
13351 |
|
13352 <div class="returns"> |
|
13353 <h4>Returns:</h4> |
|
13354 |
|
13355 <div class="returns-description"> |
|
13356 |
|
13357 |
|
13358 <span class="type">Any</span>: |
|
13359 |
|
13360 The value of the attribute |
|
13361 |
|
13362 </div> |
|
13363 </div> |
|
13364 |
|
13365 |
|
13366 |
|
13367 </div> |
|
13368 |
|
13369 |
|
13370 <div id="method_getAttrs" class="method item inherited"> |
|
13371 <h3 class="name"><code>getAttrs</code></h3> |
|
13372 |
|
13373 |
|
13374 <div class="args"> |
|
13375 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13376 |
|
13377 <li class="arg"> |
|
13378 |
|
13379 <code>attrs</code> |
|
13380 |
|
13381 </li> |
|
13382 |
|
13383 </ul><span class="paren">)</span> |
|
13384 </div> |
|
13385 |
|
13386 |
|
13387 |
|
13388 <span class="returns-inline"> |
|
13389 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13390 </span> |
|
13391 |
|
13392 |
|
13393 |
|
13394 |
|
13395 |
|
13396 |
|
13397 |
|
13398 |
|
13399 |
|
13400 |
|
13401 |
|
13402 |
|
13403 |
|
13404 |
|
13405 <div class="meta"> |
|
13406 |
|
13407 |
|
13408 <p>Inherited from |
|
13409 <a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>: |
|
13410 |
|
13411 |
|
13412 |
|
13413 <a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a> |
|
13414 |
|
13415 </p> |
|
13416 |
|
13417 |
|
13418 |
|
13419 |
|
13420 |
|
13421 </div> |
|
13422 |
|
13423 <div class="description"> |
|
13424 <p>Gets multiple attribute values.</p> |
|
13425 </div> |
|
13426 |
|
13427 |
|
13428 <div class="params"> |
|
13429 <h4>Parameters:</h4> |
|
13430 |
|
13431 <ul class="params-list"> |
|
13432 |
|
13433 <li class="param"> |
|
13434 |
|
13435 <code class="param-name">attrs</code> |
|
13436 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
13437 |
|
13438 |
|
13439 |
|
13440 |
|
13441 <div class="param-description"> |
|
13442 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
13443 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
13444 </div> |
|
13445 |
|
13446 |
|
13447 </li> |
|
13448 |
|
13449 </ul> |
|
13450 </div> |
|
13451 |
|
13452 |
|
13453 |
|
13454 <div class="returns"> |
|
13455 <h4>Returns:</h4> |
|
13456 |
|
13457 <div class="returns-description"> |
|
13458 |
|
13459 |
|
13460 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
13461 |
|
13462 An object with attribute name/value pairs. |
|
13463 |
|
13464 </div> |
|
13465 </div> |
|
13466 |
|
13467 |
|
13468 |
|
13469 </div> |
|
13470 |
|
13471 |
|
13472 <div id="method_getEvent" class="method item inherited"> |
|
13473 <h3 class="name"><code>getEvent</code></h3> |
|
13474 |
|
13475 |
|
13476 <div class="args"> |
|
13477 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13478 |
|
13479 <li class="arg"> |
|
13480 |
|
13481 <code>type</code> |
|
13482 |
|
13483 </li> |
|
13484 |
|
13485 <li class="arg"> |
|
13486 |
|
13487 <code>prefixed</code> |
|
13488 |
|
13489 </li> |
|
13490 |
|
13491 </ul><span class="paren">)</span> |
|
13492 </div> |
|
13493 |
|
13494 |
|
13495 |
|
13496 <span class="returns-inline"> |
|
13497 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
13498 </span> |
|
13499 |
|
13500 |
|
13501 |
|
13502 |
|
13503 |
|
13504 |
|
13505 |
|
13506 |
|
13507 |
|
13508 |
|
13509 |
|
13510 |
|
13511 |
|
13512 |
|
13513 <div class="meta"> |
|
13514 |
|
13515 |
|
13516 <p>Inherited from |
|
13517 <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>: |
|
13518 |
|
13519 |
|
13520 |
|
13521 <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a> |
|
13522 |
|
13523 </p> |
|
13524 |
|
13525 |
|
13526 |
|
13527 |
|
13528 |
|
13529 </div> |
|
13530 |
|
13531 <div class="description"> |
|
13532 <p>Returns the custom event of the provided type has been created, a |
|
13533 falsy value otherwise</p> |
|
13534 </div> |
|
13535 |
|
13536 |
|
13537 <div class="params"> |
|
13538 <h4>Parameters:</h4> |
|
13539 |
|
13540 <ul class="params-list"> |
|
13541 |
|
13542 <li class="param"> |
|
13543 |
|
13544 <code class="param-name">type</code> |
|
13545 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13546 |
|
13547 |
|
13548 |
|
13549 |
|
13550 <div class="param-description"> |
|
13551 <p>the type, or name of the event</p> |
|
13552 </div> |
|
13553 |
|
13554 |
|
13555 </li> |
|
13556 |
|
13557 <li class="param"> |
|
13558 |
|
13559 <code class="param-name">prefixed</code> |
|
13560 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13561 |
|
13562 |
|
13563 |
|
13564 |
|
13565 <div class="param-description"> |
|
13566 <p>if true, the type is prefixed already</p> |
|
13567 </div> |
|
13568 |
|
13569 |
|
13570 </li> |
|
13571 |
|
13572 </ul> |
|
13573 </div> |
|
13574 |
|
13575 |
|
13576 |
|
13577 <div class="returns"> |
|
13578 <h4>Returns:</h4> |
|
13579 |
|
13580 <div class="returns-description"> |
|
13581 |
|
13582 |
|
13583 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
13584 |
|
13585 the custom event or null |
|
13586 |
|
13587 </div> |
|
13588 </div> |
|
13589 |
|
13590 |
|
13591 |
|
13592 </div> |
|
13593 |
|
13594 |
|
13595 <div id="method_getPath" class="method item inherited"> |
|
13596 <h3 class="name"><code>getPath</code></h3> |
|
13597 |
|
13598 |
|
13599 <span class="paren">()</span> |
|
13600 |
|
13601 |
|
13602 |
|
13603 <span class="returns-inline"> |
|
13604 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13605 </span> |
|
13606 |
|
13607 |
|
13608 |
|
13609 |
|
13610 |
|
13611 |
|
13612 |
|
13613 |
|
13614 |
|
13615 |
|
13616 |
|
13617 |
|
13618 |
|
13619 |
|
13620 <div class="meta"> |
|
13621 |
|
13622 |
|
13623 <p>Inherited from |
|
13624 <a href="../classes/Router.html#method_getPath">Router</a>: |
|
13625 |
|
13626 |
|
13627 |
|
13628 <a href="../files/app_js_router.js.html#l228"><code>app/js/router.js:228</code></a> |
|
13629 |
|
13630 </p> |
|
13631 |
|
13632 |
|
13633 |
|
13634 |
|
13635 |
|
13636 </div> |
|
13637 |
|
13638 <div class="description"> |
|
13639 <p>Gets the current route path, relative to the <code>root</code> (if any).</p> |
|
13640 </div> |
|
13641 |
|
13642 |
|
13643 |
|
13644 |
|
13645 <div class="returns"> |
|
13646 <h4>Returns:</h4> |
|
13647 |
|
13648 <div class="returns-description"> |
|
13649 |
|
13650 |
|
13651 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
13652 |
|
13653 Current route path. |
|
13654 |
|
13655 </div> |
|
13656 </div> |
|
13657 |
|
13658 |
|
13659 |
|
13660 </div> |
|
13661 |
|
13662 |
|
13663 <div id="method_getTargets" class="method item inherited"> |
|
13664 <h3 class="name"><code>getTargets</code></h3> |
|
13665 |
|
13666 |
|
13667 <span class="paren">()</span> |
|
13668 |
|
13669 |
|
13670 |
|
13671 <span class="returns-inline"> |
|
13672 <span class="type"></span> |
|
13673 </span> |
|
13674 |
|
13675 |
|
13676 |
|
13677 |
|
13678 |
|
13679 |
|
13680 |
|
13681 |
|
13682 |
|
13683 |
|
13684 |
|
13685 |
|
13686 |
|
13687 |
|
13688 <div class="meta"> |
|
13689 |
|
13690 |
|
13691 <p>Inherited from |
|
13692 <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>: |
|
13693 |
|
13694 |
|
13695 |
|
13696 <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a> |
|
13697 |
|
13698 </p> |
|
13699 |
|
13700 |
|
13701 |
|
13702 |
|
13703 |
|
13704 </div> |
|
13705 |
|
13706 <div class="description"> |
|
13707 <p>Returns an array of bubble targets for this object.</p> |
|
13708 </div> |
|
13709 |
|
13710 |
|
13711 |
|
13712 |
|
13713 <div class="returns"> |
|
13714 <h4>Returns:</h4> |
|
13715 |
|
13716 <div class="returns-description"> |
|
13717 |
|
13718 |
|
13719 EventTarget[] |
|
13720 |
|
13721 </div> |
|
13722 </div> |
|
13723 |
|
13724 |
|
13725 |
|
13726 </div> |
|
13727 |
|
13728 |
|
13729 <div id="method_getViewInfo" class="method item"> |
|
13730 <h3 class="name"><code>getViewInfo</code></h3> |
|
13731 |
|
13732 |
|
13733 <div class="args"> |
|
13734 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13735 |
|
13736 <li class="arg"> |
|
13737 |
|
13738 <code>view</code> |
|
13739 |
|
13740 </li> |
|
13741 |
|
13742 </ul><span class="paren">)</span> |
|
13743 </div> |
|
13744 |
|
13745 |
|
13746 |
|
13747 <span class="returns-inline"> |
|
13748 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13749 </span> |
|
13750 |
|
13751 |
|
13752 |
|
13753 |
|
13754 |
|
13755 |
|
13756 |
|
13757 |
|
13758 |
|
13759 |
|
13760 |
|
13761 |
|
13762 |
|
13763 |
|
13764 <div class="meta"> |
|
13765 |
|
13766 |
|
13767 |
|
13768 <p> |
|
13769 |
|
13770 Defined in |
|
13771 |
|
13772 |
|
13773 |
|
13774 |
|
13775 <a href="../files/app_js_app-base.js.html#l215"><code>app/js/app-base.js:215</code></a> |
|
13776 |
|
13777 </p> |
|
13778 |
|
13779 |
|
13780 |
|
13781 |
|
13782 |
|
13783 <p>Available since 3.5.0</p> |
|
13784 |
|
13785 </div> |
|
13786 |
|
13787 <div class="description"> |
|
13788 <p>Returns the metadata associated with a view instance or view name defined on |
|
13789 the <code>views</code> object.</p> |
|
13790 </div> |
|
13791 |
|
13792 |
|
13793 <div class="params"> |
|
13794 <h4>Parameters:</h4> |
|
13795 |
|
13796 <ul class="params-list"> |
|
13797 |
|
13798 <li class="param"> |
|
13799 |
|
13800 <code class="param-name">view</code> |
|
13801 <span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13802 |
|
13803 |
|
13804 |
|
13805 |
|
13806 <div class="param-description"> |
|
13807 <p>View instance, or name of a view defined on the |
|
13808 <code>views</code> object.</p> |
|
13809 </div> |
|
13810 |
|
13811 |
|
13812 </li> |
|
13813 |
|
13814 </ul> |
|
13815 </div> |
|
13816 |
|
13817 |
|
13818 |
|
13819 <div class="returns"> |
|
13820 <h4>Returns:</h4> |
|
13821 |
|
13822 <div class="returns-description"> |
|
13823 |
|
13824 |
|
13825 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
13826 |
|
13827 The metadata for the view, or <code>undefined</code> if the view is |
|
13828 not registered. |
|
13829 |
|
13830 </div> |
|
13831 </div> |
|
13832 |
|
13833 |
|
13834 |
|
13835 </div> |
|
13836 |
|
13837 |
|
13838 <div id="method_hasRoute" class="method item inherited"> |
|
13839 <h3 class="name"><code>hasRoute</code></h3> |
|
13840 |
|
13841 |
|
13842 <div class="args"> |
|
13843 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13844 |
|
13845 <li class="arg"> |
|
13846 |
|
13847 <code>url</code> |
|
13848 |
|
13849 </li> |
|
13850 |
|
13851 </ul><span class="paren">)</span> |
|
13852 </div> |
|
13853 |
|
13854 |
|
13855 |
|
13856 <span class="returns-inline"> |
|
13857 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
13858 </span> |
|
13859 |
|
13860 |
|
13861 |
|
13862 |
|
13863 |
|
13864 |
|
13865 |
|
13866 |
|
13867 |
|
13868 |
|
13869 |
|
13870 |
|
13871 |
|
13872 |
|
13873 <div class="meta"> |
|
13874 |
|
13875 |
|
13876 <p>Inherited from |
|
13877 <a href="../classes/Router.html#method_hasRoute">Router</a>: |
|
13878 |
|
13879 |
|
13880 |
|
13881 <a href="../files/app_js_router.js.html#l238"><code>app/js/router.js:238</code></a> |
|
13882 |
|
13883 </p> |
|
13884 |
|
13885 |
|
13886 |
|
13887 |
|
13888 |
|
13889 </div> |
|
13890 |
|
13891 <div class="description"> |
|
13892 <p>Returns <code>true</code> if this router has at least one route that matches the |
|
13893 specified URL, <code>false</code> otherwise.</p> |
|
13894 |
|
13895 <p>This method enforces the same-origin security constraint on the specified |
|
13896 <code>url</code>; any URL which is not from the same origin as the current URL will |
|
13897 always return <code>false</code>.</p> |
|
13898 </div> |
|
13899 |
|
13900 |
|
13901 <div class="params"> |
|
13902 <h4>Parameters:</h4> |
|
13903 |
|
13904 <ul class="params-list"> |
|
13905 |
|
13906 <li class="param"> |
|
13907 |
|
13908 <code class="param-name">url</code> |
|
13909 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13910 |
|
13911 |
|
13912 |
|
13913 |
|
13914 <div class="param-description"> |
|
13915 <p>URL to match.</p> |
|
13916 </div> |
|
13917 |
|
13918 |
|
13919 </li> |
|
13920 |
|
13921 </ul> |
|
13922 </div> |
|
13923 |
|
13924 |
|
13925 |
|
13926 <div class="returns"> |
|
13927 <h4>Returns:</h4> |
|
13928 |
|
13929 <div class="returns-description"> |
|
13930 |
|
13931 |
|
13932 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
13933 |
|
13934 <code>true</code> if there's at least one matching route, <code>false</code> |
|
13935 otherwise. |
|
13936 |
|
13937 </div> |
|
13938 </div> |
|
13939 |
|
13940 |
|
13941 |
|
13942 </div> |
|
13943 |
|
13944 |
|
13945 <div id="method_init" class="method item inherited"> |
|
13946 <h3 class="name"><code>init</code></h3> |
|
13947 |
|
13948 |
|
13949 <div class="args"> |
|
13950 <span class="paren">(</span><ul class="args-list inline commas"> |
|
13951 |
|
13952 <li class="arg"> |
|
13953 |
|
13954 <code>cfg</code> |
|
13955 |
|
13956 </li> |
|
13957 |
|
13958 </ul><span class="paren">)</span> |
|
13959 </div> |
|
13960 |
|
13961 |
|
13962 |
|
13963 <span class="returns-inline"> |
|
13964 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span> |
|
13965 </span> |
|
13966 |
|
13967 |
|
13968 |
|
13969 |
|
13970 |
|
13971 |
|
13972 |
|
13973 |
|
13974 |
|
13975 |
|
13976 |
|
13977 <span class="flag chainable">chainable</span> |
|
13978 |
|
13979 |
|
13980 |
|
13981 |
|
13982 <div class="meta"> |
|
13983 |
|
13984 <p>Inherited from |
|
13985 <a href="../classes/BaseObservable.html#method_init"> |
|
13986 BaseObservable |
|
13987 </a> |
|
13988 |
|
13989 but overwritten in |
|
13990 |
|
13991 |
|
13992 |
|
13993 <a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a> |
|
13994 |
|
13995 </p> |
|
13996 |
|
13997 |
|
13998 |
|
13999 |
|
14000 |
|
14001 </div> |
|
14002 |
|
14003 <div class="description"> |
|
14004 <p>Init lifecycle method, invoked during construction. Sets up attributes |
|
14005 and invokes initializers for the class hierarchy.</p> |
|
14006 </div> |
|
14007 |
|
14008 |
|
14009 <div class="params"> |
|
14010 <h4>Parameters:</h4> |
|
14011 |
|
14012 <ul class="params-list"> |
|
14013 |
|
14014 <li class="param"> |
|
14015 |
|
14016 <code class="param-name">cfg</code> |
|
14017 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14018 |
|
14019 |
|
14020 |
|
14021 |
|
14022 <div class="param-description"> |
|
14023 <p>Object with configuration property name/value pairs</p> |
|
14024 </div> |
|
14025 |
|
14026 |
|
14027 </li> |
|
14028 |
|
14029 </ul> |
|
14030 </div> |
|
14031 |
|
14032 |
|
14033 |
|
14034 <div class="returns"> |
|
14035 <h4>Returns:</h4> |
|
14036 |
|
14037 <div class="returns-description"> |
|
14038 |
|
14039 |
|
14040 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>: |
|
14041 |
|
14042 A reference to this object |
|
14043 |
|
14044 </div> |
|
14045 </div> |
|
14046 |
|
14047 |
|
14048 |
|
14049 </div> |
|
14050 |
|
14051 |
|
14052 <div id="method_match" class="method item inherited"> |
|
14053 <h3 class="name"><code>match</code></h3> |
|
14054 |
|
14055 |
|
14056 <div class="args"> |
|
14057 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14058 |
|
14059 <li class="arg"> |
|
14060 |
|
14061 <code>path</code> |
|
14062 |
|
14063 </li> |
|
14064 |
|
14065 </ul><span class="paren">)</span> |
|
14066 </div> |
|
14067 |
|
14068 |
|
14069 |
|
14070 <span class="returns-inline"> |
|
14071 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
14072 </span> |
|
14073 |
|
14074 |
|
14075 |
|
14076 |
|
14077 |
|
14078 |
|
14079 |
|
14080 |
|
14081 |
|
14082 |
|
14083 |
|
14084 |
|
14085 |
|
14086 |
|
14087 <div class="meta"> |
|
14088 |
|
14089 |
|
14090 <p>Inherited from |
|
14091 <a href="../classes/Router.html#method_match">Router</a>: |
|
14092 |
|
14093 |
|
14094 |
|
14095 <a href="../files/app_js_router.js.html#l267"><code>app/js/router.js:267</code></a> |
|
14096 |
|
14097 </p> |
|
14098 |
|
14099 |
|
14100 |
|
14101 |
|
14102 |
|
14103 </div> |
|
14104 |
|
14105 <div class="description"> |
|
14106 <p>Returns an array of route objects that match the specified URL path.</p> |
|
14107 |
|
14108 <p>This method is called internally to determine which routes match the current |
|
14109 path whenever the URL changes. You may override it if you want to customize |
|
14110 the route matching logic, although this usually shouldn't be necessary.</p> |
|
14111 |
|
14112 <p>Each returned route object has the following properties:</p> |
|
14113 |
|
14114 <ul> |
|
14115 <li><p><code>callback</code>: A function or a string representing the name of a function |
|
14116 this router that should be executed when the route is triggered.</p></li> |
|
14117 <li><p><code>keys</code>: An array of strings representing the named parameters defined in |
|
14118 the route's path specification, if any.</p></li> |
|
14119 <li><p><code>path</code>: The route's path specification, which may be either a string or |
|
14120 a regex.</p></li> |
|
14121 <li><p><code>regex</code>: A regular expression version of the route's path specification. |
|
14122 This regex is used to determine whether the route matches a given path.</p></li> |
|
14123 </ul> |
|
14124 </div> |
|
14125 |
|
14126 |
|
14127 <div class="params"> |
|
14128 <h4>Parameters:</h4> |
|
14129 |
|
14130 <ul class="params-list"> |
|
14131 |
|
14132 <li class="param"> |
|
14133 |
|
14134 <code class="param-name">path</code> |
|
14135 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14136 |
|
14137 |
|
14138 |
|
14139 |
|
14140 <div class="param-description"> |
|
14141 <p>URL path to match.</p> |
|
14142 </div> |
|
14143 |
|
14144 |
|
14145 </li> |
|
14146 |
|
14147 </ul> |
|
14148 </div> |
|
14149 |
|
14150 |
|
14151 |
|
14152 <div class="returns"> |
|
14153 <h4>Returns:</h4> |
|
14154 |
|
14155 <div class="returns-description"> |
|
14156 |
|
14157 |
|
14158 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>: |
|
14159 |
|
14160 Array of route objects that match the specified path. |
|
14161 |
|
14162 </div> |
|
14163 </div> |
|
14164 |
|
14165 |
|
14166 |
|
14167 <div class="example"> |
|
14168 <h4>Example:</h4> |
|
14169 |
|
14170 <div class="example-content"> |
|
14171 <pre class="code prettyprint"><code>router.route('/foo', function () {}); |
|
14172 router.match('/foo'); |
|
14173 // => [{callback: ..., keys: [], path: '/foo', regex: ...}] |
|
14174 </code></pre> |
|
14175 </div> |
|
14176 </div> |
|
14177 |
|
14178 </div> |
|
14179 |
|
14180 |
|
14181 <div id="method_modifyAttr" class="method item inherited"> |
|
14182 <h3 class="name"><code>modifyAttr</code></h3> |
|
14183 |
|
14184 |
|
14185 <div class="args"> |
|
14186 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14187 |
|
14188 <li class="arg"> |
|
14189 |
|
14190 <code>name</code> |
|
14191 |
|
14192 </li> |
|
14193 |
|
14194 <li class="arg"> |
|
14195 |
|
14196 <code>config</code> |
|
14197 |
|
14198 </li> |
|
14199 |
|
14200 </ul><span class="paren">)</span> |
|
14201 </div> |
|
14202 |
|
14203 |
|
14204 |
|
14205 |
|
14206 |
|
14207 |
|
14208 |
|
14209 |
|
14210 |
|
14211 |
|
14212 |
|
14213 |
|
14214 |
|
14215 |
|
14216 |
|
14217 |
|
14218 <div class="meta"> |
|
14219 |
|
14220 |
|
14221 <p>Inherited from |
|
14222 <a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>: |
|
14223 |
|
14224 |
|
14225 |
|
14226 <a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a> |
|
14227 |
|
14228 </p> |
|
14229 |
|
14230 |
|
14231 |
|
14232 |
|
14233 |
|
14234 </div> |
|
14235 |
|
14236 <div class="description"> |
|
14237 <p>Updates the configuration of an attribute which has already been added.</p> |
|
14238 |
|
14239 <p> |
|
14240 The properties which can be modified through this interface are limited |
|
14241 to the following subset of attributes, which can be safely modified |
|
14242 after a value has already been set on the attribute: readOnly, writeOnce, |
|
14243 broadcast and getter. |
|
14244 </p> |
|
14245 </div> |
|
14246 |
|
14247 |
|
14248 <div class="params"> |
|
14249 <h4>Parameters:</h4> |
|
14250 |
|
14251 <ul class="params-list"> |
|
14252 |
|
14253 <li class="param"> |
|
14254 |
|
14255 <code class="param-name">name</code> |
|
14256 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14257 |
|
14258 |
|
14259 |
|
14260 |
|
14261 <div class="param-description"> |
|
14262 <p>The name of the attribute whose configuration is to be updated.</p> |
|
14263 </div> |
|
14264 |
|
14265 |
|
14266 </li> |
|
14267 |
|
14268 <li class="param"> |
|
14269 |
|
14270 <code class="param-name">config</code> |
|
14271 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14272 |
|
14273 |
|
14274 |
|
14275 |
|
14276 <div class="param-description"> |
|
14277 <p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p> |
|
14278 </div> |
|
14279 |
|
14280 |
|
14281 </li> |
|
14282 |
|
14283 </ul> |
|
14284 </div> |
|
14285 |
|
14286 |
|
14287 |
|
14288 |
|
14289 |
|
14290 </div> |
|
14291 |
|
14292 |
|
14293 <div id="method_navigate" class="method item"> |
|
14294 <h3 class="name"><code>navigate</code></h3> |
|
14295 |
|
14296 |
|
14297 <div class="args"> |
|
14298 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14299 |
|
14300 <li class="arg"> |
|
14301 |
|
14302 <code>url</code> |
|
14303 |
|
14304 </li> |
|
14305 |
|
14306 <li class="arg"> |
|
14307 |
|
14308 <code class="optional">[options]</code> |
|
14309 |
|
14310 </li> |
|
14311 |
|
14312 </ul><span class="paren">)</span> |
|
14313 </div> |
|
14314 |
|
14315 |
|
14316 |
|
14317 |
|
14318 |
|
14319 |
|
14320 |
|
14321 |
|
14322 |
|
14323 |
|
14324 |
|
14325 |
|
14326 |
|
14327 |
|
14328 |
|
14329 |
|
14330 <div class="meta"> |
|
14331 |
|
14332 <p>Inherited from |
|
14333 <a href="../classes/PjaxBase.html#method_navigate"> |
|
14334 PjaxBase |
|
14335 </a> |
|
14336 |
|
14337 but overwritten in |
|
14338 |
|
14339 |
|
14340 |
|
14341 <a href="../files/app_js_app-base.js.html#l234"><code>app/js/app-base.js:234</code></a> |
|
14342 |
|
14343 </p> |
|
14344 |
|
14345 |
|
14346 |
|
14347 |
|
14348 |
|
14349 </div> |
|
14350 |
|
14351 <div class="description"> |
|
14352 <p>Navigates to the specified URL if there is a route handler that matches. In |
|
14353 browsers capable of using HTML5 history or when <code>serverRouting</code> is falsy, |
|
14354 the navigation will be enhanced by firing the <code>navigate</code> event and having |
|
14355 the app handle the "request". When <code>serverRouting</code> is <code>true</code>, non-HTML5 |
|
14356 browsers will navigate to the new URL via a full page reload.</p> |
|
14357 |
|
14358 <p>When there is a route handler for the specified URL and it is being |
|
14359 navigated to, this method will return <code>true</code>, otherwise it will return |
|
14360 <code>false</code>.</p> |
|
14361 |
|
14362 <p><strong>Note:</strong> The specified URL <em>must</em> be of the same origin as the current URL, |
|
14363 otherwise an error will be logged and navigation will not occur. This is |
|
14364 intended as both a security constraint and a purposely imposed limitation as |
|
14365 it does not make sense to tell the app to navigate to a URL on a |
|
14366 different scheme, host, or port.</p> |
|
14367 </div> |
|
14368 |
|
14369 |
|
14370 <div class="params"> |
|
14371 <h4>Parameters:</h4> |
|
14372 |
|
14373 <ul class="params-list"> |
|
14374 |
|
14375 <li class="param"> |
|
14376 |
|
14377 <code class="param-name">url</code> |
|
14378 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14379 |
|
14380 |
|
14381 |
|
14382 |
|
14383 <div class="param-description"> |
|
14384 <p>The URL to navigate to. This must be of the same origin |
|
14385 as the current URL.</p> |
|
14386 </div> |
|
14387 |
|
14388 |
|
14389 </li> |
|
14390 |
|
14391 <li class="param"> |
|
14392 |
|
14393 <code class="param-name optional">[options]</code> |
|
14394 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14395 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14396 |
|
14397 |
|
14398 |
|
14399 |
|
14400 <div class="param-description"> |
|
14401 <p>Additional options to configure the navigation. |
|
14402 These are mixed into the <code>navigate</code> event facade.</p> |
|
14403 </div> |
|
14404 |
|
14405 |
|
14406 <ul class="params-list"> |
|
14407 |
|
14408 <li class="param"> |
|
14409 |
|
14410 <code class="param-name optional">[replace]</code> |
|
14411 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
14412 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14413 |
|
14414 |
|
14415 <div class="param-description"> |
|
14416 <p>Whether or not the current history |
|
14417 entry will be replaced, or a new entry will be created. Will default |
|
14418 to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p> |
|
14419 </div> |
|
14420 |
|
14421 |
|
14422 </li> |
|
14423 |
|
14424 <li class="param"> |
|
14425 |
|
14426 <code class="param-name optional">[force]</code> |
|
14427 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
14428 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14429 |
|
14430 |
|
14431 <div class="param-description"> |
|
14432 <p>Whether the enhanced navigation |
|
14433 should occur even in browsers without HTML5 history. Will default to |
|
14434 <code>true</code> when <code>serverRouting</code> is falsy.</p> |
|
14435 </div> |
|
14436 |
|
14437 |
|
14438 </li> |
|
14439 |
|
14440 </ul> |
|
14441 |
|
14442 </li> |
|
14443 |
|
14444 </ul> |
|
14445 </div> |
|
14446 |
|
14447 |
|
14448 |
|
14449 |
|
14450 |
|
14451 </div> |
|
14452 |
|
14453 |
|
14454 <div id="method_on" class="method item inherited"> |
|
14455 <h3 class="name"><code>on</code></h3> |
|
14456 |
|
14457 |
|
14458 <div class="args"> |
|
14459 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14460 |
|
14461 <li class="arg"> |
|
14462 |
|
14463 <code>type</code> |
|
14464 |
|
14465 </li> |
|
14466 |
|
14467 <li class="arg"> |
|
14468 |
|
14469 <code>fn</code> |
|
14470 |
|
14471 </li> |
|
14472 |
|
14473 <li class="arg"> |
|
14474 |
|
14475 <code class="optional">[context]</code> |
|
14476 |
|
14477 </li> |
|
14478 |
|
14479 <li class="arg"> |
|
14480 |
|
14481 <code class="optional">[arg*]</code> |
|
14482 |
|
14483 </li> |
|
14484 |
|
14485 </ul><span class="paren">)</span> |
|
14486 </div> |
|
14487 |
|
14488 |
|
14489 |
|
14490 <span class="returns-inline"> |
|
14491 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
14492 </span> |
|
14493 |
|
14494 |
|
14495 |
|
14496 |
|
14497 |
|
14498 |
|
14499 |
|
14500 |
|
14501 |
|
14502 |
|
14503 |
|
14504 |
|
14505 |
|
14506 |
|
14507 <div class="meta"> |
|
14508 |
|
14509 |
|
14510 <p>Inherited from |
|
14511 <a href="../classes/EventTarget.html#method_on">EventTarget</a>: |
|
14512 |
|
14513 |
|
14514 |
|
14515 <a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a> |
|
14516 |
|
14517 </p> |
|
14518 |
|
14519 |
|
14520 |
|
14521 |
|
14522 |
|
14523 </div> |
|
14524 |
|
14525 <div class="description"> |
|
14526 <p>Subscribe a callback function to a custom event fired by this object or |
|
14527 from an object that bubbles its events to this object.</p> |
|
14528 |
|
14529 <p>Callback functions for events published with <code>emitFacade = true</code> will |
|
14530 receive an <code>EventFacade</code> as the first argument (typically named "e"). |
|
14531 These callbacks can then call <code>e.preventDefault()</code> to disable the |
|
14532 behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code> |
|
14533 API for all available properties and methods. Subscribers to |
|
14534 non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code> |
|
14535 after the event name.</p> |
|
14536 |
|
14537 <p>To subscribe to multiple events at once, pass an object as the first |
|
14538 argument, where the key:value pairs correspond to the eventName:callback, |
|
14539 or pass an array of event names as the first argument to subscribe to |
|
14540 all listed events with the same callback.</p> |
|
14541 |
|
14542 <p>Returning <code>false</code> from a callback is supported as an alternative to |
|
14543 calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is |
|
14544 recommended to use the event methods whenever possible.</p> |
|
14545 </div> |
|
14546 |
|
14547 |
|
14548 <div class="params"> |
|
14549 <h4>Parameters:</h4> |
|
14550 |
|
14551 <ul class="params-list"> |
|
14552 |
|
14553 <li class="param"> |
|
14554 |
|
14555 <code class="param-name">type</code> |
|
14556 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14557 |
|
14558 |
|
14559 |
|
14560 |
|
14561 <div class="param-description"> |
|
14562 <p>The name of the event</p> |
|
14563 </div> |
|
14564 |
|
14565 |
|
14566 </li> |
|
14567 |
|
14568 <li class="param"> |
|
14569 |
|
14570 <code class="param-name">fn</code> |
|
14571 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
14572 |
|
14573 |
|
14574 |
|
14575 |
|
14576 <div class="param-description"> |
|
14577 <p>The callback to execute in response to the event</p> |
|
14578 </div> |
|
14579 |
|
14580 |
|
14581 </li> |
|
14582 |
|
14583 <li class="param"> |
|
14584 |
|
14585 <code class="param-name optional">[context]</code> |
|
14586 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14587 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14588 |
|
14589 |
|
14590 |
|
14591 |
|
14592 <div class="param-description"> |
|
14593 <p>Override <code>this</code> object in callback</p> |
|
14594 </div> |
|
14595 |
|
14596 |
|
14597 </li> |
|
14598 |
|
14599 <li class="param"> |
|
14600 |
|
14601 <code class="param-name optional">[arg*]</code> |
|
14602 <span class="type">Any</span> |
|
14603 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14604 |
|
14605 |
|
14606 |
|
14607 |
|
14608 <div class="param-description"> |
|
14609 <p>0..n additional arguments to supply to the subscriber</p> |
|
14610 </div> |
|
14611 |
|
14612 |
|
14613 </li> |
|
14614 |
|
14615 </ul> |
|
14616 </div> |
|
14617 |
|
14618 |
|
14619 |
|
14620 <div class="returns"> |
|
14621 <h4>Returns:</h4> |
|
14622 |
|
14623 <div class="returns-description"> |
|
14624 |
|
14625 |
|
14626 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
14627 |
|
14628 A subscription handle capable of detaching that |
|
14629 subscription |
|
14630 |
|
14631 </div> |
|
14632 </div> |
|
14633 |
|
14634 |
|
14635 |
|
14636 </div> |
|
14637 |
|
14638 |
|
14639 <div id="method_once" class="method item inherited"> |
|
14640 <h3 class="name"><code>once</code></h3> |
|
14641 |
|
14642 |
|
14643 <div class="args"> |
|
14644 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14645 |
|
14646 <li class="arg"> |
|
14647 |
|
14648 <code>type</code> |
|
14649 |
|
14650 </li> |
|
14651 |
|
14652 <li class="arg"> |
|
14653 |
|
14654 <code>fn</code> |
|
14655 |
|
14656 </li> |
|
14657 |
|
14658 <li class="arg"> |
|
14659 |
|
14660 <code class="optional">[context]</code> |
|
14661 |
|
14662 </li> |
|
14663 |
|
14664 <li class="arg"> |
|
14665 |
|
14666 <code class="optional">[arg*]</code> |
|
14667 |
|
14668 </li> |
|
14669 |
|
14670 </ul><span class="paren">)</span> |
|
14671 </div> |
|
14672 |
|
14673 |
|
14674 |
|
14675 <span class="returns-inline"> |
|
14676 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
14677 </span> |
|
14678 |
|
14679 |
|
14680 |
|
14681 |
|
14682 |
|
14683 |
|
14684 |
|
14685 |
|
14686 |
|
14687 |
|
14688 |
|
14689 |
|
14690 |
|
14691 |
|
14692 <div class="meta"> |
|
14693 |
|
14694 |
|
14695 <p>Inherited from |
|
14696 <a href="../classes/EventTarget.html#method_once">EventTarget</a>: |
|
14697 |
|
14698 |
|
14699 |
|
14700 <a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a> |
|
14701 |
|
14702 </p> |
|
14703 |
|
14704 |
|
14705 |
|
14706 |
|
14707 |
|
14708 </div> |
|
14709 |
|
14710 <div class="description"> |
|
14711 <p>Listen to a custom event hosted by this object one time. |
|
14712 This is the equivalent to <code>on</code> except the |
|
14713 listener is immediatelly detached when it is executed.</p> |
|
14714 </div> |
|
14715 |
|
14716 |
|
14717 <div class="params"> |
|
14718 <h4>Parameters:</h4> |
|
14719 |
|
14720 <ul class="params-list"> |
|
14721 |
|
14722 <li class="param"> |
|
14723 |
|
14724 <code class="param-name">type</code> |
|
14725 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14726 |
|
14727 |
|
14728 |
|
14729 |
|
14730 <div class="param-description"> |
|
14731 <p>The name of the event</p> |
|
14732 </div> |
|
14733 |
|
14734 |
|
14735 </li> |
|
14736 |
|
14737 <li class="param"> |
|
14738 |
|
14739 <code class="param-name">fn</code> |
|
14740 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
14741 |
|
14742 |
|
14743 |
|
14744 |
|
14745 <div class="param-description"> |
|
14746 <p>The callback to execute in response to the event</p> |
|
14747 </div> |
|
14748 |
|
14749 |
|
14750 </li> |
|
14751 |
|
14752 <li class="param"> |
|
14753 |
|
14754 <code class="param-name optional">[context]</code> |
|
14755 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14756 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14757 |
|
14758 |
|
14759 |
|
14760 |
|
14761 <div class="param-description"> |
|
14762 <p>Override <code>this</code> object in callback</p> |
|
14763 </div> |
|
14764 |
|
14765 |
|
14766 </li> |
|
14767 |
|
14768 <li class="param"> |
|
14769 |
|
14770 <code class="param-name optional">[arg*]</code> |
|
14771 <span class="type">Any</span> |
|
14772 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14773 |
|
14774 |
|
14775 |
|
14776 |
|
14777 <div class="param-description"> |
|
14778 <p>0..n additional arguments to supply to the subscriber</p> |
|
14779 </div> |
|
14780 |
|
14781 |
|
14782 </li> |
|
14783 |
|
14784 </ul> |
|
14785 </div> |
|
14786 |
|
14787 |
|
14788 |
|
14789 <div class="returns"> |
|
14790 <h4>Returns:</h4> |
|
14791 |
|
14792 <div class="returns-description"> |
|
14793 |
|
14794 |
|
14795 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
14796 |
|
14797 A subscription handle capable of detaching the |
|
14798 subscription |
|
14799 |
|
14800 </div> |
|
14801 </div> |
|
14802 |
|
14803 |
|
14804 |
|
14805 </div> |
|
14806 |
|
14807 |
|
14808 <div id="method_onceAfter" class="method item inherited"> |
|
14809 <h3 class="name"><code>onceAfter</code></h3> |
|
14810 |
|
14811 |
|
14812 <div class="args"> |
|
14813 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14814 |
|
14815 <li class="arg"> |
|
14816 |
|
14817 <code>type</code> |
|
14818 |
|
14819 </li> |
|
14820 |
|
14821 <li class="arg"> |
|
14822 |
|
14823 <code>fn</code> |
|
14824 |
|
14825 </li> |
|
14826 |
|
14827 <li class="arg"> |
|
14828 |
|
14829 <code class="optional">[context]</code> |
|
14830 |
|
14831 </li> |
|
14832 |
|
14833 <li class="arg"> |
|
14834 |
|
14835 <code class="optional">[arg*]</code> |
|
14836 |
|
14837 </li> |
|
14838 |
|
14839 </ul><span class="paren">)</span> |
|
14840 </div> |
|
14841 |
|
14842 |
|
14843 |
|
14844 <span class="returns-inline"> |
|
14845 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
14846 </span> |
|
14847 |
|
14848 |
|
14849 |
|
14850 |
|
14851 |
|
14852 |
|
14853 |
|
14854 |
|
14855 |
|
14856 |
|
14857 |
|
14858 |
|
14859 |
|
14860 |
|
14861 <div class="meta"> |
|
14862 |
|
14863 |
|
14864 <p>Inherited from |
|
14865 <a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>: |
|
14866 |
|
14867 |
|
14868 |
|
14869 <a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a> |
|
14870 |
|
14871 </p> |
|
14872 |
|
14873 |
|
14874 |
|
14875 |
|
14876 |
|
14877 </div> |
|
14878 |
|
14879 <div class="description"> |
|
14880 <p>Listen to a custom event hosted by this object one time. |
|
14881 This is the equivalent to <code>after</code> except the |
|
14882 listener is immediatelly detached when it is executed.</p> |
|
14883 </div> |
|
14884 |
|
14885 |
|
14886 <div class="params"> |
|
14887 <h4>Parameters:</h4> |
|
14888 |
|
14889 <ul class="params-list"> |
|
14890 |
|
14891 <li class="param"> |
|
14892 |
|
14893 <code class="param-name">type</code> |
|
14894 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
14895 |
|
14896 |
|
14897 |
|
14898 |
|
14899 <div class="param-description"> |
|
14900 <p>The name of the event</p> |
|
14901 </div> |
|
14902 |
|
14903 |
|
14904 </li> |
|
14905 |
|
14906 <li class="param"> |
|
14907 |
|
14908 <code class="param-name">fn</code> |
|
14909 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
14910 |
|
14911 |
|
14912 |
|
14913 |
|
14914 <div class="param-description"> |
|
14915 <p>The callback to execute in response to the event</p> |
|
14916 </div> |
|
14917 |
|
14918 |
|
14919 </li> |
|
14920 |
|
14921 <li class="param"> |
|
14922 |
|
14923 <code class="param-name optional">[context]</code> |
|
14924 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
14925 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14926 |
|
14927 |
|
14928 |
|
14929 |
|
14930 <div class="param-description"> |
|
14931 <p>Override <code>this</code> object in callback</p> |
|
14932 </div> |
|
14933 |
|
14934 |
|
14935 </li> |
|
14936 |
|
14937 <li class="param"> |
|
14938 |
|
14939 <code class="param-name optional">[arg*]</code> |
|
14940 <span class="type">Any</span> |
|
14941 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
14942 |
|
14943 |
|
14944 |
|
14945 |
|
14946 <div class="param-description"> |
|
14947 <p>0..n additional arguments to supply to the subscriber</p> |
|
14948 </div> |
|
14949 |
|
14950 |
|
14951 </li> |
|
14952 |
|
14953 </ul> |
|
14954 </div> |
|
14955 |
|
14956 |
|
14957 |
|
14958 <div class="returns"> |
|
14959 <h4>Returns:</h4> |
|
14960 |
|
14961 <div class="returns-description"> |
|
14962 |
|
14963 |
|
14964 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
14965 |
|
14966 A subscription handle capable of detaching that |
|
14967 subscription |
|
14968 |
|
14969 </div> |
|
14970 </div> |
|
14971 |
|
14972 |
|
14973 |
|
14974 </div> |
|
14975 |
|
14976 |
|
14977 <div id="method_parseType" class="method item inherited"> |
|
14978 <h3 class="name"><code>parseType</code></h3> |
|
14979 |
|
14980 |
|
14981 <div class="args"> |
|
14982 <span class="paren">(</span><ul class="args-list inline commas"> |
|
14983 |
|
14984 <li class="arg"> |
|
14985 |
|
14986 <code>type</code> |
|
14987 |
|
14988 </li> |
|
14989 |
|
14990 <li class="arg"> |
|
14991 |
|
14992 <code class="optional">[pre=this._yuievt.config.prefix]</code> |
|
14993 |
|
14994 </li> |
|
14995 |
|
14996 </ul><span class="paren">)</span> |
|
14997 </div> |
|
14998 |
|
14999 |
|
15000 |
|
15001 <span class="returns-inline"> |
|
15002 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
15003 </span> |
|
15004 |
|
15005 |
|
15006 |
|
15007 |
|
15008 |
|
15009 |
|
15010 |
|
15011 |
|
15012 |
|
15013 |
|
15014 |
|
15015 |
|
15016 |
|
15017 |
|
15018 <div class="meta"> |
|
15019 |
|
15020 |
|
15021 <p>Inherited from |
|
15022 <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>: |
|
15023 |
|
15024 |
|
15025 |
|
15026 <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a> |
|
15027 |
|
15028 </p> |
|
15029 |
|
15030 |
|
15031 |
|
15032 |
|
15033 |
|
15034 <p>Available since 3.3.0</p> |
|
15035 |
|
15036 </div> |
|
15037 |
|
15038 <div class="description"> |
|
15039 <p>Takes the type parameter passed to 'on' and parses out the |
|
15040 various pieces that could be included in the type. If the |
|
15041 event type is passed without a prefix, it will be expanded |
|
15042 to include the prefix one is supplied or the event target |
|
15043 is configured with a default prefix.</p> |
|
15044 </div> |
|
15045 |
|
15046 |
|
15047 <div class="params"> |
|
15048 <h4>Parameters:</h4> |
|
15049 |
|
15050 <ul class="params-list"> |
|
15051 |
|
15052 <li class="param"> |
|
15053 |
|
15054 <code class="param-name">type</code> |
|
15055 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15056 |
|
15057 |
|
15058 |
|
15059 |
|
15060 <div class="param-description"> |
|
15061 <p>the type</p> |
|
15062 </div> |
|
15063 |
|
15064 |
|
15065 </li> |
|
15066 |
|
15067 <li class="param"> |
|
15068 |
|
15069 <code class="param-name optional">[pre=this._yuievt.config.prefix]</code> |
|
15070 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15071 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15072 |
|
15073 |
|
15074 |
|
15075 |
|
15076 <div class="param-description"> |
|
15077 <p>the prefix</p> |
|
15078 </div> |
|
15079 |
|
15080 |
|
15081 </li> |
|
15082 |
|
15083 </ul> |
|
15084 </div> |
|
15085 |
|
15086 |
|
15087 |
|
15088 <div class="returns"> |
|
15089 <h4>Returns:</h4> |
|
15090 |
|
15091 <div class="returns-description"> |
|
15092 |
|
15093 |
|
15094 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>: |
|
15095 |
|
15096 an array containing: |
|
15097 * the detach category, if supplied, |
|
15098 * the prefixed event type, |
|
15099 * whether or not this is an after listener, |
|
15100 * the supplied event type |
|
15101 |
|
15102 </div> |
|
15103 </div> |
|
15104 |
|
15105 |
|
15106 |
|
15107 </div> |
|
15108 |
|
15109 |
|
15110 <div id="method_publish" class="method item inherited"> |
|
15111 <h3 class="name"><code>publish</code></h3> |
|
15112 |
|
15113 |
|
15114 <div class="args"> |
|
15115 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15116 |
|
15117 <li class="arg"> |
|
15118 |
|
15119 <code>type</code> |
|
15120 |
|
15121 </li> |
|
15122 |
|
15123 <li class="arg"> |
|
15124 |
|
15125 <code>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="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
15136 </span> |
|
15137 |
|
15138 |
|
15139 |
|
15140 |
|
15141 |
|
15142 |
|
15143 |
|
15144 |
|
15145 |
|
15146 |
|
15147 |
|
15148 |
|
15149 |
|
15150 |
|
15151 <div class="meta"> |
|
15152 |
|
15153 |
|
15154 <p>Inherited from |
|
15155 <a href="../classes/EventTarget.html#method_publish">EventTarget</a>: |
|
15156 |
|
15157 |
|
15158 |
|
15159 <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a> |
|
15160 |
|
15161 </p> |
|
15162 |
|
15163 |
|
15164 |
|
15165 |
|
15166 |
|
15167 </div> |
|
15168 |
|
15169 <div class="description"> |
|
15170 <p>Creates a new custom event of the specified type. If a custom event |
|
15171 by that name already exists, it will not be re-created. In either |
|
15172 case the custom event is returned.</p> |
|
15173 </div> |
|
15174 |
|
15175 |
|
15176 <div class="params"> |
|
15177 <h4>Parameters:</h4> |
|
15178 |
|
15179 <ul class="params-list"> |
|
15180 |
|
15181 <li class="param"> |
|
15182 |
|
15183 <code class="param-name">type</code> |
|
15184 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15185 |
|
15186 |
|
15187 |
|
15188 |
|
15189 <div class="param-description"> |
|
15190 <p>the type, or name of the event</p> |
|
15191 </div> |
|
15192 |
|
15193 |
|
15194 </li> |
|
15195 |
|
15196 <li class="param"> |
|
15197 |
|
15198 <code class="param-name">opts</code> |
|
15199 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15200 |
|
15201 |
|
15202 |
|
15203 |
|
15204 <div class="param-description"> |
|
15205 <p>optional config params. Valid properties are:</p> |
|
15206 |
|
15207 <p><ul> |
|
15208 <li> |
|
15209 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false) |
|
15210 </li> |
|
15211 <li> |
|
15212 'bubbles': whether or not this event bubbles (true) |
|
15213 Events can only bubble if emitFacade is true. |
|
15214 </li> |
|
15215 <li> |
|
15216 'context': the default execution context for the listeners (this) |
|
15217 </li> |
|
15218 <li> |
|
15219 'defaultFn': the default function to execute when this event fires if preventDefault was not called |
|
15220 </li> |
|
15221 <li> |
|
15222 'emitFacade': whether or not this event emits a facade (false) |
|
15223 </li> |
|
15224 <li> |
|
15225 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' |
|
15226 </li> |
|
15227 <li> |
|
15228 'fireOnce': if an event is configured to fire once, new subscribers after |
|
15229 the fire will be notified immediately. |
|
15230 </li> |
|
15231 <li> |
|
15232 'async': fireOnce event listeners will fire synchronously if the event has already |
|
15233 fired unless async is true. |
|
15234 </li> |
|
15235 <li> |
|
15236 'preventable': whether or not preventDefault() has an effect (true) |
|
15237 </li> |
|
15238 <li> |
|
15239 'preventedFn': a function that is executed when preventDefault is called |
|
15240 </li> |
|
15241 <li> |
|
15242 'queuable': whether or not this event can be queued during bubbling (false) |
|
15243 </li> |
|
15244 <li> |
|
15245 'silent': if silent is true, debug messages are not provided for this event. |
|
15246 </li> |
|
15247 <li> |
|
15248 'stoppedFn': a function that is executed when stopPropagation is called |
|
15249 </li></p> |
|
15250 |
|
15251 <p><li> |
|
15252 'monitored': specifies whether or not this event should send notifications about |
|
15253 when the event has been attached, detached, or published. |
|
15254 </li> |
|
15255 <li> |
|
15256 'type': the event type (valid option if not provided as the first parameter to publish) |
|
15257 </li> |
|
15258 </ul></p> |
|
15259 </div> |
|
15260 |
|
15261 |
|
15262 </li> |
|
15263 |
|
15264 </ul> |
|
15265 </div> |
|
15266 |
|
15267 |
|
15268 |
|
15269 <div class="returns"> |
|
15270 <h4>Returns:</h4> |
|
15271 |
|
15272 <div class="returns-description"> |
|
15273 |
|
15274 |
|
15275 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
15276 |
|
15277 the custom event |
|
15278 |
|
15279 </div> |
|
15280 </div> |
|
15281 |
|
15282 |
|
15283 |
|
15284 </div> |
|
15285 |
|
15286 |
|
15287 <div id="method_remove" class="method item inherited"> |
|
15288 <h3 class="name"><code>remove</code></h3> |
|
15289 |
|
15290 |
|
15291 <span class="paren">()</span> |
|
15292 |
|
15293 |
|
15294 |
|
15295 |
|
15296 |
|
15297 |
|
15298 |
|
15299 |
|
15300 |
|
15301 |
|
15302 |
|
15303 |
|
15304 |
|
15305 <span class="flag chainable">chainable</span> |
|
15306 |
|
15307 |
|
15308 |
|
15309 |
|
15310 <div class="meta"> |
|
15311 |
|
15312 |
|
15313 <p>Inherited from |
|
15314 <a href="../classes/View.html#method_remove">View</a>: |
|
15315 |
|
15316 |
|
15317 |
|
15318 <a href="../files/app_js_view.js.html#l272"><code>app/js/view.js:272</code></a> |
|
15319 |
|
15320 </p> |
|
15321 |
|
15322 |
|
15323 |
|
15324 |
|
15325 |
|
15326 </div> |
|
15327 |
|
15328 <div class="description"> |
|
15329 <p>Removes this view's container element from the DOM (if it's in the DOM), |
|
15330 but doesn't destroy it or any event listeners attached to it.</p> |
|
15331 </div> |
|
15332 |
|
15333 |
|
15334 |
|
15335 |
|
15336 |
|
15337 |
|
15338 </div> |
|
15339 |
|
15340 |
|
15341 <div id="method_removeAttr" class="method item inherited"> |
|
15342 <h3 class="name"><code>removeAttr</code></h3> |
|
15343 |
|
15344 |
|
15345 <div class="args"> |
|
15346 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15347 |
|
15348 <li class="arg"> |
|
15349 |
|
15350 <code>name</code> |
|
15351 |
|
15352 </li> |
|
15353 |
|
15354 </ul><span class="paren">)</span> |
|
15355 </div> |
|
15356 |
|
15357 |
|
15358 |
|
15359 |
|
15360 |
|
15361 |
|
15362 |
|
15363 |
|
15364 |
|
15365 |
|
15366 |
|
15367 |
|
15368 |
|
15369 |
|
15370 |
|
15371 |
|
15372 <div class="meta"> |
|
15373 |
|
15374 |
|
15375 <p>Inherited from |
|
15376 <a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>: |
|
15377 |
|
15378 |
|
15379 |
|
15380 <a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a> |
|
15381 |
|
15382 </p> |
|
15383 |
|
15384 |
|
15385 |
|
15386 |
|
15387 |
|
15388 </div> |
|
15389 |
|
15390 <div class="description"> |
|
15391 <p>Removes an attribute from the host object</p> |
|
15392 </div> |
|
15393 |
|
15394 |
|
15395 <div class="params"> |
|
15396 <h4>Parameters:</h4> |
|
15397 |
|
15398 <ul class="params-list"> |
|
15399 |
|
15400 <li class="param"> |
|
15401 |
|
15402 <code class="param-name">name</code> |
|
15403 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15404 |
|
15405 |
|
15406 |
|
15407 |
|
15408 <div class="param-description"> |
|
15409 <p>The name of the attribute to be removed.</p> |
|
15410 </div> |
|
15411 |
|
15412 |
|
15413 </li> |
|
15414 |
|
15415 </ul> |
|
15416 </div> |
|
15417 |
|
15418 |
|
15419 |
|
15420 |
|
15421 |
|
15422 </div> |
|
15423 |
|
15424 |
|
15425 <div id="method_removeQuery" class="method item inherited"> |
|
15426 <h3 class="name"><code>removeQuery</code></h3> |
|
15427 |
|
15428 |
|
15429 <div class="args"> |
|
15430 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15431 |
|
15432 <li class="arg"> |
|
15433 |
|
15434 <code>url</code> |
|
15435 |
|
15436 </li> |
|
15437 |
|
15438 </ul><span class="paren">)</span> |
|
15439 </div> |
|
15440 |
|
15441 |
|
15442 |
|
15443 <span class="returns-inline"> |
|
15444 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15445 </span> |
|
15446 |
|
15447 |
|
15448 |
|
15449 |
|
15450 |
|
15451 |
|
15452 |
|
15453 |
|
15454 |
|
15455 |
|
15456 |
|
15457 |
|
15458 |
|
15459 |
|
15460 <div class="meta"> |
|
15461 |
|
15462 |
|
15463 <p>Inherited from |
|
15464 <a href="../classes/Router.html#method_removeQuery">Router</a>: |
|
15465 |
|
15466 |
|
15467 |
|
15468 <a href="../files/app_js_router.js.html#l325"><code>app/js/router.js:325</code></a> |
|
15469 |
|
15470 </p> |
|
15471 |
|
15472 |
|
15473 |
|
15474 |
|
15475 |
|
15476 </div> |
|
15477 |
|
15478 <div class="description"> |
|
15479 <p>Removes a query string from the end of the <em>url</em> (if one exists) and returns |
|
15480 the result.</p> |
|
15481 </div> |
|
15482 |
|
15483 |
|
15484 <div class="params"> |
|
15485 <h4>Parameters:</h4> |
|
15486 |
|
15487 <ul class="params-list"> |
|
15488 |
|
15489 <li class="param"> |
|
15490 |
|
15491 <code class="param-name">url</code> |
|
15492 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15493 |
|
15494 |
|
15495 |
|
15496 |
|
15497 <div class="param-description"> |
|
15498 <p>URL.</p> |
|
15499 </div> |
|
15500 |
|
15501 |
|
15502 </li> |
|
15503 |
|
15504 </ul> |
|
15505 </div> |
|
15506 |
|
15507 |
|
15508 |
|
15509 <div class="returns"> |
|
15510 <h4>Returns:</h4> |
|
15511 |
|
15512 <div class="returns-description"> |
|
15513 |
|
15514 |
|
15515 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
15516 |
|
15517 Queryless path. |
|
15518 |
|
15519 </div> |
|
15520 </div> |
|
15521 |
|
15522 |
|
15523 |
|
15524 </div> |
|
15525 |
|
15526 |
|
15527 <div id="method_removeRoot" class="method item inherited"> |
|
15528 <h3 class="name"><code>removeRoot</code></h3> |
|
15529 |
|
15530 |
|
15531 <div class="args"> |
|
15532 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15533 |
|
15534 <li class="arg"> |
|
15535 |
|
15536 <code>url</code> |
|
15537 |
|
15538 </li> |
|
15539 |
|
15540 </ul><span class="paren">)</span> |
|
15541 </div> |
|
15542 |
|
15543 |
|
15544 |
|
15545 <span class="returns-inline"> |
|
15546 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15547 </span> |
|
15548 |
|
15549 |
|
15550 |
|
15551 |
|
15552 |
|
15553 |
|
15554 |
|
15555 |
|
15556 |
|
15557 |
|
15558 |
|
15559 |
|
15560 |
|
15561 |
|
15562 <div class="meta"> |
|
15563 |
|
15564 |
|
15565 <p>Inherited from |
|
15566 <a href="../classes/Router.html#method_removeRoot">Router</a>: |
|
15567 |
|
15568 |
|
15569 |
|
15570 <a href="../files/app_js_router.js.html#l303"><code>app/js/router.js:303</code></a> |
|
15571 |
|
15572 </p> |
|
15573 |
|
15574 |
|
15575 |
|
15576 |
|
15577 |
|
15578 </div> |
|
15579 |
|
15580 <div class="description"> |
|
15581 <p>Removes the <code>root</code> URL from the front of <em>url</em> (if it's there) and returns |
|
15582 the result. The returned path will always have a leading <code>/</code>.</p> |
|
15583 </div> |
|
15584 |
|
15585 |
|
15586 <div class="params"> |
|
15587 <h4>Parameters:</h4> |
|
15588 |
|
15589 <ul class="params-list"> |
|
15590 |
|
15591 <li class="param"> |
|
15592 |
|
15593 <code class="param-name">url</code> |
|
15594 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15595 |
|
15596 |
|
15597 |
|
15598 |
|
15599 <div class="param-description"> |
|
15600 <p>URL.</p> |
|
15601 </div> |
|
15602 |
|
15603 |
|
15604 </li> |
|
15605 |
|
15606 </ul> |
|
15607 </div> |
|
15608 |
|
15609 |
|
15610 |
|
15611 <div class="returns"> |
|
15612 <h4>Returns:</h4> |
|
15613 |
|
15614 <div class="returns-description"> |
|
15615 |
|
15616 |
|
15617 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
15618 |
|
15619 Rootless path. |
|
15620 |
|
15621 </div> |
|
15622 </div> |
|
15623 |
|
15624 |
|
15625 |
|
15626 </div> |
|
15627 |
|
15628 |
|
15629 <div id="method_removeTarget" class="method item inherited"> |
|
15630 <h3 class="name"><code>removeTarget</code></h3> |
|
15631 |
|
15632 |
|
15633 <div class="args"> |
|
15634 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15635 |
|
15636 <li class="arg"> |
|
15637 |
|
15638 <code>o</code> |
|
15639 |
|
15640 </li> |
|
15641 |
|
15642 </ul><span class="paren">)</span> |
|
15643 </div> |
|
15644 |
|
15645 |
|
15646 |
|
15647 |
|
15648 |
|
15649 |
|
15650 |
|
15651 |
|
15652 |
|
15653 |
|
15654 |
|
15655 |
|
15656 |
|
15657 |
|
15658 |
|
15659 |
|
15660 <div class="meta"> |
|
15661 |
|
15662 |
|
15663 <p>Inherited from |
|
15664 <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>: |
|
15665 |
|
15666 |
|
15667 |
|
15668 <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a> |
|
15669 |
|
15670 </p> |
|
15671 |
|
15672 |
|
15673 |
|
15674 |
|
15675 |
|
15676 </div> |
|
15677 |
|
15678 <div class="description"> |
|
15679 <p>Removes a bubble target</p> |
|
15680 </div> |
|
15681 |
|
15682 |
|
15683 <div class="params"> |
|
15684 <h4>Parameters:</h4> |
|
15685 |
|
15686 <ul class="params-list"> |
|
15687 |
|
15688 <li class="param"> |
|
15689 |
|
15690 <code class="param-name">o</code> |
|
15691 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
15692 |
|
15693 |
|
15694 |
|
15695 |
|
15696 <div class="param-description"> |
|
15697 <p>the target to remove</p> |
|
15698 </div> |
|
15699 |
|
15700 |
|
15701 </li> |
|
15702 |
|
15703 </ul> |
|
15704 </div> |
|
15705 |
|
15706 |
|
15707 |
|
15708 |
|
15709 |
|
15710 </div> |
|
15711 |
|
15712 |
|
15713 <div id="method_render" class="method item"> |
|
15714 <h3 class="name"><code>render</code></h3> |
|
15715 |
|
15716 |
|
15717 <span class="paren">()</span> |
|
15718 |
|
15719 |
|
15720 |
|
15721 |
|
15722 |
|
15723 |
|
15724 |
|
15725 |
|
15726 |
|
15727 |
|
15728 |
|
15729 |
|
15730 |
|
15731 <span class="flag chainable">chainable</span> |
|
15732 |
|
15733 |
|
15734 |
|
15735 |
|
15736 <div class="meta"> |
|
15737 |
|
15738 <p>Inherited from |
|
15739 <a href="../classes/View.html#method_render"> |
|
15740 View |
|
15741 </a> |
|
15742 |
|
15743 but overwritten in |
|
15744 |
|
15745 |
|
15746 |
|
15747 <a href="../files/app_js_app-base.js.html#l266"><code>app/js/app-base.js:266</code></a> |
|
15748 |
|
15749 </p> |
|
15750 |
|
15751 |
|
15752 |
|
15753 |
|
15754 |
|
15755 </div> |
|
15756 |
|
15757 <div class="description"> |
|
15758 <p>Renders this application by appending the <code>viewContainer</code> node to the |
|
15759 <code>container</code> node if it isn't already a child of the container, and the |
|
15760 <code>activeView</code> will be appended the view container, if it isn't already.</p> |
|
15761 |
|
15762 <p>You should call this method at least once, usually after the initialization |
|
15763 of your app instance so the proper DOM structure is setup and optionally |
|
15764 append the container to the DOM if it's not there already.</p> |
|
15765 |
|
15766 <p>You may override this method to customize the app's rendering, but you |
|
15767 should expect that the <code>viewContainer</code>'s contents will be modified by the |
|
15768 app for the purpose of rendering the <code>activeView</code> when it changes.</p> |
|
15769 </div> |
|
15770 |
|
15771 |
|
15772 |
|
15773 |
|
15774 |
|
15775 |
|
15776 </div> |
|
15777 |
|
15778 |
|
15779 <div id="method_replace" class="method item inherited"> |
|
15780 <h3 class="name"><code>replace</code></h3> |
|
15781 |
|
15782 |
|
15783 <div class="args"> |
|
15784 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15785 |
|
15786 <li class="arg"> |
|
15787 |
|
15788 <code class="optional">[url]</code> |
|
15789 |
|
15790 </li> |
|
15791 |
|
15792 </ul><span class="paren">)</span> |
|
15793 </div> |
|
15794 |
|
15795 |
|
15796 |
|
15797 |
|
15798 |
|
15799 |
|
15800 |
|
15801 |
|
15802 |
|
15803 |
|
15804 |
|
15805 |
|
15806 |
|
15807 <span class="flag chainable">chainable</span> |
|
15808 |
|
15809 |
|
15810 |
|
15811 |
|
15812 <div class="meta"> |
|
15813 |
|
15814 |
|
15815 <p>Inherited from |
|
15816 <a href="../classes/Router.html#method_replace">Router</a>: |
|
15817 |
|
15818 |
|
15819 |
|
15820 <a href="../files/app_js_router.js.html#l337"><code>app/js/router.js:337</code></a> |
|
15821 |
|
15822 </p> |
|
15823 |
|
15824 |
|
15825 |
|
15826 |
|
15827 |
|
15828 </div> |
|
15829 |
|
15830 <div class="description"> |
|
15831 <p>Replaces the current browser history entry with a new one, and dispatches to |
|
15832 the first matching route handler, if any.</p> |
|
15833 |
|
15834 <p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that |
|
15835 support it (or the location hash in older browsers and IE) to change the |
|
15836 URL.</p> |
|
15837 |
|
15838 <p>The specified URL must share the same origin (i.e., protocol, host, and |
|
15839 port) as the current page, or an error will occur.</p> |
|
15840 </div> |
|
15841 |
|
15842 |
|
15843 <div class="params"> |
|
15844 <h4>Parameters:</h4> |
|
15845 |
|
15846 <ul class="params-list"> |
|
15847 |
|
15848 <li class="param"> |
|
15849 |
|
15850 <code class="param-name optional">[url]</code> |
|
15851 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15852 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
15853 |
|
15854 |
|
15855 |
|
15856 |
|
15857 <div class="param-description"> |
|
15858 <p>URL to set. This URL needs to be of the same origin as |
|
15859 the current URL. This can be a URL relative to the router's <code>root</code> |
|
15860 attribute. If no URL is specified, the page's current URL will be used.</p> |
|
15861 </div> |
|
15862 |
|
15863 |
|
15864 </li> |
|
15865 |
|
15866 </ul> |
|
15867 </div> |
|
15868 |
|
15869 |
|
15870 |
|
15871 |
|
15872 |
|
15873 <div class="example"> |
|
15874 <h4>Example:</h4> |
|
15875 |
|
15876 <div class="example-content"> |
|
15877 <pre class="code prettyprint"><code>// Starting URL: http://example.com/ |
|
15878 |
|
15879 router.replace('/path/'); |
|
15880 // New URL: http://example.com/path/ |
|
15881 |
|
15882 router.replace('/path?foo=bar'); |
|
15883 // New URL: http://example.com/path?foo=bar |
|
15884 |
|
15885 router.replace('/'); |
|
15886 // New URL: http://example.com/ |
|
15887 </code></pre> |
|
15888 </div> |
|
15889 </div> |
|
15890 |
|
15891 </div> |
|
15892 |
|
15893 |
|
15894 <div id="method_reset" class="method item inherited"> |
|
15895 <h3 class="name"><code>reset</code></h3> |
|
15896 |
|
15897 |
|
15898 <div class="args"> |
|
15899 <span class="paren">(</span><ul class="args-list inline commas"> |
|
15900 |
|
15901 <li class="arg"> |
|
15902 |
|
15903 <code>name</code> |
|
15904 |
|
15905 </li> |
|
15906 |
|
15907 </ul><span class="paren">)</span> |
|
15908 </div> |
|
15909 |
|
15910 |
|
15911 |
|
15912 <span class="returns-inline"> |
|
15913 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
15914 </span> |
|
15915 |
|
15916 |
|
15917 |
|
15918 |
|
15919 |
|
15920 |
|
15921 |
|
15922 |
|
15923 |
|
15924 |
|
15925 |
|
15926 <span class="flag chainable">chainable</span> |
|
15927 |
|
15928 |
|
15929 |
|
15930 |
|
15931 <div class="meta"> |
|
15932 |
|
15933 |
|
15934 <p>Inherited from |
|
15935 <a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>: |
|
15936 |
|
15937 |
|
15938 |
|
15939 <a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a> |
|
15940 |
|
15941 </p> |
|
15942 |
|
15943 |
|
15944 |
|
15945 |
|
15946 |
|
15947 </div> |
|
15948 |
|
15949 <div class="description"> |
|
15950 <p>Resets the attribute (or all attributes) to its initial value, as long as |
|
15951 the attribute is not readOnly, or writeOnce.</p> |
|
15952 </div> |
|
15953 |
|
15954 |
|
15955 <div class="params"> |
|
15956 <h4>Parameters:</h4> |
|
15957 |
|
15958 <ul class="params-list"> |
|
15959 |
|
15960 <li class="param"> |
|
15961 |
|
15962 <code class="param-name">name</code> |
|
15963 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
15964 |
|
15965 |
|
15966 |
|
15967 |
|
15968 <div class="param-description"> |
|
15969 <p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p> |
|
15970 </div> |
|
15971 |
|
15972 |
|
15973 </li> |
|
15974 |
|
15975 </ul> |
|
15976 </div> |
|
15977 |
|
15978 |
|
15979 |
|
15980 <div class="returns"> |
|
15981 <h4>Returns:</h4> |
|
15982 |
|
15983 <div class="returns-description"> |
|
15984 |
|
15985 |
|
15986 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
15987 |
|
15988 A reference to the host object. |
|
15989 |
|
15990 </div> |
|
15991 </div> |
|
15992 |
|
15993 |
|
15994 |
|
15995 </div> |
|
15996 |
|
15997 |
|
15998 <div id="method_route" class="method item inherited"> |
|
15999 <h3 class="name"><code>route</code></h3> |
|
16000 |
|
16001 |
|
16002 <div class="args"> |
|
16003 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16004 |
|
16005 <li class="arg"> |
|
16006 |
|
16007 <code>path</code> |
|
16008 |
|
16009 </li> |
|
16010 |
|
16011 <li class="arg"> |
|
16012 |
|
16013 <code>callbacks</code> |
|
16014 |
|
16015 </li> |
|
16016 |
|
16017 </ul><span class="paren">)</span> |
|
16018 </div> |
|
16019 |
|
16020 |
|
16021 |
|
16022 |
|
16023 |
|
16024 |
|
16025 |
|
16026 |
|
16027 |
|
16028 |
|
16029 |
|
16030 |
|
16031 |
|
16032 <span class="flag chainable">chainable</span> |
|
16033 |
|
16034 |
|
16035 |
|
16036 |
|
16037 <div class="meta"> |
|
16038 |
|
16039 |
|
16040 <p>Inherited from |
|
16041 <a href="../classes/Router.html#method_route">Router</a>: |
|
16042 |
|
16043 |
|
16044 |
|
16045 <a href="../files/app_js_router.js.html#l371"><code>app/js/router.js:371</code></a> |
|
16046 |
|
16047 </p> |
|
16048 |
|
16049 |
|
16050 |
|
16051 |
|
16052 |
|
16053 </div> |
|
16054 |
|
16055 <div class="description"> |
|
16056 <p>Adds a route handler for the specified URL <em>path</em>.</p> |
|
16057 |
|
16058 <p>The <em>path</em> parameter may be either a string or a regular expression. If it's |
|
16059 a string, it may contain named parameters: <code>:param</code> will match any single |
|
16060 part of a URL path (not including <code>/</code> characters), and <code>*param</code> will match |
|
16061 any number of parts of a URL path (including <code>/</code> characters). These named |
|
16062 parameters will be made available as keys on the <code>req.params</code> object that's |
|
16063 passed to route handlers.</p> |
|
16064 |
|
16065 <p>If the <em>path</em> parameter is a regex, all pattern matches will be made |
|
16066 available as numbered keys on <code>req.params</code>, starting with <code>0</code> for the full |
|
16067 match, then <code>1</code> for the first subpattern match, and so on.</p> |
|
16068 |
|
16069 <p>Here's a set of sample routes along with URL paths that they match:</p> |
|
16070 |
|
16071 <ul> |
|
16072 <li><p>Route: <code>/photos/:tag/:page</code></p> |
|
16073 |
|
16074 <ul><li>URL: <code>/photos/kittens/1</code>, params: <code>{tag: 'kittens', page: '1'}</code></li> |
|
16075 <li>URL: <code>/photos/puppies/2</code>, params: <code>{tag: 'puppies', page: '2'}</code></li></ul></li> |
|
16076 <li><p>Route: <code>/file/*path</code></p> |
|
16077 |
|
16078 <ul><li>URL: <code>/file/foo/bar/baz.txt</code>, params: <code>{path: 'foo/bar/baz.txt'}</code></li> |
|
16079 <li>URL: <code>/file/foo</code>, params: <code>{path: 'foo'}</code></li></ul></li> |
|
16080 </ul> |
|
16081 |
|
16082 <p><strong>Middleware</strong>: Routes also support an arbitrary number of callback |
|
16083 functions. This allows you to easily reuse parts of your route-handling code |
|
16084 with different route. This method is liberal in how it processes the |
|
16085 specified <code>callbacks</code>, you can specify them as separate arguments, or as |
|
16086 arrays, or both.</p> |
|
16087 |
|
16088 <p>If multiple route match a given URL, they will be executed in the order they |
|
16089 were added. The first route that was added will be the first to be executed.</p> |
|
16090 |
|
16091 <p><strong>Passing Control</strong>: Invoking the <code>next()</code> function within a route callback |
|
16092 will pass control to the next callback function (if any) or route handler |
|
16093 (if any). If a value is passed to <code>next()</code>, it's assumed to be an error, |
|
16094 therefore stopping the dispatch chain, unless that value is: <code>"route"</code>, |
|
16095 which is special case and dispatching will skip to the next route handler. |
|
16096 This allows middleware to skip any remaining middleware for a particular |
|
16097 route.</p> |
|
16098 </div> |
|
16099 |
|
16100 |
|
16101 <div class="params"> |
|
16102 <h4>Parameters:</h4> |
|
16103 |
|
16104 <ul class="params-list"> |
|
16105 |
|
16106 <li class="param"> |
|
16107 |
|
16108 <code class="param-name">path</code> |
|
16109 <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> |
|
16110 |
|
16111 |
|
16112 |
|
16113 |
|
16114 <div class="param-description"> |
|
16115 <p>Path to match. May be a string or a regular |
|
16116 expression.</p> |
|
16117 </div> |
|
16118 |
|
16119 |
|
16120 </li> |
|
16121 |
|
16122 <li class="param"> |
|
16123 |
|
16124 <code class="param-name">callbacks</code> |
|
16125 <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> |
|
16126 |
|
16127 |
|
16128 |
|
16129 <span class="flag multiple" title="This argument may occur one or more times.">multiple</span> |
|
16130 |
|
16131 |
|
16132 <div class="param-description"> |
|
16133 <p>Callback functions to call |
|
16134 whenever this route is triggered. These can be specified as separate |
|
16135 arguments, or in arrays, or both. If a callback is specified as a |
|
16136 string, the named function will be called on this router instance.</p> |
|
16137 </div> |
|
16138 |
|
16139 |
|
16140 <ul class="params-list"> |
|
16141 |
|
16142 <li class="param"> |
|
16143 |
|
16144 <code class="param-name">req</code> |
|
16145 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16146 |
|
16147 |
|
16148 <div class="param-description"> |
|
16149 <p>Request object containing information about |
|
16150 the request. It contains the following properties.</p> |
|
16151 </div> |
|
16152 |
|
16153 |
|
16154 <ul class="params-list"> |
|
16155 |
|
16156 <li class="param"> |
|
16157 |
|
16158 <code class="param-name">params</code> |
|
16159 <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> |
|
16160 |
|
16161 |
|
16162 <div class="param-description"> |
|
16163 Captured parameters matched by |
|
16164 the route path specification. If a string path was used and contained |
|
16165 named parameters, then this will be a key/value hash mapping parameter |
|
16166 names to their matched values. If a regex path was used, this will be |
|
16167 an array of subpattern matches starting at index 0 for the full match, |
|
16168 then 1 for the first subpattern match, and so on. |
|
16169 </div> |
|
16170 </li> |
|
16171 |
|
16172 <li class="param"> |
|
16173 |
|
16174 <code class="param-name">path</code> |
|
16175 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16176 |
|
16177 |
|
16178 <div class="param-description"> |
|
16179 The current URL path. |
|
16180 </div> |
|
16181 </li> |
|
16182 |
|
16183 <li class="param"> |
|
16184 |
|
16185 <code class="param-name">pendingCallbacks</code> |
|
16186 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
16187 |
|
16188 |
|
16189 <div class="param-description"> |
|
16190 Number of remaining |
|
16191 callbacks the route handler has after this one in the dispatch chain. |
|
16192 </div> |
|
16193 </li> |
|
16194 |
|
16195 <li class="param"> |
|
16196 |
|
16197 <code class="param-name">pendingRoutes</code> |
|
16198 <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span> |
|
16199 |
|
16200 |
|
16201 <div class="param-description"> |
|
16202 Number of matching routes |
|
16203 after this one in the dispatch chain. |
|
16204 </div> |
|
16205 </li> |
|
16206 |
|
16207 <li class="param"> |
|
16208 |
|
16209 <code class="param-name">query</code> |
|
16210 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16211 |
|
16212 |
|
16213 <div class="param-description"> |
|
16214 Query hash representing the URL |
|
16215 query string, if any. Parameter names are keys, and are mapped to |
|
16216 parameter values. |
|
16217 </div> |
|
16218 </li> |
|
16219 |
|
16220 <li class="param"> |
|
16221 |
|
16222 <code class="param-name">url</code> |
|
16223 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16224 |
|
16225 |
|
16226 <div class="param-description"> |
|
16227 The full URL. |
|
16228 </div> |
|
16229 </li> |
|
16230 |
|
16231 <li class="param"> |
|
16232 |
|
16233 <code class="param-name">src</code> |
|
16234 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16235 |
|
16236 |
|
16237 <div class="param-description"> |
|
16238 What initiated the dispatch. In an |
|
16239 HTML5 browser, when the back/forward buttons are used, this property |
|
16240 will have a value of "popstate". |
|
16241 </div> |
|
16242 </li> |
|
16243 |
|
16244 </ul> |
|
16245 |
|
16246 </li> |
|
16247 |
|
16248 <li class="param"> |
|
16249 |
|
16250 <code class="param-name">res</code> |
|
16251 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16252 |
|
16253 |
|
16254 <div class="param-description"> |
|
16255 <p>Response object containing methods and |
|
16256 information that relate to responding to a request. It contains the |
|
16257 following properties.</p> |
|
16258 </div> |
|
16259 |
|
16260 |
|
16261 <ul class="params-list"> |
|
16262 |
|
16263 <li class="param"> |
|
16264 |
|
16265 <code class="param-name">req</code> |
|
16266 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16267 |
|
16268 |
|
16269 <div class="param-description"> |
|
16270 Reference to the request object. |
|
16271 </div> |
|
16272 </li> |
|
16273 |
|
16274 </ul> |
|
16275 |
|
16276 </li> |
|
16277 |
|
16278 <li class="param"> |
|
16279 |
|
16280 <code class="param-name">next</code> |
|
16281 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
16282 |
|
16283 |
|
16284 <div class="param-description"> |
|
16285 <p>Function to pass control to the next |
|
16286 callback or the next matching route if no more callbacks (middleware) |
|
16287 exist for the current route handler. If you don't call this function, |
|
16288 then no further callbacks or route handlers will be executed, even if |
|
16289 there are more that match. If you do call this function, then the next |
|
16290 callback (if any) or matching route handler (if any) will be called. |
|
16291 All of these functions will receive the same <code>req</code> and <code>res</code> objects |
|
16292 that were passed to this route (so you can use these objects to pass |
|
16293 data along to subsequent callbacks and routes).</p> |
|
16294 </div> |
|
16295 |
|
16296 |
|
16297 <ul class="params-list"> |
|
16298 |
|
16299 <li class="param"> |
|
16300 |
|
16301 <code class="param-name optional">[err]</code> |
|
16302 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16303 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16304 |
|
16305 |
|
16306 <div class="param-description"> |
|
16307 Optional error which will stop the |
|
16308 dispatch chaining for this <code>req</code>, unless the value is <code>"route"</code>, which |
|
16309 is special cased to jump skip past any callbacks for the current route |
|
16310 and pass control the next route handler. |
|
16311 </div> |
|
16312 </li> |
|
16313 |
|
16314 </ul> |
|
16315 |
|
16316 </li> |
|
16317 |
|
16318 </ul> |
|
16319 |
|
16320 </li> |
|
16321 |
|
16322 </ul> |
|
16323 </div> |
|
16324 |
|
16325 |
|
16326 |
|
16327 |
|
16328 |
|
16329 <div class="example"> |
|
16330 <h4>Example:</h4> |
|
16331 |
|
16332 <div class="example-content"> |
|
16333 <pre class="code prettyprint"><code>router.route('/photos/:tag/:page', function (req, res, next) { |
|
16334 Y.log('Current tag: ' + req.params.tag); |
|
16335 Y.log('Current page number: ' + req.params.page); |
|
16336 }); |
|
16337 |
|
16338 // Using middleware. |
|
16339 |
|
16340 router.findUser = function (req, res, next) { |
|
16341 req.user = this.get('users').findById(req.params.user); |
|
16342 next(); |
|
16343 }; |
|
16344 |
|
16345 router.route('/users/:user', 'findUser', function (req, res, next) { |
|
16346 // The <code>findUser</code> middleware puts the <code>user</code> object on the <code>req</code>. |
|
16347 Y.log('Current user:' req.user.get('name')); |
|
16348 }); |
|
16349 </code></pre> |
|
16350 </div> |
|
16351 </div> |
|
16352 |
|
16353 </div> |
|
16354 |
|
16355 |
|
16356 <div id="method_save" class="method item inherited"> |
|
16357 <h3 class="name"><code>save</code></h3> |
|
16358 |
|
16359 |
|
16360 <div class="args"> |
|
16361 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16362 |
|
16363 <li class="arg"> |
|
16364 |
|
16365 <code class="optional">[url]</code> |
|
16366 |
|
16367 </li> |
|
16368 |
|
16369 </ul><span class="paren">)</span> |
|
16370 </div> |
|
16371 |
|
16372 |
|
16373 |
|
16374 |
|
16375 |
|
16376 |
|
16377 |
|
16378 |
|
16379 |
|
16380 |
|
16381 |
|
16382 |
|
16383 |
|
16384 <span class="flag chainable">chainable</span> |
|
16385 |
|
16386 |
|
16387 |
|
16388 |
|
16389 <div class="meta"> |
|
16390 |
|
16391 |
|
16392 <p>Inherited from |
|
16393 <a href="../classes/Router.html#method_save">Router</a>: |
|
16394 |
|
16395 |
|
16396 |
|
16397 <a href="../files/app_js_router.js.html#l498"><code>app/js/router.js:498</code></a> |
|
16398 |
|
16399 </p> |
|
16400 |
|
16401 |
|
16402 |
|
16403 |
|
16404 |
|
16405 </div> |
|
16406 |
|
16407 <div class="description"> |
|
16408 <p>Saves a new browser history entry and dispatches to the first matching route |
|
16409 handler, if any.</p> |
|
16410 |
|
16411 <p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that |
|
16412 support it (or the location hash in older browsers and IE) to change the |
|
16413 URL and create a history entry.</p> |
|
16414 |
|
16415 <p>The specified URL must share the same origin (i.e., protocol, host, and |
|
16416 port) as the current page, or an error will occur.</p> |
|
16417 </div> |
|
16418 |
|
16419 |
|
16420 <div class="params"> |
|
16421 <h4>Parameters:</h4> |
|
16422 |
|
16423 <ul class="params-list"> |
|
16424 |
|
16425 <li class="param"> |
|
16426 |
|
16427 <code class="param-name optional">[url]</code> |
|
16428 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16429 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16430 |
|
16431 |
|
16432 |
|
16433 |
|
16434 <div class="param-description"> |
|
16435 <p>URL to set. This URL needs to be of the same origin as |
|
16436 the current URL. This can be a URL relative to the router's <code>root</code> |
|
16437 attribute. If no URL is specified, the page's current URL will be used.</p> |
|
16438 </div> |
|
16439 |
|
16440 |
|
16441 </li> |
|
16442 |
|
16443 </ul> |
|
16444 </div> |
|
16445 |
|
16446 |
|
16447 |
|
16448 |
|
16449 |
|
16450 <div class="example"> |
|
16451 <h4>Example:</h4> |
|
16452 |
|
16453 <div class="example-content"> |
|
16454 <pre class="code prettyprint"><code>// Starting URL: http://example.com/ |
|
16455 |
|
16456 router.save('/path/'); |
|
16457 // New URL: http://example.com/path/ |
|
16458 |
|
16459 router.save('/path?foo=bar'); |
|
16460 // New URL: http://example.com/path?foo=bar |
|
16461 |
|
16462 router.save('/'); |
|
16463 // New URL: http://example.com/ |
|
16464 </code></pre> |
|
16465 </div> |
|
16466 </div> |
|
16467 |
|
16468 </div> |
|
16469 |
|
16470 |
|
16471 <div id="method_set" class="method item inherited"> |
|
16472 <h3 class="name"><code>set</code></h3> |
|
16473 |
|
16474 |
|
16475 <div class="args"> |
|
16476 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16477 |
|
16478 <li class="arg"> |
|
16479 |
|
16480 <code>name</code> |
|
16481 |
|
16482 </li> |
|
16483 |
|
16484 <li class="arg"> |
|
16485 |
|
16486 <code>value</code> |
|
16487 |
|
16488 </li> |
|
16489 |
|
16490 <li class="arg"> |
|
16491 |
|
16492 <code class="optional">[opts]</code> |
|
16493 |
|
16494 </li> |
|
16495 |
|
16496 </ul><span class="paren">)</span> |
|
16497 </div> |
|
16498 |
|
16499 |
|
16500 |
|
16501 <span class="returns-inline"> |
|
16502 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16503 </span> |
|
16504 |
|
16505 |
|
16506 |
|
16507 |
|
16508 |
|
16509 |
|
16510 |
|
16511 |
|
16512 |
|
16513 |
|
16514 |
|
16515 <span class="flag chainable">chainable</span> |
|
16516 |
|
16517 |
|
16518 |
|
16519 |
|
16520 <div class="meta"> |
|
16521 |
|
16522 <p>Inherited from |
|
16523 <a href="../classes/AttributeObservable.html#method_set"> |
|
16524 AttributeObservable |
|
16525 </a> |
|
16526 |
|
16527 but overwritten in |
|
16528 |
|
16529 |
|
16530 |
|
16531 <a href="../files/attribute_js_AttributeCore.js.html#l410"><code>attribute/js/AttributeCore.js:410</code></a> |
|
16532 |
|
16533 </p> |
|
16534 |
|
16535 |
|
16536 |
|
16537 |
|
16538 |
|
16539 </div> |
|
16540 |
|
16541 <div class="description"> |
|
16542 <p>Sets the value of an attribute.</p> |
|
16543 </div> |
|
16544 |
|
16545 |
|
16546 <div class="params"> |
|
16547 <h4>Parameters:</h4> |
|
16548 |
|
16549 <ul class="params-list"> |
|
16550 |
|
16551 <li class="param"> |
|
16552 |
|
16553 <code class="param-name">name</code> |
|
16554 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
16555 |
|
16556 |
|
16557 |
|
16558 |
|
16559 <div class="param-description"> |
|
16560 <p>The name of the attribute. If the |
|
16561 current value of the attribute is an Object, dot notation can be used |
|
16562 to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p> |
|
16563 </div> |
|
16564 |
|
16565 |
|
16566 </li> |
|
16567 |
|
16568 <li class="param"> |
|
16569 |
|
16570 <code class="param-name">value</code> |
|
16571 <span class="type">Any</span> |
|
16572 |
|
16573 |
|
16574 |
|
16575 |
|
16576 <div class="param-description"> |
|
16577 <p>The value to set the attribute to.</p> |
|
16578 </div> |
|
16579 |
|
16580 |
|
16581 </li> |
|
16582 |
|
16583 <li class="param"> |
|
16584 |
|
16585 <code class="param-name optional">[opts]</code> |
|
16586 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16587 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16588 |
|
16589 |
|
16590 |
|
16591 |
|
16592 <div class="param-description"> |
|
16593 <p>Optional data providing the circumstances for the change.</p> |
|
16594 </div> |
|
16595 |
|
16596 |
|
16597 </li> |
|
16598 |
|
16599 </ul> |
|
16600 </div> |
|
16601 |
|
16602 |
|
16603 |
|
16604 <div class="returns"> |
|
16605 <h4>Returns:</h4> |
|
16606 |
|
16607 <div class="returns-description"> |
|
16608 |
|
16609 |
|
16610 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
16611 |
|
16612 A reference to the host object. |
|
16613 |
|
16614 </div> |
|
16615 </div> |
|
16616 |
|
16617 |
|
16618 |
|
16619 </div> |
|
16620 |
|
16621 |
|
16622 <div id="method_setAttrs" class="method item inherited"> |
|
16623 <h3 class="name"><code>setAttrs</code></h3> |
|
16624 |
|
16625 |
|
16626 <div class="args"> |
|
16627 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16628 |
|
16629 <li class="arg"> |
|
16630 |
|
16631 <code>attrs</code> |
|
16632 |
|
16633 </li> |
|
16634 |
|
16635 <li class="arg"> |
|
16636 |
|
16637 <code class="optional">[opts]</code> |
|
16638 |
|
16639 </li> |
|
16640 |
|
16641 </ul><span class="paren">)</span> |
|
16642 </div> |
|
16643 |
|
16644 |
|
16645 |
|
16646 <span class="returns-inline"> |
|
16647 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16648 </span> |
|
16649 |
|
16650 |
|
16651 |
|
16652 |
|
16653 |
|
16654 |
|
16655 |
|
16656 |
|
16657 |
|
16658 |
|
16659 |
|
16660 <span class="flag chainable">chainable</span> |
|
16661 |
|
16662 |
|
16663 |
|
16664 |
|
16665 <div class="meta"> |
|
16666 |
|
16667 <p>Inherited from |
|
16668 <a href="../classes/AttributeObservable.html#method_setAttrs"> |
|
16669 AttributeObservable |
|
16670 </a> |
|
16671 |
|
16672 but overwritten in |
|
16673 |
|
16674 |
|
16675 |
|
16676 <a href="../files/attribute_js_AttributeCore.js.html#l729"><code>attribute/js/AttributeCore.js:729</code></a> |
|
16677 |
|
16678 </p> |
|
16679 |
|
16680 |
|
16681 |
|
16682 |
|
16683 |
|
16684 </div> |
|
16685 |
|
16686 <div class="description"> |
|
16687 <p>Sets multiple attribute values.</p> |
|
16688 </div> |
|
16689 |
|
16690 |
|
16691 <div class="params"> |
|
16692 <h4>Parameters:</h4> |
|
16693 |
|
16694 <ul class="params-list"> |
|
16695 |
|
16696 <li class="param"> |
|
16697 |
|
16698 <code class="param-name">attrs</code> |
|
16699 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16700 |
|
16701 |
|
16702 |
|
16703 |
|
16704 <div class="param-description"> |
|
16705 <p>An object with attributes name/value pairs.</p> |
|
16706 </div> |
|
16707 |
|
16708 |
|
16709 </li> |
|
16710 |
|
16711 <li class="param"> |
|
16712 |
|
16713 <code class="param-name optional">[opts]</code> |
|
16714 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16715 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16716 |
|
16717 |
|
16718 |
|
16719 |
|
16720 <div class="param-description"> |
|
16721 <p>Optional data providing the circumstances for the change.</p> |
|
16722 </div> |
|
16723 |
|
16724 |
|
16725 </li> |
|
16726 |
|
16727 </ul> |
|
16728 </div> |
|
16729 |
|
16730 |
|
16731 |
|
16732 <div class="returns"> |
|
16733 <h4>Returns:</h4> |
|
16734 |
|
16735 <div class="returns-description"> |
|
16736 |
|
16737 |
|
16738 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
16739 |
|
16740 A reference to the host object. |
|
16741 |
|
16742 </div> |
|
16743 </div> |
|
16744 |
|
16745 |
|
16746 |
|
16747 </div> |
|
16748 |
|
16749 |
|
16750 <div id="method_showView" class="method item"> |
|
16751 <h3 class="name"><code>showView</code></h3> |
|
16752 |
|
16753 |
|
16754 <div class="args"> |
|
16755 <span class="paren">(</span><ul class="args-list inline commas"> |
|
16756 |
|
16757 <li class="arg"> |
|
16758 |
|
16759 <code>view</code> |
|
16760 |
|
16761 </li> |
|
16762 |
|
16763 <li class="arg"> |
|
16764 |
|
16765 <code class="optional">[config]</code> |
|
16766 |
|
16767 </li> |
|
16768 |
|
16769 <li class="arg"> |
|
16770 |
|
16771 <code class="optional">[options]</code> |
|
16772 |
|
16773 </li> |
|
16774 |
|
16775 <li class="arg"> |
|
16776 |
|
16777 <code class="optional">[callback]</code> |
|
16778 |
|
16779 </li> |
|
16780 |
|
16781 </ul><span class="paren">)</span> |
|
16782 </div> |
|
16783 |
|
16784 |
|
16785 |
|
16786 |
|
16787 |
|
16788 |
|
16789 |
|
16790 |
|
16791 |
|
16792 |
|
16793 |
|
16794 |
|
16795 |
|
16796 <span class="flag chainable">chainable</span> |
|
16797 |
|
16798 |
|
16799 |
|
16800 |
|
16801 <div class="meta"> |
|
16802 |
|
16803 |
|
16804 |
|
16805 <p> |
|
16806 |
|
16807 Defined in |
|
16808 |
|
16809 |
|
16810 |
|
16811 |
|
16812 <a href="../files/app_js_app-base.js.html#l307"><code>app/js/app-base.js:307</code></a> |
|
16813 |
|
16814 </p> |
|
16815 |
|
16816 |
|
16817 |
|
16818 |
|
16819 |
|
16820 <p>Available since 3.5.0</p> |
|
16821 |
|
16822 </div> |
|
16823 |
|
16824 <div class="description"> |
|
16825 <p>Sets which view is active/visible for the application. This will set the |
|
16826 app's <code>activeView</code> attribute to the specified <code>view</code>.</p> |
|
16827 |
|
16828 <p>The <code>view</code> will be "attached" to this app, meaning it will be both rendered |
|
16829 into this app's <code>viewContainer</code> node and all of its events will bubble to |
|
16830 the app. The previous <code>activeView</code> will be "detached" from this app.</p> |
|
16831 |
|
16832 <p>When a string-name is provided for a view which has been registered on this |
|
16833 app's <code>views</code> object, the referenced metadata will be used and the |
|
16834 <code>activeView</code> will be set to either a preserved view instance, or a new |
|
16835 instance of the registered view will be created using the specified <code>config</code> |
|
16836 object passed-into this method.</p> |
|
16837 |
|
16838 <p>A callback function can be specified as either the third or fourth argument, |
|
16839 and this function will be called after the new <code>view</code> becomes the |
|
16840 <code>activeView</code>, is rendered to the <code>viewContainer</code>, and is ready to use.</p> |
|
16841 </div> |
|
16842 |
|
16843 |
|
16844 <div class="params"> |
|
16845 <h4>Parameters:</h4> |
|
16846 |
|
16847 <ul class="params-list"> |
|
16848 |
|
16849 <li class="param"> |
|
16850 |
|
16851 <code class="param-name">view</code> |
|
16852 <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/View.html" class="crosslink">View</a></span> |
|
16853 |
|
16854 |
|
16855 |
|
16856 |
|
16857 <div class="param-description"> |
|
16858 <p>The name of a view defined in the <code>views</code> object, |
|
16859 or a view instance which should become this app's <code>activeView</code>.</p> |
|
16860 </div> |
|
16861 |
|
16862 |
|
16863 </li> |
|
16864 |
|
16865 <li class="param"> |
|
16866 |
|
16867 <code class="param-name optional">[config]</code> |
|
16868 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16869 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16870 |
|
16871 |
|
16872 |
|
16873 |
|
16874 <div class="param-description"> |
|
16875 <p>Optional configuration to use when creating a new |
|
16876 view instance. This config object can also be used to update an existing |
|
16877 or preserved view's attributes when <code>options.update</code> is <code>true</code>.</p> |
|
16878 </div> |
|
16879 |
|
16880 |
|
16881 </li> |
|
16882 |
|
16883 <li class="param"> |
|
16884 |
|
16885 <code class="param-name optional">[options]</code> |
|
16886 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
16887 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16888 |
|
16889 |
|
16890 |
|
16891 |
|
16892 <div class="param-description"> |
|
16893 <p>Optional object containing any of the following |
|
16894 properties:</p> |
|
16895 </div> |
|
16896 |
|
16897 |
|
16898 <ul class="params-list"> |
|
16899 |
|
16900 <li class="param"> |
|
16901 |
|
16902 <code class="param-name optional">[callback]</code> |
|
16903 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
16904 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16905 |
|
16906 |
|
16907 <div class="param-description"> |
|
16908 <p>Optional callback function to call |
|
16909 after new <code>activeView</code> is ready to use, the function will be passed:</p> |
|
16910 </div> |
|
16911 |
|
16912 |
|
16913 <ul class="params-list"> |
|
16914 |
|
16915 <li class="param"> |
|
16916 |
|
16917 <code class="param-name">view</code> |
|
16918 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
16919 |
|
16920 |
|
16921 <div class="param-description"> |
|
16922 A reference to the new |
|
16923 <code>activeView</code>. |
|
16924 </div> |
|
16925 </li> |
|
16926 |
|
16927 </ul> |
|
16928 |
|
16929 </li> |
|
16930 |
|
16931 <li class="param"> |
|
16932 |
|
16933 <code class="param-name optional">[prepend=false]</code> |
|
16934 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16935 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16936 |
|
16937 |
|
16938 <div class="param-description"> |
|
16939 <p>Whether the <code>view</code> should be |
|
16940 prepended instead of appended to the <code>viewContainer</code>.</p> |
|
16941 </div> |
|
16942 |
|
16943 |
|
16944 </li> |
|
16945 |
|
16946 <li class="param"> |
|
16947 |
|
16948 <code class="param-name optional">[render]</code> |
|
16949 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16950 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16951 |
|
16952 |
|
16953 <div class="param-description"> |
|
16954 <p>Whether the <code>view</code> should be rendered. |
|
16955 <strong>Note:</strong> If no value is specified, a view instance will only be |
|
16956 rendered if it's newly created by this method.</p> |
|
16957 </div> |
|
16958 |
|
16959 |
|
16960 </li> |
|
16961 |
|
16962 <li class="param"> |
|
16963 |
|
16964 <code class="param-name optional">[update=false]</code> |
|
16965 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
16966 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16967 |
|
16968 |
|
16969 <div class="param-description"> |
|
16970 <p>Whether an existing view should |
|
16971 have its attributes updated by passing the <code>config</code> object to its |
|
16972 <code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if |
|
16973 the <code>view</code> instance is created as a result of calling this method.</p> |
|
16974 </div> |
|
16975 |
|
16976 |
|
16977 </li> |
|
16978 |
|
16979 </ul> |
|
16980 |
|
16981 </li> |
|
16982 |
|
16983 <li class="param"> |
|
16984 |
|
16985 <code class="param-name optional">[callback]</code> |
|
16986 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
16987 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
16988 |
|
16989 |
|
16990 |
|
16991 |
|
16992 <div class="param-description"> |
|
16993 <p>Optional callback Function to call after the |
|
16994 new <code>activeView</code> is ready to use. <strong>Note:</strong> this will override |
|
16995 <code>options.callback</code> and it can be specified as either the third or fourth |
|
16996 argument. The function will be passed the following:</p> |
|
16997 </div> |
|
16998 |
|
16999 |
|
17000 <ul class="params-list"> |
|
17001 |
|
17002 <li class="param"> |
|
17003 |
|
17004 <code class="param-name">view</code> |
|
17005 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
17006 |
|
17007 |
|
17008 <div class="param-description"> |
|
17009 <p>A reference to the new <code>activeView</code>.</p> |
|
17010 </div> |
|
17011 |
|
17012 |
|
17013 </li> |
|
17014 |
|
17015 </ul> |
|
17016 |
|
17017 </li> |
|
17018 |
|
17019 </ul> |
|
17020 </div> |
|
17021 |
|
17022 |
|
17023 |
|
17024 |
|
17025 |
|
17026 <div class="example"> |
|
17027 <h4>Example:</h4> |
|
17028 |
|
17029 <div class="example-content"> |
|
17030 <pre class="code prettyprint"><code>var app = new Y.App({ |
|
17031 views: { |
|
17032 usersView: { |
|
17033 // Imagine that <code>Y.UsersView</code> has been defined. |
|
17034 type: Y.UsersView |
|
17035 } |
|
17036 }, |
|
17037 |
|
17038 users: new Y.ModelList() |
|
17039 }); |
|
17040 |
|
17041 app.route('/users/', function () { |
|
17042 this.showView('usersView', {users: this.get('users')}); |
|
17043 }); |
|
17044 |
|
17045 app.render(); |
|
17046 app.navigate('/uses/'); // => Creates a new <code>Y.UsersView</code> and shows it. |
|
17047 </code></pre> |
|
17048 </div> |
|
17049 </div> |
|
17050 |
|
17051 </div> |
|
17052 |
|
17053 |
|
17054 <div id="method_subscribe" class="method item deprecated inherited"> |
|
17055 <h3 class="name"><code>subscribe</code></h3> |
|
17056 |
|
17057 |
|
17058 <span class="paren">()</span> |
|
17059 |
|
17060 |
|
17061 |
|
17062 |
|
17063 |
|
17064 <span class="flag deprecated" title="use on">deprecated</span> |
|
17065 |
|
17066 |
|
17067 |
|
17068 |
|
17069 |
|
17070 |
|
17071 |
|
17072 |
|
17073 |
|
17074 |
|
17075 |
|
17076 |
|
17077 <div class="meta"> |
|
17078 |
|
17079 |
|
17080 <p>Inherited from |
|
17081 <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>: |
|
17082 |
|
17083 |
|
17084 |
|
17085 <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a> |
|
17086 |
|
17087 </p> |
|
17088 |
|
17089 |
|
17090 |
|
17091 <p>Deprecated: use on</p> |
|
17092 |
|
17093 |
|
17094 |
|
17095 </div> |
|
17096 |
|
17097 <div class="description"> |
|
17098 <p>subscribe to an event</p> |
|
17099 </div> |
|
17100 |
|
17101 |
|
17102 |
|
17103 |
|
17104 |
|
17105 |
|
17106 </div> |
|
17107 |
|
17108 |
|
17109 <div id="method_toString" class="method item inherited"> |
|
17110 <h3 class="name"><code>toString</code></h3> |
|
17111 |
|
17112 |
|
17113 <span class="paren">()</span> |
|
17114 |
|
17115 |
|
17116 |
|
17117 <span class="returns-inline"> |
|
17118 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17119 </span> |
|
17120 |
|
17121 |
|
17122 |
|
17123 |
|
17124 |
|
17125 |
|
17126 |
|
17127 |
|
17128 |
|
17129 |
|
17130 |
|
17131 |
|
17132 |
|
17133 |
|
17134 <div class="meta"> |
|
17135 |
|
17136 |
|
17137 <p>Inherited from |
|
17138 <a href="../classes/BaseCore.html#method_toString">BaseCore</a>: |
|
17139 |
|
17140 |
|
17141 |
|
17142 <a href="../files/base_js_BaseCore.js.html#l754"><code>base/js/BaseCore.js:754</code></a> |
|
17143 |
|
17144 </p> |
|
17145 |
|
17146 |
|
17147 |
|
17148 |
|
17149 |
|
17150 </div> |
|
17151 |
|
17152 <div class="description"> |
|
17153 <p>Default toString implementation. Provides the constructor NAME |
|
17154 and the instance guid, if set.</p> |
|
17155 </div> |
|
17156 |
|
17157 |
|
17158 |
|
17159 |
|
17160 <div class="returns"> |
|
17161 <h4>Returns:</h4> |
|
17162 |
|
17163 <div class="returns-description"> |
|
17164 |
|
17165 |
|
17166 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
17167 |
|
17168 String representation for this object |
|
17169 |
|
17170 </div> |
|
17171 </div> |
|
17172 |
|
17173 |
|
17174 |
|
17175 </div> |
|
17176 |
|
17177 |
|
17178 <div id="method_unsubscribe" class="method item deprecated inherited"> |
|
17179 <h3 class="name"><code>unsubscribe</code></h3> |
|
17180 |
|
17181 |
|
17182 <span class="paren">()</span> |
|
17183 |
|
17184 |
|
17185 |
|
17186 |
|
17187 |
|
17188 <span class="flag deprecated" title="use detach">deprecated</span> |
|
17189 |
|
17190 |
|
17191 |
|
17192 |
|
17193 |
|
17194 |
|
17195 |
|
17196 |
|
17197 |
|
17198 |
|
17199 |
|
17200 |
|
17201 <div class="meta"> |
|
17202 |
|
17203 |
|
17204 <p>Inherited from |
|
17205 <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>: |
|
17206 |
|
17207 |
|
17208 |
|
17209 <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a> |
|
17210 |
|
17211 </p> |
|
17212 |
|
17213 |
|
17214 |
|
17215 <p>Deprecated: use detach</p> |
|
17216 |
|
17217 |
|
17218 |
|
17219 </div> |
|
17220 |
|
17221 <div class="description"> |
|
17222 <p>detach a listener</p> |
|
17223 </div> |
|
17224 |
|
17225 |
|
17226 |
|
17227 |
|
17228 |
|
17229 |
|
17230 </div> |
|
17231 |
|
17232 |
|
17233 <div id="method_unsubscribeAll" class="method item deprecated inherited"> |
|
17234 <h3 class="name"><code>unsubscribeAll</code></h3> |
|
17235 |
|
17236 |
|
17237 <div class="args"> |
|
17238 <span class="paren">(</span><ul class="args-list inline commas"> |
|
17239 |
|
17240 <li class="arg"> |
|
17241 |
|
17242 <code>type</code> |
|
17243 |
|
17244 </li> |
|
17245 |
|
17246 </ul><span class="paren">)</span> |
|
17247 </div> |
|
17248 |
|
17249 |
|
17250 |
|
17251 |
|
17252 |
|
17253 <span class="flag deprecated" title="use detachAll">deprecated</span> |
|
17254 |
|
17255 |
|
17256 |
|
17257 |
|
17258 |
|
17259 |
|
17260 |
|
17261 |
|
17262 |
|
17263 |
|
17264 |
|
17265 |
|
17266 <div class="meta"> |
|
17267 |
|
17268 |
|
17269 <p>Inherited from |
|
17270 <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>: |
|
17271 |
|
17272 |
|
17273 |
|
17274 <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a> |
|
17275 |
|
17276 </p> |
|
17277 |
|
17278 |
|
17279 |
|
17280 <p>Deprecated: use detachAll</p> |
|
17281 |
|
17282 |
|
17283 |
|
17284 </div> |
|
17285 |
|
17286 <div class="description"> |
|
17287 <p>Removes all listeners from the specified event. If the event type |
|
17288 is not specified, all listeners from all hosted custom events will |
|
17289 be removed.</p> |
|
17290 </div> |
|
17291 |
|
17292 |
|
17293 <div class="params"> |
|
17294 <h4>Parameters:</h4> |
|
17295 |
|
17296 <ul class="params-list"> |
|
17297 |
|
17298 <li class="param"> |
|
17299 |
|
17300 <code class="param-name">type</code> |
|
17301 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
17302 |
|
17303 |
|
17304 |
|
17305 |
|
17306 <div class="param-description"> |
|
17307 <p>The type, or name of the event</p> |
|
17308 </div> |
|
17309 |
|
17310 |
|
17311 </li> |
|
17312 |
|
17313 </ul> |
|
17314 </div> |
|
17315 |
|
17316 |
|
17317 |
|
17318 |
|
17319 |
|
17320 </div> |
|
17321 |
|
17322 |
|
17323 <div id="method_upgrade" class="method item inherited"> |
|
17324 <h3 class="name"><code>upgrade</code></h3> |
|
17325 |
|
17326 |
|
17327 <span class="paren">()</span> |
|
17328 |
|
17329 |
|
17330 |
|
17331 <span class="returns-inline"> |
|
17332 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17333 </span> |
|
17334 |
|
17335 |
|
17336 |
|
17337 |
|
17338 |
|
17339 |
|
17340 |
|
17341 |
|
17342 |
|
17343 |
|
17344 |
|
17345 |
|
17346 |
|
17347 |
|
17348 <div class="meta"> |
|
17349 |
|
17350 |
|
17351 <p>Inherited from |
|
17352 <a href="../classes/Router.html#method_upgrade">Router</a>: |
|
17353 |
|
17354 |
|
17355 |
|
17356 <a href="../files/app_js_router.js.html#l532"><code>app/js/router.js:532</code></a> |
|
17357 |
|
17358 </p> |
|
17359 |
|
17360 |
|
17361 |
|
17362 |
|
17363 |
|
17364 </div> |
|
17365 |
|
17366 <div class="description"> |
|
17367 <p>Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5 |
|
17368 browsers, this method is a noop.</p> |
|
17369 </div> |
|
17370 |
|
17371 |
|
17372 |
|
17373 |
|
17374 <div class="returns"> |
|
17375 <h4>Returns:</h4> |
|
17376 |
|
17377 <div class="returns-description"> |
|
17378 |
|
17379 |
|
17380 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
17381 |
|
17382 <code>true</code> if the URL was upgraded, <code>false</code> otherwise. |
|
17383 |
|
17384 </div> |
|
17385 </div> |
|
17386 |
|
17387 |
|
17388 |
|
17389 </div> |
|
17390 |
|
17391 |
|
17392 </div> |
|
17393 |
|
17394 |
|
17395 |
|
17396 <div id="properties" class="api-class-tabpanel"> |
|
17397 <h2 class="off-left">Properties</h2> |
|
17398 |
|
17399 |
|
17400 <div id="property__allowAdHocAttrs" class="property item protected inherited"> |
|
17401 <h3 class="name"><code>_allowAdHocAttrs</code></h3> |
|
17402 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17403 |
|
17404 |
|
17405 |
|
17406 |
|
17407 <span class="flag protected">protected</span> |
|
17408 |
|
17409 |
|
17410 |
|
17411 |
|
17412 |
|
17413 |
|
17414 <div class="meta"> |
|
17415 |
|
17416 <p>Inherited from |
|
17417 <a href="../classes/BaseCore.html#property__allowAdHocAttrs"> |
|
17418 BaseCore |
|
17419 </a> |
|
17420 |
|
17421 but overwritten in |
|
17422 |
|
17423 |
|
17424 |
|
17425 <a href="../files/app_js_view.js.html#l111"><code>app/js/view.js:111</code></a> |
|
17426 |
|
17427 </p> |
|
17428 |
|
17429 |
|
17430 |
|
17431 |
|
17432 <p>Available since 3.5.0</p> |
|
17433 |
|
17434 </div> |
|
17435 |
|
17436 <div class="description"> |
|
17437 <p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config |
|
17438 properties passed to View's constructor. This makes it possible to |
|
17439 instantiate a view and set a bunch of attributes without having to subclass |
|
17440 <code>Y.View</code> and declare all those attributes first.</p> |
|
17441 </div> |
|
17442 |
|
17443 |
|
17444 <p><strong>Default:</strong> true</p> |
|
17445 |
|
17446 |
|
17447 |
|
17448 |
|
17449 |
|
17450 </div> |
|
17451 |
|
17452 |
|
17453 <div id="property__dispatched" class="property item protected inherited"> |
|
17454 <h3 class="name"><code>_dispatched</code></h3> |
|
17455 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17456 |
|
17457 |
|
17458 |
|
17459 |
|
17460 <span class="flag protected">protected</span> |
|
17461 |
|
17462 |
|
17463 |
|
17464 |
|
17465 |
|
17466 |
|
17467 <div class="meta"> |
|
17468 |
|
17469 |
|
17470 <p>Inherited from |
|
17471 <a href="../classes/Router.html#property__dispatched">Router</a>: |
|
17472 |
|
17473 |
|
17474 |
|
17475 <a href="../files/app_js_router.js.html#l64"><code>app/js/router.js:64</code></a> |
|
17476 |
|
17477 </p> |
|
17478 |
|
17479 |
|
17480 |
|
17481 |
|
17482 </div> |
|
17483 |
|
17484 <div class="description"> |
|
17485 <p>Whether or not <code>_dispatch()</code> has been called since this router was |
|
17486 instantiated.</p> |
|
17487 </div> |
|
17488 |
|
17489 |
|
17490 <p><strong>Default:</strong> undefined</p> |
|
17491 |
|
17492 |
|
17493 |
|
17494 |
|
17495 |
|
17496 </div> |
|
17497 |
|
17498 |
|
17499 <div id="property__dispatching" class="property item protected inherited"> |
|
17500 <h3 class="name"><code>_dispatching</code></h3> |
|
17501 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17502 |
|
17503 |
|
17504 |
|
17505 |
|
17506 <span class="flag protected">protected</span> |
|
17507 |
|
17508 |
|
17509 |
|
17510 |
|
17511 |
|
17512 |
|
17513 <div class="meta"> |
|
17514 |
|
17515 |
|
17516 <p>Inherited from |
|
17517 <a href="../classes/Router.html#property__dispatching">Router</a>: |
|
17518 |
|
17519 |
|
17520 |
|
17521 <a href="../files/app_js_router.js.html#l74"><code>app/js/router.js:74</code></a> |
|
17522 |
|
17523 </p> |
|
17524 |
|
17525 |
|
17526 |
|
17527 |
|
17528 </div> |
|
17529 |
|
17530 <div class="description"> |
|
17531 <p>Whether or not we're currently in the process of dispatching to routes.</p> |
|
17532 </div> |
|
17533 |
|
17534 |
|
17535 <p><strong>Default:</strong> undefined</p> |
|
17536 |
|
17537 |
|
17538 |
|
17539 |
|
17540 |
|
17541 </div> |
|
17542 |
|
17543 |
|
17544 <div id="property__historyEvents" class="property item protected inherited"> |
|
17545 <h3 class="name"><code>_historyEvents</code></h3> |
|
17546 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
17547 |
|
17548 |
|
17549 |
|
17550 |
|
17551 <span class="flag protected">protected</span> |
|
17552 |
|
17553 |
|
17554 |
|
17555 |
|
17556 |
|
17557 |
|
17558 <div class="meta"> |
|
17559 |
|
17560 |
|
17561 <p>Inherited from |
|
17562 <a href="../classes/Router.html#property__historyEvents">Router</a>: |
|
17563 |
|
17564 |
|
17565 |
|
17566 <a href="../files/app_js_router.js.html#l83"><code>app/js/router.js:83</code></a> |
|
17567 |
|
17568 </p> |
|
17569 |
|
17570 |
|
17571 |
|
17572 |
|
17573 </div> |
|
17574 |
|
17575 <div class="description"> |
|
17576 <p>History event handle for the <code>history:change</code> or <code>hashchange</code> event |
|
17577 subscription.</p> |
|
17578 </div> |
|
17579 |
|
17580 |
|
17581 |
|
17582 |
|
17583 |
|
17584 |
|
17585 </div> |
|
17586 |
|
17587 |
|
17588 <div id="property__html5" class="property item protected inherited"> |
|
17589 <h3 class="name"><code>_html5</code></h3> |
|
17590 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17591 |
|
17592 |
|
17593 |
|
17594 |
|
17595 <span class="flag protected">protected</span> |
|
17596 |
|
17597 |
|
17598 |
|
17599 |
|
17600 |
|
17601 |
|
17602 <div class="meta"> |
|
17603 |
|
17604 |
|
17605 <p>Inherited from |
|
17606 <a href="../classes/Router.html#property__html5">Router</a>: |
|
17607 |
|
17608 |
|
17609 |
|
17610 <a href="../files/app_js_router.js.html#l92"><code>app/js/router.js:92</code></a> |
|
17611 |
|
17612 </p> |
|
17613 |
|
17614 |
|
17615 |
|
17616 |
|
17617 </div> |
|
17618 |
|
17619 <div class="description"> |
|
17620 <p>Cached copy of the <code>html5</code> attribute for internal use.</p> |
|
17621 </div> |
|
17622 |
|
17623 |
|
17624 |
|
17625 |
|
17626 |
|
17627 |
|
17628 </div> |
|
17629 |
|
17630 |
|
17631 <div id="property__NON_ATTRS_CFG" class="property item protected"> |
|
17632 <h3 class="name"><code>_NON_ATTRS_CFG</code></h3> |
|
17633 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
17634 |
|
17635 |
|
17636 |
|
17637 |
|
17638 <span class="flag protected">protected</span> |
|
17639 |
|
17640 |
|
17641 |
|
17642 |
|
17643 |
|
17644 <span class="flag static">static</span> |
|
17645 |
|
17646 |
|
17647 <div class="meta"> |
|
17648 |
|
17649 |
|
17650 |
|
17651 <p> |
|
17652 |
|
17653 Defined in |
|
17654 |
|
17655 |
|
17656 |
|
17657 |
|
17658 <a href="../files/app_js_app-base.js.html#l1020"><code>app/js/app-base.js:1020</code></a> |
|
17659 |
|
17660 </p> |
|
17661 |
|
17662 |
|
17663 |
|
17664 |
|
17665 <p>Available since 3.5.0</p> |
|
17666 |
|
17667 </div> |
|
17668 |
|
17669 <div class="description"> |
|
17670 <p>Properties that shouldn't be turned into ad-hoc attributes when passed to |
|
17671 App's constructor.</p> |
|
17672 </div> |
|
17673 |
|
17674 |
|
17675 |
|
17676 |
|
17677 |
|
17678 |
|
17679 </div> |
|
17680 |
|
17681 |
|
17682 <div id="property__pjaxEvents" class="property item protected inherited"> |
|
17683 <h3 class="name"><code>_pjaxEvents</code></h3> |
|
17684 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
17685 |
|
17686 |
|
17687 |
|
17688 |
|
17689 <span class="flag protected">protected</span> |
|
17690 |
|
17691 |
|
17692 |
|
17693 |
|
17694 |
|
17695 |
|
17696 <div class="meta"> |
|
17697 |
|
17698 |
|
17699 <p>Inherited from |
|
17700 <a href="../classes/PjaxBase.html#property__pjaxEvents">PjaxBase</a>: |
|
17701 |
|
17702 |
|
17703 |
|
17704 <a href="../files/pjax_js_pjax-base.js.html#l69"><code>pjax/js/pjax-base.js:69</code></a> |
|
17705 |
|
17706 </p> |
|
17707 |
|
17708 |
|
17709 |
|
17710 |
|
17711 <p>Available since 3.5.0</p> |
|
17712 |
|
17713 </div> |
|
17714 |
|
17715 <div class="description"> |
|
17716 <p>Holds the delegated pjax-link click handler.</p> |
|
17717 </div> |
|
17718 |
|
17719 |
|
17720 |
|
17721 |
|
17722 |
|
17723 |
|
17724 </div> |
|
17725 |
|
17726 |
|
17727 <div id="property__ready" class="property item protected inherited"> |
|
17728 <h3 class="name"><code>_ready</code></h3> |
|
17729 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
17730 |
|
17731 |
|
17732 |
|
17733 |
|
17734 <span class="flag protected">protected</span> |
|
17735 |
|
17736 |
|
17737 |
|
17738 |
|
17739 |
|
17740 |
|
17741 <div class="meta"> |
|
17742 |
|
17743 |
|
17744 <p>Inherited from |
|
17745 <a href="../classes/Router.html#property__ready">Router</a>: |
|
17746 |
|
17747 |
|
17748 |
|
17749 <a href="../files/app_js_router.js.html#l100"><code>app/js/router.js:100</code></a> |
|
17750 |
|
17751 </p> |
|
17752 |
|
17753 |
|
17754 |
|
17755 |
|
17756 </div> |
|
17757 |
|
17758 <div class="description"> |
|
17759 <p>Whether or not the <code>ready</code> event has fired yet.</p> |
|
17760 </div> |
|
17761 |
|
17762 |
|
17763 <p><strong>Default:</strong> undefined</p> |
|
17764 |
|
17765 |
|
17766 |
|
17767 |
|
17768 |
|
17769 </div> |
|
17770 |
|
17771 |
|
17772 <div id="property__regexPathParam" class="property item protected inherited"> |
|
17773 <h3 class="name"><code>_regexPathParam</code></h3> |
|
17774 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
17775 |
|
17776 |
|
17777 |
|
17778 |
|
17779 <span class="flag protected">protected</span> |
|
17780 |
|
17781 |
|
17782 |
|
17783 |
|
17784 |
|
17785 |
|
17786 <div class="meta"> |
|
17787 |
|
17788 |
|
17789 <p>Inherited from |
|
17790 <a href="../classes/Router.html#property__regexPathParam">Router</a>: |
|
17791 |
|
17792 |
|
17793 |
|
17794 <a href="../files/app_js_router.js.html#l109"><code>app/js/router.js:109</code></a> |
|
17795 |
|
17796 </p> |
|
17797 |
|
17798 |
|
17799 |
|
17800 |
|
17801 </div> |
|
17802 |
|
17803 <div class="description"> |
|
17804 <p>Regex used to match parameter placeholders in route paths.</p> |
|
17805 |
|
17806 <p>Subpattern captures:</p> |
|
17807 |
|
17808 <ol> |
|
17809 <li><p>Parameter prefix character. Either a <code>:</code> for subpath parameters that |
|
17810 should only match a single level of a path, or <code>*</code> for splat parameters |
|
17811 that should match any number of path levels.</p></li> |
|
17812 <li><p>Parameter name, if specified, otherwise it is a wildcard match.</p></li> |
|
17813 </ol> |
|
17814 </div> |
|
17815 |
|
17816 |
|
17817 |
|
17818 |
|
17819 |
|
17820 |
|
17821 </div> |
|
17822 |
|
17823 |
|
17824 <div id="property__regexURL" class="property item protected inherited"> |
|
17825 <h3 class="name"><code>_regexURL</code></h3> |
|
17826 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
17827 |
|
17828 |
|
17829 |
|
17830 |
|
17831 <span class="flag protected">protected</span> |
|
17832 |
|
17833 |
|
17834 |
|
17835 |
|
17836 |
|
17837 |
|
17838 <div class="meta"> |
|
17839 |
|
17840 |
|
17841 <p>Inherited from |
|
17842 <a href="../classes/PjaxBase.html#property__regexURL">PjaxBase</a>: |
|
17843 |
|
17844 |
|
17845 |
|
17846 <a href="../files/pjax_js_pjax-base.js.html#l78"><code>pjax/js/pjax-base.js:78</code></a> |
|
17847 |
|
17848 </p> |
|
17849 |
|
17850 |
|
17851 |
|
17852 |
|
17853 <p>Available since 3.5.0</p> |
|
17854 |
|
17855 </div> |
|
17856 |
|
17857 <div class="description"> |
|
17858 <p>Regex used to break up a URL string around the URL's path.</p> |
|
17859 |
|
17860 <p>Subpattern captures:</p> |
|
17861 |
|
17862 <ol> |
|
17863 <li>Origin, everything before the URL's path-part.</li> |
|
17864 <li>The URL's path-part.</li> |
|
17865 <li>Suffix, everything after the URL's path-part.</li> |
|
17866 </ol> |
|
17867 </div> |
|
17868 |
|
17869 |
|
17870 |
|
17871 |
|
17872 |
|
17873 |
|
17874 </div> |
|
17875 |
|
17876 |
|
17877 <div id="property__regexUrlOrigin" class="property item protected inherited"> |
|
17878 <h3 class="name"><code>_regexUrlOrigin</code></h3> |
|
17879 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
17880 |
|
17881 |
|
17882 |
|
17883 |
|
17884 <span class="flag protected">protected</span> |
|
17885 |
|
17886 |
|
17887 |
|
17888 |
|
17889 |
|
17890 |
|
17891 <div class="meta"> |
|
17892 |
|
17893 |
|
17894 <p>Inherited from |
|
17895 <a href="../classes/Router.html#property__regexUrlOrigin">Router</a>: |
|
17896 |
|
17897 |
|
17898 |
|
17899 <a href="../files/app_js_router.js.html#l136"><code>app/js/router.js:136</code></a> |
|
17900 |
|
17901 </p> |
|
17902 |
|
17903 |
|
17904 |
|
17905 |
|
17906 </div> |
|
17907 |
|
17908 <div class="description"> |
|
17909 <p>Regex that matches everything before the path portion of a URL (the origin). |
|
17910 This will be used to strip this part of the URL from a string when we |
|
17911 only want the path.</p> |
|
17912 </div> |
|
17913 |
|
17914 |
|
17915 |
|
17916 |
|
17917 |
|
17918 |
|
17919 </div> |
|
17920 |
|
17921 |
|
17922 <div id="property__regexUrlQuery" class="property item protected inherited"> |
|
17923 <h3 class="name"><code>_regexUrlQuery</code></h3> |
|
17924 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span> |
|
17925 |
|
17926 |
|
17927 |
|
17928 |
|
17929 <span class="flag protected">protected</span> |
|
17930 |
|
17931 |
|
17932 |
|
17933 |
|
17934 |
|
17935 |
|
17936 <div class="meta"> |
|
17937 |
|
17938 |
|
17939 <p>Inherited from |
|
17940 <a href="../classes/Router.html#property__regexUrlQuery">Router</a>: |
|
17941 |
|
17942 |
|
17943 |
|
17944 <a href="../files/app_js_router.js.html#l126"><code>app/js/router.js:126</code></a> |
|
17945 |
|
17946 </p> |
|
17947 |
|
17948 |
|
17949 |
|
17950 |
|
17951 </div> |
|
17952 |
|
17953 <div class="description"> |
|
17954 <p>Regex that matches and captures the query portion of a URL, minus the |
|
17955 preceding <code>?</code> character, and discarding the hash portion of the URL if any.</p> |
|
17956 </div> |
|
17957 |
|
17958 |
|
17959 |
|
17960 |
|
17961 |
|
17962 |
|
17963 </div> |
|
17964 |
|
17965 |
|
17966 <div id="property__viewInfoMap" class="property item protected"> |
|
17967 <h3 class="name"><code>_viewInfoMap</code></h3> |
|
17968 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
17969 |
|
17970 |
|
17971 |
|
17972 |
|
17973 <span class="flag protected">protected</span> |
|
17974 |
|
17975 |
|
17976 |
|
17977 |
|
17978 |
|
17979 |
|
17980 <div class="meta"> |
|
17981 |
|
17982 |
|
17983 |
|
17984 <p> |
|
17985 |
|
17986 Defined in |
|
17987 |
|
17988 |
|
17989 |
|
17990 |
|
17991 <a href="../files/app_js_app-base.js.html#l134"><code>app/js/app-base.js:134</code></a> |
|
17992 |
|
17993 </p> |
|
17994 |
|
17995 |
|
17996 |
|
17997 |
|
17998 <p>Available since 3.5.0</p> |
|
17999 |
|
18000 </div> |
|
18001 |
|
18002 <div class="description"> |
|
18003 <p>Map of view instance id (via <code>Y.stamp()</code>) to view-info object in <code>views</code>.</p> |
|
18004 |
|
18005 <p>This mapping is used to tie a specific view instance back to its metadata by |
|
18006 adding a reference to the the related view info on the <code>views</code> object.</p> |
|
18007 </div> |
|
18008 |
|
18009 |
|
18010 <p><strong>Default:</strong> {}</p> |
|
18011 |
|
18012 |
|
18013 |
|
18014 |
|
18015 |
|
18016 </div> |
|
18017 |
|
18018 |
|
18019 <div id="property_containerTemplate" class="property item inherited"> |
|
18020 <h3 class="name"><code>containerTemplate</code></h3> |
|
18021 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18022 |
|
18023 |
|
18024 |
|
18025 |
|
18026 |
|
18027 |
|
18028 |
|
18029 |
|
18030 |
|
18031 <div class="meta"> |
|
18032 |
|
18033 |
|
18034 <p>Inherited from |
|
18035 <a href="../classes/View.html#property_containerTemplate">View</a>: |
|
18036 |
|
18037 |
|
18038 |
|
18039 <a href="../files/app_js_view.js.html#l40"><code>app/js/view.js:40</code></a> |
|
18040 |
|
18041 </p> |
|
18042 |
|
18043 |
|
18044 |
|
18045 |
|
18046 <p>Available since 3.5.0</p> |
|
18047 |
|
18048 </div> |
|
18049 |
|
18050 <div class="description"> |
|
18051 <p>Template for this view's container.</p> |
|
18052 </div> |
|
18053 |
|
18054 |
|
18055 <p><strong>Default:</strong> "<div/>"</p> |
|
18056 |
|
18057 |
|
18058 |
|
18059 |
|
18060 |
|
18061 </div> |
|
18062 |
|
18063 |
|
18064 <div id="property_events" class="property item inherited"> |
|
18065 <h3 class="name"><code>events</code></h3> |
|
18066 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
18067 |
|
18068 |
|
18069 |
|
18070 |
|
18071 |
|
18072 |
|
18073 |
|
18074 |
|
18075 |
|
18076 <div class="meta"> |
|
18077 |
|
18078 |
|
18079 <p>Inherited from |
|
18080 <a href="../classes/View.html#property_events">View</a>: |
|
18081 |
|
18082 |
|
18083 |
|
18084 <a href="../files/app_js_view.js.html#l50"><code>app/js/view.js:50</code></a> |
|
18085 |
|
18086 </p> |
|
18087 |
|
18088 |
|
18089 |
|
18090 |
|
18091 </div> |
|
18092 |
|
18093 <div class="description"> |
|
18094 <p>Hash of CSS selectors mapped to events to delegate to elements matching |
|
18095 those selectors.</p> |
|
18096 |
|
18097 <p>CSS selectors are relative to the <code>container</code> element. Events are attached |
|
18098 to the container, and delegation is used so that subscribers are only |
|
18099 notified of events that occur on elements inside the container that match |
|
18100 the specified selectors. This allows the container's contents to be re- |
|
18101 rendered as needed without losing event subscriptions.</p> |
|
18102 |
|
18103 <p>Event handlers can be specified either as functions or as strings that map |
|
18104 to function names on this view instance or its prototype.</p> |
|
18105 |
|
18106 <p>The <code>this</code> object in event handlers will refer to this view instance. If |
|
18107 you'd prefer <code>this</code> to be something else, use <code>Y.bind()</code> to bind a custom |
|
18108 <code>this</code> object.</p> |
|
18109 </div> |
|
18110 |
|
18111 |
|
18112 <p><strong>Default:</strong> {}</p> |
|
18113 |
|
18114 |
|
18115 |
|
18116 <div class="example"> |
|
18117 <h4>Example:</h4> |
|
18118 |
|
18119 <div class="example-content"> |
|
18120 <pre class="code prettyprint"><code>var view = new Y.View({ |
|
18121 events: { |
|
18122 // Call <code>this.toggle()</code> whenever the element with the id |
|
18123 // "toggle-button" is clicked. |
|
18124 '#toggle-button': {click: 'toggle'}, |
|
18125 |
|
18126 // Call <code>this.hoverOn()</code> when the mouse moves over any element |
|
18127 // with the "hoverable" class, and <code>this.hoverOff()</code> when the |
|
18128 // mouse moves out of any element with the "hoverable" class. |
|
18129 '.hoverable': { |
|
18130 mouseover: 'hoverOn', |
|
18131 mouseout : 'hoverOff' |
|
18132 } |
|
18133 } |
|
18134 }); |
|
18135 </code></pre> |
|
18136 </div> |
|
18137 </div> |
|
18138 |
|
18139 |
|
18140 |
|
18141 </div> |
|
18142 |
|
18143 |
|
18144 <div id="property_name" class="property item deprecated inherited"> |
|
18145 <h3 class="name"><code>name</code></h3> |
|
18146 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18147 |
|
18148 |
|
18149 <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span> |
|
18150 |
|
18151 |
|
18152 |
|
18153 |
|
18154 |
|
18155 |
|
18156 |
|
18157 |
|
18158 <div class="meta"> |
|
18159 |
|
18160 |
|
18161 <p>Inherited from |
|
18162 <a href="../classes/BaseCore.html#property_name">BaseCore</a>: |
|
18163 |
|
18164 |
|
18165 |
|
18166 <a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a> |
|
18167 |
|
18168 </p> |
|
18169 |
|
18170 |
|
18171 <p>Deprecated: Use this.constructor.NAME</p> |
|
18172 |
|
18173 |
|
18174 |
|
18175 </div> |
|
18176 |
|
18177 <div class="description"> |
|
18178 <p>The string used to identify the class of this object.</p> |
|
18179 </div> |
|
18180 |
|
18181 |
|
18182 |
|
18183 |
|
18184 |
|
18185 |
|
18186 </div> |
|
18187 |
|
18188 |
|
18189 <div id="property_template" class="property item inherited"> |
|
18190 <h3 class="name"><code>template</code></h3> |
|
18191 <span class="type">Mixed</span> |
|
18192 |
|
18193 |
|
18194 |
|
18195 |
|
18196 |
|
18197 |
|
18198 |
|
18199 |
|
18200 |
|
18201 <div class="meta"> |
|
18202 |
|
18203 |
|
18204 <p>Inherited from |
|
18205 <a href="../classes/View.html#property_template">View</a>: |
|
18206 |
|
18207 |
|
18208 |
|
18209 <a href="../files/app_js_view.js.html#l91"><code>app/js/view.js:91</code></a> |
|
18210 |
|
18211 </p> |
|
18212 |
|
18213 |
|
18214 |
|
18215 |
|
18216 </div> |
|
18217 |
|
18218 <div class="description"> |
|
18219 <p>Template for this view's contents.</p> |
|
18220 |
|
18221 <p>This is a convenience property that has no default behavior of its own. |
|
18222 It's only provided as a convention to allow you to store whatever you |
|
18223 consider to be a template, whether that's an HTML string, a <code>Y.Node</code> |
|
18224 instance, a Mustache template, or anything else your little heart |
|
18225 desires.</p> |
|
18226 |
|
18227 <p>How this template gets used is entirely up to you and your custom |
|
18228 <code>render()</code> method.</p> |
|
18229 </div> |
|
18230 |
|
18231 |
|
18232 <p><strong>Default:</strong> ''</p> |
|
18233 |
|
18234 |
|
18235 |
|
18236 |
|
18237 |
|
18238 </div> |
|
18239 |
|
18240 |
|
18241 <div id="property_views" class="property item"> |
|
18242 <h3 class="name"><code>views</code></h3> |
|
18243 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
18244 |
|
18245 |
|
18246 |
|
18247 |
|
18248 |
|
18249 |
|
18250 |
|
18251 |
|
18252 |
|
18253 <div class="meta"> |
|
18254 |
|
18255 |
|
18256 |
|
18257 <p> |
|
18258 |
|
18259 Defined in |
|
18260 |
|
18261 |
|
18262 |
|
18263 |
|
18264 <a href="../files/app_js_app-base.js.html#l76"><code>app/js/app-base.js:76</code></a> |
|
18265 |
|
18266 </p> |
|
18267 |
|
18268 |
|
18269 |
|
18270 |
|
18271 <p>Available since 3.5.0</p> |
|
18272 |
|
18273 </div> |
|
18274 |
|
18275 <div class="description"> |
|
18276 <p>Hash of view-name to metadata used to declaratively describe an |
|
18277 application's views and their relationship with the app and its other views.</p> |
|
18278 |
|
18279 <p>The view metadata is composed of Objects keyed to a view-name that can have |
|
18280 any or all of the following properties:</p> |
|
18281 |
|
18282 <ul> |
|
18283 <li><p><code>type</code>: Function or a string representing the view constructor to use to |
|
18284 create view instances. If a string is used, the constructor function is |
|
18285 assumed to be on the <code>Y</code> object; e.g. <code>"SomeView"</code> -> <code>Y.SomeView</code>.</p></li> |
|
18286 <li><p><code>preserve</code>: Boolean for whether the view instance should be retained. By |
|
18287 default, the view instance will be destroyed when it is no longer the |
|
18288 <code>activeView</code>. If <code>true</code> the view instance will simply be <code>removed()</code> |
|
18289 from the DOM when it is no longer active. This is useful when the view |
|
18290 is frequently used and may be expensive to re-create.</p></li> |
|
18291 <li><p><code>parent</code>: String to another named view in this hash that represents the |
|
18292 parent view within the application's view hierarchy; e.g. a <code>"photo"</code> |
|
18293 view could have <code>"album"</code> has its <code>parent</code> view. This parent/child |
|
18294 relationship is a useful cue for things like transitions.</p></li> |
|
18295 <li><p><code>instance</code>: Used internally to manage the current instance of this named |
|
18296 view. This can be used if your view instance is created up-front, or if |
|
18297 you would rather manage the View lifecycle, but you probably should just |
|
18298 let this be handled for you.</p></li> |
|
18299 </ul> |
|
18300 |
|
18301 <p>If <code>views</code> are specified at instantiation time, the metadata in the <code>views</code> |
|
18302 Object here will be used as defaults when creating the instance's <code>views</code>.</p> |
|
18303 |
|
18304 <p>Every <code>Y.App</code> instance gets its own copy of a <code>views</code> object so this Object |
|
18305 on the prototype will not be polluted.</p> |
|
18306 </div> |
|
18307 |
|
18308 |
|
18309 <p><strong>Default:</strong> {}</p> |
|
18310 |
|
18311 |
|
18312 |
|
18313 <div class="example"> |
|
18314 <h4>Example:</h4> |
|
18315 |
|
18316 <div class="example-content"> |
|
18317 <pre class="code prettyprint"><code>// Imagine that <code>Y.UsersView</code> and <code>Y.UserView</code> have been defined. |
|
18318 var app = new Y.App({ |
|
18319 views: { |
|
18320 users: { |
|
18321 type : Y.UsersView, |
|
18322 preserve: true |
|
18323 }, |
|
18324 |
|
18325 user: { |
|
18326 type : Y.UserView, |
|
18327 parent: 'users' |
|
18328 } |
|
18329 } |
|
18330 }); |
|
18331 </code></pre> |
|
18332 </div> |
|
18333 </div> |
|
18334 |
|
18335 |
|
18336 |
|
18337 </div> |
|
18338 |
|
18339 |
|
18340 </div> |
|
18341 |
|
18342 |
|
18343 |
|
18344 <div id="attrs" class="api-class-tabpanel"> |
|
18345 <h2 class="off-left">Attributes</h2> |
|
18346 |
|
18347 |
|
18348 <div id="attr_activeView" class="attr item"> |
|
18349 <a name="config_activeView"></a> |
|
18350 <h3 class="name"><code>activeView</code></h3> |
|
18351 <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span> |
|
18352 |
|
18353 |
|
18354 |
|
18355 |
|
18356 |
|
18357 |
|
18358 |
|
18359 |
|
18360 |
|
18361 |
|
18362 |
|
18363 |
|
18364 |
|
18365 |
|
18366 <span class="flag readonly">readonly</span> |
|
18367 |
|
18368 |
|
18369 <div class="meta"> |
|
18370 |
|
18371 |
|
18372 |
|
18373 <p> |
|
18374 |
|
18375 Defined in |
|
18376 |
|
18377 |
|
18378 |
|
18379 |
|
18380 <a href="../files/app_js_app-base.js.html#l819"><code>app/js/app-base.js:819</code></a> |
|
18381 |
|
18382 </p> |
|
18383 |
|
18384 |
|
18385 |
|
18386 |
|
18387 <p>Available since 3.5.0</p> |
|
18388 |
|
18389 </div> |
|
18390 |
|
18391 <div class="description"> |
|
18392 <p>The application's active/visible view.</p> |
|
18393 |
|
18394 <p>This attribute is read-only, to set the <code>activeView</code> use the |
|
18395 <code>showView()</code> method.</p> |
|
18396 </div> |
|
18397 |
|
18398 |
|
18399 <p><strong>Default:</strong> null</p> |
|
18400 |
|
18401 |
|
18402 |
|
18403 <div class="emits box"> |
|
18404 <h4>Fires event <code>activeViewChange</code></h4> |
|
18405 |
|
18406 <p> |
|
18407 Fires when the value for the configuration attribute <code>activeView</code> is |
|
18408 changed. You can listen for the event using the <code>on</code> method if you |
|
18409 wish to be notified before the attribute's value has changed, or |
|
18410 using the <code>after</code> method if you wish to be notified after the |
|
18411 attribute's value has changed. |
|
18412 </p> |
|
18413 |
|
18414 <div class="params"> |
|
18415 <h4>Parameters:</h4> |
|
18416 |
|
18417 <ul class="params-list"> |
|
18418 <li class="param"> |
|
18419 <code class="param-name">e</code> |
|
18420 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18421 |
|
18422 <div class="param-description"> |
|
18423 An Event Facade object with the following |
|
18424 attribute-specific properties added: |
|
18425 </div> |
|
18426 |
|
18427 <ul class="params-list"> |
|
18428 <li class="param"> |
|
18429 <code class="param-name">prevVal</code> |
|
18430 <span class="type">Any</span> |
|
18431 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18432 </li> |
|
18433 <li class="param"> |
|
18434 <code class="param-name">newVal</code> |
|
18435 <span class="type">Any</span> |
|
18436 <div class="param-description">The value the attribute is to be set to.</div> |
|
18437 </li> |
|
18438 <li class="param"> |
|
18439 <code class="param-name">attrName</code> |
|
18440 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18441 <div class="param-description">The name of the attribute being set.</div> |
|
18442 </li> |
|
18443 <li class="param"> |
|
18444 <code class="param-name">subAttrName</code> |
|
18445 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18446 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
18447 </li> |
|
18448 </ul> |
|
18449 </li> |
|
18450 </ul> |
|
18451 </div> |
|
18452 </div> |
|
18453 |
|
18454 |
|
18455 |
|
18456 </div> |
|
18457 |
|
18458 |
|
18459 <div id="attr_container" class="attr item"> |
|
18460 <a name="config_container"></a> |
|
18461 <h3 class="name"><code>container</code></h3> |
|
18462 <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18463 |
|
18464 |
|
18465 |
|
18466 |
|
18467 |
|
18468 |
|
18469 |
|
18470 |
|
18471 |
|
18472 |
|
18473 |
|
18474 |
|
18475 |
|
18476 |
|
18477 |
|
18478 <div class="meta"> |
|
18479 |
|
18480 <p>Inherited from |
|
18481 <a href="../classes/View.html#attr_container"> |
|
18482 View |
|
18483 </a> |
|
18484 |
|
18485 but overwritten in |
|
18486 |
|
18487 |
|
18488 |
|
18489 <a href="../files/app_js_app-base.js.html#l837"><code>app/js/app-base.js:837</code></a> |
|
18490 |
|
18491 </p> |
|
18492 |
|
18493 |
|
18494 |
|
18495 |
|
18496 </div> |
|
18497 |
|
18498 <div class="description"> |
|
18499 <p>Container node which represents the application's bounding-box, into |
|
18500 which this app's content will be rendered.</p> |
|
18501 |
|
18502 <p>The container node serves as the host for all DOM events attached by the |
|
18503 app. Delegation is used to handle events on children of the container, |
|
18504 allowing the container's contents to be re-rendered at any time without |
|
18505 losing event subscriptions.</p> |
|
18506 |
|
18507 <p>The default container is the <code><body></code> Node, but you can override this in |
|
18508 a subclass, or by passing in a custom <code>container</code> config value at |
|
18509 instantiation time.</p> |
|
18510 |
|
18511 <p>When <code>container</code> is overridden by a subclass or passed as a config |
|
18512 option at instantiation time, it may be provided as a selector string, a |
|
18513 DOM element, or a <code>Y.Node</code> instance. During initialization, this app's |
|
18514 <code>create()</code> method will be called to convert the container into a |
|
18515 <code>Y.Node</code> instance if it isn't one already and stamp it with the CSS |
|
18516 class: <code>"yui3-app"</code>.</p> |
|
18517 |
|
18518 <p>The container is not added to the page automatically. This allows you to |
|
18519 have full control over how and when your app is actually rendered to |
|
18520 the page.</p> |
|
18521 </div> |
|
18522 |
|
18523 |
|
18524 <p><strong>Default:</strong> Y.one('body')</p> |
|
18525 |
|
18526 |
|
18527 |
|
18528 <div class="emits box"> |
|
18529 <h4>Fires event <code>containerChange</code></h4> |
|
18530 |
|
18531 <p> |
|
18532 Fires when the value for the configuration attribute <code>container</code> is |
|
18533 changed. You can listen for the event using the <code>on</code> method if you |
|
18534 wish to be notified before the attribute's value has changed, or |
|
18535 using the <code>after</code> method if you wish to be notified after the |
|
18536 attribute's value has changed. |
|
18537 </p> |
|
18538 |
|
18539 <div class="params"> |
|
18540 <h4>Parameters:</h4> |
|
18541 |
|
18542 <ul class="params-list"> |
|
18543 <li class="param"> |
|
18544 <code class="param-name">e</code> |
|
18545 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18546 |
|
18547 <div class="param-description"> |
|
18548 An Event Facade object with the following |
|
18549 attribute-specific properties added: |
|
18550 </div> |
|
18551 |
|
18552 <ul class="params-list"> |
|
18553 <li class="param"> |
|
18554 <code class="param-name">prevVal</code> |
|
18555 <span class="type">Any</span> |
|
18556 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18557 </li> |
|
18558 <li class="param"> |
|
18559 <code class="param-name">newVal</code> |
|
18560 <span class="type">Any</span> |
|
18561 <div class="param-description">The value the attribute is to be set to.</div> |
|
18562 </li> |
|
18563 <li class="param"> |
|
18564 <code class="param-name">attrName</code> |
|
18565 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18566 <div class="param-description">The name of the attribute being set.</div> |
|
18567 </li> |
|
18568 <li class="param"> |
|
18569 <code class="param-name">subAttrName</code> |
|
18570 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18571 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
18572 </li> |
|
18573 </ul> |
|
18574 </li> |
|
18575 </ul> |
|
18576 </div> |
|
18577 </div> |
|
18578 |
|
18579 |
|
18580 |
|
18581 </div> |
|
18582 |
|
18583 |
|
18584 <div id="attr_destroyed" class="attr item inherited"> |
|
18585 <a name="config_destroyed"></a> |
|
18586 <h3 class="name"><code>destroyed</code></h3> |
|
18587 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18588 |
|
18589 |
|
18590 |
|
18591 |
|
18592 |
|
18593 |
|
18594 |
|
18595 |
|
18596 |
|
18597 |
|
18598 |
|
18599 |
|
18600 |
|
18601 |
|
18602 <span class="flag readonly">readonly</span> |
|
18603 |
|
18604 |
|
18605 <div class="meta"> |
|
18606 |
|
18607 |
|
18608 <p>Inherited from |
|
18609 <a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>: |
|
18610 |
|
18611 |
|
18612 |
|
18613 <a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a> |
|
18614 |
|
18615 </p> |
|
18616 |
|
18617 |
|
18618 |
|
18619 |
|
18620 </div> |
|
18621 |
|
18622 <div class="description"> |
|
18623 <p>Flag indicating whether or not this object |
|
18624 has been through the destroy lifecycle phase.</p> |
|
18625 </div> |
|
18626 |
|
18627 |
|
18628 <p><strong>Default:</strong> false</p> |
|
18629 |
|
18630 |
|
18631 |
|
18632 <div class="emits box"> |
|
18633 <h4>Fires event <code>destroyedChange</code></h4> |
|
18634 |
|
18635 <p> |
|
18636 Fires when the value for the configuration attribute <code>destroyed</code> is |
|
18637 changed. You can listen for the event using the <code>on</code> method if you |
|
18638 wish to be notified before the attribute's value has changed, or |
|
18639 using the <code>after</code> method if you wish to be notified after the |
|
18640 attribute's value has changed. |
|
18641 </p> |
|
18642 |
|
18643 <div class="params"> |
|
18644 <h4>Parameters:</h4> |
|
18645 |
|
18646 <ul class="params-list"> |
|
18647 <li class="param"> |
|
18648 <code class="param-name">e</code> |
|
18649 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18650 |
|
18651 <div class="param-description"> |
|
18652 An Event Facade object with the following |
|
18653 attribute-specific properties added: |
|
18654 </div> |
|
18655 |
|
18656 <ul class="params-list"> |
|
18657 <li class="param"> |
|
18658 <code class="param-name">prevVal</code> |
|
18659 <span class="type">Any</span> |
|
18660 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18661 </li> |
|
18662 <li class="param"> |
|
18663 <code class="param-name">newVal</code> |
|
18664 <span class="type">Any</span> |
|
18665 <div class="param-description">The value the attribute is to be set to.</div> |
|
18666 </li> |
|
18667 <li class="param"> |
|
18668 <code class="param-name">attrName</code> |
|
18669 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18670 <div class="param-description">The name of the attribute being set.</div> |
|
18671 </li> |
|
18672 <li class="param"> |
|
18673 <code class="param-name">subAttrName</code> |
|
18674 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18675 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
18676 </li> |
|
18677 </ul> |
|
18678 </li> |
|
18679 </ul> |
|
18680 </div> |
|
18681 </div> |
|
18682 |
|
18683 |
|
18684 |
|
18685 </div> |
|
18686 |
|
18687 |
|
18688 <div id="attr_html5" class="attr item"> |
|
18689 <a name="config_html5"></a> |
|
18690 <h3 class="name"><code>html5</code></h3> |
|
18691 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18692 |
|
18693 |
|
18694 |
|
18695 |
|
18696 |
|
18697 |
|
18698 |
|
18699 |
|
18700 |
|
18701 |
|
18702 |
|
18703 |
|
18704 |
|
18705 |
|
18706 |
|
18707 <div class="meta"> |
|
18708 |
|
18709 <p>Inherited from |
|
18710 <a href="../classes/Router.html#attr_html5"> |
|
18711 Router |
|
18712 </a> |
|
18713 |
|
18714 but overwritten in |
|
18715 |
|
18716 |
|
18717 |
|
18718 <a href="../files/app_js_app-base.js.html#l872"><code>app/js/app-base.js:872</code></a> |
|
18719 |
|
18720 </p> |
|
18721 |
|
18722 |
|
18723 |
|
18724 |
|
18725 </div> |
|
18726 |
|
18727 <div class="description"> |
|
18728 <p>Whether or not this browser is capable of using HTML5 history.</p> |
|
18729 |
|
18730 <p>This value is dependent on the value of <code>serverRouting</code> and will default |
|
18731 accordingly.</p> |
|
18732 |
|
18733 <p>Setting this to <code>false</code> will force the use of hash-based history even on |
|
18734 HTML5 browsers, but please don't do this unless you understand the |
|
18735 consequences.</p> |
|
18736 </div> |
|
18737 |
|
18738 |
|
18739 |
|
18740 |
|
18741 <div class="emits box"> |
|
18742 <h4>Fires event <code>html5Change</code></h4> |
|
18743 |
|
18744 <p> |
|
18745 Fires when the value for the configuration attribute <code>html5</code> is |
|
18746 changed. You can listen for the event using the <code>on</code> method if you |
|
18747 wish to be notified before the attribute's value has changed, or |
|
18748 using the <code>after</code> method if you wish to be notified after the |
|
18749 attribute's value has changed. |
|
18750 </p> |
|
18751 |
|
18752 <div class="params"> |
|
18753 <h4>Parameters:</h4> |
|
18754 |
|
18755 <ul class="params-list"> |
|
18756 <li class="param"> |
|
18757 <code class="param-name">e</code> |
|
18758 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18759 |
|
18760 <div class="param-description"> |
|
18761 An Event Facade object with the following |
|
18762 attribute-specific properties added: |
|
18763 </div> |
|
18764 |
|
18765 <ul class="params-list"> |
|
18766 <li class="param"> |
|
18767 <code class="param-name">prevVal</code> |
|
18768 <span class="type">Any</span> |
|
18769 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18770 </li> |
|
18771 <li class="param"> |
|
18772 <code class="param-name">newVal</code> |
|
18773 <span class="type">Any</span> |
|
18774 <div class="param-description">The value the attribute is to be set to.</div> |
|
18775 </li> |
|
18776 <li class="param"> |
|
18777 <code class="param-name">attrName</code> |
|
18778 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18779 <div class="param-description">The name of the attribute being set.</div> |
|
18780 </li> |
|
18781 <li class="param"> |
|
18782 <code class="param-name">subAttrName</code> |
|
18783 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18784 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
18785 </li> |
|
18786 </ul> |
|
18787 </li> |
|
18788 </ul> |
|
18789 </div> |
|
18790 </div> |
|
18791 |
|
18792 |
|
18793 |
|
18794 </div> |
|
18795 |
|
18796 |
|
18797 <div id="attr_initialized" class="attr item inherited"> |
|
18798 <a name="config_initialized"></a> |
|
18799 <h3 class="name"><code>initialized</code></h3> |
|
18800 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
18801 |
|
18802 |
|
18803 |
|
18804 |
|
18805 |
|
18806 |
|
18807 |
|
18808 |
|
18809 |
|
18810 |
|
18811 |
|
18812 |
|
18813 |
|
18814 |
|
18815 <span class="flag readonly">readonly</span> |
|
18816 |
|
18817 |
|
18818 <div class="meta"> |
|
18819 |
|
18820 |
|
18821 <p>Inherited from |
|
18822 <a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>: |
|
18823 |
|
18824 |
|
18825 |
|
18826 <a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a> |
|
18827 |
|
18828 </p> |
|
18829 |
|
18830 |
|
18831 |
|
18832 |
|
18833 </div> |
|
18834 |
|
18835 <div class="description"> |
|
18836 <p>Flag indicating whether or not this object |
|
18837 has been through the init lifecycle phase.</p> |
|
18838 </div> |
|
18839 |
|
18840 |
|
18841 <p><strong>Default:</strong> false</p> |
|
18842 |
|
18843 |
|
18844 |
|
18845 <div class="emits box"> |
|
18846 <h4>Fires event <code>initializedChange</code></h4> |
|
18847 |
|
18848 <p> |
|
18849 Fires when the value for the configuration attribute <code>initialized</code> is |
|
18850 changed. You can listen for the event using the <code>on</code> method if you |
|
18851 wish to be notified before the attribute's value has changed, or |
|
18852 using the <code>after</code> method if you wish to be notified after the |
|
18853 attribute's value has changed. |
|
18854 </p> |
|
18855 |
|
18856 <div class="params"> |
|
18857 <h4>Parameters:</h4> |
|
18858 |
|
18859 <ul class="params-list"> |
|
18860 <li class="param"> |
|
18861 <code class="param-name">e</code> |
|
18862 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18863 |
|
18864 <div class="param-description"> |
|
18865 An Event Facade object with the following |
|
18866 attribute-specific properties added: |
|
18867 </div> |
|
18868 |
|
18869 <ul class="params-list"> |
|
18870 <li class="param"> |
|
18871 <code class="param-name">prevVal</code> |
|
18872 <span class="type">Any</span> |
|
18873 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18874 </li> |
|
18875 <li class="param"> |
|
18876 <code class="param-name">newVal</code> |
|
18877 <span class="type">Any</span> |
|
18878 <div class="param-description">The value the attribute is to be set to.</div> |
|
18879 </li> |
|
18880 <li class="param"> |
|
18881 <code class="param-name">attrName</code> |
|
18882 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18883 <div class="param-description">The name of the attribute being set.</div> |
|
18884 </li> |
|
18885 <li class="param"> |
|
18886 <code class="param-name">subAttrName</code> |
|
18887 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18888 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
18889 </li> |
|
18890 </ul> |
|
18891 </li> |
|
18892 </ul> |
|
18893 </div> |
|
18894 </div> |
|
18895 |
|
18896 |
|
18897 |
|
18898 </div> |
|
18899 |
|
18900 |
|
18901 <div id="attr_linkSelector" class="attr item"> |
|
18902 <a name="config_linkSelector"></a> |
|
18903 <h3 class="name"><code>linkSelector</code></h3> |
|
18904 <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> |
|
18905 |
|
18906 |
|
18907 |
|
18908 |
|
18909 |
|
18910 |
|
18911 |
|
18912 |
|
18913 |
|
18914 |
|
18915 |
|
18916 |
|
18917 |
|
18918 |
|
18919 |
|
18920 <div class="meta"> |
|
18921 |
|
18922 <p>Inherited from |
|
18923 <a href="../classes/PjaxBase.html#attr_linkSelector"> |
|
18924 PjaxBase |
|
18925 </a> |
|
18926 |
|
18927 but overwritten in |
|
18928 |
|
18929 |
|
18930 |
|
18931 <a href="../files/app_js_app-base.js.html#l891"><code>app/js/app-base.js:891</code></a> |
|
18932 |
|
18933 </p> |
|
18934 |
|
18935 |
|
18936 |
|
18937 |
|
18938 </div> |
|
18939 |
|
18940 <div class="description"> |
|
18941 <p>CSS selector string used to filter link click events so that only the |
|
18942 links which match it will have the enhanced-navigation behavior of pjax |
|
18943 applied.</p> |
|
18944 |
|
18945 <p>When a link is clicked and that link matches this selector, navigating |
|
18946 to the link's <code>href</code> URL using the enhanced, pjax, behavior will be |
|
18947 attempted; and the browser's default way to navigate to new pages will |
|
18948 be the fallback.</p> |
|
18949 |
|
18950 <p>By default this selector will match <em>all</em> links on the page.</p> |
|
18951 </div> |
|
18952 |
|
18953 |
|
18954 <p><strong>Default:</strong> "a"</p> |
|
18955 |
|
18956 |
|
18957 |
|
18958 <div class="emits box"> |
|
18959 <h4>Fires event <code>linkSelectorChange</code></h4> |
|
18960 |
|
18961 <p> |
|
18962 Fires when the value for the configuration attribute <code>linkSelector</code> is |
|
18963 changed. You can listen for the event using the <code>on</code> method if you |
|
18964 wish to be notified before the attribute's value has changed, or |
|
18965 using the <code>after</code> method if you wish to be notified after the |
|
18966 attribute's value has changed. |
|
18967 </p> |
|
18968 |
|
18969 <div class="params"> |
|
18970 <h4>Parameters:</h4> |
|
18971 |
|
18972 <ul class="params-list"> |
|
18973 <li class="param"> |
|
18974 <code class="param-name">e</code> |
|
18975 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
18976 |
|
18977 <div class="param-description"> |
|
18978 An Event Facade object with the following |
|
18979 attribute-specific properties added: |
|
18980 </div> |
|
18981 |
|
18982 <ul class="params-list"> |
|
18983 <li class="param"> |
|
18984 <code class="param-name">prevVal</code> |
|
18985 <span class="type">Any</span> |
|
18986 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
18987 </li> |
|
18988 <li class="param"> |
|
18989 <code class="param-name">newVal</code> |
|
18990 <span class="type">Any</span> |
|
18991 <div class="param-description">The value the attribute is to be set to.</div> |
|
18992 </li> |
|
18993 <li class="param"> |
|
18994 <code class="param-name">attrName</code> |
|
18995 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
18996 <div class="param-description">The name of the attribute being set.</div> |
|
18997 </li> |
|
18998 <li class="param"> |
|
18999 <code class="param-name">subAttrName</code> |
|
19000 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19001 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19002 </li> |
|
19003 </ul> |
|
19004 </li> |
|
19005 </ul> |
|
19006 </div> |
|
19007 </div> |
|
19008 |
|
19009 |
|
19010 |
|
19011 </div> |
|
19012 |
|
19013 |
|
19014 <div id="attr_navigateOnHash" class="attr item inherited"> |
|
19015 <a name="config_navigateOnHash"></a> |
|
19016 <h3 class="name"><code>navigateOnHash</code></h3> |
|
19017 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19018 |
|
19019 |
|
19020 |
|
19021 |
|
19022 |
|
19023 |
|
19024 |
|
19025 |
|
19026 |
|
19027 |
|
19028 |
|
19029 |
|
19030 |
|
19031 |
|
19032 |
|
19033 <div class="meta"> |
|
19034 |
|
19035 |
|
19036 <p>Inherited from |
|
19037 <a href="../classes/PjaxBase.html#attr_navigateOnHash">PjaxBase</a>: |
|
19038 |
|
19039 |
|
19040 |
|
19041 <a href="../files/pjax_js_pjax-base.js.html#l401"><code>pjax/js/pjax-base.js:401</code></a> |
|
19042 |
|
19043 </p> |
|
19044 |
|
19045 |
|
19046 |
|
19047 |
|
19048 <p>Available since 3.5.0</p> |
|
19049 |
|
19050 </div> |
|
19051 |
|
19052 <div class="description"> |
|
19053 <p>Whether navigating to a hash-fragment identifier on the current page should |
|
19054 be enhanced and cause the <code>navigate</code> event to fire.</p> |
|
19055 |
|
19056 <p>By default Pjax allows the browser to perform its default action when a user |
|
19057 is navigating within a page by clicking in-page links |
|
19058 (e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or |
|
19059 enhance in-page navigation.</p> |
|
19060 </div> |
|
19061 |
|
19062 |
|
19063 <p><strong>Default:</strong> false</p> |
|
19064 |
|
19065 |
|
19066 |
|
19067 <div class="emits box"> |
|
19068 <h4>Fires event <code>navigateOnHashChange</code></h4> |
|
19069 |
|
19070 <p> |
|
19071 Fires when the value for the configuration attribute <code>navigateOnHash</code> is |
|
19072 changed. You can listen for the event using the <code>on</code> method if you |
|
19073 wish to be notified before the attribute's value has changed, or |
|
19074 using the <code>after</code> method if you wish to be notified after the |
|
19075 attribute's value has changed. |
|
19076 </p> |
|
19077 |
|
19078 <div class="params"> |
|
19079 <h4>Parameters:</h4> |
|
19080 |
|
19081 <ul class="params-list"> |
|
19082 <li class="param"> |
|
19083 <code class="param-name">e</code> |
|
19084 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19085 |
|
19086 <div class="param-description"> |
|
19087 An Event Facade object with the following |
|
19088 attribute-specific properties added: |
|
19089 </div> |
|
19090 |
|
19091 <ul class="params-list"> |
|
19092 <li class="param"> |
|
19093 <code class="param-name">prevVal</code> |
|
19094 <span class="type">Any</span> |
|
19095 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19096 </li> |
|
19097 <li class="param"> |
|
19098 <code class="param-name">newVal</code> |
|
19099 <span class="type">Any</span> |
|
19100 <div class="param-description">The value the attribute is to be set to.</div> |
|
19101 </li> |
|
19102 <li class="param"> |
|
19103 <code class="param-name">attrName</code> |
|
19104 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19105 <div class="param-description">The name of the attribute being set.</div> |
|
19106 </li> |
|
19107 <li class="param"> |
|
19108 <code class="param-name">subAttrName</code> |
|
19109 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19110 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19111 </li> |
|
19112 </ul> |
|
19113 </li> |
|
19114 </ul> |
|
19115 </div> |
|
19116 </div> |
|
19117 |
|
19118 |
|
19119 |
|
19120 </div> |
|
19121 |
|
19122 |
|
19123 <div id="attr_root" class="attr item inherited"> |
|
19124 <a name="config_root"></a> |
|
19125 <h3 class="name"><code>root</code></h3> |
|
19126 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19127 |
|
19128 |
|
19129 |
|
19130 |
|
19131 |
|
19132 |
|
19133 |
|
19134 |
|
19135 |
|
19136 |
|
19137 |
|
19138 |
|
19139 |
|
19140 |
|
19141 |
|
19142 <div class="meta"> |
|
19143 |
|
19144 |
|
19145 <p>Inherited from |
|
19146 <a href="../classes/Router.html#attr_root">Router</a>: |
|
19147 |
|
19148 |
|
19149 |
|
19150 <a href="../files/app_js_router.js.html#l1336"><code>app/js/router.js:1336</code></a> |
|
19151 |
|
19152 </p> |
|
19153 |
|
19154 |
|
19155 |
|
19156 |
|
19157 </div> |
|
19158 |
|
19159 <div class="description"> |
|
19160 <p>Absolute root path from which all routes should be evaluated.</p> |
|
19161 |
|
19162 <p>For example, if your router is running on a page at |
|
19163 <code>http://example.com/myapp/</code> and you add a route with the path <code>/</code>, your |
|
19164 route will never execute, because the path will always be preceded by |
|
19165 <code>/myapp</code>. Setting <code>root</code> to <code>/myapp</code> would cause all routes to be |
|
19166 evaluated relative to that root URL, so the <code>/</code> route would then execute |
|
19167 when the user browses to <code>http://example.com/myapp/</code>.</p> |
|
19168 </div> |
|
19169 |
|
19170 |
|
19171 <p><strong>Default:</strong> `''`</p> |
|
19172 |
|
19173 |
|
19174 |
|
19175 <div class="emits box"> |
|
19176 <h4>Fires event <code>rootChange</code></h4> |
|
19177 |
|
19178 <p> |
|
19179 Fires when the value for the configuration attribute <code>root</code> is |
|
19180 changed. You can listen for the event using the <code>on</code> method if you |
|
19181 wish to be notified before the attribute's value has changed, or |
|
19182 using the <code>after</code> method if you wish to be notified after the |
|
19183 attribute's value has changed. |
|
19184 </p> |
|
19185 |
|
19186 <div class="params"> |
|
19187 <h4>Parameters:</h4> |
|
19188 |
|
19189 <ul class="params-list"> |
|
19190 <li class="param"> |
|
19191 <code class="param-name">e</code> |
|
19192 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19193 |
|
19194 <div class="param-description"> |
|
19195 An Event Facade object with the following |
|
19196 attribute-specific properties added: |
|
19197 </div> |
|
19198 |
|
19199 <ul class="params-list"> |
|
19200 <li class="param"> |
|
19201 <code class="param-name">prevVal</code> |
|
19202 <span class="type">Any</span> |
|
19203 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19204 </li> |
|
19205 <li class="param"> |
|
19206 <code class="param-name">newVal</code> |
|
19207 <span class="type">Any</span> |
|
19208 <div class="param-description">The value the attribute is to be set to.</div> |
|
19209 </li> |
|
19210 <li class="param"> |
|
19211 <code class="param-name">attrName</code> |
|
19212 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19213 <div class="param-description">The name of the attribute being set.</div> |
|
19214 </li> |
|
19215 <li class="param"> |
|
19216 <code class="param-name">subAttrName</code> |
|
19217 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19218 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19219 </li> |
|
19220 </ul> |
|
19221 </li> |
|
19222 </ul> |
|
19223 </div> |
|
19224 </div> |
|
19225 |
|
19226 |
|
19227 |
|
19228 </div> |
|
19229 |
|
19230 |
|
19231 <div id="attr_routes" class="attr item inherited"> |
|
19232 <a name="config_routes"></a> |
|
19233 <h3 class="name"><code>routes</code></h3> |
|
19234 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span> |
|
19235 |
|
19236 |
|
19237 |
|
19238 |
|
19239 |
|
19240 |
|
19241 |
|
19242 |
|
19243 |
|
19244 |
|
19245 |
|
19246 |
|
19247 |
|
19248 |
|
19249 |
|
19250 <div class="meta"> |
|
19251 |
|
19252 |
|
19253 <p>Inherited from |
|
19254 <a href="../classes/Router.html#attr_routes">Router</a>: |
|
19255 |
|
19256 |
|
19257 |
|
19258 <a href="../files/app_js_router.js.html#l1354"><code>app/js/router.js:1354</code></a> |
|
19259 |
|
19260 </p> |
|
19261 |
|
19262 |
|
19263 |
|
19264 |
|
19265 </div> |
|
19266 |
|
19267 <div class="description"> |
|
19268 <p>Array of route objects.</p> |
|
19269 |
|
19270 <p>Each item in the array must be an object with the following properties:</p> |
|
19271 |
|
19272 <ul> |
|
19273 <li><p><code>path</code>: String or regex representing the path to match. See the docs |
|
19274 for the <code>route()</code> method for more details.</p></li> |
|
19275 <li><p><code>callbacks</code>: Function or a string representing the name of a |
|
19276 function on this router instance that should be called when the |
|
19277 route is triggered. An array of functions and/or strings may also be |
|
19278 provided. See the docs for the <code>route()</code> method for more details.</p></li> |
|
19279 </ul> |
|
19280 |
|
19281 <p>This attribute is intended to be used to set routes at init time, or to |
|
19282 completely reset all routes after init. To add routes after init without |
|
19283 resetting all existing routes, use the <code>route()</code> method.</p> |
|
19284 </div> |
|
19285 |
|
19286 |
|
19287 <p><strong>Default:</strong> `[]`</p> |
|
19288 |
|
19289 |
|
19290 |
|
19291 <div class="emits box"> |
|
19292 <h4>Fires event <code>routesChange</code></h4> |
|
19293 |
|
19294 <p> |
|
19295 Fires when the value for the configuration attribute <code>routes</code> is |
|
19296 changed. You can listen for the event using the <code>on</code> method if you |
|
19297 wish to be notified before the attribute's value has changed, or |
|
19298 using the <code>after</code> method if you wish to be notified after the |
|
19299 attribute's value has changed. |
|
19300 </p> |
|
19301 |
|
19302 <div class="params"> |
|
19303 <h4>Parameters:</h4> |
|
19304 |
|
19305 <ul class="params-list"> |
|
19306 <li class="param"> |
|
19307 <code class="param-name">e</code> |
|
19308 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19309 |
|
19310 <div class="param-description"> |
|
19311 An Event Facade object with the following |
|
19312 attribute-specific properties added: |
|
19313 </div> |
|
19314 |
|
19315 <ul class="params-list"> |
|
19316 <li class="param"> |
|
19317 <code class="param-name">prevVal</code> |
|
19318 <span class="type">Any</span> |
|
19319 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19320 </li> |
|
19321 <li class="param"> |
|
19322 <code class="param-name">newVal</code> |
|
19323 <span class="type">Any</span> |
|
19324 <div class="param-description">The value the attribute is to be set to.</div> |
|
19325 </li> |
|
19326 <li class="param"> |
|
19327 <code class="param-name">attrName</code> |
|
19328 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19329 <div class="param-description">The name of the attribute being set.</div> |
|
19330 </li> |
|
19331 <li class="param"> |
|
19332 <code class="param-name">subAttrName</code> |
|
19333 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19334 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19335 </li> |
|
19336 </ul> |
|
19337 </li> |
|
19338 </ul> |
|
19339 </div> |
|
19340 </div> |
|
19341 |
|
19342 |
|
19343 |
|
19344 </div> |
|
19345 |
|
19346 |
|
19347 <div id="attr_scrollToTop" class="attr item inherited"> |
|
19348 <a name="config_scrollToTop"></a> |
|
19349 <h3 class="name"><code>scrollToTop</code></h3> |
|
19350 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19351 |
|
19352 |
|
19353 |
|
19354 |
|
19355 |
|
19356 |
|
19357 |
|
19358 |
|
19359 |
|
19360 |
|
19361 |
|
19362 |
|
19363 |
|
19364 |
|
19365 |
|
19366 <div class="meta"> |
|
19367 |
|
19368 |
|
19369 <p>Inherited from |
|
19370 <a href="../classes/PjaxBase.html#attr_scrollToTop">PjaxBase</a>: |
|
19371 |
|
19372 |
|
19373 |
|
19374 <a href="../files/pjax_js_pjax-base.js.html#l419"><code>pjax/js/pjax-base.js:419</code></a> |
|
19375 |
|
19376 </p> |
|
19377 |
|
19378 |
|
19379 |
|
19380 |
|
19381 <p>Available since 3.5.0</p> |
|
19382 |
|
19383 </div> |
|
19384 |
|
19385 <div class="description"> |
|
19386 <p>Whether the page should be scrolled to the top after navigating to a URL.</p> |
|
19387 |
|
19388 <p>When the user clicks the browser's back button, the previous scroll position |
|
19389 will be maintained.</p> |
|
19390 </div> |
|
19391 |
|
19392 |
|
19393 <p><strong>Default:</strong> true</p> |
|
19394 |
|
19395 |
|
19396 |
|
19397 <div class="emits box"> |
|
19398 <h4>Fires event <code>scrollToTopChange</code></h4> |
|
19399 |
|
19400 <p> |
|
19401 Fires when the value for the configuration attribute <code>scrollToTop</code> is |
|
19402 changed. You can listen for the event using the <code>on</code> method if you |
|
19403 wish to be notified before the attribute's value has changed, or |
|
19404 using the <code>after</code> method if you wish to be notified after the |
|
19405 attribute's value has changed. |
|
19406 </p> |
|
19407 |
|
19408 <div class="params"> |
|
19409 <h4>Parameters:</h4> |
|
19410 |
|
19411 <ul class="params-list"> |
|
19412 <li class="param"> |
|
19413 <code class="param-name">e</code> |
|
19414 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19415 |
|
19416 <div class="param-description"> |
|
19417 An Event Facade object with the following |
|
19418 attribute-specific properties added: |
|
19419 </div> |
|
19420 |
|
19421 <ul class="params-list"> |
|
19422 <li class="param"> |
|
19423 <code class="param-name">prevVal</code> |
|
19424 <span class="type">Any</span> |
|
19425 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19426 </li> |
|
19427 <li class="param"> |
|
19428 <code class="param-name">newVal</code> |
|
19429 <span class="type">Any</span> |
|
19430 <div class="param-description">The value the attribute is to be set to.</div> |
|
19431 </li> |
|
19432 <li class="param"> |
|
19433 <code class="param-name">attrName</code> |
|
19434 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19435 <div class="param-description">The name of the attribute being set.</div> |
|
19436 </li> |
|
19437 <li class="param"> |
|
19438 <code class="param-name">subAttrName</code> |
|
19439 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19440 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19441 </li> |
|
19442 </ul> |
|
19443 </li> |
|
19444 </ul> |
|
19445 </div> |
|
19446 </div> |
|
19447 |
|
19448 |
|
19449 |
|
19450 </div> |
|
19451 |
|
19452 |
|
19453 <div id="attr_serverRouting" class="attr item"> |
|
19454 <a name="config_serverRouting"></a> |
|
19455 <h3 class="name"><code>serverRouting</code></h3> |
|
19456 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19457 |
|
19458 |
|
19459 |
|
19460 |
|
19461 |
|
19462 |
|
19463 |
|
19464 |
|
19465 |
|
19466 |
|
19467 |
|
19468 |
|
19469 |
|
19470 |
|
19471 |
|
19472 <div class="meta"> |
|
19473 |
|
19474 |
|
19475 |
|
19476 <p> |
|
19477 |
|
19478 Defined in |
|
19479 |
|
19480 |
|
19481 |
|
19482 |
|
19483 <a href="../files/app_js_app-base.js.html#l911"><code>app/js/app-base.js:911</code></a> |
|
19484 |
|
19485 </p> |
|
19486 |
|
19487 |
|
19488 |
|
19489 |
|
19490 <p>Available since 3.5.0</p> |
|
19491 |
|
19492 </div> |
|
19493 |
|
19494 <div class="description"> |
|
19495 <p>Whether or not this application's server is capable of properly routing |
|
19496 all requests and rendering the initial state in the HTML responses.</p> |
|
19497 |
|
19498 <p>This can have three different values, each having particular |
|
19499 implications on how the app will handle routing and navigation:</p> |
|
19500 |
|
19501 <ul> |
|
19502 <li><p><code>undefined</code>: The best form of URLs will be chosen based on the |
|
19503 capabilities of the browser. Given no information about the server |
|
19504 environmentm a balanced approach to routing and navigation is |
|
19505 chosen.</p> |
|
19506 |
|
19507 <p>The server should be capable of handling full-path requests, since |
|
19508 full-URLs will be generated by browsers using HTML5 history. If this |
|
19509 is a client-side-only app the server could handle full-URL requests |
|
19510 by sending a redirect back to the root with a hash-based URL, e.g:</p> |
|
19511 |
|
19512 <pre class="code prettyprint"><code>Request: http://example.com/users/1 |
|
19513 Redirect to: http://example.com/#/users/1 |
|
19514 </code></pre></li> |
|
19515 <li><p><code>true</code>: The server is <em>fully</em> capable of properly handling requests |
|
19516 to all full-path URLs the app can produce.</p> |
|
19517 |
|
19518 <p>This is the best option for progressive-enhancement because it will |
|
19519 cause <strong>all URLs to always have full-paths</strong>, which means the server |
|
19520 will be able to accurately handle all URLs this app produces. e.g.</p> |
|
19521 |
|
19522 <pre class="code prettyprint"><code>http://example.com/users/1 |
|
19523 </code></pre> |
|
19524 |
|
19525 <p>To meet this strict full-URL requirement, browsers which are not |
|
19526 capable of using HTML5 history will make requests to the server |
|
19527 resulting in full-page reloads.</p></li> |
|
19528 <li><p><code>false</code>: The server is <em>not</em> capable of properly handling requests |
|
19529 to all full-path URLs the app can produce, therefore all routing |
|
19530 will be handled by this App instance.</p> |
|
19531 |
|
19532 <p>Be aware that this will cause <strong>all URLs to always be hash-based</strong>, |
|
19533 even in browsers that are capable of using HTML5 history. e.g.</p> |
|
19534 |
|
19535 <pre class="code prettyprint"><code>http://example.com/#/users/1 |
|
19536 </code></pre> |
|
19537 |
|
19538 <p>A single-page or client-side-only app where the server sends a |
|
19539 "shell" page with JavaScript to the client might have this |
|
19540 restriction. If you're setting this to <code>false</code>, read the following:</p></li> |
|
19541 </ul> |
|
19542 |
|
19543 <p><strong>Note:</strong> When this is set to <code>false</code>, the server will <em>never</em> receive |
|
19544 the full URL because browsers do not send the fragment-part to the |
|
19545 server, that is everything after and including the "#".</p> |
|
19546 |
|
19547 <p>Consider the following example:</p> |
|
19548 |
|
19549 <pre class="code prettyprint"><code>URL shown in browser: http://example.com/#/users/1 |
|
19550 URL sent to server: http://example.com/ |
|
19551 </code></pre> |
|
19552 |
|
19553 <p>You should feel bad about hurting our precious web if you forcefully set |
|
19554 either <code>serverRouting</code> or <code>html5</code> to <code>false</code>, because you're basically |
|
19555 punching the web in the face here with your lossy URLs! Please make sure |
|
19556 you know what you're doing and that you understand the implications.</p> |
|
19557 |
|
19558 <p>Ideally you should always prefer full-path URLs (not /#/foo/), and want |
|
19559 full-page reloads when the client's browser is not capable of enhancing |
|
19560 the experience using the HTML5 history APIs. Setting this to <code>true</code> is |
|
19561 the best option for progressive-enhancement (and graceful-degradation).</p> |
|
19562 </div> |
|
19563 |
|
19564 |
|
19565 <p><strong>Default:</strong> undefined</p> |
|
19566 |
|
19567 |
|
19568 |
|
19569 <div class="emits box"> |
|
19570 <h4>Fires event <code>serverRoutingChange</code></h4> |
|
19571 |
|
19572 <p> |
|
19573 Fires when the value for the configuration attribute <code>serverRouting</code> is |
|
19574 changed. You can listen for the event using the <code>on</code> method if you |
|
19575 wish to be notified before the attribute's value has changed, or |
|
19576 using the <code>after</code> method if you wish to be notified after the |
|
19577 attribute's value has changed. |
|
19578 </p> |
|
19579 |
|
19580 <div class="params"> |
|
19581 <h4>Parameters:</h4> |
|
19582 |
|
19583 <ul class="params-list"> |
|
19584 <li class="param"> |
|
19585 <code class="param-name">e</code> |
|
19586 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19587 |
|
19588 <div class="param-description"> |
|
19589 An Event Facade object with the following |
|
19590 attribute-specific properties added: |
|
19591 </div> |
|
19592 |
|
19593 <ul class="params-list"> |
|
19594 <li class="param"> |
|
19595 <code class="param-name">prevVal</code> |
|
19596 <span class="type">Any</span> |
|
19597 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19598 </li> |
|
19599 <li class="param"> |
|
19600 <code class="param-name">newVal</code> |
|
19601 <span class="type">Any</span> |
|
19602 <div class="param-description">The value the attribute is to be set to.</div> |
|
19603 </li> |
|
19604 <li class="param"> |
|
19605 <code class="param-name">attrName</code> |
|
19606 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19607 <div class="param-description">The name of the attribute being set.</div> |
|
19608 </li> |
|
19609 <li class="param"> |
|
19610 <code class="param-name">subAttrName</code> |
|
19611 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19612 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19613 </li> |
|
19614 </ul> |
|
19615 </li> |
|
19616 </ul> |
|
19617 </div> |
|
19618 </div> |
|
19619 |
|
19620 |
|
19621 |
|
19622 </div> |
|
19623 |
|
19624 |
|
19625 <div id="attr_viewContainer" class="attr item"> |
|
19626 <a name="config_viewContainer"></a> |
|
19627 <h3 class="name"><code>viewContainer</code></h3> |
|
19628 <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19629 |
|
19630 |
|
19631 |
|
19632 |
|
19633 |
|
19634 |
|
19635 |
|
19636 |
|
19637 |
|
19638 |
|
19639 |
|
19640 |
|
19641 |
|
19642 |
|
19643 |
|
19644 <div class="meta"> |
|
19645 |
|
19646 |
|
19647 |
|
19648 <p> |
|
19649 |
|
19650 Defined in |
|
19651 |
|
19652 |
|
19653 |
|
19654 |
|
19655 <a href="../files/app_js_app-base.js.html#l987"><code>app/js/app-base.js:987</code></a> |
|
19656 |
|
19657 </p> |
|
19658 |
|
19659 |
|
19660 |
|
19661 |
|
19662 <p>Available since 3.5.0</p> |
|
19663 |
|
19664 </div> |
|
19665 |
|
19666 <div class="description"> |
|
19667 <p>The node into which this app's <code>views</code> will be rendered when they become |
|
19668 the <code>activeView</code>.</p> |
|
19669 |
|
19670 <p>The view container node serves as the container to hold the app's |
|
19671 <code>activeView</code>. Each time the <code>activeView</code> is set via <code>showView()</code>, the |
|
19672 previous view will be removed from this node, and the new active view's |
|
19673 <code>container</code> node will be appended.</p> |
|
19674 |
|
19675 <p>The default view container is a <code><div></code> Node, but you can override this |
|
19676 in a subclass, or by passing in a custom <code>viewContainer</code> config value at |
|
19677 instantiation time. The <code>viewContainer</code> may be provided as a selector |
|
19678 string, DOM element, or a <code>Y.Node</code> instance (having the <code>viewContainer</code> |
|
19679 and the <code>container</code> be the same node is also supported).</p> |
|
19680 |
|
19681 <p>The app's <code>render()</code> method will stamp the view container with the CSS |
|
19682 class <code>"yui3-app-views"</code> and append it to the app's <code>container</code> node if |
|
19683 it isn't already, and any <code>activeView</code> will be appended to this node if |
|
19684 it isn't already.</p> |
|
19685 </div> |
|
19686 |
|
19687 |
|
19688 <p><strong>Default:</strong> Y.Node.create(this.containerTemplate)</p> |
|
19689 |
|
19690 |
|
19691 |
|
19692 <div class="emits box"> |
|
19693 <h4>Fires event <code>viewContainerChange</code></h4> |
|
19694 |
|
19695 <p> |
|
19696 Fires when the value for the configuration attribute <code>viewContainer</code> is |
|
19697 changed. You can listen for the event using the <code>on</code> method if you |
|
19698 wish to be notified before the attribute's value has changed, or |
|
19699 using the <code>after</code> method if you wish to be notified after the |
|
19700 attribute's value has changed. |
|
19701 </p> |
|
19702 |
|
19703 <div class="params"> |
|
19704 <h4>Parameters:</h4> |
|
19705 |
|
19706 <ul class="params-list"> |
|
19707 <li class="param"> |
|
19708 <code class="param-name">e</code> |
|
19709 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19710 |
|
19711 <div class="param-description"> |
|
19712 An Event Facade object with the following |
|
19713 attribute-specific properties added: |
|
19714 </div> |
|
19715 |
|
19716 <ul class="params-list"> |
|
19717 <li class="param"> |
|
19718 <code class="param-name">prevVal</code> |
|
19719 <span class="type">Any</span> |
|
19720 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
19721 </li> |
|
19722 <li class="param"> |
|
19723 <code class="param-name">newVal</code> |
|
19724 <span class="type">Any</span> |
|
19725 <div class="param-description">The value the attribute is to be set to.</div> |
|
19726 </li> |
|
19727 <li class="param"> |
|
19728 <code class="param-name">attrName</code> |
|
19729 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19730 <div class="param-description">The name of the attribute being set.</div> |
|
19731 </li> |
|
19732 <li class="param"> |
|
19733 <code class="param-name">subAttrName</code> |
|
19734 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19735 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
19736 </li> |
|
19737 </ul> |
|
19738 </li> |
|
19739 </ul> |
|
19740 </div> |
|
19741 </div> |
|
19742 |
|
19743 |
|
19744 |
|
19745 </div> |
|
19746 |
|
19747 |
|
19748 </div> |
|
19749 |
|
19750 |
|
19751 |
|
19752 <div id="events" class="api-class-tabpanel"> |
|
19753 <h2 class="off-left">Events</h2> |
|
19754 |
|
19755 |
|
19756 <div id="event_destroy" class="events item inherited"> |
|
19757 <h3 class="name"><code>destroy</code></h3> |
|
19758 <span class="type"></span> |
|
19759 |
|
19760 |
|
19761 |
|
19762 |
|
19763 |
|
19764 |
|
19765 |
|
19766 |
|
19767 |
|
19768 <div class="meta"> |
|
19769 |
|
19770 |
|
19771 <p>Inherited from |
|
19772 <a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>: |
|
19773 |
|
19774 |
|
19775 |
|
19776 <a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a> |
|
19777 |
|
19778 </p> |
|
19779 |
|
19780 |
|
19781 |
|
19782 |
|
19783 </div> |
|
19784 |
|
19785 <div class="description"> |
|
19786 <p> |
|
19787 Lifecycle event for the destroy phase, |
|
19788 fired prior to destruction. Invoking the preventDefault |
|
19789 method on the event object provided to subscribers will |
|
19790 prevent destruction from proceeding. |
|
19791 </p> |
|
19792 |
|
19793 <p> |
|
19794 Subscribers to the "after" moment of this event, will be notified |
|
19795 after destruction is complete (and as a result cannot prevent |
|
19796 destruction). |
|
19797 </p> |
|
19798 </div> |
|
19799 |
|
19800 |
|
19801 <div class="params"> |
|
19802 <h4>Event Payload:</h4> |
|
19803 |
|
19804 <ul class="params-list"> |
|
19805 |
|
19806 <li class="param"> |
|
19807 |
|
19808 <code class="param-name">e</code> |
|
19809 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19810 |
|
19811 |
|
19812 |
|
19813 |
|
19814 <div class="param-description"> |
|
19815 <p>Event object</p> |
|
19816 </div> |
|
19817 |
|
19818 |
|
19819 </li> |
|
19820 |
|
19821 </ul> |
|
19822 </div> |
|
19823 |
|
19824 |
|
19825 |
|
19826 |
|
19827 </div> |
|
19828 |
|
19829 |
|
19830 <div id="event_init" class="events item inherited"> |
|
19831 <h3 class="name"><code>init</code></h3> |
|
19832 <span class="type"></span> |
|
19833 |
|
19834 |
|
19835 |
|
19836 |
|
19837 |
|
19838 |
|
19839 |
|
19840 |
|
19841 |
|
19842 <div class="meta"> |
|
19843 |
|
19844 |
|
19845 <p>Inherited from |
|
19846 <a href="../classes/BaseObservable.html#event_init">BaseObservable</a>: |
|
19847 |
|
19848 |
|
19849 |
|
19850 <a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a> |
|
19851 |
|
19852 </p> |
|
19853 |
|
19854 |
|
19855 |
|
19856 |
|
19857 </div> |
|
19858 |
|
19859 <div class="description"> |
|
19860 <p> |
|
19861 Lifecycle event for the init phase, fired prior to initialization. |
|
19862 Invoking the preventDefault() method on the event object provided |
|
19863 to subscribers will prevent initialization from occuring. |
|
19864 </p> |
|
19865 |
|
19866 <p> |
|
19867 Subscribers to the "after" momemt of this event, will be notified |
|
19868 after initialization of the object is complete (and therefore |
|
19869 cannot prevent initialization). |
|
19870 </p> |
|
19871 </div> |
|
19872 |
|
19873 |
|
19874 <div class="params"> |
|
19875 <h4>Event Payload:</h4> |
|
19876 |
|
19877 <ul class="params-list"> |
|
19878 |
|
19879 <li class="param"> |
|
19880 |
|
19881 <code class="param-name">e</code> |
|
19882 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
19883 |
|
19884 |
|
19885 |
|
19886 |
|
19887 <div class="param-description"> |
|
19888 <p>Event object, with a cfg property which |
|
19889 refers to the configuration object passed to the constructor.</p> |
|
19890 </div> |
|
19891 |
|
19892 |
|
19893 </li> |
|
19894 |
|
19895 </ul> |
|
19896 </div> |
|
19897 |
|
19898 |
|
19899 |
|
19900 |
|
19901 </div> |
|
19902 |
|
19903 |
|
19904 <div id="event_navigate" class="events item inherited"> |
|
19905 <h3 class="name"><code>navigate</code></h3> |
|
19906 <span class="type"></span> |
|
19907 |
|
19908 |
|
19909 |
|
19910 |
|
19911 |
|
19912 |
|
19913 |
|
19914 |
|
19915 |
|
19916 <div class="meta"> |
|
19917 |
|
19918 |
|
19919 <p>Inherited from |
|
19920 <a href="../classes/PjaxBase.html#event_navigate">PjaxBase</a>: |
|
19921 |
|
19922 |
|
19923 |
|
19924 <a href="../files/pjax_js_pjax-base.js.html#l16"><code>pjax/js/pjax-base.js:16</code></a> |
|
19925 |
|
19926 </p> |
|
19927 |
|
19928 |
|
19929 |
|
19930 |
|
19931 <p>Available since 3.5.0</p> |
|
19932 |
|
19933 </div> |
|
19934 |
|
19935 <div class="description"> |
|
19936 <p>Fired when navigating to a URL via Pjax.</p> |
|
19937 |
|
19938 <p>When the <code>navigate()</code> method is called or a pjax link is clicked, this event |
|
19939 will be fired if the browser supports HTML5 history <em>and</em> the router has a |
|
19940 route handler for the specified URL.</p> |
|
19941 |
|
19942 <p>This is a useful event to listen to for adding a visual loading indicator |
|
19943 while the route handlers are busy handling the URL change.</p> |
|
19944 </div> |
|
19945 |
|
19946 |
|
19947 <div class="params"> |
|
19948 <h4>Event Payload:</h4> |
|
19949 |
|
19950 <ul class="params-list"> |
|
19951 |
|
19952 <li class="param"> |
|
19953 |
|
19954 <code class="param-name">url</code> |
|
19955 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19956 |
|
19957 |
|
19958 |
|
19959 |
|
19960 <div class="param-description"> |
|
19961 <p>The URL that the router will dispatch to its route |
|
19962 handlers in order to fulfill the enhanced navigation "request".</p> |
|
19963 </div> |
|
19964 |
|
19965 |
|
19966 </li> |
|
19967 |
|
19968 <li class="param"> |
|
19969 |
|
19970 <code class="param-name optional">[force=false]</code> |
|
19971 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
19972 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
19973 |
|
19974 |
|
19975 |
|
19976 |
|
19977 <div class="param-description"> |
|
19978 <p>Whether the enhanced navigation should occur |
|
19979 even in browsers without HTML5 history.</p> |
|
19980 </div> |
|
19981 |
|
19982 |
|
19983 </li> |
|
19984 |
|
19985 <li class="param"> |
|
19986 |
|
19987 <code class="param-name optional">[hash]</code> |
|
19988 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
19989 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
19990 |
|
19991 |
|
19992 |
|
19993 |
|
19994 <div class="param-description"> |
|
19995 <p>The hash-fragment (including "#") of the <code>url</code>. This |
|
19996 will be present when the <code>url</code> differs from the current URL only by its |
|
19997 hash and <code>navigateOnHash</code> has been set to <code>true</code>.</p> |
|
19998 </div> |
|
19999 |
|
20000 |
|
20001 </li> |
|
20002 |
|
20003 <li class="param"> |
|
20004 |
|
20005 <code class="param-name optional">[originEvent]</code> |
|
20006 <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span> |
|
20007 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20008 |
|
20009 |
|
20010 |
|
20011 |
|
20012 <div class="param-description"> |
|
20013 <p>The event that caused the navigation. Usually |
|
20014 this would be a click event from a "pjax" anchor element.</p> |
|
20015 </div> |
|
20016 |
|
20017 |
|
20018 </li> |
|
20019 |
|
20020 <li class="param"> |
|
20021 |
|
20022 <code class="param-name optional">[replace]</code> |
|
20023 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
20024 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
20025 |
|
20026 |
|
20027 |
|
20028 |
|
20029 <div class="param-description"> |
|
20030 <p>Whether or not the current history entry will be |
|
20031 replaced, or a new entry will be created. Will default to <code>true</code> if the |
|
20032 specified <code>url</code> is the same as the current URL.</p> |
|
20033 </div> |
|
20034 |
|
20035 |
|
20036 </li> |
|
20037 |
|
20038 </ul> |
|
20039 </div> |
|
20040 |
|
20041 |
|
20042 |
|
20043 |
|
20044 </div> |
|
20045 |
|
20046 |
|
20047 <div id="event_ready" class="events item inherited"> |
|
20048 <h3 class="name"><code>ready</code></h3> |
|
20049 <span class="type"></span> |
|
20050 |
|
20051 |
|
20052 |
|
20053 |
|
20054 |
|
20055 |
|
20056 |
|
20057 |
|
20058 |
|
20059 <div class="meta"> |
|
20060 |
|
20061 |
|
20062 <p>Inherited from |
|
20063 <a href="../classes/Router.html#event_ready">Router</a>: |
|
20064 |
|
20065 |
|
20066 |
|
20067 <a href="../files/app_js_router.js.html#l24"><code>app/js/router.js:24</code></a> |
|
20068 |
|
20069 </p> |
|
20070 |
|
20071 |
|
20072 |
|
20073 |
|
20074 </div> |
|
20075 |
|
20076 <div class="description"> |
|
20077 <p>Fired when the router is ready to begin dispatching to route handlers.</p> |
|
20078 |
|
20079 <p>You shouldn't need to wait for this event unless you plan to implement some |
|
20080 kind of custom dispatching logic. It's used internally in order to avoid |
|
20081 dispatching to an initial route if a browser history change occurs first.</p> |
|
20082 </div> |
|
20083 |
|
20084 |
|
20085 <div class="params"> |
|
20086 <h4>Event Payload:</h4> |
|
20087 |
|
20088 <ul class="params-list"> |
|
20089 |
|
20090 <li class="param"> |
|
20091 |
|
20092 <code class="param-name">dispatched</code> |
|
20093 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
20094 |
|
20095 |
|
20096 |
|
20097 |
|
20098 <div class="param-description"> |
|
20099 <p><code>true</code> if routes have already been dispatched |
|
20100 (most likely due to a history change).</p> |
|
20101 </div> |
|
20102 |
|
20103 |
|
20104 </li> |
|
20105 |
|
20106 </ul> |
|
20107 </div> |
|
20108 |
|
20109 |
|
20110 |
|
20111 |
|
20112 </div> |
|
20113 |
|
20114 |
|
20115 </div> |
|
20116 |
|
20117 </div> |
|
20118 </div> |
|
20119 |
|
20120 </div> |
|
20121 </div> |
|
20122 </div> |
|
20123 </div> |
|
20124 </div> |
|
20125 </div> |
|
20126 <script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
20127 <script>prettyPrint();</script> |
|
20128 <script src="../assets/js/yui-prettify.js"></script> |
|
20129 <script src="../assets/../api.js"></script> |
|
20130 <script src="../assets/js/api-filter.js"></script> |
|
20131 <script src="../assets/js/api-list.js"></script> |
|
20132 <script src="../assets/js/api-search.js"></script> |
|
20133 <script src="../assets/js/apidocs.js"></script> |
|
20134 </body> |
|
20135 </html> |