|
1 <!DOCTYPE html> |
|
2 <html lang="en"> |
|
3 <head> |
|
4 <meta charset="utf-8"> |
|
5 <title>Model - 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>Model Class</h1> |
|
1532 <div class="box meta"> |
|
1533 |
|
1534 |
|
1535 |
|
1536 <div class="extends"> |
|
1537 Extends <a href="../classes/Base.html" class="crosslink">Base</a> |
|
1538 </div> |
|
1539 |
|
1540 |
|
1541 |
|
1542 <div class="foundat"> |
|
1543 Defined in: <a href="../files/app_js_model.js.html#l10"><code>app/js/model.js:10</code></a> |
|
1544 </div> |
|
1545 |
|
1546 |
|
1547 |
|
1548 |
|
1549 Module: <a href="../modules/model.html">model</a><br> |
|
1550 Parent Module: <a href="../modules/app.html">app</a> |
|
1551 |
|
1552 |
|
1553 |
|
1554 |
|
1555 <p>Available since 3.4.0</p> |
|
1556 |
|
1557 </div> |
|
1558 |
|
1559 |
|
1560 |
|
1561 <div class="box intro"> |
|
1562 <p>Attribute-based data model with APIs for getting, setting, validating, and |
|
1563 syncing attribute values, as well as events for being notified of model changes.</p> |
|
1564 |
|
1565 <p>In most cases, you'll want to create your own subclass of <code>Y.Model</code> and |
|
1566 customize it to meet your needs. In particular, the <code>sync()</code> and <code>validate()</code> |
|
1567 methods are meant to be overridden by custom implementations. You may also want |
|
1568 to override the <code>parse()</code> method to parse non-generic server responses.</p> |
|
1569 </div> |
|
1570 |
|
1571 |
|
1572 <div class="constructor"> |
|
1573 <h2>Constructor</h2> |
|
1574 <div id="method_Model" class="method item"> |
|
1575 <h3 class="name"><code>Model</code></h3> |
|
1576 |
|
1577 |
|
1578 <span class="paren">()</span> |
|
1579 |
|
1580 |
|
1581 |
|
1582 |
|
1583 |
|
1584 |
|
1585 |
|
1586 |
|
1587 |
|
1588 |
|
1589 |
|
1590 |
|
1591 |
|
1592 |
|
1593 |
|
1594 |
|
1595 <div class="meta"> |
|
1596 |
|
1597 |
|
1598 |
|
1599 <p> |
|
1600 |
|
1601 Defined in |
|
1602 |
|
1603 |
|
1604 |
|
1605 |
|
1606 <a href="../files/app_js_model.js.html#l10"><code>app/js/model.js:10</code></a> |
|
1607 |
|
1608 </p> |
|
1609 |
|
1610 |
|
1611 |
|
1612 |
|
1613 |
|
1614 <p>Available since 3.4.0</p> |
|
1615 |
|
1616 </div> |
|
1617 |
|
1618 <div class="description"> |
|
1619 |
|
1620 </div> |
|
1621 |
|
1622 |
|
1623 |
|
1624 |
|
1625 |
|
1626 |
|
1627 </div> |
|
1628 |
|
1629 </div> |
|
1630 |
|
1631 |
|
1632 <div id="classdocs" class="tabview"> |
|
1633 <ul class="api-class-tabs"> |
|
1634 <li class="api-class-tab index"><a href="#index">Index</a></li> |
|
1635 |
|
1636 |
|
1637 <li class="api-class-tab methods"><a href="#methods">Methods</a></li> |
|
1638 |
|
1639 |
|
1640 <li class="api-class-tab properties"><a href="#properties">Properties</a></li> |
|
1641 |
|
1642 |
|
1643 <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> |
|
1644 |
|
1645 |
|
1646 <li class="api-class-tab events"><a href="#events">Events</a></li> |
|
1647 |
|
1648 </ul> |
|
1649 |
|
1650 <div> |
|
1651 <div id="index" class="api-class-tabpanel index"> |
|
1652 <h2 class="off-left">Item Index</h2> |
|
1653 |
|
1654 |
|
1655 <div class="index-section methods"> |
|
1656 <h3>Methods</h3> |
|
1657 |
|
1658 <ul class="index-list methods extends"> |
|
1659 |
|
1660 <li class="index-item method private inherited"> |
|
1661 <a href="#method__addAttrs">_addAttrs</a> |
|
1662 |
|
1663 |
|
1664 |
|
1665 </li> |
|
1666 |
|
1667 <li class="index-item method private inherited"> |
|
1668 <a href="#method__addLazyAttr">_addLazyAttr</a> |
|
1669 |
|
1670 |
|
1671 |
|
1672 </li> |
|
1673 |
|
1674 <li class="index-item method private inherited"> |
|
1675 <a href="#method__aggregateAttrs">_aggregateAttrs</a> |
|
1676 |
|
1677 |
|
1678 |
|
1679 </li> |
|
1680 |
|
1681 <li class="index-item method private inherited"> |
|
1682 <a href="#method__attrCfgHash">_attrCfgHash</a> |
|
1683 |
|
1684 |
|
1685 |
|
1686 </li> |
|
1687 |
|
1688 <li class="index-item method private inherited"> |
|
1689 <a href="#method__baseDestroy">_baseDestroy</a> |
|
1690 |
|
1691 |
|
1692 |
|
1693 </li> |
|
1694 |
|
1695 <li class="index-item method private inherited"> |
|
1696 <a href="#method__baseInit">_baseInit</a> |
|
1697 |
|
1698 |
|
1699 |
|
1700 </li> |
|
1701 |
|
1702 <li class="index-item method private inherited"> |
|
1703 <a href="#method__cloneDefaultValue">_cloneDefaultValue</a> |
|
1704 |
|
1705 |
|
1706 |
|
1707 </li> |
|
1708 |
|
1709 <li class="index-item method protected inherited"> |
|
1710 <a href="#method__defAttrChangeFn">_defAttrChangeFn</a> |
|
1711 |
|
1712 |
|
1713 |
|
1714 </li> |
|
1715 |
|
1716 <li class="index-item method protected inherited"> |
|
1717 <a href="#method__defDestroyFn">_defDestroyFn</a> |
|
1718 |
|
1719 |
|
1720 |
|
1721 </li> |
|
1722 |
|
1723 <li class="index-item method protected inherited"> |
|
1724 <a href="#method__defInitFn">_defInitFn</a> |
|
1725 |
|
1726 |
|
1727 |
|
1728 </li> |
|
1729 |
|
1730 <li class="index-item method private inherited"> |
|
1731 <a href="#method__destroyHierarchy">_destroyHierarchy</a> |
|
1732 |
|
1733 |
|
1734 |
|
1735 </li> |
|
1736 |
|
1737 <li class="index-item method private inherited"> |
|
1738 <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a> |
|
1739 |
|
1740 |
|
1741 |
|
1742 </li> |
|
1743 |
|
1744 <li class="index-item method private inherited"> |
|
1745 <a href="#method__filterAttrCfgs">_filterAttrCfgs</a> |
|
1746 |
|
1747 |
|
1748 |
|
1749 </li> |
|
1750 |
|
1751 <li class="index-item method private inherited"> |
|
1752 <a href="#method__fireAttrChange">_fireAttrChange</a> |
|
1753 |
|
1754 |
|
1755 |
|
1756 </li> |
|
1757 |
|
1758 <li class="index-item method protected inherited"> |
|
1759 <a href="#method__getAttr">_getAttr</a> |
|
1760 |
|
1761 |
|
1762 |
|
1763 </li> |
|
1764 |
|
1765 <li class="index-item method protected inherited"> |
|
1766 <a href="#method__getAttrCfg">_getAttrCfg</a> |
|
1767 |
|
1768 |
|
1769 |
|
1770 </li> |
|
1771 |
|
1772 <li class="index-item method protected inherited"> |
|
1773 <a href="#method__getAttrCfgs">_getAttrCfgs</a> |
|
1774 |
|
1775 |
|
1776 |
|
1777 </li> |
|
1778 |
|
1779 <li class="index-item method private inherited"> |
|
1780 <a href="#method__getAttrInitVal">_getAttrInitVal</a> |
|
1781 |
|
1782 |
|
1783 |
|
1784 </li> |
|
1785 |
|
1786 <li class="index-item method protected inherited"> |
|
1787 <a href="#method__getAttrs">_getAttrs</a> |
|
1788 |
|
1789 |
|
1790 |
|
1791 </li> |
|
1792 |
|
1793 <li class="index-item method protected inherited"> |
|
1794 <a href="#method__getClasses">_getClasses</a> |
|
1795 |
|
1796 |
|
1797 |
|
1798 </li> |
|
1799 |
|
1800 <li class="index-item method private inherited"> |
|
1801 <a href="#method__getFullType">_getFullType</a> |
|
1802 |
|
1803 |
|
1804 |
|
1805 </li> |
|
1806 |
|
1807 <li class="index-item method private inherited"> |
|
1808 <a href="#method__getStateVal">_getStateVal</a> |
|
1809 |
|
1810 |
|
1811 |
|
1812 </li> |
|
1813 |
|
1814 <li class="index-item method private inherited"> |
|
1815 <a href="#method__getType">_getType</a> |
|
1816 |
|
1817 |
|
1818 |
|
1819 </li> |
|
1820 |
|
1821 <li class="index-item method private inherited"> |
|
1822 <a href="#method__initAttrHost">_initAttrHost</a> |
|
1823 |
|
1824 |
|
1825 |
|
1826 </li> |
|
1827 |
|
1828 <li class="index-item method private inherited inherited"> |
|
1829 <a href="#method__initAttribute">_initAttribute</a> |
|
1830 |
|
1831 |
|
1832 |
|
1833 </li> |
|
1834 |
|
1835 <li class="index-item method protected inherited"> |
|
1836 <a href="#method__initAttrs">_initAttrs</a> |
|
1837 |
|
1838 |
|
1839 |
|
1840 </li> |
|
1841 |
|
1842 <li class="index-item method private inherited"> |
|
1843 <a href="#method__initBase">_initBase</a> |
|
1844 |
|
1845 |
|
1846 |
|
1847 </li> |
|
1848 |
|
1849 <li class="index-item method private inherited"> |
|
1850 <a href="#method__initHierarchy">_initHierarchy</a> |
|
1851 |
|
1852 |
|
1853 |
|
1854 </li> |
|
1855 |
|
1856 <li class="index-item method private inherited"> |
|
1857 <a href="#method__initHierarchyData">_initHierarchyData</a> |
|
1858 |
|
1859 |
|
1860 |
|
1861 </li> |
|
1862 |
|
1863 <li class="index-item method private inherited"> |
|
1864 <a href="#method__isLazyAttr">_isLazyAttr</a> |
|
1865 |
|
1866 |
|
1867 |
|
1868 </li> |
|
1869 |
|
1870 <li class="index-item method private inherited"> |
|
1871 <a href="#method__monitor">_monitor</a> |
|
1872 |
|
1873 |
|
1874 |
|
1875 </li> |
|
1876 |
|
1877 <li class="index-item method private inherited"> |
|
1878 <a href="#method__normAttrVals">_normAttrVals</a> |
|
1879 |
|
1880 |
|
1881 |
|
1882 </li> |
|
1883 |
|
1884 <li class="index-item method protected"> |
|
1885 <a href="#method__parse">_parse</a> |
|
1886 |
|
1887 |
|
1888 |
|
1889 </li> |
|
1890 |
|
1891 <li class="index-item method private inherited"> |
|
1892 <a href="#method__parseType">_parseType</a> |
|
1893 |
|
1894 |
|
1895 |
|
1896 </li> |
|
1897 |
|
1898 <li class="index-item method private inherited"> |
|
1899 <a href="#method__preInitEventCfg">_preInitEventCfg</a> |
|
1900 |
|
1901 |
|
1902 |
|
1903 </li> |
|
1904 |
|
1905 <li class="index-item method protected deprecated inherited"> |
|
1906 <a href="#method__protectAttrs">_protectAttrs</a> |
|
1907 |
|
1908 |
|
1909 |
|
1910 <span class="flag deprecated">deprecated</span> |
|
1911 |
|
1912 </li> |
|
1913 |
|
1914 <li class="index-item method private inherited"> |
|
1915 <a href="#method__publish">_publish</a> |
|
1916 |
|
1917 |
|
1918 |
|
1919 </li> |
|
1920 |
|
1921 <li class="index-item method protected inherited inherited"> |
|
1922 <a href="#method__set">_set</a> |
|
1923 |
|
1924 |
|
1925 |
|
1926 </li> |
|
1927 |
|
1928 <li class="index-item method protected inherited"> |
|
1929 <a href="#method__setAttr">_setAttr</a> |
|
1930 |
|
1931 |
|
1932 |
|
1933 </li> |
|
1934 |
|
1935 <li class="index-item method protected inherited inherited"> |
|
1936 <a href="#method__setAttrs">_setAttrs</a> |
|
1937 |
|
1938 |
|
1939 |
|
1940 </li> |
|
1941 |
|
1942 <li class="index-item method private inherited"> |
|
1943 <a href="#method__setAttrVal">_setAttrVal</a> |
|
1944 |
|
1945 |
|
1946 |
|
1947 </li> |
|
1948 |
|
1949 <li class="index-item method private inherited"> |
|
1950 <a href="#method__setStateVal">_setStateVal</a> |
|
1951 |
|
1952 |
|
1953 |
|
1954 </li> |
|
1955 |
|
1956 <li class="index-item method protected"> |
|
1957 <a href="#method__validate">_validate</a> |
|
1958 |
|
1959 |
|
1960 |
|
1961 </li> |
|
1962 |
|
1963 <li class="index-item method protected inherited"> |
|
1964 <a href="#method_addAttr">addAttr</a> |
|
1965 |
|
1966 |
|
1967 |
|
1968 </li> |
|
1969 |
|
1970 <li class="index-item method inherited"> |
|
1971 <a href="#method_addAttrs">addAttrs</a> |
|
1972 |
|
1973 |
|
1974 |
|
1975 </li> |
|
1976 |
|
1977 <li class="index-item method inherited"> |
|
1978 <a href="#method_addTarget">addTarget</a> |
|
1979 |
|
1980 |
|
1981 |
|
1982 </li> |
|
1983 |
|
1984 <li class="index-item method inherited"> |
|
1985 <a href="#method_after">after</a> |
|
1986 |
|
1987 |
|
1988 |
|
1989 </li> |
|
1990 |
|
1991 <li class="index-item method inherited"> |
|
1992 <a href="#method_attrAdded">attrAdded</a> |
|
1993 |
|
1994 |
|
1995 |
|
1996 </li> |
|
1997 |
|
1998 <li class="index-item method inherited"> |
|
1999 <a href="#method_before">before</a> |
|
2000 |
|
2001 |
|
2002 |
|
2003 </li> |
|
2004 |
|
2005 <li class="index-item method inherited"> |
|
2006 <a href="#method_bubble">bubble</a> |
|
2007 |
|
2008 |
|
2009 |
|
2010 </li> |
|
2011 |
|
2012 <li class="index-item method inherited"> |
|
2013 <a href="#method_destroy">destroy</a> |
|
2014 |
|
2015 |
|
2016 |
|
2017 </li> |
|
2018 |
|
2019 <li class="index-item method inherited"> |
|
2020 <a href="#method_detach">detach</a> |
|
2021 |
|
2022 |
|
2023 |
|
2024 </li> |
|
2025 |
|
2026 <li class="index-item method inherited"> |
|
2027 <a href="#method_detachAll">detachAll</a> |
|
2028 |
|
2029 |
|
2030 |
|
2031 </li> |
|
2032 |
|
2033 <li class="index-item method inherited"> |
|
2034 <a href="#method_fire">fire</a> |
|
2035 |
|
2036 |
|
2037 |
|
2038 </li> |
|
2039 |
|
2040 <li class="index-item method"> |
|
2041 <a href="#method_generateClientId">generateClientId</a> |
|
2042 |
|
2043 |
|
2044 |
|
2045 </li> |
|
2046 |
|
2047 <li class="index-item method inherited"> |
|
2048 <a href="#method_get">get</a> |
|
2049 |
|
2050 |
|
2051 |
|
2052 </li> |
|
2053 |
|
2054 <li class="index-item method"> |
|
2055 <a href="#method_getAsHTML">getAsHTML</a> |
|
2056 |
|
2057 |
|
2058 |
|
2059 </li> |
|
2060 |
|
2061 <li class="index-item method"> |
|
2062 <a href="#method_getAsURL">getAsURL</a> |
|
2063 |
|
2064 |
|
2065 |
|
2066 </li> |
|
2067 |
|
2068 <li class="index-item method inherited"> |
|
2069 <a href="#method_getAttrs">getAttrs</a> |
|
2070 |
|
2071 |
|
2072 |
|
2073 </li> |
|
2074 |
|
2075 <li class="index-item method inherited"> |
|
2076 <a href="#method_getEvent">getEvent</a> |
|
2077 |
|
2078 |
|
2079 |
|
2080 </li> |
|
2081 |
|
2082 <li class="index-item method inherited"> |
|
2083 <a href="#method_getTargets">getTargets</a> |
|
2084 |
|
2085 |
|
2086 |
|
2087 </li> |
|
2088 |
|
2089 <li class="index-item method inherited inherited"> |
|
2090 <a href="#method_init">init</a> |
|
2091 |
|
2092 |
|
2093 |
|
2094 </li> |
|
2095 |
|
2096 <li class="index-item method"> |
|
2097 <a href="#method_isModified">isModified</a> |
|
2098 |
|
2099 |
|
2100 |
|
2101 </li> |
|
2102 |
|
2103 <li class="index-item method"> |
|
2104 <a href="#method_isNew">isNew</a> |
|
2105 |
|
2106 |
|
2107 |
|
2108 </li> |
|
2109 |
|
2110 <li class="index-item method"> |
|
2111 <a href="#method_load">load</a> |
|
2112 |
|
2113 |
|
2114 |
|
2115 </li> |
|
2116 |
|
2117 <li class="index-item method inherited"> |
|
2118 <a href="#method_modifyAttr">modifyAttr</a> |
|
2119 |
|
2120 |
|
2121 |
|
2122 </li> |
|
2123 |
|
2124 <li class="index-item method inherited"> |
|
2125 <a href="#method_on">on</a> |
|
2126 |
|
2127 |
|
2128 |
|
2129 </li> |
|
2130 |
|
2131 <li class="index-item method inherited"> |
|
2132 <a href="#method_once">once</a> |
|
2133 |
|
2134 |
|
2135 |
|
2136 </li> |
|
2137 |
|
2138 <li class="index-item method inherited"> |
|
2139 <a href="#method_onceAfter">onceAfter</a> |
|
2140 |
|
2141 |
|
2142 |
|
2143 </li> |
|
2144 |
|
2145 <li class="index-item method"> |
|
2146 <a href="#method_parse">parse</a> |
|
2147 |
|
2148 |
|
2149 |
|
2150 </li> |
|
2151 |
|
2152 <li class="index-item method inherited"> |
|
2153 <a href="#method_parseType">parseType</a> |
|
2154 |
|
2155 |
|
2156 |
|
2157 </li> |
|
2158 |
|
2159 <li class="index-item method inherited"> |
|
2160 <a href="#method_publish">publish</a> |
|
2161 |
|
2162 |
|
2163 |
|
2164 </li> |
|
2165 |
|
2166 <li class="index-item method inherited"> |
|
2167 <a href="#method_removeAttr">removeAttr</a> |
|
2168 |
|
2169 |
|
2170 |
|
2171 </li> |
|
2172 |
|
2173 <li class="index-item method inherited"> |
|
2174 <a href="#method_removeTarget">removeTarget</a> |
|
2175 |
|
2176 |
|
2177 |
|
2178 </li> |
|
2179 |
|
2180 <li class="index-item method inherited"> |
|
2181 <a href="#method_reset">reset</a> |
|
2182 |
|
2183 |
|
2184 |
|
2185 </li> |
|
2186 |
|
2187 <li class="index-item method"> |
|
2188 <a href="#method_save">save</a> |
|
2189 |
|
2190 |
|
2191 |
|
2192 </li> |
|
2193 |
|
2194 <li class="index-item method inherited"> |
|
2195 <a href="#method_set">set</a> |
|
2196 |
|
2197 |
|
2198 |
|
2199 </li> |
|
2200 |
|
2201 <li class="index-item method inherited"> |
|
2202 <a href="#method_setAttrs">setAttrs</a> |
|
2203 |
|
2204 |
|
2205 |
|
2206 </li> |
|
2207 |
|
2208 <li class="index-item method deprecated inherited"> |
|
2209 <a href="#method_subscribe">subscribe</a> |
|
2210 |
|
2211 |
|
2212 |
|
2213 <span class="flag deprecated">deprecated</span> |
|
2214 |
|
2215 </li> |
|
2216 |
|
2217 <li class="index-item method"> |
|
2218 <a href="#method_sync">sync</a> |
|
2219 |
|
2220 |
|
2221 |
|
2222 </li> |
|
2223 |
|
2224 <li class="index-item method"> |
|
2225 <a href="#method_toJSON">toJSON</a> |
|
2226 |
|
2227 |
|
2228 |
|
2229 </li> |
|
2230 |
|
2231 <li class="index-item method inherited"> |
|
2232 <a href="#method_toString">toString</a> |
|
2233 |
|
2234 |
|
2235 |
|
2236 </li> |
|
2237 |
|
2238 <li class="index-item method"> |
|
2239 <a href="#method_undo">undo</a> |
|
2240 |
|
2241 |
|
2242 |
|
2243 </li> |
|
2244 |
|
2245 <li class="index-item method deprecated inherited"> |
|
2246 <a href="#method_unsubscribe">unsubscribe</a> |
|
2247 |
|
2248 |
|
2249 |
|
2250 <span class="flag deprecated">deprecated</span> |
|
2251 |
|
2252 </li> |
|
2253 |
|
2254 <li class="index-item method deprecated inherited"> |
|
2255 <a href="#method_unsubscribeAll">unsubscribeAll</a> |
|
2256 |
|
2257 |
|
2258 |
|
2259 <span class="flag deprecated">deprecated</span> |
|
2260 |
|
2261 </li> |
|
2262 |
|
2263 <li class="index-item method"> |
|
2264 <a href="#method_validate">validate</a> |
|
2265 |
|
2266 |
|
2267 |
|
2268 </li> |
|
2269 |
|
2270 </ul> |
|
2271 </div> |
|
2272 |
|
2273 |
|
2274 |
|
2275 <div class="index-section properties"> |
|
2276 <h3>Properties</h3> |
|
2277 |
|
2278 <ul class="index-list properties extends"> |
|
2279 |
|
2280 <li class="index-item property protected inherited"> |
|
2281 <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a> |
|
2282 |
|
2283 |
|
2284 |
|
2285 </li> |
|
2286 |
|
2287 <li class="index-item property protected"> |
|
2288 <a href="#property__isYUIModel">_isYUIModel</a> |
|
2289 |
|
2290 |
|
2291 |
|
2292 </li> |
|
2293 |
|
2294 <li class="index-item property"> |
|
2295 <a href="#property_changed">changed</a> |
|
2296 |
|
2297 |
|
2298 |
|
2299 </li> |
|
2300 |
|
2301 <li class="index-item property"> |
|
2302 <a href="#property_idAttribute">idAttribute</a> |
|
2303 |
|
2304 |
|
2305 |
|
2306 </li> |
|
2307 |
|
2308 <li class="index-item property"> |
|
2309 <a href="#property_lastChange">lastChange</a> |
|
2310 |
|
2311 |
|
2312 |
|
2313 </li> |
|
2314 |
|
2315 <li class="index-item property"> |
|
2316 <a href="#property_lists">lists</a> |
|
2317 |
|
2318 |
|
2319 |
|
2320 </li> |
|
2321 |
|
2322 <li class="index-item property deprecated inherited"> |
|
2323 <a href="#property_name">name</a> |
|
2324 |
|
2325 |
|
2326 |
|
2327 <span class="flag deprecated">deprecated</span> |
|
2328 |
|
2329 </li> |
|
2330 |
|
2331 </ul> |
|
2332 </div> |
|
2333 |
|
2334 |
|
2335 |
|
2336 <div class="index-section attrs"> |
|
2337 <h3>Attributes</h3> |
|
2338 |
|
2339 <ul class="index-list attrs extends"> |
|
2340 |
|
2341 <li class="index-item attr"> |
|
2342 <a href="#attr_clientId">clientId</a> |
|
2343 </li> |
|
2344 |
|
2345 <li class="index-item attr inherited"> |
|
2346 <a href="#attr_destroyed">destroyed</a> |
|
2347 </li> |
|
2348 |
|
2349 <li class="index-item attr"> |
|
2350 <a href="#attr_id">id</a> |
|
2351 </li> |
|
2352 |
|
2353 <li class="index-item attr inherited"> |
|
2354 <a href="#attr_initialized">initialized</a> |
|
2355 </li> |
|
2356 |
|
2357 </ul> |
|
2358 </div> |
|
2359 |
|
2360 |
|
2361 |
|
2362 <div class="index-section events"> |
|
2363 <h3>Events</h3> |
|
2364 |
|
2365 <ul class="index-list events extends"> |
|
2366 |
|
2367 <li class="index-item event"> |
|
2368 <a href="#event_change">change</a> |
|
2369 |
|
2370 |
|
2371 |
|
2372 </li> |
|
2373 |
|
2374 <li class="index-item event inherited"> |
|
2375 <a href="#event_destroy">destroy</a> |
|
2376 |
|
2377 |
|
2378 |
|
2379 </li> |
|
2380 |
|
2381 <li class="index-item event"> |
|
2382 <a href="#event_error">error</a> |
|
2383 |
|
2384 |
|
2385 |
|
2386 </li> |
|
2387 |
|
2388 <li class="index-item event inherited"> |
|
2389 <a href="#event_init">init</a> |
|
2390 |
|
2391 |
|
2392 |
|
2393 </li> |
|
2394 |
|
2395 <li class="index-item event"> |
|
2396 <a href="#event_load">load</a> |
|
2397 |
|
2398 |
|
2399 |
|
2400 </li> |
|
2401 |
|
2402 <li class="index-item event"> |
|
2403 <a href="#event_save">save</a> |
|
2404 |
|
2405 |
|
2406 |
|
2407 </li> |
|
2408 |
|
2409 </ul> |
|
2410 </div> |
|
2411 |
|
2412 </div> |
|
2413 |
|
2414 |
|
2415 <div id="methods" class="api-class-tabpanel"> |
|
2416 <h2 class="off-left">Methods</h2> |
|
2417 |
|
2418 |
|
2419 <div id="method__addAttrs" class="method item private inherited"> |
|
2420 <h3 class="name"><code>_addAttrs</code></h3> |
|
2421 |
|
2422 |
|
2423 <div class="args"> |
|
2424 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2425 |
|
2426 <li class="arg"> |
|
2427 |
|
2428 <code>cfgs</code> |
|
2429 |
|
2430 </li> |
|
2431 |
|
2432 <li class="arg"> |
|
2433 |
|
2434 <code>values</code> |
|
2435 |
|
2436 </li> |
|
2437 |
|
2438 <li class="arg"> |
|
2439 |
|
2440 <code>lazy</code> |
|
2441 |
|
2442 </li> |
|
2443 |
|
2444 </ul><span class="paren">)</span> |
|
2445 </div> |
|
2446 |
|
2447 |
|
2448 |
|
2449 |
|
2450 |
|
2451 |
|
2452 |
|
2453 <span class="flag private">private</span> |
|
2454 |
|
2455 |
|
2456 |
|
2457 |
|
2458 |
|
2459 |
|
2460 |
|
2461 |
|
2462 |
|
2463 |
|
2464 <div class="meta"> |
|
2465 |
|
2466 |
|
2467 <p>Inherited from |
|
2468 <a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>: |
|
2469 |
|
2470 |
|
2471 |
|
2472 <a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a> |
|
2473 |
|
2474 </p> |
|
2475 |
|
2476 |
|
2477 |
|
2478 |
|
2479 |
|
2480 </div> |
|
2481 |
|
2482 <div class="description"> |
|
2483 <p>Implementation behind the public addAttrs method.</p> |
|
2484 |
|
2485 <p>This method is invoked directly by get if it encounters a scenario |
|
2486 in which an attribute's valueFn attempts to obtain the |
|
2487 value an attribute in the same group of attributes, which has not yet |
|
2488 been added (on demand initialization).</p> |
|
2489 </div> |
|
2490 |
|
2491 |
|
2492 <div class="params"> |
|
2493 <h4>Parameters:</h4> |
|
2494 |
|
2495 <ul class="params-list"> |
|
2496 |
|
2497 <li class="param"> |
|
2498 |
|
2499 <code class="param-name">cfgs</code> |
|
2500 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2501 |
|
2502 |
|
2503 |
|
2504 |
|
2505 <div class="param-description"> |
|
2506 <p>An object with attribute name/configuration pairs.</p> |
|
2507 </div> |
|
2508 |
|
2509 |
|
2510 </li> |
|
2511 |
|
2512 <li class="param"> |
|
2513 |
|
2514 <code class="param-name">values</code> |
|
2515 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2516 |
|
2517 |
|
2518 |
|
2519 |
|
2520 <div class="param-description"> |
|
2521 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
2522 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
2523 </div> |
|
2524 |
|
2525 |
|
2526 </li> |
|
2527 |
|
2528 <li class="param"> |
|
2529 |
|
2530 <code class="param-name">lazy</code> |
|
2531 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
2532 |
|
2533 |
|
2534 |
|
2535 |
|
2536 <div class="param-description"> |
|
2537 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
2538 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
2539 See <a href="#method_addAttr">addAttr</a>.</p> |
|
2540 </div> |
|
2541 |
|
2542 |
|
2543 </li> |
|
2544 |
|
2545 </ul> |
|
2546 </div> |
|
2547 |
|
2548 |
|
2549 |
|
2550 |
|
2551 |
|
2552 </div> |
|
2553 |
|
2554 |
|
2555 <div id="method__addLazyAttr" class="method item private inherited"> |
|
2556 <h3 class="name"><code>_addLazyAttr</code></h3> |
|
2557 |
|
2558 |
|
2559 <div class="args"> |
|
2560 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2561 |
|
2562 <li class="arg"> |
|
2563 |
|
2564 <code>name</code> |
|
2565 |
|
2566 </li> |
|
2567 |
|
2568 <li class="arg"> |
|
2569 |
|
2570 <code class="optional">[lazyCfg]</code> |
|
2571 |
|
2572 </li> |
|
2573 |
|
2574 </ul><span class="paren">)</span> |
|
2575 </div> |
|
2576 |
|
2577 |
|
2578 |
|
2579 |
|
2580 |
|
2581 |
|
2582 |
|
2583 <span class="flag private">private</span> |
|
2584 |
|
2585 |
|
2586 |
|
2587 |
|
2588 |
|
2589 |
|
2590 |
|
2591 |
|
2592 |
|
2593 |
|
2594 <div class="meta"> |
|
2595 |
|
2596 |
|
2597 <p>Inherited from |
|
2598 <a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>: |
|
2599 |
|
2600 |
|
2601 |
|
2602 <a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a> |
|
2603 |
|
2604 </p> |
|
2605 |
|
2606 |
|
2607 |
|
2608 |
|
2609 |
|
2610 </div> |
|
2611 |
|
2612 <div class="description"> |
|
2613 <p>Finishes initializing an attribute which has been lazily added.</p> |
|
2614 </div> |
|
2615 |
|
2616 |
|
2617 <div class="params"> |
|
2618 <h4>Parameters:</h4> |
|
2619 |
|
2620 <ul class="params-list"> |
|
2621 |
|
2622 <li class="param"> |
|
2623 |
|
2624 <code class="param-name">name</code> |
|
2625 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2626 |
|
2627 |
|
2628 |
|
2629 |
|
2630 <div class="param-description"> |
|
2631 <p>The name of the attribute</p> |
|
2632 </div> |
|
2633 |
|
2634 |
|
2635 </li> |
|
2636 |
|
2637 <li class="param"> |
|
2638 |
|
2639 <code class="param-name optional">[lazyCfg]</code> |
|
2640 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2641 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
2642 |
|
2643 |
|
2644 |
|
2645 |
|
2646 <div class="param-description"> |
|
2647 <p>Optional config hash for the attribute. This is added for performance |
|
2648 along the critical path, where the calling method has already obtained lazy config from state.</p> |
|
2649 </div> |
|
2650 |
|
2651 |
|
2652 </li> |
|
2653 |
|
2654 </ul> |
|
2655 </div> |
|
2656 |
|
2657 |
|
2658 |
|
2659 |
|
2660 |
|
2661 </div> |
|
2662 |
|
2663 |
|
2664 <div id="method__aggregateAttrs" class="method item private inherited"> |
|
2665 <h3 class="name"><code>_aggregateAttrs</code></h3> |
|
2666 |
|
2667 |
|
2668 <div class="args"> |
|
2669 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2670 |
|
2671 <li class="arg"> |
|
2672 |
|
2673 <code>allAttrs</code> |
|
2674 |
|
2675 </li> |
|
2676 |
|
2677 </ul><span class="paren">)</span> |
|
2678 </div> |
|
2679 |
|
2680 |
|
2681 |
|
2682 <span class="returns-inline"> |
|
2683 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2684 </span> |
|
2685 |
|
2686 |
|
2687 |
|
2688 |
|
2689 |
|
2690 <span class="flag private">private</span> |
|
2691 |
|
2692 |
|
2693 |
|
2694 |
|
2695 |
|
2696 |
|
2697 |
|
2698 |
|
2699 |
|
2700 |
|
2701 <div class="meta"> |
|
2702 |
|
2703 |
|
2704 <p>Inherited from |
|
2705 <a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>: |
|
2706 |
|
2707 |
|
2708 |
|
2709 <a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a> |
|
2710 |
|
2711 </p> |
|
2712 |
|
2713 |
|
2714 |
|
2715 |
|
2716 |
|
2717 </div> |
|
2718 |
|
2719 <div class="description"> |
|
2720 <p>A helper method, used by _initHierarchyData to aggregate |
|
2721 attribute configuration across the instances class hierarchy.</p> |
|
2722 |
|
2723 <p>The method will protect the attribute configuration value to protect the statically defined |
|
2724 default value in ATTRS if required (if the value is an object literal, array or the |
|
2725 attribute configuration has cloneDefaultValue set to shallow or deep).</p> |
|
2726 </div> |
|
2727 |
|
2728 |
|
2729 <div class="params"> |
|
2730 <h4>Parameters:</h4> |
|
2731 |
|
2732 <ul class="params-list"> |
|
2733 |
|
2734 <li class="param"> |
|
2735 |
|
2736 <code class="param-name">allAttrs</code> |
|
2737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
2738 |
|
2739 |
|
2740 |
|
2741 |
|
2742 <div class="param-description"> |
|
2743 <p>An array of ATTRS definitions across classes in the hierarchy |
|
2744 (subclass first, Base last)</p> |
|
2745 </div> |
|
2746 |
|
2747 |
|
2748 </li> |
|
2749 |
|
2750 </ul> |
|
2751 </div> |
|
2752 |
|
2753 |
|
2754 |
|
2755 <div class="returns"> |
|
2756 <h4>Returns:</h4> |
|
2757 |
|
2758 <div class="returns-description"> |
|
2759 |
|
2760 |
|
2761 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
2762 |
|
2763 The aggregate set of ATTRS definitions for the instance |
|
2764 |
|
2765 </div> |
|
2766 </div> |
|
2767 |
|
2768 |
|
2769 |
|
2770 </div> |
|
2771 |
|
2772 |
|
2773 <div id="method__attrCfgHash" class="method item private inherited"> |
|
2774 <h3 class="name"><code>_attrCfgHash</code></h3> |
|
2775 |
|
2776 |
|
2777 <span class="paren">()</span> |
|
2778 |
|
2779 |
|
2780 |
|
2781 |
|
2782 |
|
2783 |
|
2784 |
|
2785 <span class="flag private">private</span> |
|
2786 |
|
2787 |
|
2788 |
|
2789 |
|
2790 |
|
2791 |
|
2792 |
|
2793 |
|
2794 |
|
2795 |
|
2796 <div class="meta"> |
|
2797 |
|
2798 |
|
2799 <p>Inherited from |
|
2800 <a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>: |
|
2801 |
|
2802 |
|
2803 |
|
2804 <a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a> |
|
2805 |
|
2806 </p> |
|
2807 |
|
2808 |
|
2809 |
|
2810 |
|
2811 |
|
2812 </div> |
|
2813 |
|
2814 <div class="description"> |
|
2815 <p>Utility method to define the attribute hash used to filter/whitelist property mixes for |
|
2816 this class for iteration performance reasons.</p> |
|
2817 </div> |
|
2818 |
|
2819 |
|
2820 |
|
2821 |
|
2822 |
|
2823 |
|
2824 </div> |
|
2825 |
|
2826 |
|
2827 <div id="method__baseDestroy" class="method item private inherited"> |
|
2828 <h3 class="name"><code>_baseDestroy</code></h3> |
|
2829 |
|
2830 |
|
2831 <span class="paren">()</span> |
|
2832 |
|
2833 |
|
2834 |
|
2835 |
|
2836 |
|
2837 |
|
2838 |
|
2839 <span class="flag private">private</span> |
|
2840 |
|
2841 |
|
2842 |
|
2843 |
|
2844 |
|
2845 |
|
2846 |
|
2847 |
|
2848 |
|
2849 |
|
2850 <div class="meta"> |
|
2851 |
|
2852 |
|
2853 <p>Inherited from |
|
2854 <a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>: |
|
2855 |
|
2856 |
|
2857 |
|
2858 <a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a> |
|
2859 |
|
2860 </p> |
|
2861 |
|
2862 |
|
2863 |
|
2864 |
|
2865 |
|
2866 </div> |
|
2867 |
|
2868 <div class="description"> |
|
2869 <p>Internal destroy implementation for BaseCore</p> |
|
2870 </div> |
|
2871 |
|
2872 |
|
2873 |
|
2874 |
|
2875 |
|
2876 |
|
2877 </div> |
|
2878 |
|
2879 |
|
2880 <div id="method__baseInit" class="method item private inherited"> |
|
2881 <h3 class="name"><code>_baseInit</code></h3> |
|
2882 |
|
2883 |
|
2884 <span class="paren">()</span> |
|
2885 |
|
2886 |
|
2887 |
|
2888 |
|
2889 |
|
2890 |
|
2891 |
|
2892 <span class="flag private">private</span> |
|
2893 |
|
2894 |
|
2895 |
|
2896 |
|
2897 |
|
2898 |
|
2899 |
|
2900 |
|
2901 |
|
2902 |
|
2903 <div class="meta"> |
|
2904 |
|
2905 |
|
2906 <p>Inherited from |
|
2907 <a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>: |
|
2908 |
|
2909 |
|
2910 |
|
2911 <a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a> |
|
2912 |
|
2913 </p> |
|
2914 |
|
2915 |
|
2916 |
|
2917 |
|
2918 |
|
2919 </div> |
|
2920 |
|
2921 <div class="description"> |
|
2922 <p>Internal initialization implementation for BaseCore</p> |
|
2923 </div> |
|
2924 |
|
2925 |
|
2926 |
|
2927 |
|
2928 |
|
2929 |
|
2930 </div> |
|
2931 |
|
2932 |
|
2933 <div id="method__cloneDefaultValue" class="method item private inherited"> |
|
2934 <h3 class="name"><code>_cloneDefaultValue</code></h3> |
|
2935 |
|
2936 |
|
2937 <div class="args"> |
|
2938 <span class="paren">(</span><ul class="args-list inline commas"> |
|
2939 |
|
2940 <li class="arg"> |
|
2941 |
|
2942 <code>cfg</code> |
|
2943 |
|
2944 </li> |
|
2945 |
|
2946 </ul><span class="paren">)</span> |
|
2947 </div> |
|
2948 |
|
2949 |
|
2950 |
|
2951 |
|
2952 |
|
2953 |
|
2954 |
|
2955 <span class="flag private">private</span> |
|
2956 |
|
2957 |
|
2958 |
|
2959 |
|
2960 |
|
2961 |
|
2962 |
|
2963 |
|
2964 |
|
2965 |
|
2966 <div class="meta"> |
|
2967 |
|
2968 |
|
2969 <p>Inherited from |
|
2970 <a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>: |
|
2971 |
|
2972 |
|
2973 |
|
2974 <a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a> |
|
2975 |
|
2976 </p> |
|
2977 |
|
2978 |
|
2979 |
|
2980 |
|
2981 |
|
2982 </div> |
|
2983 |
|
2984 <div class="description"> |
|
2985 <p>This method assumes that the value has already been checked to be an object. |
|
2986 Since it's on a critical path, we don't want to re-do the check.</p> |
|
2987 </div> |
|
2988 |
|
2989 |
|
2990 <div class="params"> |
|
2991 <h4>Parameters:</h4> |
|
2992 |
|
2993 <ul class="params-list"> |
|
2994 |
|
2995 <li class="param"> |
|
2996 |
|
2997 <code class="param-name">cfg</code> |
|
2998 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
2999 |
|
3000 |
|
3001 |
|
3002 |
|
3003 <div class="param-description"> |
|
3004 |
|
3005 </div> |
|
3006 |
|
3007 |
|
3008 </li> |
|
3009 |
|
3010 </ul> |
|
3011 </div> |
|
3012 |
|
3013 |
|
3014 |
|
3015 |
|
3016 |
|
3017 </div> |
|
3018 |
|
3019 |
|
3020 <div id="method__defAttrChangeFn" class="method item protected"> |
|
3021 <h3 class="name"><code>_defAttrChangeFn</code></h3> |
|
3022 |
|
3023 |
|
3024 <div class="args"> |
|
3025 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3026 |
|
3027 <li class="arg"> |
|
3028 |
|
3029 <code>e</code> |
|
3030 |
|
3031 </li> |
|
3032 |
|
3033 </ul><span class="paren">)</span> |
|
3034 </div> |
|
3035 |
|
3036 |
|
3037 |
|
3038 |
|
3039 |
|
3040 |
|
3041 |
|
3042 <span class="flag protected">protected</span> |
|
3043 |
|
3044 |
|
3045 |
|
3046 |
|
3047 |
|
3048 |
|
3049 |
|
3050 |
|
3051 |
|
3052 |
|
3053 <div class="meta"> |
|
3054 |
|
3055 <p>Inherited from |
|
3056 <a href="../classes/AttributeObservable.html#method__defAttrChangeFn"> |
|
3057 AttributeObservable |
|
3058 </a> |
|
3059 |
|
3060 but overwritten in |
|
3061 |
|
3062 |
|
3063 |
|
3064 <a href="../files/app_js_model.js.html#l926"><code>app/js/model.js:926</code></a> |
|
3065 |
|
3066 </p> |
|
3067 |
|
3068 |
|
3069 |
|
3070 |
|
3071 |
|
3072 </div> |
|
3073 |
|
3074 <div class="description"> |
|
3075 <p>Duckpunches the <code>_defAttrChangeFn()</code> provided by <code>Y.Attribute</code> so we can |
|
3076 have a single global notification when a change event occurs.</p> |
|
3077 </div> |
|
3078 |
|
3079 |
|
3080 <div class="params"> |
|
3081 <h4>Parameters:</h4> |
|
3082 |
|
3083 <ul class="params-list"> |
|
3084 |
|
3085 <li class="param"> |
|
3086 |
|
3087 <code class="param-name">e</code> |
|
3088 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3089 |
|
3090 |
|
3091 |
|
3092 |
|
3093 <div class="param-description"> |
|
3094 |
|
3095 </div> |
|
3096 |
|
3097 |
|
3098 </li> |
|
3099 |
|
3100 </ul> |
|
3101 </div> |
|
3102 |
|
3103 |
|
3104 |
|
3105 |
|
3106 |
|
3107 </div> |
|
3108 |
|
3109 |
|
3110 <div id="method__defDestroyFn" class="method item protected inherited"> |
|
3111 <h3 class="name"><code>_defDestroyFn</code></h3> |
|
3112 |
|
3113 |
|
3114 <div class="args"> |
|
3115 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3116 |
|
3117 <li class="arg"> |
|
3118 |
|
3119 <code>e</code> |
|
3120 |
|
3121 </li> |
|
3122 |
|
3123 </ul><span class="paren">)</span> |
|
3124 </div> |
|
3125 |
|
3126 |
|
3127 |
|
3128 |
|
3129 |
|
3130 |
|
3131 |
|
3132 <span class="flag protected">protected</span> |
|
3133 |
|
3134 |
|
3135 |
|
3136 |
|
3137 |
|
3138 |
|
3139 |
|
3140 |
|
3141 |
|
3142 |
|
3143 <div class="meta"> |
|
3144 |
|
3145 |
|
3146 <p>Inherited from |
|
3147 <a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>: |
|
3148 |
|
3149 |
|
3150 |
|
3151 <a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a> |
|
3152 |
|
3153 </p> |
|
3154 |
|
3155 |
|
3156 |
|
3157 |
|
3158 |
|
3159 </div> |
|
3160 |
|
3161 <div class="description"> |
|
3162 <p>Default destroy event handler</p> |
|
3163 </div> |
|
3164 |
|
3165 |
|
3166 <div class="params"> |
|
3167 <h4>Parameters:</h4> |
|
3168 |
|
3169 <ul class="params-list"> |
|
3170 |
|
3171 <li class="param"> |
|
3172 |
|
3173 <code class="param-name">e</code> |
|
3174 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3175 |
|
3176 |
|
3177 |
|
3178 |
|
3179 <div class="param-description"> |
|
3180 <p>Event object</p> |
|
3181 </div> |
|
3182 |
|
3183 |
|
3184 </li> |
|
3185 |
|
3186 </ul> |
|
3187 </div> |
|
3188 |
|
3189 |
|
3190 |
|
3191 |
|
3192 |
|
3193 </div> |
|
3194 |
|
3195 |
|
3196 <div id="method__defInitFn" class="method item protected inherited"> |
|
3197 <h3 class="name"><code>_defInitFn</code></h3> |
|
3198 |
|
3199 |
|
3200 <div class="args"> |
|
3201 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3202 |
|
3203 <li class="arg"> |
|
3204 |
|
3205 <code>e</code> |
|
3206 |
|
3207 </li> |
|
3208 |
|
3209 </ul><span class="paren">)</span> |
|
3210 </div> |
|
3211 |
|
3212 |
|
3213 |
|
3214 |
|
3215 |
|
3216 |
|
3217 |
|
3218 <span class="flag protected">protected</span> |
|
3219 |
|
3220 |
|
3221 |
|
3222 |
|
3223 |
|
3224 |
|
3225 |
|
3226 |
|
3227 |
|
3228 |
|
3229 <div class="meta"> |
|
3230 |
|
3231 |
|
3232 <p>Inherited from |
|
3233 <a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>: |
|
3234 |
|
3235 |
|
3236 |
|
3237 <a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a> |
|
3238 |
|
3239 </p> |
|
3240 |
|
3241 |
|
3242 |
|
3243 |
|
3244 |
|
3245 </div> |
|
3246 |
|
3247 <div class="description"> |
|
3248 <p>Default init event handler</p> |
|
3249 </div> |
|
3250 |
|
3251 |
|
3252 <div class="params"> |
|
3253 <h4>Parameters:</h4> |
|
3254 |
|
3255 <ul class="params-list"> |
|
3256 |
|
3257 <li class="param"> |
|
3258 |
|
3259 <code class="param-name">e</code> |
|
3260 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
3261 |
|
3262 |
|
3263 |
|
3264 |
|
3265 <div class="param-description"> |
|
3266 <p>Event object, with a cfg property which |
|
3267 refers to the configuration object passed to the constructor.</p> |
|
3268 </div> |
|
3269 |
|
3270 |
|
3271 </li> |
|
3272 |
|
3273 </ul> |
|
3274 </div> |
|
3275 |
|
3276 |
|
3277 |
|
3278 |
|
3279 |
|
3280 </div> |
|
3281 |
|
3282 |
|
3283 <div id="method__destroyHierarchy" class="method item private inherited"> |
|
3284 <h3 class="name"><code>_destroyHierarchy</code></h3> |
|
3285 |
|
3286 |
|
3287 <span class="paren">()</span> |
|
3288 |
|
3289 |
|
3290 |
|
3291 |
|
3292 |
|
3293 |
|
3294 |
|
3295 <span class="flag private">private</span> |
|
3296 |
|
3297 |
|
3298 |
|
3299 |
|
3300 |
|
3301 |
|
3302 |
|
3303 |
|
3304 |
|
3305 |
|
3306 <div class="meta"> |
|
3307 |
|
3308 |
|
3309 <p>Inherited from |
|
3310 <a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>: |
|
3311 |
|
3312 |
|
3313 |
|
3314 <a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a> |
|
3315 |
|
3316 </p> |
|
3317 |
|
3318 |
|
3319 |
|
3320 |
|
3321 |
|
3322 </div> |
|
3323 |
|
3324 <div class="description"> |
|
3325 <p>Destroys the class hierarchy for this instance by invoking |
|
3326 the destructor method on the prototype of each class in the hierarchy.</p> |
|
3327 </div> |
|
3328 |
|
3329 |
|
3330 |
|
3331 |
|
3332 |
|
3333 |
|
3334 </div> |
|
3335 |
|
3336 |
|
3337 <div id="method__filterAdHocAttrs" class="method item private inherited"> |
|
3338 <h3 class="name"><code>_filterAdHocAttrs</code></h3> |
|
3339 |
|
3340 |
|
3341 <div class="args"> |
|
3342 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3343 |
|
3344 <li class="arg"> |
|
3345 |
|
3346 <code>allAttrs</code> |
|
3347 |
|
3348 </li> |
|
3349 |
|
3350 <li class="arg"> |
|
3351 |
|
3352 <code>userVals</code> |
|
3353 |
|
3354 </li> |
|
3355 |
|
3356 </ul><span class="paren">)</span> |
|
3357 </div> |
|
3358 |
|
3359 |
|
3360 |
|
3361 <span class="returns-inline"> |
|
3362 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3363 </span> |
|
3364 |
|
3365 |
|
3366 |
|
3367 |
|
3368 |
|
3369 <span class="flag private">private</span> |
|
3370 |
|
3371 |
|
3372 |
|
3373 |
|
3374 |
|
3375 |
|
3376 |
|
3377 |
|
3378 |
|
3379 |
|
3380 <div class="meta"> |
|
3381 |
|
3382 |
|
3383 <p>Inherited from |
|
3384 <a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>: |
|
3385 |
|
3386 |
|
3387 |
|
3388 <a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a> |
|
3389 |
|
3390 </p> |
|
3391 |
|
3392 |
|
3393 |
|
3394 |
|
3395 |
|
3396 </div> |
|
3397 |
|
3398 <div class="description"> |
|
3399 |
|
3400 </div> |
|
3401 |
|
3402 |
|
3403 <div class="params"> |
|
3404 <h4>Parameters:</h4> |
|
3405 |
|
3406 <ul class="params-list"> |
|
3407 |
|
3408 <li class="param"> |
|
3409 |
|
3410 <code class="param-name">allAttrs</code> |
|
3411 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3412 |
|
3413 |
|
3414 |
|
3415 |
|
3416 <div class="param-description"> |
|
3417 <p>The set of all attribute configurations for this instance. |
|
3418 Attributes will be removed from this set, if they belong to the filtered class, so |
|
3419 that by the time all classes are processed, allCfgs will be empty.</p> |
|
3420 </div> |
|
3421 |
|
3422 |
|
3423 </li> |
|
3424 |
|
3425 <li class="param"> |
|
3426 |
|
3427 <code class="param-name">userVals</code> |
|
3428 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3429 |
|
3430 |
|
3431 |
|
3432 |
|
3433 <div class="param-description"> |
|
3434 <p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p> |
|
3435 </div> |
|
3436 |
|
3437 |
|
3438 </li> |
|
3439 |
|
3440 </ul> |
|
3441 </div> |
|
3442 |
|
3443 |
|
3444 |
|
3445 <div class="returns"> |
|
3446 <h4>Returns:</h4> |
|
3447 |
|
3448 <div class="returns-description"> |
|
3449 |
|
3450 |
|
3451 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
3452 |
|
3453 The set of adhoc attributes passed in, in the form |
|
3454 of an object with attribute name/configuration pairs. |
|
3455 |
|
3456 </div> |
|
3457 </div> |
|
3458 |
|
3459 |
|
3460 |
|
3461 </div> |
|
3462 |
|
3463 |
|
3464 <div id="method__filterAttrCfgs" class="method item private inherited"> |
|
3465 <h3 class="name"><code>_filterAttrCfgs</code></h3> |
|
3466 |
|
3467 |
|
3468 <div class="args"> |
|
3469 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3470 |
|
3471 <li class="arg"> |
|
3472 |
|
3473 <code>clazz</code> |
|
3474 |
|
3475 </li> |
|
3476 |
|
3477 <li class="arg"> |
|
3478 |
|
3479 <code>allCfgs</code> |
|
3480 |
|
3481 </li> |
|
3482 |
|
3483 </ul><span class="paren">)</span> |
|
3484 </div> |
|
3485 |
|
3486 |
|
3487 |
|
3488 <span class="returns-inline"> |
|
3489 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3490 </span> |
|
3491 |
|
3492 |
|
3493 |
|
3494 |
|
3495 |
|
3496 <span class="flag private">private</span> |
|
3497 |
|
3498 |
|
3499 |
|
3500 |
|
3501 |
|
3502 |
|
3503 |
|
3504 |
|
3505 |
|
3506 |
|
3507 <div class="meta"> |
|
3508 |
|
3509 |
|
3510 <p>Inherited from |
|
3511 <a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>: |
|
3512 |
|
3513 |
|
3514 |
|
3515 <a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a> |
|
3516 |
|
3517 </p> |
|
3518 |
|
3519 |
|
3520 |
|
3521 |
|
3522 |
|
3523 </div> |
|
3524 |
|
3525 <div class="description"> |
|
3526 <p>A helper method used when processing ATTRS across the class hierarchy during |
|
3527 initialization. Returns a disposable object with the attributes defined for |
|
3528 the provided class, extracted from the set of all attributes passed in.</p> |
|
3529 </div> |
|
3530 |
|
3531 |
|
3532 <div class="params"> |
|
3533 <h4>Parameters:</h4> |
|
3534 |
|
3535 <ul class="params-list"> |
|
3536 |
|
3537 <li class="param"> |
|
3538 |
|
3539 <code class="param-name">clazz</code> |
|
3540 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
3541 |
|
3542 |
|
3543 |
|
3544 |
|
3545 <div class="param-description"> |
|
3546 <p>The class for which the desired attributes are required.</p> |
|
3547 </div> |
|
3548 |
|
3549 |
|
3550 </li> |
|
3551 |
|
3552 <li class="param"> |
|
3553 |
|
3554 <code class="param-name">allCfgs</code> |
|
3555 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3556 |
|
3557 |
|
3558 |
|
3559 |
|
3560 <div class="param-description"> |
|
3561 <p>The set of all attribute configurations for this instance. |
|
3562 Attributes will be removed from this set, if they belong to the filtered class, so |
|
3563 that by the time all classes are processed, allCfgs will be empty.</p> |
|
3564 </div> |
|
3565 |
|
3566 |
|
3567 </li> |
|
3568 |
|
3569 </ul> |
|
3570 </div> |
|
3571 |
|
3572 |
|
3573 |
|
3574 <div class="returns"> |
|
3575 <h4>Returns:</h4> |
|
3576 |
|
3577 <div class="returns-description"> |
|
3578 |
|
3579 |
|
3580 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
3581 |
|
3582 The set of attributes belonging to the class passed in, in the form |
|
3583 of an object with attribute name/configuration pairs. |
|
3584 |
|
3585 </div> |
|
3586 </div> |
|
3587 |
|
3588 |
|
3589 |
|
3590 </div> |
|
3591 |
|
3592 |
|
3593 <div id="method__fireAttrChange" class="method item private inherited"> |
|
3594 <h3 class="name"><code>_fireAttrChange</code></h3> |
|
3595 |
|
3596 |
|
3597 <div class="args"> |
|
3598 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3599 |
|
3600 <li class="arg"> |
|
3601 |
|
3602 <code>attrName</code> |
|
3603 |
|
3604 </li> |
|
3605 |
|
3606 <li class="arg"> |
|
3607 |
|
3608 <code>subAttrName</code> |
|
3609 |
|
3610 </li> |
|
3611 |
|
3612 <li class="arg"> |
|
3613 |
|
3614 <code>currVal</code> |
|
3615 |
|
3616 </li> |
|
3617 |
|
3618 <li class="arg"> |
|
3619 |
|
3620 <code>newVal</code> |
|
3621 |
|
3622 </li> |
|
3623 |
|
3624 <li class="arg"> |
|
3625 |
|
3626 <code>opts</code> |
|
3627 |
|
3628 </li> |
|
3629 |
|
3630 <li class="arg"> |
|
3631 |
|
3632 <code class="optional">[cfg]</code> |
|
3633 |
|
3634 </li> |
|
3635 |
|
3636 </ul><span class="paren">)</span> |
|
3637 </div> |
|
3638 |
|
3639 |
|
3640 |
|
3641 |
|
3642 |
|
3643 |
|
3644 |
|
3645 <span class="flag private">private</span> |
|
3646 |
|
3647 |
|
3648 |
|
3649 |
|
3650 |
|
3651 |
|
3652 |
|
3653 |
|
3654 |
|
3655 |
|
3656 <div class="meta"> |
|
3657 |
|
3658 |
|
3659 <p>Inherited from |
|
3660 <a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>: |
|
3661 |
|
3662 |
|
3663 |
|
3664 <a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a> |
|
3665 |
|
3666 </p> |
|
3667 |
|
3668 |
|
3669 |
|
3670 |
|
3671 |
|
3672 </div> |
|
3673 |
|
3674 <div class="description"> |
|
3675 <p>Utility method to help setup the event payload and fire the attribute change event.</p> |
|
3676 </div> |
|
3677 |
|
3678 |
|
3679 <div class="params"> |
|
3680 <h4>Parameters:</h4> |
|
3681 |
|
3682 <ul class="params-list"> |
|
3683 |
|
3684 <li class="param"> |
|
3685 |
|
3686 <code class="param-name">attrName</code> |
|
3687 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3688 |
|
3689 |
|
3690 |
|
3691 |
|
3692 <div class="param-description"> |
|
3693 <p>The name of the attribute</p> |
|
3694 </div> |
|
3695 |
|
3696 |
|
3697 </li> |
|
3698 |
|
3699 <li class="param"> |
|
3700 |
|
3701 <code class="param-name">subAttrName</code> |
|
3702 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3703 |
|
3704 |
|
3705 |
|
3706 |
|
3707 <div class="param-description"> |
|
3708 <p>The full path of the property being changed, |
|
3709 if this is a sub-attribute value being change. Otherwise null.</p> |
|
3710 </div> |
|
3711 |
|
3712 |
|
3713 </li> |
|
3714 |
|
3715 <li class="param"> |
|
3716 |
|
3717 <code class="param-name">currVal</code> |
|
3718 <span class="type">Any</span> |
|
3719 |
|
3720 |
|
3721 |
|
3722 |
|
3723 <div class="param-description"> |
|
3724 <p>The current value of the attribute</p> |
|
3725 </div> |
|
3726 |
|
3727 |
|
3728 </li> |
|
3729 |
|
3730 <li class="param"> |
|
3731 |
|
3732 <code class="param-name">newVal</code> |
|
3733 <span class="type">Any</span> |
|
3734 |
|
3735 |
|
3736 |
|
3737 |
|
3738 <div class="param-description"> |
|
3739 <p>The new value of the attribute</p> |
|
3740 </div> |
|
3741 |
|
3742 |
|
3743 </li> |
|
3744 |
|
3745 <li class="param"> |
|
3746 |
|
3747 <code class="param-name">opts</code> |
|
3748 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3749 |
|
3750 |
|
3751 |
|
3752 |
|
3753 <div class="param-description"> |
|
3754 <p>Any additional event data to mix into the attribute change event's event facade.</p> |
|
3755 </div> |
|
3756 |
|
3757 |
|
3758 </li> |
|
3759 |
|
3760 <li class="param"> |
|
3761 |
|
3762 <code class="param-name optional">[cfg]</code> |
|
3763 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3764 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
3765 |
|
3766 |
|
3767 |
|
3768 |
|
3769 <div class="param-description"> |
|
3770 <p>The attribute config stored in State, if already available.</p> |
|
3771 </div> |
|
3772 |
|
3773 |
|
3774 </li> |
|
3775 |
|
3776 </ul> |
|
3777 </div> |
|
3778 |
|
3779 |
|
3780 |
|
3781 |
|
3782 |
|
3783 </div> |
|
3784 |
|
3785 |
|
3786 <div id="method__getAttr" class="method item protected inherited"> |
|
3787 <h3 class="name"><code>_getAttr</code></h3> |
|
3788 |
|
3789 |
|
3790 <div class="args"> |
|
3791 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3792 |
|
3793 <li class="arg"> |
|
3794 |
|
3795 <code>name</code> |
|
3796 |
|
3797 </li> |
|
3798 |
|
3799 </ul><span class="paren">)</span> |
|
3800 </div> |
|
3801 |
|
3802 |
|
3803 |
|
3804 <span class="returns-inline"> |
|
3805 <span class="type">Any</span> |
|
3806 </span> |
|
3807 |
|
3808 |
|
3809 |
|
3810 |
|
3811 |
|
3812 <span class="flag protected">protected</span> |
|
3813 |
|
3814 |
|
3815 |
|
3816 |
|
3817 |
|
3818 |
|
3819 |
|
3820 <span class="flag chainable">chainable</span> |
|
3821 |
|
3822 |
|
3823 |
|
3824 |
|
3825 <div class="meta"> |
|
3826 |
|
3827 |
|
3828 <p>Inherited from |
|
3829 <a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>: |
|
3830 |
|
3831 |
|
3832 |
|
3833 <a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a> |
|
3834 |
|
3835 </p> |
|
3836 |
|
3837 |
|
3838 |
|
3839 |
|
3840 |
|
3841 </div> |
|
3842 |
|
3843 <div class="description"> |
|
3844 <p>Provides the common implementation for the public get method, |
|
3845 allowing Attribute hosts to over-ride either method.</p> |
|
3846 |
|
3847 <p>See <a href="#method_get">get</a> for argument details.</p> |
|
3848 </div> |
|
3849 |
|
3850 |
|
3851 <div class="params"> |
|
3852 <h4>Parameters:</h4> |
|
3853 |
|
3854 <ul class="params-list"> |
|
3855 |
|
3856 <li class="param"> |
|
3857 |
|
3858 <code class="param-name">name</code> |
|
3859 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3860 |
|
3861 |
|
3862 |
|
3863 |
|
3864 <div class="param-description"> |
|
3865 <p>The name of the attribute.</p> |
|
3866 </div> |
|
3867 |
|
3868 |
|
3869 </li> |
|
3870 |
|
3871 </ul> |
|
3872 </div> |
|
3873 |
|
3874 |
|
3875 |
|
3876 <div class="returns"> |
|
3877 <h4>Returns:</h4> |
|
3878 |
|
3879 <div class="returns-description"> |
|
3880 |
|
3881 |
|
3882 <span class="type">Any</span>: |
|
3883 |
|
3884 The value of the attribute. |
|
3885 |
|
3886 </div> |
|
3887 </div> |
|
3888 |
|
3889 |
|
3890 |
|
3891 </div> |
|
3892 |
|
3893 |
|
3894 <div id="method__getAttrCfg" class="method item protected inherited"> |
|
3895 <h3 class="name"><code>_getAttrCfg</code></h3> |
|
3896 |
|
3897 |
|
3898 <div class="args"> |
|
3899 <span class="paren">(</span><ul class="args-list inline commas"> |
|
3900 |
|
3901 <li class="arg"> |
|
3902 |
|
3903 <code>name</code> |
|
3904 |
|
3905 </li> |
|
3906 |
|
3907 </ul><span class="paren">)</span> |
|
3908 </div> |
|
3909 |
|
3910 |
|
3911 |
|
3912 <span class="returns-inline"> |
|
3913 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
3914 </span> |
|
3915 |
|
3916 |
|
3917 |
|
3918 |
|
3919 |
|
3920 <span class="flag protected">protected</span> |
|
3921 |
|
3922 |
|
3923 |
|
3924 |
|
3925 |
|
3926 |
|
3927 |
|
3928 |
|
3929 |
|
3930 |
|
3931 <div class="meta"> |
|
3932 |
|
3933 |
|
3934 <p>Inherited from |
|
3935 <a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>: |
|
3936 |
|
3937 |
|
3938 |
|
3939 <a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a> |
|
3940 |
|
3941 </p> |
|
3942 |
|
3943 |
|
3944 |
|
3945 |
|
3946 |
|
3947 </div> |
|
3948 |
|
3949 <div class="description"> |
|
3950 <p>Returns an object with the configuration properties (and value) |
|
3951 for the given attribute. If attrName is not provided, returns the |
|
3952 configuration properties for all attributes.</p> |
|
3953 </div> |
|
3954 |
|
3955 |
|
3956 <div class="params"> |
|
3957 <h4>Parameters:</h4> |
|
3958 |
|
3959 <ul class="params-list"> |
|
3960 |
|
3961 <li class="param"> |
|
3962 |
|
3963 <code class="param-name">name</code> |
|
3964 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
3965 |
|
3966 |
|
3967 |
|
3968 |
|
3969 <div class="param-description"> |
|
3970 <p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p> |
|
3971 </div> |
|
3972 |
|
3973 |
|
3974 </li> |
|
3975 |
|
3976 </ul> |
|
3977 </div> |
|
3978 |
|
3979 |
|
3980 |
|
3981 <div class="returns"> |
|
3982 <h4>Returns:</h4> |
|
3983 |
|
3984 <div class="returns-description"> |
|
3985 |
|
3986 |
|
3987 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
3988 |
|
3989 The configuration properties for the given attribute, or all attributes. |
|
3990 |
|
3991 </div> |
|
3992 </div> |
|
3993 |
|
3994 |
|
3995 |
|
3996 </div> |
|
3997 |
|
3998 |
|
3999 <div id="method__getAttrCfgs" class="method item protected inherited"> |
|
4000 <h3 class="name"><code>_getAttrCfgs</code></h3> |
|
4001 |
|
4002 |
|
4003 <span class="paren">()</span> |
|
4004 |
|
4005 |
|
4006 |
|
4007 <span class="returns-inline"> |
|
4008 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4009 </span> |
|
4010 |
|
4011 |
|
4012 |
|
4013 |
|
4014 |
|
4015 <span class="flag protected">protected</span> |
|
4016 |
|
4017 |
|
4018 |
|
4019 |
|
4020 |
|
4021 |
|
4022 |
|
4023 |
|
4024 |
|
4025 |
|
4026 <div class="meta"> |
|
4027 |
|
4028 |
|
4029 <p>Inherited from |
|
4030 <a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>: |
|
4031 |
|
4032 |
|
4033 |
|
4034 <a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a> |
|
4035 |
|
4036 </p> |
|
4037 |
|
4038 |
|
4039 |
|
4040 |
|
4041 |
|
4042 </div> |
|
4043 |
|
4044 <div class="description"> |
|
4045 <p>Returns an aggregated set of attribute configurations, by traversing |
|
4046 the class hierarchy.</p> |
|
4047 </div> |
|
4048 |
|
4049 |
|
4050 |
|
4051 |
|
4052 <div class="returns"> |
|
4053 <h4>Returns:</h4> |
|
4054 |
|
4055 <div class="returns-description"> |
|
4056 |
|
4057 |
|
4058 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
4059 |
|
4060 The hash of attribute configurations, aggregated across classes in the hierarchy |
|
4061 This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return |
|
4062 the cached value. |
|
4063 |
|
4064 </div> |
|
4065 </div> |
|
4066 |
|
4067 |
|
4068 |
|
4069 </div> |
|
4070 |
|
4071 |
|
4072 <div id="method__getAttrInitVal" class="method item private inherited"> |
|
4073 <h3 class="name"><code>_getAttrInitVal</code></h3> |
|
4074 |
|
4075 |
|
4076 <div class="args"> |
|
4077 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4078 |
|
4079 <li class="arg"> |
|
4080 |
|
4081 <code>attr</code> |
|
4082 |
|
4083 </li> |
|
4084 |
|
4085 <li class="arg"> |
|
4086 |
|
4087 <code>cfg</code> |
|
4088 |
|
4089 </li> |
|
4090 |
|
4091 <li class="arg"> |
|
4092 |
|
4093 <code>initValues</code> |
|
4094 |
|
4095 </li> |
|
4096 |
|
4097 </ul><span class="paren">)</span> |
|
4098 </div> |
|
4099 |
|
4100 |
|
4101 |
|
4102 <span class="returns-inline"> |
|
4103 <span class="type">Any</span> |
|
4104 </span> |
|
4105 |
|
4106 |
|
4107 |
|
4108 |
|
4109 |
|
4110 <span class="flag private">private</span> |
|
4111 |
|
4112 |
|
4113 |
|
4114 |
|
4115 |
|
4116 |
|
4117 |
|
4118 |
|
4119 |
|
4120 |
|
4121 <div class="meta"> |
|
4122 |
|
4123 |
|
4124 <p>Inherited from |
|
4125 <a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>: |
|
4126 |
|
4127 |
|
4128 |
|
4129 <a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a> |
|
4130 |
|
4131 </p> |
|
4132 |
|
4133 |
|
4134 |
|
4135 |
|
4136 |
|
4137 </div> |
|
4138 |
|
4139 <div class="description"> |
|
4140 <p>Returns the initial value of the given attribute from |
|
4141 either the default configuration provided, or the |
|
4142 over-ridden value if it exists in the set of initValues |
|
4143 provided and the attribute is not read-only.</p> |
|
4144 </div> |
|
4145 |
|
4146 |
|
4147 <div class="params"> |
|
4148 <h4>Parameters:</h4> |
|
4149 |
|
4150 <ul class="params-list"> |
|
4151 |
|
4152 <li class="param"> |
|
4153 |
|
4154 <code class="param-name">attr</code> |
|
4155 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4156 |
|
4157 |
|
4158 |
|
4159 |
|
4160 <div class="param-description"> |
|
4161 <p>The name of the attribute</p> |
|
4162 </div> |
|
4163 |
|
4164 |
|
4165 </li> |
|
4166 |
|
4167 <li class="param"> |
|
4168 |
|
4169 <code class="param-name">cfg</code> |
|
4170 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4171 |
|
4172 |
|
4173 |
|
4174 |
|
4175 <div class="param-description"> |
|
4176 <p>The attribute configuration object</p> |
|
4177 </div> |
|
4178 |
|
4179 |
|
4180 </li> |
|
4181 |
|
4182 <li class="param"> |
|
4183 |
|
4184 <code class="param-name">initValues</code> |
|
4185 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4186 |
|
4187 |
|
4188 |
|
4189 |
|
4190 <div class="param-description"> |
|
4191 <p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p> |
|
4192 </div> |
|
4193 |
|
4194 |
|
4195 </li> |
|
4196 |
|
4197 </ul> |
|
4198 </div> |
|
4199 |
|
4200 |
|
4201 |
|
4202 <div class="returns"> |
|
4203 <h4>Returns:</h4> |
|
4204 |
|
4205 <div class="returns-description"> |
|
4206 |
|
4207 |
|
4208 <span class="type">Any</span>: |
|
4209 |
|
4210 The initial value of the attribute. |
|
4211 |
|
4212 </div> |
|
4213 </div> |
|
4214 |
|
4215 |
|
4216 |
|
4217 </div> |
|
4218 |
|
4219 |
|
4220 <div id="method__getAttrs" class="method item protected inherited"> |
|
4221 <h3 class="name"><code>_getAttrs</code></h3> |
|
4222 |
|
4223 |
|
4224 <div class="args"> |
|
4225 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4226 |
|
4227 <li class="arg"> |
|
4228 |
|
4229 <code>attrs</code> |
|
4230 |
|
4231 </li> |
|
4232 |
|
4233 </ul><span class="paren">)</span> |
|
4234 </div> |
|
4235 |
|
4236 |
|
4237 |
|
4238 <span class="returns-inline"> |
|
4239 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4240 </span> |
|
4241 |
|
4242 |
|
4243 |
|
4244 |
|
4245 |
|
4246 <span class="flag protected">protected</span> |
|
4247 |
|
4248 |
|
4249 |
|
4250 |
|
4251 |
|
4252 |
|
4253 |
|
4254 |
|
4255 |
|
4256 |
|
4257 <div class="meta"> |
|
4258 |
|
4259 |
|
4260 <p>Inherited from |
|
4261 <a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>: |
|
4262 |
|
4263 |
|
4264 |
|
4265 <a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a> |
|
4266 |
|
4267 </p> |
|
4268 |
|
4269 |
|
4270 |
|
4271 |
|
4272 |
|
4273 </div> |
|
4274 |
|
4275 <div class="description"> |
|
4276 <p>Implementation behind the public getAttrs method, to get multiple attribute values.</p> |
|
4277 </div> |
|
4278 |
|
4279 |
|
4280 <div class="params"> |
|
4281 <h4>Parameters:</h4> |
|
4282 |
|
4283 <ul class="params-list"> |
|
4284 |
|
4285 <li class="param"> |
|
4286 |
|
4287 <code class="param-name">attrs</code> |
|
4288 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
4289 |
|
4290 |
|
4291 |
|
4292 |
|
4293 <div class="param-description"> |
|
4294 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
4295 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
4296 </div> |
|
4297 |
|
4298 |
|
4299 </li> |
|
4300 |
|
4301 </ul> |
|
4302 </div> |
|
4303 |
|
4304 |
|
4305 |
|
4306 <div class="returns"> |
|
4307 <h4>Returns:</h4> |
|
4308 |
|
4309 <div class="returns-description"> |
|
4310 |
|
4311 |
|
4312 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
4313 |
|
4314 An object with attribute name/value pairs. |
|
4315 |
|
4316 </div> |
|
4317 </div> |
|
4318 |
|
4319 |
|
4320 |
|
4321 </div> |
|
4322 |
|
4323 |
|
4324 <div id="method__getClasses" class="method item protected inherited"> |
|
4325 <h3 class="name"><code>_getClasses</code></h3> |
|
4326 |
|
4327 |
|
4328 <span class="paren">()</span> |
|
4329 |
|
4330 |
|
4331 |
|
4332 <span class="returns-inline"> |
|
4333 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span> |
|
4334 </span> |
|
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/BaseCore.html#method__getClasses">BaseCore</a>: |
|
4356 |
|
4357 |
|
4358 |
|
4359 <a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a> |
|
4360 |
|
4361 </p> |
|
4362 |
|
4363 |
|
4364 |
|
4365 |
|
4366 |
|
4367 </div> |
|
4368 |
|
4369 <div class="description"> |
|
4370 <p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p> |
|
4371 </div> |
|
4372 |
|
4373 |
|
4374 |
|
4375 |
|
4376 <div class="returns"> |
|
4377 <h4>Returns:</h4> |
|
4378 |
|
4379 <div class="returns-description"> |
|
4380 |
|
4381 |
|
4382 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>: |
|
4383 |
|
4384 An array of classes (constructor functions), making up the class hierarchy for this object. |
|
4385 This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the |
|
4386 cached value. |
|
4387 |
|
4388 </div> |
|
4389 </div> |
|
4390 |
|
4391 |
|
4392 |
|
4393 </div> |
|
4394 |
|
4395 |
|
4396 <div id="method__getFullType" class="method item private inherited"> |
|
4397 <h3 class="name"><code>_getFullType</code></h3> |
|
4398 |
|
4399 |
|
4400 <div class="args"> |
|
4401 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4402 |
|
4403 <li class="arg"> |
|
4404 |
|
4405 <code>type</code> |
|
4406 |
|
4407 </li> |
|
4408 |
|
4409 </ul><span class="paren">)</span> |
|
4410 </div> |
|
4411 |
|
4412 |
|
4413 |
|
4414 <span class="returns-inline"> |
|
4415 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4416 </span> |
|
4417 |
|
4418 |
|
4419 |
|
4420 |
|
4421 |
|
4422 <span class="flag private">private</span> |
|
4423 |
|
4424 |
|
4425 |
|
4426 |
|
4427 |
|
4428 |
|
4429 |
|
4430 |
|
4431 |
|
4432 |
|
4433 <div class="meta"> |
|
4434 |
|
4435 |
|
4436 <p>Inherited from |
|
4437 <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>: |
|
4438 |
|
4439 |
|
4440 |
|
4441 <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a> |
|
4442 |
|
4443 </p> |
|
4444 |
|
4445 |
|
4446 |
|
4447 |
|
4448 |
|
4449 </div> |
|
4450 |
|
4451 <div class="description"> |
|
4452 <p>Returns the fully qualified type, given a short type string. |
|
4453 That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p> |
|
4454 |
|
4455 <p>NOTE: This method, unlike _getType, does no checking of the value passed in, and |
|
4456 is designed to be used with the low level _publish() method, for critical path |
|
4457 implementations which need to fast-track publish for performance reasons.</p> |
|
4458 </div> |
|
4459 |
|
4460 |
|
4461 <div class="params"> |
|
4462 <h4>Parameters:</h4> |
|
4463 |
|
4464 <ul class="params-list"> |
|
4465 |
|
4466 <li class="param"> |
|
4467 |
|
4468 <code class="param-name">type</code> |
|
4469 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4470 |
|
4471 |
|
4472 |
|
4473 |
|
4474 <div class="param-description"> |
|
4475 <p>The short type to prefix</p> |
|
4476 </div> |
|
4477 |
|
4478 |
|
4479 </li> |
|
4480 |
|
4481 </ul> |
|
4482 </div> |
|
4483 |
|
4484 |
|
4485 |
|
4486 <div class="returns"> |
|
4487 <h4>Returns:</h4> |
|
4488 |
|
4489 <div class="returns-description"> |
|
4490 |
|
4491 |
|
4492 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
4493 |
|
4494 The prefixed type, if a prefix is set, otherwise the type passed in |
|
4495 |
|
4496 </div> |
|
4497 </div> |
|
4498 |
|
4499 |
|
4500 |
|
4501 </div> |
|
4502 |
|
4503 |
|
4504 <div id="method__getStateVal" class="method item private inherited"> |
|
4505 <h3 class="name"><code>_getStateVal</code></h3> |
|
4506 |
|
4507 |
|
4508 <div class="args"> |
|
4509 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4510 |
|
4511 <li class="arg"> |
|
4512 |
|
4513 <code>name</code> |
|
4514 |
|
4515 </li> |
|
4516 |
|
4517 <li class="arg"> |
|
4518 |
|
4519 <code class="optional">[cfg]</code> |
|
4520 |
|
4521 </li> |
|
4522 |
|
4523 </ul><span class="paren">)</span> |
|
4524 </div> |
|
4525 |
|
4526 |
|
4527 |
|
4528 <span class="returns-inline"> |
|
4529 <span class="type">Any</span> |
|
4530 </span> |
|
4531 |
|
4532 |
|
4533 |
|
4534 |
|
4535 |
|
4536 <span class="flag private">private</span> |
|
4537 |
|
4538 |
|
4539 |
|
4540 |
|
4541 |
|
4542 |
|
4543 |
|
4544 |
|
4545 |
|
4546 |
|
4547 <div class="meta"> |
|
4548 |
|
4549 |
|
4550 <p>Inherited from |
|
4551 <a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>: |
|
4552 |
|
4553 |
|
4554 |
|
4555 <a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a> |
|
4556 |
|
4557 </p> |
|
4558 |
|
4559 |
|
4560 |
|
4561 |
|
4562 |
|
4563 </div> |
|
4564 |
|
4565 <div class="description"> |
|
4566 <p>Gets the stored value for the attribute, from either the |
|
4567 internal state object, or the state proxy if it exits</p> |
|
4568 </div> |
|
4569 |
|
4570 |
|
4571 <div class="params"> |
|
4572 <h4>Parameters:</h4> |
|
4573 |
|
4574 <ul class="params-list"> |
|
4575 |
|
4576 <li class="param"> |
|
4577 |
|
4578 <code class="param-name">name</code> |
|
4579 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
4580 |
|
4581 |
|
4582 |
|
4583 |
|
4584 <div class="param-description"> |
|
4585 <p>The name of the attribute</p> |
|
4586 </div> |
|
4587 |
|
4588 |
|
4589 </li> |
|
4590 |
|
4591 <li class="param"> |
|
4592 |
|
4593 <code class="param-name optional">[cfg]</code> |
|
4594 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4595 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
4596 |
|
4597 |
|
4598 |
|
4599 |
|
4600 <div class="param-description"> |
|
4601 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
4602 where the calling method has already obtained the config from state.</p> |
|
4603 </div> |
|
4604 |
|
4605 |
|
4606 </li> |
|
4607 |
|
4608 </ul> |
|
4609 </div> |
|
4610 |
|
4611 |
|
4612 |
|
4613 <div class="returns"> |
|
4614 <h4>Returns:</h4> |
|
4615 |
|
4616 <div class="returns-description"> |
|
4617 |
|
4618 |
|
4619 <span class="type">Any</span>: |
|
4620 |
|
4621 The stored value of the attribute |
|
4622 |
|
4623 </div> |
|
4624 </div> |
|
4625 |
|
4626 |
|
4627 |
|
4628 </div> |
|
4629 |
|
4630 |
|
4631 <div id="method__getType" class="method item private inherited"> |
|
4632 <h3 class="name"><code>_getType</code></h3> |
|
4633 |
|
4634 |
|
4635 <span class="paren">()</span> |
|
4636 |
|
4637 |
|
4638 |
|
4639 |
|
4640 |
|
4641 |
|
4642 |
|
4643 <span class="flag private">private</span> |
|
4644 |
|
4645 |
|
4646 |
|
4647 |
|
4648 |
|
4649 |
|
4650 |
|
4651 |
|
4652 |
|
4653 |
|
4654 <div class="meta"> |
|
4655 |
|
4656 |
|
4657 <p>Inherited from |
|
4658 <a href="../classes/EventTarget.html#method__getType">EventTarget</a>: |
|
4659 |
|
4660 |
|
4661 |
|
4662 <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a> |
|
4663 |
|
4664 </p> |
|
4665 |
|
4666 |
|
4667 |
|
4668 |
|
4669 |
|
4670 </div> |
|
4671 |
|
4672 <div class="description"> |
|
4673 <p>If the instance has a prefix attribute and the |
|
4674 event type is not prefixed, the instance prefix is |
|
4675 applied to the supplied type.</p> |
|
4676 </div> |
|
4677 |
|
4678 |
|
4679 |
|
4680 |
|
4681 |
|
4682 |
|
4683 </div> |
|
4684 |
|
4685 |
|
4686 <div id="method__initAttrHost" class="method item private inherited"> |
|
4687 <h3 class="name"><code>_initAttrHost</code></h3> |
|
4688 |
|
4689 |
|
4690 <div class="args"> |
|
4691 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4692 |
|
4693 <li class="arg"> |
|
4694 |
|
4695 <code>attrs</code> |
|
4696 |
|
4697 </li> |
|
4698 |
|
4699 <li class="arg"> |
|
4700 |
|
4701 <code>values</code> |
|
4702 |
|
4703 </li> |
|
4704 |
|
4705 <li class="arg"> |
|
4706 |
|
4707 <code>lazy</code> |
|
4708 |
|
4709 </li> |
|
4710 |
|
4711 </ul><span class="paren">)</span> |
|
4712 </div> |
|
4713 |
|
4714 |
|
4715 |
|
4716 |
|
4717 |
|
4718 |
|
4719 |
|
4720 <span class="flag private">private</span> |
|
4721 |
|
4722 |
|
4723 |
|
4724 |
|
4725 |
|
4726 |
|
4727 |
|
4728 |
|
4729 |
|
4730 |
|
4731 <div class="meta"> |
|
4732 |
|
4733 |
|
4734 <p>Inherited from |
|
4735 <a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>: |
|
4736 |
|
4737 |
|
4738 |
|
4739 <a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a> |
|
4740 |
|
4741 </p> |
|
4742 |
|
4743 |
|
4744 |
|
4745 |
|
4746 |
|
4747 </div> |
|
4748 |
|
4749 <div class="description"> |
|
4750 <p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the |
|
4751 constructor.</p> |
|
4752 </div> |
|
4753 |
|
4754 |
|
4755 <div class="params"> |
|
4756 <h4>Parameters:</h4> |
|
4757 |
|
4758 <ul class="params-list"> |
|
4759 |
|
4760 <li class="param"> |
|
4761 |
|
4762 <code class="param-name">attrs</code> |
|
4763 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4764 |
|
4765 |
|
4766 |
|
4767 |
|
4768 <div class="param-description"> |
|
4769 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
4770 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
4771 </div> |
|
4772 |
|
4773 |
|
4774 </li> |
|
4775 |
|
4776 <li class="param"> |
|
4777 |
|
4778 <code class="param-name">values</code> |
|
4779 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4780 |
|
4781 |
|
4782 |
|
4783 |
|
4784 <div class="param-description"> |
|
4785 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
4786 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
4787 </div> |
|
4788 |
|
4789 |
|
4790 </li> |
|
4791 |
|
4792 <li class="param"> |
|
4793 |
|
4794 <code class="param-name">lazy</code> |
|
4795 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
4796 |
|
4797 |
|
4798 |
|
4799 |
|
4800 <div class="param-description"> |
|
4801 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
4802 </div> |
|
4803 |
|
4804 |
|
4805 </li> |
|
4806 |
|
4807 </ul> |
|
4808 </div> |
|
4809 |
|
4810 |
|
4811 |
|
4812 |
|
4813 |
|
4814 </div> |
|
4815 |
|
4816 |
|
4817 <div id="method__initAttribute" class="method item private inherited"> |
|
4818 <h3 class="name"><code>_initAttribute</code></h3> |
|
4819 |
|
4820 |
|
4821 <span class="paren">()</span> |
|
4822 |
|
4823 |
|
4824 |
|
4825 |
|
4826 |
|
4827 |
|
4828 |
|
4829 <span class="flag private">private</span> |
|
4830 |
|
4831 |
|
4832 |
|
4833 |
|
4834 |
|
4835 |
|
4836 |
|
4837 |
|
4838 |
|
4839 |
|
4840 <div class="meta"> |
|
4841 |
|
4842 <p>Inherited from |
|
4843 <a href="../classes/BaseObservable.html#method__initAttribute"> |
|
4844 BaseObservable |
|
4845 </a> |
|
4846 |
|
4847 but overwritten in |
|
4848 |
|
4849 |
|
4850 |
|
4851 <a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a> |
|
4852 |
|
4853 </p> |
|
4854 |
|
4855 |
|
4856 |
|
4857 |
|
4858 |
|
4859 </div> |
|
4860 |
|
4861 <div class="description"> |
|
4862 <p>Initializes AttributeCore</p> |
|
4863 </div> |
|
4864 |
|
4865 |
|
4866 |
|
4867 |
|
4868 |
|
4869 |
|
4870 </div> |
|
4871 |
|
4872 |
|
4873 <div id="method__initAttrs" class="method item protected inherited"> |
|
4874 <h3 class="name"><code>_initAttrs</code></h3> |
|
4875 |
|
4876 |
|
4877 <div class="args"> |
|
4878 <span class="paren">(</span><ul class="args-list inline commas"> |
|
4879 |
|
4880 <li class="arg"> |
|
4881 |
|
4882 <code>attrs</code> |
|
4883 |
|
4884 </li> |
|
4885 |
|
4886 <li class="arg"> |
|
4887 |
|
4888 <code>values</code> |
|
4889 |
|
4890 </li> |
|
4891 |
|
4892 <li class="arg"> |
|
4893 |
|
4894 <code>lazy</code> |
|
4895 |
|
4896 </li> |
|
4897 |
|
4898 </ul><span class="paren">)</span> |
|
4899 </div> |
|
4900 |
|
4901 |
|
4902 |
|
4903 |
|
4904 |
|
4905 |
|
4906 |
|
4907 <span class="flag protected">protected</span> |
|
4908 |
|
4909 |
|
4910 |
|
4911 |
|
4912 |
|
4913 |
|
4914 |
|
4915 |
|
4916 |
|
4917 |
|
4918 <div class="meta"> |
|
4919 |
|
4920 |
|
4921 <p>Inherited from |
|
4922 <a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>: |
|
4923 |
|
4924 |
|
4925 |
|
4926 <a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a> |
|
4927 |
|
4928 </p> |
|
4929 |
|
4930 |
|
4931 |
|
4932 |
|
4933 |
|
4934 </div> |
|
4935 |
|
4936 <div class="description"> |
|
4937 <p>Utility method to set up initial attributes defined during construction, |
|
4938 either through the constructor.ATTRS property, or explicitly passed in.</p> |
|
4939 </div> |
|
4940 |
|
4941 |
|
4942 <div class="params"> |
|
4943 <h4>Parameters:</h4> |
|
4944 |
|
4945 <ul class="params-list"> |
|
4946 |
|
4947 <li class="param"> |
|
4948 |
|
4949 <code class="param-name">attrs</code> |
|
4950 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4951 |
|
4952 |
|
4953 |
|
4954 |
|
4955 <div class="param-description"> |
|
4956 <p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
4957 These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p> |
|
4958 </div> |
|
4959 |
|
4960 |
|
4961 </li> |
|
4962 |
|
4963 <li class="param"> |
|
4964 |
|
4965 <code class="param-name">values</code> |
|
4966 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
4967 |
|
4968 |
|
4969 |
|
4970 |
|
4971 <div class="param-description"> |
|
4972 <p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). |
|
4973 These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p> |
|
4974 </div> |
|
4975 |
|
4976 |
|
4977 </li> |
|
4978 |
|
4979 <li class="param"> |
|
4980 |
|
4981 <code class="param-name">lazy</code> |
|
4982 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
4983 |
|
4984 |
|
4985 |
|
4986 |
|
4987 <div class="param-description"> |
|
4988 <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p> |
|
4989 </div> |
|
4990 |
|
4991 |
|
4992 </li> |
|
4993 |
|
4994 </ul> |
|
4995 </div> |
|
4996 |
|
4997 |
|
4998 |
|
4999 |
|
5000 |
|
5001 </div> |
|
5002 |
|
5003 |
|
5004 <div id="method__initBase" class="method item private inherited"> |
|
5005 <h3 class="name"><code>_initBase</code></h3> |
|
5006 |
|
5007 |
|
5008 <div class="args"> |
|
5009 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5010 |
|
5011 <li class="arg"> |
|
5012 |
|
5013 <code>config</code> |
|
5014 |
|
5015 </li> |
|
5016 |
|
5017 </ul><span class="paren">)</span> |
|
5018 </div> |
|
5019 |
|
5020 |
|
5021 |
|
5022 |
|
5023 |
|
5024 |
|
5025 |
|
5026 <span class="flag private">private</span> |
|
5027 |
|
5028 |
|
5029 |
|
5030 |
|
5031 |
|
5032 |
|
5033 |
|
5034 |
|
5035 |
|
5036 |
|
5037 <div class="meta"> |
|
5038 |
|
5039 |
|
5040 <p>Inherited from |
|
5041 <a href="../classes/BaseCore.html#method__initBase">BaseCore</a>: |
|
5042 |
|
5043 |
|
5044 |
|
5045 <a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a> |
|
5046 |
|
5047 </p> |
|
5048 |
|
5049 |
|
5050 |
|
5051 |
|
5052 |
|
5053 </div> |
|
5054 |
|
5055 <div class="description"> |
|
5056 <p>Internal construction logic for BaseCore.</p> |
|
5057 </div> |
|
5058 |
|
5059 |
|
5060 <div class="params"> |
|
5061 <h4>Parameters:</h4> |
|
5062 |
|
5063 <ul class="params-list"> |
|
5064 |
|
5065 <li class="param"> |
|
5066 |
|
5067 <code class="param-name">config</code> |
|
5068 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5069 |
|
5070 |
|
5071 |
|
5072 |
|
5073 <div class="param-description"> |
|
5074 <p>The constructor configuration object</p> |
|
5075 </div> |
|
5076 |
|
5077 |
|
5078 </li> |
|
5079 |
|
5080 </ul> |
|
5081 </div> |
|
5082 |
|
5083 |
|
5084 |
|
5085 |
|
5086 |
|
5087 </div> |
|
5088 |
|
5089 |
|
5090 <div id="method__initHierarchy" class="method item private inherited"> |
|
5091 <h3 class="name"><code>_initHierarchy</code></h3> |
|
5092 |
|
5093 |
|
5094 <div class="args"> |
|
5095 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5096 |
|
5097 <li class="arg"> |
|
5098 |
|
5099 <code>userVals</code> |
|
5100 |
|
5101 </li> |
|
5102 |
|
5103 </ul><span class="paren">)</span> |
|
5104 </div> |
|
5105 |
|
5106 |
|
5107 |
|
5108 |
|
5109 |
|
5110 |
|
5111 |
|
5112 <span class="flag private">private</span> |
|
5113 |
|
5114 |
|
5115 |
|
5116 |
|
5117 |
|
5118 |
|
5119 |
|
5120 |
|
5121 |
|
5122 |
|
5123 <div class="meta"> |
|
5124 |
|
5125 |
|
5126 <p>Inherited from |
|
5127 <a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>: |
|
5128 |
|
5129 |
|
5130 |
|
5131 <a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a> |
|
5132 |
|
5133 </p> |
|
5134 |
|
5135 |
|
5136 |
|
5137 |
|
5138 |
|
5139 </div> |
|
5140 |
|
5141 <div class="description"> |
|
5142 <p>Initializes the class hierarchy for the instance, which includes |
|
5143 initializing attributes for each class defined in the class's |
|
5144 static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and |
|
5145 invoking the initializer method on the prototype of each class in the hierarchy.</p> |
|
5146 </div> |
|
5147 |
|
5148 |
|
5149 <div class="params"> |
|
5150 <h4>Parameters:</h4> |
|
5151 |
|
5152 <ul class="params-list"> |
|
5153 |
|
5154 <li class="param"> |
|
5155 |
|
5156 <code class="param-name">userVals</code> |
|
5157 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5158 |
|
5159 |
|
5160 |
|
5161 |
|
5162 <div class="param-description"> |
|
5163 <p>Object with configuration property name/value pairs</p> |
|
5164 </div> |
|
5165 |
|
5166 |
|
5167 </li> |
|
5168 |
|
5169 </ul> |
|
5170 </div> |
|
5171 |
|
5172 |
|
5173 |
|
5174 |
|
5175 |
|
5176 </div> |
|
5177 |
|
5178 |
|
5179 <div id="method__initHierarchyData" class="method item private inherited"> |
|
5180 <h3 class="name"><code>_initHierarchyData</code></h3> |
|
5181 |
|
5182 |
|
5183 <span class="paren">()</span> |
|
5184 |
|
5185 |
|
5186 |
|
5187 |
|
5188 |
|
5189 |
|
5190 |
|
5191 <span class="flag private">private</span> |
|
5192 |
|
5193 |
|
5194 |
|
5195 |
|
5196 |
|
5197 |
|
5198 |
|
5199 |
|
5200 |
|
5201 |
|
5202 <div class="meta"> |
|
5203 |
|
5204 |
|
5205 <p>Inherited from |
|
5206 <a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>: |
|
5207 |
|
5208 |
|
5209 |
|
5210 <a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a> |
|
5211 |
|
5212 </p> |
|
5213 |
|
5214 |
|
5215 |
|
5216 |
|
5217 |
|
5218 </div> |
|
5219 |
|
5220 <div class="description"> |
|
5221 <p>A helper method used by _getClasses and _getAttrCfgs, which determines both |
|
5222 the array of classes and aggregate set of attribute configurations |
|
5223 across the class hierarchy for the instance.</p> |
|
5224 </div> |
|
5225 |
|
5226 |
|
5227 |
|
5228 |
|
5229 |
|
5230 |
|
5231 </div> |
|
5232 |
|
5233 |
|
5234 <div id="method__isLazyAttr" class="method item private inherited"> |
|
5235 <h3 class="name"><code>_isLazyAttr</code></h3> |
|
5236 |
|
5237 |
|
5238 <div class="args"> |
|
5239 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5240 |
|
5241 <li class="arg"> |
|
5242 |
|
5243 <code>name</code> |
|
5244 |
|
5245 </li> |
|
5246 |
|
5247 </ul><span class="paren">)</span> |
|
5248 </div> |
|
5249 |
|
5250 |
|
5251 |
|
5252 <span class="returns-inline"> |
|
5253 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
5254 </span> |
|
5255 |
|
5256 |
|
5257 |
|
5258 |
|
5259 |
|
5260 <span class="flag private">private</span> |
|
5261 |
|
5262 |
|
5263 |
|
5264 |
|
5265 |
|
5266 |
|
5267 |
|
5268 |
|
5269 |
|
5270 |
|
5271 <div class="meta"> |
|
5272 |
|
5273 |
|
5274 <p>Inherited from |
|
5275 <a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>: |
|
5276 |
|
5277 |
|
5278 |
|
5279 <a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a> |
|
5280 |
|
5281 </p> |
|
5282 |
|
5283 |
|
5284 |
|
5285 |
|
5286 |
|
5287 </div> |
|
5288 |
|
5289 <div class="description"> |
|
5290 <p>Checks whether or not the attribute is one which has been |
|
5291 added lazily and still requires initialization.</p> |
|
5292 </div> |
|
5293 |
|
5294 |
|
5295 <div class="params"> |
|
5296 <h4>Parameters:</h4> |
|
5297 |
|
5298 <ul class="params-list"> |
|
5299 |
|
5300 <li class="param"> |
|
5301 |
|
5302 <code class="param-name">name</code> |
|
5303 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5304 |
|
5305 |
|
5306 |
|
5307 |
|
5308 <div class="param-description"> |
|
5309 <p>The name of the attribute</p> |
|
5310 </div> |
|
5311 |
|
5312 |
|
5313 </li> |
|
5314 |
|
5315 </ul> |
|
5316 </div> |
|
5317 |
|
5318 |
|
5319 |
|
5320 <div class="returns"> |
|
5321 <h4>Returns:</h4> |
|
5322 |
|
5323 <div class="returns-description"> |
|
5324 |
|
5325 |
|
5326 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
5327 |
|
5328 true if it's a lazily added attribute, false otherwise. |
|
5329 |
|
5330 </div> |
|
5331 </div> |
|
5332 |
|
5333 |
|
5334 |
|
5335 </div> |
|
5336 |
|
5337 |
|
5338 <div id="method__monitor" class="method item private inherited"> |
|
5339 <h3 class="name"><code>_monitor</code></h3> |
|
5340 |
|
5341 |
|
5342 <div class="args"> |
|
5343 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5344 |
|
5345 <li class="arg"> |
|
5346 |
|
5347 <code>what</code> |
|
5348 |
|
5349 </li> |
|
5350 |
|
5351 <li class="arg"> |
|
5352 |
|
5353 <code>eventType</code> |
|
5354 |
|
5355 </li> |
|
5356 |
|
5357 <li class="arg"> |
|
5358 |
|
5359 <code>o</code> |
|
5360 |
|
5361 </li> |
|
5362 |
|
5363 </ul><span class="paren">)</span> |
|
5364 </div> |
|
5365 |
|
5366 |
|
5367 |
|
5368 |
|
5369 |
|
5370 |
|
5371 |
|
5372 <span class="flag private">private</span> |
|
5373 |
|
5374 |
|
5375 |
|
5376 |
|
5377 |
|
5378 |
|
5379 |
|
5380 |
|
5381 |
|
5382 |
|
5383 <div class="meta"> |
|
5384 |
|
5385 |
|
5386 <p>Inherited from |
|
5387 <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>: |
|
5388 |
|
5389 |
|
5390 |
|
5391 <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a> |
|
5392 |
|
5393 </p> |
|
5394 |
|
5395 |
|
5396 |
|
5397 |
|
5398 |
|
5399 </div> |
|
5400 |
|
5401 <div class="description"> |
|
5402 <p>This is the entry point for the event monitoring system. |
|
5403 You can monitor 'attach', 'detach', 'fire', and 'publish'. |
|
5404 When configured, these events generate an event. click -> |
|
5405 click<em>attach, click</em>detach, click_publish -- these can |
|
5406 be subscribed to like other events to monitor the event |
|
5407 system. Inividual published events can have monitoring |
|
5408 turned on or off (publish can't be turned off before it |
|
5409 it published) by setting the events 'monitor' config.</p> |
|
5410 </div> |
|
5411 |
|
5412 |
|
5413 <div class="params"> |
|
5414 <h4>Parameters:</h4> |
|
5415 |
|
5416 <ul class="params-list"> |
|
5417 |
|
5418 <li class="param"> |
|
5419 |
|
5420 <code class="param-name">what</code> |
|
5421 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
5422 |
|
5423 |
|
5424 |
|
5425 |
|
5426 <div class="param-description"> |
|
5427 <p>'attach', 'detach', 'fire', or 'publish'</p> |
|
5428 </div> |
|
5429 |
|
5430 |
|
5431 </li> |
|
5432 |
|
5433 <li class="param"> |
|
5434 |
|
5435 <code class="param-name">eventType</code> |
|
5436 <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> |
|
5437 |
|
5438 |
|
5439 |
|
5440 |
|
5441 <div class="param-description"> |
|
5442 <p>The prefixed name of the event being monitored, or the CustomEvent object.</p> |
|
5443 </div> |
|
5444 |
|
5445 |
|
5446 </li> |
|
5447 |
|
5448 <li class="param"> |
|
5449 |
|
5450 <code class="param-name">o</code> |
|
5451 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5452 |
|
5453 |
|
5454 |
|
5455 |
|
5456 <div class="param-description"> |
|
5457 <p>Information about the event interaction, such as |
|
5458 fire() args, subscription category, publish config</p> |
|
5459 </div> |
|
5460 |
|
5461 |
|
5462 </li> |
|
5463 |
|
5464 </ul> |
|
5465 </div> |
|
5466 |
|
5467 |
|
5468 |
|
5469 |
|
5470 |
|
5471 </div> |
|
5472 |
|
5473 |
|
5474 <div id="method__normAttrVals" class="method item private inherited"> |
|
5475 <h3 class="name"><code>_normAttrVals</code></h3> |
|
5476 |
|
5477 |
|
5478 <div class="args"> |
|
5479 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5480 |
|
5481 <li class="arg"> |
|
5482 |
|
5483 <code>valueHash</code> |
|
5484 |
|
5485 </li> |
|
5486 |
|
5487 </ul><span class="paren">)</span> |
|
5488 </div> |
|
5489 |
|
5490 |
|
5491 |
|
5492 <span class="returns-inline"> |
|
5493 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5494 </span> |
|
5495 |
|
5496 |
|
5497 |
|
5498 |
|
5499 |
|
5500 <span class="flag private">private</span> |
|
5501 |
|
5502 |
|
5503 |
|
5504 |
|
5505 |
|
5506 |
|
5507 |
|
5508 |
|
5509 |
|
5510 |
|
5511 <div class="meta"> |
|
5512 |
|
5513 |
|
5514 <p>Inherited from |
|
5515 <a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>: |
|
5516 |
|
5517 |
|
5518 |
|
5519 <a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a> |
|
5520 |
|
5521 </p> |
|
5522 |
|
5523 |
|
5524 |
|
5525 |
|
5526 |
|
5527 </div> |
|
5528 |
|
5529 <div class="description"> |
|
5530 <p>Utility method to normalize attribute values. The base implementation |
|
5531 simply merges the hash to protect the original.</p> |
|
5532 </div> |
|
5533 |
|
5534 |
|
5535 <div class="params"> |
|
5536 <h4>Parameters:</h4> |
|
5537 |
|
5538 <ul class="params-list"> |
|
5539 |
|
5540 <li class="param"> |
|
5541 |
|
5542 <code class="param-name">valueHash</code> |
|
5543 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5544 |
|
5545 |
|
5546 |
|
5547 |
|
5548 <div class="param-description"> |
|
5549 <p>An object with attribute name/value pairs</p> |
|
5550 </div> |
|
5551 |
|
5552 |
|
5553 </li> |
|
5554 |
|
5555 </ul> |
|
5556 </div> |
|
5557 |
|
5558 |
|
5559 |
|
5560 <div class="returns"> |
|
5561 <h4>Returns:</h4> |
|
5562 |
|
5563 <div class="returns-description"> |
|
5564 |
|
5565 |
|
5566 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5567 |
|
5568 An object literal with 2 properties - "simple" and "complex", |
|
5569 containing simple and complex attribute values respectively keyed |
|
5570 by the top level attribute name, or null, if valueHash is falsey. |
|
5571 |
|
5572 </div> |
|
5573 </div> |
|
5574 |
|
5575 |
|
5576 |
|
5577 </div> |
|
5578 |
|
5579 |
|
5580 <div id="method__parse" class="method item protected"> |
|
5581 <h3 class="name"><code>_parse</code></h3> |
|
5582 |
|
5583 |
|
5584 <div class="args"> |
|
5585 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5586 |
|
5587 <li class="arg"> |
|
5588 |
|
5589 <code>response</code> |
|
5590 |
|
5591 </li> |
|
5592 |
|
5593 </ul><span class="paren">)</span> |
|
5594 </div> |
|
5595 |
|
5596 |
|
5597 |
|
5598 <span class="returns-inline"> |
|
5599 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5600 </span> |
|
5601 |
|
5602 |
|
5603 |
|
5604 |
|
5605 |
|
5606 <span class="flag protected">protected</span> |
|
5607 |
|
5608 |
|
5609 |
|
5610 |
|
5611 |
|
5612 |
|
5613 |
|
5614 |
|
5615 |
|
5616 |
|
5617 <div class="meta"> |
|
5618 |
|
5619 |
|
5620 |
|
5621 <p> |
|
5622 |
|
5623 Defined in |
|
5624 |
|
5625 |
|
5626 |
|
5627 |
|
5628 <a href="../files/app_js_model.js.html#l867"><code>app/js/model.js:867</code></a> |
|
5629 |
|
5630 </p> |
|
5631 |
|
5632 |
|
5633 |
|
5634 |
|
5635 |
|
5636 <p>Available since 3.7.0</p> |
|
5637 |
|
5638 </div> |
|
5639 |
|
5640 <div class="description"> |
|
5641 <p>Calls the public, overrideable <code>parse()</code> method and returns the result.</p> |
|
5642 |
|
5643 <p>Override this method to provide a custom pre-parsing implementation. This |
|
5644 provides a hook for custom persistence implementations to "prep" a response |
|
5645 before calling the <code>parse()</code> method.</p> |
|
5646 </div> |
|
5647 |
|
5648 |
|
5649 <div class="params"> |
|
5650 <h4>Parameters:</h4> |
|
5651 |
|
5652 <ul class="params-list"> |
|
5653 |
|
5654 <li class="param"> |
|
5655 |
|
5656 <code class="param-name">response</code> |
|
5657 <span class="type">Any</span> |
|
5658 |
|
5659 |
|
5660 |
|
5661 |
|
5662 <div class="param-description"> |
|
5663 <p>Server response.</p> |
|
5664 </div> |
|
5665 |
|
5666 |
|
5667 </li> |
|
5668 |
|
5669 </ul> |
|
5670 </div> |
|
5671 |
|
5672 |
|
5673 |
|
5674 <div class="returns"> |
|
5675 <h4>Returns:</h4> |
|
5676 |
|
5677 <div class="returns-description"> |
|
5678 |
|
5679 |
|
5680 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5681 |
|
5682 Attribute hash. |
|
5683 |
|
5684 </div> |
|
5685 </div> |
|
5686 |
|
5687 |
|
5688 |
|
5689 </div> |
|
5690 |
|
5691 |
|
5692 <div id="method__parseType" class="method item private inherited"> |
|
5693 <h3 class="name"><code>_parseType</code></h3> |
|
5694 |
|
5695 |
|
5696 <span class="paren">()</span> |
|
5697 |
|
5698 |
|
5699 |
|
5700 |
|
5701 |
|
5702 |
|
5703 |
|
5704 <span class="flag private">private</span> |
|
5705 |
|
5706 |
|
5707 |
|
5708 |
|
5709 |
|
5710 |
|
5711 |
|
5712 |
|
5713 |
|
5714 |
|
5715 <div class="meta"> |
|
5716 |
|
5717 |
|
5718 <p>Inherited from |
|
5719 <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>: |
|
5720 |
|
5721 |
|
5722 |
|
5723 <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a> |
|
5724 |
|
5725 </p> |
|
5726 |
|
5727 |
|
5728 |
|
5729 |
|
5730 |
|
5731 </div> |
|
5732 |
|
5733 <div class="description"> |
|
5734 <p>Returns an array with the detach key (if provided), |
|
5735 and the prefixed event name from _getType |
|
5736 Y.on('detachcategory| menu:click', fn)</p> |
|
5737 </div> |
|
5738 |
|
5739 |
|
5740 |
|
5741 |
|
5742 |
|
5743 |
|
5744 </div> |
|
5745 |
|
5746 |
|
5747 <div id="method__preInitEventCfg" class="method item private inherited"> |
|
5748 <h3 class="name"><code>_preInitEventCfg</code></h3> |
|
5749 |
|
5750 |
|
5751 <div class="args"> |
|
5752 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5753 |
|
5754 <li class="arg"> |
|
5755 |
|
5756 <code>config</code> |
|
5757 |
|
5758 </li> |
|
5759 |
|
5760 </ul><span class="paren">)</span> |
|
5761 </div> |
|
5762 |
|
5763 |
|
5764 |
|
5765 |
|
5766 |
|
5767 |
|
5768 |
|
5769 <span class="flag private">private</span> |
|
5770 |
|
5771 |
|
5772 |
|
5773 |
|
5774 |
|
5775 |
|
5776 |
|
5777 |
|
5778 |
|
5779 |
|
5780 <div class="meta"> |
|
5781 |
|
5782 |
|
5783 <p>Inherited from |
|
5784 <a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>: |
|
5785 |
|
5786 |
|
5787 |
|
5788 <a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a> |
|
5789 |
|
5790 </p> |
|
5791 |
|
5792 |
|
5793 |
|
5794 |
|
5795 |
|
5796 </div> |
|
5797 |
|
5798 <div class="description"> |
|
5799 <p>Handles the special on, after and target properties which allow the user to |
|
5800 easily configure on and after listeners as well as bubble targets during |
|
5801 construction, prior to init.</p> |
|
5802 </div> |
|
5803 |
|
5804 |
|
5805 <div class="params"> |
|
5806 <h4>Parameters:</h4> |
|
5807 |
|
5808 <ul class="params-list"> |
|
5809 |
|
5810 <li class="param"> |
|
5811 |
|
5812 <code class="param-name">config</code> |
|
5813 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5814 |
|
5815 |
|
5816 |
|
5817 |
|
5818 <div class="param-description"> |
|
5819 <p>The user configuration object</p> |
|
5820 </div> |
|
5821 |
|
5822 |
|
5823 </li> |
|
5824 |
|
5825 </ul> |
|
5826 </div> |
|
5827 |
|
5828 |
|
5829 |
|
5830 |
|
5831 |
|
5832 </div> |
|
5833 |
|
5834 |
|
5835 <div id="method__protectAttrs" class="method item protected deprecated inherited"> |
|
5836 <h3 class="name"><code>_protectAttrs</code></h3> |
|
5837 |
|
5838 |
|
5839 <div class="args"> |
|
5840 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5841 |
|
5842 <li class="arg"> |
|
5843 |
|
5844 <code>attrs</code> |
|
5845 |
|
5846 </li> |
|
5847 |
|
5848 </ul><span class="paren">)</span> |
|
5849 </div> |
|
5850 |
|
5851 |
|
5852 |
|
5853 <span class="returns-inline"> |
|
5854 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5855 </span> |
|
5856 |
|
5857 |
|
5858 |
|
5859 <span class="flag deprecated" title="Use `AttributeCore.protectAttrs()` or |
|
5860 `Attribute.protectAttrs()` which are the same static utility method.">deprecated</span> |
|
5861 |
|
5862 |
|
5863 |
|
5864 <span class="flag protected">protected</span> |
|
5865 |
|
5866 |
|
5867 |
|
5868 |
|
5869 |
|
5870 |
|
5871 |
|
5872 |
|
5873 |
|
5874 |
|
5875 <div class="meta"> |
|
5876 |
|
5877 |
|
5878 <p>Inherited from |
|
5879 <a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>: |
|
5880 |
|
5881 |
|
5882 |
|
5883 <a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a> |
|
5884 |
|
5885 </p> |
|
5886 |
|
5887 |
|
5888 |
|
5889 <p>Deprecated: Use `AttributeCore.protectAttrs()` or |
|
5890 `Attribute.protectAttrs()` which are the same static utility method.</p> |
|
5891 |
|
5892 |
|
5893 |
|
5894 </div> |
|
5895 |
|
5896 <div class="description"> |
|
5897 <p>Utility method to protect an attribute configuration |
|
5898 hash, by merging the entire object and the individual |
|
5899 attr config objects.</p> |
|
5900 </div> |
|
5901 |
|
5902 |
|
5903 <div class="params"> |
|
5904 <h4>Parameters:</h4> |
|
5905 |
|
5906 <ul class="params-list"> |
|
5907 |
|
5908 <li class="param"> |
|
5909 |
|
5910 <code class="param-name">attrs</code> |
|
5911 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
5912 |
|
5913 |
|
5914 |
|
5915 |
|
5916 <div class="param-description"> |
|
5917 <p>A hash of attribute to configuration object pairs.</p> |
|
5918 </div> |
|
5919 |
|
5920 |
|
5921 </li> |
|
5922 |
|
5923 </ul> |
|
5924 </div> |
|
5925 |
|
5926 |
|
5927 |
|
5928 <div class="returns"> |
|
5929 <h4>Returns:</h4> |
|
5930 |
|
5931 <div class="returns-description"> |
|
5932 |
|
5933 |
|
5934 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
5935 |
|
5936 A protected version of the attrs argument. |
|
5937 |
|
5938 </div> |
|
5939 </div> |
|
5940 |
|
5941 |
|
5942 |
|
5943 </div> |
|
5944 |
|
5945 |
|
5946 <div id="method__publish" class="method item private inherited"> |
|
5947 <h3 class="name"><code>_publish</code></h3> |
|
5948 |
|
5949 |
|
5950 <div class="args"> |
|
5951 <span class="paren">(</span><ul class="args-list inline commas"> |
|
5952 |
|
5953 <li class="arg"> |
|
5954 |
|
5955 <code>fullType</code> |
|
5956 |
|
5957 </li> |
|
5958 |
|
5959 <li class="arg"> |
|
5960 |
|
5961 <code>etOpts</code> |
|
5962 |
|
5963 </li> |
|
5964 |
|
5965 <li class="arg"> |
|
5966 |
|
5967 <code>ceOpts</code> |
|
5968 |
|
5969 </li> |
|
5970 |
|
5971 </ul><span class="paren">)</span> |
|
5972 </div> |
|
5973 |
|
5974 |
|
5975 |
|
5976 <span class="returns-inline"> |
|
5977 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
5978 </span> |
|
5979 |
|
5980 |
|
5981 |
|
5982 |
|
5983 |
|
5984 <span class="flag private">private</span> |
|
5985 |
|
5986 |
|
5987 |
|
5988 |
|
5989 |
|
5990 |
|
5991 |
|
5992 |
|
5993 |
|
5994 |
|
5995 <div class="meta"> |
|
5996 |
|
5997 |
|
5998 <p>Inherited from |
|
5999 <a href="../classes/EventTarget.html#method__publish">EventTarget</a>: |
|
6000 |
|
6001 |
|
6002 |
|
6003 <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a> |
|
6004 |
|
6005 </p> |
|
6006 |
|
6007 |
|
6008 |
|
6009 |
|
6010 |
|
6011 </div> |
|
6012 |
|
6013 <div class="description"> |
|
6014 <p>The low level event publish implementation. It expects all the massaging to have been done |
|
6015 outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast |
|
6016 path publish, which can be used by critical code paths to improve performance.</p> |
|
6017 </div> |
|
6018 |
|
6019 |
|
6020 <div class="params"> |
|
6021 <h4>Parameters:</h4> |
|
6022 |
|
6023 <ul class="params-list"> |
|
6024 |
|
6025 <li class="param"> |
|
6026 |
|
6027 <code class="param-name">fullType</code> |
|
6028 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6029 |
|
6030 |
|
6031 |
|
6032 |
|
6033 <div class="param-description"> |
|
6034 <p>The prefixed type of the event to publish.</p> |
|
6035 </div> |
|
6036 |
|
6037 |
|
6038 </li> |
|
6039 |
|
6040 <li class="param"> |
|
6041 |
|
6042 <code class="param-name">etOpts</code> |
|
6043 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6044 |
|
6045 |
|
6046 |
|
6047 |
|
6048 <div class="param-description"> |
|
6049 <p>The EventTarget specific configuration to mix into the published event.</p> |
|
6050 </div> |
|
6051 |
|
6052 |
|
6053 </li> |
|
6054 |
|
6055 <li class="param"> |
|
6056 |
|
6057 <code class="param-name">ceOpts</code> |
|
6058 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6059 |
|
6060 |
|
6061 |
|
6062 |
|
6063 <div class="param-description"> |
|
6064 <p>The publish specific configuration to mix into the published event.</p> |
|
6065 </div> |
|
6066 |
|
6067 |
|
6068 </li> |
|
6069 |
|
6070 </ul> |
|
6071 </div> |
|
6072 |
|
6073 |
|
6074 |
|
6075 <div class="returns"> |
|
6076 <h4>Returns:</h4> |
|
6077 |
|
6078 <div class="returns-description"> |
|
6079 |
|
6080 |
|
6081 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
6082 |
|
6083 The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will |
|
6084 be the default <code>CustomEvent</code> instance, and can be configured independently. |
|
6085 |
|
6086 </div> |
|
6087 </div> |
|
6088 |
|
6089 |
|
6090 |
|
6091 </div> |
|
6092 |
|
6093 |
|
6094 <div id="method__set" class="method item protected inherited"> |
|
6095 <h3 class="name"><code>_set</code></h3> |
|
6096 |
|
6097 |
|
6098 <div class="args"> |
|
6099 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6100 |
|
6101 <li class="arg"> |
|
6102 |
|
6103 <code>name</code> |
|
6104 |
|
6105 </li> |
|
6106 |
|
6107 <li class="arg"> |
|
6108 |
|
6109 <code>val</code> |
|
6110 |
|
6111 </li> |
|
6112 |
|
6113 <li class="arg"> |
|
6114 |
|
6115 <code class="optional">[opts]</code> |
|
6116 |
|
6117 </li> |
|
6118 |
|
6119 </ul><span class="paren">)</span> |
|
6120 </div> |
|
6121 |
|
6122 |
|
6123 |
|
6124 <span class="returns-inline"> |
|
6125 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6126 </span> |
|
6127 |
|
6128 |
|
6129 |
|
6130 |
|
6131 |
|
6132 <span class="flag protected">protected</span> |
|
6133 |
|
6134 |
|
6135 |
|
6136 |
|
6137 |
|
6138 |
|
6139 |
|
6140 <span class="flag chainable">chainable</span> |
|
6141 |
|
6142 |
|
6143 |
|
6144 |
|
6145 <div class="meta"> |
|
6146 |
|
6147 <p>Inherited from |
|
6148 <a href="../classes/AttributeObservable.html#method__set"> |
|
6149 AttributeObservable |
|
6150 </a> |
|
6151 |
|
6152 but overwritten in |
|
6153 |
|
6154 |
|
6155 |
|
6156 <a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a> |
|
6157 |
|
6158 </p> |
|
6159 |
|
6160 |
|
6161 |
|
6162 |
|
6163 |
|
6164 </div> |
|
6165 |
|
6166 <div class="description"> |
|
6167 <p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p> |
|
6168 </div> |
|
6169 |
|
6170 |
|
6171 <div class="params"> |
|
6172 <h4>Parameters:</h4> |
|
6173 |
|
6174 <ul class="params-list"> |
|
6175 |
|
6176 <li class="param"> |
|
6177 |
|
6178 <code class="param-name">name</code> |
|
6179 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6180 |
|
6181 |
|
6182 |
|
6183 |
|
6184 <div class="param-description"> |
|
6185 <p>The name of the attribute.</p> |
|
6186 </div> |
|
6187 |
|
6188 |
|
6189 </li> |
|
6190 |
|
6191 <li class="param"> |
|
6192 |
|
6193 <code class="param-name">val</code> |
|
6194 <span class="type">Any</span> |
|
6195 |
|
6196 |
|
6197 |
|
6198 |
|
6199 <div class="param-description"> |
|
6200 <p>The value to set the attribute to.</p> |
|
6201 </div> |
|
6202 |
|
6203 |
|
6204 </li> |
|
6205 |
|
6206 <li class="param"> |
|
6207 |
|
6208 <code class="param-name optional">[opts]</code> |
|
6209 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6210 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6211 |
|
6212 |
|
6213 |
|
6214 |
|
6215 <div class="param-description"> |
|
6216 <p>Optional data providing the circumstances for the change.</p> |
|
6217 </div> |
|
6218 |
|
6219 |
|
6220 </li> |
|
6221 |
|
6222 </ul> |
|
6223 </div> |
|
6224 |
|
6225 |
|
6226 |
|
6227 <div class="returns"> |
|
6228 <h4>Returns:</h4> |
|
6229 |
|
6230 <div class="returns-description"> |
|
6231 |
|
6232 |
|
6233 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6234 |
|
6235 A reference to the host object. |
|
6236 |
|
6237 </div> |
|
6238 </div> |
|
6239 |
|
6240 |
|
6241 |
|
6242 </div> |
|
6243 |
|
6244 |
|
6245 <div id="method__setAttr" class="method item protected inherited"> |
|
6246 <h3 class="name"><code>_setAttr</code></h3> |
|
6247 |
|
6248 |
|
6249 <div class="args"> |
|
6250 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6251 |
|
6252 <li class="arg"> |
|
6253 |
|
6254 <code>name</code> |
|
6255 |
|
6256 </li> |
|
6257 |
|
6258 <li class="arg"> |
|
6259 |
|
6260 <code>value</code> |
|
6261 |
|
6262 </li> |
|
6263 |
|
6264 <li class="arg"> |
|
6265 |
|
6266 <code class="optional">[opts]</code> |
|
6267 |
|
6268 </li> |
|
6269 |
|
6270 <li class="arg"> |
|
6271 |
|
6272 <code>force</code> |
|
6273 |
|
6274 </li> |
|
6275 |
|
6276 </ul><span class="paren">)</span> |
|
6277 </div> |
|
6278 |
|
6279 |
|
6280 |
|
6281 <span class="returns-inline"> |
|
6282 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6283 </span> |
|
6284 |
|
6285 |
|
6286 |
|
6287 |
|
6288 |
|
6289 <span class="flag protected">protected</span> |
|
6290 |
|
6291 |
|
6292 |
|
6293 |
|
6294 |
|
6295 |
|
6296 |
|
6297 <span class="flag chainable">chainable</span> |
|
6298 |
|
6299 |
|
6300 |
|
6301 |
|
6302 <div class="meta"> |
|
6303 |
|
6304 |
|
6305 <p>Inherited from |
|
6306 <a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>: |
|
6307 |
|
6308 |
|
6309 |
|
6310 <a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a> |
|
6311 |
|
6312 </p> |
|
6313 |
|
6314 |
|
6315 |
|
6316 |
|
6317 |
|
6318 </div> |
|
6319 |
|
6320 <div class="description"> |
|
6321 <p>Provides the common implementation for the public set and protected _set methods.</p> |
|
6322 |
|
6323 <p>See <a href="#method_set">set</a> for argument details.</p> |
|
6324 </div> |
|
6325 |
|
6326 |
|
6327 <div class="params"> |
|
6328 <h4>Parameters:</h4> |
|
6329 |
|
6330 <ul class="params-list"> |
|
6331 |
|
6332 <li class="param"> |
|
6333 |
|
6334 <code class="param-name">name</code> |
|
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 |
|
6337 |
|
6338 |
|
6339 |
|
6340 <div class="param-description"> |
|
6341 <p>The name of the attribute.</p> |
|
6342 </div> |
|
6343 |
|
6344 |
|
6345 </li> |
|
6346 |
|
6347 <li class="param"> |
|
6348 |
|
6349 <code class="param-name">value</code> |
|
6350 <span class="type">Any</span> |
|
6351 |
|
6352 |
|
6353 |
|
6354 |
|
6355 <div class="param-description"> |
|
6356 <p>The value to set the attribute to.</p> |
|
6357 </div> |
|
6358 |
|
6359 |
|
6360 </li> |
|
6361 |
|
6362 <li class="param"> |
|
6363 |
|
6364 <code class="param-name optional">[opts]</code> |
|
6365 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6366 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6367 |
|
6368 |
|
6369 |
|
6370 |
|
6371 <div class="param-description"> |
|
6372 <p>Optional data providing the circumstances for the change.</p> |
|
6373 </div> |
|
6374 |
|
6375 |
|
6376 </li> |
|
6377 |
|
6378 <li class="param"> |
|
6379 |
|
6380 <code class="param-name">force</code> |
|
6381 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
6382 |
|
6383 |
|
6384 |
|
6385 |
|
6386 <div class="param-description"> |
|
6387 <p>If true, allows the caller to set values for |
|
6388 readOnly or writeOnce attributes which have already been set.</p> |
|
6389 </div> |
|
6390 |
|
6391 |
|
6392 </li> |
|
6393 |
|
6394 </ul> |
|
6395 </div> |
|
6396 |
|
6397 |
|
6398 |
|
6399 <div class="returns"> |
|
6400 <h4>Returns:</h4> |
|
6401 |
|
6402 <div class="returns-description"> |
|
6403 |
|
6404 |
|
6405 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6406 |
|
6407 A reference to the host object. |
|
6408 |
|
6409 </div> |
|
6410 </div> |
|
6411 |
|
6412 |
|
6413 |
|
6414 </div> |
|
6415 |
|
6416 |
|
6417 <div id="method__setAttrs" class="method item protected inherited"> |
|
6418 <h3 class="name"><code>_setAttrs</code></h3> |
|
6419 |
|
6420 |
|
6421 <div class="args"> |
|
6422 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6423 |
|
6424 <li class="arg"> |
|
6425 |
|
6426 <code>attrs</code> |
|
6427 |
|
6428 </li> |
|
6429 |
|
6430 <li class="arg"> |
|
6431 |
|
6432 <code class="optional">[opts]</code> |
|
6433 |
|
6434 </li> |
|
6435 |
|
6436 </ul><span class="paren">)</span> |
|
6437 </div> |
|
6438 |
|
6439 |
|
6440 |
|
6441 <span class="returns-inline"> |
|
6442 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6443 </span> |
|
6444 |
|
6445 |
|
6446 |
|
6447 |
|
6448 |
|
6449 <span class="flag protected">protected</span> |
|
6450 |
|
6451 |
|
6452 |
|
6453 |
|
6454 |
|
6455 |
|
6456 |
|
6457 <span class="flag chainable">chainable</span> |
|
6458 |
|
6459 |
|
6460 |
|
6461 |
|
6462 <div class="meta"> |
|
6463 |
|
6464 <p>Inherited from |
|
6465 <a href="../classes/AttributeObservable.html#method__setAttrs"> |
|
6466 AttributeObservable |
|
6467 </a> |
|
6468 |
|
6469 but overwritten in |
|
6470 |
|
6471 |
|
6472 |
|
6473 <a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a> |
|
6474 |
|
6475 </p> |
|
6476 |
|
6477 |
|
6478 |
|
6479 |
|
6480 |
|
6481 </div> |
|
6482 |
|
6483 <div class="description"> |
|
6484 <p>Implementation behind the public setAttrs method, to set multiple attribute values.</p> |
|
6485 </div> |
|
6486 |
|
6487 |
|
6488 <div class="params"> |
|
6489 <h4>Parameters:</h4> |
|
6490 |
|
6491 <ul class="params-list"> |
|
6492 |
|
6493 <li class="param"> |
|
6494 |
|
6495 <code class="param-name">attrs</code> |
|
6496 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6497 |
|
6498 |
|
6499 |
|
6500 |
|
6501 <div class="param-description"> |
|
6502 <p>An object with attributes name/value pairs.</p> |
|
6503 </div> |
|
6504 |
|
6505 |
|
6506 </li> |
|
6507 |
|
6508 <li class="param"> |
|
6509 |
|
6510 <code class="param-name optional">[opts]</code> |
|
6511 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6512 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6513 |
|
6514 |
|
6515 |
|
6516 |
|
6517 <div class="param-description"> |
|
6518 <p>Optional data providing the circumstances for the change</p> |
|
6519 </div> |
|
6520 |
|
6521 |
|
6522 </li> |
|
6523 |
|
6524 </ul> |
|
6525 </div> |
|
6526 |
|
6527 |
|
6528 |
|
6529 <div class="returns"> |
|
6530 <h4>Returns:</h4> |
|
6531 |
|
6532 <div class="returns-description"> |
|
6533 |
|
6534 |
|
6535 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
6536 |
|
6537 A reference to the host object. |
|
6538 |
|
6539 </div> |
|
6540 </div> |
|
6541 |
|
6542 |
|
6543 |
|
6544 </div> |
|
6545 |
|
6546 |
|
6547 <div id="method__setAttrVal" class="method item private inherited"> |
|
6548 <h3 class="name"><code>_setAttrVal</code></h3> |
|
6549 |
|
6550 |
|
6551 <div class="args"> |
|
6552 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6553 |
|
6554 <li class="arg"> |
|
6555 |
|
6556 <code>attrName</code> |
|
6557 |
|
6558 </li> |
|
6559 |
|
6560 <li class="arg"> |
|
6561 |
|
6562 <code>subAttrName</code> |
|
6563 |
|
6564 </li> |
|
6565 |
|
6566 <li class="arg"> |
|
6567 |
|
6568 <code>prevVal</code> |
|
6569 |
|
6570 </li> |
|
6571 |
|
6572 <li class="arg"> |
|
6573 |
|
6574 <code>newVal</code> |
|
6575 |
|
6576 </li> |
|
6577 |
|
6578 <li class="arg"> |
|
6579 |
|
6580 <code class="optional">[opts]</code> |
|
6581 |
|
6582 </li> |
|
6583 |
|
6584 <li class="arg"> |
|
6585 |
|
6586 <code class="optional">[attrCfg]</code> |
|
6587 |
|
6588 </li> |
|
6589 |
|
6590 </ul><span class="paren">)</span> |
|
6591 </div> |
|
6592 |
|
6593 |
|
6594 |
|
6595 <span class="returns-inline"> |
|
6596 <span class="type">Booolean</span> |
|
6597 </span> |
|
6598 |
|
6599 |
|
6600 |
|
6601 |
|
6602 |
|
6603 <span class="flag private">private</span> |
|
6604 |
|
6605 |
|
6606 |
|
6607 |
|
6608 |
|
6609 |
|
6610 |
|
6611 |
|
6612 |
|
6613 |
|
6614 <div class="meta"> |
|
6615 |
|
6616 |
|
6617 <p>Inherited from |
|
6618 <a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>: |
|
6619 |
|
6620 |
|
6621 |
|
6622 <a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a> |
|
6623 |
|
6624 </p> |
|
6625 |
|
6626 |
|
6627 |
|
6628 |
|
6629 |
|
6630 </div> |
|
6631 |
|
6632 <div class="description"> |
|
6633 <p>Updates the stored value of the attribute in the privately held State object, |
|
6634 if validation and setter passes.</p> |
|
6635 </div> |
|
6636 |
|
6637 |
|
6638 <div class="params"> |
|
6639 <h4>Parameters:</h4> |
|
6640 |
|
6641 <ul class="params-list"> |
|
6642 |
|
6643 <li class="param"> |
|
6644 |
|
6645 <code class="param-name">attrName</code> |
|
6646 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6647 |
|
6648 |
|
6649 |
|
6650 |
|
6651 <div class="param-description"> |
|
6652 <p>The attribute name.</p> |
|
6653 </div> |
|
6654 |
|
6655 |
|
6656 </li> |
|
6657 |
|
6658 <li class="param"> |
|
6659 |
|
6660 <code class="param-name">subAttrName</code> |
|
6661 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6662 |
|
6663 |
|
6664 |
|
6665 |
|
6666 <div class="param-description"> |
|
6667 <p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p> |
|
6668 </div> |
|
6669 |
|
6670 |
|
6671 </li> |
|
6672 |
|
6673 <li class="param"> |
|
6674 |
|
6675 <code class="param-name">prevVal</code> |
|
6676 <span class="type">Any</span> |
|
6677 |
|
6678 |
|
6679 |
|
6680 |
|
6681 <div class="param-description"> |
|
6682 <p>The currently stored value of the attribute.</p> |
|
6683 </div> |
|
6684 |
|
6685 |
|
6686 </li> |
|
6687 |
|
6688 <li class="param"> |
|
6689 |
|
6690 <code class="param-name">newVal</code> |
|
6691 <span class="type">Any</span> |
|
6692 |
|
6693 |
|
6694 |
|
6695 |
|
6696 <div class="param-description"> |
|
6697 <p>The value which is going to be stored.</p> |
|
6698 </div> |
|
6699 |
|
6700 |
|
6701 </li> |
|
6702 |
|
6703 <li class="param"> |
|
6704 |
|
6705 <code class="param-name optional">[opts]</code> |
|
6706 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6707 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6708 |
|
6709 |
|
6710 |
|
6711 |
|
6712 <div class="param-description"> |
|
6713 <p>Optional data providing the circumstances for the change.</p> |
|
6714 </div> |
|
6715 |
|
6716 |
|
6717 </li> |
|
6718 |
|
6719 <li class="param"> |
|
6720 |
|
6721 <code class="param-name optional">[attrCfg]</code> |
|
6722 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6723 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6724 |
|
6725 |
|
6726 |
|
6727 |
|
6728 <div class="param-description"> |
|
6729 <p>Optional config hash for the attribute. This is added for performance along the critical path, |
|
6730 where the calling method has already obtained the config from state.</p> |
|
6731 </div> |
|
6732 |
|
6733 |
|
6734 </li> |
|
6735 |
|
6736 </ul> |
|
6737 </div> |
|
6738 |
|
6739 |
|
6740 |
|
6741 <div class="returns"> |
|
6742 <h4>Returns:</h4> |
|
6743 |
|
6744 <div class="returns-description"> |
|
6745 |
|
6746 |
|
6747 <span class="type">Booolean</span>: |
|
6748 |
|
6749 true if the new attribute value was stored, false if not. |
|
6750 |
|
6751 </div> |
|
6752 </div> |
|
6753 |
|
6754 |
|
6755 |
|
6756 </div> |
|
6757 |
|
6758 |
|
6759 <div id="method__setStateVal" class="method item private inherited"> |
|
6760 <h3 class="name"><code>_setStateVal</code></h3> |
|
6761 |
|
6762 |
|
6763 <div class="args"> |
|
6764 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6765 |
|
6766 <li class="arg"> |
|
6767 |
|
6768 <code>name</code> |
|
6769 |
|
6770 </li> |
|
6771 |
|
6772 <li class="arg"> |
|
6773 |
|
6774 <code>value</code> |
|
6775 |
|
6776 </li> |
|
6777 |
|
6778 </ul><span class="paren">)</span> |
|
6779 </div> |
|
6780 |
|
6781 |
|
6782 |
|
6783 |
|
6784 |
|
6785 |
|
6786 |
|
6787 <span class="flag private">private</span> |
|
6788 |
|
6789 |
|
6790 |
|
6791 |
|
6792 |
|
6793 |
|
6794 |
|
6795 |
|
6796 |
|
6797 |
|
6798 <div class="meta"> |
|
6799 |
|
6800 |
|
6801 <p>Inherited from |
|
6802 <a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>: |
|
6803 |
|
6804 |
|
6805 |
|
6806 <a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a> |
|
6807 |
|
6808 </p> |
|
6809 |
|
6810 |
|
6811 |
|
6812 |
|
6813 |
|
6814 </div> |
|
6815 |
|
6816 <div class="description"> |
|
6817 <p>Sets the stored value for the attribute, in either the |
|
6818 internal state object, or the state proxy if it exits</p> |
|
6819 </div> |
|
6820 |
|
6821 |
|
6822 <div class="params"> |
|
6823 <h4>Parameters:</h4> |
|
6824 |
|
6825 <ul class="params-list"> |
|
6826 |
|
6827 <li class="param"> |
|
6828 |
|
6829 <code class="param-name">name</code> |
|
6830 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
6831 |
|
6832 |
|
6833 |
|
6834 |
|
6835 <div class="param-description"> |
|
6836 <p>The name of the attribute</p> |
|
6837 </div> |
|
6838 |
|
6839 |
|
6840 </li> |
|
6841 |
|
6842 <li class="param"> |
|
6843 |
|
6844 <code class="param-name">value</code> |
|
6845 <span class="type">Any</span> |
|
6846 |
|
6847 |
|
6848 |
|
6849 |
|
6850 <div class="param-description"> |
|
6851 <p>The value of the attribute</p> |
|
6852 </div> |
|
6853 |
|
6854 |
|
6855 </li> |
|
6856 |
|
6857 </ul> |
|
6858 </div> |
|
6859 |
|
6860 |
|
6861 |
|
6862 |
|
6863 |
|
6864 </div> |
|
6865 |
|
6866 |
|
6867 <div id="method__validate" class="method item protected"> |
|
6868 <h3 class="name"><code>_validate</code></h3> |
|
6869 |
|
6870 |
|
6871 <div class="args"> |
|
6872 <span class="paren">(</span><ul class="args-list inline commas"> |
|
6873 |
|
6874 <li class="arg"> |
|
6875 |
|
6876 <code>attributes</code> |
|
6877 |
|
6878 </li> |
|
6879 |
|
6880 <li class="arg"> |
|
6881 |
|
6882 <code>callback</code> |
|
6883 |
|
6884 </li> |
|
6885 |
|
6886 </ul><span class="paren">)</span> |
|
6887 </div> |
|
6888 |
|
6889 |
|
6890 |
|
6891 |
|
6892 |
|
6893 |
|
6894 |
|
6895 <span class="flag protected">protected</span> |
|
6896 |
|
6897 |
|
6898 |
|
6899 |
|
6900 |
|
6901 |
|
6902 |
|
6903 |
|
6904 |
|
6905 |
|
6906 <div class="meta"> |
|
6907 |
|
6908 |
|
6909 |
|
6910 <p> |
|
6911 |
|
6912 Defined in |
|
6913 |
|
6914 |
|
6915 |
|
6916 |
|
6917 <a href="../files/app_js_model.js.html#l885"><code>app/js/model.js:885</code></a> |
|
6918 |
|
6919 </p> |
|
6920 |
|
6921 |
|
6922 |
|
6923 |
|
6924 |
|
6925 </div> |
|
6926 |
|
6927 <div class="description"> |
|
6928 <p>Calls the public, overridable <code>validate()</code> method and fires an <code>error</code> event |
|
6929 if validation fails.</p> |
|
6930 </div> |
|
6931 |
|
6932 |
|
6933 <div class="params"> |
|
6934 <h4>Parameters:</h4> |
|
6935 |
|
6936 <ul class="params-list"> |
|
6937 |
|
6938 <li class="param"> |
|
6939 |
|
6940 <code class="param-name">attributes</code> |
|
6941 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
6942 |
|
6943 |
|
6944 |
|
6945 |
|
6946 <div class="param-description"> |
|
6947 <p>Attribute hash.</p> |
|
6948 </div> |
|
6949 |
|
6950 |
|
6951 </li> |
|
6952 |
|
6953 <li class="param"> |
|
6954 |
|
6955 <code class="param-name">callback</code> |
|
6956 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
6957 |
|
6958 |
|
6959 |
|
6960 |
|
6961 <div class="param-description"> |
|
6962 <p>Validation callback.</p> |
|
6963 </div> |
|
6964 |
|
6965 |
|
6966 <ul class="params-list"> |
|
6967 |
|
6968 <li class="param"> |
|
6969 |
|
6970 <code class="param-name optional">[err]</code> |
|
6971 <span class="type">Any</span> |
|
6972 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
6973 |
|
6974 |
|
6975 <div class="param-description"> |
|
6976 <p>Value on failure, non-value on success.</p> |
|
6977 </div> |
|
6978 |
|
6979 |
|
6980 </li> |
|
6981 |
|
6982 </ul> |
|
6983 |
|
6984 </li> |
|
6985 |
|
6986 </ul> |
|
6987 </div> |
|
6988 |
|
6989 |
|
6990 |
|
6991 |
|
6992 |
|
6993 </div> |
|
6994 |
|
6995 |
|
6996 <div id="method_addAttr" class="method item protected"> |
|
6997 <h3 class="name"><code>addAttr</code></h3> |
|
6998 |
|
6999 |
|
7000 <div class="args"> |
|
7001 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7002 |
|
7003 <li class="arg"> |
|
7004 |
|
7005 <code>name</code> |
|
7006 |
|
7007 </li> |
|
7008 |
|
7009 <li class="arg"> |
|
7010 |
|
7011 <code>config</code> |
|
7012 |
|
7013 </li> |
|
7014 |
|
7015 <li class="arg"> |
|
7016 |
|
7017 <code>lazy</code> |
|
7018 |
|
7019 </li> |
|
7020 |
|
7021 </ul><span class="paren">)</span> |
|
7022 </div> |
|
7023 |
|
7024 |
|
7025 |
|
7026 <span class="returns-inline"> |
|
7027 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7028 </span> |
|
7029 |
|
7030 |
|
7031 |
|
7032 |
|
7033 |
|
7034 <span class="flag protected">protected</span> |
|
7035 |
|
7036 |
|
7037 |
|
7038 |
|
7039 |
|
7040 |
|
7041 |
|
7042 <span class="flag chainable">chainable</span> |
|
7043 |
|
7044 |
|
7045 |
|
7046 |
|
7047 <div class="meta"> |
|
7048 |
|
7049 <p>Inherited from |
|
7050 <a href="../classes/AttributeCore.html#method_addAttr"> |
|
7051 AttributeCore |
|
7052 </a> |
|
7053 |
|
7054 but overwritten in |
|
7055 |
|
7056 |
|
7057 |
|
7058 <a href="../files/app_js_model.js.html#l812"><code>app/js/model.js:812</code></a> |
|
7059 |
|
7060 </p> |
|
7061 |
|
7062 |
|
7063 |
|
7064 |
|
7065 |
|
7066 </div> |
|
7067 |
|
7068 <div class="description"> |
|
7069 <p>Duckpunches the <code>addAttr</code> method provided by <code>Y.Attribute</code> to keep the |
|
7070 <code>id</code> attribute’s value and a custom id attribute’s (if provided) value |
|
7071 in sync when adding the attributes to the model instance object.</p> |
|
7072 |
|
7073 <p>Marked as protected to hide it from Model's public API docs, even though |
|
7074 this is a public method in Attribute.</p> |
|
7075 </div> |
|
7076 |
|
7077 |
|
7078 <div class="params"> |
|
7079 <h4>Parameters:</h4> |
|
7080 |
|
7081 <ul class="params-list"> |
|
7082 |
|
7083 <li class="param"> |
|
7084 |
|
7085 <code class="param-name">name</code> |
|
7086 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7087 |
|
7088 |
|
7089 |
|
7090 |
|
7091 <div class="param-description"> |
|
7092 <p>The name of the attribute.</p> |
|
7093 </div> |
|
7094 |
|
7095 |
|
7096 </li> |
|
7097 |
|
7098 <li class="param"> |
|
7099 |
|
7100 <code class="param-name">config</code> |
|
7101 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7102 |
|
7103 |
|
7104 |
|
7105 |
|
7106 <div class="param-description"> |
|
7107 <p>An object with attribute configuration property/value |
|
7108 pairs, specifying the configuration for the attribute.</p> |
|
7109 </div> |
|
7110 |
|
7111 |
|
7112 </li> |
|
7113 |
|
7114 <li class="param"> |
|
7115 |
|
7116 <code class="param-name">lazy</code> |
|
7117 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7118 |
|
7119 |
|
7120 |
|
7121 |
|
7122 <div class="param-description"> |
|
7123 <p>(optional) Whether or not to add this attribute lazily |
|
7124 (on the first call to get/set).</p> |
|
7125 </div> |
|
7126 |
|
7127 |
|
7128 </li> |
|
7129 |
|
7130 </ul> |
|
7131 </div> |
|
7132 |
|
7133 |
|
7134 |
|
7135 <div class="returns"> |
|
7136 <h4>Returns:</h4> |
|
7137 |
|
7138 <div class="returns-description"> |
|
7139 |
|
7140 |
|
7141 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
7142 |
|
7143 A reference to the host object. |
|
7144 |
|
7145 </div> |
|
7146 </div> |
|
7147 |
|
7148 |
|
7149 |
|
7150 </div> |
|
7151 |
|
7152 |
|
7153 <div id="method_addAttrs" class="method item inherited"> |
|
7154 <h3 class="name"><code>addAttrs</code></h3> |
|
7155 |
|
7156 |
|
7157 <div class="args"> |
|
7158 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7159 |
|
7160 <li class="arg"> |
|
7161 |
|
7162 <code>cfgs</code> |
|
7163 |
|
7164 </li> |
|
7165 |
|
7166 <li class="arg"> |
|
7167 |
|
7168 <code>values</code> |
|
7169 |
|
7170 </li> |
|
7171 |
|
7172 <li class="arg"> |
|
7173 |
|
7174 <code>lazy</code> |
|
7175 |
|
7176 </li> |
|
7177 |
|
7178 </ul><span class="paren">)</span> |
|
7179 </div> |
|
7180 |
|
7181 |
|
7182 |
|
7183 <span class="returns-inline"> |
|
7184 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7185 </span> |
|
7186 |
|
7187 |
|
7188 |
|
7189 |
|
7190 |
|
7191 |
|
7192 |
|
7193 |
|
7194 |
|
7195 |
|
7196 |
|
7197 <span class="flag chainable">chainable</span> |
|
7198 |
|
7199 |
|
7200 |
|
7201 |
|
7202 <div class="meta"> |
|
7203 |
|
7204 |
|
7205 <p>Inherited from |
|
7206 <a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>: |
|
7207 |
|
7208 |
|
7209 |
|
7210 <a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a> |
|
7211 |
|
7212 </p> |
|
7213 |
|
7214 |
|
7215 |
|
7216 |
|
7217 |
|
7218 </div> |
|
7219 |
|
7220 <div class="description"> |
|
7221 <p>Configures a group of attributes, and sets initial values.</p> |
|
7222 |
|
7223 <p> |
|
7224 <strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning. |
|
7225 The caller is responsible for merging/cloning the configuration object if required. |
|
7226 </p> |
|
7227 </div> |
|
7228 |
|
7229 |
|
7230 <div class="params"> |
|
7231 <h4>Parameters:</h4> |
|
7232 |
|
7233 <ul class="params-list"> |
|
7234 |
|
7235 <li class="param"> |
|
7236 |
|
7237 <code class="param-name">cfgs</code> |
|
7238 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7239 |
|
7240 |
|
7241 |
|
7242 |
|
7243 <div class="param-description"> |
|
7244 <p>An object with attribute name/configuration pairs.</p> |
|
7245 </div> |
|
7246 |
|
7247 |
|
7248 </li> |
|
7249 |
|
7250 <li class="param"> |
|
7251 |
|
7252 <code class="param-name">values</code> |
|
7253 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7254 |
|
7255 |
|
7256 |
|
7257 |
|
7258 <div class="param-description"> |
|
7259 <p>An object with attribute name/value pairs, defining the initial values to apply. |
|
7260 Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p> |
|
7261 </div> |
|
7262 |
|
7263 |
|
7264 </li> |
|
7265 |
|
7266 <li class="param"> |
|
7267 |
|
7268 <code class="param-name">lazy</code> |
|
7269 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7270 |
|
7271 |
|
7272 |
|
7273 |
|
7274 <div class="param-description"> |
|
7275 <p>Whether or not to delay the intialization of these attributes until the first call to get/set. |
|
7276 Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. |
|
7277 See <a href="#method_addAttr">addAttr</a>.</p> |
|
7278 </div> |
|
7279 |
|
7280 |
|
7281 </li> |
|
7282 |
|
7283 </ul> |
|
7284 </div> |
|
7285 |
|
7286 |
|
7287 |
|
7288 <div class="returns"> |
|
7289 <h4>Returns:</h4> |
|
7290 |
|
7291 <div class="returns-description"> |
|
7292 |
|
7293 |
|
7294 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
7295 |
|
7296 A reference to the host object. |
|
7297 |
|
7298 </div> |
|
7299 </div> |
|
7300 |
|
7301 |
|
7302 |
|
7303 </div> |
|
7304 |
|
7305 |
|
7306 <div id="method_addTarget" class="method item inherited"> |
|
7307 <h3 class="name"><code>addTarget</code></h3> |
|
7308 |
|
7309 |
|
7310 <div class="args"> |
|
7311 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7312 |
|
7313 <li class="arg"> |
|
7314 |
|
7315 <code>o</code> |
|
7316 |
|
7317 </li> |
|
7318 |
|
7319 </ul><span class="paren">)</span> |
|
7320 </div> |
|
7321 |
|
7322 |
|
7323 |
|
7324 |
|
7325 |
|
7326 |
|
7327 |
|
7328 |
|
7329 |
|
7330 |
|
7331 |
|
7332 |
|
7333 |
|
7334 |
|
7335 |
|
7336 |
|
7337 <div class="meta"> |
|
7338 |
|
7339 |
|
7340 <p>Inherited from |
|
7341 <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>: |
|
7342 |
|
7343 |
|
7344 |
|
7345 <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a> |
|
7346 |
|
7347 </p> |
|
7348 |
|
7349 |
|
7350 |
|
7351 |
|
7352 |
|
7353 </div> |
|
7354 |
|
7355 <div class="description"> |
|
7356 <p>Registers another EventTarget as a bubble target. Bubble order |
|
7357 is determined by the order registered. Multiple targets can |
|
7358 be specified.</p> |
|
7359 |
|
7360 <p>Events can only bubble if emitFacade is true.</p> |
|
7361 |
|
7362 <p>Included in the event-custom-complex submodule.</p> |
|
7363 </div> |
|
7364 |
|
7365 |
|
7366 <div class="params"> |
|
7367 <h4>Parameters:</h4> |
|
7368 |
|
7369 <ul class="params-list"> |
|
7370 |
|
7371 <li class="param"> |
|
7372 |
|
7373 <code class="param-name">o</code> |
|
7374 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
7375 |
|
7376 |
|
7377 |
|
7378 |
|
7379 <div class="param-description"> |
|
7380 <p>the target to add</p> |
|
7381 </div> |
|
7382 |
|
7383 |
|
7384 </li> |
|
7385 |
|
7386 </ul> |
|
7387 </div> |
|
7388 |
|
7389 |
|
7390 |
|
7391 |
|
7392 |
|
7393 </div> |
|
7394 |
|
7395 |
|
7396 <div id="method_after" class="method item inherited"> |
|
7397 <h3 class="name"><code>after</code></h3> |
|
7398 |
|
7399 |
|
7400 <div class="args"> |
|
7401 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7402 |
|
7403 <li class="arg"> |
|
7404 |
|
7405 <code>type</code> |
|
7406 |
|
7407 </li> |
|
7408 |
|
7409 <li class="arg"> |
|
7410 |
|
7411 <code>fn</code> |
|
7412 |
|
7413 </li> |
|
7414 |
|
7415 <li class="arg"> |
|
7416 |
|
7417 <code class="optional">[context]</code> |
|
7418 |
|
7419 </li> |
|
7420 |
|
7421 <li class="arg"> |
|
7422 |
|
7423 <code class="optional">[arg*]</code> |
|
7424 |
|
7425 </li> |
|
7426 |
|
7427 </ul><span class="paren">)</span> |
|
7428 </div> |
|
7429 |
|
7430 |
|
7431 |
|
7432 <span class="returns-inline"> |
|
7433 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
7434 </span> |
|
7435 |
|
7436 |
|
7437 |
|
7438 |
|
7439 |
|
7440 |
|
7441 |
|
7442 |
|
7443 |
|
7444 |
|
7445 |
|
7446 |
|
7447 |
|
7448 |
|
7449 <div class="meta"> |
|
7450 |
|
7451 |
|
7452 <p>Inherited from |
|
7453 <a href="../classes/EventTarget.html#method_after">EventTarget</a>: |
|
7454 |
|
7455 |
|
7456 |
|
7457 <a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a> |
|
7458 |
|
7459 </p> |
|
7460 |
|
7461 |
|
7462 |
|
7463 |
|
7464 |
|
7465 </div> |
|
7466 |
|
7467 <div class="description"> |
|
7468 <p>Subscribe to a custom event hosted by this object. The |
|
7469 supplied callback will execute after any listeners add |
|
7470 via the subscribe method, and after the default function, |
|
7471 if configured for the event, has executed.</p> |
|
7472 </div> |
|
7473 |
|
7474 |
|
7475 <div class="params"> |
|
7476 <h4>Parameters:</h4> |
|
7477 |
|
7478 <ul class="params-list"> |
|
7479 |
|
7480 <li class="param"> |
|
7481 |
|
7482 <code class="param-name">type</code> |
|
7483 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7484 |
|
7485 |
|
7486 |
|
7487 |
|
7488 <div class="param-description"> |
|
7489 <p>The name of the event</p> |
|
7490 </div> |
|
7491 |
|
7492 |
|
7493 </li> |
|
7494 |
|
7495 <li class="param"> |
|
7496 |
|
7497 <code class="param-name">fn</code> |
|
7498 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
7499 |
|
7500 |
|
7501 |
|
7502 |
|
7503 <div class="param-description"> |
|
7504 <p>The callback to execute in response to the event</p> |
|
7505 </div> |
|
7506 |
|
7507 |
|
7508 </li> |
|
7509 |
|
7510 <li class="param"> |
|
7511 |
|
7512 <code class="param-name optional">[context]</code> |
|
7513 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7514 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7515 |
|
7516 |
|
7517 |
|
7518 |
|
7519 <div class="param-description"> |
|
7520 <p>Override <code>this</code> object in callback</p> |
|
7521 </div> |
|
7522 |
|
7523 |
|
7524 </li> |
|
7525 |
|
7526 <li class="param"> |
|
7527 |
|
7528 <code class="param-name optional">[arg*]</code> |
|
7529 <span class="type">Any</span> |
|
7530 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7531 |
|
7532 |
|
7533 |
|
7534 |
|
7535 <div class="param-description"> |
|
7536 <p>0..n additional arguments to supply to the subscriber</p> |
|
7537 </div> |
|
7538 |
|
7539 |
|
7540 </li> |
|
7541 |
|
7542 </ul> |
|
7543 </div> |
|
7544 |
|
7545 |
|
7546 |
|
7547 <div class="returns"> |
|
7548 <h4>Returns:</h4> |
|
7549 |
|
7550 <div class="returns-description"> |
|
7551 |
|
7552 |
|
7553 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
7554 |
|
7555 A subscription handle capable of detaching the |
|
7556 subscription |
|
7557 |
|
7558 </div> |
|
7559 </div> |
|
7560 |
|
7561 |
|
7562 |
|
7563 </div> |
|
7564 |
|
7565 |
|
7566 <div id="method_attrAdded" class="method item inherited"> |
|
7567 <h3 class="name"><code>attrAdded</code></h3> |
|
7568 |
|
7569 |
|
7570 <div class="args"> |
|
7571 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7572 |
|
7573 <li class="arg"> |
|
7574 |
|
7575 <code>name</code> |
|
7576 |
|
7577 </li> |
|
7578 |
|
7579 </ul><span class="paren">)</span> |
|
7580 </div> |
|
7581 |
|
7582 |
|
7583 |
|
7584 <span class="returns-inline"> |
|
7585 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7586 </span> |
|
7587 |
|
7588 |
|
7589 |
|
7590 |
|
7591 |
|
7592 |
|
7593 |
|
7594 |
|
7595 |
|
7596 |
|
7597 |
|
7598 |
|
7599 |
|
7600 |
|
7601 <div class="meta"> |
|
7602 |
|
7603 |
|
7604 <p>Inherited from |
|
7605 <a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>: |
|
7606 |
|
7607 |
|
7608 |
|
7609 <a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a> |
|
7610 |
|
7611 </p> |
|
7612 |
|
7613 |
|
7614 |
|
7615 |
|
7616 |
|
7617 </div> |
|
7618 |
|
7619 <div class="description"> |
|
7620 <p>Checks if the given attribute has been added to the host</p> |
|
7621 </div> |
|
7622 |
|
7623 |
|
7624 <div class="params"> |
|
7625 <h4>Parameters:</h4> |
|
7626 |
|
7627 <ul class="params-list"> |
|
7628 |
|
7629 <li class="param"> |
|
7630 |
|
7631 <code class="param-name">name</code> |
|
7632 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
7633 |
|
7634 |
|
7635 |
|
7636 |
|
7637 <div class="param-description"> |
|
7638 <p>The name of the attribute to check.</p> |
|
7639 </div> |
|
7640 |
|
7641 |
|
7642 </li> |
|
7643 |
|
7644 </ul> |
|
7645 </div> |
|
7646 |
|
7647 |
|
7648 |
|
7649 <div class="returns"> |
|
7650 <h4>Returns:</h4> |
|
7651 |
|
7652 <div class="returns-description"> |
|
7653 |
|
7654 |
|
7655 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7656 |
|
7657 true if an attribute with the given name has been added, false if it hasn't. |
|
7658 This method will return true for lazily added attributes. |
|
7659 |
|
7660 </div> |
|
7661 </div> |
|
7662 |
|
7663 |
|
7664 |
|
7665 </div> |
|
7666 |
|
7667 |
|
7668 <div id="method_before" class="method item inherited"> |
|
7669 <h3 class="name"><code>before</code></h3> |
|
7670 |
|
7671 |
|
7672 <span class="paren">()</span> |
|
7673 |
|
7674 |
|
7675 |
|
7676 <span class="returns-inline"> |
|
7677 <span class="type"></span> |
|
7678 </span> |
|
7679 |
|
7680 |
|
7681 |
|
7682 |
|
7683 |
|
7684 |
|
7685 |
|
7686 |
|
7687 |
|
7688 |
|
7689 |
|
7690 |
|
7691 |
|
7692 |
|
7693 <div class="meta"> |
|
7694 |
|
7695 |
|
7696 <p>Inherited from |
|
7697 <a href="../classes/EventTarget.html#method_before">EventTarget</a>: |
|
7698 |
|
7699 |
|
7700 |
|
7701 <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a> |
|
7702 |
|
7703 </p> |
|
7704 |
|
7705 |
|
7706 |
|
7707 |
|
7708 |
|
7709 </div> |
|
7710 |
|
7711 <div class="description"> |
|
7712 <p>Executes the callback before a DOM event, custom event |
|
7713 or method. If the first argument is a function, it |
|
7714 is assumed the target is a method. For DOM and custom |
|
7715 events, this is an alias for Y.on.</p> |
|
7716 |
|
7717 <p>For DOM and custom events: |
|
7718 type, callback, context, 0-n arguments</p> |
|
7719 |
|
7720 <p>For methods: |
|
7721 callback, object (method host), methodName, context, 0-n arguments</p> |
|
7722 </div> |
|
7723 |
|
7724 |
|
7725 |
|
7726 |
|
7727 <div class="returns"> |
|
7728 <h4>Returns:</h4> |
|
7729 |
|
7730 <div class="returns-description"> |
|
7731 |
|
7732 |
|
7733 detach handle |
|
7734 |
|
7735 </div> |
|
7736 </div> |
|
7737 |
|
7738 |
|
7739 |
|
7740 </div> |
|
7741 |
|
7742 |
|
7743 <div id="method_bubble" class="method item inherited"> |
|
7744 <h3 class="name"><code>bubble</code></h3> |
|
7745 |
|
7746 |
|
7747 <div class="args"> |
|
7748 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7749 |
|
7750 <li class="arg"> |
|
7751 |
|
7752 <code>evt</code> |
|
7753 |
|
7754 </li> |
|
7755 |
|
7756 </ul><span class="paren">)</span> |
|
7757 </div> |
|
7758 |
|
7759 |
|
7760 |
|
7761 <span class="returns-inline"> |
|
7762 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7763 </span> |
|
7764 |
|
7765 |
|
7766 |
|
7767 |
|
7768 |
|
7769 |
|
7770 |
|
7771 |
|
7772 |
|
7773 |
|
7774 |
|
7775 |
|
7776 |
|
7777 |
|
7778 <div class="meta"> |
|
7779 |
|
7780 |
|
7781 <p>Inherited from |
|
7782 <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>: |
|
7783 |
|
7784 |
|
7785 |
|
7786 <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a> |
|
7787 |
|
7788 </p> |
|
7789 |
|
7790 |
|
7791 |
|
7792 |
|
7793 |
|
7794 </div> |
|
7795 |
|
7796 <div class="description"> |
|
7797 <p>Propagate an event. Requires the event-custom-complex module.</p> |
|
7798 </div> |
|
7799 |
|
7800 |
|
7801 <div class="params"> |
|
7802 <h4>Parameters:</h4> |
|
7803 |
|
7804 <ul class="params-list"> |
|
7805 |
|
7806 <li class="param"> |
|
7807 |
|
7808 <code class="param-name">evt</code> |
|
7809 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
7810 |
|
7811 |
|
7812 |
|
7813 |
|
7814 <div class="param-description"> |
|
7815 <p>the custom event to propagate</p> |
|
7816 </div> |
|
7817 |
|
7818 |
|
7819 </li> |
|
7820 |
|
7821 </ul> |
|
7822 </div> |
|
7823 |
|
7824 |
|
7825 |
|
7826 <div class="returns"> |
|
7827 <h4>Returns:</h4> |
|
7828 |
|
7829 <div class="returns-description"> |
|
7830 |
|
7831 |
|
7832 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
7833 |
|
7834 the aggregated return value from Event.Custom.fire |
|
7835 |
|
7836 </div> |
|
7837 </div> |
|
7838 |
|
7839 |
|
7840 |
|
7841 </div> |
|
7842 |
|
7843 |
|
7844 <div id="method_destroy" class="method item"> |
|
7845 <h3 class="name"><code>destroy</code></h3> |
|
7846 |
|
7847 |
|
7848 <div class="args"> |
|
7849 <span class="paren">(</span><ul class="args-list inline commas"> |
|
7850 |
|
7851 <li class="arg"> |
|
7852 |
|
7853 <code class="optional">[options]</code> |
|
7854 |
|
7855 </li> |
|
7856 |
|
7857 <li class="arg"> |
|
7858 |
|
7859 <code class="optional">[callback]</code> |
|
7860 |
|
7861 </li> |
|
7862 |
|
7863 </ul><span class="paren">)</span> |
|
7864 </div> |
|
7865 |
|
7866 |
|
7867 |
|
7868 |
|
7869 |
|
7870 |
|
7871 |
|
7872 |
|
7873 |
|
7874 |
|
7875 |
|
7876 |
|
7877 |
|
7878 <span class="flag chainable">chainable</span> |
|
7879 |
|
7880 |
|
7881 |
|
7882 |
|
7883 <div class="meta"> |
|
7884 |
|
7885 <p>Inherited from |
|
7886 <a href="../classes/BaseObservable.html#method_destroy"> |
|
7887 BaseObservable |
|
7888 </a> |
|
7889 |
|
7890 but overwritten in |
|
7891 |
|
7892 |
|
7893 |
|
7894 <a href="../files/app_js_model.js.html#l205"><code>app/js/model.js:205</code></a> |
|
7895 |
|
7896 </p> |
|
7897 |
|
7898 |
|
7899 |
|
7900 |
|
7901 |
|
7902 </div> |
|
7903 |
|
7904 <div class="description"> |
|
7905 <p>Destroys this model instance and removes it from its containing lists, if |
|
7906 any.</p> |
|
7907 |
|
7908 <p>The <em>callback</em>, if one is provided, will be called after the model is |
|
7909 destroyed.</p> |
|
7910 |
|
7911 <p>If <code>options.remove</code> is <code>true</code>, then this method delegates to the <code>sync()</code> |
|
7912 method to delete the model from the persistence layer, which is an |
|
7913 asynchronous action. In this case, the <em>callback</em> (if provided) will be |
|
7914 called after the sync layer indicates success or failure of the delete |
|
7915 operation.</p> |
|
7916 </div> |
|
7917 |
|
7918 |
|
7919 <div class="params"> |
|
7920 <h4>Parameters:</h4> |
|
7921 |
|
7922 <ul class="params-list"> |
|
7923 |
|
7924 <li class="param"> |
|
7925 |
|
7926 <code class="param-name optional">[options]</code> |
|
7927 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
7928 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7929 |
|
7930 |
|
7931 |
|
7932 |
|
7933 <div class="param-description"> |
|
7934 <p>Sync options. It's up to the custom sync |
|
7935 implementation to determine what options it supports or requires, if |
|
7936 any.</p> |
|
7937 </div> |
|
7938 |
|
7939 |
|
7940 <ul class="params-list"> |
|
7941 |
|
7942 <li class="param"> |
|
7943 |
|
7944 <code class="param-name optional">[remove=false]</code> |
|
7945 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
7946 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7947 |
|
7948 |
|
7949 <div class="param-description"> |
|
7950 <p>If <code>true</code>, the model will be |
|
7951 deleted via the sync layer in addition to the instance being destroyed.</p> |
|
7952 </div> |
|
7953 |
|
7954 |
|
7955 </li> |
|
7956 |
|
7957 </ul> |
|
7958 |
|
7959 </li> |
|
7960 |
|
7961 <li class="param"> |
|
7962 |
|
7963 <code class="param-name optional">[callback]</code> |
|
7964 <span class="type">Callback</span> |
|
7965 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
7966 |
|
7967 |
|
7968 |
|
7969 |
|
7970 <div class="param-description"> |
|
7971 <p>Called after the model has been destroyed (and |
|
7972 deleted via the sync layer if <code>options.remove</code> is <code>true</code>).</p> |
|
7973 </div> |
|
7974 |
|
7975 |
|
7976 <ul class="params-list"> |
|
7977 |
|
7978 <li class="param"> |
|
7979 |
|
7980 <code class="param-name">err</code> |
|
7981 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
7982 |
|
7983 |
|
7984 <div class="param-description"> |
|
7985 <p>If an error occurred, this parameter will |
|
7986 contain the error. Otherwise <em>err</em> will be <code>null</code>.</p> |
|
7987 </div> |
|
7988 |
|
7989 |
|
7990 </li> |
|
7991 |
|
7992 </ul> |
|
7993 |
|
7994 </li> |
|
7995 |
|
7996 </ul> |
|
7997 </div> |
|
7998 |
|
7999 |
|
8000 |
|
8001 |
|
8002 |
|
8003 </div> |
|
8004 |
|
8005 |
|
8006 <div id="method_detach" class="method item inherited"> |
|
8007 <h3 class="name"><code>detach</code></h3> |
|
8008 |
|
8009 |
|
8010 <div class="args"> |
|
8011 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8012 |
|
8013 <li class="arg"> |
|
8014 |
|
8015 <code>type</code> |
|
8016 |
|
8017 </li> |
|
8018 |
|
8019 <li class="arg"> |
|
8020 |
|
8021 <code>fn</code> |
|
8022 |
|
8023 </li> |
|
8024 |
|
8025 <li class="arg"> |
|
8026 |
|
8027 <code>context</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="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
8038 </span> |
|
8039 |
|
8040 |
|
8041 |
|
8042 |
|
8043 |
|
8044 |
|
8045 |
|
8046 |
|
8047 |
|
8048 |
|
8049 |
|
8050 |
|
8051 |
|
8052 |
|
8053 <div class="meta"> |
|
8054 |
|
8055 |
|
8056 <p>Inherited from |
|
8057 <a href="../classes/EventTarget.html#method_detach">EventTarget</a>: |
|
8058 |
|
8059 |
|
8060 |
|
8061 <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a> |
|
8062 |
|
8063 </p> |
|
8064 |
|
8065 |
|
8066 |
|
8067 |
|
8068 |
|
8069 </div> |
|
8070 |
|
8071 <div class="description"> |
|
8072 <p>Detach one or more listeners the from the specified event</p> |
|
8073 </div> |
|
8074 |
|
8075 |
|
8076 <div class="params"> |
|
8077 <h4>Parameters:</h4> |
|
8078 |
|
8079 <ul class="params-list"> |
|
8080 |
|
8081 <li class="param"> |
|
8082 |
|
8083 <code class="param-name">type</code> |
|
8084 <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> |
|
8085 |
|
8086 |
|
8087 |
|
8088 |
|
8089 <div class="param-description"> |
|
8090 <p>Either the handle to the subscriber or the |
|
8091 type of event. If the type |
|
8092 is not specified, it will attempt to remove |
|
8093 the listener from all hosted events.</p> |
|
8094 </div> |
|
8095 |
|
8096 |
|
8097 </li> |
|
8098 |
|
8099 <li class="param"> |
|
8100 |
|
8101 <code class="param-name">fn</code> |
|
8102 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
8103 |
|
8104 |
|
8105 |
|
8106 |
|
8107 <div class="param-description"> |
|
8108 <p>The subscribed function to unsubscribe, if not |
|
8109 supplied, all subscribers will be removed.</p> |
|
8110 </div> |
|
8111 |
|
8112 |
|
8113 </li> |
|
8114 |
|
8115 <li class="param"> |
|
8116 |
|
8117 <code class="param-name">context</code> |
|
8118 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8119 |
|
8120 |
|
8121 |
|
8122 |
|
8123 <div class="param-description"> |
|
8124 <p>The custom object passed to subscribe. This is |
|
8125 optional, but if supplied will be used to |
|
8126 disambiguate multiple listeners that are the same |
|
8127 (e.g., you subscribe many object using a function |
|
8128 that lives on the prototype)</p> |
|
8129 </div> |
|
8130 |
|
8131 |
|
8132 </li> |
|
8133 |
|
8134 </ul> |
|
8135 </div> |
|
8136 |
|
8137 |
|
8138 |
|
8139 <div class="returns"> |
|
8140 <h4>Returns:</h4> |
|
8141 |
|
8142 <div class="returns-description"> |
|
8143 |
|
8144 |
|
8145 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
8146 |
|
8147 the host |
|
8148 |
|
8149 </div> |
|
8150 </div> |
|
8151 |
|
8152 |
|
8153 |
|
8154 </div> |
|
8155 |
|
8156 |
|
8157 <div id="method_detachAll" class="method item inherited"> |
|
8158 <h3 class="name"><code>detachAll</code></h3> |
|
8159 |
|
8160 |
|
8161 <div class="args"> |
|
8162 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8163 |
|
8164 <li class="arg"> |
|
8165 |
|
8166 <code>type</code> |
|
8167 |
|
8168 </li> |
|
8169 |
|
8170 </ul><span class="paren">)</span> |
|
8171 </div> |
|
8172 |
|
8173 |
|
8174 |
|
8175 |
|
8176 |
|
8177 |
|
8178 |
|
8179 |
|
8180 |
|
8181 |
|
8182 |
|
8183 |
|
8184 |
|
8185 |
|
8186 |
|
8187 |
|
8188 <div class="meta"> |
|
8189 |
|
8190 |
|
8191 <p>Inherited from |
|
8192 <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>: |
|
8193 |
|
8194 |
|
8195 |
|
8196 <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a> |
|
8197 |
|
8198 </p> |
|
8199 |
|
8200 |
|
8201 |
|
8202 |
|
8203 |
|
8204 </div> |
|
8205 |
|
8206 <div class="description"> |
|
8207 <p>Removes all listeners from the specified event. If the event type |
|
8208 is not specified, all listeners from all hosted custom events will |
|
8209 be removed.</p> |
|
8210 </div> |
|
8211 |
|
8212 |
|
8213 <div class="params"> |
|
8214 <h4>Parameters:</h4> |
|
8215 |
|
8216 <ul class="params-list"> |
|
8217 |
|
8218 <li class="param"> |
|
8219 |
|
8220 <code class="param-name">type</code> |
|
8221 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8222 |
|
8223 |
|
8224 |
|
8225 |
|
8226 <div class="param-description"> |
|
8227 <p>The type, or name of the event</p> |
|
8228 </div> |
|
8229 |
|
8230 |
|
8231 </li> |
|
8232 |
|
8233 </ul> |
|
8234 </div> |
|
8235 |
|
8236 |
|
8237 |
|
8238 |
|
8239 |
|
8240 </div> |
|
8241 |
|
8242 |
|
8243 <div id="method_fire" class="method item inherited"> |
|
8244 <h3 class="name"><code>fire</code></h3> |
|
8245 |
|
8246 |
|
8247 <div class="args"> |
|
8248 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8249 |
|
8250 <li class="arg"> |
|
8251 |
|
8252 <code>type</code> |
|
8253 |
|
8254 </li> |
|
8255 |
|
8256 <li class="arg"> |
|
8257 |
|
8258 <code>arguments</code> |
|
8259 |
|
8260 </li> |
|
8261 |
|
8262 </ul><span class="paren">)</span> |
|
8263 </div> |
|
8264 |
|
8265 |
|
8266 |
|
8267 <span class="returns-inline"> |
|
8268 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
8269 </span> |
|
8270 |
|
8271 |
|
8272 |
|
8273 |
|
8274 |
|
8275 |
|
8276 |
|
8277 |
|
8278 |
|
8279 |
|
8280 |
|
8281 |
|
8282 |
|
8283 |
|
8284 <div class="meta"> |
|
8285 |
|
8286 |
|
8287 <p>Inherited from |
|
8288 <a href="../classes/EventTarget.html#method_fire">EventTarget</a>: |
|
8289 |
|
8290 |
|
8291 |
|
8292 <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a> |
|
8293 |
|
8294 </p> |
|
8295 |
|
8296 |
|
8297 |
|
8298 |
|
8299 |
|
8300 </div> |
|
8301 |
|
8302 <div class="description"> |
|
8303 <p>Fire a custom event by name. The callback functions will be executed |
|
8304 from the context specified when the event was created, and with the |
|
8305 following parameters.</p> |
|
8306 |
|
8307 <p>If the custom event object hasn't been created, then the event hasn't |
|
8308 been published and it has no subscribers. For performance sake, we |
|
8309 immediate exit in this case. This means the event won't bubble, so |
|
8310 if the intention is that a bubble target be notified, the event must |
|
8311 be published on this object first.</p> |
|
8312 |
|
8313 <p>The first argument is the event type, and any additional arguments are |
|
8314 passed to the listeners as parameters. If the first of these is an |
|
8315 object literal, and the event is configured to emit an event facade, |
|
8316 that object is mixed into the event facade and the facade is provided |
|
8317 in place of the original object.</p> |
|
8318 </div> |
|
8319 |
|
8320 |
|
8321 <div class="params"> |
|
8322 <h4>Parameters:</h4> |
|
8323 |
|
8324 <ul class="params-list"> |
|
8325 |
|
8326 <li class="param"> |
|
8327 |
|
8328 <code class="param-name">type</code> |
|
8329 <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> |
|
8330 |
|
8331 |
|
8332 |
|
8333 |
|
8334 <div class="param-description"> |
|
8335 <p>The type of the event, or an object that contains |
|
8336 a 'type' property.</p> |
|
8337 </div> |
|
8338 |
|
8339 |
|
8340 </li> |
|
8341 |
|
8342 <li class="param"> |
|
8343 |
|
8344 <code class="param-name">arguments</code> |
|
8345 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span> |
|
8346 |
|
8347 |
|
8348 |
|
8349 |
|
8350 <div class="param-description"> |
|
8351 <p>an arbitrary set of parameters to pass to |
|
8352 the handler. If the first of these is an object literal and the event is |
|
8353 configured to emit an event facade, the event facade will replace that |
|
8354 parameter after the properties the object literal contains are copied to |
|
8355 the event facade.</p> |
|
8356 </div> |
|
8357 |
|
8358 |
|
8359 </li> |
|
8360 |
|
8361 </ul> |
|
8362 </div> |
|
8363 |
|
8364 |
|
8365 |
|
8366 <div class="returns"> |
|
8367 <h4>Returns:</h4> |
|
8368 |
|
8369 <div class="returns-description"> |
|
8370 |
|
8371 |
|
8372 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>: |
|
8373 |
|
8374 the event host |
|
8375 |
|
8376 </div> |
|
8377 </div> |
|
8378 |
|
8379 |
|
8380 |
|
8381 </div> |
|
8382 |
|
8383 |
|
8384 <div id="method_generateClientId" class="method item"> |
|
8385 <h3 class="name"><code>generateClientId</code></h3> |
|
8386 |
|
8387 |
|
8388 <span class="paren">()</span> |
|
8389 |
|
8390 |
|
8391 |
|
8392 <span class="returns-inline"> |
|
8393 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8394 </span> |
|
8395 |
|
8396 |
|
8397 |
|
8398 |
|
8399 |
|
8400 |
|
8401 |
|
8402 |
|
8403 |
|
8404 |
|
8405 |
|
8406 |
|
8407 |
|
8408 |
|
8409 <div class="meta"> |
|
8410 |
|
8411 |
|
8412 |
|
8413 <p> |
|
8414 |
|
8415 Defined in |
|
8416 |
|
8417 |
|
8418 |
|
8419 |
|
8420 <a href="../files/app_js_model.js.html#l260"><code>app/js/model.js:260</code></a> |
|
8421 |
|
8422 </p> |
|
8423 |
|
8424 |
|
8425 |
|
8426 |
|
8427 |
|
8428 </div> |
|
8429 |
|
8430 <div class="description"> |
|
8431 <p>Returns a clientId string that's unique among all models on the current page |
|
8432 (even models in other YUI instances). Uniqueness across pageviews is |
|
8433 unlikely.</p> |
|
8434 </div> |
|
8435 |
|
8436 |
|
8437 |
|
8438 |
|
8439 <div class="returns"> |
|
8440 <h4>Returns:</h4> |
|
8441 |
|
8442 <div class="returns-description"> |
|
8443 |
|
8444 |
|
8445 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
8446 |
|
8447 Unique clientId. |
|
8448 |
|
8449 </div> |
|
8450 </div> |
|
8451 |
|
8452 |
|
8453 |
|
8454 </div> |
|
8455 |
|
8456 |
|
8457 <div id="method_get" class="method item"> |
|
8458 <h3 class="name"><code>get</code></h3> |
|
8459 |
|
8460 |
|
8461 <div class="args"> |
|
8462 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8463 |
|
8464 <li class="arg"> |
|
8465 |
|
8466 <code>name</code> |
|
8467 |
|
8468 </li> |
|
8469 |
|
8470 </ul><span class="paren">)</span> |
|
8471 </div> |
|
8472 |
|
8473 |
|
8474 |
|
8475 <span class="returns-inline"> |
|
8476 <span class="type">Any</span> |
|
8477 </span> |
|
8478 |
|
8479 |
|
8480 |
|
8481 |
|
8482 |
|
8483 |
|
8484 |
|
8485 |
|
8486 |
|
8487 |
|
8488 |
|
8489 |
|
8490 |
|
8491 |
|
8492 <div class="meta"> |
|
8493 |
|
8494 <p>Inherited from |
|
8495 <a href="../classes/AttributeCore.html#method_get"> |
|
8496 AttributeCore |
|
8497 </a> |
|
8498 |
|
8499 but overwritten in |
|
8500 |
|
8501 |
|
8502 |
|
8503 <a href="../files/app_js_model.js.html#l273"><code>app/js/model.js:273</code></a> |
|
8504 |
|
8505 </p> |
|
8506 |
|
8507 |
|
8508 |
|
8509 |
|
8510 |
|
8511 </div> |
|
8512 |
|
8513 <div class="description"> |
|
8514 <p>Returns the value of the specified attribute.</p> |
|
8515 |
|
8516 <p>If the attribute's value is an object, <em>name</em> may use dot notation to |
|
8517 specify the path to a specific property within the object, and the value of |
|
8518 that property will be returned.</p> |
|
8519 </div> |
|
8520 |
|
8521 |
|
8522 <div class="params"> |
|
8523 <h4>Parameters:</h4> |
|
8524 |
|
8525 <ul class="params-list"> |
|
8526 |
|
8527 <li class="param"> |
|
8528 |
|
8529 <code class="param-name">name</code> |
|
8530 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8531 |
|
8532 |
|
8533 |
|
8534 |
|
8535 <div class="param-description"> |
|
8536 <p>Attribute name or object property path.</p> |
|
8537 </div> |
|
8538 |
|
8539 |
|
8540 </li> |
|
8541 |
|
8542 </ul> |
|
8543 </div> |
|
8544 |
|
8545 |
|
8546 |
|
8547 <div class="returns"> |
|
8548 <h4>Returns:</h4> |
|
8549 |
|
8550 <div class="returns-description"> |
|
8551 |
|
8552 |
|
8553 <span class="type">Any</span>: |
|
8554 |
|
8555 Attribute value, or <code>undefined</code> if the attribute doesn't |
|
8556 exist. |
|
8557 |
|
8558 </div> |
|
8559 </div> |
|
8560 |
|
8561 |
|
8562 |
|
8563 <div class="example"> |
|
8564 <h4>Example:</h4> |
|
8565 |
|
8566 <div class="example-content"> |
|
8567 <pre class="code prettyprint"><code>// Set the 'foo' attribute to an object. |
|
8568 myModel.set('foo', { |
|
8569 bar: { |
|
8570 baz: 'quux' |
|
8571 } |
|
8572 }); |
|
8573 |
|
8574 // Get the value of 'foo'. |
|
8575 myModel.get('foo'); |
|
8576 // => {bar: {baz: 'quux'}} |
|
8577 |
|
8578 // Get the value of 'foo.bar.baz'. |
|
8579 myModel.get('foo.bar.baz'); |
|
8580 // => 'quux' |
|
8581 </code></pre> |
|
8582 </div> |
|
8583 </div> |
|
8584 |
|
8585 </div> |
|
8586 |
|
8587 |
|
8588 <div id="method_getAsHTML" class="method item"> |
|
8589 <h3 class="name"><code>getAsHTML</code></h3> |
|
8590 |
|
8591 |
|
8592 <div class="args"> |
|
8593 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8594 |
|
8595 <li class="arg"> |
|
8596 |
|
8597 <code>name</code> |
|
8598 |
|
8599 </li> |
|
8600 |
|
8601 </ul><span class="paren">)</span> |
|
8602 </div> |
|
8603 |
|
8604 |
|
8605 |
|
8606 <span class="returns-inline"> |
|
8607 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8608 </span> |
|
8609 |
|
8610 |
|
8611 |
|
8612 |
|
8613 |
|
8614 |
|
8615 |
|
8616 |
|
8617 |
|
8618 |
|
8619 |
|
8620 |
|
8621 |
|
8622 |
|
8623 <div class="meta"> |
|
8624 |
|
8625 |
|
8626 |
|
8627 <p> |
|
8628 |
|
8629 Defined in |
|
8630 |
|
8631 |
|
8632 |
|
8633 |
|
8634 <a href="../files/app_js_model.js.html#l304"><code>app/js/model.js:304</code></a> |
|
8635 |
|
8636 </p> |
|
8637 |
|
8638 |
|
8639 |
|
8640 |
|
8641 |
|
8642 </div> |
|
8643 |
|
8644 <div class="description"> |
|
8645 <p>Returns an HTML-escaped version of the value of the specified string |
|
8646 attribute. The value is escaped using <code>Y.Escape.html()</code>.</p> |
|
8647 </div> |
|
8648 |
|
8649 |
|
8650 <div class="params"> |
|
8651 <h4>Parameters:</h4> |
|
8652 |
|
8653 <ul class="params-list"> |
|
8654 |
|
8655 <li class="param"> |
|
8656 |
|
8657 <code class="param-name">name</code> |
|
8658 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8659 |
|
8660 |
|
8661 |
|
8662 |
|
8663 <div class="param-description"> |
|
8664 <p>Attribute name or object property path.</p> |
|
8665 </div> |
|
8666 |
|
8667 |
|
8668 </li> |
|
8669 |
|
8670 </ul> |
|
8671 </div> |
|
8672 |
|
8673 |
|
8674 |
|
8675 <div class="returns"> |
|
8676 <h4>Returns:</h4> |
|
8677 |
|
8678 <div class="returns-description"> |
|
8679 |
|
8680 |
|
8681 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
8682 |
|
8683 HTML-escaped attribute value. |
|
8684 |
|
8685 </div> |
|
8686 </div> |
|
8687 |
|
8688 |
|
8689 |
|
8690 </div> |
|
8691 |
|
8692 |
|
8693 <div id="method_getAsURL" class="method item"> |
|
8694 <h3 class="name"><code>getAsURL</code></h3> |
|
8695 |
|
8696 |
|
8697 <div class="args"> |
|
8698 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8699 |
|
8700 <li class="arg"> |
|
8701 |
|
8702 <code>name</code> |
|
8703 |
|
8704 </li> |
|
8705 |
|
8706 </ul><span class="paren">)</span> |
|
8707 </div> |
|
8708 |
|
8709 |
|
8710 |
|
8711 <span class="returns-inline"> |
|
8712 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8713 </span> |
|
8714 |
|
8715 |
|
8716 |
|
8717 |
|
8718 |
|
8719 |
|
8720 |
|
8721 |
|
8722 |
|
8723 |
|
8724 |
|
8725 |
|
8726 |
|
8727 |
|
8728 <div class="meta"> |
|
8729 |
|
8730 |
|
8731 |
|
8732 <p> |
|
8733 |
|
8734 Defined in |
|
8735 |
|
8736 |
|
8737 |
|
8738 |
|
8739 <a href="../files/app_js_model.js.html#l317"><code>app/js/model.js:317</code></a> |
|
8740 |
|
8741 </p> |
|
8742 |
|
8743 |
|
8744 |
|
8745 |
|
8746 |
|
8747 </div> |
|
8748 |
|
8749 <div class="description"> |
|
8750 <p>Returns a URL-encoded version of the value of the specified string |
|
8751 attribute. The value is encoded using the native <code>encodeURIComponent()</code> |
|
8752 function.</p> |
|
8753 </div> |
|
8754 |
|
8755 |
|
8756 <div class="params"> |
|
8757 <h4>Parameters:</h4> |
|
8758 |
|
8759 <ul class="params-list"> |
|
8760 |
|
8761 <li class="param"> |
|
8762 |
|
8763 <code class="param-name">name</code> |
|
8764 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8765 |
|
8766 |
|
8767 |
|
8768 |
|
8769 <div class="param-description"> |
|
8770 <p>Attribute name or object property path.</p> |
|
8771 </div> |
|
8772 |
|
8773 |
|
8774 </li> |
|
8775 |
|
8776 </ul> |
|
8777 </div> |
|
8778 |
|
8779 |
|
8780 |
|
8781 <div class="returns"> |
|
8782 <h4>Returns:</h4> |
|
8783 |
|
8784 <div class="returns-description"> |
|
8785 |
|
8786 |
|
8787 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
8788 |
|
8789 URL-encoded attribute value. |
|
8790 |
|
8791 </div> |
|
8792 </div> |
|
8793 |
|
8794 |
|
8795 |
|
8796 </div> |
|
8797 |
|
8798 |
|
8799 <div id="method_getAttrs" class="method item inherited"> |
|
8800 <h3 class="name"><code>getAttrs</code></h3> |
|
8801 |
|
8802 |
|
8803 <div class="args"> |
|
8804 <span class="paren">(</span><ul class="args-list inline commas"> |
|
8805 |
|
8806 <li class="arg"> |
|
8807 |
|
8808 <code>attrs</code> |
|
8809 |
|
8810 </li> |
|
8811 |
|
8812 </ul><span class="paren">)</span> |
|
8813 </div> |
|
8814 |
|
8815 |
|
8816 |
|
8817 <span class="returns-inline"> |
|
8818 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
8819 </span> |
|
8820 |
|
8821 |
|
8822 |
|
8823 |
|
8824 |
|
8825 |
|
8826 |
|
8827 |
|
8828 |
|
8829 |
|
8830 |
|
8831 |
|
8832 |
|
8833 |
|
8834 <div class="meta"> |
|
8835 |
|
8836 |
|
8837 <p>Inherited from |
|
8838 <a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>: |
|
8839 |
|
8840 |
|
8841 |
|
8842 <a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a> |
|
8843 |
|
8844 </p> |
|
8845 |
|
8846 |
|
8847 |
|
8848 |
|
8849 |
|
8850 </div> |
|
8851 |
|
8852 <div class="description"> |
|
8853 <p>Gets multiple attribute values.</p> |
|
8854 </div> |
|
8855 |
|
8856 |
|
8857 <div class="params"> |
|
8858 <h4>Parameters:</h4> |
|
8859 |
|
8860 <ul class="params-list"> |
|
8861 |
|
8862 <li class="param"> |
|
8863 |
|
8864 <code class="param-name">attrs</code> |
|
8865 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span> |
|
8866 |
|
8867 |
|
8868 |
|
8869 |
|
8870 <div class="param-description"> |
|
8871 <p>Optional. An array of attribute names. If omitted, all attribute values are |
|
8872 returned. If set to true, all attributes modified from their initial values are returned.</p> |
|
8873 </div> |
|
8874 |
|
8875 |
|
8876 </li> |
|
8877 |
|
8878 </ul> |
|
8879 </div> |
|
8880 |
|
8881 |
|
8882 |
|
8883 <div class="returns"> |
|
8884 <h4>Returns:</h4> |
|
8885 |
|
8886 <div class="returns-description"> |
|
8887 |
|
8888 |
|
8889 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
8890 |
|
8891 An object with attribute name/value pairs. |
|
8892 |
|
8893 </div> |
|
8894 </div> |
|
8895 |
|
8896 |
|
8897 |
|
8898 </div> |
|
8899 |
|
8900 |
|
8901 <div id="method_getEvent" class="method item inherited"> |
|
8902 <h3 class="name"><code>getEvent</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>type</code> |
|
8911 |
|
8912 </li> |
|
8913 |
|
8914 <li class="arg"> |
|
8915 |
|
8916 <code>prefixed</code> |
|
8917 |
|
8918 </li> |
|
8919 |
|
8920 </ul><span class="paren">)</span> |
|
8921 </div> |
|
8922 |
|
8923 |
|
8924 |
|
8925 <span class="returns-inline"> |
|
8926 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
8927 </span> |
|
8928 |
|
8929 |
|
8930 |
|
8931 |
|
8932 |
|
8933 |
|
8934 |
|
8935 |
|
8936 |
|
8937 |
|
8938 |
|
8939 |
|
8940 |
|
8941 |
|
8942 <div class="meta"> |
|
8943 |
|
8944 |
|
8945 <p>Inherited from |
|
8946 <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>: |
|
8947 |
|
8948 |
|
8949 |
|
8950 <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a> |
|
8951 |
|
8952 </p> |
|
8953 |
|
8954 |
|
8955 |
|
8956 |
|
8957 |
|
8958 </div> |
|
8959 |
|
8960 <div class="description"> |
|
8961 <p>Returns the custom event of the provided type has been created, a |
|
8962 falsy value otherwise</p> |
|
8963 </div> |
|
8964 |
|
8965 |
|
8966 <div class="params"> |
|
8967 <h4>Parameters:</h4> |
|
8968 |
|
8969 <ul class="params-list"> |
|
8970 |
|
8971 <li class="param"> |
|
8972 |
|
8973 <code class="param-name">type</code> |
|
8974 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8975 |
|
8976 |
|
8977 |
|
8978 |
|
8979 <div class="param-description"> |
|
8980 <p>the type, or name of the event</p> |
|
8981 </div> |
|
8982 |
|
8983 |
|
8984 </li> |
|
8985 |
|
8986 <li class="param"> |
|
8987 |
|
8988 <code class="param-name">prefixed</code> |
|
8989 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
8990 |
|
8991 |
|
8992 |
|
8993 |
|
8994 <div class="param-description"> |
|
8995 <p>if true, the type is prefixed already</p> |
|
8996 </div> |
|
8997 |
|
8998 |
|
8999 </li> |
|
9000 |
|
9001 </ul> |
|
9002 </div> |
|
9003 |
|
9004 |
|
9005 |
|
9006 <div class="returns"> |
|
9007 <h4>Returns:</h4> |
|
9008 |
|
9009 <div class="returns-description"> |
|
9010 |
|
9011 |
|
9012 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
9013 |
|
9014 the custom event or null |
|
9015 |
|
9016 </div> |
|
9017 </div> |
|
9018 |
|
9019 |
|
9020 |
|
9021 </div> |
|
9022 |
|
9023 |
|
9024 <div id="method_getTargets" class="method item inherited"> |
|
9025 <h3 class="name"><code>getTargets</code></h3> |
|
9026 |
|
9027 |
|
9028 <span class="paren">()</span> |
|
9029 |
|
9030 |
|
9031 |
|
9032 <span class="returns-inline"> |
|
9033 <span class="type"></span> |
|
9034 </span> |
|
9035 |
|
9036 |
|
9037 |
|
9038 |
|
9039 |
|
9040 |
|
9041 |
|
9042 |
|
9043 |
|
9044 |
|
9045 |
|
9046 |
|
9047 |
|
9048 |
|
9049 <div class="meta"> |
|
9050 |
|
9051 |
|
9052 <p>Inherited from |
|
9053 <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>: |
|
9054 |
|
9055 |
|
9056 |
|
9057 <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a> |
|
9058 |
|
9059 </p> |
|
9060 |
|
9061 |
|
9062 |
|
9063 |
|
9064 |
|
9065 </div> |
|
9066 |
|
9067 <div class="description"> |
|
9068 <p>Returns an array of bubble targets for this object.</p> |
|
9069 </div> |
|
9070 |
|
9071 |
|
9072 |
|
9073 |
|
9074 <div class="returns"> |
|
9075 <h4>Returns:</h4> |
|
9076 |
|
9077 <div class="returns-description"> |
|
9078 |
|
9079 |
|
9080 EventTarget[] |
|
9081 |
|
9082 </div> |
|
9083 </div> |
|
9084 |
|
9085 |
|
9086 |
|
9087 </div> |
|
9088 |
|
9089 |
|
9090 <div id="method_init" class="method item inherited"> |
|
9091 <h3 class="name"><code>init</code></h3> |
|
9092 |
|
9093 |
|
9094 <div class="args"> |
|
9095 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9096 |
|
9097 <li class="arg"> |
|
9098 |
|
9099 <code>cfg</code> |
|
9100 |
|
9101 </li> |
|
9102 |
|
9103 </ul><span class="paren">)</span> |
|
9104 </div> |
|
9105 |
|
9106 |
|
9107 |
|
9108 <span class="returns-inline"> |
|
9109 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span> |
|
9110 </span> |
|
9111 |
|
9112 |
|
9113 |
|
9114 |
|
9115 |
|
9116 |
|
9117 |
|
9118 |
|
9119 |
|
9120 |
|
9121 |
|
9122 <span class="flag chainable">chainable</span> |
|
9123 |
|
9124 |
|
9125 |
|
9126 |
|
9127 <div class="meta"> |
|
9128 |
|
9129 <p>Inherited from |
|
9130 <a href="../classes/BaseObservable.html#method_init"> |
|
9131 BaseObservable |
|
9132 </a> |
|
9133 |
|
9134 but overwritten in |
|
9135 |
|
9136 |
|
9137 |
|
9138 <a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a> |
|
9139 |
|
9140 </p> |
|
9141 |
|
9142 |
|
9143 |
|
9144 |
|
9145 |
|
9146 </div> |
|
9147 |
|
9148 <div class="description"> |
|
9149 <p>Init lifecycle method, invoked during construction. Sets up attributes |
|
9150 and invokes initializers for the class hierarchy.</p> |
|
9151 </div> |
|
9152 |
|
9153 |
|
9154 <div class="params"> |
|
9155 <h4>Parameters:</h4> |
|
9156 |
|
9157 <ul class="params-list"> |
|
9158 |
|
9159 <li class="param"> |
|
9160 |
|
9161 <code class="param-name">cfg</code> |
|
9162 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9163 |
|
9164 |
|
9165 |
|
9166 |
|
9167 <div class="param-description"> |
|
9168 <p>Object with configuration property name/value pairs</p> |
|
9169 </div> |
|
9170 |
|
9171 |
|
9172 </li> |
|
9173 |
|
9174 </ul> |
|
9175 </div> |
|
9176 |
|
9177 |
|
9178 |
|
9179 <div class="returns"> |
|
9180 <h4>Returns:</h4> |
|
9181 |
|
9182 <div class="returns-description"> |
|
9183 |
|
9184 |
|
9185 <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>: |
|
9186 |
|
9187 A reference to this object |
|
9188 |
|
9189 </div> |
|
9190 </div> |
|
9191 |
|
9192 |
|
9193 |
|
9194 </div> |
|
9195 |
|
9196 |
|
9197 <div id="method_isModified" class="method item"> |
|
9198 <h3 class="name"><code>isModified</code></h3> |
|
9199 |
|
9200 |
|
9201 <span class="paren">()</span> |
|
9202 |
|
9203 |
|
9204 |
|
9205 <span class="returns-inline"> |
|
9206 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
9207 </span> |
|
9208 |
|
9209 |
|
9210 |
|
9211 |
|
9212 |
|
9213 |
|
9214 |
|
9215 |
|
9216 |
|
9217 |
|
9218 |
|
9219 |
|
9220 |
|
9221 |
|
9222 <div class="meta"> |
|
9223 |
|
9224 |
|
9225 |
|
9226 <p> |
|
9227 |
|
9228 Defined in |
|
9229 |
|
9230 |
|
9231 |
|
9232 |
|
9233 <a href="../files/app_js_model.js.html#l331"><code>app/js/model.js:331</code></a> |
|
9234 |
|
9235 </p> |
|
9236 |
|
9237 |
|
9238 |
|
9239 |
|
9240 |
|
9241 </div> |
|
9242 |
|
9243 <div class="description"> |
|
9244 <p>Returns <code>true</code> if any attribute of this model has been changed since the |
|
9245 model was last saved.</p> |
|
9246 |
|
9247 <p>New models (models for which <code>isNew()</code> returns <code>true</code>) are implicitly |
|
9248 considered to be "modified" until the first time they're saved.</p> |
|
9249 </div> |
|
9250 |
|
9251 |
|
9252 |
|
9253 |
|
9254 <div class="returns"> |
|
9255 <h4>Returns:</h4> |
|
9256 |
|
9257 <div class="returns-description"> |
|
9258 |
|
9259 |
|
9260 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
9261 |
|
9262 <code>true</code> if this model has changed since it was last saved, |
|
9263 <code>false</code> otherwise. |
|
9264 |
|
9265 </div> |
|
9266 </div> |
|
9267 |
|
9268 |
|
9269 |
|
9270 </div> |
|
9271 |
|
9272 |
|
9273 <div id="method_isNew" class="method item"> |
|
9274 <h3 class="name"><code>isNew</code></h3> |
|
9275 |
|
9276 |
|
9277 <span class="paren">()</span> |
|
9278 |
|
9279 |
|
9280 |
|
9281 <span class="returns-inline"> |
|
9282 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
9283 </span> |
|
9284 |
|
9285 |
|
9286 |
|
9287 |
|
9288 |
|
9289 |
|
9290 |
|
9291 |
|
9292 |
|
9293 |
|
9294 |
|
9295 |
|
9296 |
|
9297 |
|
9298 <div class="meta"> |
|
9299 |
|
9300 |
|
9301 |
|
9302 <p> |
|
9303 |
|
9304 Defined in |
|
9305 |
|
9306 |
|
9307 |
|
9308 |
|
9309 <a href="../files/app_js_model.js.html#l346"><code>app/js/model.js:346</code></a> |
|
9310 |
|
9311 </p> |
|
9312 |
|
9313 |
|
9314 |
|
9315 |
|
9316 |
|
9317 </div> |
|
9318 |
|
9319 <div class="description"> |
|
9320 <p>Returns <code>true</code> if this model is "new", meaning it hasn't been saved since it |
|
9321 was created.</p> |
|
9322 |
|
9323 <p>Newness is determined by checking whether the model's <code>id</code> attribute has |
|
9324 been set. An empty id is assumed to indicate a new model, whereas a |
|
9325 non-empty id indicates a model that was either loaded or has been saved |
|
9326 since it was created.</p> |
|
9327 </div> |
|
9328 |
|
9329 |
|
9330 |
|
9331 |
|
9332 <div class="returns"> |
|
9333 <h4>Returns:</h4> |
|
9334 |
|
9335 <div class="returns-description"> |
|
9336 |
|
9337 |
|
9338 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>: |
|
9339 |
|
9340 <code>true</code> if this model is new, <code>false</code> otherwise. |
|
9341 |
|
9342 </div> |
|
9343 </div> |
|
9344 |
|
9345 |
|
9346 |
|
9347 </div> |
|
9348 |
|
9349 |
|
9350 <div id="method_load" class="method item"> |
|
9351 <h3 class="name"><code>load</code></h3> |
|
9352 |
|
9353 |
|
9354 <div class="args"> |
|
9355 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9356 |
|
9357 <li class="arg"> |
|
9358 |
|
9359 <code class="optional">[options]</code> |
|
9360 |
|
9361 </li> |
|
9362 |
|
9363 <li class="arg"> |
|
9364 |
|
9365 <code class="optional">[callback]</code> |
|
9366 |
|
9367 </li> |
|
9368 |
|
9369 </ul><span class="paren">)</span> |
|
9370 </div> |
|
9371 |
|
9372 |
|
9373 |
|
9374 |
|
9375 |
|
9376 |
|
9377 |
|
9378 |
|
9379 |
|
9380 |
|
9381 |
|
9382 |
|
9383 |
|
9384 <span class="flag chainable">chainable</span> |
|
9385 |
|
9386 |
|
9387 |
|
9388 |
|
9389 <div class="meta"> |
|
9390 |
|
9391 |
|
9392 |
|
9393 <p> |
|
9394 |
|
9395 Defined in |
|
9396 |
|
9397 |
|
9398 |
|
9399 |
|
9400 <a href="../files/app_js_model.js.html#l362"><code>app/js/model.js:362</code></a> |
|
9401 |
|
9402 </p> |
|
9403 |
|
9404 |
|
9405 |
|
9406 |
|
9407 |
|
9408 </div> |
|
9409 |
|
9410 <div class="description"> |
|
9411 <p>Loads this model from the server.</p> |
|
9412 |
|
9413 <p>This method delegates to the <code>sync()</code> method to perform the actual load |
|
9414 operation, which is an asynchronous action. Specify a <em>callback</em> function to |
|
9415 be notified of success or failure.</p> |
|
9416 |
|
9417 <p>A successful load operation will fire a <code>load</code> event, while an unsuccessful |
|
9418 load operation will fire an <code>error</code> event with the <code>src</code> value "load".</p> |
|
9419 |
|
9420 <p>If the load operation succeeds and one or more of the loaded attributes |
|
9421 differ from this model's current attributes, a <code>change</code> event will be fired.</p> |
|
9422 </div> |
|
9423 |
|
9424 |
|
9425 <div class="params"> |
|
9426 <h4>Parameters:</h4> |
|
9427 |
|
9428 <ul class="params-list"> |
|
9429 |
|
9430 <li class="param"> |
|
9431 |
|
9432 <code class="param-name optional">[options]</code> |
|
9433 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9434 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9435 |
|
9436 |
|
9437 |
|
9438 |
|
9439 <div class="param-description"> |
|
9440 <p>Options to be passed to <code>sync()</code> and to <code>set()</code> |
|
9441 when setting the loaded attributes. It's up to the custom sync |
|
9442 implementation to determine what options it supports or requires, if any.</p> |
|
9443 </div> |
|
9444 |
|
9445 |
|
9446 </li> |
|
9447 |
|
9448 <li class="param"> |
|
9449 |
|
9450 <code class="param-name optional">[callback]</code> |
|
9451 <span class="type">Callback</span> |
|
9452 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9453 |
|
9454 |
|
9455 |
|
9456 |
|
9457 <div class="param-description"> |
|
9458 <p>Called when the sync operation finishes.</p> |
|
9459 </div> |
|
9460 |
|
9461 |
|
9462 <ul class="params-list"> |
|
9463 |
|
9464 <li class="param"> |
|
9465 |
|
9466 <code class="param-name">err</code> |
|
9467 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
9468 |
|
9469 |
|
9470 <div class="param-description"> |
|
9471 <p>If an error occurred, this parameter will |
|
9472 contain the error. If the sync operation succeeded, <em>err</em> will be |
|
9473 <code>null</code>.</p> |
|
9474 </div> |
|
9475 |
|
9476 |
|
9477 </li> |
|
9478 |
|
9479 <li class="param"> |
|
9480 |
|
9481 <code class="param-name">response</code> |
|
9482 <span class="type">Any</span> |
|
9483 |
|
9484 |
|
9485 <div class="param-description"> |
|
9486 <p>The server's response. This value will |
|
9487 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
9488 return an attribute hash.</p> |
|
9489 </div> |
|
9490 |
|
9491 |
|
9492 </li> |
|
9493 |
|
9494 </ul> |
|
9495 |
|
9496 </li> |
|
9497 |
|
9498 </ul> |
|
9499 </div> |
|
9500 |
|
9501 |
|
9502 |
|
9503 |
|
9504 |
|
9505 </div> |
|
9506 |
|
9507 |
|
9508 <div id="method_modifyAttr" class="method item inherited"> |
|
9509 <h3 class="name"><code>modifyAttr</code></h3> |
|
9510 |
|
9511 |
|
9512 <div class="args"> |
|
9513 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9514 |
|
9515 <li class="arg"> |
|
9516 |
|
9517 <code>name</code> |
|
9518 |
|
9519 </li> |
|
9520 |
|
9521 <li class="arg"> |
|
9522 |
|
9523 <code>config</code> |
|
9524 |
|
9525 </li> |
|
9526 |
|
9527 </ul><span class="paren">)</span> |
|
9528 </div> |
|
9529 |
|
9530 |
|
9531 |
|
9532 |
|
9533 |
|
9534 |
|
9535 |
|
9536 |
|
9537 |
|
9538 |
|
9539 |
|
9540 |
|
9541 |
|
9542 |
|
9543 |
|
9544 |
|
9545 <div class="meta"> |
|
9546 |
|
9547 |
|
9548 <p>Inherited from |
|
9549 <a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>: |
|
9550 |
|
9551 |
|
9552 |
|
9553 <a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a> |
|
9554 |
|
9555 </p> |
|
9556 |
|
9557 |
|
9558 |
|
9559 |
|
9560 |
|
9561 </div> |
|
9562 |
|
9563 <div class="description"> |
|
9564 <p>Updates the configuration of an attribute which has already been added.</p> |
|
9565 |
|
9566 <p> |
|
9567 The properties which can be modified through this interface are limited |
|
9568 to the following subset of attributes, which can be safely modified |
|
9569 after a value has already been set on the attribute: readOnly, writeOnce, |
|
9570 broadcast and getter. |
|
9571 </p> |
|
9572 </div> |
|
9573 |
|
9574 |
|
9575 <div class="params"> |
|
9576 <h4>Parameters:</h4> |
|
9577 |
|
9578 <ul class="params-list"> |
|
9579 |
|
9580 <li class="param"> |
|
9581 |
|
9582 <code class="param-name">name</code> |
|
9583 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9584 |
|
9585 |
|
9586 |
|
9587 |
|
9588 <div class="param-description"> |
|
9589 <p>The name of the attribute whose configuration is to be updated.</p> |
|
9590 </div> |
|
9591 |
|
9592 |
|
9593 </li> |
|
9594 |
|
9595 <li class="param"> |
|
9596 |
|
9597 <code class="param-name">config</code> |
|
9598 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9599 |
|
9600 |
|
9601 |
|
9602 |
|
9603 <div class="param-description"> |
|
9604 <p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p> |
|
9605 </div> |
|
9606 |
|
9607 |
|
9608 </li> |
|
9609 |
|
9610 </ul> |
|
9611 </div> |
|
9612 |
|
9613 |
|
9614 |
|
9615 |
|
9616 |
|
9617 </div> |
|
9618 |
|
9619 |
|
9620 <div id="method_on" class="method item inherited"> |
|
9621 <h3 class="name"><code>on</code></h3> |
|
9622 |
|
9623 |
|
9624 <div class="args"> |
|
9625 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9626 |
|
9627 <li class="arg"> |
|
9628 |
|
9629 <code>type</code> |
|
9630 |
|
9631 </li> |
|
9632 |
|
9633 <li class="arg"> |
|
9634 |
|
9635 <code>fn</code> |
|
9636 |
|
9637 </li> |
|
9638 |
|
9639 <li class="arg"> |
|
9640 |
|
9641 <code class="optional">[context]</code> |
|
9642 |
|
9643 </li> |
|
9644 |
|
9645 <li class="arg"> |
|
9646 |
|
9647 <code class="optional">[arg*]</code> |
|
9648 |
|
9649 </li> |
|
9650 |
|
9651 </ul><span class="paren">)</span> |
|
9652 </div> |
|
9653 |
|
9654 |
|
9655 |
|
9656 <span class="returns-inline"> |
|
9657 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
9658 </span> |
|
9659 |
|
9660 |
|
9661 |
|
9662 |
|
9663 |
|
9664 |
|
9665 |
|
9666 |
|
9667 |
|
9668 |
|
9669 |
|
9670 |
|
9671 |
|
9672 |
|
9673 <div class="meta"> |
|
9674 |
|
9675 |
|
9676 <p>Inherited from |
|
9677 <a href="../classes/EventTarget.html#method_on">EventTarget</a>: |
|
9678 |
|
9679 |
|
9680 |
|
9681 <a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a> |
|
9682 |
|
9683 </p> |
|
9684 |
|
9685 |
|
9686 |
|
9687 |
|
9688 |
|
9689 </div> |
|
9690 |
|
9691 <div class="description"> |
|
9692 <p>Subscribe a callback function to a custom event fired by this object or |
|
9693 from an object that bubbles its events to this object.</p> |
|
9694 |
|
9695 <p>Callback functions for events published with <code>emitFacade = true</code> will |
|
9696 receive an <code>EventFacade</code> as the first argument (typically named "e"). |
|
9697 These callbacks can then call <code>e.preventDefault()</code> to disable the |
|
9698 behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code> |
|
9699 API for all available properties and methods. Subscribers to |
|
9700 non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code> |
|
9701 after the event name.</p> |
|
9702 |
|
9703 <p>To subscribe to multiple events at once, pass an object as the first |
|
9704 argument, where the key:value pairs correspond to the eventName:callback, |
|
9705 or pass an array of event names as the first argument to subscribe to |
|
9706 all listed events with the same callback.</p> |
|
9707 |
|
9708 <p>Returning <code>false</code> from a callback is supported as an alternative to |
|
9709 calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is |
|
9710 recommended to use the event methods whenever possible.</p> |
|
9711 </div> |
|
9712 |
|
9713 |
|
9714 <div class="params"> |
|
9715 <h4>Parameters:</h4> |
|
9716 |
|
9717 <ul class="params-list"> |
|
9718 |
|
9719 <li class="param"> |
|
9720 |
|
9721 <code class="param-name">type</code> |
|
9722 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9723 |
|
9724 |
|
9725 |
|
9726 |
|
9727 <div class="param-description"> |
|
9728 <p>The name of the event</p> |
|
9729 </div> |
|
9730 |
|
9731 |
|
9732 </li> |
|
9733 |
|
9734 <li class="param"> |
|
9735 |
|
9736 <code class="param-name">fn</code> |
|
9737 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
9738 |
|
9739 |
|
9740 |
|
9741 |
|
9742 <div class="param-description"> |
|
9743 <p>The callback to execute in response to the event</p> |
|
9744 </div> |
|
9745 |
|
9746 |
|
9747 </li> |
|
9748 |
|
9749 <li class="param"> |
|
9750 |
|
9751 <code class="param-name optional">[context]</code> |
|
9752 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9753 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9754 |
|
9755 |
|
9756 |
|
9757 |
|
9758 <div class="param-description"> |
|
9759 <p>Override <code>this</code> object in callback</p> |
|
9760 </div> |
|
9761 |
|
9762 |
|
9763 </li> |
|
9764 |
|
9765 <li class="param"> |
|
9766 |
|
9767 <code class="param-name optional">[arg*]</code> |
|
9768 <span class="type">Any</span> |
|
9769 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9770 |
|
9771 |
|
9772 |
|
9773 |
|
9774 <div class="param-description"> |
|
9775 <p>0..n additional arguments to supply to the subscriber</p> |
|
9776 </div> |
|
9777 |
|
9778 |
|
9779 </li> |
|
9780 |
|
9781 </ul> |
|
9782 </div> |
|
9783 |
|
9784 |
|
9785 |
|
9786 <div class="returns"> |
|
9787 <h4>Returns:</h4> |
|
9788 |
|
9789 <div class="returns-description"> |
|
9790 |
|
9791 |
|
9792 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
9793 |
|
9794 A subscription handle capable of detaching that |
|
9795 subscription |
|
9796 |
|
9797 </div> |
|
9798 </div> |
|
9799 |
|
9800 |
|
9801 |
|
9802 </div> |
|
9803 |
|
9804 |
|
9805 <div id="method_once" class="method item inherited"> |
|
9806 <h3 class="name"><code>once</code></h3> |
|
9807 |
|
9808 |
|
9809 <div class="args"> |
|
9810 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9811 |
|
9812 <li class="arg"> |
|
9813 |
|
9814 <code>type</code> |
|
9815 |
|
9816 </li> |
|
9817 |
|
9818 <li class="arg"> |
|
9819 |
|
9820 <code>fn</code> |
|
9821 |
|
9822 </li> |
|
9823 |
|
9824 <li class="arg"> |
|
9825 |
|
9826 <code class="optional">[context]</code> |
|
9827 |
|
9828 </li> |
|
9829 |
|
9830 <li class="arg"> |
|
9831 |
|
9832 <code class="optional">[arg*]</code> |
|
9833 |
|
9834 </li> |
|
9835 |
|
9836 </ul><span class="paren">)</span> |
|
9837 </div> |
|
9838 |
|
9839 |
|
9840 |
|
9841 <span class="returns-inline"> |
|
9842 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
9843 </span> |
|
9844 |
|
9845 |
|
9846 |
|
9847 |
|
9848 |
|
9849 |
|
9850 |
|
9851 |
|
9852 |
|
9853 |
|
9854 |
|
9855 |
|
9856 |
|
9857 |
|
9858 <div class="meta"> |
|
9859 |
|
9860 |
|
9861 <p>Inherited from |
|
9862 <a href="../classes/EventTarget.html#method_once">EventTarget</a>: |
|
9863 |
|
9864 |
|
9865 |
|
9866 <a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a> |
|
9867 |
|
9868 </p> |
|
9869 |
|
9870 |
|
9871 |
|
9872 |
|
9873 |
|
9874 </div> |
|
9875 |
|
9876 <div class="description"> |
|
9877 <p>Listen to a custom event hosted by this object one time. |
|
9878 This is the equivalent to <code>on</code> except the |
|
9879 listener is immediatelly detached when it is executed.</p> |
|
9880 </div> |
|
9881 |
|
9882 |
|
9883 <div class="params"> |
|
9884 <h4>Parameters:</h4> |
|
9885 |
|
9886 <ul class="params-list"> |
|
9887 |
|
9888 <li class="param"> |
|
9889 |
|
9890 <code class="param-name">type</code> |
|
9891 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
9892 |
|
9893 |
|
9894 |
|
9895 |
|
9896 <div class="param-description"> |
|
9897 <p>The name of the event</p> |
|
9898 </div> |
|
9899 |
|
9900 |
|
9901 </li> |
|
9902 |
|
9903 <li class="param"> |
|
9904 |
|
9905 <code class="param-name">fn</code> |
|
9906 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
9907 |
|
9908 |
|
9909 |
|
9910 |
|
9911 <div class="param-description"> |
|
9912 <p>The callback to execute in response to the event</p> |
|
9913 </div> |
|
9914 |
|
9915 |
|
9916 </li> |
|
9917 |
|
9918 <li class="param"> |
|
9919 |
|
9920 <code class="param-name optional">[context]</code> |
|
9921 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
9922 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9923 |
|
9924 |
|
9925 |
|
9926 |
|
9927 <div class="param-description"> |
|
9928 <p>Override <code>this</code> object in callback</p> |
|
9929 </div> |
|
9930 |
|
9931 |
|
9932 </li> |
|
9933 |
|
9934 <li class="param"> |
|
9935 |
|
9936 <code class="param-name optional">[arg*]</code> |
|
9937 <span class="type">Any</span> |
|
9938 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
9939 |
|
9940 |
|
9941 |
|
9942 |
|
9943 <div class="param-description"> |
|
9944 <p>0..n additional arguments to supply to the subscriber</p> |
|
9945 </div> |
|
9946 |
|
9947 |
|
9948 </li> |
|
9949 |
|
9950 </ul> |
|
9951 </div> |
|
9952 |
|
9953 |
|
9954 |
|
9955 <div class="returns"> |
|
9956 <h4>Returns:</h4> |
|
9957 |
|
9958 <div class="returns-description"> |
|
9959 |
|
9960 |
|
9961 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
9962 |
|
9963 A subscription handle capable of detaching the |
|
9964 subscription |
|
9965 |
|
9966 </div> |
|
9967 </div> |
|
9968 |
|
9969 |
|
9970 |
|
9971 </div> |
|
9972 |
|
9973 |
|
9974 <div id="method_onceAfter" class="method item inherited"> |
|
9975 <h3 class="name"><code>onceAfter</code></h3> |
|
9976 |
|
9977 |
|
9978 <div class="args"> |
|
9979 <span class="paren">(</span><ul class="args-list inline commas"> |
|
9980 |
|
9981 <li class="arg"> |
|
9982 |
|
9983 <code>type</code> |
|
9984 |
|
9985 </li> |
|
9986 |
|
9987 <li class="arg"> |
|
9988 |
|
9989 <code>fn</code> |
|
9990 |
|
9991 </li> |
|
9992 |
|
9993 <li class="arg"> |
|
9994 |
|
9995 <code class="optional">[context]</code> |
|
9996 |
|
9997 </li> |
|
9998 |
|
9999 <li class="arg"> |
|
10000 |
|
10001 <code class="optional">[arg*]</code> |
|
10002 |
|
10003 </li> |
|
10004 |
|
10005 </ul><span class="paren">)</span> |
|
10006 </div> |
|
10007 |
|
10008 |
|
10009 |
|
10010 <span class="returns-inline"> |
|
10011 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span> |
|
10012 </span> |
|
10013 |
|
10014 |
|
10015 |
|
10016 |
|
10017 |
|
10018 |
|
10019 |
|
10020 |
|
10021 |
|
10022 |
|
10023 |
|
10024 |
|
10025 |
|
10026 |
|
10027 <div class="meta"> |
|
10028 |
|
10029 |
|
10030 <p>Inherited from |
|
10031 <a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>: |
|
10032 |
|
10033 |
|
10034 |
|
10035 <a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a> |
|
10036 |
|
10037 </p> |
|
10038 |
|
10039 |
|
10040 |
|
10041 |
|
10042 |
|
10043 </div> |
|
10044 |
|
10045 <div class="description"> |
|
10046 <p>Listen to a custom event hosted by this object one time. |
|
10047 This is the equivalent to <code>after</code> except the |
|
10048 listener is immediatelly detached when it is executed.</p> |
|
10049 </div> |
|
10050 |
|
10051 |
|
10052 <div class="params"> |
|
10053 <h4>Parameters:</h4> |
|
10054 |
|
10055 <ul class="params-list"> |
|
10056 |
|
10057 <li class="param"> |
|
10058 |
|
10059 <code class="param-name">type</code> |
|
10060 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10061 |
|
10062 |
|
10063 |
|
10064 |
|
10065 <div class="param-description"> |
|
10066 <p>The name of the event</p> |
|
10067 </div> |
|
10068 |
|
10069 |
|
10070 </li> |
|
10071 |
|
10072 <li class="param"> |
|
10073 |
|
10074 <code class="param-name">fn</code> |
|
10075 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
10076 |
|
10077 |
|
10078 |
|
10079 |
|
10080 <div class="param-description"> |
|
10081 <p>The callback to execute in response to the event</p> |
|
10082 </div> |
|
10083 |
|
10084 |
|
10085 </li> |
|
10086 |
|
10087 <li class="param"> |
|
10088 |
|
10089 <code class="param-name optional">[context]</code> |
|
10090 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10091 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10092 |
|
10093 |
|
10094 |
|
10095 |
|
10096 <div class="param-description"> |
|
10097 <p>Override <code>this</code> object in callback</p> |
|
10098 </div> |
|
10099 |
|
10100 |
|
10101 </li> |
|
10102 |
|
10103 <li class="param"> |
|
10104 |
|
10105 <code class="param-name optional">[arg*]</code> |
|
10106 <span class="type">Any</span> |
|
10107 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10108 |
|
10109 |
|
10110 |
|
10111 |
|
10112 <div class="param-description"> |
|
10113 <p>0..n additional arguments to supply to the subscriber</p> |
|
10114 </div> |
|
10115 |
|
10116 |
|
10117 </li> |
|
10118 |
|
10119 </ul> |
|
10120 </div> |
|
10121 |
|
10122 |
|
10123 |
|
10124 <div class="returns"> |
|
10125 <h4>Returns:</h4> |
|
10126 |
|
10127 <div class="returns-description"> |
|
10128 |
|
10129 |
|
10130 <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>: |
|
10131 |
|
10132 A subscription handle capable of detaching that |
|
10133 subscription |
|
10134 |
|
10135 </div> |
|
10136 </div> |
|
10137 |
|
10138 |
|
10139 |
|
10140 </div> |
|
10141 |
|
10142 |
|
10143 <div id="method_parse" class="method item"> |
|
10144 <h3 class="name"><code>parse</code></h3> |
|
10145 |
|
10146 |
|
10147 <div class="args"> |
|
10148 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10149 |
|
10150 <li class="arg"> |
|
10151 |
|
10152 <code>response</code> |
|
10153 |
|
10154 </li> |
|
10155 |
|
10156 </ul><span class="paren">)</span> |
|
10157 </div> |
|
10158 |
|
10159 |
|
10160 |
|
10161 <span class="returns-inline"> |
|
10162 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10163 </span> |
|
10164 |
|
10165 |
|
10166 |
|
10167 |
|
10168 |
|
10169 |
|
10170 |
|
10171 |
|
10172 |
|
10173 |
|
10174 |
|
10175 |
|
10176 |
|
10177 |
|
10178 <div class="meta"> |
|
10179 |
|
10180 |
|
10181 |
|
10182 <p> |
|
10183 |
|
10184 Defined in |
|
10185 |
|
10186 |
|
10187 |
|
10188 |
|
10189 <a href="../files/app_js_model.js.html#l434"><code>app/js/model.js:434</code></a> |
|
10190 |
|
10191 </p> |
|
10192 |
|
10193 |
|
10194 |
|
10195 |
|
10196 |
|
10197 </div> |
|
10198 |
|
10199 <div class="description"> |
|
10200 <p>Called to parse the <em>response</em> when the model is loaded from the server. |
|
10201 This method receives a server <em>response</em> and is expected to return an |
|
10202 attribute hash.</p> |
|
10203 |
|
10204 <p>The default implementation assumes that <em>response</em> is either an attribute |
|
10205 hash or a JSON string that can be parsed into an attribute hash. If |
|
10206 <em>response</em> is a JSON string and either <code>Y.JSON</code> or the native <code>JSON</code> object |
|
10207 are available, it will be parsed automatically. If a parse error occurs, an |
|
10208 <code>error</code> event will be fired and the model will not be updated.</p> |
|
10209 |
|
10210 <p>You may override this method to implement custom parsing logic if necessary.</p> |
|
10211 </div> |
|
10212 |
|
10213 |
|
10214 <div class="params"> |
|
10215 <h4>Parameters:</h4> |
|
10216 |
|
10217 <ul class="params-list"> |
|
10218 |
|
10219 <li class="param"> |
|
10220 |
|
10221 <code class="param-name">response</code> |
|
10222 <span class="type">Any</span> |
|
10223 |
|
10224 |
|
10225 |
|
10226 |
|
10227 <div class="param-description"> |
|
10228 <p>Server response.</p> |
|
10229 </div> |
|
10230 |
|
10231 |
|
10232 </li> |
|
10233 |
|
10234 </ul> |
|
10235 </div> |
|
10236 |
|
10237 |
|
10238 |
|
10239 <div class="returns"> |
|
10240 <h4>Returns:</h4> |
|
10241 |
|
10242 <div class="returns-description"> |
|
10243 |
|
10244 |
|
10245 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10246 |
|
10247 Attribute hash. |
|
10248 |
|
10249 </div> |
|
10250 </div> |
|
10251 |
|
10252 |
|
10253 |
|
10254 </div> |
|
10255 |
|
10256 |
|
10257 <div id="method_parseType" class="method item inherited"> |
|
10258 <h3 class="name"><code>parseType</code></h3> |
|
10259 |
|
10260 |
|
10261 <div class="args"> |
|
10262 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10263 |
|
10264 <li class="arg"> |
|
10265 |
|
10266 <code>type</code> |
|
10267 |
|
10268 </li> |
|
10269 |
|
10270 <li class="arg"> |
|
10271 |
|
10272 <code class="optional">[pre=this._yuievt.config.prefix]</code> |
|
10273 |
|
10274 </li> |
|
10275 |
|
10276 </ul><span class="paren">)</span> |
|
10277 </div> |
|
10278 |
|
10279 |
|
10280 |
|
10281 <span class="returns-inline"> |
|
10282 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
10283 </span> |
|
10284 |
|
10285 |
|
10286 |
|
10287 |
|
10288 |
|
10289 |
|
10290 |
|
10291 |
|
10292 |
|
10293 |
|
10294 |
|
10295 |
|
10296 |
|
10297 |
|
10298 <div class="meta"> |
|
10299 |
|
10300 |
|
10301 <p>Inherited from |
|
10302 <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>: |
|
10303 |
|
10304 |
|
10305 |
|
10306 <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a> |
|
10307 |
|
10308 </p> |
|
10309 |
|
10310 |
|
10311 |
|
10312 |
|
10313 |
|
10314 <p>Available since 3.3.0</p> |
|
10315 |
|
10316 </div> |
|
10317 |
|
10318 <div class="description"> |
|
10319 <p>Takes the type parameter passed to 'on' and parses out the |
|
10320 various pieces that could be included in the type. If the |
|
10321 event type is passed without a prefix, it will be expanded |
|
10322 to include the prefix one is supplied or the event target |
|
10323 is configured with a default prefix.</p> |
|
10324 </div> |
|
10325 |
|
10326 |
|
10327 <div class="params"> |
|
10328 <h4>Parameters:</h4> |
|
10329 |
|
10330 <ul class="params-list"> |
|
10331 |
|
10332 <li class="param"> |
|
10333 |
|
10334 <code class="param-name">type</code> |
|
10335 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10336 |
|
10337 |
|
10338 |
|
10339 |
|
10340 <div class="param-description"> |
|
10341 <p>the type</p> |
|
10342 </div> |
|
10343 |
|
10344 |
|
10345 </li> |
|
10346 |
|
10347 <li class="param"> |
|
10348 |
|
10349 <code class="param-name optional">[pre=this._yuievt.config.prefix]</code> |
|
10350 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10351 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10352 |
|
10353 |
|
10354 |
|
10355 |
|
10356 <div class="param-description"> |
|
10357 <p>the prefix</p> |
|
10358 </div> |
|
10359 |
|
10360 |
|
10361 </li> |
|
10362 |
|
10363 </ul> |
|
10364 </div> |
|
10365 |
|
10366 |
|
10367 |
|
10368 <div class="returns"> |
|
10369 <h4>Returns:</h4> |
|
10370 |
|
10371 <div class="returns-description"> |
|
10372 |
|
10373 |
|
10374 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>: |
|
10375 |
|
10376 an array containing: |
|
10377 * the detach category, if supplied, |
|
10378 * the prefixed event type, |
|
10379 * whether or not this is an after listener, |
|
10380 * the supplied event type |
|
10381 |
|
10382 </div> |
|
10383 </div> |
|
10384 |
|
10385 |
|
10386 |
|
10387 </div> |
|
10388 |
|
10389 |
|
10390 <div id="method_publish" class="method item inherited"> |
|
10391 <h3 class="name"><code>publish</code></h3> |
|
10392 |
|
10393 |
|
10394 <div class="args"> |
|
10395 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10396 |
|
10397 <li class="arg"> |
|
10398 |
|
10399 <code>type</code> |
|
10400 |
|
10401 </li> |
|
10402 |
|
10403 <li class="arg"> |
|
10404 |
|
10405 <code>opts</code> |
|
10406 |
|
10407 </li> |
|
10408 |
|
10409 </ul><span class="paren">)</span> |
|
10410 </div> |
|
10411 |
|
10412 |
|
10413 |
|
10414 <span class="returns-inline"> |
|
10415 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span> |
|
10416 </span> |
|
10417 |
|
10418 |
|
10419 |
|
10420 |
|
10421 |
|
10422 |
|
10423 |
|
10424 |
|
10425 |
|
10426 |
|
10427 |
|
10428 |
|
10429 |
|
10430 |
|
10431 <div class="meta"> |
|
10432 |
|
10433 |
|
10434 <p>Inherited from |
|
10435 <a href="../classes/EventTarget.html#method_publish">EventTarget</a>: |
|
10436 |
|
10437 |
|
10438 |
|
10439 <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a> |
|
10440 |
|
10441 </p> |
|
10442 |
|
10443 |
|
10444 |
|
10445 |
|
10446 |
|
10447 </div> |
|
10448 |
|
10449 <div class="description"> |
|
10450 <p>Creates a new custom event of the specified type. If a custom event |
|
10451 by that name already exists, it will not be re-created. In either |
|
10452 case the custom event is returned.</p> |
|
10453 </div> |
|
10454 |
|
10455 |
|
10456 <div class="params"> |
|
10457 <h4>Parameters:</h4> |
|
10458 |
|
10459 <ul class="params-list"> |
|
10460 |
|
10461 <li class="param"> |
|
10462 |
|
10463 <code class="param-name">type</code> |
|
10464 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10465 |
|
10466 |
|
10467 |
|
10468 |
|
10469 <div class="param-description"> |
|
10470 <p>the type, or name of the event</p> |
|
10471 </div> |
|
10472 |
|
10473 |
|
10474 </li> |
|
10475 |
|
10476 <li class="param"> |
|
10477 |
|
10478 <code class="param-name">opts</code> |
|
10479 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10480 |
|
10481 |
|
10482 |
|
10483 |
|
10484 <div class="param-description"> |
|
10485 <p>optional config params. Valid properties are:</p> |
|
10486 |
|
10487 <p><ul> |
|
10488 <li> |
|
10489 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false) |
|
10490 </li> |
|
10491 <li> |
|
10492 'bubbles': whether or not this event bubbles (true) |
|
10493 Events can only bubble if emitFacade is true. |
|
10494 </li> |
|
10495 <li> |
|
10496 'context': the default execution context for the listeners (this) |
|
10497 </li> |
|
10498 <li> |
|
10499 'defaultFn': the default function to execute when this event fires if preventDefault was not called |
|
10500 </li> |
|
10501 <li> |
|
10502 'emitFacade': whether or not this event emits a facade (false) |
|
10503 </li> |
|
10504 <li> |
|
10505 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' |
|
10506 </li> |
|
10507 <li> |
|
10508 'fireOnce': if an event is configured to fire once, new subscribers after |
|
10509 the fire will be notified immediately. |
|
10510 </li> |
|
10511 <li> |
|
10512 'async': fireOnce event listeners will fire synchronously if the event has already |
|
10513 fired unless async is true. |
|
10514 </li> |
|
10515 <li> |
|
10516 'preventable': whether or not preventDefault() has an effect (true) |
|
10517 </li> |
|
10518 <li> |
|
10519 'preventedFn': a function that is executed when preventDefault is called |
|
10520 </li> |
|
10521 <li> |
|
10522 'queuable': whether or not this event can be queued during bubbling (false) |
|
10523 </li> |
|
10524 <li> |
|
10525 'silent': if silent is true, debug messages are not provided for this event. |
|
10526 </li> |
|
10527 <li> |
|
10528 'stoppedFn': a function that is executed when stopPropagation is called |
|
10529 </li></p> |
|
10530 |
|
10531 <p><li> |
|
10532 'monitored': specifies whether or not this event should send notifications about |
|
10533 when the event has been attached, detached, or published. |
|
10534 </li> |
|
10535 <li> |
|
10536 'type': the event type (valid option if not provided as the first parameter to publish) |
|
10537 </li> |
|
10538 </ul></p> |
|
10539 </div> |
|
10540 |
|
10541 |
|
10542 </li> |
|
10543 |
|
10544 </ul> |
|
10545 </div> |
|
10546 |
|
10547 |
|
10548 |
|
10549 <div class="returns"> |
|
10550 <h4>Returns:</h4> |
|
10551 |
|
10552 <div class="returns-description"> |
|
10553 |
|
10554 |
|
10555 <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>: |
|
10556 |
|
10557 the custom event |
|
10558 |
|
10559 </div> |
|
10560 </div> |
|
10561 |
|
10562 |
|
10563 |
|
10564 </div> |
|
10565 |
|
10566 |
|
10567 <div id="method_removeAttr" class="method item inherited"> |
|
10568 <h3 class="name"><code>removeAttr</code></h3> |
|
10569 |
|
10570 |
|
10571 <div class="args"> |
|
10572 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10573 |
|
10574 <li class="arg"> |
|
10575 |
|
10576 <code>name</code> |
|
10577 |
|
10578 </li> |
|
10579 |
|
10580 </ul><span class="paren">)</span> |
|
10581 </div> |
|
10582 |
|
10583 |
|
10584 |
|
10585 |
|
10586 |
|
10587 |
|
10588 |
|
10589 |
|
10590 |
|
10591 |
|
10592 |
|
10593 |
|
10594 |
|
10595 |
|
10596 |
|
10597 |
|
10598 <div class="meta"> |
|
10599 |
|
10600 |
|
10601 <p>Inherited from |
|
10602 <a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>: |
|
10603 |
|
10604 |
|
10605 |
|
10606 <a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a> |
|
10607 |
|
10608 </p> |
|
10609 |
|
10610 |
|
10611 |
|
10612 |
|
10613 |
|
10614 </div> |
|
10615 |
|
10616 <div class="description"> |
|
10617 <p>Removes an attribute from the host object</p> |
|
10618 </div> |
|
10619 |
|
10620 |
|
10621 <div class="params"> |
|
10622 <h4>Parameters:</h4> |
|
10623 |
|
10624 <ul class="params-list"> |
|
10625 |
|
10626 <li class="param"> |
|
10627 |
|
10628 <code class="param-name">name</code> |
|
10629 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10630 |
|
10631 |
|
10632 |
|
10633 |
|
10634 <div class="param-description"> |
|
10635 <p>The name of the attribute to be removed.</p> |
|
10636 </div> |
|
10637 |
|
10638 |
|
10639 </li> |
|
10640 |
|
10641 </ul> |
|
10642 </div> |
|
10643 |
|
10644 |
|
10645 |
|
10646 |
|
10647 |
|
10648 </div> |
|
10649 |
|
10650 |
|
10651 <div id="method_removeTarget" class="method item inherited"> |
|
10652 <h3 class="name"><code>removeTarget</code></h3> |
|
10653 |
|
10654 |
|
10655 <div class="args"> |
|
10656 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10657 |
|
10658 <li class="arg"> |
|
10659 |
|
10660 <code>o</code> |
|
10661 |
|
10662 </li> |
|
10663 |
|
10664 </ul><span class="paren">)</span> |
|
10665 </div> |
|
10666 |
|
10667 |
|
10668 |
|
10669 |
|
10670 |
|
10671 |
|
10672 |
|
10673 |
|
10674 |
|
10675 |
|
10676 |
|
10677 |
|
10678 |
|
10679 |
|
10680 |
|
10681 |
|
10682 <div class="meta"> |
|
10683 |
|
10684 |
|
10685 <p>Inherited from |
|
10686 <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>: |
|
10687 |
|
10688 |
|
10689 |
|
10690 <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a> |
|
10691 |
|
10692 </p> |
|
10693 |
|
10694 |
|
10695 |
|
10696 |
|
10697 |
|
10698 </div> |
|
10699 |
|
10700 <div class="description"> |
|
10701 <p>Removes a bubble target</p> |
|
10702 </div> |
|
10703 |
|
10704 |
|
10705 <div class="params"> |
|
10706 <h4>Parameters:</h4> |
|
10707 |
|
10708 <ul class="params-list"> |
|
10709 |
|
10710 <li class="param"> |
|
10711 |
|
10712 <code class="param-name">o</code> |
|
10713 <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span> |
|
10714 |
|
10715 |
|
10716 |
|
10717 |
|
10718 <div class="param-description"> |
|
10719 <p>the target to remove</p> |
|
10720 </div> |
|
10721 |
|
10722 |
|
10723 </li> |
|
10724 |
|
10725 </ul> |
|
10726 </div> |
|
10727 |
|
10728 |
|
10729 |
|
10730 |
|
10731 |
|
10732 </div> |
|
10733 |
|
10734 |
|
10735 <div id="method_reset" class="method item inherited"> |
|
10736 <h3 class="name"><code>reset</code></h3> |
|
10737 |
|
10738 |
|
10739 <div class="args"> |
|
10740 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10741 |
|
10742 <li class="arg"> |
|
10743 |
|
10744 <code>name</code> |
|
10745 |
|
10746 </li> |
|
10747 |
|
10748 </ul><span class="paren">)</span> |
|
10749 </div> |
|
10750 |
|
10751 |
|
10752 |
|
10753 <span class="returns-inline"> |
|
10754 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10755 </span> |
|
10756 |
|
10757 |
|
10758 |
|
10759 |
|
10760 |
|
10761 |
|
10762 |
|
10763 |
|
10764 |
|
10765 |
|
10766 |
|
10767 <span class="flag chainable">chainable</span> |
|
10768 |
|
10769 |
|
10770 |
|
10771 |
|
10772 <div class="meta"> |
|
10773 |
|
10774 |
|
10775 <p>Inherited from |
|
10776 <a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>: |
|
10777 |
|
10778 |
|
10779 |
|
10780 <a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a> |
|
10781 |
|
10782 </p> |
|
10783 |
|
10784 |
|
10785 |
|
10786 |
|
10787 |
|
10788 </div> |
|
10789 |
|
10790 <div class="description"> |
|
10791 <p>Resets the attribute (or all attributes) to its initial value, as long as |
|
10792 the attribute is not readOnly, or writeOnce.</p> |
|
10793 </div> |
|
10794 |
|
10795 |
|
10796 <div class="params"> |
|
10797 <h4>Parameters:</h4> |
|
10798 |
|
10799 <ul class="params-list"> |
|
10800 |
|
10801 <li class="param"> |
|
10802 |
|
10803 <code class="param-name">name</code> |
|
10804 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
10805 |
|
10806 |
|
10807 |
|
10808 |
|
10809 <div class="param-description"> |
|
10810 <p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p> |
|
10811 </div> |
|
10812 |
|
10813 |
|
10814 </li> |
|
10815 |
|
10816 </ul> |
|
10817 </div> |
|
10818 |
|
10819 |
|
10820 |
|
10821 <div class="returns"> |
|
10822 <h4>Returns:</h4> |
|
10823 |
|
10824 <div class="returns-description"> |
|
10825 |
|
10826 |
|
10827 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
10828 |
|
10829 A reference to the host object. |
|
10830 |
|
10831 </div> |
|
10832 </div> |
|
10833 |
|
10834 |
|
10835 |
|
10836 </div> |
|
10837 |
|
10838 |
|
10839 <div id="method_save" class="method item"> |
|
10840 <h3 class="name"><code>save</code></h3> |
|
10841 |
|
10842 |
|
10843 <div class="args"> |
|
10844 <span class="paren">(</span><ul class="args-list inline commas"> |
|
10845 |
|
10846 <li class="arg"> |
|
10847 |
|
10848 <code class="optional">[options]</code> |
|
10849 |
|
10850 </li> |
|
10851 |
|
10852 <li class="arg"> |
|
10853 |
|
10854 <code class="optional">[callback]</code> |
|
10855 |
|
10856 </li> |
|
10857 |
|
10858 </ul><span class="paren">)</span> |
|
10859 </div> |
|
10860 |
|
10861 |
|
10862 |
|
10863 |
|
10864 |
|
10865 |
|
10866 |
|
10867 |
|
10868 |
|
10869 |
|
10870 |
|
10871 |
|
10872 |
|
10873 <span class="flag chainable">chainable</span> |
|
10874 |
|
10875 |
|
10876 |
|
10877 |
|
10878 <div class="meta"> |
|
10879 |
|
10880 |
|
10881 |
|
10882 <p> |
|
10883 |
|
10884 Defined in |
|
10885 |
|
10886 |
|
10887 |
|
10888 |
|
10889 <a href="../files/app_js_model.js.html#l469"><code>app/js/model.js:469</code></a> |
|
10890 |
|
10891 </p> |
|
10892 |
|
10893 |
|
10894 |
|
10895 |
|
10896 |
|
10897 </div> |
|
10898 |
|
10899 <div class="description"> |
|
10900 <p>Saves this model to the server.</p> |
|
10901 |
|
10902 <p>This method delegates to the <code>sync()</code> method to perform the actual save |
|
10903 operation, which is an asynchronous action. Specify a <em>callback</em> function to |
|
10904 be notified of success or failure.</p> |
|
10905 |
|
10906 <p>A successful save operation will fire a <code>save</code> event, while an unsuccessful |
|
10907 save operation will fire an <code>error</code> event with the <code>src</code> value "save".</p> |
|
10908 |
|
10909 <p>If the save operation succeeds and one or more of the attributes returned in |
|
10910 the server's response differ from this model's current attributes, a |
|
10911 <code>change</code> event will be fired.</p> |
|
10912 </div> |
|
10913 |
|
10914 |
|
10915 <div class="params"> |
|
10916 <h4>Parameters:</h4> |
|
10917 |
|
10918 <ul class="params-list"> |
|
10919 |
|
10920 <li class="param"> |
|
10921 |
|
10922 <code class="param-name optional">[options]</code> |
|
10923 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
10924 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10925 |
|
10926 |
|
10927 |
|
10928 |
|
10929 <div class="param-description"> |
|
10930 <p>Options to be passed to <code>sync()</code> and to <code>set()</code> |
|
10931 when setting synced attributes. It's up to the custom sync implementation |
|
10932 to determine what options it supports or requires, if any.</p> |
|
10933 </div> |
|
10934 |
|
10935 |
|
10936 </li> |
|
10937 |
|
10938 <li class="param"> |
|
10939 |
|
10940 <code class="param-name optional">[callback]</code> |
|
10941 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
10942 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
10943 |
|
10944 |
|
10945 |
|
10946 |
|
10947 <div class="param-description"> |
|
10948 <p>Called when the sync operation finishes.</p> |
|
10949 </div> |
|
10950 |
|
10951 |
|
10952 <ul class="params-list"> |
|
10953 |
|
10954 <li class="param"> |
|
10955 |
|
10956 <code class="param-name">err</code> |
|
10957 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
10958 |
|
10959 |
|
10960 <div class="param-description"> |
|
10961 <p>If an error occurred or validation |
|
10962 failed, this parameter will contain the error. If the sync operation |
|
10963 succeeded, <em>err</em> will be <code>null</code>.</p> |
|
10964 </div> |
|
10965 |
|
10966 |
|
10967 </li> |
|
10968 |
|
10969 <li class="param"> |
|
10970 |
|
10971 <code class="param-name">response</code> |
|
10972 <span class="type">Any</span> |
|
10973 |
|
10974 |
|
10975 <div class="param-description"> |
|
10976 <p>The server's response. This value will |
|
10977 be passed to the <code>parse()</code> method, which is expected to parse it and |
|
10978 return an attribute hash.</p> |
|
10979 </div> |
|
10980 |
|
10981 |
|
10982 </li> |
|
10983 |
|
10984 </ul> |
|
10985 |
|
10986 </li> |
|
10987 |
|
10988 </ul> |
|
10989 </div> |
|
10990 |
|
10991 |
|
10992 |
|
10993 |
|
10994 |
|
10995 </div> |
|
10996 |
|
10997 |
|
10998 <div id="method_set" class="method item"> |
|
10999 <h3 class="name"><code>set</code></h3> |
|
11000 |
|
11001 |
|
11002 <div class="args"> |
|
11003 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11004 |
|
11005 <li class="arg"> |
|
11006 |
|
11007 <code>name</code> |
|
11008 |
|
11009 </li> |
|
11010 |
|
11011 <li class="arg"> |
|
11012 |
|
11013 <code>value</code> |
|
11014 |
|
11015 </li> |
|
11016 |
|
11017 <li class="arg"> |
|
11018 |
|
11019 <code class="optional">[options]</code> |
|
11020 |
|
11021 </li> |
|
11022 |
|
11023 </ul><span class="paren">)</span> |
|
11024 </div> |
|
11025 |
|
11026 |
|
11027 |
|
11028 |
|
11029 |
|
11030 |
|
11031 |
|
11032 |
|
11033 |
|
11034 |
|
11035 |
|
11036 |
|
11037 |
|
11038 <span class="flag chainable">chainable</span> |
|
11039 |
|
11040 |
|
11041 |
|
11042 |
|
11043 <div class="meta"> |
|
11044 |
|
11045 <p>Inherited from |
|
11046 <a href="../classes/AttributeObservable.html#method_set"> |
|
11047 AttributeObservable |
|
11048 </a> |
|
11049 |
|
11050 but overwritten in |
|
11051 |
|
11052 |
|
11053 |
|
11054 <a href="../files/app_js_model.js.html#l550"><code>app/js/model.js:550</code></a> |
|
11055 |
|
11056 </p> |
|
11057 |
|
11058 |
|
11059 |
|
11060 |
|
11061 |
|
11062 </div> |
|
11063 |
|
11064 <div class="description"> |
|
11065 <p>Sets the value of a single attribute. If model validation fails, the |
|
11066 attribute will not be set and an <code>error</code> event will be fired.</p> |
|
11067 |
|
11068 <p>Use <code>setAttrs()</code> to set multiple attributes at once.</p> |
|
11069 </div> |
|
11070 |
|
11071 |
|
11072 <div class="params"> |
|
11073 <h4>Parameters:</h4> |
|
11074 |
|
11075 <ul class="params-list"> |
|
11076 |
|
11077 <li class="param"> |
|
11078 |
|
11079 <code class="param-name">name</code> |
|
11080 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11081 |
|
11082 |
|
11083 |
|
11084 |
|
11085 <div class="param-description"> |
|
11086 <p>Attribute name or object property path.</p> |
|
11087 </div> |
|
11088 |
|
11089 |
|
11090 </li> |
|
11091 |
|
11092 <li class="param"> |
|
11093 |
|
11094 <code class="param-name">value</code> |
|
11095 <span class="type">Any</span> |
|
11096 |
|
11097 |
|
11098 |
|
11099 |
|
11100 <div class="param-description"> |
|
11101 <p>Value to set.</p> |
|
11102 </div> |
|
11103 |
|
11104 |
|
11105 </li> |
|
11106 |
|
11107 <li class="param"> |
|
11108 |
|
11109 <code class="param-name optional">[options]</code> |
|
11110 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11111 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11112 |
|
11113 |
|
11114 |
|
11115 |
|
11116 <div class="param-description"> |
|
11117 <p>Data to be mixed into the event facade of the |
|
11118 <code>change</code> event(s) for these attributes.</p> |
|
11119 </div> |
|
11120 |
|
11121 |
|
11122 <ul class="params-list"> |
|
11123 |
|
11124 <li class="param"> |
|
11125 |
|
11126 <code class="param-name optional">[silent=false]</code> |
|
11127 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11128 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11129 |
|
11130 |
|
11131 <div class="param-description"> |
|
11132 <p>If <code>true</code>, no <code>change</code> event will |
|
11133 be fired.</p> |
|
11134 </div> |
|
11135 |
|
11136 |
|
11137 </li> |
|
11138 |
|
11139 </ul> |
|
11140 |
|
11141 </li> |
|
11142 |
|
11143 </ul> |
|
11144 </div> |
|
11145 |
|
11146 |
|
11147 |
|
11148 |
|
11149 |
|
11150 <div class="example"> |
|
11151 <h4>Example:</h4> |
|
11152 |
|
11153 <div class="example-content"> |
|
11154 <pre class="code prettyprint"><code>model.set('foo', 'bar'); |
|
11155 </code></pre> |
|
11156 </div> |
|
11157 </div> |
|
11158 |
|
11159 </div> |
|
11160 |
|
11161 |
|
11162 <div id="method_setAttrs" class="method item"> |
|
11163 <h3 class="name"><code>setAttrs</code></h3> |
|
11164 |
|
11165 |
|
11166 <div class="args"> |
|
11167 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11168 |
|
11169 <li class="arg"> |
|
11170 |
|
11171 <code>attributes</code> |
|
11172 |
|
11173 </li> |
|
11174 |
|
11175 <li class="arg"> |
|
11176 |
|
11177 <code class="optional">[options]</code> |
|
11178 |
|
11179 </li> |
|
11180 |
|
11181 </ul><span class="paren">)</span> |
|
11182 </div> |
|
11183 |
|
11184 |
|
11185 |
|
11186 |
|
11187 |
|
11188 |
|
11189 |
|
11190 |
|
11191 |
|
11192 |
|
11193 |
|
11194 |
|
11195 |
|
11196 <span class="flag chainable">chainable</span> |
|
11197 |
|
11198 |
|
11199 |
|
11200 |
|
11201 <div class="meta"> |
|
11202 |
|
11203 <p>Inherited from |
|
11204 <a href="../classes/AttributeObservable.html#method_setAttrs"> |
|
11205 AttributeObservable |
|
11206 </a> |
|
11207 |
|
11208 but overwritten in |
|
11209 |
|
11210 |
|
11211 |
|
11212 <a href="../files/app_js_model.js.html#l575"><code>app/js/model.js:575</code></a> |
|
11213 |
|
11214 </p> |
|
11215 |
|
11216 |
|
11217 |
|
11218 |
|
11219 |
|
11220 </div> |
|
11221 |
|
11222 <div class="description"> |
|
11223 <p>Sets the values of multiple attributes at once. If model validation fails, |
|
11224 the attributes will not be set and an <code>error</code> event will be fired.</p> |
|
11225 </div> |
|
11226 |
|
11227 |
|
11228 <div class="params"> |
|
11229 <h4>Parameters:</h4> |
|
11230 |
|
11231 <ul class="params-list"> |
|
11232 |
|
11233 <li class="param"> |
|
11234 |
|
11235 <code class="param-name">attributes</code> |
|
11236 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11237 |
|
11238 |
|
11239 |
|
11240 |
|
11241 <div class="param-description"> |
|
11242 <p>Hash of attribute names and values to set.</p> |
|
11243 </div> |
|
11244 |
|
11245 |
|
11246 </li> |
|
11247 |
|
11248 <li class="param"> |
|
11249 |
|
11250 <code class="param-name optional">[options]</code> |
|
11251 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11252 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11253 |
|
11254 |
|
11255 |
|
11256 |
|
11257 <div class="param-description"> |
|
11258 <p>Data to be mixed into the event facade of the |
|
11259 <code>change</code> event(s) for these attributes.</p> |
|
11260 </div> |
|
11261 |
|
11262 |
|
11263 <ul class="params-list"> |
|
11264 |
|
11265 <li class="param"> |
|
11266 |
|
11267 <code class="param-name optional">[silent=false]</code> |
|
11268 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11269 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11270 |
|
11271 |
|
11272 <div class="param-description"> |
|
11273 <p>If <code>true</code>, no <code>change</code> event will |
|
11274 be fired.</p> |
|
11275 </div> |
|
11276 |
|
11277 |
|
11278 </li> |
|
11279 |
|
11280 </ul> |
|
11281 |
|
11282 </li> |
|
11283 |
|
11284 </ul> |
|
11285 </div> |
|
11286 |
|
11287 |
|
11288 |
|
11289 |
|
11290 |
|
11291 <div class="example"> |
|
11292 <h4>Example:</h4> |
|
11293 |
|
11294 <div class="example-content"> |
|
11295 <pre class="code prettyprint"><code>model.setAttrs({ |
|
11296 foo: 'bar', |
|
11297 baz: 'quux' |
|
11298 }); |
|
11299 </code></pre> |
|
11300 </div> |
|
11301 </div> |
|
11302 |
|
11303 </div> |
|
11304 |
|
11305 |
|
11306 <div id="method_subscribe" class="method item deprecated inherited"> |
|
11307 <h3 class="name"><code>subscribe</code></h3> |
|
11308 |
|
11309 |
|
11310 <span class="paren">()</span> |
|
11311 |
|
11312 |
|
11313 |
|
11314 |
|
11315 |
|
11316 <span class="flag deprecated" title="use on">deprecated</span> |
|
11317 |
|
11318 |
|
11319 |
|
11320 |
|
11321 |
|
11322 |
|
11323 |
|
11324 |
|
11325 |
|
11326 |
|
11327 |
|
11328 |
|
11329 <div class="meta"> |
|
11330 |
|
11331 |
|
11332 <p>Inherited from |
|
11333 <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>: |
|
11334 |
|
11335 |
|
11336 |
|
11337 <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a> |
|
11338 |
|
11339 </p> |
|
11340 |
|
11341 |
|
11342 |
|
11343 <p>Deprecated: use on</p> |
|
11344 |
|
11345 |
|
11346 |
|
11347 </div> |
|
11348 |
|
11349 <div class="description"> |
|
11350 <p>subscribe to an event</p> |
|
11351 </div> |
|
11352 |
|
11353 |
|
11354 |
|
11355 |
|
11356 |
|
11357 |
|
11358 </div> |
|
11359 |
|
11360 |
|
11361 <div id="method_sync" class="method item"> |
|
11362 <h3 class="name"><code>sync</code></h3> |
|
11363 |
|
11364 |
|
11365 <div class="args"> |
|
11366 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11367 |
|
11368 <li class="arg"> |
|
11369 |
|
11370 <code>action</code> |
|
11371 |
|
11372 </li> |
|
11373 |
|
11374 <li class="arg"> |
|
11375 |
|
11376 <code class="optional">[options]</code> |
|
11377 |
|
11378 </li> |
|
11379 |
|
11380 <li class="arg"> |
|
11381 |
|
11382 <code class="optional">[callback]</code> |
|
11383 |
|
11384 </li> |
|
11385 |
|
11386 </ul><span class="paren">)</span> |
|
11387 </div> |
|
11388 |
|
11389 |
|
11390 |
|
11391 |
|
11392 |
|
11393 |
|
11394 |
|
11395 |
|
11396 |
|
11397 |
|
11398 |
|
11399 |
|
11400 |
|
11401 |
|
11402 |
|
11403 |
|
11404 <div class="meta"> |
|
11405 |
|
11406 |
|
11407 |
|
11408 <p> |
|
11409 |
|
11410 Defined in |
|
11411 |
|
11412 |
|
11413 |
|
11414 |
|
11415 <a href="../files/app_js_model.js.html#l656"><code>app/js/model.js:656</code></a> |
|
11416 |
|
11417 </p> |
|
11418 |
|
11419 |
|
11420 |
|
11421 |
|
11422 |
|
11423 </div> |
|
11424 |
|
11425 <div class="description"> |
|
11426 <p>Override this method to provide a custom persistence implementation for this |
|
11427 model. The default just calls the callback without actually doing anything.</p> |
|
11428 |
|
11429 <p>This method is called internally by <code>load()</code>, <code>save()</code>, and <code>destroy()</code>, and |
|
11430 their implementations rely on the callback being called. This effectively |
|
11431 means that when a callback is provided, it must be called at some point for |
|
11432 the class to operate correctly.</p> |
|
11433 </div> |
|
11434 |
|
11435 |
|
11436 <div class="params"> |
|
11437 <h4>Parameters:</h4> |
|
11438 |
|
11439 <ul class="params-list"> |
|
11440 |
|
11441 <li class="param"> |
|
11442 |
|
11443 <code class="param-name">action</code> |
|
11444 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11445 |
|
11446 |
|
11447 |
|
11448 |
|
11449 <div class="param-description"> |
|
11450 <p>Sync action to perform. May be one of the following:</p> |
|
11451 |
|
11452 <ul> |
|
11453 <li><code>create</code>: Store a newly-created model for the first time.</li> |
|
11454 <li><code>delete</code>: Delete an existing model.</li> |
|
11455 <li><code>read</code> : Load an existing model.</li> |
|
11456 <li><code>update</code>: Update an existing model.</li> |
|
11457 </ul> |
|
11458 </div> |
|
11459 |
|
11460 |
|
11461 </li> |
|
11462 |
|
11463 <li class="param"> |
|
11464 |
|
11465 <code class="param-name optional">[options]</code> |
|
11466 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11467 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11468 |
|
11469 |
|
11470 |
|
11471 |
|
11472 <div class="param-description"> |
|
11473 <p>Sync options. It's up to the custom sync |
|
11474 implementation to determine what options it supports or requires, if any.</p> |
|
11475 </div> |
|
11476 |
|
11477 |
|
11478 </li> |
|
11479 |
|
11480 <li class="param"> |
|
11481 |
|
11482 <code class="param-name optional">[callback]</code> |
|
11483 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
11484 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11485 |
|
11486 |
|
11487 |
|
11488 |
|
11489 <div class="param-description"> |
|
11490 <p>Called when the sync operation finishes.</p> |
|
11491 </div> |
|
11492 |
|
11493 |
|
11494 <ul class="params-list"> |
|
11495 |
|
11496 <li class="param"> |
|
11497 |
|
11498 <code class="param-name">err</code> |
|
11499 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a> | Null</span> |
|
11500 |
|
11501 |
|
11502 <div class="param-description"> |
|
11503 <p>If an error occurred, this parameter will |
|
11504 contain the error. If the sync operation succeeded, <em>err</em> will be |
|
11505 falsy.</p> |
|
11506 </div> |
|
11507 |
|
11508 |
|
11509 </li> |
|
11510 |
|
11511 <li class="param"> |
|
11512 |
|
11513 <code class="param-name optional">[response]</code> |
|
11514 <span class="type">Any</span> |
|
11515 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11516 |
|
11517 |
|
11518 <div class="param-description"> |
|
11519 <p>The server's response.</p> |
|
11520 </div> |
|
11521 |
|
11522 |
|
11523 </li> |
|
11524 |
|
11525 </ul> |
|
11526 |
|
11527 </li> |
|
11528 |
|
11529 </ul> |
|
11530 </div> |
|
11531 |
|
11532 |
|
11533 |
|
11534 |
|
11535 |
|
11536 </div> |
|
11537 |
|
11538 |
|
11539 <div id="method_toJSON" class="method item"> |
|
11540 <h3 class="name"><code>toJSON</code></h3> |
|
11541 |
|
11542 |
|
11543 <span class="paren">()</span> |
|
11544 |
|
11545 |
|
11546 |
|
11547 <span class="returns-inline"> |
|
11548 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11549 </span> |
|
11550 |
|
11551 |
|
11552 |
|
11553 |
|
11554 |
|
11555 |
|
11556 |
|
11557 |
|
11558 |
|
11559 |
|
11560 |
|
11561 |
|
11562 |
|
11563 |
|
11564 <div class="meta"> |
|
11565 |
|
11566 |
|
11567 |
|
11568 <p> |
|
11569 |
|
11570 Defined in |
|
11571 |
|
11572 |
|
11573 |
|
11574 |
|
11575 <a href="../files/app_js_model.js.html#l689"><code>app/js/model.js:689</code></a> |
|
11576 |
|
11577 </p> |
|
11578 |
|
11579 |
|
11580 |
|
11581 |
|
11582 |
|
11583 </div> |
|
11584 |
|
11585 <div class="description"> |
|
11586 <p>Returns a copy of this model's attributes that can be passed to |
|
11587 <code>Y.JSON.stringify()</code> or used for other nefarious purposes.</p> |
|
11588 |
|
11589 <p>The <code>clientId</code> attribute is not included in the returned object.</p> |
|
11590 |
|
11591 <p>If you've specified a custom attribute name in the <code>idAttribute</code> property, |
|
11592 the default <code>id</code> attribute will not be included in the returned object.</p> |
|
11593 |
|
11594 <p>Note: The ECMAScript 5 specification states that objects may implement a |
|
11595 <code>toJSON</code> method to provide an alternate object representation to serialize |
|
11596 when passed to <code>JSON.stringify(obj)</code>. This allows class instances to be |
|
11597 serialized as if they were plain objects. This is why Model's <code>toJSON</code> |
|
11598 returns an object, not a JSON string.</p> |
|
11599 |
|
11600 <p>See <a href="http://es5.github.com/#x15.12.3">http://es5.github.com/#x15.12.3</a> for details.</p> |
|
11601 </div> |
|
11602 |
|
11603 |
|
11604 |
|
11605 |
|
11606 <div class="returns"> |
|
11607 <h4>Returns:</h4> |
|
11608 |
|
11609 <div class="returns-description"> |
|
11610 |
|
11611 |
|
11612 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>: |
|
11613 |
|
11614 Copy of this model's attributes. |
|
11615 |
|
11616 </div> |
|
11617 </div> |
|
11618 |
|
11619 |
|
11620 |
|
11621 </div> |
|
11622 |
|
11623 |
|
11624 <div id="method_toString" class="method item inherited"> |
|
11625 <h3 class="name"><code>toString</code></h3> |
|
11626 |
|
11627 |
|
11628 <span class="paren">()</span> |
|
11629 |
|
11630 |
|
11631 |
|
11632 <span class="returns-inline"> |
|
11633 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11634 </span> |
|
11635 |
|
11636 |
|
11637 |
|
11638 |
|
11639 |
|
11640 |
|
11641 |
|
11642 |
|
11643 |
|
11644 |
|
11645 |
|
11646 |
|
11647 |
|
11648 |
|
11649 <div class="meta"> |
|
11650 |
|
11651 |
|
11652 <p>Inherited from |
|
11653 <a href="../classes/BaseCore.html#method_toString">BaseCore</a>: |
|
11654 |
|
11655 |
|
11656 |
|
11657 <a href="../files/base_js_BaseCore.js.html#l754"><code>base/js/BaseCore.js:754</code></a> |
|
11658 |
|
11659 </p> |
|
11660 |
|
11661 |
|
11662 |
|
11663 |
|
11664 |
|
11665 </div> |
|
11666 |
|
11667 <div class="description"> |
|
11668 <p>Default toString implementation. Provides the constructor NAME |
|
11669 and the instance guid, if set.</p> |
|
11670 </div> |
|
11671 |
|
11672 |
|
11673 |
|
11674 |
|
11675 <div class="returns"> |
|
11676 <h4>Returns:</h4> |
|
11677 |
|
11678 <div class="returns-description"> |
|
11679 |
|
11680 |
|
11681 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: |
|
11682 |
|
11683 String representation for this object |
|
11684 |
|
11685 </div> |
|
11686 </div> |
|
11687 |
|
11688 |
|
11689 |
|
11690 </div> |
|
11691 |
|
11692 |
|
11693 <div id="method_undo" class="method item"> |
|
11694 <h3 class="name"><code>undo</code></h3> |
|
11695 |
|
11696 |
|
11697 <div class="args"> |
|
11698 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11699 |
|
11700 <li class="arg"> |
|
11701 |
|
11702 <code class="optional">[attrNames]</code> |
|
11703 |
|
11704 </li> |
|
11705 |
|
11706 <li class="arg"> |
|
11707 |
|
11708 <code class="optional">[options]</code> |
|
11709 |
|
11710 </li> |
|
11711 |
|
11712 </ul><span class="paren">)</span> |
|
11713 </div> |
|
11714 |
|
11715 |
|
11716 |
|
11717 |
|
11718 |
|
11719 |
|
11720 |
|
11721 |
|
11722 |
|
11723 |
|
11724 |
|
11725 |
|
11726 |
|
11727 <span class="flag chainable">chainable</span> |
|
11728 |
|
11729 |
|
11730 |
|
11731 |
|
11732 <div class="meta"> |
|
11733 |
|
11734 |
|
11735 |
|
11736 <p> |
|
11737 |
|
11738 Defined in |
|
11739 |
|
11740 |
|
11741 |
|
11742 |
|
11743 <a href="../files/app_js_model.js.html#l723"><code>app/js/model.js:723</code></a> |
|
11744 |
|
11745 </p> |
|
11746 |
|
11747 |
|
11748 |
|
11749 |
|
11750 |
|
11751 </div> |
|
11752 |
|
11753 <div class="description"> |
|
11754 <p>Reverts the last change to the model.</p> |
|
11755 |
|
11756 <p>If an <em>attrNames</em> array is provided, then only the named attributes will be |
|
11757 reverted (and only if they were modified in the previous change). If no |
|
11758 <em>attrNames</em> array is provided, then all changed attributes will be reverted |
|
11759 to their previous values.</p> |
|
11760 |
|
11761 <p>Note that only one level of undo is available: from the current state to the |
|
11762 previous state. If <code>undo()</code> is called when no previous state is available, |
|
11763 it will simply do nothing.</p> |
|
11764 </div> |
|
11765 |
|
11766 |
|
11767 <div class="params"> |
|
11768 <h4>Parameters:</h4> |
|
11769 |
|
11770 <ul class="params-list"> |
|
11771 |
|
11772 <li class="param"> |
|
11773 |
|
11774 <code class="param-name optional">[attrNames]</code> |
|
11775 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span> |
|
11776 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11777 |
|
11778 |
|
11779 |
|
11780 |
|
11781 <div class="param-description"> |
|
11782 <p>Array of specific attribute names to revert. If |
|
11783 not specified, all attributes modified in the last change will be |
|
11784 reverted.</p> |
|
11785 </div> |
|
11786 |
|
11787 |
|
11788 </li> |
|
11789 |
|
11790 <li class="param"> |
|
11791 |
|
11792 <code class="param-name optional">[options]</code> |
|
11793 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
11794 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11795 |
|
11796 |
|
11797 |
|
11798 |
|
11799 <div class="param-description"> |
|
11800 <p>Data to be mixed into the event facade of the |
|
11801 change event(s) for these attributes.</p> |
|
11802 </div> |
|
11803 |
|
11804 |
|
11805 <ul class="params-list"> |
|
11806 |
|
11807 <li class="param"> |
|
11808 |
|
11809 <code class="param-name optional">[silent=false]</code> |
|
11810 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
11811 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
11812 |
|
11813 |
|
11814 <div class="param-description"> |
|
11815 <p>If <code>true</code>, no <code>change</code> event will |
|
11816 be fired.</p> |
|
11817 </div> |
|
11818 |
|
11819 |
|
11820 </li> |
|
11821 |
|
11822 </ul> |
|
11823 |
|
11824 </li> |
|
11825 |
|
11826 </ul> |
|
11827 </div> |
|
11828 |
|
11829 |
|
11830 |
|
11831 |
|
11832 |
|
11833 </div> |
|
11834 |
|
11835 |
|
11836 <div id="method_unsubscribe" class="method item deprecated inherited"> |
|
11837 <h3 class="name"><code>unsubscribe</code></h3> |
|
11838 |
|
11839 |
|
11840 <span class="paren">()</span> |
|
11841 |
|
11842 |
|
11843 |
|
11844 |
|
11845 |
|
11846 <span class="flag deprecated" title="use detach">deprecated</span> |
|
11847 |
|
11848 |
|
11849 |
|
11850 |
|
11851 |
|
11852 |
|
11853 |
|
11854 |
|
11855 |
|
11856 |
|
11857 |
|
11858 |
|
11859 <div class="meta"> |
|
11860 |
|
11861 |
|
11862 <p>Inherited from |
|
11863 <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>: |
|
11864 |
|
11865 |
|
11866 |
|
11867 <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a> |
|
11868 |
|
11869 </p> |
|
11870 |
|
11871 |
|
11872 |
|
11873 <p>Deprecated: use detach</p> |
|
11874 |
|
11875 |
|
11876 |
|
11877 </div> |
|
11878 |
|
11879 <div class="description"> |
|
11880 <p>detach a listener</p> |
|
11881 </div> |
|
11882 |
|
11883 |
|
11884 |
|
11885 |
|
11886 |
|
11887 |
|
11888 </div> |
|
11889 |
|
11890 |
|
11891 <div id="method_unsubscribeAll" class="method item deprecated inherited"> |
|
11892 <h3 class="name"><code>unsubscribeAll</code></h3> |
|
11893 |
|
11894 |
|
11895 <div class="args"> |
|
11896 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11897 |
|
11898 <li class="arg"> |
|
11899 |
|
11900 <code>type</code> |
|
11901 |
|
11902 </li> |
|
11903 |
|
11904 </ul><span class="paren">)</span> |
|
11905 </div> |
|
11906 |
|
11907 |
|
11908 |
|
11909 |
|
11910 |
|
11911 <span class="flag deprecated" title="use detachAll">deprecated</span> |
|
11912 |
|
11913 |
|
11914 |
|
11915 |
|
11916 |
|
11917 |
|
11918 |
|
11919 |
|
11920 |
|
11921 |
|
11922 |
|
11923 |
|
11924 <div class="meta"> |
|
11925 |
|
11926 |
|
11927 <p>Inherited from |
|
11928 <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>: |
|
11929 |
|
11930 |
|
11931 |
|
11932 <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a> |
|
11933 |
|
11934 </p> |
|
11935 |
|
11936 |
|
11937 |
|
11938 <p>Deprecated: use detachAll</p> |
|
11939 |
|
11940 |
|
11941 |
|
11942 </div> |
|
11943 |
|
11944 <div class="description"> |
|
11945 <p>Removes all listeners from the specified event. If the event type |
|
11946 is not specified, all listeners from all hosted custom events will |
|
11947 be removed.</p> |
|
11948 </div> |
|
11949 |
|
11950 |
|
11951 <div class="params"> |
|
11952 <h4>Parameters:</h4> |
|
11953 |
|
11954 <ul class="params-list"> |
|
11955 |
|
11956 <li class="param"> |
|
11957 |
|
11958 <code class="param-name">type</code> |
|
11959 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
11960 |
|
11961 |
|
11962 |
|
11963 |
|
11964 <div class="param-description"> |
|
11965 <p>The type, or name of the event</p> |
|
11966 </div> |
|
11967 |
|
11968 |
|
11969 </li> |
|
11970 |
|
11971 </ul> |
|
11972 </div> |
|
11973 |
|
11974 |
|
11975 |
|
11976 |
|
11977 |
|
11978 </div> |
|
11979 |
|
11980 |
|
11981 <div id="method_validate" class="method item"> |
|
11982 <h3 class="name"><code>validate</code></h3> |
|
11983 |
|
11984 |
|
11985 <div class="args"> |
|
11986 <span class="paren">(</span><ul class="args-list inline commas"> |
|
11987 |
|
11988 <li class="arg"> |
|
11989 |
|
11990 <code>attrs</code> |
|
11991 |
|
11992 </li> |
|
11993 |
|
11994 <li class="arg"> |
|
11995 |
|
11996 <code>callback</code> |
|
11997 |
|
11998 </li> |
|
11999 |
|
12000 </ul><span class="paren">)</span> |
|
12001 </div> |
|
12002 |
|
12003 |
|
12004 |
|
12005 |
|
12006 |
|
12007 |
|
12008 |
|
12009 |
|
12010 |
|
12011 |
|
12012 |
|
12013 |
|
12014 |
|
12015 |
|
12016 |
|
12017 |
|
12018 <div class="meta"> |
|
12019 |
|
12020 |
|
12021 |
|
12022 <p> |
|
12023 |
|
12024 Defined in |
|
12025 |
|
12026 |
|
12027 |
|
12028 |
|
12029 <a href="../files/app_js_model.js.html#l766"><code>app/js/model.js:766</code></a> |
|
12030 |
|
12031 </p> |
|
12032 |
|
12033 |
|
12034 |
|
12035 |
|
12036 |
|
12037 </div> |
|
12038 |
|
12039 <div class="description"> |
|
12040 <p>Override this method to provide custom validation logic for this model.</p> |
|
12041 |
|
12042 <p>While attribute-specific validators can be used to validate individual |
|
12043 attributes, this method gives you a hook to validate a hash of all |
|
12044 attributes before the model is saved. This method is called automatically |
|
12045 before <code>save()</code> takes any action. If validation fails, the <code>save()</code> call |
|
12046 will be aborted.</p> |
|
12047 |
|
12048 <p>In your validation method, call the provided <code>callback</code> function with no |
|
12049 arguments to indicate success. To indicate failure, pass a single argument, |
|
12050 which may contain an error message, an array of error messages, or any other |
|
12051 value. This value will be passed along to the <code>error</code> event.</p> |
|
12052 </div> |
|
12053 |
|
12054 |
|
12055 <div class="params"> |
|
12056 <h4>Parameters:</h4> |
|
12057 |
|
12058 <ul class="params-list"> |
|
12059 |
|
12060 <li class="param"> |
|
12061 |
|
12062 <code class="param-name">attrs</code> |
|
12063 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12064 |
|
12065 |
|
12066 |
|
12067 |
|
12068 <div class="param-description"> |
|
12069 <p>Attribute hash containing all model attributes to |
|
12070 be validated.</p> |
|
12071 </div> |
|
12072 |
|
12073 |
|
12074 </li> |
|
12075 |
|
12076 <li class="param"> |
|
12077 |
|
12078 <code class="param-name">callback</code> |
|
12079 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span> |
|
12080 |
|
12081 |
|
12082 |
|
12083 |
|
12084 <div class="param-description"> |
|
12085 <p>Validation callback. Call this function when your |
|
12086 validation logic finishes. To trigger a validation failure, pass any |
|
12087 value as the first argument to the callback (ideally a meaningful |
|
12088 validation error of some kind).</p> |
|
12089 </div> |
|
12090 |
|
12091 |
|
12092 <ul class="params-list"> |
|
12093 |
|
12094 <li class="param"> |
|
12095 |
|
12096 <code class="param-name optional">[err]</code> |
|
12097 <span class="type">Any</span> |
|
12098 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
12099 |
|
12100 |
|
12101 <div class="param-description"> |
|
12102 <p>Validation error. Don't provide this |
|
12103 argument if validation succeeds. If validation fails, set this to an |
|
12104 error message or some other meaningful value. It will be passed |
|
12105 along to the resulting <code>error</code> event.</p> |
|
12106 </div> |
|
12107 |
|
12108 |
|
12109 </li> |
|
12110 |
|
12111 </ul> |
|
12112 |
|
12113 </li> |
|
12114 |
|
12115 </ul> |
|
12116 </div> |
|
12117 |
|
12118 |
|
12119 |
|
12120 |
|
12121 |
|
12122 <div class="example"> |
|
12123 <h4>Example:</h4> |
|
12124 |
|
12125 <div class="example-content"> |
|
12126 <pre class="code prettyprint"><code>model.validate = function (attrs, callback) { |
|
12127 if (attrs.pie !== true) { |
|
12128 // No pie?! Invalid! |
|
12129 callback('Must provide pie.'); |
|
12130 return; |
|
12131 } |
|
12132 |
|
12133 // Success! |
|
12134 callback(); |
|
12135 }; |
|
12136 </code></pre> |
|
12137 </div> |
|
12138 </div> |
|
12139 |
|
12140 </div> |
|
12141 |
|
12142 |
|
12143 </div> |
|
12144 |
|
12145 |
|
12146 |
|
12147 <div id="properties" class="api-class-tabpanel"> |
|
12148 <h2 class="off-left">Properties</h2> |
|
12149 |
|
12150 |
|
12151 <div id="property__allowAdHocAttrs" class="property item protected"> |
|
12152 <h3 class="name"><code>_allowAdHocAttrs</code></h3> |
|
12153 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12154 |
|
12155 |
|
12156 |
|
12157 |
|
12158 <span class="flag protected">protected</span> |
|
12159 |
|
12160 |
|
12161 |
|
12162 |
|
12163 |
|
12164 |
|
12165 <div class="meta"> |
|
12166 |
|
12167 <p>Inherited from |
|
12168 <a href="../classes/BaseCore.html#property__allowAdHocAttrs"> |
|
12169 BaseCore |
|
12170 </a> |
|
12171 |
|
12172 but overwritten in |
|
12173 |
|
12174 |
|
12175 |
|
12176 <a href="../files/app_js_model.js.html#l169"><code>app/js/model.js:169</code></a> |
|
12177 |
|
12178 </p> |
|
12179 |
|
12180 |
|
12181 |
|
12182 |
|
12183 <p>Available since 3.5.0</p> |
|
12184 |
|
12185 </div> |
|
12186 |
|
12187 <div class="description"> |
|
12188 <p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config |
|
12189 properties passed to Model's constructor. This makes it possible to |
|
12190 instantiate a model and set a bunch of attributes without having to subclass |
|
12191 <code>Y.Model</code> and declare all those attributes first.</p> |
|
12192 </div> |
|
12193 |
|
12194 |
|
12195 <p><strong>Default:</strong> true</p> |
|
12196 |
|
12197 |
|
12198 |
|
12199 |
|
12200 |
|
12201 </div> |
|
12202 |
|
12203 |
|
12204 <div id="property__isYUIModel" class="property item protected"> |
|
12205 <h3 class="name"><code>_isYUIModel</code></h3> |
|
12206 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12207 |
|
12208 |
|
12209 |
|
12210 |
|
12211 <span class="flag protected">protected</span> |
|
12212 |
|
12213 |
|
12214 |
|
12215 |
|
12216 |
|
12217 |
|
12218 <div class="meta"> |
|
12219 |
|
12220 |
|
12221 |
|
12222 <p> |
|
12223 |
|
12224 Defined in |
|
12225 |
|
12226 |
|
12227 |
|
12228 |
|
12229 <a href="../files/app_js_model.js.html#l183"><code>app/js/model.js:183</code></a> |
|
12230 |
|
12231 </p> |
|
12232 |
|
12233 |
|
12234 |
|
12235 |
|
12236 <p>Available since 3.5.0</p> |
|
12237 |
|
12238 </div> |
|
12239 |
|
12240 <div class="description"> |
|
12241 <p>Total hack to allow us to identify Model instances without using |
|
12242 <code>instanceof</code>, which won't work when the instance was created in another |
|
12243 window or YUI sandbox.</p> |
|
12244 </div> |
|
12245 |
|
12246 |
|
12247 <p><strong>Default:</strong> true</p> |
|
12248 |
|
12249 |
|
12250 |
|
12251 |
|
12252 |
|
12253 </div> |
|
12254 |
|
12255 |
|
12256 <div id="property_changed" class="property item"> |
|
12257 <h3 class="name"><code>changed</code></h3> |
|
12258 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12259 |
|
12260 |
|
12261 |
|
12262 |
|
12263 |
|
12264 |
|
12265 |
|
12266 |
|
12267 |
|
12268 <div class="meta"> |
|
12269 |
|
12270 |
|
12271 |
|
12272 <p> |
|
12273 |
|
12274 Defined in |
|
12275 |
|
12276 |
|
12277 |
|
12278 |
|
12279 <a href="../files/app_js_model.js.html#l100"><code>app/js/model.js:100</code></a> |
|
12280 |
|
12281 </p> |
|
12282 |
|
12283 |
|
12284 |
|
12285 |
|
12286 </div> |
|
12287 |
|
12288 <div class="description"> |
|
12289 <p>Hash of attributes that have changed since the last time this model was |
|
12290 saved.</p> |
|
12291 </div> |
|
12292 |
|
12293 |
|
12294 <p><strong>Default:</strong> {}</p> |
|
12295 |
|
12296 |
|
12297 |
|
12298 |
|
12299 |
|
12300 </div> |
|
12301 |
|
12302 |
|
12303 <div id="property_idAttribute" class="property item"> |
|
12304 <h3 class="name"><code>idAttribute</code></h3> |
|
12305 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12306 |
|
12307 |
|
12308 |
|
12309 |
|
12310 |
|
12311 |
|
12312 |
|
12313 |
|
12314 |
|
12315 <div class="meta"> |
|
12316 |
|
12317 |
|
12318 |
|
12319 <p> |
|
12320 |
|
12321 Defined in |
|
12322 |
|
12323 |
|
12324 |
|
12325 |
|
12326 <a href="../files/app_js_model.js.html#l109"><code>app/js/model.js:109</code></a> |
|
12327 |
|
12328 </p> |
|
12329 |
|
12330 |
|
12331 |
|
12332 |
|
12333 </div> |
|
12334 |
|
12335 <div class="description"> |
|
12336 <p>Name of the attribute to use as the unique id (or primary key) for this |
|
12337 model.</p> |
|
12338 |
|
12339 <p>The default is <code>id</code>, but if your persistence layer uses a different name for |
|
12340 the primary key (such as <code>_id</code> or <code>uid</code>), you can specify that here.</p> |
|
12341 |
|
12342 <p>The built-in <code>id</code> attribute will always be an alias for whatever attribute |
|
12343 name you specify here, so getting and setting <code>id</code> will always behave the |
|
12344 same as getting and setting your custom id attribute.</p> |
|
12345 </div> |
|
12346 |
|
12347 |
|
12348 <p><strong>Default:</strong> `'id'`</p> |
|
12349 |
|
12350 |
|
12351 |
|
12352 |
|
12353 |
|
12354 </div> |
|
12355 |
|
12356 |
|
12357 <div id="property_lastChange" class="property item"> |
|
12358 <h3 class="name"><code>lastChange</code></h3> |
|
12359 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
12360 |
|
12361 |
|
12362 |
|
12363 |
|
12364 |
|
12365 |
|
12366 |
|
12367 |
|
12368 |
|
12369 <div class="meta"> |
|
12370 |
|
12371 |
|
12372 |
|
12373 <p> |
|
12374 |
|
12375 Defined in |
|
12376 |
|
12377 |
|
12378 |
|
12379 |
|
12380 <a href="../files/app_js_model.js.html#l126"><code>app/js/model.js:126</code></a> |
|
12381 |
|
12382 </p> |
|
12383 |
|
12384 |
|
12385 |
|
12386 |
|
12387 </div> |
|
12388 |
|
12389 <div class="description"> |
|
12390 <p>Hash of attributes that were changed in the last <code>change</code> event. Each item |
|
12391 in this hash is an object with the following properties:</p> |
|
12392 |
|
12393 <ul> |
|
12394 <li><code>newVal</code>: The new value of the attribute after it changed.</li> |
|
12395 <li><code>prevVal</code>: The old value of the attribute before it changed.</li> |
|
12396 <li><code>src</code>: The source of the change, or <code>null</code> if no source was specified.</li> |
|
12397 </ul> |
|
12398 </div> |
|
12399 |
|
12400 |
|
12401 <p><strong>Default:</strong> {}</p> |
|
12402 |
|
12403 |
|
12404 |
|
12405 |
|
12406 |
|
12407 </div> |
|
12408 |
|
12409 |
|
12410 <div id="property_lists" class="property item"> |
|
12411 <h3 class="name"><code>lists</code></h3> |
|
12412 <span class="type"><a href="../classes/ModelList.html" class="crosslink">ModelList[]</a></span> |
|
12413 |
|
12414 |
|
12415 |
|
12416 |
|
12417 |
|
12418 |
|
12419 |
|
12420 |
|
12421 |
|
12422 <div class="meta"> |
|
12423 |
|
12424 |
|
12425 |
|
12426 <p> |
|
12427 |
|
12428 Defined in |
|
12429 |
|
12430 |
|
12431 |
|
12432 |
|
12433 <a href="../files/app_js_model.js.html#l139"><code>app/js/model.js:139</code></a> |
|
12434 |
|
12435 </p> |
|
12436 |
|
12437 |
|
12438 |
|
12439 |
|
12440 </div> |
|
12441 |
|
12442 <div class="description"> |
|
12443 <p>Array of <code>ModelList</code> instances that contain this model.</p> |
|
12444 |
|
12445 <p>When a model is in one or more lists, the model's events will bubble up to |
|
12446 those lists. You can subscribe to a model event on a list to be notified |
|
12447 when any model in the list fires that event.</p> |
|
12448 |
|
12449 <p>This property is updated automatically when this model is added to or |
|
12450 removed from a <code>ModelList</code> instance. You shouldn't alter it manually. When |
|
12451 working with models in a list, you should always add and remove models using |
|
12452 the list's <code>add()</code> and <code>remove()</code> methods.</p> |
|
12453 </div> |
|
12454 |
|
12455 |
|
12456 <p><strong>Default:</strong> `[]`</p> |
|
12457 |
|
12458 |
|
12459 |
|
12460 <div class="example"> |
|
12461 <h4>Example:</h4> |
|
12462 |
|
12463 <div class="example-content"> |
|
12464 <p>Subscribing to model events on a list:</p> |
|
12465 |
|
12466 <pre class="code prettyprint"><code>// Assuming <code>list</code> is an existing Y.ModelList instance. |
|
12467 list.on('*:change', function (e) { |
|
12468 // This function will be called whenever any model in the list |
|
12469 // fires a <code>change</code> event. |
|
12470 // |
|
12471 // <code>e.target</code> will refer to the model instance that fired the |
|
12472 // event. |
|
12473 }); |
|
12474 </code></pre> |
|
12475 </div> |
|
12476 </div> |
|
12477 |
|
12478 |
|
12479 |
|
12480 </div> |
|
12481 |
|
12482 |
|
12483 <div id="property_name" class="property item deprecated inherited"> |
|
12484 <h3 class="name"><code>name</code></h3> |
|
12485 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12486 |
|
12487 |
|
12488 <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span> |
|
12489 |
|
12490 |
|
12491 |
|
12492 |
|
12493 |
|
12494 |
|
12495 |
|
12496 |
|
12497 <div class="meta"> |
|
12498 |
|
12499 |
|
12500 <p>Inherited from |
|
12501 <a href="../classes/BaseCore.html#property_name">BaseCore</a>: |
|
12502 |
|
12503 |
|
12504 |
|
12505 <a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a> |
|
12506 |
|
12507 </p> |
|
12508 |
|
12509 |
|
12510 <p>Deprecated: Use this.constructor.NAME</p> |
|
12511 |
|
12512 |
|
12513 |
|
12514 </div> |
|
12515 |
|
12516 <div class="description"> |
|
12517 <p>The string used to identify the class of this object.</p> |
|
12518 </div> |
|
12519 |
|
12520 |
|
12521 |
|
12522 |
|
12523 |
|
12524 |
|
12525 </div> |
|
12526 |
|
12527 |
|
12528 </div> |
|
12529 |
|
12530 |
|
12531 |
|
12532 <div id="attrs" class="api-class-tabpanel"> |
|
12533 <h2 class="off-left">Attributes</h2> |
|
12534 |
|
12535 |
|
12536 <div id="attr_clientId" class="attr item"> |
|
12537 <a name="config_clientId"></a> |
|
12538 <h3 class="name"><code>clientId</code></h3> |
|
12539 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12540 |
|
12541 |
|
12542 |
|
12543 |
|
12544 |
|
12545 |
|
12546 |
|
12547 |
|
12548 |
|
12549 |
|
12550 |
|
12551 |
|
12552 |
|
12553 |
|
12554 <span class="flag readonly">readonly</span> |
|
12555 |
|
12556 |
|
12557 <div class="meta"> |
|
12558 |
|
12559 |
|
12560 |
|
12561 <p> |
|
12562 |
|
12563 Defined in |
|
12564 |
|
12565 |
|
12566 |
|
12567 |
|
12568 <a href="../files/app_js_model.js.html#l953"><code>app/js/model.js:953</code></a> |
|
12569 |
|
12570 </p> |
|
12571 |
|
12572 |
|
12573 |
|
12574 |
|
12575 </div> |
|
12576 |
|
12577 <div class="description"> |
|
12578 <p>A client-only identifier for this model.</p> |
|
12579 |
|
12580 <p>Like the <code>id</code> attribute, <code>clientId</code> may be used to retrieve model |
|
12581 instances from lists. Unlike the <code>id</code> attribute, <code>clientId</code> is |
|
12582 automatically generated, and is only intended to be used on the client |
|
12583 during the current pageview.</p> |
|
12584 </div> |
|
12585 |
|
12586 |
|
12587 |
|
12588 |
|
12589 <div class="emits box"> |
|
12590 <h4>Fires event <code>clientIdChange</code></h4> |
|
12591 |
|
12592 <p> |
|
12593 Fires when the value for the configuration attribute <code>clientId</code> is |
|
12594 changed. You can listen for the event using the <code>on</code> method if you |
|
12595 wish to be notified before the attribute's value has changed, or |
|
12596 using the <code>after</code> method if you wish to be notified after the |
|
12597 attribute's value has changed. |
|
12598 </p> |
|
12599 |
|
12600 <div class="params"> |
|
12601 <h4>Parameters:</h4> |
|
12602 |
|
12603 <ul class="params-list"> |
|
12604 <li class="param"> |
|
12605 <code class="param-name">e</code> |
|
12606 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
12607 |
|
12608 <div class="param-description"> |
|
12609 An Event Facade object with the following |
|
12610 attribute-specific properties added: |
|
12611 </div> |
|
12612 |
|
12613 <ul class="params-list"> |
|
12614 <li class="param"> |
|
12615 <code class="param-name">prevVal</code> |
|
12616 <span class="type">Any</span> |
|
12617 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
12618 </li> |
|
12619 <li class="param"> |
|
12620 <code class="param-name">newVal</code> |
|
12621 <span class="type">Any</span> |
|
12622 <div class="param-description">The value the attribute is to be set to.</div> |
|
12623 </li> |
|
12624 <li class="param"> |
|
12625 <code class="param-name">attrName</code> |
|
12626 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12627 <div class="param-description">The name of the attribute being set.</div> |
|
12628 </li> |
|
12629 <li class="param"> |
|
12630 <code class="param-name">subAttrName</code> |
|
12631 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12632 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
12633 </li> |
|
12634 </ul> |
|
12635 </li> |
|
12636 </ul> |
|
12637 </div> |
|
12638 </div> |
|
12639 |
|
12640 |
|
12641 |
|
12642 </div> |
|
12643 |
|
12644 |
|
12645 <div id="attr_destroyed" class="attr item inherited"> |
|
12646 <a name="config_destroyed"></a> |
|
12647 <h3 class="name"><code>destroyed</code></h3> |
|
12648 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12649 |
|
12650 |
|
12651 |
|
12652 |
|
12653 |
|
12654 |
|
12655 |
|
12656 |
|
12657 |
|
12658 |
|
12659 |
|
12660 |
|
12661 |
|
12662 |
|
12663 <span class="flag readonly">readonly</span> |
|
12664 |
|
12665 |
|
12666 <div class="meta"> |
|
12667 |
|
12668 |
|
12669 <p>Inherited from |
|
12670 <a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>: |
|
12671 |
|
12672 |
|
12673 |
|
12674 <a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a> |
|
12675 |
|
12676 </p> |
|
12677 |
|
12678 |
|
12679 |
|
12680 |
|
12681 </div> |
|
12682 |
|
12683 <div class="description"> |
|
12684 <p>Flag indicating whether or not this object |
|
12685 has been through the destroy lifecycle phase.</p> |
|
12686 </div> |
|
12687 |
|
12688 |
|
12689 <p><strong>Default:</strong> false</p> |
|
12690 |
|
12691 |
|
12692 |
|
12693 <div class="emits box"> |
|
12694 <h4>Fires event <code>destroyedChange</code></h4> |
|
12695 |
|
12696 <p> |
|
12697 Fires when the value for the configuration attribute <code>destroyed</code> is |
|
12698 changed. You can listen for the event using the <code>on</code> method if you |
|
12699 wish to be notified before the attribute's value has changed, or |
|
12700 using the <code>after</code> method if you wish to be notified after the |
|
12701 attribute's value has changed. |
|
12702 </p> |
|
12703 |
|
12704 <div class="params"> |
|
12705 <h4>Parameters:</h4> |
|
12706 |
|
12707 <ul class="params-list"> |
|
12708 <li class="param"> |
|
12709 <code class="param-name">e</code> |
|
12710 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
12711 |
|
12712 <div class="param-description"> |
|
12713 An Event Facade object with the following |
|
12714 attribute-specific properties added: |
|
12715 </div> |
|
12716 |
|
12717 <ul class="params-list"> |
|
12718 <li class="param"> |
|
12719 <code class="param-name">prevVal</code> |
|
12720 <span class="type">Any</span> |
|
12721 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
12722 </li> |
|
12723 <li class="param"> |
|
12724 <code class="param-name">newVal</code> |
|
12725 <span class="type">Any</span> |
|
12726 <div class="param-description">The value the attribute is to be set to.</div> |
|
12727 </li> |
|
12728 <li class="param"> |
|
12729 <code class="param-name">attrName</code> |
|
12730 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12731 <div class="param-description">The name of the attribute being set.</div> |
|
12732 </li> |
|
12733 <li class="param"> |
|
12734 <code class="param-name">subAttrName</code> |
|
12735 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12736 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
12737 </li> |
|
12738 </ul> |
|
12739 </li> |
|
12740 </ul> |
|
12741 </div> |
|
12742 </div> |
|
12743 |
|
12744 |
|
12745 |
|
12746 </div> |
|
12747 |
|
12748 |
|
12749 <div id="attr_id" class="attr item"> |
|
12750 <a name="config_id"></a> |
|
12751 <h3 class="name"><code>id</code></h3> |
|
12752 <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/Number.html" class="crosslink">Number</a> | Null</span> |
|
12753 |
|
12754 |
|
12755 |
|
12756 |
|
12757 |
|
12758 |
|
12759 |
|
12760 |
|
12761 |
|
12762 |
|
12763 |
|
12764 |
|
12765 |
|
12766 |
|
12767 |
|
12768 <div class="meta"> |
|
12769 |
|
12770 |
|
12771 |
|
12772 <p> |
|
12773 |
|
12774 Defined in |
|
12775 |
|
12776 |
|
12777 |
|
12778 |
|
12779 <a href="../files/app_js_model.js.html#l970"><code>app/js/model.js:970</code></a> |
|
12780 |
|
12781 </p> |
|
12782 |
|
12783 |
|
12784 |
|
12785 |
|
12786 </div> |
|
12787 |
|
12788 <div class="description"> |
|
12789 <p>A unique identifier for this model. Among other things, this id may be |
|
12790 used to retrieve model instances from lists, so it should be unique.</p> |
|
12791 |
|
12792 <p>If the id is empty, this model instance is assumed to represent a new |
|
12793 item that hasn't yet been saved.</p> |
|
12794 |
|
12795 <p>If you would prefer to use a custom attribute as this model's id instead |
|
12796 of using the <code>id</code> attribute (for example, maybe you'd rather use <code>_id</code> |
|
12797 or <code>uid</code> as the primary id), you may set the <code>idAttribute</code> property to |
|
12798 the name of your custom id attribute. The <code>id</code> attribute will then |
|
12799 act as an alias for your custom attribute.</p> |
|
12800 </div> |
|
12801 |
|
12802 |
|
12803 <p><strong>Default:</strong> `null`</p> |
|
12804 |
|
12805 |
|
12806 |
|
12807 <div class="emits box"> |
|
12808 <h4>Fires event <code>idChange</code></h4> |
|
12809 |
|
12810 <p> |
|
12811 Fires when the value for the configuration attribute <code>id</code> is |
|
12812 changed. You can listen for the event using the <code>on</code> method if you |
|
12813 wish to be notified before the attribute's value has changed, or |
|
12814 using the <code>after</code> method if you wish to be notified after the |
|
12815 attribute's value has changed. |
|
12816 </p> |
|
12817 |
|
12818 <div class="params"> |
|
12819 <h4>Parameters:</h4> |
|
12820 |
|
12821 <ul class="params-list"> |
|
12822 <li class="param"> |
|
12823 <code class="param-name">e</code> |
|
12824 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
12825 |
|
12826 <div class="param-description"> |
|
12827 An Event Facade object with the following |
|
12828 attribute-specific properties added: |
|
12829 </div> |
|
12830 |
|
12831 <ul class="params-list"> |
|
12832 <li class="param"> |
|
12833 <code class="param-name">prevVal</code> |
|
12834 <span class="type">Any</span> |
|
12835 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
12836 </li> |
|
12837 <li class="param"> |
|
12838 <code class="param-name">newVal</code> |
|
12839 <span class="type">Any</span> |
|
12840 <div class="param-description">The value the attribute is to be set to.</div> |
|
12841 </li> |
|
12842 <li class="param"> |
|
12843 <code class="param-name">attrName</code> |
|
12844 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12845 <div class="param-description">The name of the attribute being set.</div> |
|
12846 </li> |
|
12847 <li class="param"> |
|
12848 <code class="param-name">subAttrName</code> |
|
12849 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12850 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
12851 </li> |
|
12852 </ul> |
|
12853 </li> |
|
12854 </ul> |
|
12855 </div> |
|
12856 </div> |
|
12857 |
|
12858 |
|
12859 |
|
12860 </div> |
|
12861 |
|
12862 |
|
12863 <div id="attr_initialized" class="attr item inherited"> |
|
12864 <a name="config_initialized"></a> |
|
12865 <h3 class="name"><code>initialized</code></h3> |
|
12866 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> |
|
12867 |
|
12868 |
|
12869 |
|
12870 |
|
12871 |
|
12872 |
|
12873 |
|
12874 |
|
12875 |
|
12876 |
|
12877 |
|
12878 |
|
12879 |
|
12880 |
|
12881 <span class="flag readonly">readonly</span> |
|
12882 |
|
12883 |
|
12884 <div class="meta"> |
|
12885 |
|
12886 |
|
12887 <p>Inherited from |
|
12888 <a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>: |
|
12889 |
|
12890 |
|
12891 |
|
12892 <a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a> |
|
12893 |
|
12894 </p> |
|
12895 |
|
12896 |
|
12897 |
|
12898 |
|
12899 </div> |
|
12900 |
|
12901 <div class="description"> |
|
12902 <p>Flag indicating whether or not this object |
|
12903 has been through the init lifecycle phase.</p> |
|
12904 </div> |
|
12905 |
|
12906 |
|
12907 <p><strong>Default:</strong> false</p> |
|
12908 |
|
12909 |
|
12910 |
|
12911 <div class="emits box"> |
|
12912 <h4>Fires event <code>initializedChange</code></h4> |
|
12913 |
|
12914 <p> |
|
12915 Fires when the value for the configuration attribute <code>initialized</code> is |
|
12916 changed. You can listen for the event using the <code>on</code> method if you |
|
12917 wish to be notified before the attribute's value has changed, or |
|
12918 using the <code>after</code> method if you wish to be notified after the |
|
12919 attribute's value has changed. |
|
12920 </p> |
|
12921 |
|
12922 <div class="params"> |
|
12923 <h4>Parameters:</h4> |
|
12924 |
|
12925 <ul class="params-list"> |
|
12926 <li class="param"> |
|
12927 <code class="param-name">e</code> |
|
12928 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
12929 |
|
12930 <div class="param-description"> |
|
12931 An Event Facade object with the following |
|
12932 attribute-specific properties added: |
|
12933 </div> |
|
12934 |
|
12935 <ul class="params-list"> |
|
12936 <li class="param"> |
|
12937 <code class="param-name">prevVal</code> |
|
12938 <span class="type">Any</span> |
|
12939 <div class="param-description">The value of the attribute, prior to it being set.</div> |
|
12940 </li> |
|
12941 <li class="param"> |
|
12942 <code class="param-name">newVal</code> |
|
12943 <span class="type">Any</span> |
|
12944 <div class="param-description">The value the attribute is to be set to.</div> |
|
12945 </li> |
|
12946 <li class="param"> |
|
12947 <code class="param-name">attrName</code> |
|
12948 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12949 <div class="param-description">The name of the attribute being set.</div> |
|
12950 </li> |
|
12951 <li class="param"> |
|
12952 <code class="param-name">subAttrName</code> |
|
12953 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
12954 <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div> |
|
12955 </li> |
|
12956 </ul> |
|
12957 </li> |
|
12958 </ul> |
|
12959 </div> |
|
12960 </div> |
|
12961 |
|
12962 |
|
12963 |
|
12964 </div> |
|
12965 |
|
12966 |
|
12967 </div> |
|
12968 |
|
12969 |
|
12970 |
|
12971 <div id="events" class="api-class-tabpanel"> |
|
12972 <h2 class="off-left">Events</h2> |
|
12973 |
|
12974 |
|
12975 <div id="event_change" class="events item"> |
|
12976 <h3 class="name"><code>change</code></h3> |
|
12977 <span class="type"></span> |
|
12978 |
|
12979 |
|
12980 |
|
12981 |
|
12982 |
|
12983 |
|
12984 |
|
12985 |
|
12986 |
|
12987 <div class="meta"> |
|
12988 |
|
12989 |
|
12990 |
|
12991 <p> |
|
12992 |
|
12993 Defined in |
|
12994 |
|
12995 |
|
12996 |
|
12997 |
|
12998 <a href="../files/app_js_model.js.html#l30"><code>app/js/model.js:30</code></a> |
|
12999 |
|
13000 </p> |
|
13001 |
|
13002 |
|
13003 |
|
13004 |
|
13005 </div> |
|
13006 |
|
13007 <div class="description"> |
|
13008 <p>Fired when one or more attributes on this model are changed.</p> |
|
13009 </div> |
|
13010 |
|
13011 |
|
13012 <div class="params"> |
|
13013 <h4>Event Payload:</h4> |
|
13014 |
|
13015 <ul class="params-list"> |
|
13016 |
|
13017 <li class="param"> |
|
13018 |
|
13019 <code class="param-name">changed</code> |
|
13020 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13021 |
|
13022 |
|
13023 |
|
13024 |
|
13025 <div class="param-description"> |
|
13026 <p>Hash of change information for each attribute that |
|
13027 changed. Each item in the hash has the following properties:</p> |
|
13028 </div> |
|
13029 |
|
13030 |
|
13031 <ul class="params-list"> |
|
13032 |
|
13033 <li class="param"> |
|
13034 |
|
13035 <code class="param-name">newVal</code> |
|
13036 <span class="type">Any</span> |
|
13037 |
|
13038 |
|
13039 <div class="param-description"> |
|
13040 <p>New value of the attribute.</p> |
|
13041 </div> |
|
13042 |
|
13043 |
|
13044 </li> |
|
13045 |
|
13046 <li class="param"> |
|
13047 |
|
13048 <code class="param-name">prevVal</code> |
|
13049 <span class="type">Any</span> |
|
13050 |
|
13051 |
|
13052 <div class="param-description"> |
|
13053 <p>Previous value of the attribute.</p> |
|
13054 </div> |
|
13055 |
|
13056 |
|
13057 </li> |
|
13058 |
|
13059 <li class="param"> |
|
13060 |
|
13061 <code class="param-name">src</code> |
|
13062 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span> |
|
13063 |
|
13064 |
|
13065 <div class="param-description"> |
|
13066 <p>Source of the change event, if any.</p> |
|
13067 </div> |
|
13068 |
|
13069 |
|
13070 </li> |
|
13071 |
|
13072 </ul> |
|
13073 |
|
13074 </li> |
|
13075 |
|
13076 </ul> |
|
13077 </div> |
|
13078 |
|
13079 |
|
13080 |
|
13081 |
|
13082 </div> |
|
13083 |
|
13084 |
|
13085 <div id="event_destroy" class="events item inherited"> |
|
13086 <h3 class="name"><code>destroy</code></h3> |
|
13087 <span class="type"></span> |
|
13088 |
|
13089 |
|
13090 |
|
13091 |
|
13092 |
|
13093 |
|
13094 |
|
13095 |
|
13096 |
|
13097 <div class="meta"> |
|
13098 |
|
13099 |
|
13100 <p>Inherited from |
|
13101 <a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>: |
|
13102 |
|
13103 |
|
13104 |
|
13105 <a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a> |
|
13106 |
|
13107 </p> |
|
13108 |
|
13109 |
|
13110 |
|
13111 |
|
13112 </div> |
|
13113 |
|
13114 <div class="description"> |
|
13115 <p> |
|
13116 Lifecycle event for the destroy phase, |
|
13117 fired prior to destruction. Invoking the preventDefault |
|
13118 method on the event object provided to subscribers will |
|
13119 prevent destruction from proceeding. |
|
13120 </p> |
|
13121 |
|
13122 <p> |
|
13123 Subscribers to the "after" moment of this event, will be notified |
|
13124 after destruction is complete (and as a result cannot prevent |
|
13125 destruction). |
|
13126 </p> |
|
13127 </div> |
|
13128 |
|
13129 |
|
13130 <div class="params"> |
|
13131 <h4>Event Payload:</h4> |
|
13132 |
|
13133 <ul class="params-list"> |
|
13134 |
|
13135 <li class="param"> |
|
13136 |
|
13137 <code class="param-name">e</code> |
|
13138 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
13139 |
|
13140 |
|
13141 |
|
13142 |
|
13143 <div class="param-description"> |
|
13144 <p>Event object</p> |
|
13145 </div> |
|
13146 |
|
13147 |
|
13148 </li> |
|
13149 |
|
13150 </ul> |
|
13151 </div> |
|
13152 |
|
13153 |
|
13154 |
|
13155 |
|
13156 </div> |
|
13157 |
|
13158 |
|
13159 <div id="event_error" class="events item"> |
|
13160 <h3 class="name"><code>error</code></h3> |
|
13161 <span class="type"></span> |
|
13162 |
|
13163 |
|
13164 |
|
13165 |
|
13166 |
|
13167 |
|
13168 |
|
13169 |
|
13170 |
|
13171 <div class="meta"> |
|
13172 |
|
13173 |
|
13174 |
|
13175 <p> |
|
13176 |
|
13177 Defined in |
|
13178 |
|
13179 |
|
13180 |
|
13181 |
|
13182 <a href="../files/app_js_model.js.html#l42"><code>app/js/model.js:42</code></a> |
|
13183 |
|
13184 </p> |
|
13185 |
|
13186 |
|
13187 |
|
13188 |
|
13189 </div> |
|
13190 |
|
13191 <div class="description"> |
|
13192 <p>Fired when an error occurs, such as when the model doesn't validate or when |
|
13193 a sync layer response can't be parsed.</p> |
|
13194 </div> |
|
13195 |
|
13196 |
|
13197 <div class="params"> |
|
13198 <h4>Event Payload:</h4> |
|
13199 |
|
13200 <ul class="params-list"> |
|
13201 |
|
13202 <li class="param"> |
|
13203 |
|
13204 <code class="param-name">error</code> |
|
13205 <span class="type">Any</span> |
|
13206 |
|
13207 |
|
13208 |
|
13209 |
|
13210 <div class="param-description"> |
|
13211 <p>Error message, object, or exception generated by the |
|
13212 error. Calling <code>toString()</code> on this should result in a meaningful error |
|
13213 message.</p> |
|
13214 </div> |
|
13215 |
|
13216 |
|
13217 </li> |
|
13218 |
|
13219 <li class="param"> |
|
13220 |
|
13221 <code class="param-name">src</code> |
|
13222 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> |
|
13223 |
|
13224 |
|
13225 |
|
13226 |
|
13227 <div class="param-description"> |
|
13228 <p>Source of the error. May be one of the following (or any |
|
13229 custom error source defined by a Model subclass):</p> |
|
13230 |
|
13231 <ul> |
|
13232 <li><p><code>load</code>: An error loading the model from a sync layer. The sync layer's |
|
13233 response (if any) will be provided as the <code>response</code> property on the |
|
13234 event facade.</p></li> |
|
13235 <li><p><code>parse</code>: An error parsing a JSON response. The response in question will |
|
13236 be provided as the <code>response</code> property on the event facade.</p></li> |
|
13237 <li><p><code>save</code>: An error saving the model to a sync layer. The sync layer's |
|
13238 response (if any) will be provided as the <code>response</code> property on the |
|
13239 event facade.</p></li> |
|
13240 <li><p><code>validate</code>: The model failed to validate. The attributes being validated |
|
13241 will be provided as the <code>attributes</code> property on the event facade.</p></li> |
|
13242 </ul> |
|
13243 </div> |
|
13244 |
|
13245 |
|
13246 </li> |
|
13247 |
|
13248 </ul> |
|
13249 </div> |
|
13250 |
|
13251 |
|
13252 |
|
13253 |
|
13254 </div> |
|
13255 |
|
13256 |
|
13257 <div id="event_init" class="events item inherited"> |
|
13258 <h3 class="name"><code>init</code></h3> |
|
13259 <span class="type"></span> |
|
13260 |
|
13261 |
|
13262 |
|
13263 |
|
13264 |
|
13265 |
|
13266 |
|
13267 |
|
13268 |
|
13269 <div class="meta"> |
|
13270 |
|
13271 |
|
13272 <p>Inherited from |
|
13273 <a href="../classes/BaseObservable.html#event_init">BaseObservable</a>: |
|
13274 |
|
13275 |
|
13276 |
|
13277 <a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a> |
|
13278 |
|
13279 </p> |
|
13280 |
|
13281 |
|
13282 |
|
13283 |
|
13284 </div> |
|
13285 |
|
13286 <div class="description"> |
|
13287 <p> |
|
13288 Lifecycle event for the init phase, fired prior to initialization. |
|
13289 Invoking the preventDefault() method on the event object provided |
|
13290 to subscribers will prevent initialization from occuring. |
|
13291 </p> |
|
13292 |
|
13293 <p> |
|
13294 Subscribers to the "after" momemt of this event, will be notified |
|
13295 after initialization of the object is complete (and therefore |
|
13296 cannot prevent initialization). |
|
13297 </p> |
|
13298 </div> |
|
13299 |
|
13300 |
|
13301 <div class="params"> |
|
13302 <h4>Event Payload:</h4> |
|
13303 |
|
13304 <ul class="params-list"> |
|
13305 |
|
13306 <li class="param"> |
|
13307 |
|
13308 <code class="param-name">e</code> |
|
13309 <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span> |
|
13310 |
|
13311 |
|
13312 |
|
13313 |
|
13314 <div class="param-description"> |
|
13315 <p>Event object, with a cfg property which |
|
13316 refers to the configuration object passed to the constructor.</p> |
|
13317 </div> |
|
13318 |
|
13319 |
|
13320 </li> |
|
13321 |
|
13322 </ul> |
|
13323 </div> |
|
13324 |
|
13325 |
|
13326 |
|
13327 |
|
13328 </div> |
|
13329 |
|
13330 |
|
13331 <div id="event_load" class="events item"> |
|
13332 <h3 class="name"><code>load</code></h3> |
|
13333 <span class="type"></span> |
|
13334 |
|
13335 |
|
13336 |
|
13337 |
|
13338 |
|
13339 |
|
13340 |
|
13341 |
|
13342 |
|
13343 <div class="meta"> |
|
13344 |
|
13345 |
|
13346 |
|
13347 <p> |
|
13348 |
|
13349 Defined in |
|
13350 |
|
13351 |
|
13352 |
|
13353 |
|
13354 <a href="../files/app_js_model.js.html#l69"><code>app/js/model.js:69</code></a> |
|
13355 |
|
13356 </p> |
|
13357 |
|
13358 |
|
13359 |
|
13360 |
|
13361 <p>Available since 3.5.0</p> |
|
13362 |
|
13363 </div> |
|
13364 |
|
13365 <div class="description"> |
|
13366 <p>Fired after model attributes are loaded from a sync layer.</p> |
|
13367 </div> |
|
13368 |
|
13369 |
|
13370 <div class="params"> |
|
13371 <h4>Event Payload:</h4> |
|
13372 |
|
13373 <ul class="params-list"> |
|
13374 |
|
13375 <li class="param"> |
|
13376 |
|
13377 <code class="param-name">parsed</code> |
|
13378 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13379 |
|
13380 |
|
13381 |
|
13382 |
|
13383 <div class="param-description"> |
|
13384 <p>The parsed version of the sync layer's response to |
|
13385 the load request.</p> |
|
13386 </div> |
|
13387 |
|
13388 |
|
13389 </li> |
|
13390 |
|
13391 <li class="param"> |
|
13392 |
|
13393 <code class="param-name">response</code> |
|
13394 <span class="type">Any</span> |
|
13395 |
|
13396 |
|
13397 |
|
13398 |
|
13399 <div class="param-description"> |
|
13400 <p>The sync layer's raw, unparsed response to the load |
|
13401 request.</p> |
|
13402 </div> |
|
13403 |
|
13404 |
|
13405 </li> |
|
13406 |
|
13407 </ul> |
|
13408 </div> |
|
13409 |
|
13410 |
|
13411 |
|
13412 |
|
13413 </div> |
|
13414 |
|
13415 |
|
13416 <div id="event_save" class="events item"> |
|
13417 <h3 class="name"><code>save</code></h3> |
|
13418 <span class="type"></span> |
|
13419 |
|
13420 |
|
13421 |
|
13422 |
|
13423 |
|
13424 |
|
13425 |
|
13426 |
|
13427 |
|
13428 <div class="meta"> |
|
13429 |
|
13430 |
|
13431 |
|
13432 <p> |
|
13433 |
|
13434 Defined in |
|
13435 |
|
13436 |
|
13437 |
|
13438 |
|
13439 <a href="../files/app_js_model.js.html#l81"><code>app/js/model.js:81</code></a> |
|
13440 |
|
13441 </p> |
|
13442 |
|
13443 |
|
13444 |
|
13445 |
|
13446 <p>Available since 3.5.0</p> |
|
13447 |
|
13448 </div> |
|
13449 |
|
13450 <div class="description"> |
|
13451 <p>Fired after model attributes are saved to a sync layer.</p> |
|
13452 </div> |
|
13453 |
|
13454 |
|
13455 <div class="params"> |
|
13456 <h4>Event Payload:</h4> |
|
13457 |
|
13458 <ul class="params-list"> |
|
13459 |
|
13460 <li class="param"> |
|
13461 |
|
13462 <code class="param-name optional">[parsed]</code> |
|
13463 <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> |
|
13464 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13465 |
|
13466 |
|
13467 |
|
13468 |
|
13469 <div class="param-description"> |
|
13470 <p>The parsed version of the sync layer's response to |
|
13471 the save request, if there was a response.</p> |
|
13472 </div> |
|
13473 |
|
13474 |
|
13475 </li> |
|
13476 |
|
13477 <li class="param"> |
|
13478 |
|
13479 <code class="param-name optional">[response]</code> |
|
13480 <span class="type">Any</span> |
|
13481 <span class="flag optional" title="This parameter is optional.">optional</span> |
|
13482 |
|
13483 |
|
13484 |
|
13485 |
|
13486 <div class="param-description"> |
|
13487 <p>The sync layer's raw, unparsed response to the save |
|
13488 request, if there was one.</p> |
|
13489 </div> |
|
13490 |
|
13491 |
|
13492 </li> |
|
13493 |
|
13494 </ul> |
|
13495 </div> |
|
13496 |
|
13497 |
|
13498 |
|
13499 |
|
13500 </div> |
|
13501 |
|
13502 |
|
13503 </div> |
|
13504 |
|
13505 </div> |
|
13506 </div> |
|
13507 |
|
13508 </div> |
|
13509 </div> |
|
13510 </div> |
|
13511 </div> |
|
13512 </div> |
|
13513 </div> |
|
13514 <script src="../assets/vendor/prettify/prettify-min.js"></script> |
|
13515 <script>prettyPrint();</script> |
|
13516 <script src="../assets/js/yui-prettify.js"></script> |
|
13517 <script src="../assets/../api.js"></script> |
|
13518 <script src="../assets/js/api-filter.js"></script> |
|
13519 <script src="../assets/js/api-list.js"></script> |
|
13520 <script src="../assets/js/api-search.js"></script> |
|
13521 <script src="../assets/js/apidocs.js"></script> |
|
13522 </body> |
|
13523 </html> |