<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Panel - 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>Panel Class</h1>
<div class="box meta">
<div class="uses">
Uses
<ul class="inline commas">
<li><a href="WidgetAutohide.html">WidgetAutohide</a></li>
<li><a href="WidgetButtons.html">WidgetButtons</a></li>
<li><a href="WidgetModality.html">WidgetModality</a></li>
<li><a href="WidgetPosition.html">WidgetPosition</a></li>
<li><a href="WidgetPositionAlign.html">WidgetPositionAlign</a></li>
<li><a href="WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
<li><a href="WidgetStack.html">WidgetStack</a></li>
<li><a href="WidgetStdMod.html">WidgetStdMod</a></li>
</ul>
</div>
<div class="extends">
Extends <a href="../classes/Widget.html" class="crosslink">Widget</a>
</div>
<div class="foundat">
Defined in: <a href="../files/panel_js_panel.js.html#l14"><code>panel/js/panel.js:14</code></a>
</div>
Module: <a href="../modules/panel.html">panel</a>
<p>Available since 3.4.0</p>
</div>
<div class="box intro">
<p>A basic Panel Widget, which can be positioned based on Page XY co-ordinates and
is stackable (z-index support). It also provides alignment and centering support
and uses a standard module format for it's content, with header, body and footer
section support. It can be made modal, and has functionality to hide and focus
on different events. The header and footer sections can be modified to allow for
button support.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Panel" class="method item">
<h3 class="name"><code>Panel</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/panel_js_panel.js.html#l14"><code>panel/js/panel.js:14</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
</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 private inherited">
<a href="#method__addShimResizeHandlers">_addShimResizeHandlers</a>
</li>
<li class="index-item method private inherited">
<a href="#method__addStdModContent">_addStdModContent</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterAlignChange">_afterAlignChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterAlignOnChange">_afterAlignOnChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterBodyChange">_afterBodyChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterButtonsChange">_afterButtonsChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterChildSelectedChange">_afterChildSelectedChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterConstrainChange">_afterConstrainChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterContentChangeButtons">_afterContentChangeButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterDefaultButtonChange">_afterDefaultButtonChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterFillHeightChange">_afterFillHeightChange</a>
</li>
<li class="index-item method inherited">
<a href="#method__afterFocusOnChange">_afterFocusOnChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterFooterChange">_afterFooterChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterHeaderChange">_afterHeaderChange</a>
</li>
<li class="index-item method inherited">
<a href="#method__afterHideOnChange">_afterHideOnChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterHostVisibleChangeAutohide">_afterHostVisibleChangeAutohide</a>
</li>
<li class="index-item method inherited">
<a href="#method__afterHostVisibleChangeModal">_afterHostVisibleChangeModal</a>
</li>
<li class="index-item method inherited">
<a href="#method__afterHostZIndexChangeModal">_afterHostZIndexChangeModal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterShimChange">_afterShimChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterVisibleChangeButtons">_afterVisibleChangeButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterXYChange">_afterXYChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__afterZIndexChange">_afterZIndexChange</a>
</li>
<li class="index-item method private inherited">
<a href="#method__aggregateAttrs">_aggregateAttrs</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__applyParsedConfig">_applyParsedConfig</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__applyParser">_applyParser</a>
</li>
<li class="index-item method private inherited">
<a href="#method__applyStdModParsedConfig">_applyStdModParsedConfig</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__attachPosAlignUIHandles">_attachPosAlignUIHandles</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__attachUIHandlesAutohide">_attachUIHandlesAutohide</a>
</li>
<li class="index-item method inherited">
<a href="#method__attachUIHandlesModal">_attachUIHandlesModal</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__bindAttrUI">_bindAttrUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindDOM">_bindDOM</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUI">_bindUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIAutohide">_bindUIAutohide</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIButtons">_bindUIButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIChild">_bindUIChild</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIModal">_bindUIModal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIPosAlign">_bindUIPosAlign</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIPosConstrained">_bindUIPosConstrained</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIPosition">_bindUIPosition</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIStack">_bindUIStack</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__bindUIStdMod">_bindUIStdMod</a>
</li>
<li class="index-item method inherited">
<a href="#method__blur">_blur</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__constrain">_constrain</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__constrainOnXYChange">_constrainOnXYChange</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__createButton">_createButton</a>
</li>
<li class="index-item method private inherited">
<a href="#method__createUIEvent">_createUIEvent</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__defaultCB">_defaultCB</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__defRenderFn">_defRenderFn</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__destroyBox">_destroyBox</a>
</li>
<li class="index-item method private inherited">
<a href="#method__destroyHierarchy">_destroyHierarchy</a>
</li>
<li class="index-item method private inherited">
<a href="#method__destroyShim">_destroyShim</a>
</li>
<li class="index-item method private inherited">
<a href="#method__destroyUIEvents">_destroyUIEvents</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__detachPosAlignUIHandles">_detachPosAlignUIHandles</a>
</li>
<li class="index-item method private inherited">
<a href="#method__detachStackHandles">_detachStackHandles</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__detachUIHandlesAutohide">_detachUIHandlesAutohide</a>
</li>
<li class="index-item method inherited">
<a href="#method__detachUIHandlesModal">_detachUIHandlesModal</a>
</li>
<li class="index-item method private inherited">
<a href="#method__doAlign">_doAlign</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__eraseStdMod">_eraseStdMod</a>
</li>
<li class="index-item method private inherited">
<a href="#method__fillHeight">_fillHeight</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__filterUIEvent">_filterUIEvent</a>
</li>
<li class="index-item method private inherited">
<a href="#method__findStdModSection">_findStdModSection</a>
</li>
<li class="index-item method private inherited">
<a href="#method__fireAttrChange">_fireAttrChange</a>
</li>
<li class="index-item method inherited">
<a href="#method__focus">_focus</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__getButtonContainer">_getButtonContainer</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getButtonDefault">_getButtonDefault</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getButtonName">_getButtonName</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getButtons">_getButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getClasses">_getClasses</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getFullType">_getFullType</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getHtmlParser">_getHtmlParser</a>
</li>
<li class="index-item method inherited">
<a href="#method__getMaskNode">_getMaskNode</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getNodeToParse">_getNodeToParse</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getPreciseHeight">_getPreciseHeight</a>
</li>
<li class="index-item method private inherited inherited">
<a href="#method__getRegion">_getRegion</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getShimTemplate">_getShimTemplate</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getSrcNode">_getSrcNode</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__getStdModContent">_getStdModContent</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getStdModTemplate">_getStdModTemplate</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getStrings">_getStrings</a>
</li>
<li class="index-item method private inherited">
<a href="#method__getType">_getType</a>
</li>
<li class="index-item method protected inherited inherited">
<a href="#method__getUIEventNode">_getUIEventNode</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getX">_getX</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__getY">_getY</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__guid">_guid</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 private inherited">
<a href="#method__initUIEvent">_initUIEvent</a>
</li>
<li class="index-item method private inherited">
<a href="#method__insertStdModSection">_insertStdModSection</a>
</li>
<li class="index-item method private inherited">
<a href="#method__isLazyAttr">_isLazyAttr</a>
</li>
<li class="index-item method private inherited">
<a href="#method__isUIEvent">_isUIEvent</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__mapButton">_mapButton</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__mapButtons">_mapButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__mapInstance">_mapInstance</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__mergeButtonConfig">_mergeButtonConfig</a>
</li>
<li class="index-item method private inherited">
<a href="#method__monitor">_monitor</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__onDocFocus">_onDocFocus</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__onDocMouseDown">_onDocMouseDown</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__parseButtons">_parseButtons</a>
</li>
<li class="index-item method private inherited">
<a href="#method__parseStdModHTML">_parseStdModHTML</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__parseZIndex">_parseZIndex</a>
</li>
<li class="index-item method private inherited">
<a href="#method__preInitEventCfg">_preInitEventCfg</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__preventOverlap">_preventOverlap</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__removeLoadingClassNames">_removeLoadingClassNames</a>
</li>
<li class="index-item method private inherited">
<a href="#method__renderBox">_renderBox</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderBoxClassNames">_renderBoxClassNames</a>
</li>
<li class="index-item method private inherited">
<a href="#method__renderShim">_renderShim</a>
</li>
<li class="index-item method private inherited">
<a href="#method__renderShimDeferred">_renderShimDeferred</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderStdMod">_renderStdMod</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUI">_renderUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUIModal">_renderUIModal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUIPosition">_renderUIPosition</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUIStack">_renderUIStack</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__renderUIStdMod">_renderUIStdMod</a>
</li>
<li class="index-item method inherited">
<a href="#method__repositionMask">_repositionMask</a>
</li>
<li class="index-item method private inherited">
<a href="#method__resyncMask">_resyncMask</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__setAlignCenter">_setAlignCenter</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__setAttrUI">_setAttrUI</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setAttrVal">_setAttrVal</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setBB">_setBB</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setBox">_setBox</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setButtons">_setButtons</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setCB">_setCB</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setConstrain">_setConstrain</a>
</li>
<li class="index-item method private inherited">
<a href="#method__setStateVal">_setStateVal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setStrings">_setStrings</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setX">_setX</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setY">_setY</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__setZIndex">_setZIndex</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__strSetter">_strSetter</a>
</li>
<li class="index-item method private inherited">
<a href="#method__syncAttrUI">_syncAttrUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUI">_syncUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIAutohide">_syncUIAutohide</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIButtons">_syncUIButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIChild">_syncUIChild</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIModal">_syncUIModal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIPosAlign">_syncUIPosAlign</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIPosition">_syncUIPosition</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIStack">_syncUIStack</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__syncUIStdMod">_syncUIStdMod</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiInsertButton">_uiInsertButton</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiRemoveButton">_uiRemoveButton</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetAlign">_uiSetAlign</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetButtons">_uiSetButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetChildSelected">_uiSetChildSelected</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetDefaultButton">_uiSetDefaultButton</a>
</li>
<li class="index-item method private inherited">
<a href="#method__uiSetDim">_uiSetDim</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetDisabled">_uiSetDisabled</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetFillHeight">_uiSetFillHeight</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetFocused">_uiSetFocused</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetHeight">_uiSetHeight</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetHostVisibleAutohide">_uiSetHostVisibleAutohide</a>
</li>
<li class="index-item method inherited">
<a href="#method__uiSetHostVisibleModal">_uiSetHostVisibleModal</a>
</li>
<li class="index-item method inherited">
<a href="#method__uiSetHostZIndexModal">_uiSetHostZIndexModal</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetShim">_uiSetShim</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetStdMod">_uiSetStdMod</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetTabIndex">_uiSetTabIndex</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetVisible">_uiSetVisible</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetVisibleButtons">_uiSetVisibleButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetVisiblePosAlign">_uiSetVisiblePosAlign</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetWidth">_uiSetWidth</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetXY">_uiSetXY</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSetZIndex">_uiSetZIndex</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__uiSizeCB">_uiSizeCB</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__unbindDOM">_unbindDOM</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__unbindUI">_unbindUI</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__unMapButton">_unMapButton</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__updateContentButtons">_updateContentButtons</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__updateDefaultButton">_updateDefaultButton</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__validateFillHeight">_validateFillHeight</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__validateXY">_validateXY</a>
</li>
<li class="index-item method protected inherited">
<a href="#method__validTabIndex">_validTabIndex</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_addButton">addButton</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_align">align</a>
</li>
<li class="index-item method inherited">
<a href="#method_ancestor">ancestor</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 protected inherited">
<a href="#method_bindUI">bindUI</a>
</li>
<li class="index-item method inherited">
<a href="#method_blur">blur</a>
</li>
<li class="index-item method inherited">
<a href="#method_bubble">bubble</a>
</li>
<li class="index-item method inherited">
<a href="#method_centered">centered</a>
</li>
<li class="index-item method inherited">
<a href="#method_constrain">constrain</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_destroy">destroy</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_destructor">destructor</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_disable">disable</a>
</li>
<li class="index-item method inherited">
<a href="#method_enable">enable</a>
</li>
<li class="index-item method private inherited">
<a href="#method_enable or disable constraints listeners">enable or disable constraints listeners</a>
</li>
<li class="index-item method inherited">
<a href="#method_fillHeight">fillHeight</a>
</li>
<li class="index-item method inherited">
<a href="#method_fire">fire</a>
</li>
<li class="index-item method inherited">
<a href="#method_focus">focus</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_getButton">getButton</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_getClassName">getClassName</a>
</li>
<li class="index-item method inherited">
<a href="#method_getConstrainedXY">getConstrainedXY</a>
</li>
<li class="index-item method inherited">
<a href="#method_getDefaultLocale">getDefaultLocale</a>
</li>
<li class="index-item method inherited">
<a href="#method_getEvent">getEvent</a>
</li>
<li class="index-item method inherited">
<a href="#method_getSkinName">getSkinName</a>
</li>
<li class="index-item method inherited">
<a href="#method_getStdModNode">getStdModNode</a>
</li>
<li class="index-item method deprecated inherited inherited">
<a href="#method_getString">getString</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method deprecated inherited inherited">
<a href="#method_getStrings">getStrings</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item method inherited">
<a href="#method_getTargets">getTargets</a>
</li>
<li class="index-item method inherited">
<a href="#method_hide">hide</a>
</li>
<li class="index-item method inherited inherited">
<a href="#method_init">init</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_initializer">initializer</a>
</li>
<li class="index-item method public inherited">
<a href="#method_isNested">isNested</a>
</li>
<li class="index-item method inherited">
<a href="#method_isRoot">isRoot</a>
</li>
<li class="index-item method inherited">
<a href="#method_modifyAttr">modifyAttr</a>
</li>
<li class="index-item method inherited">
<a href="#method_move">move</a>
</li>
<li class="index-item method inherited">
<a href="#method_next">next</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_previous">previous</a>
</li>
<li class="index-item method inherited">
<a href="#method_publish">publish</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeAttr">removeAttr</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeButton">removeButton</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 protected inherited">
<a href="#method_renderer">renderer</a>
</li>
<li class="index-item method protected inherited">
<a href="#method_renderUI">renderUI</a>
</li>
<li class="index-item method inherited">
<a href="#method_reset">reset</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 inherited">
<a href="#method_setStdModContent">setStdModContent</a>
</li>
<li class="index-item method inherited">
<a href="#method_show">show</a>
</li>
<li class="index-item method inherited">
<a href="#method_sizeShim">sizeShim</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 protected inherited">
<a href="#method_syncUI">syncUI</a>
</li>
<li class="index-item method inherited">
<a href="#method_syncXY">syncXY</a>
</li>
<li class="index-item method inherited 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>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property protected inherited">
<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>
</li>
<li class="index-item property protected inherited">
<a href="#property__buttonsHandles">_buttonsHandles</a>
</li>
<li class="index-item property protected inherited">
<a href="#property__buttonsMap">_buttonsMap</a>
</li>
<li class="index-item property protected inherited">
<a href="#property__defaultButton">_defaultButton</a>
</li>
<li class="index-item property protected inherited">
<a href="#property__posAlignUIHandles">_posAlignUIHandles</a>
</li>
<li class="index-item property private inherited">
<a href="#property__UI_ATTRS">_UI_ATTRS</a>
</li>
<li class="index-item property inherited">
<a href="#property_BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a>
</li>
<li class="index-item property inherited">
<a href="#property_BUTTONS">BUTTONS</a>
</li>
<li class="index-item property inherited">
<a href="#property_BUTTONS_TEMPLATE">BUTTONS_TEMPLATE</a>
</li>
<li class="index-item property inherited">
<a href="#property_CONTENT_TEMPLATE">CONTENT_TEMPLATE</a>
</li>
<li class="index-item property inherited">
<a href="#property_DEF_PARENT_NODE">DEF_PARENT_NODE</a>
</li>
<li class="index-item property inherited">
<a href="#property_DEF_UNIT">DEF_UNIT</a>
</li>
<li class="index-item property inherited">
<a href="#property_DEFAULT_BUTTONS_SECTION">DEFAULT_BUTTONS_SECTION</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_STACK">STACK</a>
</li>
<li class="index-item property inherited">
<a href="#property_UI_EVENTS">UI_EVENTS</a>
</li>
</ul>
</div>
<div class="index-section attrs">
<h3>Attributes</h3>
<ul class="index-list attrs extends">
<li class="index-item attr inherited">
<a href="#attr_align">align</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_alignOn">alignOn</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_bodyContent">bodyContent</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_boundingBox">boundingBox</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_buttons">buttons</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_centered">centered</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_constrain">constrain</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_contentBox">contentBox</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_defaultButton">defaultButton</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_destroyed">destroyed</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_disabled">disabled</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_fillHeight">fillHeight</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_focused">focused</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_focusOn">focusOn</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_footerContent">footerContent</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_headerContent">headerContent</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_height">height</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_hideOn">hideOn</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_id">id</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_initialized">initialized</a>
</li>
<li class="index-item attr deprecated inherited">
<a href="#attr_locale">locale</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_maskNode">maskNode</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_modal">modal</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_preventOverlap">preventOverlap</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_render">render</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_rendered">rendered</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_shim">shim</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_srcNode">srcNode</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_strings">strings</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_tabIndex">tabIndex</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_visible">visible</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_width">width</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_x">x</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_xy">xy</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_y">y</a>
</li>
<li class="index-item attr inherited">
<a href="#attr_zIndex">zIndex</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_render">render</a>
</li>
<li class="index-item event inherited">
<a href="#event_widget:contentUpdate">widget:contentUpdate</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__addShimResizeHandlers" class="method item private inherited">
<h3 class="name"><code>_addShimResizeHandlers</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__addShimResizeHandlers">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l327"><code>widget-stack/js/Widget-Stack.js:327</code></a>
</p>
</div>
<div class="description">
<p>Sets up event listeners to resize the shim when the size of the Widget changes.</p>
<p>
NOTE: This method is only used for IE6 currently, since IE6 doesn't support a way to
resize the shim purely through CSS, when the Widget does not have an explicit width/height
set.
</p>
</div>
</div>
<div id="method__addStdModContent" class="method item private inherited">
<h3 class="name"><code>_addStdModContent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
<li class="arg">
<code>children</code>
</li>
<li class="arg">
<code>where</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__addStdModContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l545"><code>widget-stdmod/js/Widget-StdMod.js:545</code></a>
</p>
</div>
<div class="description">
<p>Helper method to add content to a StdMod section node.
The content is added either before, after or replaces the existing node content
based on the value of the <code>where</code> argument.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The section Node to be updated.</p>
</div>
</li>
<li class="param">
<code class="param-name">children</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="../classes/NodeList.html" class="crosslink">NodeList</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 new content Node, NodeList or String to be added to section Node provided.</p>
</div>
</li>
<li class="param">
<code class="param-name">where</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. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.
If not provided, the content will replace existing content in the Node.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterAlignChange" class="method item protected inherited">
<h3 class="name"><code>_afterAlignChange</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/WidgetPositionAlign.html#method__afterAlignChange">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l616"><code>widget-position-align/js/Widget-PositionAlign.js:616</code></a>
</p>
</div>
<div class="description">
<p>Handles <code>alignChange</code> events by updating the UI in response to <code>align</code>
Attribute changes.</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__afterAlignOnChange" class="method item protected inherited">
<h3 class="name"><code>_afterAlignOnChange</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/WidgetPositionAlign.html#method__afterAlignOnChange">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l631"><code>widget-position-align/js/Widget-PositionAlign.js:631</code></a>
</p>
</div>
<div class="description">
<p>Handles <code>alignOnChange</code> events by updating the alignment-syncing event
handlers.</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__afterBodyChange" class="method item protected inherited">
<h3 class="name"><code>_afterBodyChange</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/WidgetStdMod.html#method__afterBodyChange">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l344"><code>widget-stdmod/js/Widget-StdMod.js:344</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the bodyContent attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterButtonsChange" class="method item protected inherited">
<h3 class="name"><code>_afterButtonsChange</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/WidgetButtons.html#method__afterButtonsChange">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1188"><code>widget-buttons/js/widget-buttons.js:1188</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
<p>Handles this widget's <code>buttonsChange</code> event which fires anytime the
<code>buttons</code> attribute is modified.</p>
<p><strong>Note:</strong> This method special-cases the <code>buttons</code> modifications caused by
<code>addButton()</code> and <code>removeButton()</code>, both of which set the <code>src</code> property on
the event facade to "add" and "remove" respectively.</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__afterChildSelectedChange" class="method item protected inherited">
<h3 class="name"><code>_afterChildSelectedChange</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>event</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the <code>selected</code>
attribute, responsible for updating the UI, in response to
attribute changes.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the attribute change.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterConstrainChange" class="method item protected inherited">
<h3 class="name"><code>_afterConstrainChange</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/WidgetPositionConstrain.html#method__afterConstrainChange">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l275"><code>widget-position-constrain/js/Widget-PositionConstrain.js:275</code></a>
</p>
</div>
<div class="description">
<p>After change listener for the "constrain" attribute, responsible
for updating the UI, in response to attribute changes.</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 facade</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterContentChangeButtons" class="method item protected inherited">
<h3 class="name"><code>_afterContentChangeButtons</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/WidgetButtons.html#method__afterContentChangeButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1237"><code>widget-buttons/js/widget-buttons.js:1237</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Handles this widget's <code>headerContentChange</code>, <code>bodyContentChange</code>,
<code>footerContentChange</code> events by making sure the <code>buttons</code> remain rendered
after changes to the content areas.</p>
<p>These events are very chatty, so extra caution is taken to avoid doing extra
work or getting into an infinite loop.</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__afterDefaultButtonChange" class="method item protected inherited">
<h3 class="name"><code>_afterDefaultButtonChange</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/WidgetButtons.html#method__afterDefaultButtonChange">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1261"><code>widget-buttons/js/widget-buttons.js:1261</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Handles this widget's <code>defaultButtonChange</code> event by adding the
"yui3-button-primary" CSS class to the new <code>defaultButton</code> and removing it
from the old default button.</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__afterFillHeightChange" class="method item protected inherited">
<h3 class="name"><code>_afterFillHeightChange</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/WidgetStdMod.html#method__afterFillHeightChange">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l372"><code>widget-stdmod/js/Widget-StdMod.js:372</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the fillHeight attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterFocusOnChange" class="method item inherited">
<h3 class="name"><code>_afterFocusOnChange</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__afterFocusOnChange">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l545"><code>widget-modality/js/Widget-Modality.js:545</code></a>
</p>
</div>
<div class="description">
<p>Default function called when focusOn Attribute is changed. Remove existing listeners and create new listeners.</p>
</div>
</div>
<div id="method__afterFooterChange" class="method item protected inherited">
<h3 class="name"><code>_afterFooterChange</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/WidgetStdMod.html#method__afterFooterChange">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l358"><code>widget-stdmod/js/Widget-StdMod.js:358</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the footerContent attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterHeaderChange" class="method item protected inherited">
<h3 class="name"><code>_afterHeaderChange</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/WidgetStdMod.html#method__afterHeaderChange">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l330"><code>widget-stdmod/js/Widget-StdMod.js:330</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the headerContent attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterHideOnChange" class="method item inherited">
<h3 class="name"><code>_afterHideOnChange</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__afterHideOnChange">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l218"><code>widget-autohide/js/Widget-Autohide.js:218</code></a>
</p>
</div>
<div class="description">
<p>Default function called when hideOn Attribute is changed. Remove existing listeners and create new listeners.</p>
</div>
</div>
<div id="method__afterHostVisibleChangeAutohide" class="method item protected inherited">
<h3 class="name"><code>_afterHostVisibleChangeAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__afterHostVisibleChangeAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l206"><code>widget-autohide/js/Widget-Autohide.js:206</code></a>
</p>
</div>
<div class="description">
<p>Default function called when the visibility of the widget changes. Determines
whether to attach or detach event listeners based on the visibility of the widget.</p>
</div>
</div>
<div id="method__afterHostVisibleChangeModal" class="method item inherited">
<h3 class="name"><code>_afterHostVisibleChangeModal</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__afterHostVisibleChangeModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l453"><code>widget-modality/js/Widget-Modality.js:453</code></a>
</p>
</div>
<div class="description">
<p>Default function that is called when visibility is changed on the widget.</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 facade of the change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterHostZIndexChangeModal" class="method item inherited">
<h3 class="name"><code>_afterHostZIndexChangeModal</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__afterHostZIndexChangeModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l464"><code>widget-modality/js/Widget-Modality.js:464</code></a>
</p>
</div>
<div class="description">
<p>Default function that is called when z-index is changed on the widget.</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 facade of the change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterShimChange" class="method item protected inherited">
<h3 class="name"><code>_afterShimChange</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/WidgetStack.html#method__afterShimChange">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l237"><code>widget-stack/js/Widget-Stack.js:237</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the shim attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterVisibleChangeButtons" class="method item protected inherited">
<h3 class="name"><code>_afterVisibleChangeButtons</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/WidgetButtons.html#method__afterVisibleChangeButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1275"><code>widget-buttons/js/widget-buttons.js:1275</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Handles this widget's <code>visibleChange</code> event by focusing the <code>defaultButton</code>
if there is one.</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__afterXYChange" class="method item protected inherited">
<h3 class="name"><code>_afterXYChange</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/WidgetPosition.html#method__afterXYChange">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l244"><code>widget-position/js/Widget-Position.js:244</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the xy attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__afterZIndexChange" class="method item protected inherited">
<h3 class="name"><code>_afterZIndexChange</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/WidgetStack.html#method__afterZIndexChange">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l249"><code>widget-stack/js/Widget-Stack.js:249</code></a>
</p>
</div>
<div class="description">
<p>Default attribute change listener for the zIndex attribute, responsible
for updating the UI, in response to attribute changes.</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 facade for the attribute change</p>
</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__applyParsedConfig" class="method item protected inherited">
<h3 class="name"><code>_applyParsedConfig</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/Widget.html#method__applyParsedConfig">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l83"><code>widget/js/WidgetHTMLParser.js:83</code></a>
</p>
</div>
<div class="description">
</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 merged configuration literal
</div>
</div>
</div>
<div id="method__applyParser" class="method item protected inherited">
<h3 class="name"><code>_applyParser</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__applyParser">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l92"><code>widget/js/WidgetHTMLParser.js:92</code></a>
</p>
</div>
<div class="description">
<p>Utility method used to apply the <code>HTML_PARSER</code> configuration for the
instance, to retrieve config data values.</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>User configuration object (will be populated with values from Node)</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__applyStdModParsedConfig" class="method item private inherited">
<h3 class="name"><code>_applyStdModParsedConfig</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__applyStdModParsedConfig">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l637"><code>widget-stdmod/js/Widget-StdMod.js:637</code></a>
</p>
</div>
<div class="description">
<p>This method is injected before the <em>applyParsedConfig step in
the application of HTML</em>PARSER, and sets up the state to
identify whether or not we should remove the current DOM content
or not, based on whether or not the current content attribute value
was extracted from the DOM, or provided by the user configuration</p>
</div>
</div>
<div id="method__attachPosAlignUIHandles" class="method item protected inherited">
<h3 class="name"><code>_attachPosAlignUIHandles</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__attachPosAlignUIHandles">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l458"><code>widget-position-align/js/Widget-PositionAlign.js:458</code></a>
</p>
</div>
<div class="description">
<p>Attaches the alignment-syncing event handlers.</p>
</div>
</div>
<div id="method__attachUIHandlesAutohide" class="method item protected inherited">
<h3 class="name"><code>_attachUIHandlesAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__attachUIHandlesAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l143"><code>widget-autohide/js/Widget-Autohide.js:143</code></a>
</p>
</div>
<div class="description">
<p>Iterates through all objects in the hideOn attribute and creates event listeners.</p>
</div>
</div>
<div id="method__attachUIHandlesModal" class="method item inherited">
<h3 class="name"><code>_attachUIHandlesModal</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__attachUIHandlesModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l382"><code>widget-modality/js/Widget-Modality.js:382</code></a>
</p>
</div>
<div class="description">
<p>Attaches UI Listeners for "clickoutside" and "focusoutside" on the
widget. When these events occur, and the widget is modal, focus is
shifted back onto the widget.</p>
</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__bindAttrUI" class="method item private inherited">
<h3 class="name"><code>_bindAttrUI</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="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1170"><code>widget/js/Widget.js:1170</code></a>
</p>
</div>
<div class="description">
<p>Binds after listeners for the list of attributes provided</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></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__bindDOM" class="method item protected inherited">
<h3 class="name"><code>_bindDOM</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindDOM">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l902"><code>widget/js/Widget.js:902</code></a>
</p>
</div>
<div class="description">
<p>Sets up DOM listeners, on elements rendered by the widget.</p>
</div>
</div>
<div id="method__bindUI" class="method item protected inherited">
<h3 class="name"><code>_bindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l883"><code>widget/js/Widget.js:883</code></a>
</p>
</div>
<div class="description">
<p>Sets up DOM and CustomEvent listeners for the widget.</p>
</div>
</div>
<div id="method__bindUIAutohide" class="method item protected inherited">
<h3 class="name"><code>_bindUIAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__bindUIAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l95"><code>widget-autohide/js/Widget-Autohide.js:95</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners to the widget.</p>
<p>
This method in invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIButtons" class="method item protected inherited">
<h3 class="name"><code>_bindUIButtons</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__bindUIButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l496"><code>widget-buttons/js/widget-buttons.js:496</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
<p>Binds UI event listeners. This method is inserted via AOP, and will execute
after <code>bindUI()</code>.</p>
</div>
</div>
<div id="method__bindUIChild" class="method item protected inherited">
<h3 class="name"><code>_bindUIChild</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__bindUIChild">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response
to WidgetChild related state changes.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIModal" class="method item protected inherited">
<h3 class="name"><code>_bindUIModal</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__bindUIModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l223"><code>widget-modality/js/Widget-Modality.js:223</code></a>
</p>
</div>
<div class="description">
<p>Hooks up methods to be executed when the widget's visibility or z-index changes</p>
<p>
This method in invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIPosAlign" class="method item protected inherited">
<h3 class="name"><code>_bindUIPosAlign</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__bindUIPosAlign">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l238"><code>widget-position-align/js/Widget-PositionAlign.js:238</code></a>
</p>
</div>
<div class="description">
<p>Bind event listeners responsible for updating the UI state in response to
the widget's position-align related state changes.</p>
<p>This method is invoked after <code>bindUI</code> has been invoked for the <code>Widget</code>
class using the AOP infrastructure.</p>
</div>
</div>
<div id="method__bindUIPosConstrained" class="method item protected inherited">
<h3 class="name"><code>_bindUIPosConstrained</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method__bindUIPosConstrained">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l259"><code>widget-position-constrain/js/Widget-PositionConstrain.js:259</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response to
Widget constrained positioning related state changes.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIPosition" class="method item protected inherited">
<h3 class="name"><code>_bindUIPosition</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__bindUIPosition">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l143"><code>widget-position/js/Widget-Position.js:143</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response to
Widget position related state changes.</p>
<p>
This method in invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIStack" class="method item protected inherited">
<h3 class="name"><code>_bindUIStack</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__bindUIStack">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l155"><code>widget-stack/js/Widget-Stack.js:155</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response to
Widget stack related state changes.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__bindUIStdMod" class="method item protected inherited">
<h3 class="name"><code>_bindUIStdMod</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__bindUIStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l310"><code>widget-stdmod/js/Widget-StdMod.js:310</code></a>
</p>
</div>
<div class="description">
<p>Binds event listeners responsible for updating the UI state in response to
Widget standard module related state changes.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__blur" class="method item inherited">
<h3 class="name"><code>_blur</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__blur">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l281"><code>widget-modality/js/Widget-Modality.js:281</code></a>
</p>
</div>
<div class="description">
<p>Blurs the widget.</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__constrain" class="method item protected inherited">
<h3 class="name"><code>_constrain</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code>axis</code>
</li>
<li class="arg">
<code>nodeRegion</code>
</li>
<li class="arg">
<code>constrainingRegion</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method__constrain">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l164"><code>widget-position-constrain/js/Widget-PositionConstrain.js:164</code></a>
</p>
</div>
<div class="description">
<p>The method which performs the actual constrain calculations for a given axis ("x" or "y") based
on the regions provided.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The value to constrain</p>
</div>
</li>
<li class="param">
<code class="param-name">axis</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 axis to use for constrainment</p>
</div>
</li>
<li class="param">
<code class="param-name">nodeRegion</code>
<span class="type">Region</span>
<div class="param-description">
<p>The region of the node to constrain</p>
</div>
</li>
<li class="param">
<code class="param-name">constrainingRegion</code>
<span class="type">Region</span>
<div class="param-description">
<p>The region of the node (or viewport) to constrain to</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
The constrained value
</div>
</div>
</div>
<div id="method__constrainOnXYChange" class="method item protected inherited">
<h3 class="name"><code>_constrainOnXYChange</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/WidgetPositionConstrain.html#method__constrainOnXYChange">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l305"><code>widget-position-constrain/js/Widget-PositionConstrain.js:305</code></a>
</p>
</div>
<div class="description">
<p>The on change listener for the "xy" attribute. Modifies the event facade's
newVal property with the constrained XY value.</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 facade for the attribute change</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__createButton" class="method item protected inherited">
<h3 class="name"><code>_createButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</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/WidgetButtons.html#method__createButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l516"><code>widget-buttons/js/widget-buttons.js:516</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns a button node based on the specified <code>button</code> node or configuration.</p>
<p>The button node will either be created via <code>Y.Plugin.Button.createNode()</code>,
or when <code>button</code> is specified as a node already, it will by <code>plug()</code>ed with
<code>Y.Plugin.Button</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</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>Button node or configuration object.</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>:
The button node.
</div>
</div>
</div>
<div id="method__createUIEvent" class="method item private inherited">
<h3 class="name"><code>_createUIEvent</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__createUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a>
</p>
</div>
<div class="description">
<p>Binds a delegated DOM event listener of the specified type to the
Widget's outtermost DOM element to facilitate the firing of a Custom
Event of the same type for the Widget instance.</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>String representing the name of the event</p>
</div>
</li>
</ul>
</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__defaultCB" class="method item protected inherited">
<h3 class="name"><code>_defaultCB</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__defaultCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l780"><code>widget/js/Widget.js:780</code></a>
</p>
</div>
<div class="description">
<p>Returns the default value for the contentBox attribute.</p>
<p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in
a new contentBox node instance being created)</p>
</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__defRenderFn" class="method item protected inherited">
<h3 class="name"><code>_defRenderFn</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__defRenderFn">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l571"><code>widget/js/Widget.js:571</code></a>
</p>
</div>
<div class="description">
<p>Default render 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>The Event object</p>
</div>
</li>
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The parent node to render to, if passed in to the <code>render</code> method</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__destroyBox" class="method item protected inherited">
<h3 class="name"><code>_destroyBox</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__destroyBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l476"><code>widget/js/Widget.js:476</code></a>
</p>
</div>
<div class="description">
<p>Removes and destroys the widgets rendered boundingBox, contentBox,
and detaches bound UI events.</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__destroyShim" class="method item private inherited">
<h3 class="name"><code>_destroyShim</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__destroyShim">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l387"><code>widget-stack/js/Widget-Stack.js:387</code></a>
</p>
</div>
<div class="description">
<p>Removes the shim from the DOM, and detaches any related event
listeners.</p>
</div>
</div>
<div id="method__destroyUIEvents" class="method item private inherited">
<h3 class="name"><code>_destroyUIEvents</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a>
</p>
</div>
<div class="description">
<p>Destructor logic for UI event infrastructure,
invoked during Widget destruction.</p>
</div>
</div>
<div id="method__detachPosAlignUIHandles" class="method item protected inherited">
<h3 class="name"><code>_detachPosAlignUIHandles</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__detachPosAlignUIHandles">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l486"><code>widget-position-align/js/Widget-PositionAlign.js:486</code></a>
</p>
</div>
<div class="description">
<p>Detaches the alignment-syncing event handlers.</p>
</div>
</div>
<div id="method__detachStackHandles" class="method item private inherited">
<h3 class="name"><code>_detachStackHandles</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="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__detachStackHandles">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l350"><code>widget-stack/js/Widget-Stack.js:350</code></a>
</p>
</div>
<div class="description">
<p>Detaches any handles stored for the provided key</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/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>handleKey The key defining the group of handles which should be detached</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__detachUIHandlesAutohide" class="method item protected inherited">
<h3 class="name"><code>_detachUIHandlesAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__detachUIHandlesAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l192"><code>widget-autohide/js/Widget-Autohide.js:192</code></a>
</p>
</div>
<div class="description">
<p>Detaches all event listeners created by this extension</p>
</div>
</div>
<div id="method__detachUIHandlesModal" class="method item inherited">
<h3 class="name"><code>_detachUIHandlesModal</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__detachUIHandlesModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l441"><code>widget-modality/js/Widget-Modality.js:441</code></a>
</p>
</div>
<div class="description">
<p>Detaches all UI Listeners that were set in _attachUIHandlesModal from the widget.</p>
</div>
</div>
<div id="method__doAlign" class="method item private inherited">
<h3 class="name"><code>_doAlign</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>widgetPoint</code>
</li>
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__doAlign">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l502"><code>widget-position-align/js/Widget-PositionAlign.js:502</code></a>
</p>
</div>
<div class="description">
<p>Helper method, used to align the given point on the widget, with the XY page
coordinates provided.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">widgetPoint</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>Supported point constant
(e.g. WidgetPositionAlign.TL)</p>
</div>
</li>
<li class="param">
<code class="param-name">x</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>X page coordinate to align to.</p>
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Y page coordinate to align to.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__eraseStdMod" class="method item protected inherited">
<h3 class="name"><code>_eraseStdMod</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__eraseStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l489"><code>widget-stdmod/js/Widget-StdMod.js:489</code></a>
</p>
</div>
<div class="description">
<p>Removes the DOM node for the given section.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section to remove. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__fillHeight" class="method item private inherited">
<h3 class="name"><code>_fillHeight</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__fillHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l422"><code>widget-stdmod/js/Widget-StdMod.js:422</code></a>
</p>
</div>
<div class="description">
<p>Updates the rendered UI, to resize the current section specified by the fillHeight attribute, so
that the standard module fills out the Widget height. If a height has not been set on Widget,
the section is not resized (height is set to "auto").</p>
</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__filterUIEvent" class="method item private inherited">
<h3 class="name"><code>_filterUIEvent</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>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__filterUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a>
</p>
</div>
<div class="description">
<p>This method is used to determine if we should fire
the UI Event or not. The default implementation makes sure
that for nested delegates (nested unrelated widgets), we don't
fire the UI event listener more than once at each level.</p>
<p>For example, without the additional filter, if you have nested
widgets, each widget will have a delegate listener. If you
click on the inner widget, the inner delegate listener's
filter will match once, but the outer will match twice
(based on delegate's design) - once for the inner widget,
and once for the outer.</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/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
<div class="param-description">
</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 OK to fire the custom UI event, false if not.
</div>
</div>
</div>
<div id="method__findStdModSection" class="method item private inherited">
<h3 class="name"><code>_findStdModSection</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__findStdModSection">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l598"><code>widget-stdmod/js/Widget-StdMod.js:598</code></a>
</p>
</div>
<div class="description">
<p>Helper method to to find the rendered node for the given section,
if it exists.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</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>:
The rendered node for the given section, or null if not found.
</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__focus" class="method item inherited">
<h3 class="name"><code>_focus</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__focus">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l268"><code>widget-modality/js/Widget-Modality.js:268</code></a>
</p>
</div>
<div class="description">
<p>Provides mouse and tab focus to the widget's bounding box.</p>
</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__getButtonContainer" class="method item protected inherited">
<h3 class="name"><code>_getButtonContainer</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>create</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/WidgetButtons.html#method__getButtonContainer">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l581"><code>widget-buttons/js/widget-buttons.js:581</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns the buttons container for the specified <code>section</code>, passing a truthy
value for <code>create</code> will create the node if it does not already exist.</p>
<p><strong>Note:</strong> It is up to the caller to properly insert the returned container
node into the content section.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer).</p>
</div>
</li>
<li class="param">
<code class="param-name">create</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 buttons container should be created if
it does not already exist.</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>:
The buttons container node for the specified <code>section</code>.
</div>
</div>
</div>
<div id="method__getButtonDefault" class="method item protected inherited">
<h3 class="name"><code>_getButtonDefault</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</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/WidgetButtons.html#method__getButtonDefault">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l616"><code>widget-buttons/js/widget-buttons.js:616</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns whether or not the specified <code>button</code> is configured to be the
default button.</p>
<p>When a button node is specified, the button's <code>getData()</code> method will be
used to determine if the button is configured to be the default. When a
button config object is specified, the <code>isDefault</code> prop will determine
whether the button is the default.</p>
<p><strong>Note:</strong> <code><button data-default="true"></button></code> is supported via the
<code>button.getData('default')</code> API call.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</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 button node or configuration 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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
Whether the button is configured to be the default button.
</div>
</div>
</div>
<div id="method__getButtonName" class="method item protected inherited">
<h3 class="name"><code>_getButtonName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</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/WidgetButtons.html#method__getButtonName">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l645"><code>widget-buttons/js/widget-buttons.js:645</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns the name of the specified <code>button</code>.</p>
<p>When a button node is specified, the button's <code>getData('name')</code> method is
preferred, but will fallback to <code>get('name')</code>, and the result will determine
the button's name. When a button config object is specified, the <code>name</code> prop
will determine the button's name.</p>
<p><strong>Note:</strong> <code><button data-name="foo"></button></code> is supported via the
<code>button.getData('name')</code> API call.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</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 button node or configuration 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/String" class="crosslink external" target="_blank">String</a></span>:
The name of the button.
</div>
</div>
</div>
<div id="method__getButtons" class="method item protected inherited">
<h3 class="name"><code>_getButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>buttons</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/WidgetButtons.html#method__getButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l674"><code>widget-buttons/js/widget-buttons.js:674</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Getter for the <code>buttons</code> attribute. A copy of the <code>buttons</code> object is
returned so the stored state cannot be modified by the callers of
<code>get('buttons')</code>.</p>
<p>This will recreate a copy of the <code>buttons</code> object, and each section array
(the button nodes are <em>not</em> copied/cloned.)</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">buttons</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 widget's current <code>buttons</code> state.</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 copy of the widget's current <code>buttons</code> state.
</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__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__getHtmlParser" class="method item private inherited">
<h3 class="name"><code>_getHtmlParser</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getHtmlParser">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l149"><code>widget/js/WidgetHTMLParser.js:149</code></a>
</p>
</div>
<div class="description">
<p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER
definitions across 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>:
HTML_PARSER definition for this instance
</div>
</div>
</div>
<div id="method__getMaskNode" class="method item inherited">
<h3 class="name"><code>_getMaskNode</code></h3>
<span class="paren">()</span>
<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/WidgetModality.html#method__getMaskNode">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l291"><code>widget-modality/js/Widget-Modality.js:291</code></a>
</p>
</div>
<div class="description">
<p>Returns the Y.Node instance of the maskNode</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The Y.Node instance of the mask, as returned from WidgetModal.<em>GET</em>MASK
</div>
</div>
</div>
<div id="method__getNodeToParse" class="method item private inherited">
<h3 class="name"><code>_getNodeToParse</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getNodeToParse">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l134"><code>widget/js/WidgetHTMLParser.js:134</code></a>
</p>
</div>
<div class="description">
<p>Determines whether we have a node reference which we should try and parse.</p>
<p>The current implementation does not parse nodes generated from CONTENT_TEMPLATE,
only explicitly set srcNode, or contentBox attributes.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The node reference to apply HTML_PARSER to.
</div>
</div>
</div>
<div id="method__getPreciseHeight" class="method item private inherited">
<h3 class="name"><code>_getPreciseHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__getPreciseHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l575"><code>widget-stdmod/js/Widget-StdMod.js:575</code></a>
</p>
</div>
<div class="description">
<p>Helper method to obtain the precise height of the node provided, including padding and border.
The height could be a sub-pixel value for certain browsers, such as Firefox 3.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The node for which the precise height is required.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
The height of the Node including borders and padding, possibly a float.
</div>
</div>
</div>
<div id="method__getRegion" class="method item private inherited">
<h3 class="name"><code>_getRegion</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[node]</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/WidgetPositionConstrain.html#method__getRegion">
WidgetPositionConstrain
</a>
but overwritten in
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l590"><code>widget-position-align/js/Widget-PositionAlign.js:590</code></a>
</p>
</div>
<div class="description">
<p>Returns the region of the passed-in <code>Node</code>, or the viewport region if
calling with passing in a <code>Node</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[node]</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The node to get the region of.</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 node's region.
</div>
</div>
</div>
<div id="method__getShimTemplate" class="method item private inherited">
<h3 class="name"><code>_getShimTemplate</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__getShimTemplate">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l421"><code>widget-stack/js/Widget-Stack.js:421</code></a>
</p>
</div>
<div class="description">
<p>Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.</p>
</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 A new shim Node instance.
</div>
</div>
</div>
<div id="method__getSrcNode" class="method item protected inherited">
<h3 class="name"><code>_getSrcNode</code></h3>
<span class="paren">()</span>
<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/Widget.html#method__getSrcNode">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l74"><code>widget/js/WidgetHTMLParser.js:74</code></a>
</p>
</div>
<div class="description">
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
The Node to apply HTML_PARSER to
</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__getStdModContent" class="method item private inherited">
<h3 class="name"><code>_getStdModContent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__getStdModContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l656"><code>widget-stdmod/js/Widget-StdMod.js:656</code></a>
</p>
</div>
<div class="description">
<p>Retrieves the child nodes (content) of a standard module section</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</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>:
The child node collection of the standard module section.
</div>
</div>
</div>
<div id="method__getStdModTemplate" class="method item protected inherited">
<h3 class="name"><code>_getStdModTemplate</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</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/WidgetStdMod.html#method__getStdModTemplate">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l532"><code>widget-stdmod/js/Widget-StdMod.js:532</code></a>
</p>
</div>
<div class="description">
<p>Gets a new Node reference for the given standard module section, by cloning
the stored template node.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</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>:
The new Node instance for the section
</div>
</div>
</div>
<div id="method__getStrings" class="method item protected inherited">
<h3 class="name"><code>_getStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>locale</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getStrings">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l56"><code>widget/js/WidgetLocale.js:56</code></a>
</p>
</div>
<div class="description">
<p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">locale</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__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__getUIEventNode" class="method item protected inherited">
<h3 class="name"><code>_getUIEventNode</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__getUIEventNode">
Widget
</a>
but overwritten in
<a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a>
</p>
</div>
<div class="description">
<p>Returns the node on which to bind delegate listeners.</p>
<p>Override of Widget's implementation of _getUIEventNode() to ensure that
all event listeners are bound to the Widget's topmost DOM element.
This ensures that the firing of each type of Widget UI event (click,
mousedown, etc.) is facilitated by a single, top-level, delegated DOM
event listener.</p>
</div>
</div>
<div id="method__getX" class="method item protected inherited">
<h3 class="name"><code>_getX</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__getX">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l220"><code>widget-position/js/Widget-Position.js:220</code></a>
</p>
</div>
<div class="description">
<p>Default getter for the X attribute. The value is retrieved from
the XY attribute, which is the sole store for the XY state.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
The X page co-ordinate value
</div>
</div>
</div>
<div id="method__getY" class="method item protected inherited">
<h3 class="name"><code>_getY</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__getY">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l232"><code>widget-position/js/Widget-Position.js:232</code></a>
</p>
</div>
<div class="description">
<p>Default getter for the Y attribute. The value is retrieved from
the XY attribute, which is the sole store for the XY state.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
The Y page co-ordinate value
</div>
</div>
</div>
<div id="method__guid" class="method item protected inherited">
<h3 class="name"><code>_guid</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__guid">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1153"><code>widget/js/Widget.js:1153</code></a>
</p>
</div>
<div class="description">
</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__initUIEvent" class="method item private inherited">
<h3 class="name"><code>_initUIEvent</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/Widget.html#method__initUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a>
</p>
</div>
<div class="description">
<p>Sets up infrastructure required to fire a UI 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></span>
<div class="param-description">
<p>String representing the name of the event</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>:
</div>
</div>
</div>
<div id="method__insertStdModSection" class="method item private inherited">
<h3 class="name"><code>_insertStdModSection</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>contentBox</code>
</li>
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>sectionNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__insertStdModSection">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l504"><code>widget-stdmod/js/Widget-StdMod.js:504</code></a>
</p>
</div>
<div class="description">
<p>Helper method to insert the Node for the given section into the correct location in the contentBox.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">contentBox</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>A reference to the Widgets content box.</p>
</div>
</li>
<li class="param">
<code class="param-name">section</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 section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</p>
</div>
</li>
<li class="param">
<code class="param-name">sectionNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The Node for the section.</p>
</div>
</li>
</ul>
</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__isUIEvent" class="method item private inherited">
<h3 class="name"><code>_isUIEvent</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/Widget.html#method__isUIEvent">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a>
</p>
</div>
<div class="description">
<p>Determines if the specified event is a UI 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></span>
<div class="param-description">
<p>String representing the name of the event</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>:
Event Returns the name of the UI Event, otherwise
undefined.
</div>
</div>
</div>
<div id="method__mapButton" class="method item protected inherited">
<h3 class="name"><code>_mapButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code>section</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__mapButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l700"><code>widget-buttons/js/widget-buttons.js:700</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds the specified <code>button</code> to the buttons map (both name -> button and
section:name -> button), and sets the button as the default if it is
configured as the default button.</p>
<p><strong>Note:</strong> If two or more buttons are configured with the same <code>name</code> and/or
configured to be the default button, the last one wins.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The button node to map.</p>
</div>
</li>
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer).</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__mapButtons" class="method item protected inherited">
<h3 class="name"><code>_mapButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>buttons</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__mapButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l730"><code>widget-buttons/js/widget-buttons.js:730</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds the specified <code>buttons</code> to the buttons map (both name -> button and
section:name -> button), and set the a button as the default if one is
configured as the default button.</p>
<p><strong>Note:</strong> This will clear all previous button mappings and null-out any
previous default button! If two or more buttons are configured with the same
<code>name</code> and/or configured to be the default button, the last one wins.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">buttons</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node[]</a></span>
<div class="param-description">
<p>The button nodes to map.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__mapInstance" class="method item protected inherited">
<h3 class="name"><code>_mapInstance</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>The</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__mapInstance">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l414"><code>widget/js/Widget.js:414</code></a>
</p>
</div>
<div class="description">
<p>Utility method used to add an entry to the boundingBox id to instance map.</p>
<p>This method can be used to populate the instance with lazily created boundingBox Node references.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">The</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>boundingBox id</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__mergeButtonConfig" class="method item protected inherited">
<h3 class="name"><code>_mergeButtonConfig</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="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/WidgetButtons.html#method__mergeButtonConfig">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l757"><code>widget-buttons/js/widget-buttons.js:757</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns a copy of the specified <code>config</code> object merged with any defaults
provided by a <code>srcNode</code> and/or a predefined configuration for a button
with the same <code>name</code> on the <code>BUTTONS</code> property.</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> | <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>Button configuration object, or string name.</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 copy of the button configuration object merged with any
defaults.
</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__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__onDocFocus" class="method item protected inherited">
<h3 class="name"><code>_onDocFocus</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="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__onDocFocus">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1081"><code>widget/js/Widget.js:1081</code></a>
</p>
</div>
<div class="description">
<p>DOM focus event handler, used to sync the state of the Widget with the DOM</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/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the DOM focus event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__onDocMouseDown" class="method item protected inherited">
<h3 class="name"><code>_onDocMouseDown</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="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1068"><code>widget/js/Widget.js:1068</code></a>
</p>
</div>
<div class="description">
<p>"mousedown" event handler for the owner document of the
widget's bounding box.</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/EventFacade.html" class="crosslink">EventFacade</a></span>
<div class="param-description">
<p>The event facade for the DOM focus event</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__parseButtons" class="method item protected inherited">
<h3 class="name"><code>_parseButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>srcNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Null | <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/WidgetButtons.html#method__parseButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l806"><code>widget-buttons/js/widget-buttons.js:806</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p><code>HTML_PARSER</code> implementation for the <code>buttons</code> attribute.</p>
<p><strong>Note:</strong> To determine a button node's name its <code>data-name</code> and <code>name</code>
attributes are examined. Whether the button should be the default is
determined by its <code>data-default</code> attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">srcNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>This widget's srcNode to search for buttons.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Null | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
<code>buttons</code> Config object parsed from this widget's DOM.
</div>
</div>
</div>
<div id="method__parseStdModHTML" class="method item private inherited">
<h3 class="name"><code>_parseStdModHTML</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</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/WidgetStdMod.html#method__parseStdModHTML">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l611"><code>widget-stdmod/js/Widget-StdMod.js:611</code></a>
</p>
</div>
<div class="description">
<p>Utility method, used by WidgetStdMods HTML_PARSER implementation
to extract data for each section from markup.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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">
</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>:
Inner HTML string with the contents of the section
</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__parseZIndex" class="method item protected inherited">
<h3 class="name"><code>_parseZIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>srcNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Mixed</span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__parseZIndex">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l183"><code>widget-stack/js/Widget-Stack.js:183</code></a>
</p>
</div>
<div class="description">
<p>Parses a <code>zIndex</code> attribute value from this widget's <code>srcNode</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">srcNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The node to parse a <code>zIndex</code> value from.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Mixed</span>:
The parsed <code>zIndex</code> value.
</div>
</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__preventOverlap" class="method item protected inherited">
<h3 class="name"><code>_preventOverlap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code>axis</code>
</li>
<li class="arg">
<code>nodeRegion</code>
</li>
<li class="arg">
<code>constrainingRegion</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method__preventOverlap">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l208"><code>widget-position-constrain/js/Widget-PositionConstrain.js:208</code></a>
</p>
</div>
<div class="description">
<p>The method which performs the preventOverlap calculations for a given axis ("x" or "y") based
on the value and regions provided.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The value being constrain</p>
</div>
</li>
<li class="param">
<code class="param-name">axis</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 axis to being constrained</p>
</div>
</li>
<li class="param">
<code class="param-name">nodeRegion</code>
<span class="type">Region</span>
<div class="param-description">
<p>The region of the node being constrained</p>
</div>
</li>
<li class="param">
<code class="param-name">constrainingRegion</code>
<span class="type">Region</span>
<div class="param-description">
<p>The region of the node (or viewport) we need to constrain to</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
The constrained value
</div>
</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__removeLoadingClassNames" class="method item protected inherited">
<h3 class="name"><code>_removeLoadingClassNames</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l862"><code>widget/js/Widget.js:862</code></a>
</p>
</div>
<div class="description">
<p>Removes class names representative of the widget's loading state from
the boundingBox.</p>
</div>
</div>
<div id="method__renderBox" class="method item private inherited">
<h3 class="name"><code>_renderBox</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l710"><code>widget/js/Widget.js:710</code></a>
</p>
</div>
<div class="description">
<p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not
already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used
as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and
the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered
to the current document's body.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The parentNode to render the widget to. If not provided, and both the boundingBox and
the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__renderBoxClassNames" class="method item protected inherited">
<h3 class="name"><code>_renderBoxClassNames</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l838"><code>widget/js/Widget.js:838</code></a>
</p>
</div>
<div class="description">
<p>Applies standard class names to the boundingBox and contentBox</p>
</div>
</div>
<div id="method__renderShim" class="method item private inherited">
<h3 class="name"><code>_renderShim</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__renderShim">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l368"><code>widget-stack/js/Widget-Stack.js:368</code></a>
</p>
</div>
<div class="description">
<p>Creates the shim element and adds it to the DOM</p>
</div>
</div>
<div id="method__renderShimDeferred" class="method item private inherited">
<h3 class="name"><code>_renderShimDeferred</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__renderShimDeferred">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l301"><code>widget-stack/js/Widget-Stack.js:301</code></a>
</p>
</div>
<div class="description">
<p>Sets up change handlers for the visible attribute, to defer shim creation/rendering
until the Widget is made visible.</p>
</div>
</div>
<div id="method__renderStdMod" class="method item protected inherited">
<h3 class="name"><code>_renderStdMod</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</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/WidgetStdMod.html#method__renderStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l466"><code>widget-stdmod/js/Widget-StdMod.js:466</code></a>
</p>
</div>
<div class="description">
<p>Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</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>:
A reference to the added section node
</div>
</div>
</div>
<div id="method__renderUI" class="method item protected inherited">
<h3 class="name"><code>_renderUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__renderUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l827"><code>widget/js/Widget.js:827</code></a>
</p>
</div>
<div class="description">
<p>Initializes the UI state for the Widget's bounding/content boxes.</p>
</div>
</div>
<div id="method__renderUIModal" class="method item protected inherited">
<h3 class="name"><code>_renderUIModal</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__renderUIModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l198"><code>widget-modality/js/Widget-Modality.js:198</code></a>
</p>
</div>
<div class="description">
<p>Adds modal class to the bounding box of the widget</p>
<p>
This method in invoked after renderUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__renderUIPosition" class="method item protected inherited">
<h3 class="name"><code>_renderUIPosition</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__renderUIPosition">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l113"><code>widget-position/js/Widget-Position.js:113</code></a>
</p>
</div>
<div class="description">
<p>Creates/Initializes the DOM to support xy page positioning.</p>
<p>
This method in invoked after renderUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__renderUIStack" class="method item protected inherited">
<h3 class="name"><code>_renderUIStack</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__renderUIStack">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l170"><code>widget-stack/js/Widget-Stack.js:170</code></a>
</p>
</div>
<div class="description">
<p>Creates/Initializes the DOM to support stackability.</p>
<p>
This method in invoked after renderUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__renderUIStdMod" class="method item protected inherited">
<h3 class="name"><code>_renderUIStdMod</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__renderUIStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l284"><code>widget-stdmod/js/Widget-StdMod.js:284</code></a>
</p>
</div>
<div class="description">
<p>Creates/Initializes the DOM for standard module support.</p>
<p>
This method is invoked after renderUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__repositionMask" class="method item inherited">
<h3 class="name"><code>_repositionMask</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>nextElem</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__repositionMask">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l488"><code>widget-modality/js/Widget-Modality.js:488</code></a>
</p>
</div>
<div class="description">
<p>Repositions the mask in the DOM for nested modality cases.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">nextElem</code>
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
<div class="param-description">
<p>The Y.Widget instance that will be visible in the stack once the current widget is closed.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__resyncMask" class="method item private inherited">
<h3 class="name"><code>_resyncMask</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>nextElem</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__resyncMask">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l522"><code>widget-modality/js/Widget-Modality.js:522</code></a>
</p>
</div>
<div class="description">
<p>Resyncs the mask in the viewport for browsers that don't support fixed positioning</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">nextElem</code>
<span class="type">Y.Widget</span>
<div class="param-description">
<p>The Y.Widget instance that will be visible in the stack once the current widget is closed.</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__setAlignCenter" class="method item protected inherited">
<h3 class="name"><code>_setAlignCenter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</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> | <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/WidgetPositionAlign.html#method__setAlignCenter">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l327"><code>widget-position-align/js/Widget-PositionAlign.js:327</code></a>
</p>
</div>
<div class="description">
<p>Default setter for <code>center</code> Attribute changes. Sets up the appropriate
value, and passes it through the to the align attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The Attribute value being 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/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>:
the value passed in.
</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__setAttrUI" class="method item private inherited">
<h3 class="name"><code>_setAttrUI</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/Widget.html#method__setAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1201"><code>widget/js/Widget.js:1201</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">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__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__setBB" class="method item private inherited">
<h3 class="name"><code>_setBB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Node/String</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setBB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l756"><code>widget/js/Widget.js:756</code></a>
</p>
</div>
<div class="description">
<p>Setter for the boundingBox attribute</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Node/String</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 class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Node
</div>
</div>
</div>
<div id="method__setBox" class="method item private inherited">
<h3 class="name"><code>_setBox</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>node</code>
</li>
<li class="arg">
<code>template</code>
</li>
<li class="arg">
<code>true</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l793"><code>widget/js/Widget.js:793</code></a>
</p>
</div>
<div class="description">
<p>Helper method to set the bounding/content box, or create it from
the provided template if not found.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</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 node's id attribute</p>
</div>
</li>
<li class="param">
<code class="param-name">node</code>
<span class="type"><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="param-description">
<p>The node reference</p>
</div>
</li>
<li class="param">
<code class="param-name">template</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>HTML string template for the node</p>
</div>
</li>
<li class="param">
<code class="param-name">true</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 this is the boundingBox, false if it's the contentBox</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>:
The node
</div>
</div>
</div>
<div id="method__setButtons" class="method item protected inherited">
<h3 class="name"><code>_setButtons</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="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/WidgetButtons.html#method__setButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l847"><code>widget-buttons/js/widget-buttons.js:847</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Setter for the <code>buttons</code> attribute. This processes the specified <code>config</code>
and returns a new <code>buttons</code> object which is stored as the new state; leaving
the original, specified <code>config</code> unmodified.</p>
<p>The button nodes will either be created via <code>Y.Plugin.Button.createNode()</code>,
or when a button is already a Node already, it will by <code>plug()</code>ed with
<code>Y.Plugin.Button</code>.</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/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">
<p>The <code>buttons</code> configuration to process.</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 processed <code>buttons</code> object which represents the new
state.
</div>
</div>
</div>
<div id="method__setCB" class="method item private inherited">
<h3 class="name"><code>_setCB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l768"><code>widget/js/Widget.js:768</code></a>
</p>
</div>
<div class="description">
<p>Setter for the contentBox attribute</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type"><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="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
Node
</div>
</div>
</div>
<div id="method__setConstrain" class="method item protected inherited">
<h3 class="name"><code>_setConstrain</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method__setConstrain">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l153"><code>widget-position-constrain/js/Widget-PositionConstrain.js:153</code></a>
</p>
</div>
<div class="description">
<p>The setter implementation for the "constrain" attribute.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | boolean</span>
<div class="param-description">
<p>The attribute value</p>
</div>
</li>
</ul>
</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__setStrings" class="method item protected inherited">
<h3 class="name"><code>_setStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>strings</code>
</li>
<li class="arg">
<code>locale</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__setStrings">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l35"><code>widget/js/WidgetLocale.js:35</code></a>
</p>
</div>
<div class="description">
<p>Sets strings for a particular locale, merging with any existing
strings which may already be defined for the locale.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">strings</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 hash of string key/values to set</p>
</div>
</li>
<li class="param">
<code class="param-name">locale</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 locale for the string values being set</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setX" class="method item protected inherited">
<h3 class="name"><code>_setX</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__setX">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l196"><code>widget-position/js/Widget-Position.js:196</code></a>
</p>
</div>
<div class="description">
<p>Default setter for the X attribute. The setter passes the X value through
to the XY attribute, which is the sole store for the XY state.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The X page co-ordinate value</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setY" class="method item protected inherited">
<h3 class="name"><code>_setY</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__setY">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l208"><code>widget-position/js/Widget-Position.js:208</code></a>
</p>
</div>
<div class="description">
<p>Default setter for the Y attribute. The setter passes the Y value through
to the XY attribute, which is the sole store for the XY state.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The Y page co-ordinate value</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setZIndex" class="method item protected inherited">
<h3 class="name"><code>_setZIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>zIndex</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__setZIndex">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l218"><code>widget-stack/js/Widget-Stack.js:218</code></a>
</p>
</div>
<div class="description">
<p>Default setter for zIndex attribute changes. Normalizes zIndex values to
numbers, converting non-numerical values to 0.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">zIndex</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/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
Normalized zIndex
</div>
</div>
</div>
<div id="method__strSetter" class="method item protected inherited">
<h3 class="name"><code>_strSetter</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>strings</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/Widget.html#method__strSetter">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a>
</p>
</div>
<div class="description">
<p>The default setter for the strings attribute. Merges partial sets
into the full string set, to allow users to partial sets of strings</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">strings</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 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 full set of strings to set
</div>
</div>
</div>
<div id="method__syncAttrUI" class="method item private inherited">
<h3 class="name"><code>_syncAttrUI</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="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1186"><code>widget/js/Widget.js:1186</code></a>
</p>
</div>
<div class="description">
<p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</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></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__syncUI" class="method item protected inherited">
<h3 class="name"><code>_syncUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l964"><code>widget/js/Widget.js:964</code></a>
</p>
</div>
<div class="description">
<p>Updates the widget UI to reflect the attribute state.</p>
</div>
</div>
<div id="method__syncUIAutohide" class="method item protected inherited">
<h3 class="name"><code>_syncUIAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__syncUIAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l110"><code>widget-autohide/js/Widget-Autohide.js:110</code></a>
</p>
</div>
<div class="description">
<p>Syncs up the widget based on its current state. In particular, removes event listeners if
widget is not visible, and attaches them otherwise.</p>
<p>
This method in invoked after syncUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__syncUIButtons" class="method item protected inherited">
<h3 class="name"><code>_syncUIButtons</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__syncUIButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l903"><code>widget-buttons/js/widget-buttons.js:903</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
<p>Syncs this widget's current button-related state to its DOM. This method is
inserted via AOP, and will execute after <code>syncUI()</code>.</p>
</div>
</div>
<div id="method__syncUIChild" class="method item protected inherited">
<h3 class="name"><code>_syncUIChild</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI to match the WidgetChild state.</p>
<p>
This method is invoked after bindUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__syncUIModal" class="method item protected inherited">
<h3 class="name"><code>_syncUIModal</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__syncUIModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l251"><code>widget-modality/js/Widget-Modality.js:251</code></a>
</p>
</div>
<div class="description">
<p>Syncs the mask with the widget's current state, namely the visibility and z-index of the widget</p>
<p>
This method in invoked after syncUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__syncUIPosAlign" class="method item protected inherited">
<h3 class="name"><code>_syncUIPosAlign</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__syncUIPosAlign">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l254"><code>widget-position-align/js/Widget-PositionAlign.js:254</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the current <code>align</code> Attribute value to the DOM.</p>
<p>This method is invoked after <code>syncUI</code> has been invoked for the <code>Widget</code>
class using the AOP infrastructure.</p>
</div>
</div>
<div id="method__syncUIPosition" class="method item protected inherited">
<h3 class="name"><code>_syncUIPosition</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__syncUIPosition">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l126"><code>widget-position/js/Widget-Position.js:126</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI to match the Widgets xy page position state.</p>
<p>
This method in invoked after syncUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__syncUIStack" class="method item protected inherited">
<h3 class="name"><code>_syncUIStack</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__syncUIStack">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l143"><code>widget-stack/js/Widget-Stack.js:143</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI to match the Widgets stack state. This method in
invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.</p>
</div>
</div>
<div id="method__syncUIStdMod" class="method item protected inherited">
<h3 class="name"><code>_syncUIStdMod</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__syncUIStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l257"><code>widget-stdmod/js/Widget-StdMod.js:257</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the UI to match the Widgets standard module state.</p>
<p>
This method is invoked after syncUI is invoked for the Widget class
using YUI's aop infrastructure.
</p>
</div>
</div>
<div id="method__uiInsertButton" class="method item protected inherited">
<h3 class="name"><code>_uiInsertButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>index</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__uiInsertButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l917"><code>widget-buttons/js/widget-buttons.js:917</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Inserts the specified <code>button</code> node into this widget's DOM at the specified
<code>section</code> and <code>index</code> and updates the section content.</p>
<p>The section and button container nodes will be created if they do not
already exist.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The button node to insert into this widget's DOM.</p>
</div>
</li>
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer).</p>
</div>
</li>
<li class="param">
<code class="param-name">index</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Index at which the <code>button</code> should be positioned.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiRemoveButton" class="method item protected inherited">
<h3 class="name"><code>_uiRemoveButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code>section</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/WidgetButtons.html#method__uiRemoveButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l943"><code>widget-buttons/js/widget-buttons.js:943</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the button node from this widget's DOM and detaches any event
subscriptions on the button that were created by this widget. The section
content will be updated unless <code>{preserveContent: true}</code> is passed in the
<code>options</code>.</p>
<p>By default the button container node will be removed when this removes the
last button of the specified <code>section</code>; and if no other content remains in
the section node, it will also be removed.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The button to remove and destroy.</p>
</div>
</li>
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer).</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.</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[preserveContent=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 section
content should be updated.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="method__uiSetAlign" class="method item protected inherited">
<h3 class="name"><code>_uiSetAlign</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[node]</code>
</li>
<li class="arg">
<code>points</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__uiSetAlign">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l347"><code>widget-position-align/js/Widget-PositionAlign.js:347</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to reflect the <code>align</code> value passed in.</p>
<p><strong>Note:</strong> See the <code>align</code> Attribute documentation, for the Object structure
expected.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[node]</code>
<span class="type"><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> | Null</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The node to align to, or null to indicate
the viewport.</p>
</div>
</li>
<li class="param">
<code class="param-name">points</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>The alignment points.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetButtons" class="method item protected inherited">
<h3 class="name"><code>_uiSetButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>buttons</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__uiSetButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l993"><code>widget-buttons/js/widget-buttons.js:993</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Sets the current <code>buttons</code> state to this widget's DOM by rendering the
specified collection of <code>buttons</code> and updates the contents of each section
as needed.</p>
<p>Button nodes which already exist in the DOM will remain intact, or will be
moved if they should be in a new position. Old button nodes which are no
longer represented in the specified <code>buttons</code> collection will be removed,
and any event subscriptions on the button which were created by this widget
will be detached.</p>
<p>If the button nodes in this widget's DOM actually change, then each content
section will be updated (or removed) appropriately.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">buttons</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 current <code>buttons</code> state to visually represent.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetChildSelected" class="method item protected inherited">
<h3 class="name"><code>_uiSetChildSelected</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>selected</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">selected</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The selected value to be reflected in the UI.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetDefaultButton" class="method item protected inherited">
<h3 class="name"><code>_uiSetDefaultButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>newButton</code>
</li>
<li class="arg">
<code>oldButton</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__uiSetDefaultButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1077"><code>widget-buttons/js/widget-buttons.js:1077</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Adds the "yui3-button-primary" CSS class to the new <code>defaultButton</code> and
removes it from the old default button.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">newButton</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The new <code>defaultButton</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">oldButton</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The old <code>defaultButton</code>.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetDim" class="method item private inherited">
<h3 class="name"><code>_uiSetDim</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dim</code>
</li>
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l997"><code>widget/js/Widget.js:997</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">dim</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 dimension - "width" or "height"</p>
</div>
</li>
<li class="param">
<code class="param-name">val</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</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 value to set</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetDisabled" class="method item protected inherited">
<h3 class="name"><code>_uiSetDisabled</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1018"><code>widget/js/Widget.js:1018</code></a>
</p>
</div>
<div class="description">
<p>Sets the disabled state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetFillHeight" class="method item protected inherited">
<h3 class="name"><code>_uiSetFillHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>fillSection</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__uiSetFillHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l398"><code>widget-stdmod/js/Widget-StdMod.js:398</code></a>
</p>
</div>
<div class="description">
<p>Updates the rendered UI, to resize the provided section so that the standard module fills out
the specified widget height. Note: This method does not check whether or not a height is set
on the Widget.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">fillSection</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>A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetFocused" class="method item protected inherited">
<h3 class="name"><code>_uiSetFocused</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
<li class="arg">
<code>src</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1029"><code>widget/js/Widget.js:1029</code></a>
</p>
</div>
<div class="description">
<p>Sets the focused state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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">
</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>String representing the source that triggered an update to
the UI.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetHeight" class="method item protected inherited">
<h3 class="name"><code>_uiSetHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l974"><code>widget/js/Widget.js:974</code></a>
</p>
</div>
<div class="description">
<p>Sets the height on the widget's bounding box element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetHostVisibleAutohide" class="method item protected inherited">
<h3 class="name"><code>_uiSetHostVisibleAutohide</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#method__uiSetHostVisibleAutohide">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l127"><code>widget-autohide/js/Widget-Autohide.js:127</code></a>
</p>
</div>
<div class="description">
<p>Removes event listeners if widget is not visible, and attaches them otherwise.</p>
</div>
</div>
<div id="method__uiSetHostVisibleModal" class="method item inherited">
<h3 class="name"><code>_uiSetHostVisibleModal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Whether</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__uiSetHostVisibleModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l302"><code>widget-modality/js/Widget-Modality.js:302</code></a>
</p>
</div>
<div class="description">
<p>Performs events attaching/detaching, stack shifting and mask repositioning based on the visibility of the widget</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Whether</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>the widget is visible or not</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetHostZIndexModal" class="method item inherited">
<h3 class="name"><code>_uiSetHostZIndexModal</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Z-Index</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method__uiSetHostZIndexModal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l368"><code>widget-modality/js/Widget-Modality.js:368</code></a>
</p>
</div>
<div class="description">
<p>Sets the z-index of the mask node.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Z-Index</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>of the widget</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetShim" class="method item protected inherited">
<h3 class="name"><code>_uiSetShim</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>enable</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__uiSetShim">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l272"><code>widget-stack/js/Widget-Stack.js:272</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to enable/disable the shim. If the widget is not currently visible,
creation of the shim is deferred until it is made visible, for performance reasons.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">enable</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, creates/renders the shim, if false, removes it.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetStdMod" class="method item protected inherited">
<h3 class="name"><code>_uiSetStdMod</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>content</code>
</li>
<li class="arg">
<code>where</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__uiSetStdMod">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l439"><code>widget-stdmod/js/Widget-StdMod.js:439</code></a>
</p>
</div>
<div class="description">
<p>Updates the rendered UI, adding the provided content (either an HTML string, or node reference),
to the specified section. The content is either added before, after or replaces existing content
in the section, based on the value of the <code>where</code> argument.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</p>
</div>
</li>
<li class="param">
<code class="param-name">content</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/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The new content (either as an HTML string, or Node reference) to add to the section</p>
</div>
</li>
<li class="param">
<code class="param-name">where</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. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.
If not provided, the content will replace existing content in the section.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetTabIndex" class="method item protected inherited">
<h3 class="name"><code>_uiSetTabIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>Number</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1051"><code>widget/js/Widget.js:1051</code></a>
</p>
</div>
<div class="description">
<p>Set the tabIndex on the widget's rendered UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">Number</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__uiSetVisible" class="method item protected inherited">
<h3 class="name"><code>_uiSetVisible</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1007"><code>widget/js/Widget.js:1007</code></a>
</p>
</div>
<div class="description">
<p>Sets the visible state for the UI</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetVisibleButtons" class="method item protected inherited">
<h3 class="name"><code>_uiSetVisibleButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>visible</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__uiSetVisibleButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1094"><code>widget-buttons/js/widget-buttons.js:1094</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Focuses this widget's <code>defaultButton</code> if there is one and this widget is
visible.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">visible</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 this widget is visible.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetVisiblePosAlign" class="method item protected inherited">
<h3 class="name"><code>_uiSetVisiblePosAlign</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>visible</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method__uiSetVisiblePosAlign">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l441"><code>widget-position-align/js/Widget-PositionAlign.js:441</code></a>
</p>
</div>
<div class="description">
<p>Attaches or detaches alignment-syncing event handlers based on the widget's
<code>visible</code> Attribute state.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">visible</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>The current value of the widget's <code>visible</code>
Attribute.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetWidth" class="method item protected inherited">
<h3 class="name"><code>_uiSetWidth</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l986"><code>widget/js/Widget.js:986</code></a>
</p>
</div>
<div class="description">
<p>Sets the width on the widget's bounding box element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetXY" class="method item protected inherited">
<h3 class="name"><code>_uiSetXY</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method__uiSetXY">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l258"><code>widget-position/js/Widget-Position.js:258</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to reflect the XY page co-ordinates passed in.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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 XY page co-ordinates value to be reflected in the UI</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSetZIndex" class="method item protected inherited">
<h3 class="name"><code>_uiSetZIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>zIndex</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method__uiSetZIndex">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l261"><code>widget-stack/js/Widget-Stack.js:261</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI to reflect the zIndex value passed in.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">zIndex</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The zindex to be reflected in the UI</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uiSizeCB" class="method item protected inherited">
<h3 class="name"><code>_uiSizeCB</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>expand</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l701"><code>widget/js/Widget.js:701</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">expand</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">
</div>
</li>
</ul>
</div>
</div>
<div id="method__unbindDOM" class="method item protected inherited">
<h3 class="name"><code>_unbindDOM</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l933"><code>widget/js/Widget.js:933</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method__unbindUI" class="method item protected inherited">
<h3 class="name"><code>_unbindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__unbindUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l894"><code>widget/js/Widget.js:894</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="method__unMapButton" class="method item protected inherited">
<h3 class="name"><code>_unMapButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code>section</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__unMapButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1112"><code>widget-buttons/js/widget-buttons.js:1112</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes the specified <code>button</code> from the buttons map (both name -> button and
section:name -> button), and nulls-out the <code>defaultButton</code> if it is
currently the default button.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The button node to remove from the buttons map.</p>
</div>
</li>
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer).</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__updateContentButtons" class="method item protected inherited">
<h3 class="name"><code>_updateContentButtons</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__updateContentButtons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1164"><code>widget-buttons/js/widget-buttons.js:1164</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the content attribute which corresponds to the specified <code>section</code>.</p>
<p>The method updates the section's content to its current <code>childNodes</code>
(text and/or HTMLElement), or will null-out its contents if the section is
empty. It also specifies a <code>src</code> of <code>buttons</code> on the change event facade.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 <code>WidgetStdMod</code> section (header/body/footer) to
update.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__updateDefaultButton" class="method item protected inherited">
<h3 class="name"><code>_updateDefaultButton</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method__updateDefaultButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l1148"><code>widget-buttons/js/widget-buttons.js:1148</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Updates the <code>defaultButton</code> attribute if it needs to be updated by comparing
its current value with the protected <code>_defaultButton</code> property.</p>
</div>
</div>
<div id="method__validateFillHeight" class="method item protected inherited">
<h3 class="name"><code>_validateFillHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method__validateFillHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l384"><code>widget-stdmod/js/Widget-StdMod.js:384</code></a>
</p>
</div>
<div class="description">
<p>Default validator for the fillHeight attribute. Verifies that the
value set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER,
or a falsey value if fillHeight is to be disabled.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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 section which should be setup to fill height, or false/null to disable fillHeight</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
true if valid, false if not
</div>
</div>
</div>
<div id="method__validateXY" class="method item protected inherited">
<h3 class="name"><code>_validateXY</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>val</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/WidgetPosition.html#method__validateXY">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l184"><code>widget-position/js/Widget-Position.js:184</code></a>
</p>
</div>
<div class="description">
<p>Default validator for the XY attribute</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">val</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>The XY page co-ordinate value which is being 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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
true if valid, false if not.
</div>
</div>
</div>
<div id="method__validTabIndex" class="method item protected inherited">
<h3 class="name"><code>_validTabIndex</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>tabIndex</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1161"><code>widget/js/Widget.js:1161</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">tabIndex</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
</div>
</li>
</ul>
</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_addButton" class="method item inherited">
<h3 class="name"><code>addButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code class="optional">[section="footer"]</code>
</li>
<li class="arg">
<code class="optional">[index]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method_addButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l284"><code>widget-buttons/js/widget-buttons.js:284</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
<p>Adds a button to this widget.</p>
<p>The new button node will have the <code>Y.Plugin.Button</code> plugin applied, be added
to this widget's <code>buttons</code>, and rendered in the specified <code>section</code> at the
specified <code>index</code> (or end of the section when no <code>index</code> is provided). If
the section does not exist, it will be created.</p>
<p>This fires the <code>buttonsChange</code> event and adds the following properties to
the event facade:</p>
<ul>
<li><p><code>button</code>: The button node or config object to add.</p></li>
<li><p><code>section</code>: The <code>WidgetStdMod</code> section (header/body/footer) where the
button will be added.</p></li>
<li><p><code>index</code>: The index at which the button will be in the section.</p></li>
<li><p><code>src</code>: "add"</p></li>
</ul>
<p><strong>Note:</strong> The <code>index</code> argument will be passed to the Array <code>splice()</code>
method, therefore a negative value will insert the <code>button</code> that many items
from the end. The <code>index</code> property on the <code>buttonsChange</code> event facade is
the index at which the <code>button</code> was added.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</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 button to add. This can be a <code>Y.Node</code>
instance, config Object, or String name for a predefined button on the
<code>BUTTONS</code> prototype property. When a config Object is provided, it will
be merged with any defaults provided by any <code>srcNode</code> and/or a button
with the same <code>name</code> defined on the <code>BUTTONS</code> property. The following
are the possible configuration properties beyond what Node plugins
accept by default:</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[action]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The default handler that should
be called when the button is clicked. A String name of a Function that
exists on the <code>context</code> object can also be provided. <strong>Note:</strong>
Specifying a set of <code>events</code> will override this setting.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[classNames]</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/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>Additional CSS classes to add
to the button node.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[context=this]</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>Context which any <code>events</code> or
<code>action</code> should be called with. Defaults to <code>this</code>, the widget.
<strong>Note:</strong> <code>e.target</code> will access the button node in the event handlers.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[disabled=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 button should be
disabled.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[events="click"]</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>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Event name, or set of
events and handlers to bind to the button node. <strong>See:</strong> <code>Y.Node.on()</code>,
this value is passed as the first argument to <code>on()</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[isDefault=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 button is the
default button.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[label]</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 visible text/value displayed in the
button.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[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>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A name which can later be used to reference
this button. If a button is defined on the <code>BUTTONS</code> property with this
same name, its configuration properties will be merged in as defaults.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[section]</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 <code>WidgetStdMod</code> section (header, body,
footer) where the button should be added.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[srcNode]</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>An existing Node to use for the button,
default values will be seeded from this node, but are overriden by any
values specified in the config object. By default a new <button>
node will be created.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[template]</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>A specific template to use when creating
a new button node (e.g. "<a />"). <strong>Note:</strong> Specifying a <code>srcNode</code>
will overide this.</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name optional">[section="footer"]</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 <code>WidgetStdMod</code> section
(header/body/footer) where the button should be added. This takes
precedence over the <code>button.section</code> configuration property.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[index]</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>The index at which the button should be inserted. If
not specified, the button will be added to the end of the section. This
value is passed to the Array <code>splice()</code> method, therefore a negative
value will insert the <code>button</code> that many items from the end.</p>
</div>
</li>
</ul>
</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_align" class="method item inherited">
<h3 class="name"><code>align</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[node]</code>
</li>
<li class="arg">
<code class="optional">[points]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method_align">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l275"><code>widget-position-align/js/Widget-PositionAlign.js:275</code></a>
</p>
</div>
<div class="description">
<p>Aligns this widget to the provided <code>Node</code> (or viewport) using the provided
points. This method can be invoked with no arguments which will cause the
widget's current <code>align</code> Attribute value to be synced to the DOM.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[node]</code>
<span class="type"><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> | Null</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A reference (or selector String) for the
<code>Node</code> which with the widget is to be aligned. If null is passed in, the
widget will be aligned with the viewport.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[points]</code>
<span class="type">Array2</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>A two item array specifying the points on the
widget and <code>Node</code>/viewport which will to be aligned. The first entry is
the point on the widget, and the second entry is the point on the
<code>Node</code>/viewport. Valid point references are defined as static constants on
the <code>WidgetPositionAlign</code> extension.</p>
</div>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<p>Aligning to the top-left corner of the <code><body></code>:</p>
<pre class="code prettyprint"><code>myWidget.align('body',
[Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);
</code></pre>
</div>
</div>
</div>
<div id="method_ancestor" class="method item inherited">
<h3 class="name"><code>ancestor</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>depth</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_ancestor">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget instance at the specified depth.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">depth</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Number representing the depth of the ancestor.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</div>
</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_bindUI" class="method item protected inherited">
<h3 class="name"><code>bindUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_bindUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l611"><code>widget/js/Widget.js:611</code></a>
</p>
</div>
<div class="description">
<p>Configures/Sets up listeners to bind Widget State to UI/DOM</p>
<p>This method is not called by framework and is not chained
automatically for the class hierarchy.</p>
</div>
</div>
<div id="method_blur" class="method item inherited">
<h3 class="name"><code>blur</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_blur">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l673"><code>widget/js/Widget.js:673</code></a>
</p>
</div>
<div class="description">
<p>Causes the Widget to lose focus by setting the "focused" attribute
to "false"</p>
</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_centered" class="method item inherited">
<h3 class="name"><code>centered</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[node]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#method_centered">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l311"><code>widget-position-align/js/Widget-PositionAlign.js:311</code></a>
</p>
</div>
<div class="description">
<p>Centers the widget in the viewport, or if a <code>Node</code> is passed in, it will
be centered to that <code>Node</code>.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[node]</code>
<span class="type"><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>A <code>Node</code> reference or selector String defining
the <code>Node</code> which the widget should be centered. If a <code>Node</code> is not passed
in, then the widget will be centered to the viewport.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_constrain" class="method item inherited">
<h3 class="name"><code>constrain</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>xy</code>
</li>
<li class="arg">
<code>node</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method_constrain">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l128"><code>widget-position-constrain/js/Widget-PositionConstrain.js:128</code></a>
</p>
</div>
<div class="description">
<p>Constrains the widget's bounding box to a node (or the viewport). If xy or node are not
passed in, the current position and the value of "constrain" will be used respectively.</p>
<p>The widget's position will be changed to the constrained position.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">xy</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>Optional. The xy values to constrain</p>
</div>
</li>
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | boolean</span>
<div class="param-description">
<p>Optional. The node to constrain to, or true for the viewport</p>
</div>
</li>
</ul>
</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>destroyAllNodes</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<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/widget_js_Widget.js.html#l452"><code>widget/js/Widget.js:452</code></a>
</p>
</div>
<div class="description">
<p>
Destroy lifecycle method. Fires the destroy
event, prior to invoking destructors for the
class hierarchy.
Overrides Base's implementation, to support arguments to destroy
</p>
<p>
Subscribers to the destroy
event can invoke preventDefault on the event object, to prevent destruction
from proceeding.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">destroyAllNodes</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, all nodes contained within the Widget are
removed and destroyed. Defaults to false due to potentially high run-time cost.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
A reference to this object
</div>
</div>
</div>
<div id="method_destructor" class="method item protected inherited">
<h3 class="name"><code>destructor</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_destructor">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l427"><code>widget/js/Widget.js:427</code></a>
</p>
</div>
<div class="description">
<p>Destructor lifecycle implementation for the Widget class. Purges events attached
to the bounding box and content box, removes them from the DOM and removes
the Widget from the list of registered widgets.</p>
</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_disable" class="method item inherited">
<h3 class="name"><code>disable</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_disable">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l692"><code>widget/js/Widget.js:692</code></a>
</p>
</div>
<div class="description">
<p>Set the Widget's "disabled" attribute to "true".</p>
</div>
</div>
<div id="method_enable" class="method item inherited">
<h3 class="name"><code>enable</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_enable">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l683"><code>widget/js/Widget.js:683</code></a>
</p>
</div>
<div class="description">
<p>Set the Widget's "disabled" attribute to "false".</p>
</div>
</div>
<div id="method_enable or disable constraints listeners" class="method item private inherited">
<h3 class="name"><code>enable or disable constraints listeners</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>enable</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#method_enable or disable constraints listeners">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l287"><code>widget-position-constrain/js/Widget-PositionConstrain.js:287</code></a>
</p>
</div>
<div class="description">
<p>Updates the UI if enabling constraints, and sets up the xyChange event listeners
to constrain whenever the widget is moved. Disabling constraints removes the listeners.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">enable</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>Enable or disable constraints</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_fillHeight" class="method item inherited">
<h3 class="name"><code>fillHeight</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method_fillHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l712"><code>widget-stdmod/js/Widget-StdMod.js:712</code></a>
</p>
</div>
<div class="description">
<p>Sets the height on the provided header, body or footer element to
fill out the height of the Widget. It determines the height of the
widgets bounding box, based on it's configured height value, and
sets the height of the provided section to fill out any
space remaining after the other standard module section heights
have been accounted for.</p>
<p><strong>NOTE:</strong> This method is not designed to work if an explicit
height has not been set on the Widget, since for an "auto" height Widget,
the heights of the header/body/footer will drive the height of the Widget.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The node which should be resized to fill out the height
of the Widget bounding box. Should be a standard module section node which belongs
to the widget.</p>
</div>
</li>
</ul>
</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_focus" class="method item inherited">
<h3 class="name"><code>focus</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_focus">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l663"><code>widget/js/Widget.js:663</code></a>
</p>
</div>
<div class="description">
<p>Causes the Widget to receive the focus by setting the "focused"
attribute to "true".</p>
</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_getButton" class="method item inherited">
<h3 class="name"><code>getButton</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">[section="footer"]</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/WidgetButtons.html#method_getButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l388"><code>widget-buttons/js/widget-buttons.js:388</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Returns a button node from this widget's <code>buttons</code>.</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="../classes/Number.html" class="crosslink">Number</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 string name or index of the button.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[section="footer"]</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 <code>WidgetStdMod</code> section
(header/body/footer) where the button exists. Only applicable when
looking for a button by numerical index, or by name but scoped to a
particular section.</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>:
The button node.
</div>
</div>
</div>
<div id="method_getClassName" class="method item inherited">
<h3 class="name"><code>getClassName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>args</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getClassName">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>
</p>
</div>
<div class="description">
<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and
<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).</p>
<p>
The instance based version of this method can be used to generate standard prefixed classnames,
based on the instances NAME, as opposed to Widget.NAME. This method should be used when you
need to use a constant class name across different types instances.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">args</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 multiple" title="This argument may occur one or more times.">multiple</span>
<div class="param-description">
<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getConstrainedXY" class="method item inherited">
<h3 class="name"><code>getConstrainedXY</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>xy</code>
</li>
<li class="arg">
<code>node</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/WidgetPositionConstrain.html#method_getConstrainedXY">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l106"><code>widget-position-constrain/js/Widget-PositionConstrain.js:106</code></a>
</p>
</div>
<div class="description">
<p>Calculates the constrained positions for the XY positions provided, using
the provided node argument is passed in. If no node value is passed in, the value of
the "constrain" attribute is used.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">xy</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>The xy values to constrain</p>
</div>
</li>
<li class="param">
<code class="param-name">node</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | boolean</span>
<div class="param-description">
<p>Optional. The node to constrain to, or true for the viewport</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>:
The constrained xy values
</div>
</div>
</div>
<div id="method_getDefaultLocale" class="method item inherited">
<h3 class="name"><code>getDefaultLocale</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/Widget.html#method_getDefaultLocale">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l153"><code>widget/js/WidgetLocale.js:153</code></a>
</p>
</div>
<div class="description">
<p>Returns the default locale for the widget (the locale value defined by the
widget class, or provided by the user during construction).</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 default locale for the widget
</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_getSkinName" class="method item inherited">
<h3 class="name"><code>getSkinName</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[skinPrefix]</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/Widget.html#method_getSkinName">Widget</a>:
<a href="../files/widget_js_WidgetSkin.js.html#l12"><code>widget/js/WidgetSkin.js:12</code></a>
</p>
</div>
<div class="description">
<p>Returns the name of the skin that's currently applied to the widget.</p>
<p>Searches up the Widget's ancestor axis for, by default, a class
yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.</p>
<p>This is only really useful after the widget's DOM structure is in the
document, either by render or by progressive enhancement.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[skinPrefix]</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 which the implementation uses for the skin
("yui3-skin-" is the default).</p>
<p>NOTE: skinPrefix will be used as part of a regular expression:</p>
<pre><code>new RegExp('\\b' + skinPrefix + '(\\S+)')
</code></pre>
<p>Although an unlikely use case, literal characters which may result in an invalid
regular expression should be escaped.</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 name of the skin, or null, if a matching skin class is not found.
</div>
</div>
</div>
<div id="method_getStdModNode" class="method item inherited">
<h3 class="name"><code>getStdModNode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>forceCreate</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/WidgetStdMod.html#method_getStdModNode">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l686"><code>widget-stdmod/js/Widget-StdMod.js:686</code></a>
</p>
</div>
<div class="description">
<p>Returns the node reference for the specified <code>section</code>.</p>
<p><strong>Note:</strong> The DOM is not queried for the node reference. The reference
stored by the widget instance is returned if it was set. Passing a
truthy for <code>forceCreate</code> will create the section node if it does not
already exist.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 section whose node reference is required.
Either <code>WidgetStdMod.HEADER</code>, <code>WidgetStdMod.BODY</code>, or
<code>WidgetStdMod.FOOTER</code>.</p>
</div>
</li>
<li class="param">
<code class="param-name">forceCreate</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 section node should be created
if it does not already exist.</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>:
The node reference for the <code>section</code>, or null if not set.
</div>
</div>
</div>
<div id="method_getString" class="method item deprecated inherited">
<h3 class="name"><code>getString</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</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 deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getString">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1225"><code>widget/js/Widget.js:1225</code></a>
</p>
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
</div>
<div class="description">
<p>Helper method to get a specific string value</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</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">
</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 string
</div>
</div>
</div>
<div id="method_getStrings" class="method item deprecated inherited">
<h3 class="name"><code>getStrings</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>key</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 deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_getStrings">
Widget
</a>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1237"><code>widget/js/Widget.js:1237</code></a>
</p>
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
</div>
<div class="description">
<p>Helper method to get the complete set of strings for the widget</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">key</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">
</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 strings
</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_hide" class="method item inherited">
<h3 class="name"><code>hide</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_hide">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l645"><code>widget/js/Widget.js:645</code></a>
</p>
</div>
<div class="description">
<p>Hides the Widget by setting the "visible" attribute to "false".</p>
</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_initializer" class="method item protected inherited">
<h3 class="name"><code>initializer</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 protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_initializer">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l380"><code>widget/js/Widget.js:380</code></a>
</p>
</div>
<div class="description">
<p>Initializer lifecycle implementation for the Widget class. Registers the
widget instance, and runs through the Widget's HTML_PARSER definition.</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>Configuration object literal for the widget</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_isNested" class="method item public inherited">
<h3 class="name"><code>isNested</code></h3>
<span class="paren">()</span>
<span class="flag public">public</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#method_isNested">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l475"><code>widget-modality/js/Widget-Modality.js:475</code></a>
</p>
</div>
<div class="description">
<p>Returns a boolean representing whether the current widget is in a "nested modality" state.
This is done by checking the number of widgets currently on the stack.</p>
</div>
</div>
<div id="method_isRoot" class="method item inherited">
<h3 class="name"><code>isRoot</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/Widget.html#method_isRoot">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>
</p>
</div>
<div class="description">
<p>Determines if the Widget is the root Widget in the
object 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/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
Boolean indicating if Widget is the root Widget in the
object hierarchy.
</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_move" class="method item inherited">
<h3 class="name"><code>move</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>x</code>
</li>
<li class="arg">
<code>y</code>
</li>
<li class="arg">
<code>x,</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method_move">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l157"><code>widget-position/js/Widget-Position.js:157</code></a>
</p>
</div>
<div class="description">
<p>Moves the Widget to the specified page xy co-ordinate position.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">x</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The new x position</p>
</div>
</li>
<li class="param">
<code class="param-name">y</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The new y position</p>
<p>Or</p>
</div>
</li>
<li class="param">
<code class="param-name">x,</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>y values passed as an array ([x, y]), to support
simple pass through of Node.getXY results</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_next" class="method item inherited">
<h3 class="name"><code>next</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>circular</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_next">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget's next sibling.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">circular</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>Boolean indicating if the parent's first child
should be returned if the child has no next sibling.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</div>
</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_previous" class="method item inherited">
<h3 class="name"><code>previous</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>circular</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_previous">Widget</a>:
<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>
</p>
</div>
<div class="description">
<p>Returns the Widget's previous sibling.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">circular</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>Boolean indicating if the parent's last child
should be returned if the child has no previous sibling.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
Widget instance.
</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_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_removeButton" class="method item inherited">
<h3 class="name"><code>removeButton</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>button</code>
</li>
<li class="arg">
<code class="optional">[section="footer"]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#method_removeButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l418"><code>widget-buttons/js/widget-buttons.js:418</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Removes a button from this widget.</p>
<p>The button will be removed from this widget's <code>buttons</code> and its DOM. Any
event subscriptions on the button which were created by this widget will be
detached. If the content section becomes empty after removing the button
node, then the section will also be removed.</p>
<p>This fires the <code>buttonsChange</code> event and adds the following properties to
the event facade:</p>
<ul>
<li><p><code>button</code>: The button node to remove.</p></li>
<li><p><code>section</code>: The <code>WidgetStdMod</code> section (header/body/footer) where the
button should be removed from.</p></li>
<li><p><code>index</code>: The index at which the button exists in the section.</p></li>
<li><p><code>src</code>: "remove"</p></li>
</ul>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">button</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="../classes/Number.html" class="crosslink">Number</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 button to remove. This can be a
<code>Y.Node</code> instance, index, or String name of a button.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[section="footer"]</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 <code>WidgetStdMod</code> section
(header/body/footer) where the button exists. Only applicable when
removing a button by numerical index, or by name but scoped to a
particular section.</p>
</div>
</li>
</ul>
</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 inherited">
<h3 class="name"><code>render</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>parentNode</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag final">final</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l513"><code>widget/js/Widget.js:513</code></a>
</p>
</div>
<div class="description">
<p>Establishes the initial DOM for the widget. Invoking this
method will lead to the creating of all DOM elements for
the widget (or the manipulation of existing DOM elements
for the progressive enhancement use case).</p>
<p>
This method should only be invoked once for an initialized
widget.
</p>
<p>
It delegates to the widget specific renderer method to do
the actual work.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">parentNode</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</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>Optional. The Node under which the
Widget is to be rendered. This can be a Node instance or a CSS selector string.</p>
<p>
If the selector string returns more than one Node, the first node will be used
as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox
are not currently in the document. If it's not provided, the Widget will be rendered
to the body of the current document in this case.
</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_renderer" class="method item protected inherited">
<h3 class="name"><code>renderer</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_renderer">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l588"><code>widget/js/Widget.js:588</code></a>
</p>
</div>
<div class="description">
<p>Creates DOM (or manipulates DOM for progressive enhancement)
This method is invoked by render() and is not chained
automatically for the class hierarchy (unlike initializer, destructor)
so it should be chained manually for subclasses if required.</p>
</div>
</div>
<div id="method_renderUI" class="method item protected inherited">
<h3 class="name"><code>renderUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_renderUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l622"><code>widget/js/Widget.js:622</code></a>
</p>
</div>
<div class="description">
<p>Adds nodes to the DOM</p>
<p>This method is not called by framework and is not chained
automatically for the class hierarchy.</p>
</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_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_setStdModContent" class="method item inherited">
<h3 class="name"><code>setStdModContent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>section</code>
</li>
<li class="arg">
<code>content</code>
</li>
<li class="arg">
<code>where</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#method_setStdModContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l668"><code>widget-stdmod/js/Widget-StdMod.js:668</code></a>
</p>
</div>
<div class="description">
<p>Updates the body section of the standard module with the content provided (either an HTML string, or node reference).</p>
<p>
This method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section,
and insert content before or after it, by specifying the <code>where</code> argument.
</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">section</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 standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER.</p>
</div>
</li>
<li class="param">
<code class="param-name">content</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/Node.html" class="crosslink">Node</a></span>
<div class="param-description">
<p>The content to be added, either an HTML string or a Node reference.</p>
</div>
</li>
<li class="param">
<code class="param-name">where</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. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.
If not provided, the content will replace existing content in the section.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_show" class="method item inherited">
<h3 class="name"><code>show</code></h3>
<span class="paren">()</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_show">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l654"><code>widget/js/Widget.js:654</code></a>
</p>
</div>
<div class="description">
<p>Shows the Widget by setting the "visible" attribute to "true".</p>
</div>
</div>
<div id="method_sizeShim" class="method item inherited">
<h3 class="name"><code>sizeShim</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#method_sizeShim">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l404"><code>widget-stack/js/Widget-Stack.js:404</code></a>
</p>
</div>
<div class="description">
<p>For IE6, synchronizes the size and position of iframe shim to that of
Widget bounding box which it is protecting. For all other browsers,
this method does not do anything.</p>
</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_syncUI" class="method item protected inherited">
<h3 class="name"><code>syncUI</code></h3>
<span class="paren">()</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#method_syncUI">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l633"><code>widget/js/Widget.js:633</code></a>
</p>
</div>
<div class="description">
<p>Refreshes the rendered UI, based on Widget State</p>
<p>This method is not called by framework and is not chained
automatically for the class hierarchy.</p>
</div>
</div>
<div id="method_syncXY" class="method item inherited">
<h3 class="name"><code>syncXY</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#method_syncXY">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l174"><code>widget-position/js/Widget-Position.js:174</code></a>
</p>
</div>
<div class="description">
<p>Synchronizes the Panel's "xy", "x", and "y" properties with the
Widget's position in the DOM.</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>
but overwritten in
<a href="../files/widget_js_Widget.js.html#l1107"><code>widget/js/Widget.js:1107</code></a>
</p>
</div>
<div class="description">
<p>Generic toString implementation for all widgets.</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 default string value for the widget [ displays the NAME of the instance, and the unique id ]
</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>
<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>:
<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>
</p>
</div>
<div class="description">
<p>This property controls whether or not instances of this class should
allow users to add ad-hoc attributes through the constructor configuration
hash.</p>
<p>AdHoc attributes are attributes which are not defined by the class, and are
not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>
</div>
<p><strong>Default:</strong> undefined (false)</p>
</div>
<div id="property__buttonsHandles" class="property item protected inherited">
<h3 class="name"><code>_buttonsHandles</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>Inherited from
<a href="../classes/WidgetButtons.html#property__buttonsHandles">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l225"><code>widget-buttons/js/widget-buttons.js:225</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>A map of button node <code>_yuid</code> -> event-handle for all button nodes which were
created by this widget.</p>
</div>
</div>
<div id="property__buttonsMap" class="property item protected inherited">
<h3 class="name"><code>_buttonsMap</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>Inherited from
<a href="../classes/WidgetButtons.html#property__buttonsMap">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l235"><code>widget-buttons/js/widget-buttons.js:235</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>A map of this widget's <code>buttons</code>, both name -> button and
section:name -> button.</p>
</div>
</div>
<div id="property__defaultButton" class="property item protected inherited">
<h3 class="name"><code>_defaultButton</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#property__defaultButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l245"><code>widget-buttons/js/widget-buttons.js:245</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Internal reference to this widget's default button.</p>
</div>
</div>
<div id="property__posAlignUIHandles" class="property item protected inherited">
<h3 class="name"><code>_posAlignUIHandles</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#property__posAlignUIHandles">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l222"><code>widget-position-align/js/Widget-PositionAlign.js:222</code></a>
</p>
</div>
<div class="description">
<p>Holds the alignment-syncing event handles.</p>
</div>
<p><strong>Default:</strong> null</p>
</div>
<div id="property__UI_ATTRS" class="property item private inherited">
<h3 class="name"><code>_UI_ATTRS</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 private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1249"><code>widget/js/Widget.js:1249</code></a>
</p>
</div>
<div class="description">
<p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p>
</div>
</div>
<div id="property_BOUNDING_TEMPLATE" class="property item inherited">
<h3 class="name"><code>BOUNDING_TEMPLATE</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/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1145"><code>widget/js/Widget.js:1145</code></a>
</p>
</div>
<div class="description">
<p>Property defining the markup template for bounding box.</p>
</div>
</div>
<div id="property_BUTTONS" class="property item">
<h3 class="name"><code>BUTTONS</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/WidgetButtons.html#property_BUTTONS">
WidgetButtons
</a>
but overwritten in
<a href="../files/panel_js_panel.js.html#l49"><code>panel/js/panel.js:49</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>Collection of predefined buttons mapped from name => config.</p>
<p>Panel includes a "close" button which can be use by name. When the close
button is in the header (which is the default), it will look like: [x].</p>
<p>See <code>addButton()</code> for a list of possible configuration values.</p>
</div>
<p><strong>Default:</strong> {close: {}}</p>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>// Panel with close button in header.
var panel = new Y.Panel({
buttons: ['close']
});
// Panel with close button in footer.
var otherPanel = new Y.Panel({
buttons: {
footer: ['close']
}
});
</code></pre>
</div>
</div>
</div>
<div id="property_BUTTONS_TEMPLATE" class="property item inherited">
<h3 class="name"><code>BUTTONS_TEMPLATE</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/WidgetButtons.html#property_BUTTONS_TEMPLATE">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l202"><code>widget-buttons/js/widget-buttons.js:202</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The HTML template to use when creating the node which wraps all buttons of a
section. By default it will have the CSS class: "yui3-widget-buttons".</p>
</div>
<p><strong>Default:</strong> "<span />"</p>
</div>
<div id="property_CONTENT_TEMPLATE" class="property item inherited">
<h3 class="name"><code>CONTENT_TEMPLATE</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/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1135"><code>widget/js/Widget.js:1135</code></a>
</p>
</div>
<div class="description">
<p>Property defining the markup template for content box. If your Widget doesn't
need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,
and contentBox and boundingBox will both point to the same Node.</p>
</div>
</div>
<div id="property_DEF_PARENT_NODE" class="property item inherited">
<h3 class="name"><code>DEF_PARENT_NODE</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="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1126"><code>widget/js/Widget.js:1126</code></a>
</p>
</div>
<div class="description">
<p>Default node to render the bounding box to. If not set,
will default to the current document body.</p>
</div>
</div>
<div id="property_DEF_UNIT" class="property item inherited">
<h3 class="name"><code>DEF_UNIT</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/Widget.html#property_DEF_UNIT">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l1118"><code>widget/js/Widget.js:1118</code></a>
</p>
</div>
<div class="description">
<p>Default unit to use for dimension values</p>
</div>
</div>
<div id="property_DEFAULT_BUTTONS_SECTION" class="property item inherited">
<h3 class="name"><code>DEFAULT_BUTTONS_SECTION</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/WidgetButtons.html#property_DEFAULT_BUTTONS_SECTION">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l213"><code>widget-buttons/js/widget-buttons.js:213</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The default section to render buttons in when no section is specified.</p>
</div>
<p><strong>Default:</strong> Y.WidgetStdMod.FOOTER</p>
</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_STACK" class="property item inherited">
<h3 class="name"><code>STACK</code></h3>
<span class="type">Unknown</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#property_STACK">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l173"><code>widget-modality/js/Widget-Modality.js:173</code></a>
</p>
</div>
<div class="description">
<p>A stack of Y.Widget objects representing the current hierarchy of modal widgets presently displayed on the screen</p>
</div>
</div>
<div id="property_UI_EVENTS" class="property item inherited">
<h3 class="name"><code>UI_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/Widget.html#property_UI_EVENTS">Widget</a>:
<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>
</p>
</div>
<div class="description">
<p>Map of DOM events that should be fired as Custom Events by the
Widget instance.</p>
</div>
</div>
</div>
<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>
<div id="attr_align" class="attr item inherited">
<a name="config_align"></a>
<h3 class="name"><code>align</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/WidgetPositionAlign.html#attr_align">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l48"><code>widget-position-align/js/Widget-PositionAlign.js:48</code></a>
</p>
</div>
<div class="description">
<p>The alignment configuration for this widget.</p>
<p>The <code>align</code> attribute is used to align a reference point on the widget, with
the reference point on another <code>Node</code>, or the viewport. The object which
<code>align</code> expects has the following properties:</p>
<ul>
<li><p><strong><code>node</code></strong>: The <code>Node</code> to which the widget is to be aligned. If set to
<code>null</code>, or not provided, the widget is aligned to the viewport.</p></li>
<li><p><strong><code>points</code></strong>: A two element Array, defining the two points on the widget
and <code>Node</code>/viewport which are to be aligned. The first element is the
point on the widget, and the second element is the point on the
<code>Node</code>/viewport. Supported alignment points are defined as static
properties on <code>WidgetPositionAlign</code>.</p></li>
</ul>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>alignChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>align</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 class="example">
<h4>Example:</h4>
<div class="example-content">
<p>Aligns the top-right corner of the widget with the top-left corner
of the viewport:</p>
<pre class="code prettyprint"><code>myWidget.set('align', {
points: [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL]
});
</code></pre>
</div>
</div>
</div>
<div id="attr_alignOn" class="attr item inherited">
<a name="config_alignOn"></a>
<h3 class="name"><code>alignOn</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#attr_alignOn">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l97"><code>widget-position-align/js/Widget-PositionAlign.js:97</code></a>
</p>
</div>
<div class="description">
<p>An Array of Objects corresponding to the <code>Node</code>s and events that will cause
the alignment of this widget to be synced to the DOM.</p>
<p>The <code>alignOn</code> Attribute is expected to be an Array of Objects with the
following properties:</p>
<ul>
<li><p><strong><code>eventName</code></strong>: The String event name to listen for.</p></li>
<li><p><strong><code>node</code></strong>: The optional <code>Node</code> that will fire the event, it can be a
<code>Node</code> reference or a selector String. This will default to the widget's
<code>boundingBox</code>.</p></li>
</ul>
</div>
<p><strong>Default:</strong> []</p>
<div class="emits box">
<h4>Fires event <code>alignOnChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>alignOn</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 class="example">
<h4>Example:</h4>
<div class="example-content">
<p>Sync this widget's alignment on window resize:</p>
<pre class="code prettyprint"><code>myWidget.set('alignOn', [
{
node : Y.one('win'),
eventName: 'resize'
}
]);
</code></pre>
</div>
</div>
</div>
<div id="attr_bodyContent" class="attr item inherited">
<a name="config_bodyContent"></a>
<h3 class="name"><code>bodyContent</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#attr_bodyContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l171"><code>widget-stdmod/js/Widget-StdMod.js:171</code></a>
</p>
</div>
<div class="description">
<p>The content to be added to the body section. This will replace any existing content
in the body. If you want to append, or insert new content, use the <a href="#method_setStdModContent">setStdModContent</a> method.</p>
</div>
<p><strong>Default:</strong> undefined</p>
<div class="emits box">
<h4>Fires event <code>bodyContentChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>bodyContent</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_boundingBox" class="attr item inherited">
<a name="config_boundingBox"></a>
<h3 class="name"><code>boundingBox</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="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>
</p>
</div>
<div class="description">
<p>The outermost DOM node for the Widget, used for sizing and positioning
of a Widget as well as a containing element for any decorator elements used
for skinning.</p>
</div>
<div class="emits box">
<h4>Fires event <code>boundingBoxChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>boundingBox</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_buttons" class="attr item inherited">
<a name="config_buttons"></a>
<h3 class="name"><code>buttons</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/WidgetButtons.html#attr_buttons">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l55"><code>widget-buttons/js/widget-buttons.js:55</code></a>
</p>
<p>Available since 3.4.0</p>
</div>
<div class="description">
<p>Collection containing a widget's buttons.</p>
<p>The collection is an Object which contains an Array of <code>Y.Node</code>s for every
<code>WidgetStdMod</code> section (header, body, footer) which has one or more buttons.
All button nodes have the <code>Y.Plugin.Button</code> plugin applied.</p>
<p>This attribute is very flexible in the values it will accept. <code>buttons</code> can
be specified as a single Array, or an Object of Arrays keyed to a particular
section.</p>
<p>All specified values will be normalized to this type of structure:</p>
<pre class="code prettyprint"><code>{
header: [...],
footer: [...]
}
</code></pre>
<p>A button can be specified as a <code>Y.Node</code>, config Object, or String name for a
predefined button on the <code>BUTTONS</code> prototype property. When a config Object
is provided, it will be merged with any defaults provided by a button with
the same <code>name</code> defined on the <code>BUTTONS</code> property.</p>
<p>See <code>addButton()</code> for the detailed list of configuration properties.</p>
<p>For convenience, a widget's buttons will always persist and remain rendered
after header/body/footer content updates. Buttons should be removed by
updating this attribute or using the <code>removeButton()</code> method.</p>
</div>
<p><strong>Default:</strong> {}</p>
<div class="emits box">
<h4>Fires event <code>buttonsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>buttons</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 class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>{
// Uses predefined "close" button by string name.
header: ['close'],
footer: [
{
name : 'cancel',
label : 'Cancel',
action: 'hide'
},
{
name : 'okay',
label : 'Okay',
isDefault: true,
events: {
click: function (e) {
this.hide();
}
}
}
]
}
</code></pre>
</div>
</div>
</div>
<div id="attr_centered" class="attr item inherited">
<a name="config_centered"></a>
<h3 class="name"><code>centered</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionAlign.html#attr_centered">WidgetPositionAlign</a>:
<a href="../files/widget-position-align_js_Widget-PositionAlign.js.html#l79"><code>widget-position-align/js/Widget-PositionAlign.js:79</code></a>
</p>
</div>
<div class="description">
<p>A convenience Attribute, which can be used as a shortcut for the <code>align</code>
Attribute.</p>
<p>If set to <code>true</code>, the widget is centered in the viewport. If set to a <code>Node</code>
reference or valid selector String, the widget will be centered within the
<code>Node</code>. If set to <code>false</code>, no center positioning is applied.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>centeredChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>centered</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_constrain" class="attr item inherited">
<a name="config_constrain"></a>
<h3 class="name"><code>constrain</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPositionConstrain.html#attr_constrain">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l56"><code>widget-position-constrain/js/Widget-PositionConstrain.js:56</code></a>
</p>
</div>
<div class="description">
<p>The node to constrain the widget's bounding box to, when setting xy. Can also be
set to true, to constrain to the viewport.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>constrainChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>constrain</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_contentBox" class="attr item inherited">
<a name="config_contentBox"></a>
<h3 class="name"><code>contentBox</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="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_contentBox">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>
</p>
</div>
<div class="description">
<p>A DOM node that is a direct descendant of a Widget's bounding box that
houses its content.</p>
</div>
<div class="emits box">
<h4>Fires event <code>contentBoxChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>contentBox</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_defaultButton" class="attr item inherited">
<a name="config_defaultButton"></a>
<h3 class="name"><code>defaultButton</code></h3>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
<span class="flag readonly">readonly</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetButtons.html#attr_defaultButton">WidgetButtons</a>:
<a href="../files/widget-buttons_js_widget-buttons.js.html#l121"><code>widget-buttons/js/widget-buttons.js:121</code></a>
</p>
<p>Available since 3.5.0</p>
</div>
<div class="description">
<p>The current default button as configured through this widget's <code>buttons</code>.</p>
<p>A button can be configured as the default button in the following ways:</p>
<ul>
<li><p>As a config Object with an <code>isDefault</code> property:
<code>{label: 'Okay', isDefault: true}</code>.</p></li>
<li><p>As a Node with a <code>data-default</code> attribute:
<code><button data-default="true">Okay</button></code>.</p></li>
</ul>
<p>This attribute is <strong>read-only</strong>; anytime there are changes to this widget's
<code>buttons</code>, the <code>defaultButton</code> will be updated if needed.</p>
<p><strong>Note:</strong> If two or more buttons are configured to be the default button,
the last one wins.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>defaultButtonChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>defaultButton</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_disabled" class="attr item inherited">
<a name="config_disabled"></a>
<h3 class="name"><code>disabled</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/Widget.html#attr_disabled">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating if the Widget should be disabled. The disabled implementation
is left to the specific classes extending widget.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>disabledChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>disabled</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_fillHeight" class="attr item inherited">
<a name="config_fillHeight"></a>
<h3 class="name"><code>fillHeight</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/WidgetStdMod.html#attr_fillHeight">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l182"><code>widget-stdmod/js/Widget-StdMod.js:182</code></a>
</p>
</div>
<div class="description">
<p>The section (WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER) which should be resized to fill the height of the standard module, when a
height is set on the Widget. If a height is not set on the widget, then all sections are sized based on
their content.</p>
</div>
<p><strong>Default:</strong> WidgetStdMod.BODY</p>
<div class="emits box">
<h4>Fires event <code>fillHeightChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>fillHeight</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_focused" class="attr item inherited">
<a name="config_focused"></a>
<h3 class="name"><code>focused</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/Widget.html#attr_focused">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating if the Widget, or one of its descendants,
has focus.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>focusedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>focused</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_focusOn" class="attr item inherited">
<a name="config_focusOn"></a>
<h3 class="name"><code>focusOn</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#attr_focusOn">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l96"><code>widget-modality/js/Widget-Modality.js:96</code></a>
</p>
</div>
<div class="description">
<p>An array of objects corresponding to the nodes and events that will trigger a re-focus back on the widget.
The implementer can supply an array of objects, with each object having the following properties:</p>
<p>eventName: (string, required): The eventName to listen to.</p>
<p>node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)</p>
<p>By default, this attribute consists of two objects which will cause the widget to re-focus if anything
outside the widget is clicked on or focussed upon.</p>
</div>
<div class="emits box">
<h4>Fires event <code>focusOnChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>focusOn</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_footerContent" class="attr item inherited">
<a name="config_footerContent"></a>
<h3 class="name"><code>footerContent</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#attr_footerContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l160"><code>widget-stdmod/js/Widget-StdMod.js:160</code></a>
</p>
</div>
<div class="description">
<p>The content to be added to the footer section. This will replace any existing content
in the footer. If you want to append, or insert new content, use the <a href="#method_setStdModContent">setStdModContent</a> method.</p>
</div>
<p><strong>Default:</strong> undefined</p>
<div class="emits box">
<h4>Fires event <code>footerContentChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>footerContent</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_headerContent" class="attr item inherited">
<a name="config_headerContent"></a>
<h3 class="name"><code>headerContent</code></h3>
<span class="type">HTML</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStdMod.html#attr_headerContent">WidgetStdMod</a>:
<a href="../files/widget-stdmod_js_Widget-StdMod.js.html#l149"><code>widget-stdmod/js/Widget-StdMod.js:149</code></a>
</p>
</div>
<div class="description">
<p>The content to be added to the header section. This will replace any existing content
in the header. If you want to append, or insert new content, use the <a href="#method_setStdModContent">setStdModContent</a> method.</p>
</div>
<p><strong>Default:</strong> undefined</p>
<div class="emits box">
<h4>Fires event <code>headerContentChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>headerContent</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_height" class="attr item inherited">
<a name="config_height"></a>
<h3 class="name"><code>height</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="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_height">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>
</p>
</div>
<div class="description">
<p>String with units, or number, representing the height of the Widget. If a number is provided,
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
</div>
<p><strong>Default:</strong> EMPTY_STR</p>
<div class="emits box">
<h4>Fires event <code>heightChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>height</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_hideOn" class="attr item inherited">
<a name="config_hideOn"></a>
<h3 class="name"><code>hideOn</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetAutohide.html#attr_hideOn">WidgetAutohide</a>:
<a href="../files/widget-autohide_js_Widget-Autohide.js.html#l57"><code>widget-autohide/js/Widget-Autohide.js:57</code></a>
</p>
</div>
<div class="description">
<p>An array of objects corresponding to the nodes, events, and keycodes to hide the widget on.
The implementer can supply an array of objects, with each object having the following properties:</p>
<p>eventName: (string, required): The eventName to listen to.</p>
<p>node: (Y.Node, optional): The Y.Node that will fire the event (defaults to the boundingBox of the widget)</p>
<p>keyCode: (string, optional): If listening for key events, specify the keyCode</p>
<p>By default, this attribute consists of one object which will cause the widget to hide if the
escape key is pressed.</p>
</div>
<div class="emits box">
<h4>Fires event <code>hideOnChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>hideOn</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_id" class="attr item inherited">
<a name="config_id"></a>
<h3 class="name"><code>id</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/Widget.html#attr_id">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>
</p>
</div>
<div class="description">
</div>
<p><strong>Default:</strong> Generated using guid()</p>
<div class="emits box">
<h4>Fires event <code>idChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>id</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_locale" class="attr item deprecated inherited">
<a name="config_locale"></a>
<h3 class="name"><code>locale</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 Y.config.lang and Y.Intl externalization support">deprecated</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_locale">Widget</a>:
<a href="../files/widget_js_WidgetLocale.js.html#l17"><code>widget/js/WidgetLocale.js:17</code></a>
</p>
<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>
</div>
<div class="description">
<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will
return/set strings for this locale.</p>
</div>
<p><strong>Default:</strong> "en"</p>
<div class="emits box">
<h4>Fires event <code>localeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>locale</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_maskNode" class="attr item inherited">
<a name="config_maskNode"></a>
<h3 class="name"><code>maskNode</code></h3>
<span class="type">Y.Node</span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetModality.html#attr_maskNode">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l73"><code>widget-modality/js/Widget-Modality.js:73</code></a>
</p>
</div>
<div class="description">
<p>Returns a Y.Node instance of the node being used as the mask.</p>
</div>
<div class="emits box">
<h4>Fires event <code>maskNodeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>maskNode</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_modal" class="attr item inherited">
<a name="config_modal"></a>
<h3 class="name"><code>modal</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/WidgetModality.html#attr_modal">WidgetModality</a>:
<a href="../files/widget-modality_js_Widget-Modality.js.html#l85"><code>widget-modality/js/Widget-Modality.js:85</code></a>
</p>
</div>
<div class="description">
<p>Whether the widget should be modal or not.</p>
</div>
<div class="emits box">
<h4>Fires event <code>modalChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>modal</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_preventOverlap" class="attr item inherited">
<a name="config_preventOverlap"></a>
<h3 class="name"><code>preventOverlap</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/WidgetPositionConstrain.html#attr_preventOverlap">WidgetPositionConstrain</a>:
<a href="../files/widget-position-constrain_js_Widget-PositionConstrain.js.html#l68"><code>widget-position-constrain/js/Widget-PositionConstrain.js:68</code></a>
</p>
</div>
<div class="description">
<p>If set to true, and WidgetPositionAlign is also added to the Widget,
constrained positioning will attempt to prevent the widget's bounding box from overlapping
the element to which it has been aligned, by flipping the orientation of the alignment
for corner based alignments</p>
</div>
<div class="emits box">
<h4>Fires event <code>preventOverlapChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>preventOverlap</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_render" class="attr item inherited">
<a name="config_render"></a>
<h3 class="name"><code>render</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>
</p>
</div>
<div class="description">
<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>
</div>
<div class="emits box">
<h4>Fires event <code>renderChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>render</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_rendered" class="attr item inherited">
<a name="config_rendered"></a>
<h3 class="name"><code>rendered</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/Widget.html#attr_rendered">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>
</p>
</div>
<div class="description">
<p>Flag indicating whether or not this Widget
has been through the render lifecycle phase.</p>
</div>
<p><strong>Default:</strong> false</p>
<div class="emits box">
<h4>Fires event <code>renderedChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>rendered</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_shim" class="attr item inherited">
<a name="config_shim"></a>
<h3 class="name"><code>shim</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/WidgetStack.html#attr_shim">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l74"><code>widget-stack/js/Widget-Stack.js:74</code></a>
</p>
</div>
<div class="description">
<p>Boolean flag to indicate whether or not a shim should be added to the Widgets
boundingBox, to protect it from select box bleedthrough.</p>
</div>
<p><strong>Default:</strong> false, for all browsers other than IE6, for which a shim is enabled by default.</p>
<div class="emits box">
<h4>Fires event <code>shimChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>shim</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_srcNode" class="attr item inherited">
<a name="config_srcNode"></a>
<h3 class="name"><code>srcNode</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="../classes/Node.html" class="crosslink">Node</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_srcNode">Widget</a>:
<a href="../files/widget_js_WidgetHTMLParser.js.html#l58"><code>widget/js/WidgetHTMLParser.js:58</code></a>
</p>
</div>
<div class="description">
<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>
</div>
<div class="emits box">
<h4>Fires event <code>srcNodeChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>srcNode</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_strings" class="attr item inherited">
<a name="config_strings"></a>
<h3 class="name"><code>strings</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/Widget.html#attr_strings">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l274"><code>widget/js/Widget.js:274</code></a>
</p>
</div>
<div class="description">
<p>Collection of strings used to label elements of the Widget's UI.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>stringsChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>strings</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_tabIndex" class="attr item inherited">
<a name="config_tabIndex"></a>
<h3 class="name"><code>tabIndex</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>
</p>
</div>
<div class="description">
<p>Number (between -32767 to 32767) indicating the widget's
position in the default tab flow. The value is used to set the
"tabIndex" attribute on the widget's bounding box. Negative values allow
the widget to receive DOM focus programmatically (by calling the focus
method), while being removed from the default tab flow. A value of
null removes the "tabIndex" attribute from the widget's bounding box.</p>
</div>
<p><strong>Default:</strong> null</p>
<div class="emits box">
<h4>Fires event <code>tabIndexChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>tabIndex</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_visible" class="attr item inherited">
<a name="config_visible"></a>
<h3 class="name"><code>visible</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/Widget.html#attr_visible">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>
</p>
</div>
<div class="description">
<p>Boolean indicating whether or not the Widget is visible.</p>
</div>
<p><strong>Default:</strong> TRUE</p>
<div class="emits box">
<h4>Fires event <code>visibleChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>visible</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_width" class="attr item inherited">
<a name="config_width"></a>
<h3 class="name"><code>width</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="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#attr_width">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>
</p>
</div>
<div class="description">
<p>String with units, or number, representing the width of the Widget. If a number is provided,
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
</div>
<p><strong>Default:</strong> EMPTY_STR</p>
<div class="emits box">
<h4>Fires event <code>widthChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>width</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_x" class="attr item inherited">
<a name="config_x"></a>
<h3 class="name"><code>x</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#attr_x">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l50"><code>widget-position/js/Widget-Position.js:50</code></a>
</p>
</div>
<div class="description">
<p>Page X co-ordinate for the widget. This attribute acts as a facade for the
xy attribute. Changes in position can be monitored by listening for xyChange events.</p>
</div>
<p><strong>Default:</strong> 0</p>
<div class="emits box">
<h4>Fires event <code>xChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>x</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_xy" class="attr item inherited">
<a name="config_xy"></a>
<h3 class="name"><code>xy</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>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#attr_xy">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l86"><code>widget-position/js/Widget-Position.js:86</code></a>
</p>
</div>
<div class="description">
<p>Page XY co-ordinate pair for the widget.</p>
</div>
<p><strong>Default:</strong> [0,0]</p>
<div class="emits box">
<h4>Fires event <code>xyChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>xy</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_y" class="attr item inherited">
<a name="config_y"></a>
<h3 class="name"><code>y</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetPosition.html#attr_y">WidgetPosition</a>:
<a href="../files/widget-position_js_Widget-Position.js.html#l68"><code>widget-position/js/Widget-Position.js:68</code></a>
</p>
</div>
<div class="description">
<p>Page Y co-ordinate for the widget. This attribute acts as a facade for the
xy attribute. Changes in position can be monitored by listening for xyChange events.</p>
</div>
<p><strong>Default:</strong> 0</p>
<div class="emits box">
<h4>Fires event <code>yChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>y</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_zIndex" class="attr item inherited">
<a name="config_zIndex"></a>
<h3 class="name"><code>zIndex</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="meta">
<p>Inherited from
<a href="../classes/WidgetStack.html#attr_zIndex">WidgetStack</a>:
<a href="../files/widget-stack_js_Widget-Stack.js.html#l86"><code>widget-stack/js/Widget-Stack.js:86</code></a>
</p>
</div>
<div class="description">
<p>The z-index to apply to the Widgets boundingBox. Non-numerical values for
zIndex will be converted to 0</p>
</div>
<p><strong>Default:</strong> 0</p>
<div class="emits box">
<h4>Fires event <code>zIndexChange</code></h4>
<p>
Fires when the value for the configuration attribute <code>zIndex</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_render" class="events item inherited">
<h3 class="name"><code>render</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#event_render">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l543"><code>widget/js/Widget.js:543</code></a>
</p>
</div>
<div class="description">
<p>Lifecycle event for the render phase, fired prior to rendering the UI
for the widget (prior to invoking the widget's renderer method).</p>
<p>
Subscribers to the "on" moment of this event, will be notified
before the widget is rendered.
</p>
<p>
Subscribers to the "after" moment of this event, will be notified
after rendering is complete.
</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>The Event Facade</p>
</div>
</li>
</ul>
</div>
</div>
<div id="event_widget:contentUpdate" class="events item inherited">
<h3 class="name"><code>widget:contentUpdate</code></h3>
<span class="type"></span>
<div class="meta">
<p>Inherited from
<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:
<a href="../files/widget_js_Widget.js.html#l397"><code>widget/js/Widget.js:397</code></a>
</p>
</div>
<div class="description">
<p>Notification event, which widget implementations can fire, when
they change the content of the widget. This event has no default
behavior and cannot be prevented, so the "on" or "after"
moments are effectively equivalent (with on listeners being invoked before
after listeners).</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>The Event Facade</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>