5
<title>App - YUI 3</title>
6
<link rel="stylesheet" href="http://yui.yahooapis.com/3.5.0/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
<script src="http://yui.yahooapis.com/3.5.0/build/yui/yui-min.js"></script>
11
<body class="yui3-skin-sam">
14
<div id="hd" class="yui3-g header">
15
<div class="yui3-u-3-4">
17
<h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
20
<div class="yui3-u-1-4 version">
21
<em>API Docs for: 3.5.1</em>
24
<div id="bd" class="yui3-g">
26
<div class="yui3-u-1-4">
27
<div id="docs-sidebar" class="sidebar apidocs">
29
<h2 class="off-left">APIs</h2>
30
<div id="api-tabview" class="tabview">
32
<li><a href="#api-classes">Classes</a></li>
33
<li><a href="#api-modules">Modules</a></li>
36
<div id="api-tabview-filter">
37
<input type="search" id="api-filter" placeholder="Type to filter APIs">
40
<div id="api-tabview-panel">
41
<ul id="api-classes" class="apis classes">
43
<li><a href="../classes/Anim.html">Anim</a></li>
45
<li><a href="../classes/App.html">App</a></li>
47
<li><a href="../classes/App.Base.html">App.Base</a></li>
49
<li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
51
<li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
53
<li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
55
<li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
57
<li><a href="../classes/Array.html">Array</a></li>
59
<li><a href="../classes/ArrayList.html">ArrayList</a></li>
61
<li><a href="../classes/ArraySort.html">ArraySort</a></li>
63
<li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
65
<li><a href="../classes/Attribute.html">Attribute</a></li>
67
<li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
69
<li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
71
<li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
73
<li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
75
<li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
77
<li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
79
<li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
81
<li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
83
<li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
85
<li><a href="../classes/Axis.html">Axis</a></li>
87
<li><a href="../classes/AxisType.html">AxisType</a></li>
89
<li><a href="../classes/BarSeries.html">BarSeries</a></li>
91
<li><a href="../classes/Base.html">Base</a></li>
93
<li><a href="../classes/BaseCore.html">BaseCore</a></li>
95
<li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
97
<li><a href="../classes/Button.html">Button</a></li>
99
<li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
101
<li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
103
<li><a href="../classes/ButtonPlugin.html">ButtonPlugin</a></li>
105
<li><a href="../classes/Cache.html">Cache</a></li>
107
<li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
109
<li><a href="../classes/Calendar.html">Calendar</a></li>
111
<li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
113
<li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
115
<li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
117
<li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
119
<li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
121
<li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
123
<li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
125
<li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
127
<li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
129
<li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
131
<li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
133
<li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
135
<li><a href="../classes/Chart.html">Chart</a></li>
137
<li><a href="../classes/ChartBase.html">ChartBase</a></li>
139
<li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
141
<li><a href="../classes/Circle.html">Circle</a></li>
143
<li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
145
<li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
147
<li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
149
<li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
151
<li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
153
<li><a href="../classes/config.html">config</a></li>
155
<li><a href="../classes/Console.html">Console</a></li>
157
<li><a href="../classes/Controller.html">Controller</a></li>
159
<li><a href="../classes/Cookie.html">Cookie</a></li>
161
<li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
163
<li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
165
<li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
167
<li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
169
<li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
171
<li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
173
<li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
175
<li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
177
<li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
179
<li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
181
<li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
183
<li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
185
<li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
187
<li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
189
<li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
191
<li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
193
<li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
195
<li><a href="../classes/DataTable.html">DataTable</a></li>
197
<li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
199
<li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
201
<li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
203
<li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
205
<li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
207
<li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
209
<li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
211
<li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
213
<li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
215
<li><a href="../classes/DataType.Date.html">DataType.Date</a></li>
217
<li><a href="../classes/DataType.Date.Locale.html">DataType.Date.Locale</a></li>
219
<li><a href="../classes/DataType.Number.html">DataType.Number</a></li>
221
<li><a href="../classes/DataType.XML.html">DataType.XML</a></li>
223
<li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
225
<li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
227
<li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
229
<li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
231
<li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
233
<li><a href="../classes/Dial.html">Dial</a></li>
235
<li><a href="../classes/Do.html">Do</a></li>
237
<li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
239
<li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
241
<li><a href="../classes/Do.Error.html">Do.Error</a></li>
243
<li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
245
<li><a href="../classes/Do.Method.html">Do.Method</a></li>
247
<li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
249
<li><a href="../classes/DOM.html">DOM</a></li>
251
<li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
253
<li><a href="../classes/Drawing.html">Drawing</a></li>
255
<li><a href="../classes/Easing.html">Easing</a></li>
257
<li><a href="../classes/EditorBase.html">EditorBase</a></li>
259
<li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
261
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
263
<li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
265
<li><a href="../classes/Escape.html">Escape</a></li>
267
<li><a href="../classes/Event.html">Event</a></li>
269
<li><a href="../classes/EventFacade.html">EventFacade</a></li>
271
<li><a href="../classes/EventHandle.html">EventHandle</a></li>
273
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
275
<li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
277
<li><a href="../classes/Features.html">Features</a></li>
279
<li><a href="../classes/File.html">File</a></li>
281
<li><a href="../classes/FileFlash.html">FileFlash</a></li>
283
<li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
285
<li><a href="../classes/Fills.html">Fills</a></li>
287
<li><a href="../classes/Frame.html">Frame</a></li>
289
<li><a href="../classes/Get.html">Get</a></li>
291
<li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
293
<li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
295
<li><a href="../classes/Graph.html">Graph</a></li>
297
<li><a href="../classes/Graphic.html">Graphic</a></li>
299
<li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
301
<li><a href="../classes/Gridlines.html">Gridlines</a></li>
303
<li><a href="../classes/GroupCircle.html">GroupCircle</a></li>
305
<li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
307
<li><a href="../classes/GroupRect.html">GroupRect</a></li>
309
<li><a href="../classes/Handlebars.html">Handlebars</a></li>
311
<li><a href="../classes/Highlight.html">Highlight</a></li>
313
<li><a href="../classes/Histogram.html">Histogram</a></li>
315
<li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
317
<li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
319
<li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
321
<li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
323
<li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
325
<li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
327
<li><a href="../classes/Intl.html">Intl</a></li>
329
<li><a href="../classes/IO.html">IO</a></li>
331
<li><a href="../classes/JSON.html">JSON</a></li>
333
<li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
335
<li><a href="../classes/Lang.html">Lang</a></li>
337
<li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
339
<li><a href="../classes/Lines.html">Lines</a></li>
341
<li><a href="../classes/LineSeries.html">LineSeries</a></li>
343
<li><a href="../classes/Loader.html">Loader</a></li>
345
<li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
347
<li><a href="../classes/Matrix.html">Matrix</a></li>
349
<li><a href="../classes/Model.html">Model</a></li>
351
<li><a href="../classes/ModelList.html">ModelList</a></li>
353
<li><a href="../classes/Node.html">Node</a></li>
355
<li><a href="../classes/NodeList.html">NodeList</a></li>
357
<li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
359
<li><a href="../classes/Object.html">Object</a></li>
361
<li><a href="../classes/Overlay.html">Overlay</a></li>
363
<li><a href="../classes/Panel.html">Panel</a></li>
365
<li><a href="../classes/Parallel.html">Parallel</a></li>
367
<li><a href="../classes/Path.html">Path</a></li>
369
<li><a href="../classes/PieChart.html">PieChart</a></li>
371
<li><a href="../classes/PieSeries.html">PieSeries</a></li>
373
<li><a href="../classes/Pjax.html">Pjax</a></li>
375
<li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
377
<li><a href="../classes/Plots.html">Plots</a></li>
379
<li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
381
<li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
383
<li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
385
<li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
387
<li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
389
<li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
391
<li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
393
<li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
395
<li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
397
<li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
399
<li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
401
<li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
403
<li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
405
<li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
407
<li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
409
<li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
411
<li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
413
<li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
415
<li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
417
<li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
419
<li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
421
<li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
423
<li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
425
<li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
427
<li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
429
<li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
431
<li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
433
<li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
435
<li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
437
<li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
439
<li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
441
<li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
443
<li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
445
<li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
447
<li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
449
<li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
451
<li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
453
<li><a href="../classes/Pollable.html">Pollable</a></li>
455
<li><a href="../classes/Profiler.html">Profiler</a></li>
457
<li><a href="../classes/QueryString.html">QueryString</a></li>
459
<li><a href="../classes/Queue.html">Queue</a></li>
461
<li><a href="../classes/Record.html">Record</a></li>
463
<li><a href="../classes/Recordset.html">Recordset</a></li>
465
<li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
467
<li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
469
<li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
471
<li><a href="../classes/Rect.html">Rect</a></li>
473
<li><a href="../classes/Renderer.html">Renderer</a></li>
475
<li><a href="../classes/Resize.html">Resize</a></li>
477
<li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
479
<li><a href="../classes/Router.html">Router</a></li>
481
<li><a href="../classes/ScrollView.html">ScrollView</a></li>
483
<li><a href="../classes/Selector.html">Selector</a></li>
485
<li><a href="../classes/Shape.html">Shape</a></li>
487
<li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
489
<li><a href="../classes/Slider.html">Slider</a></li>
491
<li><a href="../classes/SliderBase.html">SliderBase</a></li>
493
<li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
495
<li><a href="../classes/Sortable.html">Sortable</a></li>
497
<li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
499
<li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
501
<li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
503
<li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
505
<li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
507
<li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
509
<li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
511
<li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
513
<li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
515
<li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
517
<li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
519
<li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
521
<li><a href="../classes/State.html">State</a></li>
523
<li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
525
<li><a href="../classes/Subscriber.html">Subscriber</a></li>
527
<li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
529
<li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
531
<li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
533
<li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
535
<li><a href="../classes/SVGPath.html">SVGPath</a></li>
537
<li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
539
<li><a href="../classes/SVGRect.html">SVGRect</a></li>
541
<li><a href="../classes/SVGShape.html">SVGShape</a></li>
543
<li><a href="../classes/SWF.html">SWF</a></li>
545
<li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
547
<li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
549
<li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
551
<li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
553
<li><a href="../classes/Tab.html">Tab</a></li>
555
<li><a href="../classes/TabView.html">TabView</a></li>
557
<li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
559
<li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
561
<li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
563
<li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
565
<li><a href="../classes/Test.Console.html">Test.Console</a></li>
567
<li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
569
<li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
571
<li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
573
<li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
575
<li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
577
<li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
579
<li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
581
<li><a href="../classes/Test.Results.html">Test.Results</a></li>
583
<li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
585
<li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
587
<li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
589
<li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
591
<li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
593
<li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
595
<li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
597
<li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
599
<li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
601
<li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
603
<li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
605
<li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
607
<li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
609
<li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
611
<li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
613
<li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
615
<li><a href="../classes/Transition.html">Transition</a></li>
617
<li><a href="../classes/UA.html">UA</a></li>
619
<li><a href="../classes/Uploader.html">Uploader</a></li>
621
<li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
623
<li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
625
<li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
627
<li><a href="../classes/ValueChange.html">ValueChange</a></li>
629
<li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
631
<li><a href="../classes/View.html">View</a></li>
633
<li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
635
<li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
637
<li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
639
<li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
641
<li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
643
<li><a href="../classes/VMLPath.html">VMLPath</a></li>
645
<li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
647
<li><a href="../classes/VMLRect.html">VMLRect</a></li>
649
<li><a href="../classes/VMLShape.html">VMLShape</a></li>
651
<li><a href="../classes/Widget.html">Widget</a></li>
653
<li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
655
<li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
657
<li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
659
<li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
661
<li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
663
<li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
665
<li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
667
<li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
669
<li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
671
<li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
673
<li><a href="../classes/YQL.html">YQL</a></li>
675
<li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
677
<li><a href="../classes/YUI.html">YUI</a></li>
679
<li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
683
<ul id="api-modules" class="apis modules">
685
<li><a href="../modules/align-plugin.html">align-plugin</a></li>
687
<li><a href="../modules/anim.html">anim</a></li>
689
<li><a href="../modules/anim-base.html">anim-base</a></li>
691
<li><a href="../modules/anim-color.html">anim-color</a></li>
693
<li><a href="../modules/anim-curve.html">anim-curve</a></li>
695
<li><a href="../modules/anim-easing.html">anim-easing</a></li>
697
<li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
699
<li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
701
<li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
703
<li><a href="../modules/anim-xy.html">anim-xy</a></li>
705
<li><a href="../modules/app.html">app</a></li>
707
<li><a href="../modules/app-base.html">app-base</a></li>
709
<li><a href="../modules/app-transitions.html">app-transitions</a></li>
711
<li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
713
<li><a href="../modules/array-extras.html">array-extras</a></li>
715
<li><a href="../modules/array-invoke.html">array-invoke</a></li>
717
<li><a href="../modules/arraylist.html">arraylist</a></li>
719
<li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
721
<li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
723
<li><a href="../modules/arraysort.html">arraysort</a></li>
725
<li><a href="../modules/async-queue.html">async-queue</a></li>
727
<li><a href="../modules/attribute.html">attribute</a></li>
729
<li><a href="../modules/attribute-base.html">attribute-base</a></li>
731
<li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
733
<li><a href="../modules/attribute-core.html">attribute-core</a></li>
735
<li><a href="../modules/attribute-events.html">attribute-events</a></li>
737
<li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
739
<li><a href="../modules/autocomplete.html">autocomplete</a></li>
741
<li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
743
<li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
745
<li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
747
<li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
749
<li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
751
<li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
753
<li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
755
<li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
757
<li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
759
<li><a href="../modules/base.html">base</a></li>
761
<li><a href="../modules/base-base.html">base-base</a></li>
763
<li><a href="../modules/base-build.html">base-build</a></li>
765
<li><a href="../modules/base-core.html">base-core</a></li>
767
<li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
769
<li><a href="../modules/button.html">button</a></li>
771
<li><a href="../modules/button-core.html">button-core</a></li>
773
<li><a href="../modules/button-group.html">button-group</a></li>
775
<li><a href="../modules/button-plugin.html">button-plugin</a></li>
777
<li><a href="../modules/cache.html">cache</a></li>
779
<li><a href="../modules/cache-base.html">cache-base</a></li>
781
<li><a href="../modules/cache-offline.html">cache-offline</a></li>
783
<li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
785
<li><a href="../modules/calendar.html">calendar</a></li>
787
<li><a href="../modules/calendar-base.html">calendar-base</a></li>
789
<li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
791
<li><a href="../modules/charts.html">charts</a></li>
793
<li><a href="../modules/charts-legend.html">charts-legend</a></li>
795
<li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
797
<li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
799
<li><a href="../modules/collection.html">collection</a></li>
801
<li><a href="../modules/console.html">console</a></li>
803
<li><a href="../modules/console-filters.html">console-filters</a></li>
805
<li><a href="../modules/cookie.html">cookie</a></li>
807
<li><a href="../modules/createlink-base.html">createlink-base</a></li>
809
<li><a href="../modules/dataschema.html">dataschema</a></li>
811
<li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
813
<li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
815
<li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
817
<li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
819
<li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
821
<li><a href="../modules/datasource.html">datasource</a></li>
823
<li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
825
<li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
827
<li><a href="../modules/datasource-function.html">datasource-function</a></li>
829
<li><a href="../modules/datasource-get.html">datasource-get</a></li>
831
<li><a href="../modules/datasource-io.html">datasource-io</a></li>
833
<li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
835
<li><a href="../modules/datasource-local.html">datasource-local</a></li>
837
<li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
839
<li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
841
<li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
843
<li><a href="../modules/datatable.html">datatable</a></li>
845
<li><a href="../modules/datatable-base.html">datatable-base</a></li>
847
<li><a href="../modules/datatable-base-deprecated.html">datatable-base-deprecated</a></li>
849
<li><a href="../modules/datatable-body.html">datatable-body</a></li>
851
<li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
853
<li><a href="../modules/datatable-core.html">datatable-core</a></li>
855
<li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
857
<li><a href="../modules/datatable-datasource-deprecated.html">datatable-datasource-deprecated</a></li>
859
<li><a href="../modules/datatable-deprecated.html">datatable-deprecated</a></li>
861
<li><a href="../modules/datatable-head.html">datatable-head</a></li>
863
<li><a href="../modules/datatable-message.html">datatable-message</a></li>
865
<li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
867
<li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
869
<li><a href="../modules/datatable-scroll-deprecated.html">datatable-scroll-deprecated</a></li>
871
<li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
873
<li><a href="../modules/datatable-sort-deprecated.html">datatable-sort-deprecated</a></li>
875
<li><a href="../modules/datatype.html">datatype</a></li>
877
<li><a href="../modules/datatype-date.html">datatype-date</a></li>
879
<li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
881
<li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
883
<li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
885
<li><a href="../modules/datatype-number.html">datatype-number</a></li>
887
<li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
889
<li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
891
<li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
893
<li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
895
<li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
897
<li><a href="../modules/dd.html">dd</a></li>
899
<li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
901
<li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
903
<li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
905
<li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
907
<li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
909
<li><a href="../modules/dd-drag.html">dd-drag</a></li>
911
<li><a href="../modules/dd-drop.html">dd-drop</a></li>
913
<li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
915
<li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
917
<li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
919
<li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
921
<li><a href="../modules/dial.html">dial</a></li>
923
<li><a href="../modules/dom.html">dom</a></li>
925
<li><a href="../modules/dom-base.html">dom-base</a></li>
927
<li><a href="../modules/dom-screen.html">dom-screen</a></li>
929
<li><a href="../modules/dom-style.html">dom-style</a></li>
931
<li><a href="../modules/dump.html">dump</a></li>
933
<li><a href="../modules/editor.html">editor</a></li>
935
<li><a href="../modules/editor-base.html">editor-base</a></li>
937
<li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
939
<li><a href="../modules/editor-br.html">editor-br</a></li>
941
<li><a href="../modules/editor-lists.html">editor-lists</a></li>
943
<li><a href="../modules/editor-para.html">editor-para</a></li>
945
<li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
947
<li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
949
<li><a href="../modules/editor-tab.html">editor-tab</a></li>
951
<li><a href="../modules/escape.html">escape</a></li>
953
<li><a href="../modules/event.html">event</a></li>
955
<li><a href="../modules/event-base.html">event-base</a></li>
957
<li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
959
<li><a href="../modules/event-custom.html">event-custom</a></li>
961
<li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
963
<li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
965
<li><a href="../modules/event-delegate.html">event-delegate</a></li>
967
<li><a href="../modules/event-flick.html">event-flick</a></li>
969
<li><a href="../modules/event-focus.html">event-focus</a></li>
971
<li><a href="../modules/event-gestures.html">event-gestures</a></li>
973
<li><a href="../modules/event-hover.html">event-hover</a></li>
975
<li><a href="../modules/event-key.html">event-key</a></li>
977
<li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
979
<li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
981
<li><a href="../modules/event-move.html">event-move</a></li>
983
<li><a href="../modules/event-outside.html">event-outside</a></li>
985
<li><a href="../modules/event-resize.html">event-resize</a></li>
987
<li><a href="../modules/event-simulate.html">event-simulate</a></li>
989
<li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
991
<li><a href="../modules/event-touch.html">event-touch</a></li>
993
<li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
995
<li><a href="../modules/exec-command.html">exec-command</a></li>
997
<li><a href="../modules/features.html">features</a></li>
999
<li><a href="../modules/file.html">file</a></li>
1001
<li><a href="../modules/file-flash.html">file-flash</a></li>
1003
<li><a href="../modules/file-html5.html">file-html5</a></li>
1005
<li><a href="../modules/frame.html">frame</a></li>
1007
<li><a href="../modules/get.html">get</a></li>
1009
<li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
1011
<li><a href="../modules/graphics.html">graphics</a></li>
1013
<li><a href="../modules/handlebars.html">handlebars</a></li>
1015
<li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
1017
<li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
1019
<li><a href="../modules/highlight.html">highlight</a></li>
1021
<li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
1023
<li><a href="../modules/highlight-base.html">highlight-base</a></li>
1025
<li><a href="../modules/history.html">history</a></li>
1027
<li><a href="../modules/history-base.html">history-base</a></li>
1029
<li><a href="../modules/history-hash.html">history-hash</a></li>
1031
<li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
1033
<li><a href="../modules/history-html5.html">history-html5</a></li>
1035
<li><a href="../modules/imageloader.html">imageloader</a></li>
1037
<li><a href="../modules/intl.html">intl</a></li>
1039
<li><a href="../modules/io.html">io</a></li>
1041
<li><a href="../modules/io-base.html">io-base</a></li>
1043
<li><a href="../modules/io-form.html">io-form</a></li>
1045
<li><a href="../modules/io-queue.html">io-queue</a></li>
1047
<li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
1049
<li><a href="../modules/io-xdr.html">io-xdr</a></li>
1051
<li><a href="../modules/json.html">json</a></li>
1053
<li><a href="../modules/json-parse.html">json-parse</a></li>
1055
<li><a href="../modules/json-stringify.html">json-stringify</a></li>
1057
<li><a href="../modules/jsonp.html">jsonp</a></li>
1059
<li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
1061
<li><a href="../modules/loader.html">loader</a></li>
1063
<li><a href="../modules/loader-base.html">loader-base</a></li>
1065
<li><a href="../modules/matrix.html">matrix</a></li>
1067
<li><a href="../modules/model.html">model</a></li>
1069
<li><a href="../modules/model-list.html">model-list</a></li>
1071
<li><a href="../modules/node.html">node</a></li>
1073
<li><a href="../modules/node-base.html">node-base</a></li>
1075
<li><a href="../modules/node-core.html">node-core</a></li>
1077
<li><a href="../modules/node-data.html">node-data</a></li>
1079
<li><a href="../modules/node-deprecated.html">node-deprecated</a></li>
1081
<li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
1083
<li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
1085
<li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
1087
<li><a href="../modules/node-flick.html">node-flick</a></li>
1089
<li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
1091
<li><a href="../modules/node-load.html">node-load</a></li>
1093
<li><a href="../modules/node-menunav.html">node-menunav</a></li>
1095
<li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
1097
<li><a href="../modules/node-screen.html">node-screen</a></li>
1099
<li><a href="../modules/node-style.html">node-style</a></li>
1101
<li><a href="../modules/oop.html">oop</a></li>
1103
<li><a href="../modules/overlay.html">overlay</a></li>
1105
<li><a href="../modules/panel.html">panel</a></li>
1107
<li><a href="../modules/parallel.html">parallel</a></li>
1109
<li><a href="../modules/pjax.html">pjax</a></li>
1111
<li><a href="../modules/pjax-base.html">pjax-base</a></li>
1113
<li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
1115
<li><a href="../modules/plugin.html">plugin</a></li>
1117
<li><a href="../modules/pluginhost.html">pluginhost</a></li>
1119
<li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
1121
<li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
1123
<li><a href="../modules/profiler.html">profiler</a></li>
1125
<li><a href="../modules/querystring.html">querystring</a></li>
1127
<li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
1129
<li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
1131
<li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
1133
<li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
1135
<li><a href="../modules/queue-promote.html">queue-promote</a></li>
1137
<li><a href="../modules/range-slider.html">range-slider</a></li>
1139
<li><a href="../modules/recordset.html">recordset</a></li>
1141
<li><a href="../modules/recordset-base.html">recordset-base</a></li>
1143
<li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
1145
<li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
1147
<li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
1149
<li><a href="../modules/resize.html">resize</a></li>
1151
<li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
1153
<li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
1155
<li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
1157
<li><a href="../modules/rollup.html">rollup</a></li>
1159
<li><a href="../modules/router.html">router</a></li>
1161
<li><a href="../modules/scrollview.html">scrollview</a></li>
1163
<li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
1165
<li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
1167
<li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
1169
<li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
1171
<li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
1173
<li><a href="../modules/selection.html">selection</a></li>
1175
<li><a href="../modules/selector-css2.html">selector-css2</a></li>
1177
<li><a href="../modules/selector-css3.html">selector-css3</a></li>
1179
<li><a href="../modules/selector-native.html">selector-native</a></li>
1181
<li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
1183
<li><a href="../modules/slider.html">slider</a></li>
1185
<li><a href="../modules/slider-base.html">slider-base</a></li>
1187
<li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
1189
<li><a href="../modules/sortable.html">sortable</a></li>
1191
<li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
1193
<li><a href="../modules/stylesheet.html">stylesheet</a></li>
1195
<li><a href="../modules/substitute.html">substitute</a></li>
1197
<li><a href="../modules/swf.html">swf</a></li>
1199
<li><a href="../modules/swfdetect.html">swfdetect</a></li>
1201
<li><a href="../modules/tabview.html">tabview</a></li>
1203
<li><a href="../modules/test.html">test</a></li>
1205
<li><a href="../modules/test-console.html">test-console</a></li>
1207
<li><a href="../modules/text.html">text</a></li>
1209
<li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
1211
<li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
1213
<li><a href="../modules/transition.html">transition</a></li>
1215
<li><a href="../modules/uploader.html">uploader</a></li>
1217
<li><a href="../modules/uploader-deprecated.html">uploader-deprecated</a></li>
1219
<li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
1221
<li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
1223
<li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
1225
<li><a href="../modules/view.html">view</a></li>
1227
<li><a href="../modules/view-node-map.html">view-node-map</a></li>
1229
<li><a href="../modules/widget.html">widget</a></li>
1231
<li><a href="../modules/widget-anim.html">widget-anim</a></li>
1233
<li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
1235
<li><a href="../modules/widget-base.html">widget-base</a></li>
1237
<li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
1239
<li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
1241
<li><a href="../modules/widget-child.html">widget-child</a></li>
1243
<li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
1245
<li><a href="../modules/widget-locale.html">widget-locale</a></li>
1247
<li><a href="../modules/widget-modality.html">widget-modality</a></li>
1249
<li><a href="../modules/widget-parent.html">widget-parent</a></li>
1251
<li><a href="../modules/widget-position.html">widget-position</a></li>
1253
<li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
1255
<li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
1257
<li><a href="../modules/widget-skin.html">widget-skin</a></li>
1259
<li><a href="../modules/widget-stack.html">widget-stack</a></li>
1261
<li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
1263
<li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
1265
<li><a href="../modules/yql.html">yql</a></li>
1267
<li><a href="../modules/yui.html">yui</a></li>
1269
<li><a href="../modules/yui-base.html">yui-base</a></li>
1271
<li><a href="../modules/yui-later.html">yui-later</a></li>
1273
<li><a href="../modules/yui-log.html">yui-log</a></li>
1275
<li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
1277
<li><a href="../modules/yui3.html">yui3</a></li>
1286
<div class="yui3-u-3-4">
1287
<div id="api-options">
1289
<label for="api-show-inherited">
1290
<input type="checkbox" id="api-show-inherited" checked>
1294
<label for="api-show-protected">
1295
<input type="checkbox" id="api-show-protected">
1299
<label for="api-show-private">
1300
<input type="checkbox" id="api-show-private">
1306
<div class="apidocs">
1307
<div id="docs-main">
1308
<div class="content">
1310
<div class="box meta">
1314
<ul class="inline commas">
1316
<li><a href="App.Transitions.html">App.Transitions</a></li>
1323
<div class="extends">
1324
Extends <a href="../classes/App.Base.html" class="crosslink">App.Base</a>
1329
<div class="foundat">
1330
Defined in: <a href="../files/app_js_app-base.js.html#l1100"><code>app/js/app-base.js:1100</code></a>
1336
Module: <a href="../modules/app-base.html">app-base</a><br>
1337
Parent Module: <a href="../modules/app.html">app</a>
1342
<p>Available since 3.5.0</p>
1348
<div class="box intro">
1349
<p>Provides a top-level application component which manages navigation and views.</p>
1351
<p>This gives you a foundation and structure on which to build your application; it
1352
combines robust URL navigation with powerful routing and flexible view
1355
<p><code>Y.App</code> is both a namespace and constructor function. The <code>Y.App</code> class is
1356
special in that any <code>Y.App</code> class extensions that are included in the YUI
1357
instance will be <strong>auto-mixed</strong> on to the <code>Y.App</code> class. Consider this example:</p>
1359
<pre class="code"><code class="prettyprint">YUI().use('app-base', 'app-transitions', function (Y) {
1360
// This will create two YUI Apps, <code>basicApp</code> will not have transitions,
1361
// but <code>fancyApp</code> will have transitions support included and turn it on.
1362
var basicApp = new Y.App.Base(),
1363
fancyApp = new Y.App({transitions: true});
1369
<div class="constructor">
1370
<h2>Constructor</h2>
1371
<div id="method_App" class="method item">
1372
<h3 class="name"><code>App</code></h3>
1376
<span class="paren">(</span><ul class="args-list inline commas">
1380
<code class="optional">[config]</code>
1384
</ul><span class="paren">)</span>
1411
<a href="../files/app_js_app-base.js.html#l1100"><code>app/js/app-base.js:1100</code></a>
1419
<p>Available since 3.5.0</p>
1423
<div class="description">
1428
<div class="params">
1429
<h4>Parameters:</h4>
1431
<ul class="params-list">
1435
<code class="param-name optional">[config]</code>
1436
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
1437
<span class="flag optional" title="This parameter is optional.">optional</span>
1442
<div class="param-description">
1443
<p>The following are configuration properties that can be
1444
specified <em>in addition</em> to default attribute values and the non-attribute
1445
properties provided by <code>Y.Base</code>:</p>
1449
<ul class="params-list">
1453
<code class="param-name optional">[views]</code>
1454
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
1455
<span class="flag optional" title="This parameter is optional.">optional</span>
1458
<div class="param-description">
1459
<p>Hash of view-name to metadata used to
1460
declaratively describe an application's views and their relationship with
1461
the app and other views. The views specified here will override any defaults
1462
provided by the <code>views</code> object on the <code>prototype</code>.</p>
1484
<div id="classdocs" class="tabview">
1485
<ul class="api-class-tabs">
1486
<li class="api-class-tab index"><a href="#index">Index</a></li>
1489
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
1492
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
1495
<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
1498
<li class="api-class-tab events"><a href="#events">Events</a></li>
1503
<div id="index" class="api-class-tabpanel index">
1504
<h2 class="off-left">Item Index</h2>
1507
<div class="index-section methods">
1510
<ul class="index-list methods">
1512
<li class="index-item method private inherited">
1513
<a href="#method__addAttrs">_addAttrs</a>
1518
<li class="index-item method private inherited">
1519
<a href="#method__addLazyAttr">_addLazyAttr</a>
1524
<li class="index-item method protected inherited">
1525
<a href="#method__afterActiveViewChange">_afterActiveViewChange</a>
1530
<li class="index-item method protected inherited">
1531
<a href="#method__afterContainerChange">_afterContainerChange</a>
1536
<li class="index-item method protected inherited">
1537
<a href="#method__afterHistoryChange">_afterHistoryChange</a>
1542
<li class="index-item method private inherited">
1543
<a href="#method__aggregateAttrs">_aggregateAttrs</a>
1548
<li class="index-item method protected inherited">
1549
<a href="#method__attachView">_attachView</a>
1554
<li class="index-item method private inherited inherited">
1555
<a href="#method__attrCfgHash">_attrCfgHash</a>
1560
<li class="index-item method private inherited">
1561
<a href="#method__baseDestroy">_baseDestroy</a>
1566
<li class="index-item method private inherited">
1567
<a href="#method__baseInit">_baseInit</a>
1572
<li class="index-item method protected inherited">
1573
<a href="#method__decode">_decode</a>
1578
<li class="index-item method private inherited">
1579
<a href="#method__defAttrChangeFn">_defAttrChangeFn</a>
1584
<li class="index-item method protected inherited">
1585
<a href="#method__defDestroyFn">_defDestroyFn</a>
1590
<li class="index-item method protected inherited">
1591
<a href="#method__defInitFn">_defInitFn</a>
1596
<li class="index-item method protected inherited">
1597
<a href="#method__defNavigateFn">_defNavigateFn</a>
1602
<li class="index-item method protected inherited">
1603
<a href="#method__defReadyFn">_defReadyFn</a>
1608
<li class="index-item method protected inherited">
1609
<a href="#method__dequeue">_dequeue</a>
1614
<li class="index-item method protected inherited inherited">
1615
<a href="#method__destroyContainer">_destroyContainer</a>
1620
<li class="index-item method private inherited">
1621
<a href="#method__destroyHierarchy">_destroyHierarchy</a>
1626
<li class="index-item method protected inherited">
1627
<a href="#method__detachView">_detachView</a>
1632
<li class="index-item method protected inherited">
1633
<a href="#method__dispatch">_dispatch</a>
1638
<li class="index-item method private inherited">
1639
<a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>
1644
<li class="index-item method private inherited">
1645
<a href="#method__filterAttrCfs">_filterAttrCfs</a>
1650
<li class="index-item method private inherited">
1651
<a href="#method__fireAttrChange">_fireAttrChange</a>
1656
<li class="index-item method protected inherited">
1657
<a href="#method__getAttr">_getAttr</a>
1662
<li class="index-item method protected inherited">
1663
<a href="#method__getAttrCfg">_getAttrCfg</a>
1668
<li class="index-item method protected inherited">
1669
<a href="#method__getAttrCfgs">_getAttrCfgs</a>
1674
<li class="index-item method private inherited inherited">
1675
<a href="#method__getAttrInitVal">_getAttrInitVal</a>
1680
<li class="index-item method protected inherited">
1681
<a href="#method__getAttrs">_getAttrs</a>
1686
<li class="index-item method protected inherited">
1687
<a href="#method__getClasses">_getClasses</a>
1692
<li class="index-item method protected inherited">
1693
<a href="#method__getContainer">_getContainer</a>
1698
<li class="index-item method protected inherited">
1699
<a href="#method__getHashPath">_getHashPath</a>
1704
<li class="index-item method protected inherited">
1705
<a href="#method__getOrigin">_getOrigin</a>
1710
<li class="index-item method protected inherited">
1711
<a href="#method__getPath">_getPath</a>
1716
<li class="index-item method protected inherited">
1717
<a href="#method__getQuery">_getQuery</a>
1722
<li class="index-item method protected inherited">
1723
<a href="#method__getRegex">_getRegex</a>
1728
<li class="index-item method protected inherited">
1729
<a href="#method__getRequest">_getRequest</a>
1734
<li class="index-item method protected inherited">
1735
<a href="#method__getResponse">_getResponse</a>
1740
<li class="index-item method protected inherited">
1741
<a href="#method__getRoot">_getRoot</a>
1746
<li class="index-item method protected inherited">
1747
<a href="#method__getRoutes">_getRoutes</a>
1752
<li class="index-item method private inherited">
1753
<a href="#method__getStateVal">_getStateVal</a>
1758
<li class="index-item method private inherited">
1759
<a href="#method__getType">_getType</a>
1764
<li class="index-item method protected inherited inherited">
1765
<a href="#method__getURL">_getURL</a>
1770
<li class="index-item method protected inherited">
1771
<a href="#method__getViewContainer">_getViewContainer</a>
1776
<li class="index-item method protected inherited">
1777
<a href="#method__hasSameOrigin">_hasSameOrigin</a>
1782
<li class="index-item method private inherited">
1783
<a href="#method__initAttrHost">_initAttrHost</a>
1788
<li class="index-item method private inherited inherited">
1789
<a href="#method__initAttribute">_initAttribute</a>
1794
<li class="index-item method protected inherited">
1795
<a href="#method__initAttrs">_initAttrs</a>
1800
<li class="index-item method private inherited inherited">
1801
<a href="#method__initBase">_initBase</a>
1806
<li class="index-item method private inherited">
1807
<a href="#method__initHierarchy">_initHierarchy</a>
1812
<li class="index-item method private inherited">
1813
<a href="#method__initHierarchyData">_initHierarchyData</a>
1818
<li class="index-item method protected inherited">
1819
<a href="#method__initHtml5">_initHtml5</a>
1824
<li class="index-item method protected inherited">
1825
<a href="#method__isChildView">_isChildView</a>
1830
<li class="index-item method private inherited">
1831
<a href="#method__isLazyAttr">_isLazyAttr</a>
1836
<li class="index-item method protected inherited">
1837
<a href="#method__isParentView">_isParentView</a>
1842
<li class="index-item method protected inherited">
1843
<a href="#method__joinURL">_joinURL</a>
1848
<li class="index-item method private inherited">
1849
<a href="#method__monitor">_monitor</a>
1854
<li class="index-item method protected inherited inherited">
1855
<a href="#method__navigate">_navigate</a>
1860
<li class="index-item method protected inherited">
1861
<a href="#method__normalizePath">_normalizePath</a>
1866
<li class="index-item method private inherited inherited">
1867
<a href="#method__normAttrVals">_normAttrVals</a>
1872
<li class="index-item method protected inherited">
1873
<a href="#method__onLinkClick">_onLinkClick</a>
1878
<li class="index-item method protected inherited">
1879
<a href="#method__parseQuery">_parseQuery</a>
1884
<li class="index-item method private inherited">
1885
<a href="#method__parseType">_parseType</a>
1890
<li class="index-item method protected inherited">
1891
<a href="#method__pjaxBindUI">_pjaxBindUI</a>
1896
<li class="index-item method private inherited">
1897
<a href="#method__preInitEventCfg">_preInitEventCfg</a>
1902
<li class="index-item method protected inherited">
1903
<a href="#method__protectAttrs">_protectAttrs</a>
1908
<li class="index-item method protected inherited">
1909
<a href="#method__queue">_queue</a>
1914
<li class="index-item method protected inherited">
1915
<a href="#method__resolvePath">_resolvePath</a>
1920
<li class="index-item method protected inherited">
1921
<a href="#method__resolveURL">_resolveURL</a>
1926
<li class="index-item method protected inherited inherited">
1927
<a href="#method__save">_save</a>
1932
<li class="index-item method protected inherited inherited">
1933
<a href="#method__set">_set</a>
1938
<li class="index-item method protected inherited">
1939
<a href="#method__setAttr">_setAttr</a>
1944
<li class="index-item method protected inherited">
1945
<a href="#method__setAttrs">_setAttrs</a>
1950
<li class="index-item method private inherited">
1951
<a href="#method__setAttrVal">_setAttrVal</a>
1956
<li class="index-item method protected inherited">
1957
<a href="#method__setRoutes">_setRoutes</a>
1962
<li class="index-item method private inherited">
1963
<a href="#method__setStateVal">_setStateVal</a>
1968
<li class="index-item method protected inherited">
1969
<a href="#method__setTransitions">_setTransitions</a>
1974
<li class="index-item method protected inherited">
1975
<a href="#method__uiSetActiveView">_uiSetActiveView</a>
1980
<li class="index-item method protected inherited">
1981
<a href="#method__upgradeURL">_upgradeURL</a>
1986
<li class="index-item method inherited">
1987
<a href="#method_addAttr">addAttr</a>
1992
<li class="index-item method inherited">
1993
<a href="#method_addAttrs">addAttrs</a>
1998
<li class="index-item method inherited">
1999
<a href="#method_addTarget">addTarget</a>
2004
<li class="index-item method inherited">
2005
<a href="#method_after">after</a>
2010
<li class="index-item method inherited">
2011
<a href="#method_attachEvents">attachEvents</a>
2016
<li class="index-item method inherited">
2017
<a href="#method_attrAdded">attrAdded</a>
2022
<li class="index-item method inherited">
2023
<a href="#method_before">before</a>
2028
<li class="index-item method inherited">
2029
<a href="#method_bubble">bubble</a>
2034
<li class="index-item method inherited">
2035
<a href="#method_create">create</a>
2040
<li class="index-item method inherited">
2041
<a href="#method_createView">createView</a>
2046
<li class="index-item method inherited inherited">
2047
<a href="#method_destroy">destroy</a>
2052
<li class="index-item method inherited">
2053
<a href="#method_detach">detach</a>
2058
<li class="index-item method inherited">
2059
<a href="#method_detachAll">detachAll</a>
2064
<li class="index-item method inherited">
2065
<a href="#method_detachEvents">detachEvents</a>
2070
<li class="index-item method inherited">
2071
<a href="#method_dispatch">dispatch</a>
2076
<li class="index-item method inherited">
2077
<a href="#method_fire">fire</a>
2082
<li class="index-item method inherited">
2083
<a href="#method_get">get</a>
2088
<li class="index-item method inherited">
2089
<a href="#method_getAttrs">getAttrs</a>
2094
<li class="index-item method inherited">
2095
<a href="#method_getEvent">getEvent</a>
2100
<li class="index-item method inherited">
2101
<a href="#method_getPath">getPath</a>
2106
<li class="index-item method inherited">
2107
<a href="#method_getTargets">getTargets</a>
2112
<li class="index-item method inherited">
2113
<a href="#method_getViewInfo">getViewInfo</a>
2118
<li class="index-item method inherited">
2119
<a href="#method_hasRoute">hasRoute</a>
2124
<li class="index-item method inherited inherited">
2125
<a href="#method_init">init</a>
2130
<li class="index-item method inherited">
2131
<a href="#method_match">match</a>
2136
<li class="index-item method inherited">
2137
<a href="#method_modifyAttr">modifyAttr</a>
2142
<li class="index-item method inherited inherited">
2143
<a href="#method_navigate">navigate</a>
2148
<li class="index-item method inherited">
2149
<a href="#method_on">on</a>
2154
<li class="index-item method inherited">
2155
<a href="#method_once">once</a>
2160
<li class="index-item method inherited">
2161
<a href="#method_onceAfter">onceAfter</a>
2166
<li class="index-item method inherited">
2167
<a href="#method_parseType">parseType</a>
2172
<li class="index-item method inherited">
2173
<a href="#method_publish">publish</a>
2178
<li class="index-item method inherited">
2179
<a href="#method_remove">remove</a>
2184
<li class="index-item method inherited">
2185
<a href="#method_removeAttr">removeAttr</a>
2190
<li class="index-item method inherited">
2191
<a href="#method_removeQuery">removeQuery</a>
2196
<li class="index-item method inherited">
2197
<a href="#method_removeRoot">removeRoot</a>
2202
<li class="index-item method inherited">
2203
<a href="#method_removeTarget">removeTarget</a>
2208
<li class="index-item method inherited inherited">
2209
<a href="#method_render">render</a>
2214
<li class="index-item method inherited">
2215
<a href="#method_replace">replace</a>
2220
<li class="index-item method inherited">
2221
<a href="#method_reset">reset</a>
2226
<li class="index-item method inherited">
2227
<a href="#method_route">route</a>
2232
<li class="index-item method inherited">
2233
<a href="#method_save">save</a>
2238
<li class="index-item method inherited inherited">
2239
<a href="#method_set">set</a>
2244
<li class="index-item method inherited inherited">
2245
<a href="#method_setAttrs">setAttrs</a>
2250
<li class="index-item method inherited inherited">
2251
<a href="#method_showView">showView</a>
2256
<li class="index-item method deprecated inherited">
2257
<a href="#method_subscribe">subscribe</a>
2262
<li class="index-item method inherited">
2263
<a href="#method_toString">toString</a>
2268
<li class="index-item method deprecated inherited">
2269
<a href="#method_unsubscribe">unsubscribe</a>
2274
<li class="index-item method deprecated inherited">
2275
<a href="#method_unsubscribeAll">unsubscribeAll</a>
2280
<li class="index-item method inherited">
2281
<a href="#method_upgrade">upgrade</a>
2291
<div class="index-section properties">
2294
<ul class="index-list properties">
2296
<li class="index-item property protected inherited inherited">
2297
<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>
2302
<li class="index-item property protected inherited">
2303
<a href="#property__dispatched">_dispatched</a>
2308
<li class="index-item property protected inherited">
2309
<a href="#property__dispatching">_dispatching</a>
2314
<li class="index-item property protected inherited">
2315
<a href="#property__html5">_html5</a>
2320
<li class="index-item property protected inherited">
2321
<a href="#property__pjaxEvents">_pjaxEvents</a>
2326
<li class="index-item property protected inherited">
2327
<a href="#property__ready">_ready</a>
2332
<li class="index-item property protected inherited">
2333
<a href="#property__regexPathParam">_regexPathParam</a>
2338
<li class="index-item property protected inherited">
2339
<a href="#property__regexURL">_regexURL</a>
2344
<li class="index-item property protected inherited">
2345
<a href="#property__regexUrlOrigin">_regexUrlOrigin</a>
2350
<li class="index-item property protected inherited">
2351
<a href="#property__regexUrlQuery">_regexUrlQuery</a>
2356
<li class="index-item property protected inherited">
2357
<a href="#property__viewInfoMap">_viewInfoMap</a>
2362
<li class="index-item property inherited">
2363
<a href="#property_containerTemplate">containerTemplate</a>
2368
<li class="index-item property inherited">
2369
<a href="#property_events">events</a>
2374
<li class="index-item property deprecated inherited">
2375
<a href="#property_name">name</a>
2380
<li class="index-item property inherited">
2381
<a href="#property_template">template</a>
2386
<li class="index-item property inherited">
2387
<a href="#property_transitions">transitions</a>
2392
<li class="index-item property inherited">
2393
<a href="#property_views">views</a>
2403
<div class="index-section attrs">
2406
<ul class="index-list attrs">
2408
<li class="index-item attr inherited">
2409
<a href="#attr_activeView">activeView</a>
2412
<li class="index-item attr inherited inherited">
2413
<a href="#attr_container">container</a>
2416
<li class="index-item attr inherited">
2417
<a href="#attr_destroyed">destroyed</a>
2420
<li class="index-item attr inherited inherited">
2421
<a href="#attr_html5">html5</a>
2424
<li class="index-item attr inherited">
2425
<a href="#attr_initialized">initialized</a>
2428
<li class="index-item attr inherited inherited">
2429
<a href="#attr_linkSelector">linkSelector</a>
2432
<li class="index-item attr inherited">
2433
<a href="#attr_navigateOnHash">navigateOnHash</a>
2436
<li class="index-item attr inherited">
2437
<a href="#attr_root">root</a>
2440
<li class="index-item attr inherited">
2441
<a href="#attr_routes">routes</a>
2444
<li class="index-item attr inherited">
2445
<a href="#attr_scrollToTop">scrollToTop</a>
2448
<li class="index-item attr inherited">
2449
<a href="#attr_serverRouting">serverRouting</a>
2452
<li class="index-item attr inherited">
2453
<a href="#attr_transitions">transitions</a>
2456
<li class="index-item attr inherited">
2457
<a href="#attr_viewContainer">viewContainer</a>
2465
<div class="index-section events">
2468
<ul class="index-list events">
2470
<li class="index-item event inherited">
2471
<a href="#event_destroy">destroy</a>
2476
<li class="index-item event inherited">
2477
<a href="#event_init">init</a>
2482
<li class="index-item event inherited">
2483
<a href="#event_navigate">navigate</a>
2488
<li class="index-item event inherited">
2489
<a href="#event_ready">ready</a>
2500
<div id="methods" class="api-class-tabpanel">
2501
<h2 class="off-left">Methods</h2>
2504
<div id="method__addAttrs" class="method item private inherited">
2505
<h3 class="name"><code>_addAttrs</code></h3>
2509
<span class="paren">(</span><ul class="args-list inline commas">
2529
</ul><span class="paren">)</span>
2538
<span class="flag private">private</span>
2551
<a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:
2555
<a href="../files/attribute_js_AttributeCore.js.html#l740"><code>attribute/js/AttributeCore.js:740</code></a>
2565
<div class="description">
2566
<p>Implementation behind the public addAttrs method. </p>
2568
<p>This method is invoked directly by get if it encounters a scenario
2569
in which an attribute's valueFn attempts to obtain the
2570
value an attribute in the same group of attributes, which has not yet
2571
been added (on demand initialization).</p>
2575
<div class="params">
2576
<h4>Parameters:</h4>
2578
<ul class="params-list">
2582
<code class="param-name">cfgs</code>
2583
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2588
<div class="param-description">
2589
<p>An object with attribute name/configuration pairs.</p>
2597
<code class="param-name">values</code>
2598
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2603
<div class="param-description">
2604
<p>An object with attribute name/value pairs, defining the initial values to apply.
2605
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
2613
<code class="param-name">lazy</code>
2614
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
2619
<div class="param-description">
2620
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
2621
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
2622
See <a href="#method_addAttr">addAttr</a>.</p>
2638
<div id="method__addLazyAttr" class="method item private inherited">
2639
<h3 class="name"><code>_addLazyAttr</code></h3>
2643
<span class="paren">(</span><ul class="args-list inline commas">
2651
</ul><span class="paren">)</span>
2660
<span class="flag private">private</span>
2673
<a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:
2677
<a href="../files/attribute_js_AttributeCore.js.html#l312"><code>attribute/js/AttributeCore.js:312</code></a>
2687
<div class="description">
2688
<p>Finishes initializing an attribute which has been lazily added.</p>
2692
<div class="params">
2693
<h4>Parameters:</h4>
2695
<ul class="params-list">
2699
<code class="param-name">name</code>
2700
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2705
<div class="param-description">
2706
<p>The name of the attribute</p>
2722
<div id="method__afterActiveViewChange" class="method item protected inherited">
2723
<h3 class="name"><code>_afterActiveViewChange</code></h3>
2727
<span class="paren">(</span><ul class="args-list inline commas">
2735
</ul><span class="paren">)</span>
2744
<span class="flag protected">protected</span>
2757
<a href="../classes/App.Base.html#method__afterActiveViewChange">App.Base</a>:
2761
<a href="../files/app_js_app-base.js.html#l840"><code>app/js/app-base.js:840</code></a>
2769
<p>Available since 3.5.0</p>
2773
<div class="description">
2774
<p>Handles the application's <code>activeViewChange</code> event (which is fired when the
2775
<code>activeView</code> attribute changes) by detaching the old view, attaching the new
2778
<p>The <code>activeView</code> attribute is read-only, so the public API to change its
2779
value is through the <code>showView()</code> method.</p>
2783
<div class="params">
2784
<h4>Parameters:</h4>
2786
<ul class="params-list">
2790
<code class="param-name">e</code>
2791
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
2796
<div class="param-description">
2813
<div id="method__afterContainerChange" class="method item protected inherited">
2814
<h3 class="name"><code>_afterContainerChange</code></h3>
2817
<span class="paren">()</span>
2825
<span class="flag protected">protected</span>
2838
<a href="../classes/View.html#method__afterContainerChange">View</a>:
2842
<a href="../files/app_js_view.js.html#l348"><code>app/js/view.js:348</code></a>
2850
<p>Available since 3.5.0</p>
2854
<div class="description">
2855
<p>Handles <code>containerChange</code> events. Detaches event handlers from the old
2856
container (if any) and attaches them to the new container.</p>
2858
<p>Right now the <code>container</code> attr is initOnly so this event should only ever
2859
fire the first time the container is created, but in the future (once Y.App
2860
can handle it) we may allow runtime container changes.</p>
2871
<div id="method__afterHistoryChange" class="method item protected inherited">
2872
<h3 class="name"><code>_afterHistoryChange</code></h3>
2876
<span class="paren">(</span><ul class="args-list inline commas">
2884
</ul><span class="paren">)</span>
2893
<span class="flag protected">protected</span>
2906
<a href="../classes/Router.html#method__afterHistoryChange">Router</a>:
2910
<a href="../files/app_js_router.js.html#l940"><code>app/js/router.js:940</code></a>
2920
<div class="description">
2921
<p>Handles <code>history:change</code> and <code>hashchange</code> events.</p>
2925
<div class="params">
2926
<h4>Parameters:</h4>
2928
<ul class="params-list">
2932
<code class="param-name">e</code>
2933
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
2938
<div class="param-description">
2955
<div id="method__aggregateAttrs" class="method item private inherited">
2956
<h3 class="name"><code>_aggregateAttrs</code></h3>
2960
<span class="paren">(</span><ul class="args-list inline commas">
2964
<code>allAttrs</code>
2968
</ul><span class="paren">)</span>
2973
<span class="returns-inline">
2974
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2981
<span class="flag private">private</span>
2994
<a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:
2998
<a href="../files/base_js_BaseCore.js.html#l426"><code>base/js/BaseCore.js:426</code></a>
3008
<div class="description">
3009
<p>A helper method, used by _initHierarchyData to aggregate
3010
attribute configuration across the instances class hierarchy.</p>
3012
<p>The method will protect the attribute configuration value to protect the statically defined
3013
default value in ATTRS if required (if the value is an object literal, array or the
3014
attribute configuration has cloneDefaultValue set to shallow or deep).</p>
3018
<div class="params">
3019
<h4>Parameters:</h4>
3021
<ul class="params-list">
3025
<code class="param-name">allAttrs</code>
3026
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
3031
<div class="param-description">
3032
<p>An array of ATTRS definitions across classes in the hierarchy
3033
(subclass first, Base last)</p>
3044
<div class="returns">
3047
<div class="returns-description">
3050
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
3052
The aggregate set of ATTRS definitions for the instance
3062
<div id="method__attachView" class="method item protected inherited">
3063
<h3 class="name"><code>_attachView</code></h3>
3067
<span class="paren">(</span><ul class="args-list inline commas">
3077
<code>prepend=false</code>
3081
</ul><span class="paren">)</span>
3090
<span class="flag protected">protected</span>
3103
<a href="../classes/App.Base.html#method__attachView">App.Base</a>:
3107
<a href="../files/app_js_app-base.js.html#l431"><code>app/js/app-base.js:431</code></a>
3115
<p>Available since 3.5.0</p>
3119
<div class="description">
3120
<p>Helper method to attach the view instance to the application by making the
3121
app a bubble target of the view, append the view to the <code>viewContainer</code>, and
3122
assign it to the <code>instance</code> property of the associated view info metadata.</p>
3126
<div class="params">
3127
<h4>Parameters:</h4>
3129
<ul class="params-list">
3133
<code class="param-name">view</code>
3134
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
3139
<div class="param-description">
3140
<p>View to attach.</p>
3148
<code class="param-name">prepend=false</code>
3149
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
3154
<div class="param-description">
3155
<p>Whether the view should be prepended instead
3156
of appended to the <code>viewContainer</code>.</p>
3172
<div id="method__attrCfgHash" class="method item private inherited">
3173
<h3 class="name"><code>_attrCfgHash</code></h3>
3176
<span class="paren">()</span>
3184
<span class="flag private">private</span>
3196
<a href="../classes/BaseCore.html#method__attrCfgHash">
3204
<a href="../files/base_js_Base.js.html#l180"><code>base/js/Base.js:180</code></a>
3214
<div class="description">
3215
<p>Utility method to define the attribute hash used to filter/whitelist property mixes for
3227
<div id="method__baseDestroy" class="method item private inherited">
3228
<h3 class="name"><code>_baseDestroy</code></h3>
3231
<span class="paren">()</span>
3239
<span class="flag private">private</span>
3252
<a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:
3256
<a href="../files/base_js_BaseCore.js.html#l263"><code>base/js/BaseCore.js:263</code></a>
3266
<div class="description">
3267
<p>Internal destroy implementation for BaseCore</p>
3278
<div id="method__baseInit" class="method item private inherited">
3279
<h3 class="name"><code>_baseInit</code></h3>
3282
<span class="paren">()</span>
3290
<span class="flag private">private</span>
3303
<a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:
3307
<a href="../files/base_js_BaseCore.js.html#l235"><code>base/js/BaseCore.js:235</code></a>
3317
<div class="description">
3318
<p>Internal initialization implementation for BaseCore</p>
3329
<div id="method__decode" class="method item protected inherited">
3330
<h3 class="name"><code>_decode</code></h3>
3334
<span class="paren">(</span><ul class="args-list inline commas">
3342
</ul><span class="paren">)</span>
3347
<span class="returns-inline">
3348
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
3355
<span class="flag protected">protected</span>
3368
<a href="../classes/Router.html#method__decode">Router</a>:
3372
<a href="../files/app_js_router.js.html#l489"><code>app/js/router.js:489</code></a>
3382
<div class="description">
3383
<p>Wrapper around <code>decodeURIComponent</code> that also converts <code>+</code> chars into
3388
<div class="params">
3389
<h4>Parameters:</h4>
3391
<ul class="params-list">
3395
<code class="param-name">string</code>
3396
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
3401
<div class="param-description">
3402
<p>String to decode.</p>
3413
<div class="returns">
3416
<div class="returns-description">
3419
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
3431
<div id="method__defAttrChangeFn" class="method item private inherited">
3432
<h3 class="name"><code>_defAttrChangeFn</code></h3>
3436
<span class="paren">(</span><ul class="args-list inline commas">
3444
</ul><span class="paren">)</span>
3453
<span class="flag private">private</span>
3466
<a href="../classes/AttributeEvents.html#method__defAttrChangeFn">AttributeEvents</a>:
3470
<a href="../files/attribute_js_AttributeEvents.js.html#l148"><code>attribute/js/AttributeEvents.js:148</code></a>
3480
<div class="description">
3481
<p>Default function for attribute change events.</p>
3485
<div class="params">
3486
<h4>Parameters:</h4>
3488
<ul class="params-list">
3492
<code class="param-name">e</code>
3493
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3498
<div class="param-description">
3499
<p>The event object for attribute change events.</p>
3515
<div id="method__defDestroyFn" class="method item protected inherited">
3516
<h3 class="name"><code>_defDestroyFn</code></h3>
3520
<span class="paren">(</span><ul class="args-list inline commas">
3528
</ul><span class="paren">)</span>
3537
<span class="flag protected">protected</span>
3550
<a href="../classes/Base.html#method__defDestroyFn">Base</a>:
3554
<a href="../files/base_js_Base.js.html#l325"><code>base/js/Base.js:325</code></a>
3564
<div class="description">
3565
<p>Default destroy event handler</p>
3569
<div class="params">
3570
<h4>Parameters:</h4>
3572
<ul class="params-list">
3576
<code class="param-name">e</code>
3577
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3582
<div class="param-description">
3599
<div id="method__defInitFn" class="method item protected inherited">
3600
<h3 class="name"><code>_defInitFn</code></h3>
3604
<span class="paren">(</span><ul class="args-list inline commas">
3612
</ul><span class="paren">)</span>
3621
<span class="flag protected">protected</span>
3634
<a href="../classes/Base.html#method__defInitFn">Base</a>:
3638
<a href="../files/base_js_Base.js.html#l313"><code>base/js/Base.js:313</code></a>
3648
<div class="description">
3649
<p>Default init event handler</p>
3653
<div class="params">
3654
<h4>Parameters:</h4>
3656
<ul class="params-list">
3660
<code class="param-name">e</code>
3661
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3666
<div class="param-description">
3667
<p>Event object, with a cfg property which
3668
refers to the configuration object passed to the constructor.</p>
3684
<div id="method__defNavigateFn" class="method item protected inherited">
3685
<h3 class="name"><code>_defNavigateFn</code></h3>
3689
<span class="paren">(</span><ul class="args-list inline commas">
3697
</ul><span class="paren">)</span>
3706
<span class="flag protected">protected</span>
3719
<a href="../classes/PjaxBase.html#method__defNavigateFn">PjaxBase</a>:
3723
<a href="../files/pjax_js_pjax-base.js.html#l392"><code>pjax/js/pjax-base.js:392</code></a>
3731
<p>Available since 3.5.0</p>
3735
<div class="description">
3736
<p>Default handler for the <code>navigate</code> event.</p>
3738
<p>Adds a new history entry or replaces the current entry for the specified URL
3739
and will scroll the page to the top if configured to do so.</p>
3743
<div class="params">
3744
<h4>Parameters:</h4>
3746
<ul class="params-list">
3750
<code class="param-name">e</code>
3751
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3756
<div class="param-description">
3773
<div id="method__defReadyFn" class="method item protected inherited">
3774
<h3 class="name"><code>_defReadyFn</code></h3>
3778
<span class="paren">(</span><ul class="args-list inline commas">
3786
</ul><span class="paren">)</span>
3795
<span class="flag protected">protected</span>
3808
<a href="../classes/Router.html#method__defReadyFn">Router</a>:
3812
<a href="../files/app_js_router.js.html#l971"><code>app/js/router.js:971</code></a>
3822
<div class="description">
3823
<p>Default handler for the <code>ready</code> event.</p>
3827
<div class="params">
3828
<h4>Parameters:</h4>
3830
<ul class="params-list">
3834
<code class="param-name">e</code>
3835
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3840
<div class="param-description">
3857
<div id="method__dequeue" class="method item protected inherited">
3858
<h3 class="name"><code>_dequeue</code></h3>
3861
<span class="paren">()</span>
3869
<span class="flag protected">protected</span>
3877
<span class="flag chainable">chainable</span>
3884
<a href="../classes/Router.html#method__dequeue">Router</a>:
3888
<a href="../files/app_js_router.js.html#l502"><code>app/js/router.js:502</code></a>
3898
<div class="description">
3899
<p>Shifts the topmost <code>_save()</code> call off the queue and executes it. Does
3900
nothing if the queue is empty.</p>
3911
<div id="method__destroyContainer" class="method item protected inherited">
3912
<h3 class="name"><code>_destroyContainer</code></h3>
3915
<span class="paren">()</span>
3923
<span class="flag protected">protected</span>
3935
<a href="../classes/View.html#method__destroyContainer">
3943
<a href="../files/app_js_app-base.js.html#l464"><code>app/js/app-base.js:464</code></a>
3953
<div class="description">
3954
<p>Overrides View's container destruction to deal with the <code>viewContainer</code> and
3955
checks to make sure not to remove and purge the <code><body></code>.</p>
3966
<div id="method__destroyHierarchy" class="method item private inherited">
3967
<h3 class="name"><code>_destroyHierarchy</code></h3>
3970
<span class="paren">()</span>
3978
<span class="flag private">private</span>
3991
<a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:
3995
<a href="../files/base_js_BaseCore.js.html#l559"><code>base/js/BaseCore.js:559</code></a>
4005
<div class="description">
4006
<p>Destroys the class hierarchy for this instance by invoking
4007
the destructor method on the prototype of each class in the hierarchy.</p>
4018
<div id="method__detachView" class="method item protected inherited">
4019
<h3 class="name"><code>_detachView</code></h3>
4023
<span class="paren">(</span><ul class="args-list inline commas">
4031
</ul><span class="paren">)</span>
4040
<span class="flag protected">protected</span>
4053
<a href="../classes/App.Base.html#method__detachView">App.Base</a>:
4057
<a href="../files/app_js_app-base.js.html#l501"><code>app/js/app-base.js:501</code></a>
4065
<p>Available since 3.5.0</p>
4069
<div class="description">
4070
<p>Helper method to detach the view instance from the application by removing
4071
the application as a bubble target of the view, and either just removing the
4072
view if it is intended to be preserved, or destroying the instance
4077
<div class="params">
4078
<h4>Parameters:</h4>
4080
<ul class="params-list">
4084
<code class="param-name">view</code>
4085
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
4090
<div class="param-description">
4091
<p>View to detach.</p>
4107
<div id="method__dispatch" class="method item protected inherited">
4108
<h3 class="name"><code>_dispatch</code></h3>
4112
<span class="paren">(</span><ul class="args-list inline commas">
4132
</ul><span class="paren">)</span>
4141
<span class="flag protected">protected</span>
4149
<span class="flag chainable">chainable</span>
4156
<a href="../classes/Router.html#method__dispatch">Router</a>:
4160
<a href="../files/app_js_router.js.html#l530"><code>app/js/router.js:530</code></a>
4170
<div class="description">
4171
<p>Dispatches to the first route handler that matches the specified <em>path</em>.</p>
4173
<p>If called before the <code>ready</code> event has fired, the dispatch will be aborted.
4174
This ensures normalized behavior between Chrome (which fires a <code>popstate</code>
4175
event on every pageview) and other browsers (which do not).</p>
4179
<div class="params">
4180
<h4>Parameters:</h4>
4182
<ul class="params-list">
4186
<code class="param-name">path</code>
4187
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4192
<div class="param-description">
4201
<code class="param-name">url</code>
4202
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4207
<div class="param-description">
4216
<code class="param-name">src</code>
4217
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4222
<div class="param-description">
4223
<p>What initiated the dispatch.</p>
4239
<div id="method__filterAdHocAttrs" class="method item private inherited">
4240
<h3 class="name"><code>_filterAdHocAttrs</code></h3>
4244
<span class="paren">(</span><ul class="args-list inline commas">
4248
<code>allAttrs</code>
4254
<code>userVals</code>
4258
</ul><span class="paren">)</span>
4263
<span class="returns-inline">
4264
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4271
<span class="flag private">private</span>
4284
<a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:
4288
<a href="../files/base_js_BaseCore.js.html#l342"><code>base/js/BaseCore.js:342</code></a>
4298
<div class="description">
4303
<div class="params">
4304
<h4>Parameters:</h4>
4306
<ul class="params-list">
4310
<code class="param-name">allAttrs</code>
4311
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4316
<div class="param-description">
4317
<p>The set of all attribute configurations for this instance.
4318
Attributes will be removed from this set, if they belong to the filtered class, so
4319
that by the time all classes are processed, allCfgs will be empty.</p>
4327
<code class="param-name">userVals</code>
4328
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4333
<div class="param-description">
4334
<p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>
4345
<div class="returns">
4348
<div class="returns-description">
4351
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4353
The set of adhoc attributes passed in, in the form
4354
of an object with attribute name/configuration pairs.
4364
<div id="method__filterAttrCfs" class="method item private inherited">
4365
<h3 class="name"><code>_filterAttrCfs</code></h3>
4369
<span class="paren">(</span><ul class="args-list inline commas">
4379
<code>allCfgs</code>
4383
</ul><span class="paren">)</span>
4388
<span class="returns-inline">
4389
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4396
<span class="flag private">private</span>
4409
<a href="../classes/BaseCore.html#method__filterAttrCfs">BaseCore</a>:
4413
<a href="../files/base_js_BaseCore.js.html#l310"><code>base/js/BaseCore.js:310</code></a>
4423
<div class="description">
4424
<p>A helper method used when processing ATTRS across the class hierarchy during
4425
initialization. Returns a disposable object with the attributes defined for
4426
the provided class, extracted from the set of all attributes passed in.</p>
4430
<div class="params">
4431
<h4>Parameters:</h4>
4433
<ul class="params-list">
4437
<code class="param-name">clazz</code>
4438
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
4443
<div class="param-description">
4444
<p>The class for which the desired attributes are required.</p>
4452
<code class="param-name">allCfgs</code>
4453
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4458
<div class="param-description">
4459
<p>The set of all attribute configurations for this instance.
4460
Attributes will be removed from this set, if they belong to the filtered class, so
4461
that by the time all classes are processed, allCfgs will be empty.</p>
4472
<div class="returns">
4475
<div class="returns-description">
4478
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4480
The set of attributes belonging to the class passed in, in the form
4481
of an object with attribute name/configuration pairs.
4491
<div id="method__fireAttrChange" class="method item private inherited">
4492
<h3 class="name"><code>_fireAttrChange</code></h3>
4496
<span class="paren">(</span><ul class="args-list inline commas">
4500
<code>attrName</code>
4506
<code>subAttrName</code>
4512
<code>currVal</code>
4528
</ul><span class="paren">)</span>
4537
<span class="flag private">private</span>
4550
<a href="../classes/AttributeEvents.html#method__fireAttrChange">AttributeEvents</a>:
4554
<a href="../files/attribute_js_AttributeEvents.js.html#l94"><code>attribute/js/AttributeEvents.js:94</code></a>
4564
<div class="description">
4565
<p>Utility method to help setup the event payload and fire the attribute change event.</p>
4569
<div class="params">
4570
<h4>Parameters:</h4>
4572
<ul class="params-list">
4576
<code class="param-name">attrName</code>
4577
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4582
<div class="param-description">
4583
<p>The name of the attribute</p>
4591
<code class="param-name">subAttrName</code>
4592
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4597
<div class="param-description">
4598
<p>The full path of the property being changed,
4599
if this is a sub-attribute value being change. Otherwise null.</p>
4607
<code class="param-name">currVal</code>
4608
<span class="type">Any</span>
4613
<div class="param-description">
4614
<p>The current value of the attribute</p>
4622
<code class="param-name">newVal</code>
4623
<span class="type">Any</span>
4628
<div class="param-description">
4629
<p>The new value of the attribute</p>
4637
<code class="param-name">opts</code>
4638
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4643
<div class="param-description">
4644
<p>Any additional event data to mix into the attribute change event's event facade.</p>
4660
<div id="method__getAttr" class="method item protected inherited">
4661
<h3 class="name"><code>_getAttr</code></h3>
4665
<span class="paren">(</span><ul class="args-list inline commas">
4673
</ul><span class="paren">)</span>
4678
<span class="returns-inline">
4679
<span class="type">Any</span>
4686
<span class="flag protected">protected</span>
4694
<span class="flag chainable">chainable</span>
4701
<a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:
4705
<a href="../files/attribute_js_AttributeCore.js.html#l468"><code>attribute/js/AttributeCore.js:468</code></a>
4715
<div class="description">
4716
<p>Provides the common implementation for the public get method,
4717
allowing Attribute hosts to over-ride either method.</p>
4719
<p>See <a href="#method_get">get</a> for argument details.</p>
4723
<div class="params">
4724
<h4>Parameters:</h4>
4726
<ul class="params-list">
4730
<code class="param-name">name</code>
4731
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4736
<div class="param-description">
4737
<p>The name of the attribute.</p>
4748
<div class="returns">
4751
<div class="returns-description">
4754
<span class="type">Any</span>:
4756
The value of the attribute.
4766
<div id="method__getAttrCfg" class="method item protected inherited">
4767
<h3 class="name"><code>_getAttrCfg</code></h3>
4771
<span class="paren">(</span><ul class="args-list inline commas">
4779
</ul><span class="paren">)</span>
4784
<span class="returns-inline">
4785
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4792
<span class="flag protected">protected</span>
4805
<a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:
4809
<a href="../files/attribute_js_AttributeExtras.js.html#l112"><code>attribute/js/AttributeExtras.js:112</code></a>
4819
<div class="description">
4820
<p>Returns an object with the configuration properties (and value)
4821
for the given attribute. If attrName is not provided, returns the
4822
configuration properties for all attributes.</p>
4826
<div class="params">
4827
<h4>Parameters:</h4>
4829
<ul class="params-list">
4833
<code class="param-name">name</code>
4834
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4839
<div class="param-description">
4840
<p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>
4851
<div class="returns">
4854
<div class="returns-description">
4857
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4859
The configuration properties for the given attribute, or all attributes.
4869
<div id="method__getAttrCfgs" class="method item protected inherited">
4870
<h3 class="name"><code>_getAttrCfgs</code></h3>
4873
<span class="paren">()</span>
4877
<span class="returns-inline">
4878
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4885
<span class="flag protected">protected</span>
4898
<a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:
4902
<a href="../files/base_js_BaseCore.js.html#l293"><code>base/js/BaseCore.js:293</code></a>
4912
<div class="description">
4913
<p>Returns an aggregated set of attribute configurations, by traversing
4914
the class hierarchy.</p>
4920
<div class="returns">
4923
<div class="returns-description">
4926
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4928
The hash of attribute configurations, aggregated across classes in the hierarchy
4929
This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
4940
<div id="method__getAttrInitVal" class="method item private inherited">
4941
<h3 class="name"><code>_getAttrInitVal</code></h3>
4945
<span class="paren">(</span><ul class="args-list inline commas">
4961
<code>initValues</code>
4965
</ul><span class="paren">)</span>
4970
<span class="returns-inline">
4971
<span class="type">Any</span>
4978
<span class="flag private">private</span>
4990
<a href="../classes/Attribute.html#method__getAttrInitVal">
4998
<a href="../files/attribute_js_AttributeCore.js.html#l823"><code>attribute/js/AttributeCore.js:823</code></a>
5008
<div class="description">
5009
<p>Returns the initial value of the given attribute from
5010
either the default configuration provided, or the
5011
over-ridden value if it exists in the set of initValues
5012
provided and the attribute is not read-only.</p>
5016
<div class="params">
5017
<h4>Parameters:</h4>
5019
<ul class="params-list">
5023
<code class="param-name">attr</code>
5024
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5029
<div class="param-description">
5030
<p>The name of the attribute</p>
5038
<code class="param-name">cfg</code>
5039
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5044
<div class="param-description">
5045
<p>The attribute configuration object</p>
5053
<code class="param-name">initValues</code>
5054
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5059
<div class="param-description">
5060
<p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>
5071
<div class="returns">
5074
<div class="returns-description">
5077
<span class="type">Any</span>:
5079
The initial value of the attribute.
5089
<div id="method__getAttrs" class="method item protected inherited">
5090
<h3 class="name"><code>_getAttrs</code></h3>
5094
<span class="paren">(</span><ul class="args-list inline commas">
5102
</ul><span class="paren">)</span>
5107
<span class="returns-inline">
5108
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5115
<span class="flag protected">protected</span>
5128
<a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:
5132
<a href="../files/attribute_js_AttributeCore.js.html#l677"><code>attribute/js/AttributeCore.js:677</code></a>
5142
<div class="description">
5143
<p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>
5147
<div class="params">
5148
<h4>Parameters:</h4>
5150
<ul class="params-list">
5154
<code class="param-name">attrs</code>
5155
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
5160
<div class="param-description">
5161
<p>Optional. An array of attribute names. If omitted, all attribute values are
5162
returned. If set to true, all attributes modified from their initial values are returned.</p>
5173
<div class="returns">
5176
<div class="returns-description">
5179
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
5181
An object with attribute name/value pairs.
5191
<div id="method__getClasses" class="method item protected inherited">
5192
<h3 class="name"><code>_getClasses</code></h3>
5195
<span class="paren">()</span>
5199
<span class="returns-inline">
5200
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>
5207
<span class="flag protected">protected</span>
5220
<a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:
5224
<a href="../files/base_js_BaseCore.js.html#l277"><code>base/js/BaseCore.js:277</code></a>
5234
<div class="description">
5235
<p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>
5241
<div class="returns">
5244
<div class="returns-description">
5247
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>:
5249
An array of classes (constructor functions), making up the class hierarchy for this object.
5250
This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
5261
<div id="method__getContainer" class="method item protected inherited">
5262
<h3 class="name"><code>_getContainer</code></h3>
5266
<span class="paren">(</span><ul class="args-list inline commas">
5274
</ul><span class="paren">)</span>
5279
<span class="returns-inline">
5280
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
5287
<span class="flag protected">protected</span>
5300
<a href="../classes/View.html#method__getContainer">View</a>:
5304
<a href="../files/app_js_view.js.html#l314"><code>app/js/view.js:314</code></a>
5312
<p>Available since 3.5.0</p>
5316
<div class="description">
5317
<p>Getter for the <code>container</code> attribute.</p>
5321
<div class="params">
5322
<h4>Parameters:</h4>
5324
<ul class="params-list">
5328
<code class="param-name">value</code>
5329
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span>
5334
<div class="param-description">
5335
<p>Current attribute value.</p>
5346
<div class="returns">
5349
<div class="returns-description">
5352
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
5364
<div id="method__getHashPath" class="method item protected inherited">
5365
<h3 class="name"><code>_getHashPath</code></h3>
5368
<span class="paren">()</span>
5372
<span class="returns-inline">
5373
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5380
<span class="flag protected">protected</span>
5393
<a href="../classes/Router.html#method__getHashPath">Router</a>:
5397
<a href="../files/app_js_router.js.html#l587"><code>app/js/router.js:587</code></a>
5407
<div class="description">
5408
<p>Gets the current path from the location hash, or an empty string if the
5415
<div class="returns">
5418
<div class="returns-description">
5421
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
5423
Current hash path, or an empty string if the hash is empty.
5433
<div id="method__getOrigin" class="method item protected inherited">
5434
<h3 class="name"><code>_getOrigin</code></h3>
5437
<span class="paren">()</span>
5441
<span class="returns-inline">
5442
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5449
<span class="flag protected">protected</span>
5462
<a href="../classes/Router.html#method__getOrigin">Router</a>:
5466
<a href="../files/app_js_router.js.html#l599"><code>app/js/router.js:599</code></a>
5476
<div class="description">
5477
<p>Gets the location origin (i.e., protocol, host, and port) as a URL.</p>
5483
<div class="returns">
5486
<div class="returns-description">
5489
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
5491
Location origin (i.e., protocol, host, and port).
5498
<div class="example">
5501
<div class="example-content">
5502
<pre class="code"><code class="prettyprint">http://example.com
5510
<div id="method__getPath" class="method item protected inherited">
5511
<h3 class="name"><code>_getPath</code></h3>
5514
<span class="paren">()</span>
5518
<span class="returns-inline">
5519
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5526
<span class="flag protected">protected</span>
5539
<a href="../classes/Router.html#method__getPath">Router</a>:
5543
<a href="../files/app_js_router.js.html#l614"><code>app/js/router.js:614</code></a>
5553
<div class="description">
5554
<p>Gets the current route path, relative to the <code>root</code> (if any).</p>
5560
<div class="returns">
5563
<div class="returns-description">
5566
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
5578
<div id="method__getQuery" class="method item protected inherited">
5579
<h3 class="name"><code>_getQuery</code></h3>
5582
<span class="paren">()</span>
5586
<span class="returns-inline">
5587
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5594
<span class="flag protected">protected</span>
5607
<a href="../classes/Router.html#method__getQuery">Router</a>:
5611
<a href="../files/app_js_router.js.html#l628"><code>app/js/router.js:628</code></a>
5621
<div class="description">
5622
<p>Gets the current route query string.</p>
5628
<div class="returns">
5631
<div class="returns-description">
5634
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
5636
Current route query string.
5646
<div id="method__getRegex" class="method item protected inherited">
5647
<h3 class="name"><code>_getRegex</code></h3>
5651
<span class="paren">(</span><ul class="args-list inline commas">
5665
</ul><span class="paren">)</span>
5670
<span class="returns-inline">
5671
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
5678
<span class="flag protected">protected</span>
5691
<a href="../classes/Router.html#method__getRegex">Router</a>:
5695
<a href="../files/app_js_router.js.html#l649"><code>app/js/router.js:649</code></a>
5705
<div class="description">
5706
<p>Creates a regular expression from the given route specification. If <em>path</em>
5707
is already a regex, it will be returned unmodified.</p>
5711
<div class="params">
5712
<h4>Parameters:</h4>
5714
<ul class="params-list">
5718
<code class="param-name">path</code>
5719
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
5724
<div class="param-description">
5725
<p>Route path specification.</p>
5733
<code class="param-name">keys</code>
5734
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
5739
<div class="param-description">
5740
<p>Array reference to which route parameter names will be
5752
<div class="returns">
5755
<div class="returns-description">
5758
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>:
5770
<div id="method__getRequest" class="method item protected inherited">
5771
<h3 class="name"><code>_getRequest</code></h3>
5775
<span class="paren">(</span><ul class="args-list inline commas">
5795
</ul><span class="paren">)</span>
5800
<span class="returns-inline">
5801
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5808
<span class="flag protected">protected</span>
5821
<a href="../classes/Router.html#method__getRequest">Router</a>:
5825
<a href="../files/app_js_router.js.html#l684"><code>app/js/router.js:684</code></a>
5835
<div class="description">
5836
<p>Gets a request object that can be passed to a route handler.</p>
5840
<div class="params">
5841
<h4>Parameters:</h4>
5843
<ul class="params-list">
5847
<code class="param-name">path</code>
5848
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5853
<div class="param-description">
5854
<p>Current path being dispatched.</p>
5862
<code class="param-name">url</code>
5863
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5868
<div class="param-description">
5869
<p>Current full URL being dispatched.</p>
5877
<code class="param-name">src</code>
5878
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5883
<div class="param-description">
5884
<p>What initiated the dispatch.</p>
5895
<div class="returns">
5898
<div class="returns-description">
5901
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
5913
<div id="method__getResponse" class="method item protected inherited">
5914
<h3 class="name"><code>_getResponse</code></h3>
5918
<span class="paren">(</span><ul class="args-list inline commas">
5926
</ul><span class="paren">)</span>
5931
<span class="returns-inline">
5932
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5939
<span class="flag protected">protected</span>
5952
<a href="../classes/Router.html#method__getResponse">Router</a>:
5956
<a href="../files/app_js_router.js.html#l703"><code>app/js/router.js:703</code></a>
5966
<div class="description">
5967
<p>Gets a response object that can be passed to a route handler.</p>
5971
<div class="params">
5972
<h4>Parameters:</h4>
5974
<ul class="params-list">
5978
<code class="param-name">req</code>
5979
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5984
<div class="param-description">
5985
<p>Request object.</p>
5996
<div class="returns">
5999
<div class="returns-description">
6002
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
6014
<div id="method__getRoot" class="method item protected inherited">
6015
<h3 class="name"><code>_getRoot</code></h3>
6018
<span class="paren">()</span>
6022
<span class="returns-inline">
6023
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6030
<span class="flag protected">protected</span>
6043
<a href="../classes/PjaxBase.html#method__getRoot">PjaxBase</a>:
6047
<a href="../files/pjax_js_pjax-base.js.html#l161"><code>pjax/js/pjax-base.js:161</code></a>
6055
<p>Available since 3.5.0</p>
6059
<div class="description">
6060
<p>Returns the current path root after popping off the last path segment,
6061
making it useful for resolving other URL paths against.</p>
6063
<p>The path root will always begin and end with a '/'.</p>
6069
<div class="returns">
6072
<div class="returns-description">
6075
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
6077
The URL's path root.
6087
<div id="method__getRoutes" class="method item protected inherited">
6088
<h3 class="name"><code>_getRoutes</code></h3>
6091
<span class="paren">()</span>
6095
<span class="returns-inline">
6096
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
6103
<span class="flag protected">protected</span>
6116
<a href="../classes/Router.html#method__getRoutes">Router</a>:
6120
<a href="../files/app_js_router.js.html#l722"><code>app/js/router.js:722</code></a>
6130
<div class="description">
6131
<p>Getter for the <code>routes</code> attribute.</p>
6137
<div class="returns">
6140
<div class="returns-description">
6143
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
6145
Array of route objects.
6155
<div id="method__getStateVal" class="method item private inherited">
6156
<h3 class="name"><code>_getStateVal</code></h3>
6160
<span class="paren">(</span><ul class="args-list inline commas">
6168
</ul><span class="paren">)</span>
6173
<span class="returns-inline">
6174
<span class="type">Any</span>
6181
<span class="flag private">private</span>
6194
<a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:
6198
<a href="../files/attribute_js_AttributeCore.js.html#l522"><code>attribute/js/AttributeCore.js:522</code></a>
6208
<div class="description">
6209
<p>Gets the stored value for the attribute, from either the
6210
internal state object, or the state proxy if it exits</p>
6214
<div class="params">
6215
<h4>Parameters:</h4>
6217
<ul class="params-list">
6221
<code class="param-name">name</code>
6222
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6227
<div class="param-description">
6228
<p>The name of the attribute</p>
6239
<div class="returns">
6242
<div class="returns-description">
6245
<span class="type">Any</span>:
6247
The stored value of the attribute
6257
<div id="method__getType" class="method item private inherited">
6258
<h3 class="name"><code>_getType</code></h3>
6261
<span class="paren">()</span>
6269
<span class="flag private">private</span>
6282
<a href="../classes/EventTarget.html#method__getType">EventTarget</a>:
6286
<a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>
6296
<div class="description">
6297
<p>If the instance has a prefix attribute and the
6298
event type is not prefixed, the instance prefix is
6299
applied to the supplied type.</p>
6310
<div id="method__getURL" class="method item protected inherited">
6311
<h3 class="name"><code>_getURL</code></h3>
6314
<span class="paren">()</span>
6318
<span class="returns-inline">
6319
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6326
<span class="flag protected">protected</span>
6338
<a href="../classes/Router.html#method__getURL">
6346
<a href="../files/app_js_app-base.js.html#l567"><code>app/js/app-base.js:567</code></a>
6356
<div class="description">
6357
<p>Gets the current full URL. When <code>html5</code> is false, the URL will first be
6358
upgraded before it's returned.</p>
6364
<div class="returns">
6367
<div class="returns-description">
6370
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
6382
<div id="method__getViewContainer" class="method item protected inherited">
6383
<h3 class="name"><code>_getViewContainer</code></h3>
6387
<span class="paren">(</span><ul class="args-list inline commas">
6395
</ul><span class="paren">)</span>
6400
<span class="returns-inline">
6401
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
6408
<span class="flag protected">protected</span>
6421
<a href="../classes/App.Base.html#method__getViewContainer">App.Base</a>:
6425
<a href="../files/app_js_app-base.js.html#l542"><code>app/js/app-base.js:542</code></a>
6433
<p>Available since 3.5.0</p>
6437
<div class="description">
6438
<p>Getter for the <code>viewContainer</code> attribute.</p>
6442
<div class="params">
6443
<h4>Parameters:</h4>
6445
<ul class="params-list">
6449
<code class="param-name">value</code>
6450
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span>
6455
<div class="param-description">
6456
<p>Current attribute value.</p>
6467
<div class="returns">
6470
<div class="returns-description">
6473
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
6475
View container node.
6485
<div id="method__hasSameOrigin" class="method item protected inherited">
6486
<h3 class="name"><code>_hasSameOrigin</code></h3>
6490
<span class="paren">(</span><ul class="args-list inline commas">
6498
</ul><span class="paren">)</span>
6503
<span class="returns-inline">
6504
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
6511
<span class="flag protected">protected</span>
6524
<a href="../classes/Router.html#method__hasSameOrigin">Router</a>:
6528
<a href="../files/app_js_router.js.html#l744"><code>app/js/router.js:744</code></a>
6538
<div class="description">
6539
<p>Returns <code>true</code> when the specified <code>url</code> is from the same origin as the
6540
current URL; i.e., the protocol, host, and port of the URLs are the same.</p>
6542
<p>All host or path relative URLs are of the same origin. A scheme-relative URL
6543
is first prefixed with the current scheme before being evaluated.</p>
6547
<div class="params">
6548
<h4>Parameters:</h4>
6550
<ul class="params-list">
6554
<code class="param-name">url</code>
6555
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6560
<div class="param-description">
6561
<p>URL to compare origin with the current URL.</p>
6572
<div class="returns">
6575
<div class="returns-description">
6578
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
6580
Whether the URL has the same origin of the current URL.
6590
<div id="method__initAttrHost" class="method item private inherited">
6591
<h3 class="name"><code>_initAttrHost</code></h3>
6595
<span class="paren">(</span><ul class="args-list inline commas">
6615
</ul><span class="paren">)</span>
6624
<span class="flag private">private</span>
6637
<a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:
6641
<a href="../files/attribute_js_AttributeCore.js.html#l109"><code>attribute/js/AttributeCore.js:109</code></a>
6651
<div class="description">
6652
<p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the
6657
<div class="params">
6658
<h4>Parameters:</h4>
6660
<ul class="params-list">
6664
<code class="param-name">attrs</code>
6665
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6670
<div class="param-description">
6671
<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>
6679
<code class="param-name">values</code>
6680
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6685
<div class="param-description">
6686
<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>
6694
<code class="param-name">lazy</code>
6695
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
6700
<div class="param-description">
6701
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
6717
<div id="method__initAttribute" class="method item private inherited">
6718
<h3 class="name"><code>_initAttribute</code></h3>
6721
<span class="paren">()</span>
6729
<span class="flag private">private</span>
6741
<a href="../classes/BaseCore.html#method__initAttribute">
6749
<a href="../files/base_js_Base.js.html#l169"><code>base/js/Base.js:169</code></a>
6759
<div class="description">
6760
<p>Initializes Attribute</p>
6771
<div id="method__initAttrs" class="method item protected inherited">
6772
<h3 class="name"><code>_initAttrs</code></h3>
6776
<span class="paren">(</span><ul class="args-list inline commas">
6796
</ul><span class="paren">)</span>
6805
<span class="flag protected">protected</span>
6818
<a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:
6822
<a href="../files/attribute_js_AttributeCore.js.html#l862"><code>attribute/js/AttributeCore.js:862</code></a>
6832
<div class="description">
6833
<p>Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.</p>
6837
<div class="params">
6838
<h4>Parameters:</h4>
6840
<ul class="params-list">
6844
<code class="param-name">attrs</code>
6845
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6850
<div class="param-description">
6851
<p>The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.</p>
6859
<code class="param-name">values</code>
6860
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6865
<div class="param-description">
6866
<p>The initial attribute values to apply (passed through to <a href="#method_addAttrs">addAttrs</a>). These are not merged/cloned. The caller is responsible for isolating user provided values if required.</p>
6874
<code class="param-name">lazy</code>
6875
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
6880
<div class="param-description">
6881
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
6897
<div id="method__initBase" class="method item private inherited">
6898
<h3 class="name"><code>_initBase</code></h3>
6902
<span class="paren">(</span><ul class="args-list inline commas">
6910
</ul><span class="paren">)</span>
6919
<span class="flag private">private</span>
6931
<a href="../classes/BaseCore.html#method__initBase">
6939
<a href="../files/base_js_Base.js.html#l154"><code>base/js/Base.js:154</code></a>
6949
<div class="description">
6950
<p>Internal construction logic for Base.</p>
6954
<div class="params">
6955
<h4>Parameters:</h4>
6957
<ul class="params-list">
6961
<code class="param-name">config</code>
6962
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6967
<div class="param-description">
6968
<p>The constructor configuration object</p>
6984
<div id="method__initHierarchy" class="method item private inherited">
6985
<h3 class="name"><code>_initHierarchy</code></h3>
6989
<span class="paren">(</span><ul class="args-list inline commas">
6993
<code>userVals</code>
6997
</ul><span class="paren">)</span>
7006
<span class="flag private">private</span>
7019
<a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:
7023
<a href="../files/base_js_BaseCore.js.html#l501"><code>base/js/BaseCore.js:501</code></a>
7033
<div class="description">
7034
<p>Initializes the class hierarchy for the instance, which includes
7035
initializing attributes for each class defined in the class's
7036
static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
7037
invoking the initializer method on the prototype of each class in the hierarchy.</p>
7041
<div class="params">
7042
<h4>Parameters:</h4>
7044
<ul class="params-list">
7048
<code class="param-name">userVals</code>
7049
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7054
<div class="param-description">
7055
<p>Object with configuration property name/value pairs</p>
7071
<div id="method__initHierarchyData" class="method item private inherited">
7072
<h3 class="name"><code>_initHierarchyData</code></h3>
7075
<span class="paren">()</span>
7083
<span class="flag private">private</span>
7096
<a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:
7100
<a href="../files/base_js_BaseCore.js.html#l372"><code>base/js/BaseCore.js:372</code></a>
7110
<div class="description">
7111
<p>A helper method used by _getClasses and _getAttrCfgs, which determines both
7112
the array of classes and aggregate set of attribute configurations
7113
across the class hierarchy for the instance.</p>
7124
<div id="method__initHtml5" class="method item protected inherited">
7125
<h3 class="name"><code>_initHtml5</code></h3>
7128
<span class="paren">()</span>
7132
<span class="returns-inline">
7133
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7140
<span class="flag protected">protected</span>
7153
<a href="../classes/App.Base.html#method__initHtml5">App.Base</a>:
7157
<a href="../files/app_js_app-base.js.html#l581"><code>app/js/app-base.js:581</code></a>
7165
<p>Available since 3.5.0</p>
7169
<div class="description">
7170
<p>Provides the default value for the <code>html5</code> attribute.</p>
7172
<p>The value returned is dependent on the value of the <code>serverRouting</code>
7173
attribute. When <code>serverRouting</code> is explicit set to <code>false</code> (not just falsy),
7174
the default value for <code>html5</code> will be set to <code>false</code> for <em>all</em> browsers.</p>
7176
<p>When <code>serverRouting</code> is <code>true</code> or <code>undefined</code> the returned value will be
7177
dependent on the browser's capability of using HTML5 history.</p>
7183
<div class="returns">
7186
<div class="returns-description">
7189
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
7191
Whether or not HTML5 history should be used.
7201
<div id="method__isChildView" class="method item protected inherited">
7202
<h3 class="name"><code>_isChildView</code></h3>
7206
<span class="paren">(</span><ul class="args-list inline commas">
7220
</ul><span class="paren">)</span>
7225
<span class="returns-inline">
7226
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7233
<span class="flag protected">protected</span>
7246
<a href="../classes/App.Base.html#method__isChildView">App.Base</a>:
7250
<a href="../files/app_js_app-base.js.html#l606"><code>app/js/app-base.js:606</code></a>
7258
<p>Available since 3.5.0</p>
7262
<div class="description">
7263
<p>Determines if the specified <code>view</code> is configured as a child of the specified
7264
<code>parent</code> view. This requires both views to be either named-views, or view
7265
instances created using configuration data that exists in the <code>views</code>
7266
object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p>
7270
<div class="params">
7271
<h4>Parameters:</h4>
7273
<ul class="params-list">
7277
<code class="param-name">view</code>
7278
<span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7283
<div class="param-description">
7284
<p>The name of a view defined in the <code>views</code> object,
7285
or a view instance.</p>
7293
<code class="param-name">parent</code>
7294
<span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7299
<div class="param-description">
7300
<p>The name of a view defined in the <code>views</code>
7301
object, or a view instance.</p>
7312
<div class="returns">
7315
<div class="returns-description">
7318
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
7320
Whether the view is configured as a child of the parent.
7330
<div id="method__isLazyAttr" class="method item private inherited">
7331
<h3 class="name"><code>_isLazyAttr</code></h3>
7335
<span class="paren">(</span><ul class="args-list inline commas">
7343
</ul><span class="paren">)</span>
7348
<span class="returns-inline">
7349
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7356
<span class="flag private">private</span>
7369
<a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:
7373
<a href="../files/attribute_js_AttributeCore.js.html#l299"><code>attribute/js/AttributeCore.js:299</code></a>
7383
<div class="description">
7384
<p>Checks whether or not the attribute is one which has been
7385
added lazily and still requires initialization.</p>
7389
<div class="params">
7390
<h4>Parameters:</h4>
7392
<ul class="params-list">
7396
<code class="param-name">name</code>
7397
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7402
<div class="param-description">
7403
<p>The name of the attribute</p>
7414
<div class="returns">
7417
<div class="returns-description">
7420
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
7422
true if it's a lazily added attribute, false otherwise.
7432
<div id="method__isParentView" class="method item protected inherited">
7433
<h3 class="name"><code>_isParentView</code></h3>
7437
<span class="paren">(</span><ul class="args-list inline commas">
7451
</ul><span class="paren">)</span>
7456
<span class="returns-inline">
7457
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7464
<span class="flag protected">protected</span>
7477
<a href="../classes/App.Base.html#method__isParentView">App.Base</a>:
7481
<a href="../files/app_js_app-base.js.html#l632"><code>app/js/app-base.js:632</code></a>
7489
<p>Available since 3.5.0</p>
7493
<div class="description">
7494
<p>Determines if the specified <code>view</code> is configured as the parent of the
7495
specified <code>child</code> view. This requires both views to be either named-views,
7496
or view instances created using configuration data that exists in the
7497
<code>views</code> object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p>
7501
<div class="params">
7502
<h4>Parameters:</h4>
7504
<ul class="params-list">
7508
<code class="param-name">view</code>
7509
<span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7514
<div class="param-description">
7515
<p>The name of a view defined in the <code>views</code> object,
7516
or a view instance.</p>
7524
<code class="param-name">parent</code>
7525
<span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7530
<div class="param-description">
7531
<p>The name of a view defined in the <code>views</code>
7532
object, or a view instance.</p>
7543
<div class="returns">
7546
<div class="returns-description">
7549
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
7551
Whether the view is configured as the parent of the child.
7561
<div id="method__joinURL" class="method item protected inherited">
7562
<h3 class="name"><code>_joinURL</code></h3>
7566
<span class="paren">(</span><ul class="args-list inline commas">
7574
</ul><span class="paren">)</span>
7579
<span class="returns-inline">
7580
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7587
<span class="flag protected">protected</span>
7600
<a href="../classes/Router.html#method__joinURL">Router</a>:
7604
<a href="../files/app_js_router.js.html#l767"><code>app/js/router.js:767</code></a>
7614
<div class="description">
7615
<p>Joins the <code>root</code> URL to the specified <em>url</em>, normalizing leading/trailing
7616
<code>/</code> characters.</p>
7620
<div class="params">
7621
<h4>Parameters:</h4>
7623
<ul class="params-list">
7627
<code class="param-name">url</code>
7628
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7633
<div class="param-description">
7634
<p>URL to append to the <code>root</code> URL.</p>
7645
<div class="returns">
7648
<div class="returns-description">
7651
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
7660
<div class="example">
7663
<div class="example-content">
7664
<pre class="code"><code class="prettyprint">router.set('root', '/foo');
7665
router._joinURL('bar'); // => '/foo/bar'
7666
router._joinURL('/bar'); // => '/foo/bar'
7668
router.set('root', '/foo/');
7669
router._joinURL('bar'); // => '/foo/bar'
7670
router._joinURL('/bar'); // => '/foo/bar'
7678
<div id="method__monitor" class="method item private inherited">
7679
<h3 class="name"><code>_monitor</code></h3>
7683
<span class="paren">(</span><ul class="args-list inline commas">
7703
</ul><span class="paren">)</span>
7712
<span class="flag private">private</span>
7725
<a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:
7729
<a href="../files/event-custom_js_event-target.js.html#l602"><code>event-custom/js/event-target.js:602</code></a>
7739
<div class="description">
7740
<p>This is the entry point for the event monitoring system.
7741
You can monitor 'attach', 'detach', 'fire', and 'publish'.
7742
When configured, these events generate an event. click ->
7743
click<em>attach, click</em>detach, click_publish -- these can
7744
be subscribed to like other events to monitor the event
7745
system. Inividual published events can have monitoring
7746
turned on or off (publish can't be turned off before it
7747
it published) by setting the events 'monitor' config.</p>
7751
<div class="params">
7752
<h4>Parameters:</h4>
7754
<ul class="params-list">
7758
<code class="param-name">what</code>
7759
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7764
<div class="param-description">
7765
<p>'attach', 'detach', 'fire', or 'publish'</p>
7773
<code class="param-name">type</code>
7774
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7779
<div class="param-description">
7780
<p>Name of the event being monitored</p>
7788
<code class="param-name">o</code>
7789
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7794
<div class="param-description">
7795
<p>Information about the event interaction, such as
7796
fire() args, subscription category, publish config</p>
7812
<div id="method__navigate" class="method item protected inherited">
7813
<h3 class="name"><code>_navigate</code></h3>
7817
<span class="paren">(</span><ul class="args-list inline commas">
7827
<code class="optional">[options]</code>
7831
</ul><span class="paren">)</span>
7840
<span class="flag protected">protected</span>
7852
<a href="../classes/PjaxBase.html#method__navigate">
7860
<a href="../files/app_js_app-base.js.html#l658"><code>app/js/app-base.js:658</code></a>
7870
<div class="description">
7871
<p>Underlying implementation for <code>navigate()</code>.</p>
7875
<div class="params">
7876
<h4>Parameters:</h4>
7878
<ul class="params-list">
7882
<code class="param-name">url</code>
7883
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7888
<div class="param-description">
7889
<p>The fully-resolved URL that the app should dispatch to
7890
its route handlers to fulfill the enhanced navigation "request", or use to
7891
update <code>window.location</code> in non-HTML5 history capable browsers when
7892
<code>serverRouting</code> is <code>true</code>.</p>
7900
<code class="param-name optional">[options]</code>
7901
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7902
<span class="flag optional" title="This parameter is optional.">optional</span>
7907
<div class="param-description">
7908
<p>Additional options to configure the navigation.
7909
These are mixed into the <code>navigate</code> event facade.</p>
7913
<ul class="params-list">
7917
<code class="param-name optional">[replace]</code>
7918
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7919
<span class="flag optional" title="This parameter is optional.">optional</span>
7922
<div class="param-description">
7923
<p>Whether or not the current history
7924
entry will be replaced, or a new entry will be created. Will default
7925
to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>
7933
<code class="param-name optional">[force]</code>
7934
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7935
<span class="flag optional" title="This parameter is optional.">optional</span>
7938
<div class="param-description">
7939
<p>Whether the enhanced navigation
7940
should occur even in browsers without HTML5 history. Will default to
7941
<code>true</code> when <code>serverRouting</code> is falsy.</p>
7961
<div id="method__normalizePath" class="method item protected inherited">
7962
<h3 class="name"><code>_normalizePath</code></h3>
7966
<span class="paren">(</span><ul class="args-list inline commas">
7974
</ul><span class="paren">)</span>
7979
<span class="returns-inline">
7980
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7987
<span class="flag protected">protected</span>
8000
<a href="../classes/PjaxBase.html#method__normalizePath">PjaxBase</a>:
8004
<a href="../files/pjax_js_pjax-base.js.html#l254"><code>pjax/js/pjax-base.js:254</code></a>
8012
<p>Available since 3.5.0</p>
8016
<div class="description">
8017
<p>Returns a normalized path, ridding it of any '..' segments and properly
8018
handling leading and trailing slashes.</p>
8022
<div class="params">
8023
<h4>Parameters:</h4>
8025
<ul class="params-list">
8029
<code class="param-name">path</code>
8030
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8035
<div class="param-description">
8036
<p>URL path to normalize.</p>
8047
<div class="returns">
8050
<div class="returns-description">
8053
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
8065
<div id="method__normAttrVals" class="method item private inherited">
8066
<h3 class="name"><code>_normAttrVals</code></h3>
8070
<span class="paren">(</span><ul class="args-list inline commas">
8074
<code>valueHash</code>
8078
</ul><span class="paren">)</span>
8083
<span class="returns-inline">
8084
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8091
<span class="flag private">private</span>
8103
<a href="../classes/Attribute.html#method__normAttrVals">
8111
<a href="../files/attribute_js_AttributeCore.js.html#l808"><code>attribute/js/AttributeCore.js:808</code></a>
8121
<div class="description">
8122
<p>Utility method to normalize attribute values. The base implementation
8123
simply merges the hash to protect the original.</p>
8127
<div class="params">
8128
<h4>Parameters:</h4>
8130
<ul class="params-list">
8134
<code class="param-name">valueHash</code>
8135
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8140
<div class="param-description">
8141
<p>An object with attribute name/value pairs</p>
8152
<div class="returns">
8155
<div class="returns-description">
8158
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
8169
<div id="method__onLinkClick" class="method item protected inherited">
8170
<h3 class="name"><code>_onLinkClick</code></h3>
8174
<span class="paren">(</span><ul class="args-list inline commas">
8182
</ul><span class="paren">)</span>
8191
<span class="flag protected">protected</span>
8204
<a href="../classes/PjaxBase.html#method__onLinkClick">PjaxBase</a>:
8208
<a href="../files/pjax_js_pjax-base.js.html#l417"><code>pjax/js/pjax-base.js:417</code></a>
8216
<p>Available since 3.5.0</p>
8220
<div class="description">
8221
<p>Handler for delegated link-click events which match the <code>linkSelector</code>.</p>
8223
<p>This will attempt to enhance the navigation to the link element's <code>href</code> by
8224
passing the URL to the <code>_navigate()</code> method. When the navigation is being
8225
enhanced, the default action is prevented.</p>
8227
<p>If the user clicks a link with the middle/right mouse buttons, or is holding
8228
down the Ctrl or Command keys, this method's behavior is not applied and
8229
allows the native behavior to occur. Similarly, if the router is not capable
8230
or handling the URL because no route-handlers match, the link click will
8231
behave natively.</p>
8235
<div class="params">
8236
<h4>Parameters:</h4>
8238
<ul class="params-list">
8242
<code class="param-name">e</code>
8243
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
8248
<div class="param-description">
8265
<div id="method__parseQuery" class="method item protected inherited">
8266
<h3 class="name"><code>_parseQuery</code></h3>
8270
<span class="paren">(</span><ul class="args-list inline commas">
8278
</ul><span class="paren">)</span>
8283
<span class="returns-inline">
8284
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8291
<span class="flag protected">protected</span>
8304
<a href="../classes/Router.html#method__parseQuery">Router</a>:
8308
<a href="../files/app_js_router.js.html#l799"><code>app/js/router.js:799</code></a>
8318
<div class="description">
8319
<p>Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is
8320
available, this method will be an alias to that.</p>
8324
<div class="params">
8325
<h4>Parameters:</h4>
8327
<ul class="params-list">
8331
<code class="param-name">query</code>
8332
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8337
<div class="param-description">
8338
<p>Query string to parse.</p>
8349
<div class="returns">
8352
<div class="returns-description">
8355
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
8357
Hash of key/value pairs for query parameters.
8367
<div id="method__parseType" class="method item private inherited">
8368
<h3 class="name"><code>_parseType</code></h3>
8371
<span class="paren">()</span>
8379
<span class="flag private">private</span>
8392
<a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:
8396
<a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>
8406
<div class="description">
8407
<p>Returns an array with the detach key (if provided),
8408
and the prefixed event name from _getType
8409
Y.on('detachcategory| menu:click', fn)</p>
8420
<div id="method__pjaxBindUI" class="method item protected inherited">
8421
<h3 class="name"><code>_pjaxBindUI</code></h3>
8424
<span class="paren">()</span>
8432
<span class="flag protected">protected</span>
8445
<a href="../classes/PjaxBase.html#method__pjaxBindUI">PjaxBase</a>:
8449
<a href="../files/pjax_js_pjax-base.js.html#l296"><code>pjax/js/pjax-base.js:296</code></a>
8457
<p>Available since 3.5.0</p>
8461
<div class="description">
8462
<p>Binds the delegation of link-click events that match the <code>linkSelector</code> to
8463
the <code>_onLinkClick()</code> handler.</p>
8465
<p>By default this method will only be called if the browser is capable of
8466
using HTML5 history.</p>
8477
<div id="method__preInitEventCfg" class="method item private inherited">
8478
<h3 class="name"><code>_preInitEventCfg</code></h3>
8482
<span class="paren">(</span><ul class="args-list inline commas">
8490
</ul><span class="paren">)</span>
8499
<span class="flag private">private</span>
8512
<a href="../classes/Base.html#method__preInitEventCfg">Base</a>:
8516
<a href="../files/base_js_Base.js.html#l233"><code>base/js/Base.js:233</code></a>
8526
<div class="description">
8527
<p>Handles the special on, after and target properties which allow the user to
8528
easily configure on and after listeners as well as bubble targets during
8529
construction, prior to init.</p>
8533
<div class="params">
8534
<h4>Parameters:</h4>
8536
<ul class="params-list">
8540
<code class="param-name">config</code>
8541
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8546
<div class="param-description">
8547
<p>The user configuration object</p>
8563
<div id="method__protectAttrs" class="method item protected inherited">
8564
<h3 class="name"><code>_protectAttrs</code></h3>
8568
<span class="paren">(</span><ul class="args-list inline commas">
8576
</ul><span class="paren">)</span>
8581
<span class="returns-inline">
8582
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8589
<span class="flag protected">protected</span>
8602
<a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:
8606
<a href="../files/attribute_js_AttributeCore.js.html#l786"><code>attribute/js/AttributeCore.js:786</code></a>
8616
<div class="description">
8617
<p>Utility method to protect an attribute configuration
8618
hash, by merging the entire object and the individual
8619
attr config objects.</p>
8623
<div class="params">
8624
<h4>Parameters:</h4>
8626
<ul class="params-list">
8630
<code class="param-name">attrs</code>
8631
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8636
<div class="param-description">
8637
<p>A hash of attribute to configuration object pairs.</p>
8648
<div class="returns">
8651
<div class="returns-description">
8654
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
8656
A protected version of the attrs argument.
8666
<div id="method__queue" class="method item protected inherited">
8667
<h3 class="name"><code>_queue</code></h3>
8670
<span class="paren">()</span>
8678
<span class="flag protected">protected</span>
8686
<span class="flag chainable">chainable</span>
8693
<a href="../classes/Router.html#method__queue">Router</a>:
8697
<a href="../files/app_js_router.js.html#l827"><code>app/js/router.js:827</code></a>
8707
<div class="description">
8708
<p>Queues up a <code>_save()</code> call to run after all previously-queued calls have
8711
<p>This is necessary because if we make multiple <code>_save()</code> calls before the
8712
first call gets dispatched, then both calls will dispatch to the last call's
8715
<p>All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the
8716
queued function is executed.</p>
8727
<div id="method__resolvePath" class="method item protected inherited">
8728
<h3 class="name"><code>_resolvePath</code></h3>
8732
<span class="paren">(</span><ul class="args-list inline commas">
8740
</ul><span class="paren">)</span>
8745
<span class="returns-inline">
8746
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8753
<span class="flag protected">protected</span>
8766
<a href="../classes/PjaxBase.html#method__resolvePath">PjaxBase</a>:
8770
<a href="../files/pjax_js_pjax-base.js.html#l315"><code>pjax/js/pjax-base.js:315</code></a>
8778
<p>Available since 3.5.0</p>
8782
<div class="description">
8783
<p>Returns the normalized result of resolving the <code>path</code> against the current
8784
path. Falsy values for <code>path</code> will return just the current path.</p>
8788
<div class="params">
8789
<h4>Parameters:</h4>
8791
<ul class="params-list">
8795
<code class="param-name">path</code>
8796
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8801
<div class="param-description">
8802
<p>URL path to resolve.</p>
8813
<div class="returns">
8816
<div class="returns-description">
8819
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
8831
<div id="method__resolveURL" class="method item protected inherited">
8832
<h3 class="name"><code>_resolveURL</code></h3>
8836
<span class="paren">(</span><ul class="args-list inline commas">
8844
</ul><span class="paren">)</span>
8849
<span class="returns-inline">
8850
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8857
<span class="flag protected">protected</span>
8870
<a href="../classes/PjaxBase.html#method__resolveURL">PjaxBase</a>:
8874
<a href="../files/pjax_js_pjax-base.js.html#l339"><code>pjax/js/pjax-base.js:339</code></a>
8882
<p>Available since 3.5.0</p>
8886
<div class="description">
8887
<p>Resolves the specified URL against the current URL.</p>
8889
<p>This method resolves URLs like a browser does and will always return an
8890
absolute URL. When the specified URL is already absolute, it is assumed to
8891
be fully resolved and is simply returned as is. Scheme-relative URLs are
8892
prefixed with the current protocol. Relative URLs are giving the current
8893
URL's origin and are resolved and normalized against the current path root.</p>
8897
<div class="params">
8898
<h4>Parameters:</h4>
8900
<ul class="params-list">
8904
<code class="param-name">url</code>
8905
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8910
<div class="param-description">
8911
<p>URL to resolve.</p>
8922
<div class="returns">
8925
<div class="returns-description">
8928
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
8940
<div id="method__save" class="method item protected inherited">
8941
<h3 class="name"><code>_save</code></h3>
8945
<span class="paren">(</span><ul class="args-list inline commas">
8949
<code class="optional">[url]</code>
8955
<code class="optional">[replace=false]</code>
8959
</ul><span class="paren">)</span>
8968
<span class="flag protected">protected</span>
8976
<span class="flag chainable">chainable</span>
8982
<a href="../classes/Router.html#method__save">
8990
<a href="../files/app_js_app-base.js.html#l692"><code>app/js/app-base.js:692</code></a>
9000
<div class="description">
9001
<p>Will either save a history entry using <code>pushState()</code> or the location hash,
9002
or gracefully-degrade to sending a request to the server causing a full-page
9005
<p>Overrides Router's <code>_save()</code> method to preform graceful-degradation when the
9006
app's <code>serverRouting</code> is <code>true</code> and <code>html5</code> is <code>false</code> by updating the full
9007
URL via standard assignment to <code>window.location</code> or by calling
9008
<code>window.location.replace()</code>; both of which will cause a request to the
9009
server resulting in a full-page reload.</p>
9011
<p>Otherwise this will just delegate off to Router's <code>_save()</code> method allowing
9012
the client-side enhanced routing to occur.</p>
9016
<div class="params">
9017
<h4>Parameters:</h4>
9019
<ul class="params-list">
9023
<code class="param-name optional">[url]</code>
9024
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9025
<span class="flag optional" title="This parameter is optional.">optional</span>
9030
<div class="param-description">
9031
<p>URL for the history entry.</p>
9039
<code class="param-name optional">[replace=false]</code>
9040
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9041
<span class="flag optional" title="This parameter is optional.">optional</span>
9046
<div class="param-description">
9047
<p>If <code>true</code>, the current history entry will
9048
be replaced instead of a new one being added.</p>
9064
<div id="method__set" class="method item protected inherited">
9065
<h3 class="name"><code>_set</code></h3>
9069
<span class="paren">(</span><ul class="args-list inline commas">
9083
</ul><span class="paren">)</span>
9088
<span class="returns-inline">
9089
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9096
<span class="flag protected">protected</span>
9104
<span class="flag chainable">chainable</span>
9110
<a href="../classes/AttributeEvents.html#method__set">
9118
<a href="../files/attribute_js_AttributeCore.js.html#l346"><code>attribute/js/AttributeCore.js:346</code></a>
9128
<div class="description">
9129
<p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>
9133
<div class="params">
9134
<h4>Parameters:</h4>
9136
<ul class="params-list">
9140
<code class="param-name">name</code>
9141
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9146
<div class="param-description">
9147
<p>The name of the attribute.</p>
9155
<code class="param-name">val</code>
9156
<span class="type">Any</span>
9161
<div class="param-description">
9162
<p>The value to set the attribute to.</p>
9173
<div class="returns">
9176
<div class="returns-description">
9179
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
9181
A reference to the host object.
9191
<div id="method__setAttr" class="method item protected inherited">
9192
<h3 class="name"><code>_setAttr</code></h3>
9196
<span class="paren">(</span><ul class="args-list inline commas">
9222
</ul><span class="paren">)</span>
9227
<span class="returns-inline">
9228
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9235
<span class="flag protected">protected</span>
9243
<span class="flag chainable">chainable</span>
9250
<a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:
9254
<a href="../files/attribute_js_AttributeCore.js.html#l361"><code>attribute/js/AttributeCore.js:361</code></a>
9264
<div class="description">
9265
<p>Provides the common implementation for the public set and protected _set methods.</p>
9267
<p>See <a href="#method_set">set</a> for argument details.</p>
9271
<div class="params">
9272
<h4>Parameters:</h4>
9274
<ul class="params-list">
9278
<code class="param-name">name</code>
9279
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9284
<div class="param-description">
9285
<p>The name of the attribute.</p>
9293
<code class="param-name">value</code>
9294
<span class="type">Any</span>
9299
<div class="param-description">
9300
<p>The value to set the attribute to.</p>
9308
<code class="param-name">opts</code>
9309
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9314
<div class="param-description">
9315
<p>(Optional) Optional event data to be mixed into
9316
the event facade passed to subscribers of the attribute's change event.
9317
This is currently a hack. There's no real need for the AttributeCore implementation
9318
to support this parameter, but breaking it out into AttributeEvents, results in
9319
additional function hops for the critical path. May change in 3.5.0 PR3.</p>
9327
<code class="param-name">force</code>
9328
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9333
<div class="param-description">
9334
<p>If true, allows the caller to set values for
9335
readOnly or writeOnce attributes which have already been set.</p>
9346
<div class="returns">
9349
<div class="returns-description">
9352
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
9354
A reference to the host object.
9364
<div id="method__setAttrs" class="method item protected inherited">
9365
<h3 class="name"><code>_setAttrs</code></h3>
9369
<span class="paren">(</span><ul class="args-list inline commas">
9377
</ul><span class="paren">)</span>
9382
<span class="returns-inline">
9383
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9390
<span class="flag protected">protected</span>
9398
<span class="flag chainable">chainable</span>
9405
<a href="../classes/AttributeCore.html#method__setAttrs">AttributeCore</a>:
9409
<a href="../files/attribute_js_AttributeCore.js.html#l647"><code>attribute/js/AttributeCore.js:647</code></a>
9419
<div class="description">
9420
<p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>
9424
<div class="params">
9425
<h4>Parameters:</h4>
9427
<ul class="params-list">
9431
<code class="param-name">attrs</code>
9432
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9437
<div class="param-description">
9438
<p>An object with attributes name/value pairs.</p>
9449
<div class="returns">
9452
<div class="returns-description">
9455
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
9457
A reference to the host object.
9467
<div id="method__setAttrVal" class="method item private inherited">
9468
<h3 class="name"><code>_setAttrVal</code></h3>
9472
<span class="paren">(</span><ul class="args-list inline commas">
9476
<code>attrName</code>
9482
<code>subAttrName</code>
9488
<code>prevVal</code>
9498
</ul><span class="paren">)</span>
9503
<span class="returns-inline">
9504
<span class="type">Booolean</span>
9511
<span class="flag private">private</span>
9524
<a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:
9528
<a href="../files/attribute_js_AttributeCore.js.html#l554"><code>attribute/js/AttributeCore.js:554</code></a>
9538
<div class="description">
9539
<p>Updates the stored value of the attribute in the privately held State object,
9540
if validation and setter passes.</p>
9544
<div class="params">
9545
<h4>Parameters:</h4>
9547
<ul class="params-list">
9551
<code class="param-name">attrName</code>
9552
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9557
<div class="param-description">
9558
<p>The attribute name.</p>
9566
<code class="param-name">subAttrName</code>
9567
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9572
<div class="param-description">
9573
<p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>
9581
<code class="param-name">prevVal</code>
9582
<span class="type">Any</span>
9587
<div class="param-description">
9588
<p>The currently stored value of the attribute.</p>
9596
<code class="param-name">newVal</code>
9597
<span class="type">Any</span>
9602
<div class="param-description">
9603
<p>The value which is going to be stored.</p>
9614
<div class="returns">
9617
<div class="returns-description">
9620
<span class="type">Booolean</span>:
9622
true if the new attribute value was stored, false if not.
9632
<div id="method__setRoutes" class="method item protected inherited">
9633
<h3 class="name"><code>_setRoutes</code></h3>
9637
<span class="paren">(</span><ul class="args-list inline commas">
9645
</ul><span class="paren">)</span>
9650
<span class="returns-inline">
9651
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
9658
<span class="flag protected">protected</span>
9671
<a href="../classes/Router.html#method__setRoutes">Router</a>:
9675
<a href="../files/app_js_router.js.html#l920"><code>app/js/router.js:920</code></a>
9685
<div class="description">
9686
<p>Setter for the <code>routes</code> attribute.</p>
9690
<div class="params">
9691
<h4>Parameters:</h4>
9693
<ul class="params-list">
9697
<code class="param-name">routes</code>
9698
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
9703
<div class="param-description">
9704
<p>Array of route objects.</p>
9715
<div class="returns">
9718
<div class="returns-description">
9721
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
9723
Array of route objects.
9733
<div id="method__setStateVal" class="method item private inherited">
9734
<h3 class="name"><code>_setStateVal</code></h3>
9738
<span class="paren">(</span><ul class="args-list inline commas">
9752
</ul><span class="paren">)</span>
9761
<span class="flag private">private</span>
9774
<a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:
9778
<a href="../files/attribute_js_AttributeCore.js.html#l536"><code>attribute/js/AttributeCore.js:536</code></a>
9788
<div class="description">
9789
<p>Sets the stored value for the attribute, in either the
9790
internal state object, or the state proxy if it exits</p>
9794
<div class="params">
9795
<h4>Parameters:</h4>
9797
<ul class="params-list">
9801
<code class="param-name">name</code>
9802
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9807
<div class="param-description">
9808
<p>The name of the attribute</p>
9816
<code class="param-name">value</code>
9817
<span class="type">Any</span>
9822
<div class="param-description">
9823
<p>The value of the attribute</p>
9839
<div id="method__setTransitions" class="method item protected inherited">
9840
<h3 class="name"><code>_setTransitions</code></h3>
9844
<span class="paren">(</span><ul class="args-list inline commas">
9848
<code>transitions</code>
9852
</ul><span class="paren">)</span>
9857
<span class="returns-inline">
9858
<span class="type">Mixed</span>
9865
<span class="flag protected">protected</span>
9878
<a href="../classes/App.Transitions.html#method__setTransitions">App.Transitions</a>:
9882
<a href="../files/app_js_app-extensions_app-transitions.js.html#l220"><code>app/js/app-extensions/app-transitions.js:220</code></a>
9890
<p>Available since 3.5.0</p>
9894
<div class="description">
9895
<p>Setter for <code>transitions</code> attribute.</p>
9897
<p>When specified as <code>true</code>, the defaults will be use as specified by the
9898
<code>transitions</code> prototype property.</p>
9902
<div class="params">
9903
<h4>Parameters:</h4>
9905
<ul class="params-list">
9909
<code class="param-name">transitions</code>
9910
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9915
<div class="param-description">
9916
<p>The new <code>transitions</code> attribute value.</p>
9927
<div class="returns">
9930
<div class="returns-description">
9933
<span class="type">Mixed</span>:
9935
The processed value which represents the new state.
9945
<div id="method__uiSetActiveView" class="method item protected inherited">
9946
<h3 class="name"><code>_uiSetActiveView</code></h3>
9950
<span class="paren">(</span><ul class="args-list inline commas">
9954
<code>newView</code>
9960
<code class="optional">[oldView]</code>
9966
<code class="optional">[options]</code>
9970
</ul><span class="paren">)</span>
9979
<span class="flag protected">protected</span>
9992
<a href="../classes/App.Base.html#method__uiSetActiveView">App.Base</a>:
9996
<a href="../files/app_js_app-base.js.html#l741"><code>app/js/app-base.js:741</code></a>
10004
<p>Available since 3.5.0</p>
10008
<div class="description">
10009
<p>Performs the actual change of this app's <code>activeView</code> by attaching the
10010
<code>newView</code> to this app, and detaching the <code>oldView</code> from this app using any
10011
specified <code>options</code>.</p>
10013
<p>The <code>newView</code> is attached to the app by rendering it to the <code>viewContainer</code>,
10014
and making this app a bubble target of its events.</p>
10016
<p>The <code>oldView</code> is detached from the app by removing it from the
10017
<code>viewContainer</code>, and removing this app as a bubble target for its events.
10018
The <code>oldView</code> will either be preserved or properly destroyed.</p>
10020
<p><strong>Note:</strong> The <code>activeView</code> attribute is read-only and can be changed by
10021
calling the <code>showView()</code> method.</p>
10025
<div class="params">
10026
<h4>Parameters:</h4>
10028
<ul class="params-list">
10032
<code class="param-name">newView</code>
10033
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
10038
<div class="param-description">
10039
<p>The View which is now this app's <code>activeView</code>.</p>
10047
<code class="param-name optional">[oldView]</code>
10048
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
10049
<span class="flag optional" title="This parameter is optional.">optional</span>
10054
<div class="param-description">
10055
<p>The View which was this app's <code>activeView</code>.</p>
10063
<code class="param-name optional">[options]</code>
10064
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10065
<span class="flag optional" title="This parameter is optional.">optional</span>
10070
<div class="param-description">
10071
<p>Optional object containing any of the following
10076
<ul class="params-list">
10080
<code class="param-name optional">[callback]</code>
10081
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
10082
<span class="flag optional" title="This parameter is optional.">optional</span>
10085
<div class="param-description">
10086
<p>Optional callback function to call
10087
after new <code>activeView</code> is ready to use, the function will be passed:</p>
10091
<ul class="params-list">
10095
<code class="param-name">view</code>
10096
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
10099
<div class="param-description">
10100
A reference to the new
10101
<code>activeView</code>.
10111
<code class="param-name optional">[prepend=false]</code>
10112
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10113
<span class="flag optional" title="This parameter is optional.">optional</span>
10116
<div class="param-description">
10117
<p>Whether the <code>view</code> should be
10118
prepended instead of appended to the <code>viewContainer</code>.</p>
10126
<code class="param-name optional">[render]</code>
10127
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10128
<span class="flag optional" title="This parameter is optional.">optional</span>
10131
<div class="param-description">
10132
<p>Whether the <code>view</code> should be rendered.
10133
<strong>Note:</strong> If no value is specified, a view instance will only be
10134
rendered if it's newly created by this method.</p>
10142
<code class="param-name optional">[update=false]</code>
10143
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10144
<span class="flag optional" title="This parameter is optional.">optional</span>
10147
<div class="param-description">
10148
<p>Whether an existing view should
10149
have its attributes updated by passing the <code>config</code> object to its
10150
<code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if
10151
the <code>view</code> instance is created as a result of calling this method.</p>
10171
<div id="method__upgradeURL" class="method item protected inherited">
10172
<h3 class="name"><code>_upgradeURL</code></h3>
10176
<span class="paren">(</span><ul class="args-list inline commas">
10184
</ul><span class="paren">)</span>
10189
<span class="returns-inline">
10190
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10197
<span class="flag protected">protected</span>
10210
<a href="../classes/App.Base.html#method__upgradeURL">App.Base</a>:
10214
<a href="../files/app_js_app-base.js.html#l797"><code>app/js/app-base.js:797</code></a>
10222
<p>Available since 3.5.0</p>
10226
<div class="description">
10227
<p>Upgrades a hash-based URL to a full-path URL, if necessary.</p>
10229
<p>The specified <code>url</code> will be upgraded if its of the same origin as the
10230
current URL and has a path-like hash. URLs that don't need upgrading will be
10231
returned as-is.</p>
10235
<div class="params">
10236
<h4>Parameters:</h4>
10238
<ul class="params-list">
10242
<code class="param-name">url</code>
10243
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10248
<div class="param-description">
10249
<p>The URL to upgrade from hash-based to full-path.</p>
10260
<div class="returns">
10263
<div class="returns-description">
10266
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
10268
The upgraded URL, or the specified URL untouched.
10275
<div class="example">
10278
<div class="example-content">
10279
<pre class="code"><code class="prettyprint">app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';
10287
<div id="method_addAttr" class="method item inherited">
10288
<h3 class="name"><code>addAttr</code></h3>
10292
<span class="paren">(</span><ul class="args-list inline commas">
10302
<code>config</code>
10312
</ul><span class="paren">)</span>
10317
<span class="returns-inline">
10318
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10331
<span class="flag chainable">chainable</span>
10338
<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:
10342
<a href="../files/attribute_js_AttributeCore.js.html#l124"><code>attribute/js/AttributeCore.js:124</code></a>
10352
<div class="description">
10354
Adds an attribute with the provided configuration to the host object.
10358
The config argument object supports the following properties:
10362
<dt>value <Any></dt>
10363
<dd>The initial value to set on the attribute</dd>
10365
<dt>valueFn <Function | String></dt>
10367
<p>A function, which will return the initial value to set on the attribute. This is useful
10368
for cases where the attribute configuration is defined statically, but needs to
10369
reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,
10370
the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which
10371
case the value property is used.</p>
10373
<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>
10376
<dt>readOnly <boolean></dt>
10377
<dd>Whether or not the attribute is read only. Attributes having readOnly set to true
10378
cannot be modified by invoking the set method.</dd>
10380
<dt>writeOnce <boolean> or <string></dt>
10382
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
10383
can only have their values set once, be it through the default configuration,
10384
constructor configuration arguments, or by invoking set.
10385
<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization
10386
(when used with Base, this means it can only be set during construction)</p>
10389
<dt>setter <Function | String></dt>
10391
<p>The setter function used to massage or normalize the value passed to the set method for the attribute.
10392
The value returned by the setter will be the final stored value. Returning
10393
<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
10394
the value from being stored.
10397
<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>
10400
<dt>getter <Function | String></dt>
10403
The getter function used to massage or normalize the value returned by the get method for the attribute.
10404
The value returned by the getter function is the value which will be returned to the user when they
10408
<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>
10411
<dt>validator <Function | String></dt>
10414
The validator function invoked prior to setting the stored value. Returning
10415
false from the validator function will prevent the value from being stored.
10418
<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>
10421
<dt>lazyAdd <boolean></dt>
10422
<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.
10423
This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
10424
the <a href="#method_addAttrs">addAttrs</a> method.</dd>
10428
<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
10429
the context ("this") set to the host object.</p>
10431
<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,
10432
and are not intended for public use.</p>
10436
<div class="params">
10437
<h4>Parameters:</h4>
10439
<ul class="params-list">
10443
<code class="param-name">name</code>
10444
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10449
<div class="param-description">
10450
<p>The name of the attribute.</p>
10458
<code class="param-name">config</code>
10459
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10464
<div class="param-description">
10465
<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>
10468
<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
10469
to protect the original values, you will need to merge the object.
10478
<code class="param-name">lazy</code>
10479
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10484
<div class="param-description">
10485
<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>
10496
<div class="returns">
10499
<div class="returns-description">
10502
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
10504
A reference to the host object.
10514
<div id="method_addAttrs" class="method item inherited">
10515
<h3 class="name"><code>addAttrs</code></h3>
10519
<span class="paren">(</span><ul class="args-list inline commas">
10529
<code>values</code>
10539
</ul><span class="paren">)</span>
10544
<span class="returns-inline">
10545
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10558
<span class="flag chainable">chainable</span>
10565
<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:
10569
<a href="../files/attribute_js_AttributeCore.js.html#l708"><code>attribute/js/AttributeCore.js:708</code></a>
10579
<div class="description">
10580
<p>Configures a group of attributes, and sets initial values.</p>
10583
<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.
10584
The caller is responsible for merging/cloning the configuration object if required.
10589
<div class="params">
10590
<h4>Parameters:</h4>
10592
<ul class="params-list">
10596
<code class="param-name">cfgs</code>
10597
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10602
<div class="param-description">
10603
<p>An object with attribute name/configuration pairs.</p>
10611
<code class="param-name">values</code>
10612
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10617
<div class="param-description">
10618
<p>An object with attribute name/value pairs, defining the initial values to apply.
10619
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
10627
<code class="param-name">lazy</code>
10628
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10633
<div class="param-description">
10634
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
10635
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
10636
See <a href="#method_addAttr">addAttr</a>.</p>
10647
<div class="returns">
10650
<div class="returns-description">
10653
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
10655
A reference to the host object.
10665
<div id="method_addTarget" class="method item inherited">
10666
<h3 class="name"><code>addTarget</code></h3>
10670
<span class="paren">(</span><ul class="args-list inline commas">
10678
</ul><span class="paren">)</span>
10698
<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:
10702
<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>
10712
<div class="description">
10713
<p>Registers another EventTarget as a bubble target. Bubble order
10714
is determined by the order registered. Multiple targets can
10717
<p>Events can only bubble if emitFacade is true.</p>
10719
<p>Included in the event-custom-complex submodule.</p>
10723
<div class="params">
10724
<h4>Parameters:</h4>
10726
<ul class="params-list">
10730
<code class="param-name">o</code>
10731
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
10736
<div class="param-description">
10737
<p>the target to add</p>
10753
<div id="method_after" class="method item inherited">
10754
<h3 class="name"><code>after</code></h3>
10758
<span class="paren">(</span><ul class="args-list inline commas">
10774
<code class="optional">[context]</code>
10780
<code class="optional">[arg*]</code>
10784
</ul><span class="paren">)</span>
10789
<span class="returns-inline">
10790
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
10808
<a href="../classes/EventTarget.html#method_after">EventTarget</a>:
10812
<a href="../files/event-custom_js_event-target.js.html#l730"><code>event-custom/js/event-target.js:730</code></a>
10822
<div class="description">
10823
<p>Subscribe to a custom event hosted by this object. The
10824
supplied callback will execute after any listeners add
10825
via the subscribe method, and after the default function,
10826
if configured for the event, has executed.</p>
10830
<div class="params">
10831
<h4>Parameters:</h4>
10833
<ul class="params-list">
10837
<code class="param-name">type</code>
10838
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10843
<div class="param-description">
10844
<p>The name of the event</p>
10852
<code class="param-name">fn</code>
10853
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
10858
<div class="param-description">
10859
<p>The callback to execute in response to the event</p>
10867
<code class="param-name optional">[context]</code>
10868
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10869
<span class="flag optional" title="This parameter is optional.">optional</span>
10874
<div class="param-description">
10875
<p>Override <code>this</code> object in callback</p>
10883
<code class="param-name optional">[arg*]</code>
10884
<span class="type">Any</span>
10885
<span class="flag optional" title="This parameter is optional.">optional</span>
10890
<div class="param-description">
10891
<p>0..n additional arguments to supply to the subscriber</p>
10902
<div class="returns">
10905
<div class="returns-description">
10908
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
10910
A subscription handle capable of detaching the
10921
<div id="method_attachEvents" class="method item inherited">
10922
<h3 class="name"><code>attachEvents</code></h3>
10926
<span class="paren">(</span><ul class="args-list inline commas">
10930
<code class="optional">[events]</code>
10934
</ul><span class="paren">)</span>
10949
<span class="flag chainable">chainable</span>
10956
<a href="../classes/View.html#method_attachEvents">View</a>:
10960
<a href="../files/app_js_view.js.html#l181"><code>app/js/view.js:181</code></a>
10970
<div class="description">
10971
<p>Attaches delegated event handlers to this view's container element. This
10972
method is called internally to subscribe to events configured in the
10973
<code>events</code> attribute when the view is initialized.</p>
10975
<p>You may override this method to customize the event attaching logic.</p>
10979
<div class="params">
10980
<h4>Parameters:</h4>
10982
<ul class="params-list">
10986
<code class="param-name optional">[events]</code>
10987
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10988
<span class="flag optional" title="This parameter is optional.">optional</span>
10993
<div class="param-description">
10994
<p>Hash of events to attach. See the docs for the
10995
<code>events</code> attribute for details on the format. If not specified, this
10996
view's <code>events</code> property will be used.</p>
11012
<div id="method_attrAdded" class="method item inherited">
11013
<h3 class="name"><code>attrAdded</code></h3>
11017
<span class="paren">(</span><ul class="args-list inline commas">
11025
</ul><span class="paren">)</span>
11030
<span class="returns-inline">
11031
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
11049
<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:
11053
<a href="../files/attribute_js_AttributeCore.js.html#l272"><code>attribute/js/AttributeCore.js:272</code></a>
11063
<div class="description">
11064
<p>Checks if the given attribute has been added to the host</p>
11068
<div class="params">
11069
<h4>Parameters:</h4>
11071
<ul class="params-list">
11075
<code class="param-name">name</code>
11076
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11081
<div class="param-description">
11082
<p>The name of the attribute to check.</p>
11093
<div class="returns">
11096
<div class="returns-description">
11099
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
11101
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
11111
<div id="method_before" class="method item inherited">
11112
<h3 class="name"><code>before</code></h3>
11115
<span class="paren">()</span>
11119
<span class="returns-inline">
11120
<span class="type"></span>
11138
<a href="../classes/EventTarget.html#method_before">EventTarget</a>:
11142
<a href="../files/event-custom_js_event-target.js.html#l767"><code>event-custom/js/event-target.js:767</code></a>
11152
<div class="description">
11153
<p>Executes the callback before a DOM event, custom event
11154
or method. If the first argument is a function, it
11155
is assumed the target is a method. For DOM and custom
11156
events, this is an alias for Y.on.</p>
11158
<p>For DOM and custom events:
11159
type, callback, context, 0-n arguments</p>
11162
callback, object (method host), methodName, context, 0-n arguments</p>
11168
<div class="returns">
11171
<div class="returns-description">
11184
<div id="method_bubble" class="method item inherited">
11185
<h3 class="name"><code>bubble</code></h3>
11189
<span class="paren">(</span><ul class="args-list inline commas">
11197
</ul><span class="paren">)</span>
11202
<span class="returns-inline">
11203
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
11221
<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:
11225
<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>
11235
<div class="description">
11236
<p>Propagate an event. Requires the event-custom-complex module.</p>
11240
<div class="params">
11241
<h4>Parameters:</h4>
11243
<ul class="params-list">
11247
<code class="param-name">evt</code>
11248
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
11253
<div class="param-description">
11254
<p>the custom event to propagate</p>
11265
<div class="returns">
11268
<div class="returns-description">
11271
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
11273
the aggregated return value from Event.Custom.fire
11283
<div id="method_create" class="method item inherited">
11284
<h3 class="name"><code>create</code></h3>
11288
<span class="paren">(</span><ul class="args-list inline commas">
11292
<code class="optional">[container]</code>
11296
</ul><span class="paren">)</span>
11301
<span class="returns-inline">
11302
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
11320
<a href="../classes/View.html#method_create">View</a>:
11324
<a href="../files/app_js_view.js.html#l226"><code>app/js/view.js:226</code></a>
11334
<div class="description">
11335
<p>Creates and returns a container node for this view.</p>
11337
<p>By default, the container is created from the HTML template specified in the
11338
<code>containerTemplate</code> property, and is <em>not</em> added to the DOM automatically.</p>
11340
<p>You may override this method to customize how the container node is created
11341
(such as by rendering it from a custom template format). Your method must
11342
return a <code>Y.Node</code> instance.</p>
11346
<div class="params">
11347
<h4>Parameters:</h4>
11349
<ul class="params-list">
11353
<code class="param-name optional">[container]</code>
11354
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11355
<span class="flag optional" title="This parameter is optional.">optional</span>
11360
<div class="param-description">
11361
<p>Selector string, <code>Y.Node</code>
11362
instance, or DOM element to use at the container node.</p>
11373
<div class="returns">
11376
<div class="returns-description">
11379
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
11381
Node instance of the created container node.
11391
<div id="method_createView" class="method item inherited">
11392
<h3 class="name"><code>createView</code></h3>
11396
<span class="paren">(</span><ul class="args-list inline commas">
11406
<code class="optional">[config]</code>
11410
</ul><span class="paren">)</span>
11415
<span class="returns-inline">
11416
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
11434
<a href="../classes/App.Base.html#method_createView">App.Base</a>:
11438
<a href="../files/app_js_app-base.js.html#l185"><code>app/js/app-base.js:185</code></a>
11446
<p>Available since 3.5.0</p>
11450
<div class="description">
11451
<p>Creates and returns a new view instance using the provided <code>name</code> to look up
11452
the view info metadata defined in the <code>views</code> object. The passed-in <code>config</code>
11453
object is passed to the view constructor function.</p>
11455
<p>This function also maps a view instance back to its view info metadata.</p>
11459
<div class="params">
11460
<h4>Parameters:</h4>
11462
<ul class="params-list">
11466
<code class="param-name">name</code>
11467
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11472
<div class="param-description">
11473
<p>The name of a view defined on the <code>views</code> object.</p>
11481
<code class="param-name optional">[config]</code>
11482
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
11483
<span class="flag optional" title="This parameter is optional.">optional</span>
11488
<div class="param-description">
11489
<p>The configuration object passed to the view
11490
constructor function when creating the new view instance.</p>
11501
<div class="returns">
11504
<div class="returns-description">
11507
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>:
11509
The new view instance.
11519
<div id="method_destroy" class="method item inherited">
11520
<h3 class="name"><code>destroy</code></h3>
11524
<span class="paren">(</span><ul class="args-list inline commas">
11528
<code class="optional">[options]</code>
11532
</ul><span class="paren">)</span>
11547
<span class="flag chainable">chainable</span>
11553
<a href="../classes/BaseCore.html#method_destroy">
11561
<a href="../files/app_js_view.js.html#l146"><code>app/js/view.js:146</code></a>
11571
<div class="description">
11572
<p>Destroys this View, detaching any DOM events and optionally also destroying
11573
its container node.</p>
11575
<p>By default, the container node will not be destroyed. Pass an <em>options</em>
11576
object with a truthy <code>remove</code> property to destroy the container as well.</p>
11580
<div class="params">
11581
<h4>Parameters:</h4>
11583
<ul class="params-list">
11587
<code class="param-name optional">[options]</code>
11588
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
11589
<span class="flag optional" title="This parameter is optional.">optional</span>
11594
<div class="param-description">
11599
<ul class="params-list">
11603
<code class="param-name optional">[remove=false]</code>
11604
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
11605
<span class="flag optional" title="This parameter is optional.">optional</span>
11608
<div class="param-description">
11609
<p>If <code>true</code>, this View's container
11610
will be removed from the DOM and destroyed as well.</p>
11630
<div id="method_detach" class="method item inherited">
11631
<h3 class="name"><code>detach</code></h3>
11635
<span class="paren">(</span><ul class="args-list inline commas">
11651
<code>context</code>
11655
</ul><span class="paren">)</span>
11660
<span class="returns-inline">
11661
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
11679
<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:
11683
<a href="../files/event-custom_js_event-target.js.html#l345"><code>event-custom/js/event-target.js:345</code></a>
11693
<div class="description">
11694
<p>Detach one or more listeners the from the specified event</p>
11698
<div class="params">
11699
<h4>Parameters:</h4>
11701
<ul class="params-list">
11705
<code class="param-name">type</code>
11706
<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>
11711
<div class="param-description">
11712
<p>Either the handle to the subscriber or the
11713
type of event. If the type
11714
is not specified, it will attempt to remove
11715
the listener from all hosted events.</p>
11723
<code class="param-name">fn</code>
11724
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
11729
<div class="param-description">
11730
<p>The subscribed function to unsubscribe, if not
11731
supplied, all subscribers will be removed.</p>
11739
<code class="param-name">context</code>
11740
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
11745
<div class="param-description">
11746
<p>The custom object passed to subscribe. This is
11747
optional, but if supplied will be used to
11748
disambiguate multiple listeners that are the same
11749
(e.g., you subscribe many object using a function
11750
that lives on the prototype)</p>
11761
<div class="returns">
11764
<div class="returns-description">
11767
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
11779
<div id="method_detachAll" class="method item inherited">
11780
<h3 class="name"><code>detachAll</code></h3>
11784
<span class="paren">(</span><ul class="args-list inline commas">
11792
</ul><span class="paren">)</span>
11812
<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:
11816
<a href="../files/event-custom_js_event-target.js.html#l465"><code>event-custom/js/event-target.js:465</code></a>
11826
<div class="description">
11827
<p>Removes all listeners from the specified event. If the event type
11828
is not specified, all listeners from all hosted custom events will
11833
<div class="params">
11834
<h4>Parameters:</h4>
11836
<ul class="params-list">
11840
<code class="param-name">type</code>
11841
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11846
<div class="param-description">
11847
<p>The type, or name of the event</p>
11863
<div id="method_detachEvents" class="method item inherited">
11864
<h3 class="name"><code>detachEvents</code></h3>
11867
<span class="paren">()</span>
11881
<span class="flag chainable">chainable</span>
11888
<a href="../classes/View.html#method_detachEvents">View</a>:
11892
<a href="../files/app_js_view.js.html#l246"><code>app/js/view.js:246</code></a>
11902
<div class="description">
11903
<p>Detaches DOM events that have previously been attached to the container by
11904
<code>attachEvents()</code>.</p>
11915
<div id="method_dispatch" class="method item inherited">
11916
<h3 class="name"><code>dispatch</code></h3>
11919
<span class="paren">()</span>
11933
<span class="flag chainable">chainable</span>
11940
<a href="../classes/Router.html#method_dispatch">Router</a>:
11944
<a href="../files/app_js_router.js.html#l183"><code>app/js/router.js:183</code></a>
11954
<div class="description">
11955
<p>Dispatches to the first route handler that matches the current URL, if any.</p>
11957
<p>If <code>dispatch()</code> is called before the <code>ready</code> event has fired, it will
11958
automatically wait for the <code>ready</code> event before dispatching. Otherwise it
11959
will dispatch immediately.</p>
11970
<div id="method_fire" class="method item inherited">
11971
<h3 class="name"><code>fire</code></h3>
11975
<span class="paren">(</span><ul class="args-list inline commas">
11985
<code>arguments</code>
11989
</ul><span class="paren">)</span>
11994
<span class="returns-inline">
11995
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
12013
<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:
12017
<a href="../files/event-custom_js_event-target.js.html#l629"><code>event-custom/js/event-target.js:629</code></a>
12027
<div class="description">
12028
<p>Fire a custom event by name. The callback functions will be executed
12029
from the context specified when the event was created, and with the
12030
following parameters.</p>
12032
<p>If the custom event object hasn't been created, then the event hasn't
12033
been published and it has no subscribers. For performance sake, we
12034
immediate exit in this case. This means the event won't bubble, so
12035
if the intention is that a bubble target be notified, the event must
12036
be published on this object first.</p>
12038
<p>The first argument is the event type, and any additional arguments are
12039
passed to the listeners as parameters. If the first of these is an
12040
object literal, and the event is configured to emit an event facade,
12041
that object is mixed into the event facade and the facade is provided
12042
in place of the original object.</p>
12046
<div class="params">
12047
<h4>Parameters:</h4>
12049
<ul class="params-list">
12053
<code class="param-name">type</code>
12054
<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>
12059
<div class="param-description">
12060
<p>The type of the event, or an object that contains
12061
a 'type' property.</p>
12069
<code class="param-name">arguments</code>
12070
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>
12075
<div class="param-description">
12076
<p>an arbitrary set of parameters to pass to
12077
the handler. If the first of these is an object literal and the event is
12078
configured to emit an event facade, the event facade will replace that
12079
parameter after the properties the object literal contains are copied to
12080
the event facade.</p>
12091
<div class="returns">
12094
<div class="returns-description">
12097
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
12109
<div id="method_get" class="method item inherited">
12110
<h3 class="name"><code>get</code></h3>
12114
<span class="paren">(</span><ul class="args-list inline commas">
12122
</ul><span class="paren">)</span>
12127
<span class="returns-inline">
12128
<span class="type">Any</span>
12146
<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:
12150
<a href="../files/attribute_js_AttributeCore.js.html#l283"><code>attribute/js/AttributeCore.js:283</code></a>
12160
<div class="description">
12161
<p>Returns the current value of the attribute. If the attribute
12162
has been configured with a 'getter' function, this method will delegate
12163
to the 'getter' to obtain the value of the attribute.</p>
12167
<div class="params">
12168
<h4>Parameters:</h4>
12170
<ul class="params-list">
12174
<code class="param-name">name</code>
12175
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12180
<div class="param-description">
12181
<p>The name of the attribute. If the value of the attribute is an Object,
12182
dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>
12193
<div class="returns">
12196
<div class="returns-description">
12199
<span class="type">Any</span>:
12201
The value of the attribute
12211
<div id="method_getAttrs" class="method item inherited">
12212
<h3 class="name"><code>getAttrs</code></h3>
12216
<span class="paren">(</span><ul class="args-list inline commas">
12224
</ul><span class="paren">)</span>
12229
<span class="returns-inline">
12230
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
12248
<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:
12252
<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>
12262
<div class="description">
12263
<p>Gets multiple attribute values.</p>
12267
<div class="params">
12268
<h4>Parameters:</h4>
12270
<ul class="params-list">
12274
<code class="param-name">attrs</code>
12275
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
12280
<div class="param-description">
12281
<p>Optional. An array of attribute names. If omitted, all attribute values are
12282
returned. If set to true, all attributes modified from their initial values are returned.</p>
12293
<div class="returns">
12296
<div class="returns-description">
12299
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
12301
An object with attribute name/value pairs.
12311
<div id="method_getEvent" class="method item inherited">
12312
<h3 class="name"><code>getEvent</code></h3>
12316
<span class="paren">(</span><ul class="args-list inline commas">
12326
<code>prefixed</code>
12330
</ul><span class="paren">)</span>
12335
<span class="returns-inline">
12336
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
12354
<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:
12358
<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>
12368
<div class="description">
12369
<p>Returns the custom event of the provided type has been created, a
12370
falsy value otherwise</p>
12374
<div class="params">
12375
<h4>Parameters:</h4>
12377
<ul class="params-list">
12381
<code class="param-name">type</code>
12382
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12387
<div class="param-description">
12388
<p>the type, or name of the event</p>
12396
<code class="param-name">prefixed</code>
12397
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12402
<div class="param-description">
12403
<p>if true, the type is prefixed already</p>
12414
<div class="returns">
12417
<div class="returns-description">
12420
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
12422
the custom event or null
12432
<div id="method_getPath" class="method item inherited">
12433
<h3 class="name"><code>getPath</code></h3>
12436
<span class="paren">()</span>
12440
<span class="returns-inline">
12441
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12459
<a href="../classes/Router.html#method_getPath">Router</a>:
12463
<a href="../files/app_js_router.js.html#l207"><code>app/js/router.js:207</code></a>
12473
<div class="description">
12474
<p>Gets the current route path, relative to the <code>root</code> (if any).</p>
12480
<div class="returns">
12483
<div class="returns-description">
12486
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
12488
Current route path.
12498
<div id="method_getTargets" class="method item inherited">
12499
<h3 class="name"><code>getTargets</code></h3>
12502
<span class="paren">()</span>
12506
<span class="returns-inline">
12507
<span class="type"></span>
12525
<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:
12529
<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>
12539
<div class="description">
12540
<p>Returns an array of bubble targets for this object.</p>
12546
<div class="returns">
12549
<div class="returns-description">
12562
<div id="method_getViewInfo" class="method item inherited">
12563
<h3 class="name"><code>getViewInfo</code></h3>
12567
<span class="paren">(</span><ul class="args-list inline commas">
12575
</ul><span class="paren">)</span>
12580
<span class="returns-inline">
12581
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
12599
<a href="../classes/App.Base.html#method_getViewInfo">App.Base</a>:
12603
<a href="../files/app_js_app-base.js.html#l215"><code>app/js/app-base.js:215</code></a>
12611
<p>Available since 3.5.0</p>
12615
<div class="description">
12616
<p>Returns the metadata associated with a view instance or view name defined on
12617
the <code>views</code> object.</p>
12621
<div class="params">
12622
<h4>Parameters:</h4>
12624
<ul class="params-list">
12628
<code class="param-name">view</code>
12629
<span class="type"><a href="../classes/View.html" class="crosslink">View</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12634
<div class="param-description">
12635
<p>View instance, or name of a view defined on the
12636
<code>views</code> object.</p>
12647
<div class="returns">
12650
<div class="returns-description">
12653
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
12655
The metadata for the view, or <code>undefined</code> if the view is
12666
<div id="method_hasRoute" class="method item inherited">
12667
<h3 class="name"><code>hasRoute</code></h3>
12671
<span class="paren">(</span><ul class="args-list inline commas">
12679
</ul><span class="paren">)</span>
12684
<span class="returns-inline">
12685
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
12703
<a href="../classes/Router.html#method_hasRoute">Router</a>:
12707
<a href="../files/app_js_router.js.html#l217"><code>app/js/router.js:217</code></a>
12717
<div class="description">
12718
<p>Returns <code>true</code> if this router has at least one route that matches the
12719
specified URL, <code>false</code> otherwise.</p>
12721
<p>This method enforces the same-origin security constraint on the specified
12722
<code>url</code>; any URL which is not from the same origin as the current URL will
12723
always return <code>false</code>.</p>
12727
<div class="params">
12728
<h4>Parameters:</h4>
12730
<ul class="params-list">
12734
<code class="param-name">url</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>
12740
<div class="param-description">
12741
<p>URL to match.</p>
12752
<div class="returns">
12755
<div class="returns-description">
12758
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
12760
<code>true</code> if there's at least one matching route, <code>false</code>
12771
<div id="method_init" class="method item inherited">
12772
<h3 class="name"><code>init</code></h3>
12776
<span class="paren">(</span><ul class="args-list inline commas">
12780
<code>config</code>
12784
</ul><span class="paren">)</span>
12789
<span class="returns-inline">
12790
<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>
12803
<span class="flag chainable">chainable</span>
12809
<a href="../classes/BaseCore.html#method_init">
12817
<a href="../files/base_js_Base.js.html#l191"><code>base/js/Base.js:191</code></a>
12827
<div class="description">
12828
<p>Init lifecycle method, invoked during construction.
12829
Fires the init event prior to setting up attributes and
12830
invoking initializers for the class hierarchy.</p>
12834
<div class="params">
12835
<h4>Parameters:</h4>
12837
<ul class="params-list">
12841
<code class="param-name">config</code>
12842
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
12847
<div class="param-description">
12848
<p>Object with configuration property name/value pairs</p>
12859
<div class="returns">
12862
<div class="returns-description">
12865
<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:
12867
A reference to this object
12877
<div id="method_match" class="method item inherited">
12878
<h3 class="name"><code>match</code></h3>
12882
<span class="paren">(</span><ul class="args-list inline commas">
12890
</ul><span class="paren">)</span>
12895
<span class="returns-inline">
12896
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
12914
<a href="../classes/Router.html#method_match">Router</a>:
12918
<a href="../files/app_js_router.js.html#l240"><code>app/js/router.js:240</code></a>
12928
<div class="description">
12929
<p>Returns an array of route objects that match the specified URL path.</p>
12931
<p>This method is called internally to determine which routes match the current
12932
path whenever the URL changes. You may override it if you want to customize
12933
the route matching logic, although this usually shouldn't be necessary.</p>
12935
<p>Each returned route object has the following properties:</p>
12938
<li><code>callback</code>: A function or a string representing the name of a function
12939
this router that should be executed when the route is triggered.</li>
12940
<li><code>keys</code>: An array of strings representing the named parameters defined in
12941
the route's path specification, if any.</li>
12942
<li><code>path</code>: The route's path specification, which may be either a string or
12944
<li><code>regex</code>: A regular expression version of the route's path specification.
12945
This regex is used to determine whether the route matches a given path.</li>
12950
<div class="params">
12951
<h4>Parameters:</h4>
12953
<ul class="params-list">
12957
<code class="param-name">path</code>
12958
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12963
<div class="param-description">
12964
<p>URL path to match.</p>
12975
<div class="returns">
12978
<div class="returns-description">
12981
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
12983
Array of route objects that match the specified path.
12990
<div class="example">
12993
<div class="example-content">
12994
<pre class="code"><code class="prettyprint">router.route('/foo', function () {});
12995
router.match('/foo');
12996
// => [{callback: ..., keys: [], path: '/foo', regex: ...}]
13004
<div id="method_modifyAttr" class="method item inherited">
13005
<h3 class="name"><code>modifyAttr</code></h3>
13009
<span class="paren">(</span><ul class="args-list inline commas">
13019
<code>config</code>
13023
</ul><span class="paren">)</span>
13043
<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:
13047
<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>
13057
<div class="description">
13058
<p>Updates the configuration of an attribute which has already been added.</p>
13061
The properties which can be modified through this interface are limited
13062
to the following subset of attributes, which can be safely modified
13063
after a value has already been set on the attribute: readOnly, writeOnce,
13064
broadcast and getter.
13069
<div class="params">
13070
<h4>Parameters:</h4>
13072
<ul class="params-list">
13076
<code class="param-name">name</code>
13077
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13082
<div class="param-description">
13083
<p>The name of the attribute whose configuration is to be updated.</p>
13091
<code class="param-name">config</code>
13092
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13097
<div class="param-description">
13098
<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>
13114
<div id="method_navigate" class="method item inherited">
13115
<h3 class="name"><code>navigate</code></h3>
13119
<span class="paren">(</span><ul class="args-list inline commas">
13129
<code class="optional">[options]</code>
13133
</ul><span class="paren">)</span>
13152
<a href="../classes/PjaxBase.html#method_navigate">
13160
<a href="../files/app_js_app-base.js.html#l234"><code>app/js/app-base.js:234</code></a>
13170
<div class="description">
13171
<p>Navigates to the specified URL if there is a route handler that matches. In
13172
browsers capable of using HTML5 history or when <code>serverRouting</code> is falsy,
13173
the navigation will be enhanced by firing the <code>navigate</code> event and having
13174
the app handle the "request". When <code>serverRouting</code> is <code>true</code>, non-HTML5
13175
browsers will navigate to the new URL via a full page reload.</p>
13177
<p>When there is a route handler for the specified URL and it is being
13178
navigated to, this method will return <code>true</code>, otherwise it will return
13179
<code>false</code>.</p>
13181
<p><strong>Note:</strong> The specified URL <em>must</em> be of the same origin as the current URL,
13182
otherwise an error will be logged and navigation will not occur. This is
13183
intended as both a security constraint and a purposely imposed limitation as
13184
it does not make sense to tell the app to navigate to a URL on a
13185
different scheme, host, or port.</p>
13189
<div class="params">
13190
<h4>Parameters:</h4>
13192
<ul class="params-list">
13196
<code class="param-name">url</code>
13197
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13202
<div class="param-description">
13203
<p>The URL to navigate to. This must be of the same origin
13204
as the current URL.</p>
13212
<code class="param-name optional">[options]</code>
13213
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13214
<span class="flag optional" title="This parameter is optional.">optional</span>
13219
<div class="param-description">
13220
<p>Additional options to configure the navigation.
13221
These are mixed into the <code>navigate</code> event facade.</p>
13225
<ul class="params-list">
13229
<code class="param-name optional">[replace]</code>
13230
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
13231
<span class="flag optional" title="This parameter is optional.">optional</span>
13234
<div class="param-description">
13235
<p>Whether or not the current history
13236
entry will be replaced, or a new entry will be created. Will default
13237
to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>
13245
<code class="param-name optional">[force]</code>
13246
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
13247
<span class="flag optional" title="This parameter is optional.">optional</span>
13250
<div class="param-description">
13251
<p>Whether the enhanced navigation
13252
should occur even in browsers without HTML5 history. Will default to
13253
<code>true</code> when <code>serverRouting</code> is falsy.</p>
13273
<div id="method_on" class="method item inherited">
13274
<h3 class="name"><code>on</code></h3>
13278
<span class="paren">(</span><ul class="args-list inline commas">
13294
<code class="optional">[context]</code>
13300
<code class="optional">[arg*]</code>
13304
</ul><span class="paren">)</span>
13309
<span class="returns-inline">
13310
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13328
<a href="../classes/EventTarget.html#method_on">EventTarget</a>:
13332
<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>
13342
<div class="description">
13343
<p>Subscribe a callback function to a custom event fired by this object or
13344
from an object that bubbles its events to this object.</p>
13346
<p>Callback functions for events published with <code>emitFacade = true</code> will
13347
receive an <code>EventFacade</code> as the first argument (typically named "e").
13348
These callbacks can then call <code>e.preventDefault()</code> to disable the
13349
behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>
13350
API for all available properties and methods. Subscribers to
13351
non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>
13352
after the event name.</p>
13354
<p>To subscribe to multiple events at once, pass an object as the first
13355
argument, where the key:value pairs correspond to the eventName:callback,
13356
or pass an array of event names as the first argument to subscribe to
13357
all listed events with the same callback.</p>
13359
<p>Returning <code>false</code> from a callback is supported as an alternative to
13360
calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is
13361
recommended to use the event methods whenever possible.</p>
13365
<div class="params">
13366
<h4>Parameters:</h4>
13368
<ul class="params-list">
13372
<code class="param-name">type</code>
13373
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13378
<div class="param-description">
13379
<p>The name of the event</p>
13387
<code class="param-name">fn</code>
13388
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13393
<div class="param-description">
13394
<p>The callback to execute in response to the event</p>
13402
<code class="param-name optional">[context]</code>
13403
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13404
<span class="flag optional" title="This parameter is optional.">optional</span>
13409
<div class="param-description">
13410
<p>Override <code>this</code> object in callback</p>
13418
<code class="param-name optional">[arg*]</code>
13419
<span class="type">Any</span>
13420
<span class="flag optional" title="This parameter is optional.">optional</span>
13425
<div class="param-description">
13426
<p>0..n additional arguments to supply to the subscriber</p>
13437
<div class="returns">
13440
<div class="returns-description">
13443
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13445
A subscription handle capable of detaching that
13456
<div id="method_once" class="method item inherited">
13457
<h3 class="name"><code>once</code></h3>
13461
<span class="paren">(</span><ul class="args-list inline commas">
13477
<code class="optional">[context]</code>
13483
<code class="optional">[arg*]</code>
13487
</ul><span class="paren">)</span>
13492
<span class="returns-inline">
13493
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13511
<a href="../classes/EventTarget.html#method_once">EventTarget</a>:
13515
<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>
13525
<div class="description">
13526
<p>Listen to a custom event hosted by this object one time.
13527
This is the equivalent to <code>on</code> except the
13528
listener is immediatelly detached when it is executed.</p>
13532
<div class="params">
13533
<h4>Parameters:</h4>
13535
<ul class="params-list">
13539
<code class="param-name">type</code>
13540
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13545
<div class="param-description">
13546
<p>The name of the event</p>
13554
<code class="param-name">fn</code>
13555
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13560
<div class="param-description">
13561
<p>The callback to execute in response to the event</p>
13569
<code class="param-name optional">[context]</code>
13570
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13571
<span class="flag optional" title="This parameter is optional.">optional</span>
13576
<div class="param-description">
13577
<p>Override <code>this</code> object in callback</p>
13585
<code class="param-name optional">[arg*]</code>
13586
<span class="type">Any</span>
13587
<span class="flag optional" title="This parameter is optional.">optional</span>
13592
<div class="param-description">
13593
<p>0..n additional arguments to supply to the subscriber</p>
13604
<div class="returns">
13607
<div class="returns-description">
13610
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13612
A subscription handle capable of detaching the
13623
<div id="method_onceAfter" class="method item inherited">
13624
<h3 class="name"><code>onceAfter</code></h3>
13628
<span class="paren">(</span><ul class="args-list inline commas">
13644
<code class="optional">[context]</code>
13650
<code class="optional">[arg*]</code>
13654
</ul><span class="paren">)</span>
13659
<span class="returns-inline">
13660
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13678
<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:
13682
<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>
13692
<div class="description">
13693
<p>Listen to a custom event hosted by this object one time.
13694
This is the equivalent to <code>after</code> except the
13695
listener is immediatelly detached when it is executed.</p>
13699
<div class="params">
13700
<h4>Parameters:</h4>
13702
<ul class="params-list">
13706
<code class="param-name">type</code>
13707
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13712
<div class="param-description">
13713
<p>The name of the event</p>
13721
<code class="param-name">fn</code>
13722
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13727
<div class="param-description">
13728
<p>The callback to execute in response to the event</p>
13736
<code class="param-name optional">[context]</code>
13737
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13738
<span class="flag optional" title="This parameter is optional.">optional</span>
13743
<div class="param-description">
13744
<p>Override <code>this</code> object in callback</p>
13752
<code class="param-name optional">[arg*]</code>
13753
<span class="type">Any</span>
13754
<span class="flag optional" title="This parameter is optional.">optional</span>
13759
<div class="param-description">
13760
<p>0..n additional arguments to supply to the subscriber</p>
13771
<div class="returns">
13774
<div class="returns-description">
13777
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13779
A subscription handle capable of detaching that
13790
<div id="method_parseType" class="method item inherited">
13791
<h3 class="name"><code>parseType</code></h3>
13795
<span class="paren">(</span><ul class="args-list inline commas">
13805
<code class="optional">[pre=this._yuievt.config.prefix]</code>
13809
</ul><span class="paren">)</span>
13814
<span class="returns-inline">
13815
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
13833
<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:
13837
<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>
13845
<p>Available since 3.3.0</p>
13849
<div class="description">
13850
<p>Takes the type parameter passed to 'on' and parses out the
13851
various pieces that could be included in the type. If the
13852
event type is passed without a prefix, it will be expanded
13853
to include the prefix one is supplied or the event target
13854
is configured with a default prefix.</p>
13858
<div class="params">
13859
<h4>Parameters:</h4>
13861
<ul class="params-list">
13865
<code class="param-name">type</code>
13866
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13871
<div class="param-description">
13880
<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>
13881
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13882
<span class="flag optional" title="This parameter is optional.">optional</span>
13887
<div class="param-description">
13899
<div class="returns">
13902
<div class="returns-description">
13905
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
13907
an array containing:
13908
* the detach category, if supplied,
13909
* the prefixed event type,
13910
* whether or not this is an after listener,
13911
* the supplied event type
13921
<div id="method_publish" class="method item inherited">
13922
<h3 class="name"><code>publish</code></h3>
13926
<span class="paren">(</span><ul class="args-list inline commas">
13940
</ul><span class="paren">)</span>
13945
<span class="returns-inline">
13946
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
13964
<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:
13968
<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>
13978
<div class="description">
13979
<p>Creates a new custom event of the specified type. If a custom event
13980
by that name already exists, it will not be re-created. In either
13981
case the custom event is returned.</p>
13985
<div class="params">
13986
<h4>Parameters:</h4>
13988
<ul class="params-list">
13992
<code class="param-name">type</code>
13993
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13998
<div class="param-description">
13999
<p>the type, or name of the event</p>
14007
<code class="param-name">opts</code>
14008
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14013
<div class="param-description">
14014
<p>optional config params. Valid properties are:</p>
14018
'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
14021
'bubbles': whether or not this event bubbles (true)
14022
Events can only bubble if emitFacade is true.
14025
'context': the default execution context for the listeners (this)
14028
'defaultFn': the default function to execute when this event fires if preventDefault was not called
14031
'emitFacade': whether or not this event emits a facade (false)
14034
'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
14037
'fireOnce': if an event is configured to fire once, new subscribers after
14038
the fire will be notified immediately.
14041
'async': fireOnce event listeners will fire synchronously if the event has already
14042
fired unless async is true.
14045
'preventable': whether or not preventDefault() has an effect (true)
14048
'preventedFn': a function that is executed when preventDefault is called
14051
'queuable': whether or not this event can be queued during bubbling (false)
14054
'silent': if silent is true, debug messages are not provided for this event.
14057
'stoppedFn': a function that is executed when stopPropagation is called
14061
'monitored': specifies whether or not this event should send notifications about
14062
when the event has been attached, detached, or published.
14065
'type': the event type (valid option if not provided as the first parameter to publish)
14078
<div class="returns">
14081
<div class="returns-description">
14084
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
14096
<div id="method_remove" class="method item inherited">
14097
<h3 class="name"><code>remove</code></h3>
14100
<span class="paren">()</span>
14114
<span class="flag chainable">chainable</span>
14121
<a href="../classes/View.html#method_remove">View</a>:
14125
<a href="../files/app_js_view.js.html#l263"><code>app/js/view.js:263</code></a>
14135
<div class="description">
14136
<p>Removes this view's container element from the DOM (if it's in the DOM),
14137
but doesn't destroy it or any event listeners attached to it.</p>
14148
<div id="method_removeAttr" class="method item inherited">
14149
<h3 class="name"><code>removeAttr</code></h3>
14153
<span class="paren">(</span><ul class="args-list inline commas">
14161
</ul><span class="paren">)</span>
14181
<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:
14185
<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>
14195
<div class="description">
14196
<p>Removes an attribute from the host object</p>
14200
<div class="params">
14201
<h4>Parameters:</h4>
14203
<ul class="params-list">
14207
<code class="param-name">name</code>
14208
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14213
<div class="param-description">
14214
<p>The name of the attribute to be removed.</p>
14230
<div id="method_removeQuery" class="method item inherited">
14231
<h3 class="name"><code>removeQuery</code></h3>
14235
<span class="paren">(</span><ul class="args-list inline commas">
14243
</ul><span class="paren">)</span>
14248
<span class="returns-inline">
14249
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14267
<a href="../classes/Router.html#method_removeQuery">Router</a>:
14271
<a href="../files/app_js_router.js.html#l295"><code>app/js/router.js:295</code></a>
14281
<div class="description">
14282
<p>Removes a query string from the end of the <em>url</em> (if one exists) and returns
14287
<div class="params">
14288
<h4>Parameters:</h4>
14290
<ul class="params-list">
14294
<code class="param-name">url</code>
14295
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14300
<div class="param-description">
14312
<div class="returns">
14315
<div class="returns-description">
14318
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
14330
<div id="method_removeRoot" class="method item inherited">
14331
<h3 class="name"><code>removeRoot</code></h3>
14335
<span class="paren">(</span><ul class="args-list inline commas">
14343
</ul><span class="paren">)</span>
14348
<span class="returns-inline">
14349
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14367
<a href="../classes/Router.html#method_removeRoot">Router</a>:
14371
<a href="../files/app_js_router.js.html#l273"><code>app/js/router.js:273</code></a>
14381
<div class="description">
14382
<p>Removes the <code>root</code> URL from the front of <em>url</em> (if it's there) and returns
14383
the result. The returned path will always have a leading <code>/</code>.</p>
14387
<div class="params">
14388
<h4>Parameters:</h4>
14390
<ul class="params-list">
14394
<code class="param-name">url</code>
14395
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14400
<div class="param-description">
14412
<div class="returns">
14415
<div class="returns-description">
14418
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
14430
<div id="method_removeTarget" class="method item inherited">
14431
<h3 class="name"><code>removeTarget</code></h3>
14435
<span class="paren">(</span><ul class="args-list inline commas">
14443
</ul><span class="paren">)</span>
14463
<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:
14467
<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>
14477
<div class="description">
14478
<p>Removes a bubble target</p>
14482
<div class="params">
14483
<h4>Parameters:</h4>
14485
<ul class="params-list">
14489
<code class="param-name">o</code>
14490
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
14495
<div class="param-description">
14496
<p>the target to remove</p>
14512
<div id="method_render" class="method item inherited">
14513
<h3 class="name"><code>render</code></h3>
14516
<span class="paren">()</span>
14530
<span class="flag chainable">chainable</span>
14536
<a href="../classes/View.html#method_render">
14544
<a href="../files/app_js_app-base.js.html#l266"><code>app/js/app-base.js:266</code></a>
14554
<div class="description">
14555
<p>Renders this application by appending the <code>viewContainer</code> node to the
14556
<code>container</code> node if it isn't already a child of the container, and the
14557
<code>activeView</code> will be appended the view container, if it isn't already.</p>
14559
<p>You should call this method at least once, usually after the initialization
14560
of your app instance so the proper DOM structure is setup and optionally
14561
append the container to the DOM if it's not there already.</p>
14563
<p>You may override this method to customize the app's rendering, but you
14564
should expect that the <code>viewContainer</code>'s contents will be modified by the
14565
app for the purpose of rendering the <code>activeView</code> when it changes.</p>
14576
<div id="method_replace" class="method item inherited">
14577
<h3 class="name"><code>replace</code></h3>
14581
<span class="paren">(</span><ul class="args-list inline commas">
14585
<code class="optional">[url]</code>
14589
</ul><span class="paren">)</span>
14604
<span class="flag chainable">chainable</span>
14611
<a href="../classes/Router.html#method_replace">Router</a>:
14615
<a href="../files/app_js_router.js.html#l307"><code>app/js/router.js:307</code></a>
14625
<div class="description">
14626
<p>Replaces the current browser history entry with a new one, and dispatches to
14627
the first matching route handler, if any.</p>
14629
<p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that
14630
support it (or the location hash in older browsers and IE) to change the
14633
<p>The specified URL must share the same origin (i.e., protocol, host, and
14634
port) as the current page, or an error will occur.</p>
14638
<div class="params">
14639
<h4>Parameters:</h4>
14641
<ul class="params-list">
14645
<code class="param-name optional">[url]</code>
14646
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14647
<span class="flag optional" title="This parameter is optional.">optional</span>
14652
<div class="param-description">
14653
<p>URL to set. This URL needs to be of the same origin as
14654
the current URL. This can be a URL relative to the router's <code>root</code>
14655
attribute. If no URL is specified, the page's current URL will be used.</p>
14668
<div class="example">
14671
<div class="example-content">
14672
<pre class="code"><code class="prettyprint">// Starting URL: http://example.com/
14674
router.replace('/path/');
14675
// New URL: http://example.com/path/
14677
router.replace('/path?foo=bar');
14678
// New URL: http://example.com/path?foo=bar
14680
router.replace('/');
14681
// New URL: http://example.com/
14689
<div id="method_reset" class="method item inherited">
14690
<h3 class="name"><code>reset</code></h3>
14694
<span class="paren">(</span><ul class="args-list inline commas">
14702
</ul><span class="paren">)</span>
14707
<span class="returns-inline">
14708
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14721
<span class="flag chainable">chainable</span>
14728
<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:
14732
<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>
14742
<div class="description">
14743
<p>Resets the attribute (or all attributes) to its initial value, as long as
14744
the attribute is not readOnly, or writeOnce.</p>
14748
<div class="params">
14749
<h4>Parameters:</h4>
14751
<ul class="params-list">
14755
<code class="param-name">name</code>
14756
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14761
<div class="param-description">
14762
<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>
14773
<div class="returns">
14776
<div class="returns-description">
14779
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
14781
A reference to the host object.
14791
<div id="method_route" class="method item inherited">
14792
<h3 class="name"><code>route</code></h3>
14796
<span class="paren">(</span><ul class="args-list inline commas">
14806
<code>callback</code>
14810
</ul><span class="paren">)</span>
14825
<span class="flag chainable">chainable</span>
14832
<a href="../classes/Router.html#method_route">Router</a>:
14836
<a href="../files/app_js_router.js.html#l341"><code>app/js/router.js:341</code></a>
14846
<div class="description">
14847
<p>Adds a route handler for the specified URL <em>path</em>.</p>
14849
<p>The <em>path</em> parameter may be either a string or a regular expression. If it's
14850
a string, it may contain named parameters: <code>:param</code> will match any single
14851
part of a URL path (not including <code>/</code> characters), and <code>*param</code> will match
14852
any number of parts of a URL path (including <code>/</code> characters). These named
14853
parameters will be made available as keys on the <code>req.params</code> object that's
14854
passed to route handlers.</p>
14856
<p>If the <em>path</em> parameter is a regex, all pattern matches will be made
14857
available as numbered keys on <code>req.params</code>, starting with <code>0</code> for the full
14858
match, then <code>1</code> for the first subpattern match, and so on.</p>
14860
<p>Here's a set of sample routes along with URL paths that they match:</p>
14863
<li><p>Route: <code>/photos/:tag/:page</code></p>
14865
<ul><li>URL: <code>/photos/kittens/1</code>, params: <code>{tag: 'kittens', page: '1'}</code></li>
14866
<li>URL: <code>/photos/puppies/2</code>, params: <code>{tag: 'puppies', page: '2'}</code></li></ul></li>
14867
<li><p>Route: <code>/file/*path</code></p>
14869
<ul><li>URL: <code>/file/foo/bar/baz.txt</code>, params: <code>{path: 'foo/bar/baz.txt'}</code></li>
14870
<li>URL: <code>/file/foo</code>, params: <code>{path: 'foo'}</code></li></ul></li>
14873
<p>If multiple route handlers match a given URL, they will be executed in the
14874
order they were added. The first route that was added will be the first to
14879
<div class="params">
14880
<h4>Parameters:</h4>
14882
<ul class="params-list">
14886
<code class="param-name">path</code>
14887
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
14892
<div class="param-description">
14893
<p>Path to match. May be a string or a regular
14902
<code class="param-name">callback</code>
14903
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14908
<div class="param-description">
14909
<p>Callback function to call whenever this
14910
route is triggered. If specified as a string, the named function will be
14911
called on this router instance.</p>
14915
<ul class="params-list">
14919
<code class="param-name">req</code>
14920
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14923
<div class="param-description">
14924
<p>Request object containing information about
14925
the request. It contains the following properties.</p>
14929
<ul class="params-list">
14933
<code class="param-name">params</code>
14934
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14937
<div class="param-description">
14938
Captured parameters matched by
14939
the route path specification. If a string path was used and contained
14940
named parameters, then this will be a key/value hash mapping parameter
14941
names to their matched values. If a regex path was used, this will be
14942
an array of subpattern matches starting at index 0 for the full match,
14943
then 1 for the first subpattern match, and so on.
14949
<code class="param-name">path</code>
14950
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14953
<div class="param-description">
14954
The current URL path.
14960
<code class="param-name">query</code>
14961
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14964
<div class="param-description">
14965
Query hash representing the URL query
14966
string, if any. Parameter names are keys, and are mapped to parameter
14973
<code class="param-name">url</code>
14974
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14977
<div class="param-description">
14984
<code class="param-name">src</code>
14985
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14988
<div class="param-description">
14989
What initiated the dispatch. In an
14990
HTML5 browser, when the back/forward buttons are used, this property
14991
will have a value of "popstate".
15001
<code class="param-name">res</code>
15002
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15005
<div class="param-description">
15006
<p>Response object containing methods and
15007
information that relate to responding to a request. It contains the
15008
following properties.</p>
15012
<ul class="params-list">
15016
<code class="param-name">req</code>
15017
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15020
<div class="param-description">
15021
Reference to the request object.
15031
<code class="param-name">next</code>
15032
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
15035
<div class="param-description">
15036
<p>Callback to pass control to the next
15037
matching route. If you don't call this function, then no further route
15038
handlers will be executed, even if there are more that match. If you do
15039
call this function, then the next matching route handler (if any) will
15040
be called, and will receive the same <code>req</code> object that was passed to
15041
this route (so you can use the request object to pass data along to
15042
subsequent routes).</p>
15059
<div class="example">
15062
<div class="example-content">
15063
<pre class="code"><code class="prettyprint">router.route('/photos/:tag/:page', function (req, res, next) {
15064
Y.log('Current tag: ' + req.params.tag);
15065
Y.log('Current page number: ' + req.params.page);
15074
<div id="method_save" class="method item inherited">
15075
<h3 class="name"><code>save</code></h3>
15079
<span class="paren">(</span><ul class="args-list inline commas">
15083
<code class="optional">[url]</code>
15087
</ul><span class="paren">)</span>
15102
<span class="flag chainable">chainable</span>
15109
<a href="../classes/Router.html#method_save">Router</a>:
15113
<a href="../files/app_js_router.js.html#l423"><code>app/js/router.js:423</code></a>
15123
<div class="description">
15124
<p>Saves a new browser history entry and dispatches to the first matching route
15125
handler, if any.</p>
15127
<p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that
15128
support it (or the location hash in older browsers and IE) to change the
15129
URL and create a history entry.</p>
15131
<p>The specified URL must share the same origin (i.e., protocol, host, and
15132
port) as the current page, or an error will occur.</p>
15136
<div class="params">
15137
<h4>Parameters:</h4>
15139
<ul class="params-list">
15143
<code class="param-name optional">[url]</code>
15144
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15145
<span class="flag optional" title="This parameter is optional.">optional</span>
15150
<div class="param-description">
15151
<p>URL to set. This URL needs to be of the same origin as
15152
the current URL. This can be a URL relative to the router's <code>root</code>
15153
attribute. If no URL is specified, the page's current URL will be used.</p>
15166
<div class="example">
15169
<div class="example-content">
15170
<pre class="code"><code class="prettyprint">// Starting URL: http://example.com/
15172
router.save('/path/');
15173
// New URL: http://example.com/path/
15175
router.save('/path?foo=bar');
15176
// New URL: http://example.com/path?foo=bar
15179
// New URL: http://example.com/
15187
<div id="method_set" class="method item inherited">
15188
<h3 class="name"><code>set</code></h3>
15192
<span class="paren">(</span><ul class="args-list inline commas">
15206
</ul><span class="paren">)</span>
15211
<span class="returns-inline">
15212
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15225
<span class="flag chainable">chainable</span>
15231
<a href="../classes/AttributeEvents.html#method_set">
15239
<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>
15249
<div class="description">
15250
<p>Sets the value of an attribute.</p>
15254
<div class="params">
15255
<h4>Parameters:</h4>
15257
<ul class="params-list">
15261
<code class="param-name">name</code>
15262
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15267
<div class="param-description">
15268
<p>The name of the attribute. If the
15269
current value of the attribute is an Object, dot notation can be used
15270
to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>
15278
<code class="param-name">value</code>
15279
<span class="type">Any</span>
15284
<div class="param-description">
15285
<p>The value to set the attribute to.</p>
15296
<div class="returns">
15299
<div class="returns-description">
15302
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
15304
A reference to the host object.
15314
<div id="method_setAttrs" class="method item inherited">
15315
<h3 class="name"><code>setAttrs</code></h3>
15319
<span class="paren">(</span><ul class="args-list inline commas">
15327
</ul><span class="paren">)</span>
15332
<span class="returns-inline">
15333
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15346
<span class="flag chainable">chainable</span>
15352
<a href="../classes/AttributeEvents.html#method_setAttrs">
15360
<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>
15370
<div class="description">
15371
<p>Sets multiple attribute values.</p>
15375
<div class="params">
15376
<h4>Parameters:</h4>
15378
<ul class="params-list">
15382
<code class="param-name">attrs</code>
15383
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15388
<div class="param-description">
15389
<p>An object with attributes name/value pairs.</p>
15400
<div class="returns">
15403
<div class="returns-description">
15406
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
15408
A reference to the host object.
15418
<div id="method_showView" class="method item inherited">
15419
<h3 class="name"><code>showView</code></h3>
15423
<span class="paren">(</span><ul class="args-list inline commas">
15433
<code class="optional">[config]</code>
15439
<code class="optional">[options]</code>
15445
<code class="optional">[callback]</code>
15449
</ul><span class="paren">)</span>
15464
<span class="flag chainable">chainable</span>
15470
<a href="../classes/App.Base.html#method_showView">
15478
<a href="../files/app_js_app-extensions_app-transitions.js.html#l145"><code>app/js/app-extensions/app-transitions.js:145</code></a>
15486
<p>Available since 3.5.0</p>
15490
<div class="description">
15491
<p>Sets which view is active/visible for the application. This will set the
15492
app's <code>activeView</code> attribute to the specified <code>view</code>.</p>
15494
<p>The <code>view</code> will be "attached" to this app, meaning it will be both rendered
15495
into this app's <code>viewContainer</code> node and all of its events will bubble to
15496
the app. The previous <code>activeView</code> will be "detached" from this app.</p>
15498
<p>When a string-name is provided for a view which has been registered on this
15499
app's <code>views</code> object, the referenced metadata will be used and the
15500
<code>activeView</code> will be set to either a preserved view instance, or a new
15501
instance of the registered view will be created using the specified <code>config</code>
15502
object passed-into this method.</p>
15504
<p>A callback function can be specified as either the third or fourth argument,
15505
and this function will be called after the new <code>view</code> becomes the
15506
<code>activeView</code>, is rendered to the <code>viewContainer</code>, and is ready to use.</p>
15510
<div class="params">
15511
<h4>Parameters:</h4>
15513
<ul class="params-list">
15517
<code class="param-name">view</code>
15518
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/View.html" class="crosslink">View</a></span>
15523
<div class="param-description">
15524
<p>The name of a view defined in the <code>views</code> object,
15525
or a view instance which should become this app's <code>activeView</code>.</p>
15533
<code class="param-name optional">[config]</code>
15534
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15535
<span class="flag optional" title="This parameter is optional.">optional</span>
15540
<div class="param-description">
15541
<p>Optional configuration to use when creating a new
15542
view instance. This config object can also be used to update an existing
15543
or preserved view's attributes when <code>options.update</code> is <code>true</code>.</p>
15551
<code class="param-name optional">[options]</code>
15552
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15553
<span class="flag optional" title="This parameter is optional.">optional</span>
15558
<div class="param-description">
15559
<p>Optional object containing any of the following
15564
<ul class="params-list">
15568
<code class="param-name optional">[callback]</code>
15569
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
15570
<span class="flag optional" title="This parameter is optional.">optional</span>
15573
<div class="param-description">
15574
<p>Optional callback function to call
15575
after new <code>activeView</code> is ready to use, the function will be passed:</p>
15579
<ul class="params-list">
15583
<code class="param-name">view</code>
15584
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
15587
<div class="param-description">
15588
A reference to the new
15589
<code>activeView</code>.
15599
<code class="param-name optional">[prepend=false]</code>
15600
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15601
<span class="flag optional" title="This parameter is optional.">optional</span>
15604
<div class="param-description">
15605
<p>Whether the <code>view</code> should be
15606
prepended instead of appended to the <code>viewContainer</code>.</p>
15614
<code class="param-name optional">[render]</code>
15615
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15616
<span class="flag optional" title="This parameter is optional.">optional</span>
15619
<div class="param-description">
15620
<p>Whether the <code>view</code> should be rendered.
15621
<strong>Note:</strong> If no value is specified, a view instance will only be
15622
rendered if it's newly created by this method.</p>
15630
<code class="param-name optional">[transition]</code>
15631
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15632
<span class="flag optional" title="This parameter is optional.">optional</span>
15635
<div class="param-description">
15636
<p>Optional transition override.
15637
A transition can be specified which will override the default, or
15638
<code>false</code> for no transition.</p>
15646
<code class="param-name optional">[update=false]</code>
15647
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15648
<span class="flag optional" title="This parameter is optional.">optional</span>
15651
<div class="param-description">
15652
<p>Whether an existing view should
15653
have its attributes updated by passing the <code>config</code> object to its
15654
<code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if
15655
the <code>view</code> instance is created as a result of calling this method.</p>
15667
<code class="param-name optional">[callback]</code>
15668
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
15669
<span class="flag optional" title="This parameter is optional.">optional</span>
15674
<div class="param-description">
15675
<p>Optional callback Function to call after the
15676
new <code>activeView</code> is ready to use. <strong>Note:</strong> this will override
15677
<code>options.callback</code> and it can be specified as either the third or fourth
15678
argument. The function will be passed the following:</p>
15682
<ul class="params-list">
15686
<code class="param-name">view</code>
15687
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
15690
<div class="param-description">
15691
<p>A reference to the new <code>activeView</code>.</p>
15708
<div class="example">
15711
<div class="example-content">
15712
<pre class="code"><code class="prettyprint">var app = new Y.App({
15715
// Imagine that <code>Y.UsersView</code> has been defined.
15721
users : new Y.ModelList()
15724
app.route('/users/', function () {
15725
this.showView('usersView', {users: this.get('users')});
15729
app.navigate('/uses/');
15730
// => Creates a new <code>Y.UsersView</code> and transitions to it.
15738
<div id="method_subscribe" class="method item deprecated inherited">
15739
<h3 class="name"><code>subscribe</code></h3>
15742
<span class="paren">()</span>
15748
<span class="flag deprecated" title="use on">deprecated</span>
15763
<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:
15767
<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>
15773
<p>Deprecated: use on</p>
15779
<div class="description">
15780
<p>subscribe to an event</p>
15791
<div id="method_toString" class="method item inherited">
15792
<h3 class="name"><code>toString</code></h3>
15795
<span class="paren">()</span>
15799
<span class="returns-inline">
15800
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15818
<a href="../classes/BaseCore.html#method_toString">BaseCore</a>:
15822
<a href="../files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a>
15832
<div class="description">
15833
<p>Default toString implementation. Provides the constructor NAME
15834
and the instance guid, if set.</p>
15840
<div class="returns">
15843
<div class="returns-description">
15846
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
15848
String representation for this object
15858
<div id="method_unsubscribe" class="method item deprecated inherited">
15859
<h3 class="name"><code>unsubscribe</code></h3>
15862
<span class="paren">()</span>
15868
<span class="flag deprecated" title="use detach">deprecated</span>
15883
<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
15887
<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>
15893
<p>Deprecated: use detach</p>
15899
<div class="description">
15900
<p>detach a listener</p>
15911
<div id="method_unsubscribeAll" class="method item deprecated inherited">
15912
<h3 class="name"><code>unsubscribeAll</code></h3>
15916
<span class="paren">(</span><ul class="args-list inline commas">
15924
</ul><span class="paren">)</span>
15931
<span class="flag deprecated" title="use detachAll">deprecated</span>
15946
<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
15950
<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>
15956
<p>Deprecated: use detachAll</p>
15962
<div class="description">
15963
<p>Removes all listeners from the specified event. If the event type
15964
is not specified, all listeners from all hosted custom events will
15969
<div class="params">
15970
<h4>Parameters:</h4>
15972
<ul class="params-list">
15976
<code class="param-name">type</code>
15977
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15982
<div class="param-description">
15983
<p>The type, or name of the event</p>
15999
<div id="method_upgrade" class="method item inherited">
16000
<h3 class="name"><code>upgrade</code></h3>
16003
<span class="paren">()</span>
16007
<span class="returns-inline">
16008
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16026
<a href="../classes/Router.html#method_upgrade">Router</a>:
16030
<a href="../files/app_js_router.js.html#l457"><code>app/js/router.js:457</code></a>
16040
<div class="description">
16041
<p>Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5
16042
browsers, this method is a noop.</p>
16048
<div class="returns">
16051
<div class="returns-description">
16054
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
16056
<code>true</code> if the URL was upgraded, <code>false</code> otherwise.
16070
<div id="properties" class="api-class-tabpanel">
16071
<h2 class="off-left">Properties</h2>
16074
<div id="property__allowAdHocAttrs" class="property item protected inherited">
16075
<h3 class="name"><code>_allowAdHocAttrs</code></h3>
16076
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16081
<span class="flag protected">protected</span>
16091
<a href="../classes/BaseCore.html#property__allowAdHocAttrs">
16099
<a href="../files/app_js_view.js.html#l111"><code>app/js/view.js:111</code></a>
16106
<p>Available since 3.5.0</p>
16110
<div class="description">
16111
<p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config
16112
properties passed to View's constructor. This makes it possible to
16113
instantiate a view and set a bunch of attributes without having to subclass
16114
<code>Y.View</code> and declare all those attributes first.</p>
16118
<p><strong>Default:</strong> true</p>
16127
<div id="property__dispatched" class="property item protected inherited">
16128
<h3 class="name"><code>_dispatched</code></h3>
16129
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16134
<span class="flag protected">protected</span>
16145
<a href="../classes/Router.html#property__dispatched">Router</a>:
16149
<a href="../files/app_js_router.js.html#l60"><code>app/js/router.js:60</code></a>
16158
<div class="description">
16159
<p>Whether or not <code>_dispatch()</code> has been called since this router was
16164
<p><strong>Default:</strong> undefined</p>
16173
<div id="property__dispatching" class="property item protected inherited">
16174
<h3 class="name"><code>_dispatching</code></h3>
16175
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16180
<span class="flag protected">protected</span>
16191
<a href="../classes/Router.html#property__dispatching">Router</a>:
16195
<a href="../files/app_js_router.js.html#l70"><code>app/js/router.js:70</code></a>
16204
<div class="description">
16205
<p>Whether or not we're currently in the process of dispatching to routes.</p>
16209
<p><strong>Default:</strong> undefined</p>
16218
<div id="property__html5" class="property item protected inherited">
16219
<h3 class="name"><code>_html5</code></h3>
16220
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16225
<span class="flag protected">protected</span>
16236
<a href="../classes/Router.html#property__html5">Router</a>:
16240
<a href="../files/app_js_router.js.html#l79"><code>app/js/router.js:79</code></a>
16249
<div class="description">
16250
<p>Cached copy of the <code>html5</code> attribute for internal use.</p>
16261
<div id="property__pjaxEvents" class="property item protected inherited">
16262
<h3 class="name"><code>_pjaxEvents</code></h3>
16263
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
16268
<span class="flag protected">protected</span>
16279
<a href="../classes/PjaxBase.html#property__pjaxEvents">PjaxBase</a>:
16283
<a href="../files/pjax_js_pjax-base.js.html#l71"><code>pjax/js/pjax-base.js:71</code></a>
16290
<p>Available since 3.5.0</p>
16294
<div class="description">
16295
<p>Holds the delegated pjax-link click handler.</p>
16306
<div id="property__ready" class="property item protected inherited">
16307
<h3 class="name"><code>_ready</code></h3>
16308
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16313
<span class="flag protected">protected</span>
16324
<a href="../classes/Router.html#property__ready">Router</a>:
16328
<a href="../files/app_js_router.js.html#l87"><code>app/js/router.js:87</code></a>
16337
<div class="description">
16338
<p>Whether or not the <code>ready</code> event has fired yet.</p>
16342
<p><strong>Default:</strong> undefined</p>
16351
<div id="property__regexPathParam" class="property item protected inherited">
16352
<h3 class="name"><code>_regexPathParam</code></h3>
16353
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
16358
<span class="flag protected">protected</span>
16369
<a href="../classes/Router.html#property__regexPathParam">Router</a>:
16373
<a href="../files/app_js_router.js.html#l96"><code>app/js/router.js:96</code></a>
16382
<div class="description">
16383
<p>Regex used to match parameter placeholders in route paths.</p>
16385
<p>Subpattern captures:</p>
16388
<li><p>Parameter prefix character. Either a <code>:</code> for subpath parameters that
16389
should only match a single level of a path, or <code>*</code> for splat parameters
16390
that should match any number of path levels.</p></li>
16391
<li><p>Parameter name, if specified, otherwise it is a wildcard match.</p></li>
16403
<div id="property__regexURL" class="property item protected inherited">
16404
<h3 class="name"><code>_regexURL</code></h3>
16405
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
16410
<span class="flag protected">protected</span>
16421
<a href="../classes/PjaxBase.html#property__regexURL">PjaxBase</a>:
16425
<a href="../files/pjax_js_pjax-base.js.html#l80"><code>pjax/js/pjax-base.js:80</code></a>
16432
<p>Available since 3.5.0</p>
16436
<div class="description">
16437
<p>Regex used to break up a URL string around the URL's path.</p>
16439
<p>Subpattern captures:</p>
16442
<li>Origin, everything before the URL's path-part.</li>
16443
<li>The URL's path-part.</li>
16444
<li>Suffix, everything after the URL's path-part.</li>
16456
<div id="property__regexUrlOrigin" class="property item protected inherited">
16457
<h3 class="name"><code>_regexUrlOrigin</code></h3>
16458
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
16463
<span class="flag protected">protected</span>
16474
<a href="../classes/Router.html#property__regexUrlOrigin">Router</a>:
16478
<a href="../files/app_js_router.js.html#l123"><code>app/js/router.js:123</code></a>
16487
<div class="description">
16488
<p>Regex that matches everything before the path portion of a URL (the origin).
16489
This will be used to strip this part of the URL from a string when we
16490
only want the path.</p>
16501
<div id="property__regexUrlQuery" class="property item protected inherited">
16502
<h3 class="name"><code>_regexUrlQuery</code></h3>
16503
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
16508
<span class="flag protected">protected</span>
16519
<a href="../classes/Router.html#property__regexUrlQuery">Router</a>:
16523
<a href="../files/app_js_router.js.html#l113"><code>app/js/router.js:113</code></a>
16532
<div class="description">
16533
<p>Regex that matches and captures the query portion of a URL, minus the
16534
preceding <code>?</code> character, and discarding the hash portion of the URL if any.</p>
16545
<div id="property__viewInfoMap" class="property item protected inherited">
16546
<h3 class="name"><code>_viewInfoMap</code></h3>
16547
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
16552
<span class="flag protected">protected</span>
16563
<a href="../classes/App.Base.html#property__viewInfoMap">App.Base</a>:
16567
<a href="../files/app_js_app-base.js.html#l134"><code>app/js/app-base.js:134</code></a>
16574
<p>Available since 3.5.0</p>
16578
<div class="description">
16579
<p>Map of view instance id (via <code>Y.stamp()</code>) to view-info object in <code>views</code>.</p>
16581
<p>This mapping is used to tie a specific view instance back to its metadata by
16582
adding a reference to the the related view info on the <code>views</code> object.</p>
16586
<p><strong>Default:</strong> {}</p>
16595
<div id="property_containerTemplate" class="property item inherited">
16596
<h3 class="name"><code>containerTemplate</code></h3>
16597
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16611
<a href="../classes/View.html#property_containerTemplate">View</a>:
16615
<a href="../files/app_js_view.js.html#l40"><code>app/js/view.js:40</code></a>
16622
<p>Available since 3.5.0</p>
16626
<div class="description">
16627
<p>Template for this view's container.</p>
16631
<p><strong>Default:</strong> "<div/>"</p>
16640
<div id="property_events" class="property item inherited">
16641
<h3 class="name"><code>events</code></h3>
16642
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
16656
<a href="../classes/View.html#property_events">View</a>:
16660
<a href="../files/app_js_view.js.html#l50"><code>app/js/view.js:50</code></a>
16669
<div class="description">
16670
<p>Hash of CSS selectors mapped to events to delegate to elements matching
16671
those selectors.</p>
16673
<p>CSS selectors are relative to the <code>container</code> element. Events are attached
16674
to the container, and delegation is used so that subscribers are only
16675
notified of events that occur on elements inside the container that match
16676
the specified selectors. This allows the container's contents to be re-
16677
rendered as needed without losing event subscriptions.</p>
16679
<p>Event handlers can be specified either as functions or as strings that map
16680
to function names on this view instance or its prototype.</p>
16682
<p>The <code>this</code> object in event handlers will refer to this view instance. If
16683
you'd prefer <code>this</code> to be something else, use <code>Y.bind()</code> to bind a custom
16684
<code>this</code> object.</p>
16688
<p><strong>Default:</strong> {}</p>
16692
<div class="example">
16695
<div class="example-content">
16696
<pre class="code"><code class="prettyprint">var view = new Y.View({
16698
// Call <code>this.toggle()</code> whenever the element with the id
16699
// "toggle-button" is clicked.
16700
'#toggle-button': {click: 'toggle'},
16702
// Call <code>this.hoverOn()</code> when the mouse moves over any element
16703
// with the "hoverable" class, and <code>this.hoverOff()</code> when the
16704
// mouse moves out of any element with the "hoverable" class.
16706
mouseover: 'hoverOn',
16707
mouseout : 'hoverOff'
16720
<div id="property_name" class="property item deprecated inherited">
16721
<h3 class="name"><code>name</code></h3>
16722
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16725
<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>
16738
<a href="../classes/BaseCore.html#property_name">BaseCore</a>:
16742
<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>
16747
<p>Deprecated: Use this.constructor.NAME</p>
16753
<div class="description">
16754
<p>The string used to identify the class of this object.</p>
16765
<div id="property_template" class="property item inherited">
16766
<h3 class="name"><code>template</code></h3>
16767
<span class="type">Mixed</span>
16781
<a href="../classes/View.html#property_template">View</a>:
16785
<a href="../files/app_js_view.js.html#l91"><code>app/js/view.js:91</code></a>
16794
<div class="description">
16795
<p>Template for this view's contents.</p>
16797
<p>This is a convenience property that has no default behavior of its own.
16798
It's only provided as a convention to allow you to store whatever you
16799
consider to be a template, whether that's an HTML string, a <code>Y.Node</code>
16800
instance, a Mustache template, or anything else your little heart
16803
<p>How this template gets used is entirely up to you and your custom
16804
<code>render()</code> method.</p>
16808
<p><strong>Default:</strong> ''</p>
16817
<div id="property_transitions" class="property item inherited">
16818
<h3 class="name"><code>transitions</code></h3>
16819
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
16833
<a href="../classes/App.Transitions.html#property_transitions">App.Transitions</a>:
16837
<a href="../files/app_js_app-extensions_app-transitions.js.html#l107"><code>app/js/app-extensions/app-transitions.js:107</code></a>
16844
<p>Available since 3.5.0</p>
16848
<div class="description">
16849
<p>Default transitions to use when the <code>activeView</code> changes.</p>
16851
<p>The following are types of changes for which transitions can be defined that
16852
correspond to the relationship between the new and previous <code>activeView</code>:</p>
16855
<li><p><code>navigate</code>: The default transition to use when changing the <code>activeView</code>
16856
of the application.</p></li>
16857
<li><p><code>toChild</code>: The transition to use when the new <code>activeView</code> is configured
16858
as a child of the previously active view via its <code>parent</code> property as
16859
defined in this app's <code>views</code>.</p></li>
16860
<li><p><code>toParent</code>: The transition to use when the new <code>activeView</code> is
16861
configured as the <code>parent</code> of the previously active view as defined in
16862
this app's <code>views</code>.</p></li>
16865
<p><strong>Note:</strong> Transitions are an opt-in feature and will only be used in
16866
browsers which support native CSS3 transitions.</p>
16870
<p><strong>Default:</strong> {
16871
navigate: 'fade',
16872
toChild : 'slideLeft',
16873
toParent: 'slideRight'
16883
<div id="property_views" class="property item inherited">
16884
<h3 class="name"><code>views</code></h3>
16885
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
16899
<a href="../classes/App.Base.html#property_views">App.Base</a>:
16903
<a href="../files/app_js_app-base.js.html#l76"><code>app/js/app-base.js:76</code></a>
16910
<p>Available since 3.5.0</p>
16914
<div class="description">
16915
<p>Hash of view-name to metadata used to declaratively describe an
16916
application's views and their relationship with the app and its other views.</p>
16918
<p>The view metadata is composed of Objects keyed to a view-name that can have
16919
any or all of the following properties:</p>
16922
<li><p><code>type</code>: Function or a string representing the view constructor to use to
16923
create view instances. If a string is used, the constructor function is
16924
assumed to be on the <code>Y</code> object; e.g. <code>"SomeView"</code> -> <code>Y.SomeView</code>.</p></li>
16925
<li><p><code>preserve</code>: Boolean for whether the view instance should be retained. By
16926
default, the view instance will be destroyed when it is no longer the
16927
<code>activeView</code>. If <code>true</code> the view instance will simply be <code>removed()</code>
16928
from the DOM when it is no longer active. This is useful when the view
16929
is frequently used and may be expensive to re-create.</p></li>
16930
<li><p><code>parent</code>: String to another named view in this hash that represents the
16931
parent view within the application's view hierarchy; e.g. a <code>"photo"</code>
16932
view could have <code>"album"</code> has its <code>parent</code> view. This parent/child
16933
relationship is a useful cue for things like transitions.</p></li>
16934
<li><p><code>instance</code>: Used internally to manage the current instance of this named
16935
view. This can be used if your view instance is created up-front, or if
16936
you would rather manage the View lifecycle, but you probably should just
16937
let this be handled for you.</p></li>
16940
<p>If <code>views</code> are specified at instantiation time, the metadata in the <code>views</code>
16941
Object here will be used as defaults when creating the instance's <code>views</code>.</p>
16943
<p>Every <code>Y.App</code> instance gets its own copy of a <code>views</code> object so this Object
16944
on the prototype will not be polluted.</p>
16948
<p><strong>Default:</strong> {}</p>
16952
<div class="example">
16955
<div class="example-content">
16956
<pre class="code"><code class="prettyprint">// Imagine that <code>Y.UsersView</code> and <code>Y.UserView</code> have been defined.
16957
var app = new Y.App({
16960
type : Y.UsersView,
16983
<div id="attrs" class="api-class-tabpanel">
16984
<h2 class="off-left">Attributes</h2>
16987
<div id="attr_activeView" class="attr item inherited">
16988
<a name="config_activeView"></a>
16989
<h3 class="name"><code>activeView</code></h3>
16990
<span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
17004
<a href="../classes/App.Base.html#attr_activeView">App.Base</a>:
17008
<a href="../files/app_js_app-base.js.html#l858"><code>app/js/app-base.js:858</code></a>
17015
<p>Available since 3.5.0</p>
17019
<div class="description">
17020
<p>The application's active/visible view.</p>
17022
<p>This attribute is read-only, to set the <code>activeView</code> use the
17023
<code>showView()</code> method.</p>
17027
<p><strong>Default:</strong> null</p>
17031
<div class="emits box">
17032
<h4>Fires event <code>activeViewChange</code></h4>
17035
Fires when the value for the configuration attribute <code>activeView</code> is
17036
changed. You can listen for the event using the <code>on</code> method if you
17037
wish to be notified before the attribute's value has changed, or
17038
using the <code>after</code> method if you wish to be notified after the
17039
attribute's value has changed.
17042
<div class="params">
17043
<h4>Parameters:</h4>
17045
<ul class="params-list">
17047
<code class="param-name">e</code>
17048
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17050
<div class="param-description">
17051
An Event Facade object with the following
17052
attribute-specific properties added:
17055
<ul class="params-list">
17057
<code class="param-name">prevVal</code>
17058
<span class="type">Any</span>
17059
<div class="param-description">The value of the attribute, prior to it being set.</div>
17062
<code class="param-name">newVal</code>
17063
<span class="type">Any</span>
17064
<div class="param-description">The value the attribute is to be set to.</div>
17067
<code class="param-name">attrName</code>
17068
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17069
<div class="param-description">The name of the attribute being set.</div>
17072
<code class="param-name">subAttrName</code>
17073
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17074
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17087
<div id="attr_container" class="attr item inherited">
17088
<a name="config_container"></a>
17089
<h3 class="name"><code>container</code></h3>
17090
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17103
<a href="../classes/View.html#attr_container">
17111
<a href="../files/app_js_app-base.js.html#l876"><code>app/js/app-base.js:876</code></a>
17120
<div class="description">
17121
<p>Container node which represents the application's bounding-box, into
17122
which this app's content will be rendered.</p>
17124
<p>The container node serves as the host for all DOM events attached by the
17125
app. Delegation is used to handle events on children of the container,
17126
allowing the container's contents to be re-rendered at any time without
17127
losing event subscriptions.</p>
17129
<p>The default container is the <code><body></code> Node, but you can override this in
17130
a subclass, or by passing in a custom <code>container</code> config value at
17131
instantiation time.</p>
17133
<p>When <code>container</code> is overridden by a subclass or passed as a config
17134
option at instantiation time, it may be provided as a selector string, a
17135
DOM element, or a <code>Y.Node</code> instance. During initialization, this app's
17136
<code>create()</code> method will be called to convert the container into a
17137
<code>Y.Node</code> instance if it isn't one already and stamp it with the CSS
17138
class: <code>"yui3-app"</code>.</p>
17140
<p>The container is not added to the page automatically. This allows you to
17141
have full control over how and when your app is actually rendered to
17146
<p><strong>Default:</strong> Y.one('body')</p>
17150
<div class="emits box">
17151
<h4>Fires event <code>containerChange</code></h4>
17154
Fires when the value for the configuration attribute <code>container</code> is
17155
changed. You can listen for the event using the <code>on</code> method if you
17156
wish to be notified before the attribute's value has changed, or
17157
using the <code>after</code> method if you wish to be notified after the
17158
attribute's value has changed.
17161
<div class="params">
17162
<h4>Parameters:</h4>
17164
<ul class="params-list">
17166
<code class="param-name">e</code>
17167
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17169
<div class="param-description">
17170
An Event Facade object with the following
17171
attribute-specific properties added:
17174
<ul class="params-list">
17176
<code class="param-name">prevVal</code>
17177
<span class="type">Any</span>
17178
<div class="param-description">The value of the attribute, prior to it being set.</div>
17181
<code class="param-name">newVal</code>
17182
<span class="type">Any</span>
17183
<div class="param-description">The value the attribute is to be set to.</div>
17186
<code class="param-name">attrName</code>
17187
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17188
<div class="param-description">The name of the attribute being set.</div>
17191
<code class="param-name">subAttrName</code>
17192
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17193
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17206
<div id="attr_destroyed" class="attr item inherited">
17207
<a name="config_destroyed"></a>
17208
<h3 class="name"><code>destroyed</code></h3>
17209
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
17223
<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:
17227
<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>
17236
<div class="description">
17237
<p>Flag indicating whether or not this object
17238
has been through the destroy lifecycle phase.</p>
17242
<p><strong>Default:</strong> false</p>
17246
<div class="emits box">
17247
<h4>Fires event <code>destroyedChange</code></h4>
17250
Fires when the value for the configuration attribute <code>destroyed</code> is
17251
changed. You can listen for the event using the <code>on</code> method if you
17252
wish to be notified before the attribute's value has changed, or
17253
using the <code>after</code> method if you wish to be notified after the
17254
attribute's value has changed.
17257
<div class="params">
17258
<h4>Parameters:</h4>
17260
<ul class="params-list">
17262
<code class="param-name">e</code>
17263
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17265
<div class="param-description">
17266
An Event Facade object with the following
17267
attribute-specific properties added:
17270
<ul class="params-list">
17272
<code class="param-name">prevVal</code>
17273
<span class="type">Any</span>
17274
<div class="param-description">The value of the attribute, prior to it being set.</div>
17277
<code class="param-name">newVal</code>
17278
<span class="type">Any</span>
17279
<div class="param-description">The value the attribute is to be set to.</div>
17282
<code class="param-name">attrName</code>
17283
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17284
<div class="param-description">The name of the attribute being set.</div>
17287
<code class="param-name">subAttrName</code>
17288
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17289
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17302
<div id="attr_html5" class="attr item inherited">
17303
<a name="config_html5"></a>
17304
<h3 class="name"><code>html5</code></h3>
17305
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
17318
<a href="../classes/Router.html#attr_html5">
17326
<a href="../files/app_js_app-base.js.html#l911"><code>app/js/app-base.js:911</code></a>
17335
<div class="description">
17336
<p>Whether or not this browser is capable of using HTML5 history.</p>
17338
<p>This value is dependent on the value of <code>serverRouting</code> and will default
17341
<p>Setting this to <code>false</code> will force the use of hash-based history even on
17342
HTML5 browsers, but please don't do this unless you understand the
17349
<div class="emits box">
17350
<h4>Fires event <code>html5Change</code></h4>
17353
Fires when the value for the configuration attribute <code>html5</code> is
17354
changed. You can listen for the event using the <code>on</code> method if you
17355
wish to be notified before the attribute's value has changed, or
17356
using the <code>after</code> method if you wish to be notified after the
17357
attribute's value has changed.
17360
<div class="params">
17361
<h4>Parameters:</h4>
17363
<ul class="params-list">
17365
<code class="param-name">e</code>
17366
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17368
<div class="param-description">
17369
An Event Facade object with the following
17370
attribute-specific properties added:
17373
<ul class="params-list">
17375
<code class="param-name">prevVal</code>
17376
<span class="type">Any</span>
17377
<div class="param-description">The value of the attribute, prior to it being set.</div>
17380
<code class="param-name">newVal</code>
17381
<span class="type">Any</span>
17382
<div class="param-description">The value the attribute is to be set to.</div>
17385
<code class="param-name">attrName</code>
17386
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17387
<div class="param-description">The name of the attribute being set.</div>
17390
<code class="param-name">subAttrName</code>
17391
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17392
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17405
<div id="attr_initialized" class="attr item inherited">
17406
<a name="config_initialized"></a>
17407
<h3 class="name"><code>initialized</code></h3>
17408
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
17422
<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:
17426
<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>
17435
<div class="description">
17436
<p>Flag indicating whether or not this object
17437
has been through the init lifecycle phase.</p>
17441
<p><strong>Default:</strong> false</p>
17445
<div class="emits box">
17446
<h4>Fires event <code>initializedChange</code></h4>
17449
Fires when the value for the configuration attribute <code>initialized</code> is
17450
changed. You can listen for the event using the <code>on</code> method if you
17451
wish to be notified before the attribute's value has changed, or
17452
using the <code>after</code> method if you wish to be notified after the
17453
attribute's value has changed.
17456
<div class="params">
17457
<h4>Parameters:</h4>
17459
<ul class="params-list">
17461
<code class="param-name">e</code>
17462
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17464
<div class="param-description">
17465
An Event Facade object with the following
17466
attribute-specific properties added:
17469
<ul class="params-list">
17471
<code class="param-name">prevVal</code>
17472
<span class="type">Any</span>
17473
<div class="param-description">The value of the attribute, prior to it being set.</div>
17476
<code class="param-name">newVal</code>
17477
<span class="type">Any</span>
17478
<div class="param-description">The value the attribute is to be set to.</div>
17481
<code class="param-name">attrName</code>
17482
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17483
<div class="param-description">The name of the attribute being set.</div>
17486
<code class="param-name">subAttrName</code>
17487
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17488
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17501
<div id="attr_linkSelector" class="attr item inherited">
17502
<a name="config_linkSelector"></a>
17503
<h3 class="name"><code>linkSelector</code></h3>
17504
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
17517
<a href="../classes/PjaxBase.html#attr_linkSelector">
17525
<a href="../files/app_js_app-base.js.html#l930"><code>app/js/app-base.js:930</code></a>
17534
<div class="description">
17535
<p>CSS selector string used to filter link click events so that only the
17536
links which match it will have the enhanced-navigation behavior of pjax
17539
<p>When a link is clicked and that link matches this selector, navigating
17540
to the link's <code>href</code> URL using the enhanced, pjax, behavior will be
17541
attempted; and the browser's default way to navigate to new pages will
17542
be the fallback.</p>
17544
<p>By default this selector will match <em>all</em> links on the page.</p>
17548
<p><strong>Default:</strong> "a"</p>
17552
<div class="emits box">
17553
<h4>Fires event <code>linkSelectorChange</code></h4>
17556
Fires when the value for the configuration attribute <code>linkSelector</code> is
17557
changed. You can listen for the event using the <code>on</code> method if you
17558
wish to be notified before the attribute's value has changed, or
17559
using the <code>after</code> method if you wish to be notified after the
17560
attribute's value has changed.
17563
<div class="params">
17564
<h4>Parameters:</h4>
17566
<ul class="params-list">
17568
<code class="param-name">e</code>
17569
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17571
<div class="param-description">
17572
An Event Facade object with the following
17573
attribute-specific properties added:
17576
<ul class="params-list">
17578
<code class="param-name">prevVal</code>
17579
<span class="type">Any</span>
17580
<div class="param-description">The value of the attribute, prior to it being set.</div>
17583
<code class="param-name">newVal</code>
17584
<span class="type">Any</span>
17585
<div class="param-description">The value the attribute is to be set to.</div>
17588
<code class="param-name">attrName</code>
17589
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17590
<div class="param-description">The name of the attribute being set.</div>
17593
<code class="param-name">subAttrName</code>
17594
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17595
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17608
<div id="attr_navigateOnHash" class="attr item inherited">
17609
<a name="config_navigateOnHash"></a>
17610
<h3 class="name"><code>navigateOnHash</code></h3>
17611
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
17625
<a href="../classes/PjaxBase.html#attr_navigateOnHash">PjaxBase</a>:
17629
<a href="../files/pjax_js_pjax-base.js.html#l472"><code>pjax/js/pjax-base.js:472</code></a>
17636
<p>Available since 3.5.0</p>
17640
<div class="description">
17641
<p>Whether navigating to a hash-fragment identifier on the current page should
17642
be enhanced and cause the <code>navigate</code> event to fire.</p>
17644
<p>By default Pjax allows the browser to perform its default action when a user
17645
is navigating within a page by clicking in-page links
17646
(e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or
17647
enhance in-page navigation.</p>
17651
<p><strong>Default:</strong> false</p>
17655
<div class="emits box">
17656
<h4>Fires event <code>navigateOnHashChange</code></h4>
17659
Fires when the value for the configuration attribute <code>navigateOnHash</code> is
17660
changed. You can listen for the event using the <code>on</code> method if you
17661
wish to be notified before the attribute's value has changed, or
17662
using the <code>after</code> method if you wish to be notified after the
17663
attribute's value has changed.
17666
<div class="params">
17667
<h4>Parameters:</h4>
17669
<ul class="params-list">
17671
<code class="param-name">e</code>
17672
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17674
<div class="param-description">
17675
An Event Facade object with the following
17676
attribute-specific properties added:
17679
<ul class="params-list">
17681
<code class="param-name">prevVal</code>
17682
<span class="type">Any</span>
17683
<div class="param-description">The value of the attribute, prior to it being set.</div>
17686
<code class="param-name">newVal</code>
17687
<span class="type">Any</span>
17688
<div class="param-description">The value the attribute is to be set to.</div>
17691
<code class="param-name">attrName</code>
17692
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17693
<div class="param-description">The name of the attribute being set.</div>
17696
<code class="param-name">subAttrName</code>
17697
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17698
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17711
<div id="attr_root" class="attr item inherited">
17712
<a name="config_root"></a>
17713
<h3 class="name"><code>root</code></h3>
17714
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17728
<a href="../classes/Router.html#attr_root">Router</a>:
17732
<a href="../files/app_js_router.js.html#l1007"><code>app/js/router.js:1007</code></a>
17741
<div class="description">
17742
<p>Absolute root path from which all routes should be evaluated.</p>
17744
<p>For example, if your router is running on a page at
17745
<code>http://example.com/myapp/</code> and you add a route with the path <code>/</code>, your
17746
route will never execute, because the path will always be preceded by
17747
<code>/myapp</code>. Setting <code>root</code> to <code>/myapp</code> would cause all routes to be
17748
evaluated relative to that root URL, so the <code>/</code> route would then execute
17749
when the user browses to <code>http://example.com/myapp/</code>.</p>
17753
<p><strong>Default:</strong> `''`</p>
17757
<div class="emits box">
17758
<h4>Fires event <code>rootChange</code></h4>
17761
Fires when the value for the configuration attribute <code>root</code> is
17762
changed. You can listen for the event using the <code>on</code> method if you
17763
wish to be notified before the attribute's value has changed, or
17764
using the <code>after</code> method if you wish to be notified after the
17765
attribute's value has changed.
17768
<div class="params">
17769
<h4>Parameters:</h4>
17771
<ul class="params-list">
17773
<code class="param-name">e</code>
17774
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17776
<div class="param-description">
17777
An Event Facade object with the following
17778
attribute-specific properties added:
17781
<ul class="params-list">
17783
<code class="param-name">prevVal</code>
17784
<span class="type">Any</span>
17785
<div class="param-description">The value of the attribute, prior to it being set.</div>
17788
<code class="param-name">newVal</code>
17789
<span class="type">Any</span>
17790
<div class="param-description">The value the attribute is to be set to.</div>
17793
<code class="param-name">attrName</code>
17794
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17795
<div class="param-description">The name of the attribute being set.</div>
17798
<code class="param-name">subAttrName</code>
17799
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17800
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17813
<div id="attr_routes" class="attr item inherited">
17814
<a name="config_routes"></a>
17815
<h3 class="name"><code>routes</code></h3>
17816
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
17830
<a href="../classes/Router.html#attr_routes">Router</a>:
17834
<a href="../files/app_js_router.js.html#l1025"><code>app/js/router.js:1025</code></a>
17843
<div class="description">
17844
<p>Array of route objects.</p>
17846
<p>Each item in the array must be an object with the following properties:</p>
17849
<li><p><code>path</code>: String or regex representing the path to match. See the docs
17850
for the <code>route()</code> method for more details.</p></li>
17851
<li><p><code>callback</code>: Function or a string representing the name of a function
17852
on this router instance that should be called when the route is
17853
triggered. See the docs for the <code>route()</code> method for more details.</p></li>
17856
<p>This attribute is intended to be used to set routes at init time, or to
17857
completely reset all routes after init. To add routes after init without
17858
resetting all existing routes, use the <code>route()</code> method.</p>
17862
<p><strong>Default:</strong> `[]`</p>
17866
<div class="emits box">
17867
<h4>Fires event <code>routesChange</code></h4>
17870
Fires when the value for the configuration attribute <code>routes</code> is
17871
changed. You can listen for the event using the <code>on</code> method if you
17872
wish to be notified before the attribute's value has changed, or
17873
using the <code>after</code> method if you wish to be notified after the
17874
attribute's value has changed.
17877
<div class="params">
17878
<h4>Parameters:</h4>
17880
<ul class="params-list">
17882
<code class="param-name">e</code>
17883
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17885
<div class="param-description">
17886
An Event Facade object with the following
17887
attribute-specific properties added:
17890
<ul class="params-list">
17892
<code class="param-name">prevVal</code>
17893
<span class="type">Any</span>
17894
<div class="param-description">The value of the attribute, prior to it being set.</div>
17897
<code class="param-name">newVal</code>
17898
<span class="type">Any</span>
17899
<div class="param-description">The value the attribute is to be set to.</div>
17902
<code class="param-name">attrName</code>
17903
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17904
<div class="param-description">The name of the attribute being set.</div>
17907
<code class="param-name">subAttrName</code>
17908
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17909
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17922
<div id="attr_scrollToTop" class="attr item inherited">
17923
<a name="config_scrollToTop"></a>
17924
<h3 class="name"><code>scrollToTop</code></h3>
17925
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
17939
<a href="../classes/PjaxBase.html#attr_scrollToTop">PjaxBase</a>:
17943
<a href="../files/pjax_js_pjax-base.js.html#l490"><code>pjax/js/pjax-base.js:490</code></a>
17950
<p>Available since 3.5.0</p>
17954
<div class="description">
17955
<p>Whether the page should be scrolled to the top after navigating to a URL.</p>
17957
<p>When the user clicks the browser's back button, the previous scroll position
17958
will be maintained.</p>
17962
<p><strong>Default:</strong> true</p>
17966
<div class="emits box">
17967
<h4>Fires event <code>scrollToTopChange</code></h4>
17970
Fires when the value for the configuration attribute <code>scrollToTop</code> is
17971
changed. You can listen for the event using the <code>on</code> method if you
17972
wish to be notified before the attribute's value has changed, or
17973
using the <code>after</code> method if you wish to be notified after the
17974
attribute's value has changed.
17977
<div class="params">
17978
<h4>Parameters:</h4>
17980
<ul class="params-list">
17982
<code class="param-name">e</code>
17983
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17985
<div class="param-description">
17986
An Event Facade object with the following
17987
attribute-specific properties added:
17990
<ul class="params-list">
17992
<code class="param-name">prevVal</code>
17993
<span class="type">Any</span>
17994
<div class="param-description">The value of the attribute, prior to it being set.</div>
17997
<code class="param-name">newVal</code>
17998
<span class="type">Any</span>
17999
<div class="param-description">The value the attribute is to be set to.</div>
18002
<code class="param-name">attrName</code>
18003
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18004
<div class="param-description">The name of the attribute being set.</div>
18007
<code class="param-name">subAttrName</code>
18008
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18009
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
18022
<div id="attr_serverRouting" class="attr item inherited">
18023
<a name="config_serverRouting"></a>
18024
<h3 class="name"><code>serverRouting</code></h3>
18025
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
18039
<a href="../classes/App.Base.html#attr_serverRouting">App.Base</a>:
18043
<a href="../files/app_js_app-base.js.html#l950"><code>app/js/app-base.js:950</code></a>
18050
<p>Available since 3.5.0</p>
18054
<div class="description">
18055
<p>Whether or not this application's server is capable of properly routing
18056
all requests and rendering the initial state in the HTML responses.</p>
18058
<p>This can have three different values, each having particular
18059
implications on how the app will handle routing and navigation:</p>
18062
<li><p><code>undefined</code>: The best form of URLs will be chosen based on the
18063
capabilities of the browser. Given no information about the server
18064
environmentm a balanced approach to routing and navigation is
18067
<p>The server should be capable of handling full-path requests, since
18068
full-URLs will be generated by browsers using HTML5 history. If this
18069
is a client-side-only app the server could handle full-URL requests
18070
by sending a redirect back to the root with a hash-based URL, e.g:</p>
18072
<pre class="code"><code class="prettyprint">Request: http://example.com/users/1
18073
Redirect to: http://example.com/#/users/1
18075
<li><p><code>true</code>: The server is <em>fully</em> capable of properly handling requests
18076
to all full-path URLs the app can produce.</p>
18078
<p>This is the best option for progressive-enhancement because it will
18079
cause <strong>all URLs to always have full-paths</strong>, which means the server
18080
will be able to accurately handle all URLs this app produces. e.g.</p>
18082
<pre class="code"><code class="prettyprint">http://example.com/users/1
18085
<p>To meet this strict full-URL requirement, browsers which are not
18086
capable of using HTML5 history will make requests to the server
18087
resulting in full-page reloads.</p></li>
18088
<li><p><code>false</code>: The server is <em>not</em> capable of properly handling requests
18089
to all full-path URLs the app can produce, therefore all routing
18090
will be handled by this App instance.</p>
18092
<p>Be aware that this will cause <strong>all URLs to always be hash-based</strong>,
18093
even in browsers that are capable of using HTML5 history. e.g.</p>
18095
<pre class="code"><code class="prettyprint">http://example.com/#/users/1
18098
<p>A single-page or client-side-only app where the server sends a
18099
"shell" page with JavaScript to the client might have this
18100
restriction. If you're setting this to <code>false</code>, read the following:</p></li>
18103
<p><strong>Note:</strong> When this is set to <code>false</code>, the server will <em>never</em> receive
18104
the full URL because browsers do not send the fragment-part to the
18105
server, that is everything after and including the "#".</p>
18107
<p>Consider the following example:</p>
18109
<pre class="code"><code class="prettyprint">URL shown in browser: http://example.com/#/users/1
18110
URL sent to server: http://example.com/
18113
<p>You should feel bad about hurting our precious web if you forcefully set
18114
either <code>serverRouting</code> or <code>html5</code> to <code>false</code>, because you're basically
18115
punching the web in the face here with your lossy URLs! Please make sure
18116
you know what you're doing and that you understand the implications.</p>
18118
<p>Ideally you should always prefer full-path URLs (not /#/foo/), and want
18119
full-page reloads when the client's browser is not capable of enhancing
18120
the experience using the HTML5 history APIs. Setting this to <code>true</code> is
18121
the best option for progressive-enhancement (and graceful-degradation).</p>
18125
<p><strong>Default:</strong> undefined</p>
18129
<div class="emits box">
18130
<h4>Fires event <code>serverRoutingChange</code></h4>
18133
Fires when the value for the configuration attribute <code>serverRouting</code> is
18134
changed. You can listen for the event using the <code>on</code> method if you
18135
wish to be notified before the attribute's value has changed, or
18136
using the <code>after</code> method if you wish to be notified after the
18137
attribute's value has changed.
18140
<div class="params">
18141
<h4>Parameters:</h4>
18143
<ul class="params-list">
18145
<code class="param-name">e</code>
18146
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
18148
<div class="param-description">
18149
An Event Facade object with the following
18150
attribute-specific properties added:
18153
<ul class="params-list">
18155
<code class="param-name">prevVal</code>
18156
<span class="type">Any</span>
18157
<div class="param-description">The value of the attribute, prior to it being set.</div>
18160
<code class="param-name">newVal</code>
18161
<span class="type">Any</span>
18162
<div class="param-description">The value the attribute is to be set to.</div>
18165
<code class="param-name">attrName</code>
18166
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18167
<div class="param-description">The name of the attribute being set.</div>
18170
<code class="param-name">subAttrName</code>
18171
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18172
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
18185
<div id="attr_transitions" class="attr item inherited">
18186
<a name="config_transitions"></a>
18187
<h3 class="name"><code>transitions</code></h3>
18188
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
18202
<a href="../classes/App.Transitions.html#attr_transitions">App.Transitions</a>:
18206
<a href="../files/app_js_app-extensions_app-transitions.js.html#l39"><code>app/js/app-extensions/app-transitions.js:39</code></a>
18213
<p>Available since 3.5.0</p>
18217
<div class="description">
18218
<p>Whether or not this application should use view transitions, and if so then
18219
which ones or <code>true</code> for the defaults which are specified by the
18220
<code>transitions</code> prototype property.</p>
18222
<p><strong>Note:</strong> Transitions are an opt-in feature and will only be used in
18223
browsers which support native CSS3 transitions.</p>
18227
<p><strong>Default:</strong> false</p>
18231
<div class="emits box">
18232
<h4>Fires event <code>transitionsChange</code></h4>
18235
Fires when the value for the configuration attribute <code>transitions</code> is
18236
changed. You can listen for the event using the <code>on</code> method if you
18237
wish to be notified before the attribute's value has changed, or
18238
using the <code>after</code> method if you wish to be notified after the
18239
attribute's value has changed.
18242
<div class="params">
18243
<h4>Parameters:</h4>
18245
<ul class="params-list">
18247
<code class="param-name">e</code>
18248
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
18250
<div class="param-description">
18251
An Event Facade object with the following
18252
attribute-specific properties added:
18255
<ul class="params-list">
18257
<code class="param-name">prevVal</code>
18258
<span class="type">Any</span>
18259
<div class="param-description">The value of the attribute, prior to it being set.</div>
18262
<code class="param-name">newVal</code>
18263
<span class="type">Any</span>
18264
<div class="param-description">The value the attribute is to be set to.</div>
18267
<code class="param-name">attrName</code>
18268
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18269
<div class="param-description">The name of the attribute being set.</div>
18272
<code class="param-name">subAttrName</code>
18273
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18274
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
18287
<div id="attr_viewContainer" class="attr item inherited">
18288
<a name="config_viewContainer"></a>
18289
<h3 class="name"><code>viewContainer</code></h3>
18290
<span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18304
<a href="../classes/App.Base.html#attr_viewContainer">App.Base</a>:
18308
<a href="../files/app_js_app-base.js.html#l1026"><code>app/js/app-base.js:1026</code></a>
18315
<p>Available since 3.5.0</p>
18319
<div class="description">
18320
<p>The node into which this app's <code>views</code> will be rendered when they become
18321
the <code>activeView</code>.</p>
18323
<p>The view container node serves as the container to hold the app's
18324
<code>activeView</code>. Each time the <code>activeView</code> is set via <code>showView()</code>, the
18325
previous view will be removed from this node, and the new active view's
18326
<code>container</code> node will be appended.</p>
18328
<p>The default view container is a <code><div></code> Node, but you can override this
18329
in a subclass, or by passing in a custom <code>viewContainer</code> config value at
18330
instantiation time. The <code>viewContainer</code> may be provided as a selector
18331
string, DOM element, or a <code>Y.Node</code> instance (having the <code>viewContainer</code>
18332
and the <code>container</code> be the same node is also supported).</p>
18334
<p>The app's <code>render()</code> method will stamp the view container with the CSS
18335
class <code>"yui3-app-views"</code> and append it to the app's <code>container</code> node if
18336
it isn't already, and any <code>activeView</code> will be appended to this node if
18337
it isn't already.</p>
18341
<p><strong>Default:</strong> Y.Node.create(this.containerTemplate)</p>
18345
<div class="emits box">
18346
<h4>Fires event <code>viewContainerChange</code></h4>
18349
Fires when the value for the configuration attribute <code>viewContainer</code> is
18350
changed. You can listen for the event using the <code>on</code> method if you
18351
wish to be notified before the attribute's value has changed, or
18352
using the <code>after</code> method if you wish to be notified after the
18353
attribute's value has changed.
18356
<div class="params">
18357
<h4>Parameters:</h4>
18359
<ul class="params-list">
18361
<code class="param-name">e</code>
18362
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
18364
<div class="param-description">
18365
An Event Facade object with the following
18366
attribute-specific properties added:
18369
<ul class="params-list">
18371
<code class="param-name">prevVal</code>
18372
<span class="type">Any</span>
18373
<div class="param-description">The value of the attribute, prior to it being set.</div>
18376
<code class="param-name">newVal</code>
18377
<span class="type">Any</span>
18378
<div class="param-description">The value the attribute is to be set to.</div>
18381
<code class="param-name">attrName</code>
18382
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18383
<div class="param-description">The name of the attribute being set.</div>
18386
<code class="param-name">subAttrName</code>
18387
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18388
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
18405
<div id="events" class="api-class-tabpanel">
18406
<h2 class="off-left">Events</h2>
18409
<div id="event_destroy" class="events item inherited">
18410
<h3 class="name"><code>destroy</code></h3>
18411
<span class="type"></span>
18425
<a href="../classes/Base.html#event_destroy">Base</a>:
18429
<a href="../files/base_js_Base.js.html#l285"><code>base/js/Base.js:285</code></a>
18438
<div class="description">
18440
Lifecycle event for the destroy phase,
18441
fired prior to destruction. Invoking the preventDefault
18442
method on the event object provided to subscribers will
18443
prevent destruction from proceeding.
18447
Subscribers to the "after" moment of this event, will be notified
18448
after destruction is complete (and as a result cannot prevent
18454
<div class="params">
18455
<h4>Event Payload:</h4>
18457
<ul class="params-list">
18461
<code class="param-name">e</code>
18462
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
18467
<div class="param-description">
18468
<p>Event object</p>
18483
<div id="event_init" class="events item inherited">
18484
<h3 class="name"><code>init</code></h3>
18485
<span class="type"></span>
18499
<a href="../classes/Base.html#event_init">Base</a>:
18503
<a href="../files/base_js_Base.js.html#l202"><code>base/js/Base.js:202</code></a>
18512
<div class="description">
18514
Lifecycle event for the init phase, fired prior to initialization.
18515
Invoking the preventDefault() method on the event object provided
18516
to subscribers will prevent initialization from occuring.
18520
Subscribers to the "after" momemt of this event, will be notified
18521
after initialization of the object is complete (and therefore
18522
cannot prevent initialization).
18527
<div class="params">
18528
<h4>Event Payload:</h4>
18530
<ul class="params-list">
18534
<code class="param-name">e</code>
18535
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
18540
<div class="param-description">
18541
<p>Event object, with a cfg property which
18542
refers to the configuration object passed to the constructor.</p>
18557
<div id="event_navigate" class="events item inherited">
18558
<h3 class="name"><code>navigate</code></h3>
18559
<span class="type"></span>
18573
<a href="../classes/PjaxBase.html#event_navigate">PjaxBase</a>:
18577
<a href="../files/pjax_js_pjax-base.js.html#l18"><code>pjax/js/pjax-base.js:18</code></a>
18584
<p>Available since 3.5.0</p>
18588
<div class="description">
18589
<p>Fired when navigating to a URL via Pjax.</p>
18591
<p>When the <code>navigate()</code> method is called or a pjax link is clicked, this event
18592
will be fired if the browser supports HTML5 history <em>and</em> the router has a
18593
route handler for the specified URL.</p>
18595
<p>This is a useful event to listen to for adding a visual loading indicator
18596
while the route handlers are busy handling the URL change.</p>
18600
<div class="params">
18601
<h4>Event Payload:</h4>
18603
<ul class="params-list">
18607
<code class="param-name">url</code>
18608
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18613
<div class="param-description">
18614
<p>The URL that the router will dispatch to its route
18615
handlers in order to fulfill the enhanced navigation "request".</p>
18623
<code class="param-name optional">[force=false]</code>
18624
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
18625
<span class="flag optional" title="This parameter is optional.">optional</span>
18630
<div class="param-description">
18631
<p>Whether the enhanced navigation should occur
18632
even in browsers without HTML5 history.</p>
18640
<code class="param-name optional">[hash]</code>
18641
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
18642
<span class="flag optional" title="This parameter is optional.">optional</span>
18647
<div class="param-description">
18648
<p>The hash-fragment (including "#") of the <code>url</code>. This
18649
will be present when the <code>url</code> differs from the current URL only by its
18650
hash and <code>navigateOnHash</code> has ben set to <code>true</code>.</p>
18658
<code class="param-name optional">[originEvent]</code>
18659
<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
18660
<span class="flag optional" title="This parameter is optional.">optional</span>
18665
<div class="param-description">
18666
<p>The event that caused the navigation. Usually
18667
this would be a click event from a "pjax" anchor element.</p>
18675
<code class="param-name optional">[replace]</code>
18676
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
18677
<span class="flag optional" title="This parameter is optional.">optional</span>
18682
<div class="param-description">
18683
<p>Whether or not the current history entry will be
18684
replaced, or a new entry will be created. Will default to <code>true</code> if the
18685
specified <code>url</code> is the same as the current URL.</p>
18700
<div id="event_ready" class="events item inherited">
18701
<h3 class="name"><code>ready</code></h3>
18702
<span class="type"></span>
18716
<a href="../classes/Router.html#event_ready">Router</a>:
18720
<a href="../files/app_js_router.js.html#l20"><code>app/js/router.js:20</code></a>
18729
<div class="description">
18730
<p>Fired when the router is ready to begin dispatching to route handlers.</p>
18732
<p>You shouldn't need to wait for this event unless you plan to implement some
18733
kind of custom dispatching logic. It's used internally in order to avoid
18734
dispatching to an initial route if a browser history change occurs first.</p>
18738
<div class="params">
18739
<h4>Event Payload:</h4>
18741
<ul class="params-list">
18745
<code class="param-name">dispatched</code>
18746
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
18751
<div class="param-description">
18752
<p><code>true</code> if routes have already been dispatched
18753
(most likely due to a history change).</p>
18779
<script src="../assets/vendor/prettify/prettify-min.js"></script>
18780
<script>prettyPrint();</script>
18781
<script src="../assets/js/yui-prettify.js"></script>
18782
<script src="../assets/../api.js"></script>
18783
<script src="../assets/js/api-filter.js"></script>
18784
<script src="../assets/js/api-list.js"></script>
18785
<script src="../assets/js/api-search.js"></script>
18786
<script src="../assets/js/apidocs.js"></script>
added
removed
lib/yui/api/classes/App.html
