--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui_3.10.3/api/classes/App.Base.html Tue Jul 16 14:29:46 2013 +0200
@@ -0,0 +1,20135 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>App.Base - YUI 3</title>
+ <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+ <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+ <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+ <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
+ <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+ <div id="hd" class="yui3-g header">
+ <div class="yui3-u-3-4">
+
+ <h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
+
+ </div>
+ <div class="yui3-u-1-4 version">
+ <em>API Docs for: 3.10.3</em>
+ </div>
+ </div>
+ <div id="bd" class="yui3-g">
+
+ <div class="yui3-u-1-4">
+ <div id="docs-sidebar" class="sidebar apidocs">
+ <div id="api-list">
+ <h2 class="off-left">APIs</h2>
+ <div id="api-tabview" class="tabview">
+ <ul class="tabs">
+ <li><a href="#api-classes">Classes</a></li>
+ <li><a href="#api-modules">Modules</a></li>
+ </ul>
+
+ <div id="api-tabview-filter">
+ <input type="search" id="api-filter" placeholder="Type to filter APIs">
+ </div>
+
+ <div id="api-tabview-panel">
+ <ul id="api-classes" class="apis classes">
+
+ <li><a href="../classes/Anim.html">Anim</a></li>
+
+ <li><a href="../classes/App.html">App</a></li>
+
+ <li><a href="../classes/App.Base.html">App.Base</a></li>
+
+ <li><a href="../classes/App.Content.html">App.Content</a></li>
+
+ <li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
+
+ <li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
+
+ <li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
+
+ <li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
+
+ <li><a href="../classes/Array.html">Array</a></li>
+
+ <li><a href="../classes/ArrayList.html">ArrayList</a></li>
+
+ <li><a href="../classes/ArraySort.html">ArraySort</a></li>
+
+ <li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
+
+ <li><a href="../classes/Attribute.html">Attribute</a></li>
+
+ <li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
+
+ <li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
+
+ <li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
+
+ <li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
+
+ <li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li>
+
+ <li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
+
+ <li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
+
+ <li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
+
+ <li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
+
+ <li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
+
+ <li><a href="../classes/Axis.html">Axis</a></li>
+
+ <li><a href="../classes/AxisBase.html">AxisBase</a></li>
+
+ <li><a href="../classes/BarSeries.html">BarSeries</a></li>
+
+ <li><a href="../classes/Base.html">Base</a></li>
+
+ <li><a href="../classes/BaseCore.html">BaseCore</a></li>
+
+ <li><a href="../classes/BaseObservable.html">BaseObservable</a></li>
+
+ <li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
+
+ <li><a href="../classes/Button.html">Button</a></li>
+
+ <li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
+
+ <li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
+
+ <li><a href="../classes/Cache.html">Cache</a></li>
+
+ <li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
+
+ <li><a href="../classes/Calendar.html">Calendar</a></li>
+
+ <li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
+
+ <li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li>
+
+ <li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
+
+ <li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
+
+ <li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
+
+ <li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
+
+ <li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
+
+ <li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
+
+ <li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
+
+ <li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
+
+ <li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
+
+ <li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
+
+ <li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
+
+ <li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li>
+
+ <li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li>
+
+ <li><a href="../classes/Chart.html">Chart</a></li>
+
+ <li><a href="../classes/ChartBase.html">ChartBase</a></li>
+
+ <li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
+
+ <li><a href="../classes/Circle.html">Circle</a></li>
+
+ <li><a href="../classes/CircleGroup.html">CircleGroup</a></li>
+
+ <li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
+
+ <li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
+
+ <li><a href="../classes/Color.html">Color</a></li>
+
+ <li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li>
+
+ <li><a href="../classes/Color.HSL.html">Color.HSL</a></li>
+
+ <li><a href="../classes/Color.HSV.html">Color.HSV</a></li>
+
+ <li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
+
+ <li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
+
+ <li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
+
+ <li><a href="../classes/config.html">config</a></li>
+
+ <li><a href="../classes/Console.html">Console</a></li>
+
+ <li><a href="../classes/Controller.html">Controller</a></li>
+
+ <li><a href="../classes/Cookie.html">Cookie</a></li>
+
+ <li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
+
+ <li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
+
+ <li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
+
+ <li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
+
+ <li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
+
+ <li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
+
+ <li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
+
+ <li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
+
+ <li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
+
+ <li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
+
+ <li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
+
+ <li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
+
+ <li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
+
+ <li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
+
+ <li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
+
+ <li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
+
+ <li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
+
+ <li><a href="../classes/DataTable.html">DataTable</a></li>
+
+ <li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li>
+
+ <li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
+
+ <li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
+
+ <li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
+
+ <li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
+
+ <li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
+
+ <li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
+
+ <li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
+
+ <li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li>
+
+ <li><a href="../classes/Date.html">Date</a></li>
+
+ <li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
+
+ <li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
+
+ <li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
+
+ <li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
+
+ <li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
+
+ <li><a href="../classes/Dial.html">Dial</a></li>
+
+ <li><a href="../classes/Do.html">Do</a></li>
+
+ <li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
+
+ <li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
+
+ <li><a href="../classes/Do.Error.html">Do.Error</a></li>
+
+ <li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
+
+ <li><a href="../classes/Do.Method.html">Do.Method</a></li>
+
+ <li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
+
+ <li><a href="../classes/DOM.html">DOM</a></li>
+
+ <li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
+
+ <li><a href="../classes/Drawing.html">Drawing</a></li>
+
+ <li><a href="../classes/Easing.html">Easing</a></li>
+
+ <li><a href="../classes/EditorBase.html">EditorBase</a></li>
+
+ <li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
+
+ <li><a href="../classes/Ellipse.html">Ellipse</a></li>
+
+ <li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
+
+ <li><a href="../classes/Escape.html">Escape</a></li>
+
+ <li><a href="../classes/Event.html">Event</a></li>
+
+ <li><a href="../classes/EventFacade.html">EventFacade</a></li>
+
+ <li><a href="../classes/EventHandle.html">EventHandle</a></li>
+
+ <li><a href="../classes/EventTarget.html">EventTarget</a></li>
+
+ <li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
+
+ <li><a href="../classes/Features.html">Features</a></li>
+
+ <li><a href="../classes/File.html">File</a></li>
+
+ <li><a href="../classes/FileFlash.html">FileFlash</a></li>
+
+ <li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
+
+ <li><a href="../classes/Fills.html">Fills</a></li>
+
+ <li><a href="../classes/Frame.html">Frame</a></li>
+
+ <li><a href="../classes/Get.html">Get</a></li>
+
+ <li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
+
+ <li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
+
+ <li><a href="../classes/Graph.html">Graph</a></li>
+
+ <li><a href="../classes/Graphic.html">Graphic</a></li>
+
+ <li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
+
+ <li><a href="../classes/Gridlines.html">Gridlines</a></li>
+
+ <li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
+
+ <li><a href="../classes/GroupRect.html">GroupRect</a></li>
+
+ <li><a href="../classes/Handlebars.html">Handlebars</a></li>
+
+ <li><a href="../classes/Highlight.html">Highlight</a></li>
+
+ <li><a href="../classes/Histogram.html">Histogram</a></li>
+
+ <li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
+
+ <li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
+
+ <li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
+
+ <li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
+
+ <li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
+
+ <li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
+
+ <li><a href="../classes/Intl.html">Intl</a></li>
+
+ <li><a href="../classes/IO.html">IO</a></li>
+
+ <li><a href="../classes/JSON.html">JSON</a></li>
+
+ <li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
+
+ <li><a href="../classes/Lang.html">Lang</a></li>
+
+ <li><a href="../classes/LazyModelList.html">LazyModelList</a></li>
+
+ <li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
+
+ <li><a href="../classes/Lines.html">Lines</a></li>
+
+ <li><a href="../classes/LineSeries.html">LineSeries</a></li>
+
+ <li><a href="../classes/Loader.html">Loader</a></li>
+
+ <li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
+
+ <li><a href="../classes/Matrix.html">Matrix</a></li>
+
+ <li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li>
+
+ <li><a href="../classes/Model.html">Model</a></li>
+
+ <li><a href="../classes/ModelList.html">ModelList</a></li>
+
+ <li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li>
+
+ <li><a href="../classes/Node.html">Node</a></li>
+
+ <li><a href="../classes/NodeList.html">NodeList</a></li>
+
+ <li><a href="../classes/Number.html">Number</a></li>
+
+ <li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
+
+ <li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li>
+
+ <li><a href="../classes/NumericImpl.html">NumericImpl</a></li>
+
+ <li><a href="../classes/Object.html">Object</a></li>
+
+ <li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li>
+
+ <li><a href="../classes/Overlay.html">Overlay</a></li>
+
+ <li><a href="../classes/Panel.html">Panel</a></li>
+
+ <li><a href="../classes/Parallel.html">Parallel</a></li>
+
+ <li><a href="../classes/Path.html">Path</a></li>
+
+ <li><a href="../classes/PieChart.html">PieChart</a></li>
+
+ <li><a href="../classes/PieSeries.html">PieSeries</a></li>
+
+ <li><a href="../classes/Pjax.html">Pjax</a></li>
+
+ <li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
+
+ <li><a href="../classes/PjaxContent.html">PjaxContent</a></li>
+
+ <li><a href="../classes/Plots.html">Plots</a></li>
+
+ <li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
+
+ <li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
+
+ <li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
+
+ <li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li>
+
+ <li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
+
+ <li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
+
+ <li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
+
+ <li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
+
+ <li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
+
+ <li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
+
+ <li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
+
+ <li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
+
+ <li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
+
+ <li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
+
+ <li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
+
+ <li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
+
+ <li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
+
+ <li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
+
+ <li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
+
+ <li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
+
+ <li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
+
+ <li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
+
+ <li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
+
+ <li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
+
+ <li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
+
+ <li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
+
+ <li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
+
+ <li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
+
+ <li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
+
+ <li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
+
+ <li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
+
+ <li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
+
+ <li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
+
+ <li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li>
+
+ <li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
+
+ <li><a href="../classes/Pollable.html">Pollable</a></li>
+
+ <li><a href="../classes/Promise.html">Promise</a></li>
+
+ <li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li>
+
+ <li><a href="../classes/QueryString.html">QueryString</a></li>
+
+ <li><a href="../classes/Queue.html">Queue</a></li>
+
+ <li><a href="../classes/RangeSeries.html">RangeSeries</a></li>
+
+ <li><a href="../classes/Record.html">Record</a></li>
+
+ <li><a href="../classes/Recordset.html">Recordset</a></li>
+
+ <li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
+
+ <li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
+
+ <li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
+
+ <li><a href="../classes/Rect.html">Rect</a></li>
+
+ <li><a href="../classes/Renderer.html">Renderer</a></li>
+
+ <li><a href="../classes/Resize.html">Resize</a></li>
+
+ <li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
+
+ <li><a href="../classes/Router.html">Router</a></li>
+
+ <li><a href="../classes/ScrollView.html">ScrollView</a></li>
+
+ <li><a href="../classes/Selector.html">Selector</a></li>
+
+ <li><a href="../classes/SeriesBase.html">SeriesBase</a></li>
+
+ <li><a href="../classes/Shape.html">Shape</a></li>
+
+ <li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
+
+ <li><a href="../classes/Slider.html">Slider</a></li>
+
+ <li><a href="../classes/SliderBase.html">SliderBase</a></li>
+
+ <li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
+
+ <li><a href="../classes/soon.html">soon</a></li>
+
+ <li><a href="../classes/Sortable.html">Sortable</a></li>
+
+ <li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
+
+ <li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
+
+ <li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li>
+
+ <li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
+
+ <li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
+
+ <li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
+
+ <li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
+
+ <li><a href="../classes/StackedImpl.html">StackedImpl</a></li>
+
+ <li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
+
+ <li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
+
+ <li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
+
+ <li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
+
+ <li><a href="../classes/State.html">State</a></li>
+
+ <li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
+
+ <li><a href="../classes/Subscriber.html">Subscriber</a></li>
+
+ <li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
+
+ <li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
+
+ <li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
+
+ <li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
+
+ <li><a href="../classes/SVGPath.html">SVGPath</a></li>
+
+ <li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
+
+ <li><a href="../classes/SVGRect.html">SVGRect</a></li>
+
+ <li><a href="../classes/SVGShape.html">SVGShape</a></li>
+
+ <li><a href="../classes/SWF.html">SWF</a></li>
+
+ <li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
+
+ <li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
+
+ <li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
+
+ <li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
+
+ <li><a href="../classes/Tab.html">Tab</a></li>
+
+ <li><a href="../classes/TabView.html">TabView</a></li>
+
+ <li><a href="../classes/Template.html">Template</a></li>
+
+ <li><a href="../classes/Template.Micro.html">Template.Micro</a></li>
+
+ <li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
+
+ <li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
+
+ <li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
+
+ <li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
+
+ <li><a href="../classes/Test.Console.html">Test.Console</a></li>
+
+ <li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
+
+ <li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
+
+ <li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
+
+ <li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
+
+ <li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
+
+ <li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
+
+ <li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
+
+ <li><a href="../classes/Test.Results.html">Test.Results</a></li>
+
+ <li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
+
+ <li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
+
+ <li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
+
+ <li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
+
+ <li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
+
+ <li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
+
+ <li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
+
+ <li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
+
+ <li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
+
+ <li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
+
+ <li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
+
+ <li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
+
+ <li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
+
+ <li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
+
+ <li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li>
+
+ <li><a href="../classes/TimeImpl.html">TimeImpl</a></li>
+
+ <li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
+
+ <li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
+
+ <li><a href="../classes/Transition.html">Transition</a></li>
+
+ <li><a href="../classes/Tree.html">Tree</a></li>
+
+ <li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.html">Tree.Node</a></li>
+
+ <li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li>
+
+ <li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li>
+
+ <li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li>
+
+ <li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li>
+
+ <li><a href="../classes/UA.html">UA</a></li>
+
+ <li><a href="../classes/Uploader.html">Uploader</a></li>
+
+ <li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
+
+ <li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
+
+ <li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
+
+ <li><a href="../classes/ValueChange.html">ValueChange</a></li>
+
+ <li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
+
+ <li><a href="../classes/View.html">View</a></li>
+
+ <li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
+
+ <li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
+
+ <li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
+
+ <li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
+
+ <li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
+
+ <li><a href="../classes/VMLPath.html">VMLPath</a></li>
+
+ <li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
+
+ <li><a href="../classes/VMLRect.html">VMLRect</a></li>
+
+ <li><a href="../classes/VMLShape.html">VMLShape</a></li>
+
+ <li><a href="../classes/Widget.html">Widget</a></li>
+
+ <li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
+
+ <li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
+
+ <li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
+
+ <li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
+
+ <li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
+
+ <li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
+
+ <li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
+
+ <li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
+
+ <li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
+
+ <li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
+
+ <li><a href="../classes/XML.html">XML</a></li>
+
+ <li><a href="../classes/YQL.html">YQL</a></li>
+
+ <li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
+
+ <li><a href="../classes/YUI.html">YUI</a></li>
+
+ <li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
+
+ </ul>
+
+ <ul id="api-modules" class="apis modules">
+
+ <li><a href="../modules/align-plugin.html">align-plugin</a></li>
+
+ <li><a href="../modules/anim.html">anim</a></li>
+
+ <li><a href="../modules/anim-base.html">anim-base</a></li>
+
+ <li><a href="../modules/anim-color.html">anim-color</a></li>
+
+ <li><a href="../modules/anim-curve.html">anim-curve</a></li>
+
+ <li><a href="../modules/anim-easing.html">anim-easing</a></li>
+
+ <li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
+
+ <li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
+
+ <li><a href="../modules/anim-shape.html">anim-shape</a></li>
+
+ <li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
+
+ <li><a href="../modules/anim-xy.html">anim-xy</a></li>
+
+ <li><a href="../modules/app.html">app</a></li>
+
+ <li><a href="../modules/app-base.html">app-base</a></li>
+
+ <li><a href="../modules/app-content.html">app-content</a></li>
+
+ <li><a href="../modules/app-transitions.html">app-transitions</a></li>
+
+ <li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
+
+ <li><a href="../modules/array-extras.html">array-extras</a></li>
+
+ <li><a href="../modules/array-invoke.html">array-invoke</a></li>
+
+ <li><a href="../modules/arraylist.html">arraylist</a></li>
+
+ <li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
+
+ <li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
+
+ <li><a href="../modules/arraysort.html">arraysort</a></li>
+
+ <li><a href="../modules/async-queue.html">async-queue</a></li>
+
+ <li><a href="../modules/attribute.html">attribute</a></li>
+
+ <li><a href="../modules/attribute-base.html">attribute-base</a></li>
+
+ <li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
+
+ <li><a href="../modules/attribute-core.html">attribute-core</a></li>
+
+ <li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
+
+ <li><a href="../modules/attribute-observable.html">attribute-observable</a></li>
+
+ <li><a href="../modules/autocomplete.html">autocomplete</a></li>
+
+ <li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
+
+ <li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
+
+ <li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
+
+ <li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
+
+ <li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
+
+ <li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
+
+ <li><a href="../modules/axis.html">axis</a></li>
+
+ <li><a href="../modules/axis-base.html">axis-base</a></li>
+
+ <li><a href="../modules/axis-category.html">axis-category</a></li>
+
+ <li><a href="../modules/axis-category-base.html">axis-category-base</a></li>
+
+ <li><a href="../modules/axis-numeric.html">axis-numeric</a></li>
+
+ <li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li>
+
+ <li><a href="../modules/axis-stacked.html">axis-stacked</a></li>
+
+ <li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li>
+
+ <li><a href="../modules/axis-time.html">axis-time</a></li>
+
+ <li><a href="../modules/axis-time-base.html">axis-time-base</a></li>
+
+ <li><a href="../modules/base.html">base</a></li>
+
+ <li><a href="../modules/base-base.html">base-base</a></li>
+
+ <li><a href="../modules/base-build.html">base-build</a></li>
+
+ <li><a href="../modules/base-core.html">base-core</a></li>
+
+ <li><a href="../modules/base-observable.html">base-observable</a></li>
+
+ <li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
+
+ <li><a href="../modules/button.html">button</a></li>
+
+ <li><a href="../modules/button-core.html">button-core</a></li>
+
+ <li><a href="../modules/button-group.html">button-group</a></li>
+
+ <li><a href="../modules/button-plugin.html">button-plugin</a></li>
+
+ <li><a href="../modules/cache.html">cache</a></li>
+
+ <li><a href="../modules/cache-base.html">cache-base</a></li>
+
+ <li><a href="../modules/cache-offline.html">cache-offline</a></li>
+
+ <li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
+
+ <li><a href="../modules/calendar.html">calendar</a></li>
+
+ <li><a href="../modules/calendar-base.html">calendar-base</a></li>
+
+ <li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
+
+ <li><a href="../modules/charts.html">charts</a></li>
+
+ <li><a href="../modules/charts-base.html">charts-base</a></li>
+
+ <li><a href="../modules/charts-legend.html">charts-legend</a></li>
+
+ <li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
+
+ <li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
+
+ <li><a href="../modules/collection.html">collection</a></li>
+
+ <li><a href="../modules/color.html">color</a></li>
+
+ <li><a href="../modules/color-base.html">color-base</a></li>
+
+ <li><a href="../modules/color-harmony.html">color-harmony</a></li>
+
+ <li><a href="../modules/color-hsl.html">color-hsl</a></li>
+
+ <li><a href="../modules/color-hsv.html">color-hsv</a></li>
+
+ <li><a href="../modules/console.html">console</a></li>
+
+ <li><a href="../modules/console-filters.html">console-filters</a></li>
+
+ <li><a href="../modules/cookie.html">cookie</a></li>
+
+ <li><a href="../modules/createlink-base.html">createlink-base</a></li>
+
+ <li><a href="../modules/dataschema.html">dataschema</a></li>
+
+ <li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
+
+ <li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
+
+ <li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
+
+ <li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
+
+ <li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
+
+ <li><a href="../modules/datasource.html">datasource</a></li>
+
+ <li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
+
+ <li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
+
+ <li><a href="../modules/datasource-function.html">datasource-function</a></li>
+
+ <li><a href="../modules/datasource-get.html">datasource-get</a></li>
+
+ <li><a href="../modules/datasource-io.html">datasource-io</a></li>
+
+ <li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
+
+ <li><a href="../modules/datasource-local.html">datasource-local</a></li>
+
+ <li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
+
+ <li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
+
+ <li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
+
+ <li><a href="../modules/datatable.html">datatable</a></li>
+
+ <li><a href="../modules/datatable-base.html">datatable-base</a></li>
+
+ <li><a href="../modules/datatable-body.html">datatable-body</a></li>
+
+ <li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
+
+ <li><a href="../modules/datatable-core.html">datatable-core</a></li>
+
+ <li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
+
+ <li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li>
+
+ <li><a href="../modules/datatable-head.html">datatable-head</a></li>
+
+ <li><a href="../modules/datatable-message.html">datatable-message</a></li>
+
+ <li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
+
+ <li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
+
+ <li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
+
+ <li><a href="../modules/datatable-table.html">datatable-table</a></li>
+
+ <li><a href="../modules/datatype.html">datatype</a></li>
+
+ <li><a href="../modules/datatype-date.html">datatype-date</a></li>
+
+ <li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
+
+ <li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
+
+ <li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
+
+ <li><a href="../modules/datatype-number.html">datatype-number</a></li>
+
+ <li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
+
+ <li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
+
+ <li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
+
+ <li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
+
+ <li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
+
+ <li><a href="../modules/dd.html">dd</a></li>
+
+ <li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
+
+ <li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
+
+ <li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
+
+ <li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
+
+ <li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
+
+ <li><a href="../modules/dd-drag.html">dd-drag</a></li>
+
+ <li><a href="../modules/dd-drop.html">dd-drop</a></li>
+
+ <li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
+
+ <li><a href="../modules/dd-gestures.html">dd-gestures</a></li>
+
+ <li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
+
+ <li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
+
+ <li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
+
+ <li><a href="../modules/dial.html">dial</a></li>
+
+ <li><a href="../modules/dom.html">dom</a></li>
+
+ <li><a href="../modules/dom-base.html">dom-base</a></li>
+
+ <li><a href="../modules/dom-screen.html">dom-screen</a></li>
+
+ <li><a href="../modules/dom-style.html">dom-style</a></li>
+
+ <li><a href="../modules/dump.html">dump</a></li>
+
+ <li><a href="../modules/editor.html">editor</a></li>
+
+ <li><a href="../modules/editor-base.html">editor-base</a></li>
+
+ <li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
+
+ <li><a href="../modules/editor-br.html">editor-br</a></li>
+
+ <li><a href="../modules/editor-lists.html">editor-lists</a></li>
+
+ <li><a href="../modules/editor-para.html">editor-para</a></li>
+
+ <li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
+
+ <li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
+
+ <li><a href="../modules/editor-tab.html">editor-tab</a></li>
+
+ <li><a href="../modules/escape.html">escape</a></li>
+
+ <li><a href="../modules/event.html">event</a></li>
+
+ <li><a href="../modules/event-base.html">event-base</a></li>
+
+ <li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
+
+ <li><a href="../modules/event-custom.html">event-custom</a></li>
+
+ <li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
+
+ <li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
+
+ <li><a href="../modules/event-delegate.html">event-delegate</a></li>
+
+ <li><a href="../modules/event-flick.html">event-flick</a></li>
+
+ <li><a href="../modules/event-focus.html">event-focus</a></li>
+
+ <li><a href="../modules/event-gestures.html">event-gestures</a></li>
+
+ <li><a href="../modules/event-hover.html">event-hover</a></li>
+
+ <li><a href="../modules/event-key.html">event-key</a></li>
+
+ <li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
+
+ <li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
+
+ <li><a href="../modules/event-move.html">event-move</a></li>
+
+ <li><a href="../modules/event-outside.html">event-outside</a></li>
+
+ <li><a href="../modules/event-resize.html">event-resize</a></li>
+
+ <li><a href="../modules/event-simulate.html">event-simulate</a></li>
+
+ <li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
+
+ <li><a href="../modules/event-tap.html">event-tap</a></li>
+
+ <li><a href="../modules/event-touch.html">event-touch</a></li>
+
+ <li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
+
+ <li><a href="../modules/exec-command.html">exec-command</a></li>
+
+ <li><a href="../modules/features.html">features</a></li>
+
+ <li><a href="../modules/file.html">file</a></li>
+
+ <li><a href="../modules/file-flash.html">file-flash</a></li>
+
+ <li><a href="../modules/file-html5.html">file-html5</a></li>
+
+ <li><a href="../modules/frame.html">frame</a></li>
+
+ <li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li>
+
+ <li><a href="../modules/get.html">get</a></li>
+
+ <li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
+
+ <li><a href="../modules/graphics.html">graphics</a></li>
+
+ <li><a href="../modules/graphics-group.html">graphics-group</a></li>
+
+ <li><a href="../modules/handlebars.html">handlebars</a></li>
+
+ <li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
+
+ <li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
+
+ <li><a href="../modules/highlight.html">highlight</a></li>
+
+ <li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
+
+ <li><a href="../modules/highlight-base.html">highlight-base</a></li>
+
+ <li><a href="../modules/history.html">history</a></li>
+
+ <li><a href="../modules/history-base.html">history-base</a></li>
+
+ <li><a href="../modules/history-hash.html">history-hash</a></li>
+
+ <li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
+
+ <li><a href="../modules/history-html5.html">history-html5</a></li>
+
+ <li><a href="../modules/imageloader.html">imageloader</a></li>
+
+ <li><a href="../modules/intl.html">intl</a></li>
+
+ <li><a href="../modules/io.html">io</a></li>
+
+ <li><a href="../modules/io-base.html">io-base</a></li>
+
+ <li><a href="../modules/io-form.html">io-form</a></li>
+
+ <li><a href="../modules/io-nodejs.html">io-nodejs</a></li>
+
+ <li><a href="../modules/io-queue.html">io-queue</a></li>
+
+ <li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
+
+ <li><a href="../modules/io-xdr.html">io-xdr</a></li>
+
+ <li><a href="../modules/json.html">json</a></li>
+
+ <li><a href="../modules/json-parse.html">json-parse</a></li>
+
+ <li><a href="../modules/json-stringify.html">json-stringify</a></li>
+
+ <li><a href="../modules/jsonp.html">jsonp</a></li>
+
+ <li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
+
+ <li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li>
+
+ <li><a href="../modules/loader.html">loader</a></li>
+
+ <li><a href="../modules/loader-base.html">loader-base</a></li>
+
+ <li><a href="../modules/loader-yui3.html">loader-yui3</a></li>
+
+ <li><a href="../modules/matrix.html">matrix</a></li>
+
+ <li><a href="../modules/model.html">model</a></li>
+
+ <li><a href="../modules/model-list.html">model-list</a></li>
+
+ <li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li>
+
+ <li><a href="../modules/node.html">node</a></li>
+
+ <li><a href="../modules/node-base.html">node-base</a></li>
+
+ <li><a href="../modules/node-core.html">node-core</a></li>
+
+ <li><a href="../modules/node-data.html">node-data</a></li>
+
+ <li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
+
+ <li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
+
+ <li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
+
+ <li><a href="../modules/node-flick.html">node-flick</a></li>
+
+ <li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
+
+ <li><a href="../modules/node-load.html">node-load</a></li>
+
+ <li><a href="../modules/node-menunav.html">node-menunav</a></li>
+
+ <li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
+
+ <li><a href="../modules/node-screen.html">node-screen</a></li>
+
+ <li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li>
+
+ <li><a href="../modules/node-style.html">node-style</a></li>
+
+ <li><a href="../modules/oop.html">oop</a></li>
+
+ <li><a href="../modules/overlay.html">overlay</a></li>
+
+ <li><a href="../modules/panel.html">panel</a></li>
+
+ <li><a href="../modules/parallel.html">parallel</a></li>
+
+ <li><a href="../modules/pjax.html">pjax</a></li>
+
+ <li><a href="../modules/pjax-base.html">pjax-base</a></li>
+
+ <li><a href="../modules/pjax-content.html">pjax-content</a></li>
+
+ <li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
+
+ <li><a href="../modules/plugin.html">plugin</a></li>
+
+ <li><a href="../modules/pluginhost.html">pluginhost</a></li>
+
+ <li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
+
+ <li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
+
+ <li><a href="../modules/promise.html">promise</a></li>
+
+ <li><a href="../modules/querystring.html">querystring</a></li>
+
+ <li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
+
+ <li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
+
+ <li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
+
+ <li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
+
+ <li><a href="../modules/queue-promote.html">queue-promote</a></li>
+
+ <li><a href="../modules/range-slider.html">range-slider</a></li>
+
+ <li><a href="../modules/recordset.html">recordset</a></li>
+
+ <li><a href="../modules/recordset-base.html">recordset-base</a></li>
+
+ <li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
+
+ <li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
+
+ <li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
+
+ <li><a href="../modules/resize.html">resize</a></li>
+
+ <li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
+
+ <li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
+
+ <li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
+
+ <li><a href="../modules/rollup.html">rollup</a></li>
+
+ <li><a href="../modules/router.html">router</a></li>
+
+ <li><a href="../modules/scrollview.html">scrollview</a></li>
+
+ <li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
+
+ <li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
+
+ <li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
+
+ <li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
+
+ <li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
+
+ <li><a href="../modules/selection.html">selection</a></li>
+
+ <li><a href="../modules/selector-css2.html">selector-css2</a></li>
+
+ <li><a href="../modules/selector-css3.html">selector-css3</a></li>
+
+ <li><a href="../modules/selector-native.html">selector-native</a></li>
+
+ <li><a href="../modules/series-area.html">series-area</a></li>
+
+ <li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li>
+
+ <li><a href="../modules/series-areaspline.html">series-areaspline</a></li>
+
+ <li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li>
+
+ <li><a href="../modules/series-bar.html">series-bar</a></li>
+
+ <li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li>
+
+ <li><a href="../modules/series-base.html">series-base</a></li>
+
+ <li><a href="../modules/series-candlestick.html">series-candlestick</a></li>
+
+ <li><a href="../modules/series-cartesian.html">series-cartesian</a></li>
+
+ <li><a href="../modules/series-column.html">series-column</a></li>
+
+ <li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li>
+
+ <li><a href="../modules/series-combo.html">series-combo</a></li>
+
+ <li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li>
+
+ <li><a href="../modules/series-combospline.html">series-combospline</a></li>
+
+ <li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li>
+
+ <li><a href="../modules/series-curve-util.html">series-curve-util</a></li>
+
+ <li><a href="../modules/series-fill-util.html">series-fill-util</a></li>
+
+ <li><a href="../modules/series-histogram.html">series-histogram</a></li>
+
+ <li><a href="../modules/series-line.html">series-line</a></li>
+
+ <li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li>
+
+ <li><a href="../modules/series-line-util.html">series-line-util</a></li>
+
+ <li><a href="../modules/series-marker.html">series-marker</a></li>
+
+ <li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li>
+
+ <li><a href="../modules/series-ohlc.html">series-ohlc</a></li>
+
+ <li><a href="../modules/series-pie.html">series-pie</a></li>
+
+ <li><a href="../modules/series-plot-util.html">series-plot-util</a></li>
+
+ <li><a href="../modules/series-range.html">series-range</a></li>
+
+ <li><a href="../modules/series-spline.html">series-spline</a></li>
+
+ <li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li>
+
+ <li><a href="../modules/series-stacked.html">series-stacked</a></li>
+
+ <li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
+
+ <li><a href="../modules/slider.html">slider</a></li>
+
+ <li><a href="../modules/slider-base.html">slider-base</a></li>
+
+ <li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
+
+ <li><a href="../modules/sortable.html">sortable</a></li>
+
+ <li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
+
+ <li><a href="../modules/stylesheet.html">stylesheet</a></li>
+
+ <li><a href="../modules/substitute.html">substitute</a></li>
+
+ <li><a href="../modules/swf.html">swf</a></li>
+
+ <li><a href="../modules/swfdetect.html">swfdetect</a></li>
+
+ <li><a href="../modules/tabview.html">tabview</a></li>
+
+ <li><a href="../modules/template.html">template</a></li>
+
+ <li><a href="../modules/template-base.html">template-base</a></li>
+
+ <li><a href="../modules/template-micro.html">template-micro</a></li>
+
+ <li><a href="../modules/test.html">test</a></li>
+
+ <li><a href="../modules/test-console.html">test-console</a></li>
+
+ <li><a href="../modules/text.html">text</a></li>
+
+ <li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
+
+ <li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
+
+ <li><a href="../modules/timers.html">timers</a></li>
+
+ <li><a href="../modules/transition.html">transition</a></li>
+
+ <li><a href="../modules/transition-timer.html">transition-timer</a></li>
+
+ <li><a href="../modules/tree.html">tree</a></li>
+
+ <li><a href="../modules/tree-labelable.html">tree-labelable</a></li>
+
+ <li><a href="../modules/tree-lazy.html">tree-lazy</a></li>
+
+ <li><a href="../modules/tree-node.html">tree-node</a></li>
+
+ <li><a href="../modules/tree-openable.html">tree-openable</a></li>
+
+ <li><a href="../modules/tree-selectable.html">tree-selectable</a></li>
+
+ <li><a href="../modules/tree-sortable.html">tree-sortable</a></li>
+
+ <li><a href="../modules/uploader.html">uploader</a></li>
+
+ <li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
+
+ <li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
+
+ <li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
+
+ <li><a href="../modules/view.html">view</a></li>
+
+ <li><a href="../modules/view-node-map.html">view-node-map</a></li>
+
+ <li><a href="../modules/widget.html">widget</a></li>
+
+ <li><a href="../modules/widget-anim.html">widget-anim</a></li>
+
+ <li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
+
+ <li><a href="../modules/widget-base.html">widget-base</a></li>
+
+ <li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
+
+ <li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
+
+ <li><a href="../modules/widget-child.html">widget-child</a></li>
+
+ <li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
+
+ <li><a href="../modules/widget-locale.html">widget-locale</a></li>
+
+ <li><a href="../modules/widget-modality.html">widget-modality</a></li>
+
+ <li><a href="../modules/widget-parent.html">widget-parent</a></li>
+
+ <li><a href="../modules/widget-position.html">widget-position</a></li>
+
+ <li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
+
+ <li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
+
+ <li><a href="../modules/widget-skin.html">widget-skin</a></li>
+
+ <li><a href="../modules/widget-stack.html">widget-stack</a></li>
+
+ <li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
+
+ <li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
+
+ <li><a href="../modules/yql.html">yql</a></li>
+
+ <li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li>
+
+ <li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li>
+
+ <li><a href="../modules/yql-winjs.html">yql-winjs</a></li>
+
+ <li><a href="../modules/yui.html">yui</a></li>
+
+ <li><a href="../modules/yui-base.html">yui-base</a></li>
+
+ <li><a href="../modules/yui-later.html">yui-later</a></li>
+
+ <li><a href="../modules/yui-log.html">yui-log</a></li>
+
+ <li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <div class="yui3-u-3-4">
+ <div id="api-options">
+ Show:
+ <label for="api-show-inherited">
+ <input type="checkbox" id="api-show-inherited" checked>
+ Inherited
+ </label>
+
+ <label for="api-show-protected">
+ <input type="checkbox" id="api-show-protected">
+ Protected
+ </label>
+
+ <label for="api-show-private">
+ <input type="checkbox" id="api-show-private">
+ Private
+ </label>
+ <label for="api-show-deprecated">
+ <input type="checkbox" id="api-show-deprecated">
+ Deprecated
+ </label>
+
+ </div>
+
+
+ <div class="apidocs">
+ <div id="docs-main">
+ <div class="content">
+ <h1>App.Base Class</h1>
+<div class="box meta">
+
+ <div class="uses">
+ Uses
+ <ul class="inline commas">
+
+ <li><a href="View.html">View</a></li>
+
+ <li><a href="Router.html">Router</a></li>
+
+ <li><a href="PjaxBase.html">PjaxBase</a></li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="extends">
+ Extends <a href="../classes/Base.html" class="crosslink">Base</a>
+ </div>
+
+
+
+ <div class="foundat">
+ Defined in: <a href="../files/app_js_app-base.js.html#l51"><code>app/js/app-base.js:51</code></a>
+ </div>
+
+
+
+
+ Module: <a href="../modules/app-base.html">app-base</a><br>
+ Parent Module: <a href="../modules/app.html">app</a>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+</div>
+
+
+
+<div class="box intro">
+ <p>Provides a top-level application component which manages navigation and views.</p>
+
+<p>This gives you a foundation and structure on which to build your application; it
+combines robust URL navigation with powerful routing and flexible view
+management.</p>
+</div>
+
+
+ <div class="constructor">
+ <h2>Constructor</h2>
+ <div id="method_App.Base" class="method item">
+ <h3 class="name"><code>App.Base</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[config]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l51"><code>app/js/app-base.js:51</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[config]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The following are configuration properties that can be
+ specified <em>in addition</em> to default attribute values and the non-attribute
+ properties provided by <code>Y.Base</code>:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[views]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Hash of view-name to metadata used to
+ declaratively describe an application's views and their relationship with
+ the app and other views. The views specified here will override any defaults
+ provided by the <code>views</code> object on the <code>prototype</code>.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+ </div>
+
+
+<div id="classdocs" class="tabview">
+ <ul class="api-class-tabs">
+ <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+
+ <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
+
+
+ <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
+
+
+ <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
+
+
+ <li class="api-class-tab events"><a href="#events">Events</a></li>
+
+ </ul>
+
+ <div>
+ <div id="index" class="api-class-tabpanel index">
+ <h2 class="off-left">Item Index</h2>
+
+
+ <div class="index-section methods">
+ <h3>Methods</h3>
+
+ <ul class="index-list methods extends">
+
+ <li class="index-item method private inherited">
+ <a href="#method__addAttrs">_addAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__addLazyAttr">_addLazyAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__afterActiveViewChange">_afterActiveViewChange</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__afterContainerChange">_afterContainerChange</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__afterHistoryChange">_afterHistoryChange</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__aggregateAttrs">_aggregateAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__attachView">_attachView</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__attrCfgHash">_attrCfgHash</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__baseDestroy">_baseDestroy</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__baseInit">_baseInit</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__cloneDefaultValue">_cloneDefaultValue</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__decode">_decode</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__defAttrChangeFn">_defAttrChangeFn</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__defDestroyFn">_defDestroyFn</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__defInitFn">_defInitFn</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__defNavigateFn">_defNavigateFn</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__defReadyFn">_defReadyFn</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__dequeue">_dequeue</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__destroyContainer">_destroyContainer</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__destroyHierarchy">_destroyHierarchy</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__detachView">_detachView</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__dispatch">_dispatch</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__filterAttrCfgs">_filterAttrCfgs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__fireAttrChange">_fireAttrChange</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getAttr">_getAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getAttrCfg">_getAttrCfg</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getAttrCfgs">_getAttrCfgs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getAttrInitVal">_getAttrInitVal</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getAttrs">_getAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getClasses">_getClasses</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getContainer">_getContainer</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getFullType">_getFullType</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getHashPath">_getHashPath</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getOrigin">_getOrigin</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getPath">_getPath</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getPathRoot">_getPathRoot</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getQuery">_getQuery</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getRegex">_getRegex</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getRequest">_getRequest</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getResponse">_getResponse</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getRoutes">_getRoutes</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getStateVal">_getStateVal</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__getType">_getType</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__getURL">_getURL</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__getViewContainer">_getViewContainer</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__hasSameOrigin">_hasSameOrigin</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__initAttrHost">_initAttrHost</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited inherited">
+ <a href="#method__initAttribute">_initAttribute</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__initAttrs">_initAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__initBase">_initBase</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__initHierarchy">_initHierarchy</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__initHierarchyData">_initHierarchyData</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__initHtml5">_initHtml5</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__isChildView">_isChildView</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__isLazyAttr">_isLazyAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__isLinkSameOrigin">_isLinkSameOrigin</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__isParentView">_isParentView</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__joinURL">_joinURL</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__monitor">_monitor</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__navigate">_navigate</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__normalizePath">_normalizePath</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__normAttrVals">_normAttrVals</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__onLinkClick">_onLinkClick</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__parseQuery">_parseQuery</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__parseType">_parseType</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__pjaxBindUI">_pjaxBindUI</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__preInitEventCfg">_preInitEventCfg</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected deprecated inherited">
+ <a href="#method__protectAttrs">_protectAttrs</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__publish">_publish</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__queue">_queue</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__resolvePath">_resolvePath</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__resolveURL">_resolveURL</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__save">_save</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited inherited">
+ <a href="#method__set">_set</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__setAttr">_setAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited inherited">
+ <a href="#method__setAttrs">_setAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__setAttrVal">_setAttrVal</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__setRoutes">_setRoutes</a>
+
+
+
+ </li>
+
+ <li class="index-item method private inherited">
+ <a href="#method__setStateVal">_setStateVal</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method__uiSetActiveView">_uiSetActiveView</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected inherited">
+ <a href="#method__upgradeURL">_upgradeURL</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_addAttr">addAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_addAttrs">addAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_addTarget">addTarget</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_after">after</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_attachEvents">attachEvents</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_attrAdded">attrAdded</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_before">before</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_bubble">bubble</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_create">create</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_createView">createView</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited inherited">
+ <a href="#method_destroy">destroy</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_detach">detach</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_detachAll">detachAll</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_detachEvents">detachEvents</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_dispatch">dispatch</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_fire">fire</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_get">get</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getAttrs">getAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getEvent">getEvent</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getPath">getPath</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_getTargets">getTargets</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_getViewInfo">getViewInfo</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_hasRoute">hasRoute</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited inherited">
+ <a href="#method_init">init</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_match">match</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_modifyAttr">modifyAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_navigate">navigate</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_on">on</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_once">once</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_onceAfter">onceAfter</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_parseType">parseType</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_publish">publish</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_remove">remove</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_removeAttr">removeAttr</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_removeQuery">removeQuery</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_removeRoot">removeRoot</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_removeTarget">removeTarget</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_render">render</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_replace">replace</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_reset">reset</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_route">route</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_save">save</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited inherited">
+ <a href="#method_set">set</a>
+
+
+
+ </li>
+
+ <li class="index-item method inherited inherited">
+ <a href="#method_setAttrs">setAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_showView">showView</a>
+
+
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_subscribe">subscribe</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_toString">toString</a>
+
+
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_unsubscribe">unsubscribe</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method deprecated inherited">
+ <a href="#method_unsubscribeAll">unsubscribeAll</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method inherited">
+ <a href="#method_upgrade">upgrade</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="index-section properties">
+ <h3>Properties</h3>
+
+ <ul class="index-list properties extends">
+
+ <li class="index-item property protected inherited inherited">
+ <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__dispatched">_dispatched</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__dispatching">_dispatching</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__historyEvents">_historyEvents</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__html5">_html5</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected">
+ <a href="#property__NON_ATTRS_CFG">_NON_ATTRS_CFG</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__pjaxEvents">_pjaxEvents</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__ready">_ready</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__regexPathParam">_regexPathParam</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__regexURL">_regexURL</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__regexUrlOrigin">_regexUrlOrigin</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected inherited">
+ <a href="#property__regexUrlQuery">_regexUrlQuery</a>
+
+
+
+ </li>
+
+ <li class="index-item property protected">
+ <a href="#property__viewInfoMap">_viewInfoMap</a>
+
+
+
+ </li>
+
+ <li class="index-item property inherited">
+ <a href="#property_containerTemplate">containerTemplate</a>
+
+
+
+ </li>
+
+ <li class="index-item property inherited">
+ <a href="#property_events">events</a>
+
+
+
+ </li>
+
+ <li class="index-item property deprecated inherited">
+ <a href="#property_name">name</a>
+
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item property inherited">
+ <a href="#property_template">template</a>
+
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_views">views</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="index-section attrs">
+ <h3>Attributes</h3>
+
+ <ul class="index-list attrs extends">
+
+ <li class="index-item attr">
+ <a href="#attr_activeView">activeView</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_container">container</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_destroyed">destroyed</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_html5">html5</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_initialized">initialized</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_linkSelector">linkSelector</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_navigateOnHash">navigateOnHash</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_root">root</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_routes">routes</a>
+ </li>
+
+ <li class="index-item attr inherited">
+ <a href="#attr_scrollToTop">scrollToTop</a>
+ </li>
+
+ <li class="index-item attr">
+ <a href="#attr_serverRouting">serverRouting</a>
+ </li>
+
+ <li class="index-item attr">
+ <a href="#attr_viewContainer">viewContainer</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="index-section events">
+ <h3>Events</h3>
+
+ <ul class="index-list events extends">
+
+ <li class="index-item event inherited">
+ <a href="#event_destroy">destroy</a>
+
+
+
+ </li>
+
+ <li class="index-item event inherited">
+ <a href="#event_init">init</a>
+
+
+
+ </li>
+
+ <li class="index-item event inherited">
+ <a href="#event_navigate">navigate</a>
+
+
+
+ </li>
+
+ <li class="index-item event inherited">
+ <a href="#event_ready">ready</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+ </div>
+
+
+ <div id="methods" class="api-class-tabpanel">
+ <h2 class="off-left">Methods</h2>
+
+
+ <div id="method__addAttrs" class="method item private inherited">
+ <h3 class="name"><code>_addAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cfgs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>values</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>lazy</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l836"><code>attribute/js/AttributeCore.js:836</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Implementation behind the public addAttrs method.</p>
+
+<p>This method is invoked directly by get if it encounters a scenario
+in which an attribute's valueFn attempts to obtain the
+value an attribute in the same group of attributes, which has not yet
+been added (on demand initialization).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cfgs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute name/configuration pairs.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">values</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute name/value pairs, defining the initial values to apply.
+Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">lazy</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether or not to delay the intialization of these attributes until the first call to get/set.
+Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
+See <a href="#method_addAttr">addAttr</a>.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__addLazyAttr" class="method item private inherited">
+ <h3 class="name"><code>_addLazyAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[lazyCfg]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l382"><code>attribute/js/AttributeCore.js:382</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Finishes initializing an attribute which has been lazily added.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[lazyCfg]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional config hash for the attribute. This is added for performance
+along the critical path, where the calling method has already obtained lazy config from state.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__afterActiveViewChange" class="method item protected">
+ <h3 class="name"><code>_afterActiveViewChange</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l801"><code>app/js/app-base.js:801</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Handles the application's <code>activeViewChange</code> event (which is fired when the
+<code>activeView</code> attribute changes) by detaching the old view, attaching the new
+view.</p>
+
+<p>The <code>activeView</code> attribute is read-only, so the public API to change its
+value is through the <code>showView()</code> method.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__afterContainerChange" class="method item protected inherited">
+ <h3 class="name"><code>_afterContainerChange</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method__afterContainerChange">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l357"><code>app/js/view.js:357</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Handles <code>containerChange</code> events. Detaches event handlers from the old
+container (if any) and attaches them to the new container.</p>
+
+<p>Right now the <code>container</code> attr is initOnly so this event should only ever
+fire the first time the container is created, but in the future (once Y.App
+can handle it) we may allow runtime container changes.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__afterHistoryChange" class="method item protected inherited">
+ <h3 class="name"><code>_afterHistoryChange</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__afterHistoryChange">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1269"><code>app/js/router.js:1269</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Handles <code>history:change</code> and <code>hashchange</code> events.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__aggregateAttrs" class="method item private inherited">
+ <h3 class="name"><code>_aggregateAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>allAttrs</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l575"><code>base/js/BaseCore.js:575</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>A helper method, used by _initHierarchyData to aggregate
+attribute configuration across the instances class hierarchy.</p>
+
+<p>The method will protect the attribute configuration value to protect the statically defined
+default value in ATTRS if required (if the value is an object literal, array or the
+attribute configuration has cloneDefaultValue set to shallow or deep).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">allAttrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An array of ATTRS definitions across classes in the hierarchy
+(subclass first, Base last)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The aggregate set of ATTRS definitions for the instance
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__attachView" class="method item protected">
+ <h3 class="name"><code>_attachView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>prepend=false</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l434"><code>app/js/app-base.js:434</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to attach the view instance to the application by making the
+app a bubble target of the view, append the view to the <code>viewContainer</code>, and
+assign it to the <code>instance</code> property of the associated view info metadata.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>View to attach.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">prepend=false</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether the view should be prepended instead
+ of appended to the <code>viewContainer</code>.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__attrCfgHash" class="method item private inherited">
+ <h3 class="name"><code>_attrCfgHash</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__attrCfgHash">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l538"><code>base/js/BaseCore.js:538</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to define the attribute hash used to filter/whitelist property mixes for
+this class for iteration performance reasons.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__baseDestroy" class="method item private inherited">
+ <h3 class="name"><code>_baseDestroy</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l309"><code>base/js/BaseCore.js:309</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Internal destroy implementation for BaseCore</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__baseInit" class="method item private inherited">
+ <h3 class="name"><code>_baseInit</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l281"><code>base/js/BaseCore.js:281</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Internal initialization implementation for BaseCore</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__cloneDefaultValue" class="method item private inherited">
+ <h3 class="name"><code>_cloneDefaultValue</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cfg</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l549"><code>base/js/BaseCore.js:549</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>This method assumes that the value has already been checked to be an object.
+Since it's on a critical path, we don't want to re-do the check.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__decode" class="method item protected inherited">
+ <h3 class="name"><code>_decode</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>string</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__decode">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l564"><code>app/js/router.js:564</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Wrapper around <code>decodeURIComponent</code> that also converts <code>+</code> chars into
+spaces.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">string</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>String to decode.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Decoded string.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__defAttrChangeFn" class="method item private inherited">
+ <h3 class="name"><code>_defAttrChangeFn</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeObservable.js.html#l186"><code>attribute/js/AttributeObservable.js:186</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Default function for attribute change events.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The event object for attribute change events.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__defDestroyFn" class="method item protected inherited">
+ <h3 class="name"><code>_defDestroyFn</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>:
+
+
+
+ <a href="../files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Default destroy event handler</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Event object</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__defInitFn" class="method item protected inherited">
+ <h3 class="name"><code>_defInitFn</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method__defInitFn">BaseObservable</a>:
+
+
+
+ <a href="../files/base_js_BaseObservable.js.html#l178"><code>base/js/BaseObservable.js:178</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Default init event handler</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Event object, with a cfg property which
+refers to the configuration object passed to the constructor.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__defNavigateFn" class="method item protected inherited">
+ <h3 class="name"><code>_defNavigateFn</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method__defNavigateFn">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l300"><code>pjax/js/pjax-base.js:300</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Default handler for the <code>navigate</code> event.</p>
+
+<p>Adds a new history entry or replaces the current entry for the specified URL
+and will scroll the page to the top if configured to do so.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__defReadyFn" class="method item protected inherited">
+ <h3 class="name"><code>_defReadyFn</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__defReadyFn">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1300"><code>app/js/router.js:1300</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Default handler for the <code>ready</code> event.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__dequeue" class="method item protected inherited">
+ <h3 class="name"><code>_dequeue</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__dequeue">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l577"><code>app/js/router.js:577</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Shifts the topmost <code>_save()</code> call off the queue and executes it. Does
+nothing if the queue is empty.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__destroyContainer" class="method item protected">
+ <h3 class="name"><code>_destroyContainer</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/View.html#method__destroyContainer">
+ View
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l472"><code>app/js/app-base.js:472</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Overrides View's container destruction to deal with the <code>viewContainer</code> and
+checks to make sure not to remove and purge the <code><body></code>.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__destroyHierarchy" class="method item private inherited">
+ <h3 class="name"><code>_destroyHierarchy</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l721"><code>base/js/BaseCore.js:721</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Destroys the class hierarchy for this instance by invoking
+the destructor method on the prototype of each class in the hierarchy.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__detachView" class="method item protected">
+ <h3 class="name"><code>_detachView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l514"><code>app/js/app-base.js:514</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to detach the view instance from the application by removing
+the application as a bubble target of the view, and either just removing the
+view if it is intended to be preserved, or destroying the instance
+completely.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>View to detach.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__dispatch" class="method item protected inherited">
+ <h3 class="name"><code>_dispatch</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>src</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__dispatch">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l605"><code>app/js/router.js:605</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Dispatches to the first route handler that matches the specified <em>path</em>.</p>
+
+<p>If called before the <code>ready</code> event has fired, the dispatch will be aborted.
+This ensures normalized behavior between Chrome (which fires a <code>popstate</code>
+event on every pageview) and other browsers (which do not).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL path.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Full URL.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">src</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>What initiated the dispatch.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__filterAdHocAttrs" class="method item private inherited">
+ <h3 class="name"><code>_filterAdHocAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>allAttrs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>userVals</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l427"><code>base/js/BaseCore.js:427</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">allAttrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The set of all attribute configurations for this instance.
+Attributes will be removed from this set, if they belong to the filtered class, so
+that by the time all classes are processed, allCfgs will be empty.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">userVals</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The set of adhoc attributes passed in, in the form
+of an object with attribute name/configuration pairs.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__filterAttrCfgs" class="method item private inherited">
+ <h3 class="name"><code>_filterAttrCfgs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>clazz</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>allCfgs</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__filterAttrCfgs">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l356"><code>base/js/BaseCore.js:356</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>A helper method used when processing ATTRS across the class hierarchy during
+initialization. Returns a disposable object with the attributes defined for
+the provided class, extracted from the set of all attributes passed in.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">clazz</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The class for which the desired attributes are required.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">allCfgs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The set of all attribute configurations for this instance.
+Attributes will be removed from this set, if they belong to the filtered class, so
+that by the time all classes are processed, allCfgs will be empty.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The set of attributes belonging to the class passed in, in the form
+of an object with attribute name/configuration pairs.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__fireAttrChange" class="method item private inherited">
+ <h3 class="name"><code>_fireAttrChange</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrName</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subAttrName</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>currVal</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>newVal</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>opts</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[cfg]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method__fireAttrChange">AttributeObservable</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeObservable.js.html#l120"><code>attribute/js/AttributeObservable.js:120</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to help setup the event payload and fire the attribute change event.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The full path of the property being changed,
+if this is a sub-attribute value being change. Otherwise null.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">currVal</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The current value of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The new value of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">opts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Any additional event data to mix into the attribute change event's event facade.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[cfg]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The attribute config stored in State, if already available.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__getAttr" class="method item protected inherited">
+ <h3 class="name"><code>_getAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Any</span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l543"><code>attribute/js/AttributeCore.js:543</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Provides the common implementation for the public get method,
+allowing Attribute hosts to over-ride either method.</p>
+
+<p>See <a href="#method_get">get</a> for argument details.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Any</span>:
+
+ The value of the attribute.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getAttrCfg" class="method item protected inherited">
+ <h3 class="name"><code>_getAttrCfg</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeExtras.js.html#l114"><code>attribute/js/AttributeExtras.js:114</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an object with the configuration properties (and value)
+for the given attribute. If attrName is not provided, returns the
+configuration properties for all attributes.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The configuration properties for the given attribute, or all attributes.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getAttrCfgs" class="method item protected inherited">
+ <h3 class="name"><code>_getAttrCfgs</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l339"><code>base/js/BaseCore.js:339</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an aggregated set of attribute configurations, by traversing
+the class hierarchy.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The hash of attribute configurations, aggregated across classes in the hierarchy
+This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
+the cached value.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getAttrInitVal" class="method item private inherited">
+ <h3 class="name"><code>_getAttrInitVal</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attr</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>cfg</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>initValues</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Any</span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__getAttrInitVal">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l945"><code>attribute/js/AttributeCore.js:945</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the initial value of the given attribute from
+either the default configuration provided, or the
+over-ridden value if it exists in the set of initValues
+provided and the attribute is not read-only.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attr</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The attribute configuration object</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">initValues</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Any</span>:
+
+ The initial value of the attribute.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getAttrs" class="method item protected inherited">
+ <h3 class="name"><code>_getAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l774"><code>attribute/js/AttributeCore.js:774</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An array of attribute names. If omitted, all attribute values are
+returned. If set to true, all attributes modified from their initial values are returned.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ An object with attribute name/value pairs.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getClasses" class="method item protected inherited">
+ <h3 class="name"><code>_getClasses</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l323"><code>base/js/BaseCore.js:323</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>:
+
+ An array of classes (constructor functions), making up the class hierarchy for this object.
+This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
+cached value.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getContainer" class="method item protected inherited">
+ <h3 class="name"><code>_getContainer</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method__getContainer">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l323"><code>app/js/view.js:323</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Getter for the <code>container</code> attribute.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span>
+
+
+
+
+ <div class="param-description">
+ <p>Current attribute value.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
+
+ Container node.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getFullType" class="method item private inherited">
+ <h3 class="name"><code>_getFullType</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__getFullType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l586"><code>event-custom/js/event-target.js:586</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the fully qualified type, given a short type string.
+That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.</p>
+
+<p>NOTE: This method, unlike _getType, does no checking of the value passed in, and
+is designed to be used with the low level _publish() method, for critical path
+implementations which need to fast-track publish for performance reasons.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The short type to prefix</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ The prefixed type, if a prefix is set, otherwise the type passed in
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getHashPath" class="method item protected inherited">
+ <h3 class="name"><code>_getHashPath</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[hash]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getHashPath">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l697"><code>app/js/router.js:697</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the resolved path from the hash fragment, or an empty string if the
+hash is not path-like.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[hash]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Hash fragment to resolve into a path. By default this
+ will be the hash from the current URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Current hash path, or an empty string if the hash is empty.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getOrigin" class="method item protected inherited">
+ <h3 class="name"><code>_getOrigin</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getOrigin">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l718"><code>app/js/router.js:718</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the location origin (i.e., protocol, host, and port) as a URL.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Location origin (i.e., protocol, host, and port).
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>http://example.com
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method__getPath" class="method item protected inherited">
+ <h3 class="name"><code>_getPath</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getPath">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l733"><code>app/js/router.js:733</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the current route path, relative to the <code>root</code> (if any).</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Current route path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getPathRoot" class="method item protected inherited">
+ <h3 class="name"><code>_getPathRoot</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getPathRoot">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l747"><code>app/js/router.js:747</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Returns the current path root after popping off the last path segment,
+making it useful for resolving other URL paths against.</p>
+
+<p>The path root will always begin and end with a '/'.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ The URL's path root.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getQuery" class="method item protected inherited">
+ <h3 class="name"><code>_getQuery</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getQuery">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l773"><code>app/js/router.js:773</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the current route query string.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Current route query string.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getRegex" class="method item protected inherited">
+ <h3 class="name"><code>_getRegex</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>keys</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getRegex">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l794"><code>app/js/router.js:794</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Creates a regular expression from the given route specification. If <em>path</em>
+is already a regex, it will be returned unmodified.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>Route path specification.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">keys</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Array reference to which route parameter names will be
+ added.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>:
+
+ Route regex.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getRequest" class="method item protected inherited">
+ <h3 class="name"><code>_getRequest</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>src</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getRequest">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l829"><code>app/js/router.js:829</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets a request object that can be passed to a route handler.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Current path being dispatched.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Current full URL being dispatched.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">src</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>What initiated the dispatch.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ Request object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getResponse" class="method item protected inherited">
+ <h3 class="name"><code>_getResponse</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>req</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getResponse">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l848"><code>app/js/router.js:848</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets a response object that can be passed to a route handler.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">req</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Request object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ Response Object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getRoutes" class="method item protected inherited">
+ <h3 class="name"><code>_getRoutes</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getRoutes">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l867"><code>app/js/router.js:867</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Getter for the <code>routes</code> attribute.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
+
+ Array of route objects.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getStateVal" class="method item private inherited">
+ <h3 class="name"><code>_getStateVal</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[cfg]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Any</span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l600"><code>attribute/js/AttributeCore.js:600</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the stored value for the attribute, from either the
+internal state object, or the state proxy if it exits</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[cfg]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional config hash for the attribute. This is added for performance along the critical path,
+where the calling method has already obtained the config from state.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Any</span>:
+
+ The stored value of the attribute
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getType" class="method item private inherited">
+ <h3 class="name"><code>_getType</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__getType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>If the instance has a prefix attribute and the
+event type is not prefixed, the instance prefix is
+applied to the supplied type.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__getURL" class="method item protected inherited">
+ <h3 class="name"><code>_getURL</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__getURL">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l878"><code>app/js/router.js:878</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the current full URL.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ URL.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getViewContainer" class="method item protected">
+ <h3 class="name"><code>_getViewContainer</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l555"><code>app/js/app-base.js:555</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Getter for the <code>viewContainer</code> attribute.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | Null</span>
+
+
+
+
+ <div class="param-description">
+ <p>Current attribute value.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
+
+ View container node.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__hasSameOrigin" class="method item protected inherited">
+ <h3 class="name"><code>_hasSameOrigin</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__hasSameOrigin">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l895"><code>app/js/router.js:895</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns <code>true</code> when the specified <code>url</code> is from the same origin as the
+current URL; i.e., the protocol, host, and port of the URLs are the same.</p>
+
+<p>All host or path relative URLs are of the same origin. A scheme-relative URL
+is first prefixed with the current scheme before being evaluated.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to compare origin with the current URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ Whether the URL has the same origin of the current URL.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__initAttrHost" class="method item private inherited">
+ <h3 class="name"><code>_initAttrHost</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>values</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>lazy</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l140"><code>attribute/js/AttributeCore.js:140</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the
+constructor.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <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>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">values</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <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>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">lazy</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__initAttribute" class="method item private inherited">
+ <h3 class="name"><code>_initAttribute</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method__initAttribute">
+ BaseObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l254"><code>base/js/BaseCore.js:254</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Initializes AttributeCore</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__initAttrs" class="method item protected inherited">
+ <h3 class="name"><code>_initAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>values</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>lazy</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l1011"><code>attribute/js/AttributeCore.js:1011</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to set up initial attributes defined during construction,
+either through the constructor.ATTRS property, or explicitly passed in.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <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>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">values</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <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>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">lazy</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__initBase" class="method item private inherited">
+ <h3 class="name"><code>_initBase</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__initBase">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l219"><code>base/js/BaseCore.js:219</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Internal construction logic for BaseCore.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The constructor configuration object</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__initHierarchy" class="method item private inherited">
+ <h3 class="name"><code>_initHierarchy</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>userVals</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l659"><code>base/js/BaseCore.js:659</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Initializes the class hierarchy for the instance, which includes
+initializing attributes for each class defined in the class's
+static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
+invoking the initializer method on the prototype of each class in the hierarchy.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">userVals</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object with configuration property name/value pairs</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__initHierarchyData" class="method item private inherited">
+ <h3 class="name"><code>_initHierarchyData</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l457"><code>base/js/BaseCore.js:457</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>A helper method used by _getClasses and _getAttrCfgs, which determines both
+the array of classes and aggregate set of attribute configurations
+across the class hierarchy for the instance.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__initHtml5" class="method item protected">
+ <h3 class="name"><code>_initHtml5</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l580"><code>app/js/app-base.js:580</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Provides the default value for the <code>html5</code> attribute.</p>
+
+<p>The value returned is dependent on the value of the <code>serverRouting</code>
+attribute. When <code>serverRouting</code> is explicit set to <code>false</code> (not just falsy),
+the default value for <code>html5</code> will be set to <code>false</code> for <em>all</em> browsers.</p>
+
+<p>When <code>serverRouting</code> is <code>true</code> or <code>undefined</code> the returned value will be
+dependent on the browser's capability of using HTML5 history.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ Whether or not HTML5 history should be used.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__isChildView" class="method item protected">
+ <h3 class="name"><code>_isChildView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>parent</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l606"><code>app/js/app-base.js:606</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Determines if the specified <code>view</code> is configured as a child of the specified
+<code>parent</code> view. This requires both views to be either named-views, or view
+instances created using configuration data that exists in the <code>views</code>
+object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined in the <code>views</code> object,
+ or a view instance.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">parent</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined in the <code>views</code>
+ object, or a view instance.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ Whether the view is configured as a child of the parent.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__isLazyAttr" class="method item private inherited">
+ <h3 class="name"><code>_isLazyAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l369"><code>attribute/js/AttributeCore.js:369</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Checks whether or not the attribute is one which has been
+added lazily and still requires initialization.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ true if it's a lazily added attribute, false otherwise.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__isLinkSameOrigin" class="method item protected inherited">
+ <h3 class="name"><code>_isLinkSameOrigin</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>link</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method__isLinkSameOrigin">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l161"><code>pjax/js/pjax-base.js:161</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.6.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to test whether a specified link/anchor node's <code>href</code> is of
+the same origin as the page's current location.</p>
+
+<p>This normalize browser inconsistencies with how the <code>port</code> is reported for
+anchor elements (IE reports a value for the default port, e.g. "80").</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">link</code>
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The anchor element to test whether its <code>href</code> is of the
+ same origin as the page's current location.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ Whether or not the link's <code>href</code> is of the same origin as
+ the page's current location.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__isParentView" class="method item protected">
+ <h3 class="name"><code>_isParentView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>parent</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l632"><code>app/js/app-base.js:632</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Determines if the specified <code>view</code> is configured as the parent of the
+specified <code>child</code> view. This requires both views to be either named-views,
+or view instances created using configuration data that exists in the
+<code>views</code> object, e.g. created by the <code>createView()</code> or <code>showView()</code> method.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined in the <code>views</code> object,
+ or a view instance.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">parent</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined in the <code>views</code>
+ object, or a view instance.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ Whether the view is configured as the parent of the child.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__joinURL" class="method item protected inherited">
+ <h3 class="name"><code>_joinURL</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__joinURL">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l918"><code>app/js/router.js:918</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Joins the <code>root</code> URL to the specified <em>url</em>, normalizing leading/trailing
+<code>/</code> characters.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to append to the <code>root</code> URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Joined URL.
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>router.set('root', '/foo');
+router._joinURL('bar'); // => '/foo/bar'
+router._joinURL('/bar'); // => '/foo/bar'
+
+router.set('root', '/foo/');
+router._joinURL('bar'); // => '/foo/bar'
+router._joinURL('/bar'); // => '/foo/bar'
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method__monitor" class="method item private inherited">
+ <h3 class="name"><code>_monitor</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>what</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>eventType</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l658"><code>event-custom/js/event-target.js:658</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>This is the entry point for the event monitoring system.
+You can monitor 'attach', 'detach', 'fire', and 'publish'.
+When configured, these events generate an event. click ->
+click<em>attach, click</em>detach, click_publish -- these can
+be subscribed to like other events to monitor the event
+system. Inividual published events can have monitoring
+turned on or off (publish can't be turned off before it
+it published) by setting the events 'monitor' config.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">what</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>'attach', 'detach', 'fire', or 'publish'</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">eventType</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The prefixed name of the event being monitored, or the CustomEvent object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Information about the event interaction, such as
+ fire() args, subscription category, publish config</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__navigate" class="method item protected">
+ <h3 class="name"><code>_navigate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method__navigate">
+ PjaxBase
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l658"><code>app/js/app-base.js:658</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Underlying implementation for <code>navigate()</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The fully-resolved URL that the app should dispatch to
+ its route handlers to fulfill the enhanced navigation "request", or use to
+ update <code>window.location</code> in non-HTML5 history capable browsers when
+ <code>serverRouting</code> is <code>true</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Additional options to configure the navigation.
+ These are mixed into the <code>navigate</code> event facade.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[replace]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether or not the current history
+ entry will be replaced, or a new entry will be created. Will default
+ to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[force]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the enhanced navigation
+ should occur even in browsers without HTML5 history. Will default to
+ <code>true</code> when <code>serverRouting</code> is falsy.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__normalizePath" class="method item protected inherited">
+ <h3 class="name"><code>_normalizePath</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__normalizePath">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l951"><code>app/js/router.js:951</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Returns a normalized path, ridding it of any '..' segments and properly
+handling leading and trailing slashes.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL path to normalize.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Normalized path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__normAttrVals" class="method item private inherited">
+ <h3 class="name"><code>_normAttrVals</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>valueHash</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__normAttrVals">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l897"><code>attribute/js/AttributeCore.js:897</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to normalize attribute values. The base implementation
+simply merges the hash to protect the original.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">valueHash</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute name/value pairs</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ An object literal with 2 properties - "simple" and "complex",
+containing simple and complex attribute values respectively keyed
+by the top level attribute name, or null, if valueHash is falsey.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__onLinkClick" class="method item protected inherited">
+ <h3 class="name"><code>_onLinkClick</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method__onLinkClick">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l325"><code>pjax/js/pjax-base.js:325</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Handler for delegated link-click events which match the <code>linkSelector</code>.</p>
+
+<p>This will attempt to enhance the navigation to the link element's <code>href</code> by
+passing the URL to the <code>_navigate()</code> method. When the navigation is being
+enhanced, the default action is prevented.</p>
+
+<p>If the user clicks a link with the middle/right mouse buttons, or is holding
+down the Ctrl or Command keys, this method's behavior is not applied and
+allows the native behavior to occur. Similarly, if the router is not capable
+or handling the URL because no route-handlers match, the link click will
+behave natively.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__parseQuery" class="method item protected inherited">
+ <h3 class="name"><code>_parseQuery</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>query</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__parseQuery">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l993"><code>app/js/router.js:993</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is
+available, this method will be an alias to that.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">query</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Query string to parse.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ Hash of key/value pairs for query parameters.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__parseType" class="method item private inherited">
+ <h3 class="name"><code>_parseType</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an array with the detach key (if provided),
+and the prefixed event name from _getType
+Y.on('detachcategory| menu:click', fn)</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__pjaxBindUI" class="method item protected inherited">
+ <h3 class="name"><code>_pjaxBindUI</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method__pjaxBindUI">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l279"><code>pjax/js/pjax-base.js:279</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Binds the delegation of link-click events that match the <code>linkSelector</code> to
+the <code>_onLinkClick()</code> handler.</p>
+
+<p>By default this method will only be called if the browser is capable of
+using HTML5 history.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__preInitEventCfg" class="method item private inherited">
+ <h3 class="name"><code>_preInitEventCfg</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method__preInitEventCfg">BaseObservable</a>:
+
+
+
+ <a href="../files/base_js_BaseObservable.js.html#l98"><code>base/js/BaseObservable.js:98</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Handles the special on, after and target properties which allow the user to
+easily configure on and after listeners as well as bubble targets during
+construction, prior to init.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The user configuration object</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__protectAttrs" class="method item protected deprecated inherited">
+ <h3 class="name"><code>_protectAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+ <span class="flag deprecated" title="Use `AttributeCore.protectAttrs()` or
+ `Attribute.protectAttrs()` which are the same static utility method.">deprecated</span>
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l883"><code>attribute/js/AttributeCore.js:883</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: Use `AttributeCore.protectAttrs()` or
+ `Attribute.protectAttrs()` which are the same static utility method.</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Utility method to protect an attribute configuration
+hash, by merging the entire object and the individual
+attr config objects.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A hash of attribute to configuration object pairs.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A protected version of the attrs argument.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__publish" class="method item private inherited">
+ <h3 class="name"><code>_publish</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>fullType</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>etOpts</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>ceOpts</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method__publish">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l610"><code>event-custom/js/event-target.js:610</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The low level event publish implementation. It expects all the massaging to have been done
+outside of this method. e.g. the <code>type</code> to <code>fullType</code> conversion. It's designed to be a fast
+path publish, which can be used by critical code paths to improve performance.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">fullType</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The prefixed type of the event to publish.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">etOpts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The EventTarget specific configuration to mix into the published event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">ceOpts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The publish specific configuration to mix into the published event.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will
+be the default <code>CustomEvent</code> instance, and can be configured independently.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__queue" class="method item protected inherited">
+ <h3 class="name"><code>_queue</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__queue">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1021"><code>app/js/router.js:1021</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Queues up a <code>_save()</code> call to run after all previously-queued calls have
+finished.</p>
+
+<p>This is necessary because if we make multiple <code>_save()</code> calls before the
+first call gets dispatched, then both calls will dispatch to the last call's
+URL.</p>
+
+<p>All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the
+queued function is executed.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__resolvePath" class="method item protected inherited">
+ <h3 class="name"><code>_resolvePath</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__resolvePath">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1066"><code>app/js/router.js:1066</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Returns the normalized result of resolving the <code>path</code> against the current
+path. Falsy values for <code>path</code> will return just the current path.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL path to resolve.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Resolved path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__resolveURL" class="method item protected inherited">
+ <h3 class="name"><code>_resolveURL</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__resolveURL">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1088"><code>app/js/router.js:1088</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Resolves the specified URL against the current URL.</p>
+
+<p>This method resolves URLs like a browser does and will always return an
+absolute URL. When the specified URL is already absolute, it is assumed to
+be fully resolved and is simply returned as is. Scheme-relative URLs are
+prefixed with the current protocol. Relative URLs are giving the current
+URL's origin and are resolved and normalized against the current path root.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to resolve.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Resolved URL.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__save" class="method item protected">
+ <h3 class="name"><code>_save</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[url]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[replace=false]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__save">
+ Router
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l688"><code>app/js/app-base.js:688</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Will either save a history entry using <code>pushState()</code> or the location hash,
+or gracefully-degrade to sending a request to the server causing a full-page
+reload.</p>
+
+<p>Overrides Router's <code>_save()</code> method to preform graceful-degradation when the
+app's <code>serverRouting</code> is <code>true</code> and <code>html5</code> is <code>false</code> by updating the full
+URL via standard assignment to <code>window.location</code> or by calling
+<code>window.location.replace()</code>; both of which will cause a request to the
+server resulting in a full-page reload.</p>
+
+<p>Otherwise this will just delegate off to Router's <code>_save()</code> method allowing
+the client-side enhanced routing to occur.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[url]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>URL for the history entry.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[replace=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, the current history entry will
+ be replaced instead of a new one being added.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__set" class="method item protected inherited">
+ <h3 class="name"><code>_set</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>val</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method__set">
+ AttributeObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l427"><code>attribute/js/AttributeCore.js:427</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">val</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The value to set the attribute to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setAttr" class="method item protected inherited">
+ <h3 class="name"><code>_setAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>force</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l443"><code>attribute/js/AttributeCore.js:443</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Provides the common implementation for the public set and protected _set methods.</p>
+
+<p>See <a href="#method_set">set</a> for argument details.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The value to set the attribute to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">force</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If true, allows the caller to set values for
+readOnly or writeOnce attributes which have already been set.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setAttrs" class="method item protected inherited">
+ <h3 class="name"><code>_setAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method__setAttrs">
+ AttributeObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l742"><code>attribute/js/AttributeCore.js:742</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attributes name/value pairs.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setAttrVal" class="method item private inherited">
+ <h3 class="name"><code>_setAttrVal</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrName</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subAttrName</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>prevVal</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>newVal</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[attrCfg]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Booolean</span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l640"><code>attribute/js/AttributeCore.js:640</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Updates the stored value of the attribute in the privately held State object,
+if validation and setter passes.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The attribute name.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The currently stored value of the attribute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The value which is going to be stored.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[attrCfg]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional config hash for the attribute. This is added for performance along the critical path,
+where the calling method has already obtained the config from state.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Booolean</span>:
+
+ true if the new attribute value was stored, false if not.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setRoutes" class="method item protected inherited">
+ <h3 class="name"><code>_setRoutes</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>routes</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__setRoutes">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1203"><code>app/js/router.js:1203</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Setter for the <code>routes</code> attribute.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">routes</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Array of route objects.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
+
+ Array of route objects.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__setStateVal" class="method item private inherited">
+ <h3 class="name"><code>_setStateVal</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l622"><code>attribute/js/AttributeCore.js:622</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets the stored value for the attribute, in either the
+internal state object, or the state proxy if it exits</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The value of the attribute</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__uiSetActiveView" class="method item protected">
+ <h3 class="name"><code>_uiSetActiveView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>newView</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[oldView]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l741"><code>app/js/app-base.js:741</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Performs the actual change of this app's <code>activeView</code> by attaching the
+<code>newView</code> to this app, and detaching the <code>oldView</code> from this app using any
+specified <code>options</code>.</p>
+
+<p>The <code>newView</code> is attached to the app by rendering it to the <code>viewContainer</code>,
+and making this app a bubble target of its events.</p>
+
+<p>The <code>oldView</code> is detached from the app by removing it from the
+<code>viewContainer</code>, and removing this app as a bubble target for its events.
+The <code>oldView</code> will either be preserved or properly destroyed.</p>
+
+<p><strong>Note:</strong> The <code>activeView</code> attribute is read-only and can be changed by
+calling the <code>showView()</code> method.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">newView</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The View which is now this app's <code>activeView</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[oldView]</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The View which was this app's <code>activeView</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional object containing any of the following
+ properties:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Optional callback function to call
+ after new <code>activeView</code> is ready to use, the function will be passed:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+ <div class="param-description">
+ A reference to the new
+ <code>activeView</code>.
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[prepend=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the <code>view</code> should be
+ prepended instead of appended to the <code>viewContainer</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[render]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the <code>view</code> should be rendered.
+ <strong>Note:</strong> If no value is specified, a view instance will only be
+ rendered if it's newly created by this method.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[update=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether an existing view should
+ have its attributes updated by passing the <code>config</code> object to its
+ <code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if
+ the <code>view</code> instance is created as a result of calling this method.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__upgradeURL" class="method item protected inherited">
+ <h3 class="name"><code>_upgradeURL</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method__upgradeURL">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1224"><code>app/js/router.js:1224</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Upgrades a hash-based URL to a full-path URL, if necessary.</p>
+
+<p>The specified <code>url</code> will be upgraded if its of the same origin as the
+current URL and has a path-like hash. URLs that don't need upgrading will be
+returned as-is.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The URL to upgrade from hash-based to full-path.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ The upgraded URL, or the specified URL untouched.
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_addAttr" class="method item inherited">
+ <h3 class="name"><code>addAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>lazy</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l157"><code>attribute/js/AttributeCore.js:157</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>
+Adds an attribute with the provided configuration to the host object.
+</p>
+
+<p>
+The config argument object supports the following properties:
+</p>
+
+<dl>
+ <dt>value <Any></dt>
+ <dd>The initial value to set on the attribute</dd>
+
+ <dt>valueFn <Function | String></dt>
+ <dd>
+ <p>A function, which will return the initial value to set on the attribute. This is useful
+ for cases where the attribute configuration is defined statically, but needs to
+ reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,
+ the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which
+ case the value property is used.</p>
+
+ <p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>
+ </dd>
+
+ <dt>readOnly <boolean></dt>
+ <dd>Whether or not the attribute is read only. Attributes having readOnly set to true
+ cannot be modified by invoking the set method.</dd>
+
+ <dt>writeOnce <boolean> or <string></dt>
+ <dd>
+ Whether or not the attribute is "write once". Attributes having writeOnce set to true,
+ can only have their values set once, be it through the default configuration,
+ constructor configuration arguments, or by invoking set.
+ <p>The writeOnce attribute can also be set to the string "initOnly",
+ in which case the attribute can only be set during initialization
+ (when used with Base, this means it can only be set during construction)</p>
+ </dd>
+
+ <dt>setter <Function | String></dt>
+ <dd>
+ <p>The setter function used to massage or normalize the value passed to the set method for the attribute.
+ The value returned by the setter will be the final stored value. Returning
+ <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
+ the value from being stored.
+ </p>
+
+ <p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>
+ </dd>
+
+ <dt>getter <Function | String></dt>
+ <dd>
+ <p>
+ The getter function used to massage or normalize the value returned by the get method for the attribute.
+ The value returned by the getter function is the value which will be returned to the user when they
+ invoke get.
+ </p>
+
+ <p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>
+ </dd>
+
+ <dt>validator <Function | String></dt>
+ <dd>
+ <p>
+ The validator function invoked prior to setting the stored value. Returning
+ false from the validator function will prevent the value from being stored.
+ </p>
+
+ <p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>
+ </dd>
+
+ <dt>lazyAdd <boolean></dt>
+ <dd>Whether or not to delay initialization of the attribute until the first call to get/set it.
+ This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
+ the <a href="#method_addAttrs">addAttrs</a> method.</dd>
+
+</dl>
+
+<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
+the context ("this") set to the host object.</p>
+
+<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,
+and are not intended for public use.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>
+
+<p>
+<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
+to protect the original values, you will need to merge the object.
+</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">lazy</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_addAttrs" class="method item inherited">
+ <h3 class="name"><code>addAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cfgs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>values</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>lazy</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l805"><code>attribute/js/AttributeCore.js:805</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Configures a group of attributes, and sets initial values.</p>
+
+<p>
+<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.
+The caller is responsible for merging/cloning the configuration object if required.
+</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cfgs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute name/configuration pairs.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">values</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attribute name/value pairs, defining the initial values to apply.
+Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">lazy</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether or not to delay the intialization of these attributes until the first call to get/set.
+Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
+See <a href="#method_addAttr">addAttr</a>.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_addTarget" class="method item inherited">
+ <h3 class="name"><code>addTarget</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l455"><code>event-custom/js/event-facade.js:455</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Registers another EventTarget as a bubble target. Bubble order
+is determined by the order registered. Multiple targets can
+be specified.</p>
+
+<p>Events can only bubble if emitFacade is true.</p>
+
+<p>Included in the event-custom-complex submodule.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the target to add</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_after" class="method item inherited">
+ <h3 class="name"><code>after</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_after">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l833"><code>event-custom/js/event-target.js:833</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Subscribe to a custom event hosted by this object. The
+supplied callback will execute after any listeners add
+via the subscribe method, and after the default function,
+if configured for the event, has executed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_attachEvents" class="method item inherited">
+ <h3 class="name"><code>attachEvents</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[events]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method_attachEvents">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l181"><code>app/js/view.js:181</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Attaches delegated event handlers to this view's container element. This
+method is called internally to subscribe to events configured in the
+<code>events</code> attribute when the view is initialized.</p>
+
+<p>You may override this method to customize the event attaching logic.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[events]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Hash of events to attach. See the docs for the
+ <code>events</code> attribute for details on the format. If not specified, this
+ view's <code>events</code> property will be used.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_attrAdded" class="method item inherited">
+ <h3 class="name"><code>attrAdded</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l341"><code>attribute/js/AttributeCore.js:341</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Checks if the given attribute has been added to the host</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute to check.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ 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.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_before" class="method item inherited">
+ <h3 class="name"><code>before</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_before">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l870"><code>event-custom/js/event-target.js:870</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the callback before a DOM event, custom event
+or method. If the first argument is a function, it
+is assumed the target is a method. For DOM and custom
+events, this is an alias for Y.on.</p>
+
+<p>For DOM and custom events:
+type, callback, context, 0-n arguments</p>
+
+<p>For methods:
+callback, object (method host), methodName, context, 0-n arguments</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ detach handle
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_bubble" class="method item inherited">
+ <h3 class="name"><code>bubble</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>evt</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l507"><code>event-custom/js/event-facade.js:507</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Propagate an event. Requires the event-custom-complex module.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">evt</code>
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the custom event to propagate</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ the aggregated return value from Event.Custom.fire
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_create" class="method item inherited">
+ <h3 class="name"><code>create</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[container]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method_create">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l233"><code>app/js/view.js:233</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Creates and returns a container node for this view.</p>
+
+<p>By default, the container is created from the HTML template specified in the
+<code>containerTemplate</code> property, and is <em>not</em> added to the DOM automatically.</p>
+
+<p>You may override this method to customize how the container node is created
+(such as by rendering it from a custom template format). Your method must
+return a <code>Y.Node</code> instance.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[container]</code>
+ <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>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Selector string, <code>Y.Node</code>
+ instance, or DOM element to use at the container node.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
+
+ Node instance of the created container node.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_createView" class="method item">
+ <h3 class="name"><code>createView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[config]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l185"><code>app/js/app-base.js:185</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Creates and returns a new view instance using the provided <code>name</code> to look up
+the view info metadata defined in the <code>views</code> object. The passed-in <code>config</code>
+object is passed to the view constructor function.</p>
+
+<p>This function also maps a view instance back to its view info metadata.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined on the <code>views</code> object.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[config]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The configuration object passed to the view
+ constructor function when creating the new view instance.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>:
+
+ The new view instance.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_destroy" class="method item inherited">
+ <h3 class="name"><code>destroy</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method_destroy">
+ BaseObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_view.js.html#l146"><code>app/js/view.js:146</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Destroys this View, detaching any DOM events and optionally also destroying
+its container node.</p>
+
+<p>By default, the container node will not be destroyed. Pass an <em>options</em>
+object with a truthy <code>remove</code> property to destroy the container as well.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Options.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[remove=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>If <code>true</code>, this View's container
+ will be removed from the DOM and destroyed as well.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_detach" class="method item inherited">
+ <h3 class="name"><code>detach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_detach">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l346"><code>event-custom/js/event-target.js:346</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Detach one or more listeners the from the specified event</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>Either the handle to the subscriber or the
+ type of event. If the type
+ is not specified, it will attempt to remove
+ the listener from all hosted events.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The subscribed function to unsubscribe, if not
+ supplied, all subscribers will be removed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The custom object passed to subscribe. This is
+ optional, but if supplied will be used to
+ disambiguate multiple listeners that are the same
+ (e.g., you subscribe many object using a function
+ that lives on the prototype)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
+
+ the host
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_detachAll" class="method item inherited">
+ <h3 class="name"><code>detachAll</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l469"><code>event-custom/js/event-target.js:469</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners from the specified event. If the event type
+is not specified, all listeners from all hosted custom events will
+be removed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_detachEvents" class="method item inherited">
+ <h3 class="name"><code>detachEvents</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method_detachEvents">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l253"><code>app/js/view.js:253</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Detaches DOM events that have previously been attached to the container by
+<code>attachEvents()</code>.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_dispatch" class="method item inherited">
+ <h3 class="name"><code>dispatch</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_dispatch">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l206"><code>app/js/router.js:206</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Dispatches to the first route handler that matches the current URL, if any.</p>
+
+<p>If <code>dispatch()</code> is called before the <code>ready</code> event has fired, it will
+automatically wait for the <code>ready</code> event before dispatching. Otherwise it
+will dispatch immediately.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_fire" class="method item inherited">
+ <h3 class="name"><code>fire</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>arguments</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_fire">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l695"><code>event-custom/js/event-target.js:695</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Fire a custom event by name. The callback functions will be executed
+from the context specified when the event was created, and with the
+following parameters.</p>
+
+<p>If the custom event object hasn't been created, then the event hasn't
+been published and it has no subscribers. For performance sake, we
+immediate exit in this case. This means the event won't bubble, so
+if the intention is that a bubble target be notified, the event must
+be published on this object first.</p>
+
+<p>The first argument is the event type, and any additional arguments are
+passed to the listeners as parameters. If the first of these is an
+object literal, and the event is configured to emit an event facade,
+that object is mixed into the event facade and the facade is provided
+in place of the original object.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The type of the event, or an object that contains
+a 'type' property.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">arguments</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an arbitrary set of parameters to pass to
+the handler. If the first of these is an object literal and the event is
+configured to emit an event facade, the event facade will replace that
+parameter after the properties the object literal contains are copied to
+the event facade.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
+
+ the event host
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_get" class="method item inherited">
+ <h3 class="name"><code>get</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Any</span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l353"><code>attribute/js/AttributeCore.js:353</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the current value of the attribute. If the attribute
+has been configured with a 'getter' function, this method will delegate
+to the 'getter' to obtain the value of the attribute.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute. If the value of the attribute is an Object,
+dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Any</span>:
+
+ The value of the attribute
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getAttrs" class="method item inherited">
+ <h3 class="name"><code>getAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l762"><code>attribute/js/AttributeCore.js:762</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets multiple attribute values.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. An array of attribute names. If omitted, all attribute values are
+returned. If set to true, all attributes modified from their initial values are returned.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ An object with attribute name/value pairs.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getEvent" class="method item inherited">
+ <h3 class="name"><code>getEvent</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>prefixed</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l814"><code>event-custom/js/event-target.js:814</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns the custom event of the provided type has been created, a
+falsy value otherwise</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">prefixed</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>if true, the type is prefixed already</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ the custom event or null
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getPath" class="method item inherited">
+ <h3 class="name"><code>getPath</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_getPath">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l228"><code>app/js/router.js:228</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Gets the current route path, relative to the <code>root</code> (if any).</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Current route path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getTargets" class="method item inherited">
+ <h3 class="name"><code>getTargets</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l479"><code>event-custom/js/event-facade.js:479</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an array of bubble targets for this object.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ EventTarget[]
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getViewInfo" class="method item">
+ <h3 class="name"><code>getViewInfo</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l215"><code>app/js/app-base.js:215</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Returns the metadata associated with a view instance or view name defined on
+the <code>views</code> object.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>View instance, or name of a view defined on the
+ <code>views</code> object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ The metadata for the view, or <code>undefined</code> if the view is
+ not registered.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_hasRoute" class="method item inherited">
+ <h3 class="name"><code>hasRoute</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_hasRoute">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l238"><code>app/js/router.js:238</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns <code>true</code> if this router has at least one route that matches the
+specified URL, <code>false</code> otherwise.</p>
+
+<p>This method enforces the same-origin security constraint on the specified
+<code>url</code>; any URL which is not from the same origin as the current URL will
+always return <code>false</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to match.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ <code>true</code> if there's at least one matching route, <code>false</code>
+ otherwise.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_init" class="method item inherited">
+ <h3 class="name"><code>init</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cfg</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#method_init">
+ BaseObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l264"><code>base/js/BaseCore.js:264</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Init lifecycle method, invoked during construction. Sets up attributes
+and invokes initializers for the class hierarchy.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cfg</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Object with configuration property name/value pairs</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/BaseCore.html" class="crosslink">BaseCore</a></span>:
+
+ A reference to this object
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_match" class="method item inherited">
+ <h3 class="name"><code>match</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_match">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l267"><code>app/js/router.js:267</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns an array of route objects that match the specified URL path.</p>
+
+<p>This method is called internally to determine which routes match the current
+path whenever the URL changes. You may override it if you want to customize
+the route matching logic, although this usually shouldn't be necessary.</p>
+
+<p>Each returned route object has the following properties:</p>
+
+<ul>
+<li><p><code>callback</code>: A function or a string representing the name of a function
+this router that should be executed when the route is triggered.</p></li>
+<li><p><code>keys</code>: An array of strings representing the named parameters defined in
+the route's path specification, if any.</p></li>
+<li><p><code>path</code>: The route's path specification, which may be either a string or
+a regex.</p></li>
+<li><p><code>regex</code>: A regular expression version of the route's path specification.
+This regex is used to determine whether the route matches a given path.</p></li>
+</ul>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL path to match.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>:
+
+ Array of route objects that match the specified path.
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>router.route('/foo', function () {});
+router.match('/foo');
+// => [{callback: ..., keys: [], path: '/foo', regex: ...}]
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_modifyAttr" class="method item inherited">
+ <h3 class="name"><code>modifyAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeExtras.js.html#l40"><code>attribute/js/AttributeExtras.js:40</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Updates the configuration of an attribute which has already been added.</p>
+
+<p>
+The properties which can be modified through this interface are limited
+to the following subset of attributes, which can be safely modified
+after a value has already been set on the attribute: readOnly, writeOnce,
+broadcast and getter.
+</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute whose configuration is to be updated.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_navigate" class="method item">
+ <h3 class="name"><code>navigate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#method_navigate">
+ PjaxBase
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l234"><code>app/js/app-base.js:234</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Navigates to the specified URL if there is a route handler that matches. In
+browsers capable of using HTML5 history or when <code>serverRouting</code> is falsy,
+the navigation will be enhanced by firing the <code>navigate</code> event and having
+the app handle the "request". When <code>serverRouting</code> is <code>true</code>, non-HTML5
+browsers will navigate to the new URL via a full page reload.</p>
+
+<p>When there is a route handler for the specified URL and it is being
+navigated to, this method will return <code>true</code>, otherwise it will return
+<code>false</code>.</p>
+
+<p><strong>Note:</strong> The specified URL <em>must</em> be of the same origin as the current URL,
+otherwise an error will be logged and navigation will not occur. This is
+intended as both a security constraint and a purposely imposed limitation as
+it does not make sense to tell the app to navigate to a URL on a
+different scheme, host, or port.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The URL to navigate to. This must be of the same origin
+ as the current URL.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Additional options to configure the navigation.
+ These are mixed into the <code>navigate</code> event facade.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[replace]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether or not the current history
+ entry will be replaced, or a new entry will be created. Will default
+ to <code>true</code> if the specified <code>url</code> is the same as the current URL.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[force]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the enhanced navigation
+ should occur even in browsers without HTML5 history. Will default to
+ <code>true</code> when <code>serverRouting</code> is falsy.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_on" class="method item inherited">
+ <h3 class="name"><code>on</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_on">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l188"><code>event-custom/js/event-target.js:188</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Subscribe a callback function to a custom event fired by this object or
+from an object that bubbles its events to this object.</p>
+
+<p>Callback functions for events published with <code>emitFacade = true</code> will
+receive an <code>EventFacade</code> as the first argument (typically named "e").
+These callbacks can then call <code>e.preventDefault()</code> to disable the
+behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>
+API for all available properties and methods. Subscribers to
+non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>
+after the event name.</p>
+
+<p>To subscribe to multiple events at once, pass an object as the first
+argument, where the key:value pairs correspond to the eventName:callback,
+or pass an array of event names as the first argument to subscribe to
+all listed events with the same callback.</p>
+
+<p>Returning <code>false</code> from a callback is supported as an alternative to
+calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is
+recommended to use the event methods whenever possible.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching that
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_once" class="method item inherited">
+ <h3 class="name"><code>once</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_once">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l124"><code>event-custom/js/event-target.js:124</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Listen to a custom event hosted by this object one time.
+This is the equivalent to <code>on</code> except the
+listener is immediatelly detached when it is executed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching the
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_onceAfter" class="method item inherited">
+ <h3 class="name"><code>onceAfter</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[context]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[arg*]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l146"><code>event-custom/js/event-target.js:146</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Listen to a custom event hosted by this object one time.
+This is the equivalent to <code>after</code> except the
+listener is immediatelly detached when it is executed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute in response to the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[context]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Override <code>this</code> object in callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[arg*]</code>
+ <span class="type">Any</span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to supply to the subscriber</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ A subscription handle capable of detaching that
+ subscription
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_parseType" class="method item inherited">
+ <h3 class="name"><code>parseType</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[pre=this._yuievt.config.prefix]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l168"><code>event-custom/js/event-target.js:168</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.3.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Takes the type parameter passed to 'on' and parses out the
+various pieces that could be included in the type. If the
+event type is passed without a prefix, it will be expanded
+to include the prefix one is supplied or the event target
+is configured with a default prefix.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[pre=this._yuievt.config.prefix]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>the prefix</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ an array containing:
+ * the detach category, if supplied,
+ * the prefixed event type,
+ * whether or not this is an after listener,
+ * the supplied event type
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_publish" class="method item inherited">
+ <h3 class="name"><code>publish</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>opts</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_publish">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l493"><code>event-custom/js/event-target.js:493</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Creates a new custom event of the specified type. If a custom event
+by that name already exists, it will not be re-created. In either
+case the custom event is returned.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">opts</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional config params. Valid properties are:</p>
+
+<p><ul>
+ <li>
+ 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
+ </li>
+ <li>
+ 'bubbles': whether or not this event bubbles (true)
+ Events can only bubble if emitFacade is true.
+ </li>
+ <li>
+ 'context': the default execution context for the listeners (this)
+ </li>
+ <li>
+ 'defaultFn': the default function to execute when this event fires if preventDefault was not called
+ </li>
+ <li>
+ 'emitFacade': whether or not this event emits a facade (false)
+ </li>
+ <li>
+ 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
+ </li>
+ <li>
+ 'fireOnce': if an event is configured to fire once, new subscribers after
+ the fire will be notified immediately.
+ </li>
+ <li>
+ 'async': fireOnce event listeners will fire synchronously if the event has already
+ fired unless async is true.
+ </li>
+ <li>
+ 'preventable': whether or not preventDefault() has an effect (true)
+ </li>
+ <li>
+ 'preventedFn': a function that is executed when preventDefault is called
+ </li>
+ <li>
+ 'queuable': whether or not this event can be queued during bubbling (false)
+ </li>
+ <li>
+ 'silent': if silent is true, debug messages are not provided for this event.
+ </li>
+ <li>
+ 'stoppedFn': a function that is executed when stopPropagation is called
+ </li></p>
+
+<p><li>
+ 'monitored': specifies whether or not this event should send notifications about
+ when the event has been attached, detached, or published.
+ </li>
+ <li>
+ 'type': the event type (valid option if not provided as the first parameter to publish)
+ </li>
+ </ul></p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ the custom event
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_remove" class="method item inherited">
+ <h3 class="name"><code>remove</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#method_remove">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l272"><code>app/js/view.js:272</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes this view's container element from the DOM (if it's in the DOM),
+but doesn't destroy it or any event listeners attached to it.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_removeAttr" class="method item inherited">
+ <h3 class="name"><code>removeAttr</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeExtras.js.html#l79"><code>attribute/js/AttributeExtras.js:79</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes an attribute from the host object</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute to be removed.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_removeQuery" class="method item inherited">
+ <h3 class="name"><code>removeQuery</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_removeQuery">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l325"><code>app/js/router.js:325</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes a query string from the end of the <em>url</em> (if one exists) and returns
+the result.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Queryless path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_removeRoot" class="method item inherited">
+ <h3 class="name"><code>removeRoot</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>url</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_removeRoot">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l303"><code>app/js/router.js:303</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes the <code>root</code> URL from the front of <em>url</em> (if it's there) and returns
+the result. The returned path will always have a leading <code>/</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ Rootless path.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_removeTarget" class="method item inherited">
+ <h3 class="name"><code>removeTarget</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-facade.js.html#l489"><code>event-custom/js/event-facade.js:489</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes a bubble target</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the target to remove</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_render" class="method item">
+ <h3 class="name"><code>render</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/View.html#method_render">
+ View
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l266"><code>app/js/app-base.js:266</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Renders this application by appending the <code>viewContainer</code> node to the
+<code>container</code> node if it isn't already a child of the container, and the
+<code>activeView</code> will be appended the view container, if it isn't already.</p>
+
+<p>You should call this method at least once, usually after the initialization
+of your app instance so the proper DOM structure is setup and optionally
+append the container to the DOM if it's not there already.</p>
+
+<p>You may override this method to customize the app's rendering, but you
+should expect that the <code>viewContainer</code>'s contents will be modified by the
+app for the purpose of rendering the <code>activeView</code> when it changes.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_replace" class="method item inherited">
+ <h3 class="name"><code>replace</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[url]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_replace">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l337"><code>app/js/router.js:337</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Replaces the current browser history entry with a new one, and dispatches to
+the first matching route handler, if any.</p>
+
+<p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that
+support it (or the location hash in older browsers and IE) to change the
+URL.</p>
+
+<p>The specified URL must share the same origin (i.e., protocol, host, and
+port) as the current page, or an error will occur.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[url]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to set. This URL needs to be of the same origin as
+ the current URL. This can be a URL relative to the router's <code>root</code>
+ attribute. If no URL is specified, the page's current URL will be used.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>// Starting URL: http://example.com/
+
+router.replace('/path/');
+// New URL: http://example.com/path/
+
+router.replace('/path?foo=bar');
+// New URL: http://example.com/path?foo=bar
+
+router.replace('/');
+// New URL: http://example.com/
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_reset" class="method item inherited">
+ <h3 class="name"><code>reset</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:
+
+
+
+ <a href="../files/attribute_js_AttributeExtras.js.html#l89"><code>attribute/js/AttributeExtras.js:89</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Resets the attribute (or all attributes) to its initial value, as long as
+the attribute is not readOnly, or writeOnce.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_route" class="method item inherited">
+ <h3 class="name"><code>route</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>callbacks</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_route">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l371"><code>app/js/router.js:371</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Adds a route handler for the specified URL <em>path</em>.</p>
+
+<p>The <em>path</em> parameter may be either a string or a regular expression. If it's
+a string, it may contain named parameters: <code>:param</code> will match any single
+part of a URL path (not including <code>/</code> characters), and <code>*param</code> will match
+any number of parts of a URL path (including <code>/</code> characters). These named
+parameters will be made available as keys on the <code>req.params</code> object that's
+passed to route handlers.</p>
+
+<p>If the <em>path</em> parameter is a regex, all pattern matches will be made
+available as numbered keys on <code>req.params</code>, starting with <code>0</code> for the full
+match, then <code>1</code> for the first subpattern match, and so on.</p>
+
+<p>Here's a set of sample routes along with URL paths that they match:</p>
+
+<ul>
+<li><p>Route: <code>/photos/:tag/:page</code></p>
+
+<ul><li>URL: <code>/photos/kittens/1</code>, params: <code>{tag: 'kittens', page: '1'}</code></li>
+<li>URL: <code>/photos/puppies/2</code>, params: <code>{tag: 'puppies', page: '2'}</code></li></ul></li>
+<li><p>Route: <code>/file/*path</code></p>
+
+<ul><li>URL: <code>/file/foo/bar/baz.txt</code>, params: <code>{path: 'foo/bar/baz.txt'}</code></li>
+<li>URL: <code>/file/foo</code>, params: <code>{path: 'foo'}</code></li></ul></li>
+</ul>
+
+<p><strong>Middleware</strong>: Routes also support an arbitrary number of callback
+functions. This allows you to easily reuse parts of your route-handling code
+with different route. This method is liberal in how it processes the
+specified <code>callbacks</code>, you can specify them as separate arguments, or as
+arrays, or both.</p>
+
+<p>If multiple route match a given URL, they will be executed in the order they
+were added. The first route that was added will be the first to be executed.</p>
+
+<p><strong>Passing Control</strong>: Invoking the <code>next()</code> function within a route callback
+will pass control to the next callback function (if any) or route handler
+(if any). If a value is passed to <code>next()</code>, it's assumed to be an error,
+therefore stopping the dispatch chain, unless that value is: <code>"route"</code>,
+which is special case and dispatching will skip to the next route handler.
+This allows middleware to skip any remaining middleware for a particular
+route.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>Path to match. May be a string or a regular
+ expression.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">callbacks</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>Callback functions to call
+ whenever this route is triggered. These can be specified as separate
+ arguments, or in arrays, or both. If a callback is specified as a
+ string, the named function will be called on this router instance.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">req</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+ <div class="param-description">
+ <p>Request object containing information about
+ the request. It contains the following properties.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">params</code>
+ <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>
+
+
+ <div class="param-description">
+ Captured parameters matched by
+ the route path specification. If a string path was used and contained
+ named parameters, then this will be a key/value hash mapping parameter
+ names to their matched values. If a regex path was used, this will be
+ an array of subpattern matches starting at index 0 for the full match,
+ then 1 for the first subpattern match, and so on.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ The current URL path.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">pendingCallbacks</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+ <div class="param-description">
+ Number of remaining
+ callbacks the route handler has after this one in the dispatch chain.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">pendingRoutes</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+ <div class="param-description">
+ Number of matching routes
+ after this one in the dispatch chain.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">query</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+ <div class="param-description">
+ Query hash representing the URL
+ query string, if any. Parameter names are keys, and are mapped to
+ parameter values.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ The full URL.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">src</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <div class="param-description">
+ What initiated the dispatch. In an
+ HTML5 browser, when the back/forward buttons are used, this property
+ will have a value of "popstate".
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">res</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+ <div class="param-description">
+ <p>Response object containing methods and
+ information that relate to responding to a request. It contains the
+ following properties.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">req</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+ <div class="param-description">
+ Reference to the request object.
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">next</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+ <div class="param-description">
+ <p>Function to pass control to the next
+ callback or the next matching route if no more callbacks (middleware)
+ exist for the current route handler. If you don't call this function,
+ then no further callbacks or route handlers will be executed, even if
+ there are more that match. If you do call this function, then the next
+ callback (if any) or matching route handler (if any) will be called.
+ All of these functions will receive the same <code>req</code> and <code>res</code> objects
+ that were passed to this route (so you can use these objects to pass
+ data along to subsequent callbacks and routes).</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[err]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ Optional error which will stop the
+ dispatch chaining for this <code>req</code>, unless the value is <code>"route"</code>, which
+ is special cased to jump skip past any callbacks for the current route
+ and pass control the next route handler.
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>router.route('/photos/:tag/:page', function (req, res, next) {
+ Y.log('Current tag: ' + req.params.tag);
+ Y.log('Current page number: ' + req.params.page);
+});
+
+// Using middleware.
+
+router.findUser = function (req, res, next) {
+ req.user = this.get('users').findById(req.params.user);
+ next();
+};
+
+router.route('/users/:user', 'findUser', function (req, res, next) {
+ // The <code>findUser</code> middleware puts the <code>user</code> object on the <code>req</code>.
+ Y.log('Current user:' req.user.get('name'));
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_save" class="method item inherited">
+ <h3 class="name"><code>save</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code class="optional">[url]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_save">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l498"><code>app/js/router.js:498</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Saves a new browser history entry and dispatches to the first matching route
+handler, if any.</p>
+
+<p>Behind the scenes, this method uses HTML5 <code>pushState()</code> in browsers that
+support it (or the location hash in older browsers and IE) to change the
+URL and create a history entry.</p>
+
+<p>The specified URL must share the same origin (i.e., protocol, host, and
+port) as the current page, or an error will occur.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[url]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>URL to set. This URL needs to be of the same origin as
+ the current URL. This can be a URL relative to the router's <code>root</code>
+ attribute. If no URL is specified, the page's current URL will be used.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>// Starting URL: http://example.com/
+
+router.save('/path/');
+// New URL: http://example.com/path/
+
+router.save('/path?foo=bar');
+// New URL: http://example.com/path?foo=bar
+
+router.save('/');
+// New URL: http://example.com/
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_set" class="method item inherited">
+ <h3 class="name"><code>set</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>value</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method_set">
+ AttributeObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l410"><code>attribute/js/AttributeCore.js:410</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets the value of an attribute.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the attribute. If the
+current value of the attribute is an Object, dot notation can be used
+to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">value</code>
+ <span class="type">Any</span>
+
+
+
+
+ <div class="param-description">
+ <p>The value to set the attribute to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_setAttrs" class="method item inherited">
+ <h3 class="name"><code>setAttrs</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>attrs</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[opts]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/AttributeObservable.html#method_setAttrs">
+ AttributeObservable
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/attribute_js_AttributeCore.js.html#l729"><code>attribute/js/AttributeCore.js:729</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets multiple attribute values.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">attrs</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with attributes name/value pairs.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[opts]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional data providing the circumstances for the change.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
+
+ A reference to the host object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_showView" class="method item">
+ <h3 class="name"><code>showView</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>view</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[config]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[callback]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag chainable">chainable</span>
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l307"><code>app/js/app-base.js:307</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Sets which view is active/visible for the application. This will set the
+app's <code>activeView</code> attribute to the specified <code>view</code>.</p>
+
+<p>The <code>view</code> will be "attached" to this app, meaning it will be both rendered
+into this app's <code>viewContainer</code> node and all of its events will bubble to
+the app. The previous <code>activeView</code> will be "detached" from this app.</p>
+
+<p>When a string-name is provided for a view which has been registered on this
+app's <code>views</code> object, the referenced metadata will be used and the
+<code>activeView</code> will be set to either a preserved view instance, or a new
+instance of the registered view will be created using the specified <code>config</code>
+object passed-into this method.</p>
+
+<p>A callback function can be specified as either the third or fourth argument,
+and this function will be called after the new <code>view</code> becomes the
+<code>activeView</code>, is rendered to the <code>viewContainer</code>, and is ready to use.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <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>
+
+
+
+
+ <div class="param-description">
+ <p>The name of a view defined in the <code>views</code> object,
+ or a view instance which should become this app's <code>activeView</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[config]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional configuration to use when creating a new
+ view instance. This config object can also be used to update an existing
+ or preserved view's attributes when <code>options.update</code> is <code>true</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional object containing any of the following
+ properties:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Optional callback function to call
+ after new <code>activeView</code> is ready to use, the function will be passed:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+ <div class="param-description">
+ A reference to the new
+ <code>activeView</code>.
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[prepend=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the <code>view</code> should be
+ prepended instead of appended to the <code>viewContainer</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[render]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether the <code>view</code> should be rendered.
+ <strong>Note:</strong> If no value is specified, a view instance will only be
+ rendered if it's newly created by this method.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[update=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>Whether an existing view should
+ have its attributes updated by passing the <code>config</code> object to its
+ <code>setAttrs()</code> method. <strong>Note:</strong> This option does not have an effect if
+ the <code>view</code> instance is created as a result of calling this method.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[callback]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Optional callback Function to call after the
+ new <code>activeView</code> is ready to use. <strong>Note:</strong> this will override
+ <code>options.callback</code> and it can be specified as either the third or fourth
+ argument. The function will be passed the following:</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">view</code>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+ <div class="param-description">
+ <p>A reference to the new <code>activeView</code>.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>var app = new Y.App({
+ views: {
+ usersView: {
+ // Imagine that <code>Y.UsersView</code> has been defined.
+ type: Y.UsersView
+ }
+ },
+
+ users: new Y.ModelList()
+});
+
+app.route('/users/', function () {
+ this.showView('usersView', {users: this.get('users')});
+});
+
+app.render();
+app.navigate('/uses/'); // => Creates a new <code>Y.UsersView</code> and shows it.
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_subscribe" class="method item deprecated inherited">
+ <h3 class="name"><code>subscribe</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+ <span class="flag deprecated" title="use on">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l336"><code>event-custom/js/event-target.js:336</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use on</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>subscribe to an event</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_toString" class="method item inherited">
+ <h3 class="name"><code>toString</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#method_toString">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l754"><code>base/js/BaseCore.js:754</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Default toString implementation. Provides the constructor NAME
+and the instance guid, if set.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ String representation for this object
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_unsubscribe" class="method item deprecated inherited">
+ <h3 class="name"><code>unsubscribe</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+ <span class="flag deprecated" title="use detach">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l459"><code>event-custom/js/event-target.js:459</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use detach</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>detach a listener</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_unsubscribeAll" class="method item deprecated inherited">
+ <h3 class="name"><code>unsubscribeAll</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+ <span class="flag deprecated" title="use detachAll">deprecated</span>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
+
+
+
+ <a href="../files/event-custom_js_event-target.js.html#l480"><code>event-custom/js/event-target.js:480</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: use detachAll</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners from the specified event. If the event type
+is not specified, all listeners from all hosted custom events will
+be removed.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type, or name of the event</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_upgrade" class="method item inherited">
+ <h3 class="name"><code>upgrade</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#method_upgrade">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l532"><code>app/js/router.js:532</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Upgrades a hash-based URL to an HTML5 URL if necessary. In non-HTML5
+browsers, this method is a noop.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ <code>true</code> if the URL was upgraded, <code>false</code> otherwise.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ </div>
+
+
+
+ <div id="properties" class="api-class-tabpanel">
+ <h2 class="off-left">Properties</h2>
+
+
+ <div id="property__allowAdHocAttrs" class="property item protected inherited">
+ <h3 class="name"><code>_allowAdHocAttrs</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#property__allowAdHocAttrs">
+ BaseCore
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_view.js.html#l111"><code>app/js/view.js:111</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>This tells <code>Y.Base</code> that it should create ad-hoc attributes for config
+properties passed to View's constructor. This makes it possible to
+instantiate a view and set a bunch of attributes without having to subclass
+<code>Y.View</code> and declare all those attributes first.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> true</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property__dispatched" class="property item protected inherited">
+ <h3 class="name"><code>_dispatched</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__dispatched">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l64"><code>app/js/router.js:64</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Whether or not <code>_dispatch()</code> has been called since this router was
+instantiated.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> undefined</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property__dispatching" class="property item protected inherited">
+ <h3 class="name"><code>_dispatching</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__dispatching">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l74"><code>app/js/router.js:74</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Whether or not we're currently in the process of dispatching to routes.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> undefined</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property__historyEvents" class="property item protected inherited">
+ <h3 class="name"><code>_historyEvents</code></h3>
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__historyEvents">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l83"><code>app/js/router.js:83</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>History event handle for the <code>history:change</code> or <code>hashchange</code> event
+subscription.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__html5" class="property item protected inherited">
+ <h3 class="name"><code>_html5</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__html5">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l92"><code>app/js/router.js:92</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Cached copy of the <code>html5</code> attribute for internal use.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__NON_ATTRS_CFG" class="property item protected">
+ <h3 class="name"><code>_NON_ATTRS_CFG</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l1020"><code>app/js/app-base.js:1020</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Properties that shouldn't be turned into ad-hoc attributes when passed to
+App's constructor.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__pjaxEvents" class="property item protected inherited">
+ <h3 class="name"><code>_pjaxEvents</code></h3>
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#property__pjaxEvents">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l69"><code>pjax/js/pjax-base.js:69</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Holds the delegated pjax-link click handler.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__ready" class="property item protected inherited">
+ <h3 class="name"><code>_ready</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__ready">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l100"><code>app/js/router.js:100</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Whether or not the <code>ready</code> event has fired yet.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> undefined</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property__regexPathParam" class="property item protected inherited">
+ <h3 class="name"><code>_regexPathParam</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__regexPathParam">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l109"><code>app/js/router.js:109</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Regex used to match parameter placeholders in route paths.</p>
+
+<p>Subpattern captures:</p>
+
+<ol>
+<li><p>Parameter prefix character. Either a <code>:</code> for subpath parameters that
+ should only match a single level of a path, or <code>*</code> for splat parameters
+ that should match any number of path levels.</p></li>
+<li><p>Parameter name, if specified, otherwise it is a wildcard match.</p></li>
+</ol>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__regexURL" class="property item protected inherited">
+ <h3 class="name"><code>_regexURL</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#property__regexURL">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l78"><code>pjax/js/pjax-base.js:78</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Regex used to break up a URL string around the URL's path.</p>
+
+<p>Subpattern captures:</p>
+
+<ol>
+<li>Origin, everything before the URL's path-part.</li>
+<li>The URL's path-part.</li>
+<li>Suffix, everything after the URL's path-part.</li>
+</ol>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__regexUrlOrigin" class="property item protected inherited">
+ <h3 class="name"><code>_regexUrlOrigin</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__regexUrlOrigin">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l136"><code>app/js/router.js:136</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Regex that matches everything before the path portion of a URL (the origin).
+This will be used to strip this part of the URL from a string when we
+only want the path.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__regexUrlQuery" class="property item protected inherited">
+ <h3 class="name"><code>_regexUrlQuery</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#property__regexUrlQuery">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l126"><code>app/js/router.js:126</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Regex that matches and captures the query portion of a URL, minus the
+preceding <code>?</code> character, and discarding the hash portion of the URL if any.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__viewInfoMap" class="property item protected">
+ <h3 class="name"><code>_viewInfoMap</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l134"><code>app/js/app-base.js:134</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Map of view instance id (via <code>Y.stamp()</code>) to view-info object in <code>views</code>.</p>
+
+<p>This mapping is used to tie a specific view instance back to its metadata by
+adding a reference to the the related view info on the <code>views</code> object.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> {}</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property_containerTemplate" class="property item inherited">
+ <h3 class="name"><code>containerTemplate</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#property_containerTemplate">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l40"><code>app/js/view.js:40</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Template for this view's container.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> "<div/>"</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property_events" class="property item inherited">
+ <h3 class="name"><code>events</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#property_events">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l50"><code>app/js/view.js:50</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Hash of CSS selectors mapped to events to delegate to elements matching
+those selectors.</p>
+
+<p>CSS selectors are relative to the <code>container</code> element. Events are attached
+to the container, and delegation is used so that subscribers are only
+notified of events that occur on elements inside the container that match
+the specified selectors. This allows the container's contents to be re-
+rendered as needed without losing event subscriptions.</p>
+
+<p>Event handlers can be specified either as functions or as strings that map
+to function names on this view instance or its prototype.</p>
+
+<p>The <code>this</code> object in event handlers will refer to this view instance. If
+you'd prefer <code>this</code> to be something else, use <code>Y.bind()</code> to bind a custom
+<code>this</code> object.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> {}</p>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>var view = new Y.View({
+ events: {
+ // Call <code>this.toggle()</code> whenever the element with the id
+ // "toggle-button" is clicked.
+ '#toggle-button': {click: 'toggle'},
+
+ // Call <code>this.hoverOn()</code> when the mouse moves over any element
+ // with the "hoverable" class, and <code>this.hoverOff()</code> when the
+ // mouse moves out of any element with the "hoverable" class.
+ '.hoverable': {
+ mouseover: 'hoverOn',
+ mouseout : 'hoverOff'
+ }
+ }
+});
+</code></pre>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="property_name" class="property item deprecated inherited">
+ <h3 class="name"><code>name</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+ <span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#property_name">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l242"><code>base/js/BaseCore.js:242</code></a>
+
+ </p>
+
+
+ <p>Deprecated: Use this.constructor.NAME</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The string used to identify the class of this object.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_template" class="property item inherited">
+ <h3 class="name"><code>template</code></h3>
+ <span class="type">Mixed</span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/View.html#property_template">View</a>:
+
+
+
+ <a href="../files/app_js_view.js.html#l91"><code>app/js/view.js:91</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Template for this view's contents.</p>
+
+<p>This is a convenience property that has no default behavior of its own.
+It's only provided as a convention to allow you to store whatever you
+consider to be a template, whether that's an HTML string, a <code>Y.Node</code>
+instance, a Mustache template, or anything else your little heart
+desires.</p>
+
+<p>How this template gets used is entirely up to you and your custom
+<code>render()</code> method.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> ''</p>
+
+
+
+
+
+</div>
+
+
+ <div id="property_views" class="property item">
+ <h3 class="name"><code>views</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l76"><code>app/js/app-base.js:76</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Hash of view-name to metadata used to declaratively describe an
+application's views and their relationship with the app and its other views.</p>
+
+<p>The view metadata is composed of Objects keyed to a view-name that can have
+any or all of the following properties:</p>
+
+<ul>
+<li><p><code>type</code>: Function or a string representing the view constructor to use to
+create view instances. If a string is used, the constructor function is
+assumed to be on the <code>Y</code> object; e.g. <code>"SomeView"</code> -> <code>Y.SomeView</code>.</p></li>
+<li><p><code>preserve</code>: Boolean for whether the view instance should be retained. By
+default, the view instance will be destroyed when it is no longer the
+<code>activeView</code>. If <code>true</code> the view instance will simply be <code>removed()</code>
+from the DOM when it is no longer active. This is useful when the view
+is frequently used and may be expensive to re-create.</p></li>
+<li><p><code>parent</code>: String to another named view in this hash that represents the
+parent view within the application's view hierarchy; e.g. a <code>"photo"</code>
+view could have <code>"album"</code> has its <code>parent</code> view. This parent/child
+relationship is a useful cue for things like transitions.</p></li>
+<li><p><code>instance</code>: Used internally to manage the current instance of this named
+view. This can be used if your view instance is created up-front, or if
+you would rather manage the View lifecycle, but you probably should just
+let this be handled for you.</p></li>
+</ul>
+
+<p>If <code>views</code> are specified at instantiation time, the metadata in the <code>views</code>
+Object here will be used as defaults when creating the instance's <code>views</code>.</p>
+
+<p>Every <code>Y.App</code> instance gets its own copy of a <code>views</code> object so this Object
+on the prototype will not be polluted.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> {}</p>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>// Imagine that <code>Y.UsersView</code> and <code>Y.UserView</code> have been defined.
+var app = new Y.App({
+ views: {
+ users: {
+ type : Y.UsersView,
+ preserve: true
+ },
+
+ user: {
+ type : Y.UserView,
+ parent: 'users'
+ }
+ }
+});
+</code></pre>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ </div>
+
+
+
+ <div id="attrs" class="api-class-tabpanel">
+ <h2 class="off-left">Attributes</h2>
+
+
+ <div id="attr_activeView" class="attr item">
+ <a name="config_activeView"></a>
+ <h3 class="name"><code>activeView</code></h3>
+ <span class="type"><a href="../classes/View.html" class="crosslink">View</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag readonly">readonly</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l819"><code>app/js/app-base.js:819</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>The application's active/visible view.</p>
+
+<p>This attribute is read-only, to set the <code>activeView</code> use the
+<code>showView()</code> method.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> null</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>activeViewChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>activeView</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_container" class="attr item">
+ <a name="config_container"></a>
+ <h3 class="name"><code>container</code></h3>
+ <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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/View.html#attr_container">
+ View
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l837"><code>app/js/app-base.js:837</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Container node which represents the application's bounding-box, into
+which this app's content will be rendered.</p>
+
+<p>The container node serves as the host for all DOM events attached by the
+app. Delegation is used to handle events on children of the container,
+allowing the container's contents to be re-rendered at any time without
+losing event subscriptions.</p>
+
+<p>The default container is the <code><body></code> Node, but you can override this in
+a subclass, or by passing in a custom <code>container</code> config value at
+instantiation time.</p>
+
+<p>When <code>container</code> is overridden by a subclass or passed as a config
+option at instantiation time, it may be provided as a selector string, a
+DOM element, or a <code>Y.Node</code> instance. During initialization, this app's
+<code>create()</code> method will be called to convert the container into a
+<code>Y.Node</code> instance if it isn't one already and stamp it with the CSS
+class: <code>"yui3-app"</code>.</p>
+
+<p>The container is not added to the page automatically. This allows you to
+have full control over how and when your app is actually rendered to
+the page.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> Y.one('body')</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>containerChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>container</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_destroyed" class="attr item inherited">
+ <a name="config_destroyed"></a>
+ <h3 class="name"><code>destroyed</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag readonly">readonly</span>
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Flag indicating whether or not this object
+has been through the destroy lifecycle phase.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> false</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>destroyedChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>destroyed</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_html5" class="attr item">
+ <a name="config_html5"></a>
+ <h3 class="name"><code>html5</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/Router.html#attr_html5">
+ Router
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l872"><code>app/js/app-base.js:872</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Whether or not this browser is capable of using HTML5 history.</p>
+
+<p>This value is dependent on the value of <code>serverRouting</code> and will default
+accordingly.</p>
+
+<p>Setting this to <code>false</code> will force the use of hash-based history even on
+HTML5 browsers, but please don't do this unless you understand the
+consequences.</p>
+ </div>
+
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>html5Change</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>html5</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_initialized" class="attr item inherited">
+ <a name="config_initialized"></a>
+ <h3 class="name"><code>initialized</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag readonly">readonly</span>
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:
+
+
+
+ <a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Flag indicating whether or not this object
+has been through the init lifecycle phase.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> false</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>initializedChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>initialized</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_linkSelector" class="attr item">
+ <a name="config_linkSelector"></a>
+ <h3 class="name"><code>linkSelector</code></h3>
+ <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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#attr_linkSelector">
+ PjaxBase
+ </a>
+
+ but overwritten in
+
+
+
+ <a href="../files/app_js_app-base.js.html#l891"><code>app/js/app-base.js:891</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>CSS selector string used to filter link click events so that only the
+links which match it will have the enhanced-navigation behavior of pjax
+applied.</p>
+
+<p>When a link is clicked and that link matches this selector, navigating
+to the link's <code>href</code> URL using the enhanced, pjax, behavior will be
+attempted; and the browser's default way to navigate to new pages will
+be the fallback.</p>
+
+<p>By default this selector will match <em>all</em> links on the page.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> "a"</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>linkSelectorChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>linkSelector</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_navigateOnHash" class="attr item inherited">
+ <a name="config_navigateOnHash"></a>
+ <h3 class="name"><code>navigateOnHash</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#attr_navigateOnHash">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l401"><code>pjax/js/pjax-base.js:401</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Whether navigating to a hash-fragment identifier on the current page should
+be enhanced and cause the <code>navigate</code> event to fire.</p>
+
+<p>By default Pjax allows the browser to perform its default action when a user
+is navigating within a page by clicking in-page links
+(e.g. <code><a href="#top">Top of page</a></code>) and does not attempt to interfere or
+enhance in-page navigation.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> false</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>navigateOnHashChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>navigateOnHash</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_root" class="attr item inherited">
+ <a name="config_root"></a>
+ <h3 class="name"><code>root</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#attr_root">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1336"><code>app/js/router.js:1336</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Absolute root path from which all routes should be evaluated.</p>
+
+<p>For example, if your router is running on a page at
+<code>http://example.com/myapp/</code> and you add a route with the path <code>/</code>, your
+route will never execute, because the path will always be preceded by
+<code>/myapp</code>. Setting <code>root</code> to <code>/myapp</code> would cause all routes to be
+evaluated relative to that root URL, so the <code>/</code> route would then execute
+when the user browses to <code>http://example.com/myapp/</code>.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> `''`</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>rootChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>root</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_routes" class="attr item inherited">
+ <a name="config_routes"></a>
+ <h3 class="name"><code>routes</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object[]</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#attr_routes">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l1354"><code>app/js/router.js:1354</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Array of route objects.</p>
+
+<p>Each item in the array must be an object with the following properties:</p>
+
+<ul>
+<li><p><code>path</code>: String or regex representing the path to match. See the docs
+for the <code>route()</code> method for more details.</p></li>
+<li><p><code>callbacks</code>: Function or a string representing the name of a
+function on this router instance that should be called when the
+route is triggered. An array of functions and/or strings may also be
+provided. See the docs for the <code>route()</code> method for more details.</p></li>
+</ul>
+
+<p>This attribute is intended to be used to set routes at init time, or to
+completely reset all routes after init. To add routes after init without
+resetting all existing routes, use the <code>route()</code> method.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> `[]`</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>routesChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>routes</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_scrollToTop" class="attr item inherited">
+ <a name="config_scrollToTop"></a>
+ <h3 class="name"><code>scrollToTop</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#attr_scrollToTop">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l419"><code>pjax/js/pjax-base.js:419</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Whether the page should be scrolled to the top after navigating to a URL.</p>
+
+<p>When the user clicks the browser's back button, the previous scroll position
+will be maintained.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> true</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>scrollToTopChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>scrollToTop</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_serverRouting" class="attr item">
+ <a name="config_serverRouting"></a>
+ <h3 class="name"><code>serverRouting</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l911"><code>app/js/app-base.js:911</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Whether or not this application's server is capable of properly routing
+all requests and rendering the initial state in the HTML responses.</p>
+
+<p>This can have three different values, each having particular
+implications on how the app will handle routing and navigation:</p>
+
+<ul>
+<li><p><code>undefined</code>: The best form of URLs will be chosen based on the
+capabilities of the browser. Given no information about the server
+environmentm a balanced approach to routing and navigation is
+chosen.</p>
+
+<p>The server should be capable of handling full-path requests, since
+full-URLs will be generated by browsers using HTML5 history. If this
+is a client-side-only app the server could handle full-URL requests
+by sending a redirect back to the root with a hash-based URL, e.g:</p>
+
+<pre class="code prettyprint"><code>Request: http://example.com/users/1
+Redirect to: http://example.com/#/users/1
+</code></pre></li>
+<li><p><code>true</code>: The server is <em>fully</em> capable of properly handling requests
+to all full-path URLs the app can produce.</p>
+
+<p>This is the best option for progressive-enhancement because it will
+cause <strong>all URLs to always have full-paths</strong>, which means the server
+will be able to accurately handle all URLs this app produces. e.g.</p>
+
+<pre class="code prettyprint"><code>http://example.com/users/1
+</code></pre>
+
+<p>To meet this strict full-URL requirement, browsers which are not
+capable of using HTML5 history will make requests to the server
+resulting in full-page reloads.</p></li>
+<li><p><code>false</code>: The server is <em>not</em> capable of properly handling requests
+to all full-path URLs the app can produce, therefore all routing
+will be handled by this App instance.</p>
+
+<p>Be aware that this will cause <strong>all URLs to always be hash-based</strong>,
+even in browsers that are capable of using HTML5 history. e.g.</p>
+
+<pre class="code prettyprint"><code>http://example.com/#/users/1
+</code></pre>
+
+<p>A single-page or client-side-only app where the server sends a
+"shell" page with JavaScript to the client might have this
+restriction. If you're setting this to <code>false</code>, read the following:</p></li>
+</ul>
+
+<p><strong>Note:</strong> When this is set to <code>false</code>, the server will <em>never</em> receive
+the full URL because browsers do not send the fragment-part to the
+server, that is everything after and including the "#".</p>
+
+<p>Consider the following example:</p>
+
+<pre class="code prettyprint"><code>URL shown in browser: http://example.com/#/users/1
+URL sent to server: http://example.com/
+</code></pre>
+
+<p>You should feel bad about hurting our precious web if you forcefully set
+either <code>serverRouting</code> or <code>html5</code> to <code>false</code>, because you're basically
+punching the web in the face here with your lossy URLs! Please make sure
+you know what you're doing and that you understand the implications.</p>
+
+<p>Ideally you should always prefer full-path URLs (not /#/foo/), and want
+full-page reloads when the client's browser is not capable of enhancing
+the experience using the HTML5 history APIs. Setting this to <code>true</code> is
+the best option for progressive-enhancement (and graceful-degradation).</p>
+ </div>
+
+
+ <p><strong>Default:</strong> undefined</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>serverRoutingChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>serverRouting</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="attr_viewContainer" class="attr item">
+ <a name="config_viewContainer"></a>
+ <h3 class="name"><code>viewContainer</code></h3>
+ <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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/app_js_app-base.js.html#l987"><code>app/js/app-base.js:987</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>The node into which this app's <code>views</code> will be rendered when they become
+the <code>activeView</code>.</p>
+
+<p>The view container node serves as the container to hold the app's
+<code>activeView</code>. Each time the <code>activeView</code> is set via <code>showView()</code>, the
+previous view will be removed from this node, and the new active view's
+<code>container</code> node will be appended.</p>
+
+<p>The default view container is a <code><div></code> Node, but you can override this
+in a subclass, or by passing in a custom <code>viewContainer</code> config value at
+instantiation time. The <code>viewContainer</code> may be provided as a selector
+string, DOM element, or a <code>Y.Node</code> instance (having the <code>viewContainer</code>
+and the <code>container</code> be the same node is also supported).</p>
+
+<p>The app's <code>render()</code> method will stamp the view container with the CSS
+class <code>"yui3-app-views"</code> and append it to the app's <code>container</code> node if
+it isn't already, and any <code>activeView</code> will be appended to this node if
+it isn't already.</p>
+ </div>
+
+
+ <p><strong>Default:</strong> Y.Node.create(this.containerTemplate)</p>
+
+
+
+ <div class="emits box">
+ <h4>Fires event <code>viewContainerChange</code></h4>
+
+ <p>
+ Fires when the value for the configuration attribute <code>viewContainer</code> is
+ changed. You can listen for the event using the <code>on</code> method if you
+ wish to be notified before the attribute's value has changed, or
+ using the <code>after</code> method if you wish to be notified after the
+ attribute's value has changed.
+ </p>
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+ <div class="param-description">
+ An Event Facade object with the following
+ attribute-specific properties added:
+ </div>
+
+ <ul class="params-list">
+ <li class="param">
+ <code class="param-name">prevVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value of the attribute, prior to it being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">newVal</code>
+ <span class="type">Any</span>
+ <div class="param-description">The value the attribute is to be set to.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">attrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">The name of the attribute being set.</div>
+ </li>
+ <li class="param">
+ <code class="param-name">subAttrName</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ </div>
+
+
+
+ <div id="events" class="api-class-tabpanel">
+ <h2 class="off-left">Events</h2>
+
+
+ <div id="event_destroy" class="events item inherited">
+ <h3 class="name"><code>destroy</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#event_destroy">BaseObservable</a>:
+
+
+
+ <a href="../files/base_js_BaseObservable.js.html#l151"><code>base/js/BaseObservable.js:151</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>
+Lifecycle event for the destroy phase,
+fired prior to destruction. Invoking the preventDefault
+method on the event object provided to subscribers will
+prevent destruction from proceeding.
+</p>
+
+<p>
+Subscribers to the "after" moment of this event, will be notified
+after destruction is complete (and as a result cannot prevent
+destruction).
+</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Event object</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_init" class="events item inherited">
+ <h3 class="name"><code>init</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/BaseObservable.html#event_init">BaseObservable</a>:
+
+
+
+ <a href="../files/base_js_BaseObservable.js.html#l62"><code>base/js/BaseObservable.js:62</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>
+Lifecycle event for the init phase, fired prior to initialization.
+Invoking the preventDefault() method on the event object provided
+to subscribers will prevent initialization from occuring.
+</p>
+
+<p>
+Subscribers to the "after" momemt of this event, will be notified
+after initialization of the object is complete (and therefore
+cannot prevent initialization).
+</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Event object, with a cfg property which
+refers to the configuration object passed to the constructor.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_navigate" class="events item inherited">
+ <h3 class="name"><code>navigate</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/PjaxBase.html#event_navigate">PjaxBase</a>:
+
+
+
+ <a href="../files/pjax_js_pjax-base.js.html#l16"><code>pjax/js/pjax-base.js:16</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.5.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Fired when navigating to a URL via Pjax.</p>
+
+<p>When the <code>navigate()</code> method is called or a pjax link is clicked, this event
+will be fired if the browser supports HTML5 history <em>and</em> the router has a
+route handler for the specified URL.</p>
+
+<p>This is a useful event to listen to for adding a visual loading indicator
+while the route handlers are busy handling the URL change.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">url</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The URL that the router will dispatch to its route
+ handlers in order to fulfill the enhanced navigation "request".</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[force=false]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether the enhanced navigation should occur
+ even in browsers without HTML5 history.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[hash]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The hash-fragment (including "#") of the <code>url</code>. This
+ will be present when the <code>url</code> differs from the current URL only by its
+ hash and <code>navigateOnHash</code> has been set to <code>true</code>.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[originEvent]</code>
+ <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The event that caused the navigation. Usually
+ this would be a click event from a "pjax" anchor element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[replace]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Whether or not the current history entry will be
+ replaced, or a new entry will be created. Will default to <code>true</code> if the
+ specified <code>url</code> is the same as the current URL.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ <div id="event_ready" class="events item inherited">
+ <h3 class="name"><code>ready</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+ <p>Inherited from
+ <a href="../classes/Router.html#event_ready">Router</a>:
+
+
+
+ <a href="../files/app_js_router.js.html#l24"><code>app/js/router.js:24</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Fired when the router is ready to begin dispatching to route handlers.</p>
+
+<p>You shouldn't need to wait for this event unless you plan to implement some
+kind of custom dispatching logic. It's used internally in order to avoid
+dispatching to an initial route if a browser history change occurs first.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">dispatched</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p><code>true</code> if routes have already been dispatched
+ (most likely due to a history change).</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ </div>
+
+ </div>
+</div>
+
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>