5
<title>DataTable.Base - YUI 3</title>
6
<link rel="stylesheet" href="http://yui.yahooapis.com/3.5.0/build/cssgrids/cssgrids-min.css">
7
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
8
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
9
<script src="http://yui.yahooapis.com/3.5.0/build/yui/yui-min.js"></script>
11
<body class="yui3-skin-sam">
14
<div id="hd" class="yui3-g header">
15
<div class="yui3-u-3-4">
17
<h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
20
<div class="yui3-u-1-4 version">
21
<em>API Docs for: 3.5.1</em>
24
<div id="bd" class="yui3-g">
26
<div class="yui3-u-1-4">
27
<div id="docs-sidebar" class="sidebar apidocs">
29
<h2 class="off-left">APIs</h2>
30
<div id="api-tabview" class="tabview">
32
<li><a href="#api-classes">Classes</a></li>
33
<li><a href="#api-modules">Modules</a></li>
36
<div id="api-tabview-filter">
37
<input type="search" id="api-filter" placeholder="Type to filter APIs">
40
<div id="api-tabview-panel">
41
<ul id="api-classes" class="apis classes">
43
<li><a href="../classes/Anim.html">Anim</a></li>
45
<li><a href="../classes/App.html">App</a></li>
47
<li><a href="../classes/App.Base.html">App.Base</a></li>
49
<li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
51
<li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
53
<li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
55
<li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
57
<li><a href="../classes/Array.html">Array</a></li>
59
<li><a href="../classes/ArrayList.html">ArrayList</a></li>
61
<li><a href="../classes/ArraySort.html">ArraySort</a></li>
63
<li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
65
<li><a href="../classes/Attribute.html">Attribute</a></li>
67
<li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
69
<li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
71
<li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
73
<li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
75
<li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
77
<li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
79
<li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
81
<li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
83
<li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
85
<li><a href="../classes/Axis.html">Axis</a></li>
87
<li><a href="../classes/AxisType.html">AxisType</a></li>
89
<li><a href="../classes/BarSeries.html">BarSeries</a></li>
91
<li><a href="../classes/Base.html">Base</a></li>
93
<li><a href="../classes/BaseCore.html">BaseCore</a></li>
95
<li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
97
<li><a href="../classes/Button.html">Button</a></li>
99
<li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
101
<li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
103
<li><a href="../classes/ButtonPlugin.html">ButtonPlugin</a></li>
105
<li><a href="../classes/Cache.html">Cache</a></li>
107
<li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
109
<li><a href="../classes/Calendar.html">Calendar</a></li>
111
<li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
113
<li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
115
<li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
117
<li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
119
<li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
121
<li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
123
<li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
125
<li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
127
<li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
129
<li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
131
<li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
133
<li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
135
<li><a href="../classes/Chart.html">Chart</a></li>
137
<li><a href="../classes/ChartBase.html">ChartBase</a></li>
139
<li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
141
<li><a href="../classes/Circle.html">Circle</a></li>
143
<li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
145
<li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
147
<li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
149
<li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
151
<li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
153
<li><a href="../classes/config.html">config</a></li>
155
<li><a href="../classes/Console.html">Console</a></li>
157
<li><a href="../classes/Controller.html">Controller</a></li>
159
<li><a href="../classes/Cookie.html">Cookie</a></li>
161
<li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
163
<li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
165
<li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
167
<li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
169
<li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
171
<li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
173
<li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
175
<li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
177
<li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
179
<li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
181
<li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
183
<li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
185
<li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
187
<li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
189
<li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
191
<li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
193
<li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
195
<li><a href="../classes/DataTable.html">DataTable</a></li>
197
<li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
199
<li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
201
<li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
203
<li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
205
<li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
207
<li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
209
<li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
211
<li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
213
<li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
215
<li><a href="../classes/DataType.Date.html">DataType.Date</a></li>
217
<li><a href="../classes/DataType.Date.Locale.html">DataType.Date.Locale</a></li>
219
<li><a href="../classes/DataType.Number.html">DataType.Number</a></li>
221
<li><a href="../classes/DataType.XML.html">DataType.XML</a></li>
223
<li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
225
<li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
227
<li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
229
<li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
231
<li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
233
<li><a href="../classes/Dial.html">Dial</a></li>
235
<li><a href="../classes/Do.html">Do</a></li>
237
<li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
239
<li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
241
<li><a href="../classes/Do.Error.html">Do.Error</a></li>
243
<li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
245
<li><a href="../classes/Do.Method.html">Do.Method</a></li>
247
<li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
249
<li><a href="../classes/DOM.html">DOM</a></li>
251
<li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
253
<li><a href="../classes/Drawing.html">Drawing</a></li>
255
<li><a href="../classes/Easing.html">Easing</a></li>
257
<li><a href="../classes/EditorBase.html">EditorBase</a></li>
259
<li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
261
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
263
<li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
265
<li><a href="../classes/Escape.html">Escape</a></li>
267
<li><a href="../classes/Event.html">Event</a></li>
269
<li><a href="../classes/EventFacade.html">EventFacade</a></li>
271
<li><a href="../classes/EventHandle.html">EventHandle</a></li>
273
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
275
<li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
277
<li><a href="../classes/Features.html">Features</a></li>
279
<li><a href="../classes/File.html">File</a></li>
281
<li><a href="../classes/FileFlash.html">FileFlash</a></li>
283
<li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
285
<li><a href="../classes/Fills.html">Fills</a></li>
287
<li><a href="../classes/Frame.html">Frame</a></li>
289
<li><a href="../classes/Get.html">Get</a></li>
291
<li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
293
<li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
295
<li><a href="../classes/Graph.html">Graph</a></li>
297
<li><a href="../classes/Graphic.html">Graphic</a></li>
299
<li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
301
<li><a href="../classes/Gridlines.html">Gridlines</a></li>
303
<li><a href="../classes/GroupCircle.html">GroupCircle</a></li>
305
<li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
307
<li><a href="../classes/GroupRect.html">GroupRect</a></li>
309
<li><a href="../classes/Handlebars.html">Handlebars</a></li>
311
<li><a href="../classes/Highlight.html">Highlight</a></li>
313
<li><a href="../classes/Histogram.html">Histogram</a></li>
315
<li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
317
<li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
319
<li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
321
<li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
323
<li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
325
<li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
327
<li><a href="../classes/Intl.html">Intl</a></li>
329
<li><a href="../classes/IO.html">IO</a></li>
331
<li><a href="../classes/JSON.html">JSON</a></li>
333
<li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
335
<li><a href="../classes/Lang.html">Lang</a></li>
337
<li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
339
<li><a href="../classes/Lines.html">Lines</a></li>
341
<li><a href="../classes/LineSeries.html">LineSeries</a></li>
343
<li><a href="../classes/Loader.html">Loader</a></li>
345
<li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
347
<li><a href="../classes/Matrix.html">Matrix</a></li>
349
<li><a href="../classes/Model.html">Model</a></li>
351
<li><a href="../classes/ModelList.html">ModelList</a></li>
353
<li><a href="../classes/Node.html">Node</a></li>
355
<li><a href="../classes/NodeList.html">NodeList</a></li>
357
<li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
359
<li><a href="../classes/Object.html">Object</a></li>
361
<li><a href="../classes/Overlay.html">Overlay</a></li>
363
<li><a href="../classes/Panel.html">Panel</a></li>
365
<li><a href="../classes/Parallel.html">Parallel</a></li>
367
<li><a href="../classes/Path.html">Path</a></li>
369
<li><a href="../classes/PieChart.html">PieChart</a></li>
371
<li><a href="../classes/PieSeries.html">PieSeries</a></li>
373
<li><a href="../classes/Pjax.html">Pjax</a></li>
375
<li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
377
<li><a href="../classes/Plots.html">Plots</a></li>
379
<li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
381
<li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
383
<li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
385
<li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
387
<li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
389
<li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
391
<li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
393
<li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
395
<li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
397
<li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
399
<li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
401
<li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
403
<li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
405
<li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
407
<li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
409
<li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
411
<li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
413
<li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
415
<li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
417
<li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
419
<li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
421
<li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
423
<li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
425
<li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
427
<li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
429
<li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
431
<li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
433
<li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
435
<li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
437
<li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
439
<li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
441
<li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
443
<li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
445
<li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
447
<li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
449
<li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
451
<li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
453
<li><a href="../classes/Pollable.html">Pollable</a></li>
455
<li><a href="../classes/Profiler.html">Profiler</a></li>
457
<li><a href="../classes/QueryString.html">QueryString</a></li>
459
<li><a href="../classes/Queue.html">Queue</a></li>
461
<li><a href="../classes/Record.html">Record</a></li>
463
<li><a href="../classes/Recordset.html">Recordset</a></li>
465
<li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
467
<li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
469
<li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
471
<li><a href="../classes/Rect.html">Rect</a></li>
473
<li><a href="../classes/Renderer.html">Renderer</a></li>
475
<li><a href="../classes/Resize.html">Resize</a></li>
477
<li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
479
<li><a href="../classes/Router.html">Router</a></li>
481
<li><a href="../classes/ScrollView.html">ScrollView</a></li>
483
<li><a href="../classes/Selector.html">Selector</a></li>
485
<li><a href="../classes/Shape.html">Shape</a></li>
487
<li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
489
<li><a href="../classes/Slider.html">Slider</a></li>
491
<li><a href="../classes/SliderBase.html">SliderBase</a></li>
493
<li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
495
<li><a href="../classes/Sortable.html">Sortable</a></li>
497
<li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
499
<li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
501
<li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
503
<li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
505
<li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
507
<li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
509
<li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
511
<li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
513
<li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
515
<li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
517
<li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
519
<li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
521
<li><a href="../classes/State.html">State</a></li>
523
<li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
525
<li><a href="../classes/Subscriber.html">Subscriber</a></li>
527
<li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
529
<li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
531
<li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
533
<li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
535
<li><a href="../classes/SVGPath.html">SVGPath</a></li>
537
<li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
539
<li><a href="../classes/SVGRect.html">SVGRect</a></li>
541
<li><a href="../classes/SVGShape.html">SVGShape</a></li>
543
<li><a href="../classes/SWF.html">SWF</a></li>
545
<li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
547
<li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
549
<li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
551
<li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
553
<li><a href="../classes/Tab.html">Tab</a></li>
555
<li><a href="../classes/TabView.html">TabView</a></li>
557
<li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
559
<li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
561
<li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
563
<li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
565
<li><a href="../classes/Test.Console.html">Test.Console</a></li>
567
<li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
569
<li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
571
<li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
573
<li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
575
<li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
577
<li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
579
<li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
581
<li><a href="../classes/Test.Results.html">Test.Results</a></li>
583
<li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
585
<li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
587
<li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
589
<li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
591
<li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
593
<li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
595
<li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
597
<li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
599
<li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
601
<li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
603
<li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
605
<li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
607
<li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
609
<li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
611
<li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
613
<li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
615
<li><a href="../classes/Transition.html">Transition</a></li>
617
<li><a href="../classes/UA.html">UA</a></li>
619
<li><a href="../classes/Uploader.html">Uploader</a></li>
621
<li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
623
<li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
625
<li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
627
<li><a href="../classes/ValueChange.html">ValueChange</a></li>
629
<li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
631
<li><a href="../classes/View.html">View</a></li>
633
<li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
635
<li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
637
<li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
639
<li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
641
<li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
643
<li><a href="../classes/VMLPath.html">VMLPath</a></li>
645
<li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
647
<li><a href="../classes/VMLRect.html">VMLRect</a></li>
649
<li><a href="../classes/VMLShape.html">VMLShape</a></li>
651
<li><a href="../classes/Widget.html">Widget</a></li>
653
<li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
655
<li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
657
<li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
659
<li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
661
<li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
663
<li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
665
<li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
667
<li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
669
<li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
671
<li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
673
<li><a href="../classes/YQL.html">YQL</a></li>
675
<li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
677
<li><a href="../classes/YUI.html">YUI</a></li>
679
<li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
683
<ul id="api-modules" class="apis modules">
685
<li><a href="../modules/align-plugin.html">align-plugin</a></li>
687
<li><a href="../modules/anim.html">anim</a></li>
689
<li><a href="../modules/anim-base.html">anim-base</a></li>
691
<li><a href="../modules/anim-color.html">anim-color</a></li>
693
<li><a href="../modules/anim-curve.html">anim-curve</a></li>
695
<li><a href="../modules/anim-easing.html">anim-easing</a></li>
697
<li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
699
<li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
701
<li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
703
<li><a href="../modules/anim-xy.html">anim-xy</a></li>
705
<li><a href="../modules/app.html">app</a></li>
707
<li><a href="../modules/app-base.html">app-base</a></li>
709
<li><a href="../modules/app-transitions.html">app-transitions</a></li>
711
<li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
713
<li><a href="../modules/array-extras.html">array-extras</a></li>
715
<li><a href="../modules/array-invoke.html">array-invoke</a></li>
717
<li><a href="../modules/arraylist.html">arraylist</a></li>
719
<li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
721
<li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
723
<li><a href="../modules/arraysort.html">arraysort</a></li>
725
<li><a href="../modules/async-queue.html">async-queue</a></li>
727
<li><a href="../modules/attribute.html">attribute</a></li>
729
<li><a href="../modules/attribute-base.html">attribute-base</a></li>
731
<li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
733
<li><a href="../modules/attribute-core.html">attribute-core</a></li>
735
<li><a href="../modules/attribute-events.html">attribute-events</a></li>
737
<li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
739
<li><a href="../modules/autocomplete.html">autocomplete</a></li>
741
<li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
743
<li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
745
<li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
747
<li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
749
<li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
751
<li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
753
<li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
755
<li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
757
<li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
759
<li><a href="../modules/base.html">base</a></li>
761
<li><a href="../modules/base-base.html">base-base</a></li>
763
<li><a href="../modules/base-build.html">base-build</a></li>
765
<li><a href="../modules/base-core.html">base-core</a></li>
767
<li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
769
<li><a href="../modules/button.html">button</a></li>
771
<li><a href="../modules/button-core.html">button-core</a></li>
773
<li><a href="../modules/button-group.html">button-group</a></li>
775
<li><a href="../modules/button-plugin.html">button-plugin</a></li>
777
<li><a href="../modules/cache.html">cache</a></li>
779
<li><a href="../modules/cache-base.html">cache-base</a></li>
781
<li><a href="../modules/cache-offline.html">cache-offline</a></li>
783
<li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
785
<li><a href="../modules/calendar.html">calendar</a></li>
787
<li><a href="../modules/calendar-base.html">calendar-base</a></li>
789
<li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
791
<li><a href="../modules/charts.html">charts</a></li>
793
<li><a href="../modules/charts-legend.html">charts-legend</a></li>
795
<li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
797
<li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
799
<li><a href="../modules/collection.html">collection</a></li>
801
<li><a href="../modules/console.html">console</a></li>
803
<li><a href="../modules/console-filters.html">console-filters</a></li>
805
<li><a href="../modules/cookie.html">cookie</a></li>
807
<li><a href="../modules/createlink-base.html">createlink-base</a></li>
809
<li><a href="../modules/dataschema.html">dataschema</a></li>
811
<li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
813
<li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
815
<li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
817
<li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
819
<li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
821
<li><a href="../modules/datasource.html">datasource</a></li>
823
<li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
825
<li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
827
<li><a href="../modules/datasource-function.html">datasource-function</a></li>
829
<li><a href="../modules/datasource-get.html">datasource-get</a></li>
831
<li><a href="../modules/datasource-io.html">datasource-io</a></li>
833
<li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
835
<li><a href="../modules/datasource-local.html">datasource-local</a></li>
837
<li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
839
<li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
841
<li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
843
<li><a href="../modules/datatable.html">datatable</a></li>
845
<li><a href="../modules/datatable-base.html">datatable-base</a></li>
847
<li><a href="../modules/datatable-base-deprecated.html">datatable-base-deprecated</a></li>
849
<li><a href="../modules/datatable-body.html">datatable-body</a></li>
851
<li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
853
<li><a href="../modules/datatable-core.html">datatable-core</a></li>
855
<li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
857
<li><a href="../modules/datatable-datasource-deprecated.html">datatable-datasource-deprecated</a></li>
859
<li><a href="../modules/datatable-deprecated.html">datatable-deprecated</a></li>
861
<li><a href="../modules/datatable-head.html">datatable-head</a></li>
863
<li><a href="../modules/datatable-message.html">datatable-message</a></li>
865
<li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
867
<li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
869
<li><a href="../modules/datatable-scroll-deprecated.html">datatable-scroll-deprecated</a></li>
871
<li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
873
<li><a href="../modules/datatable-sort-deprecated.html">datatable-sort-deprecated</a></li>
875
<li><a href="../modules/datatype.html">datatype</a></li>
877
<li><a href="../modules/datatype-date.html">datatype-date</a></li>
879
<li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
881
<li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
883
<li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
885
<li><a href="../modules/datatype-number.html">datatype-number</a></li>
887
<li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
889
<li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
891
<li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
893
<li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
895
<li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
897
<li><a href="../modules/dd.html">dd</a></li>
899
<li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
901
<li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
903
<li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
905
<li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
907
<li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
909
<li><a href="../modules/dd-drag.html">dd-drag</a></li>
911
<li><a href="../modules/dd-drop.html">dd-drop</a></li>
913
<li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
915
<li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
917
<li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
919
<li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
921
<li><a href="../modules/dial.html">dial</a></li>
923
<li><a href="../modules/dom.html">dom</a></li>
925
<li><a href="../modules/dom-base.html">dom-base</a></li>
927
<li><a href="../modules/dom-screen.html">dom-screen</a></li>
929
<li><a href="../modules/dom-style.html">dom-style</a></li>
931
<li><a href="../modules/dump.html">dump</a></li>
933
<li><a href="../modules/editor.html">editor</a></li>
935
<li><a href="../modules/editor-base.html">editor-base</a></li>
937
<li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
939
<li><a href="../modules/editor-br.html">editor-br</a></li>
941
<li><a href="../modules/editor-lists.html">editor-lists</a></li>
943
<li><a href="../modules/editor-para.html">editor-para</a></li>
945
<li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
947
<li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
949
<li><a href="../modules/editor-tab.html">editor-tab</a></li>
951
<li><a href="../modules/escape.html">escape</a></li>
953
<li><a href="../modules/event.html">event</a></li>
955
<li><a href="../modules/event-base.html">event-base</a></li>
957
<li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
959
<li><a href="../modules/event-custom.html">event-custom</a></li>
961
<li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
963
<li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
965
<li><a href="../modules/event-delegate.html">event-delegate</a></li>
967
<li><a href="../modules/event-flick.html">event-flick</a></li>
969
<li><a href="../modules/event-focus.html">event-focus</a></li>
971
<li><a href="../modules/event-gestures.html">event-gestures</a></li>
973
<li><a href="../modules/event-hover.html">event-hover</a></li>
975
<li><a href="../modules/event-key.html">event-key</a></li>
977
<li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
979
<li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
981
<li><a href="../modules/event-move.html">event-move</a></li>
983
<li><a href="../modules/event-outside.html">event-outside</a></li>
985
<li><a href="../modules/event-resize.html">event-resize</a></li>
987
<li><a href="../modules/event-simulate.html">event-simulate</a></li>
989
<li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
991
<li><a href="../modules/event-touch.html">event-touch</a></li>
993
<li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
995
<li><a href="../modules/exec-command.html">exec-command</a></li>
997
<li><a href="../modules/features.html">features</a></li>
999
<li><a href="../modules/file.html">file</a></li>
1001
<li><a href="../modules/file-flash.html">file-flash</a></li>
1003
<li><a href="../modules/file-html5.html">file-html5</a></li>
1005
<li><a href="../modules/frame.html">frame</a></li>
1007
<li><a href="../modules/get.html">get</a></li>
1009
<li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
1011
<li><a href="../modules/graphics.html">graphics</a></li>
1013
<li><a href="../modules/handlebars.html">handlebars</a></li>
1015
<li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
1017
<li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
1019
<li><a href="../modules/highlight.html">highlight</a></li>
1021
<li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
1023
<li><a href="../modules/highlight-base.html">highlight-base</a></li>
1025
<li><a href="../modules/history.html">history</a></li>
1027
<li><a href="../modules/history-base.html">history-base</a></li>
1029
<li><a href="../modules/history-hash.html">history-hash</a></li>
1031
<li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
1033
<li><a href="../modules/history-html5.html">history-html5</a></li>
1035
<li><a href="../modules/imageloader.html">imageloader</a></li>
1037
<li><a href="../modules/intl.html">intl</a></li>
1039
<li><a href="../modules/io.html">io</a></li>
1041
<li><a href="../modules/io-base.html">io-base</a></li>
1043
<li><a href="../modules/io-form.html">io-form</a></li>
1045
<li><a href="../modules/io-queue.html">io-queue</a></li>
1047
<li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
1049
<li><a href="../modules/io-xdr.html">io-xdr</a></li>
1051
<li><a href="../modules/json.html">json</a></li>
1053
<li><a href="../modules/json-parse.html">json-parse</a></li>
1055
<li><a href="../modules/json-stringify.html">json-stringify</a></li>
1057
<li><a href="../modules/jsonp.html">jsonp</a></li>
1059
<li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
1061
<li><a href="../modules/loader.html">loader</a></li>
1063
<li><a href="../modules/loader-base.html">loader-base</a></li>
1065
<li><a href="../modules/matrix.html">matrix</a></li>
1067
<li><a href="../modules/model.html">model</a></li>
1069
<li><a href="../modules/model-list.html">model-list</a></li>
1071
<li><a href="../modules/node.html">node</a></li>
1073
<li><a href="../modules/node-base.html">node-base</a></li>
1075
<li><a href="../modules/node-core.html">node-core</a></li>
1077
<li><a href="../modules/node-data.html">node-data</a></li>
1079
<li><a href="../modules/node-deprecated.html">node-deprecated</a></li>
1081
<li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
1083
<li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
1085
<li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
1087
<li><a href="../modules/node-flick.html">node-flick</a></li>
1089
<li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
1091
<li><a href="../modules/node-load.html">node-load</a></li>
1093
<li><a href="../modules/node-menunav.html">node-menunav</a></li>
1095
<li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
1097
<li><a href="../modules/node-screen.html">node-screen</a></li>
1099
<li><a href="../modules/node-style.html">node-style</a></li>
1101
<li><a href="../modules/oop.html">oop</a></li>
1103
<li><a href="../modules/overlay.html">overlay</a></li>
1105
<li><a href="../modules/panel.html">panel</a></li>
1107
<li><a href="../modules/parallel.html">parallel</a></li>
1109
<li><a href="../modules/pjax.html">pjax</a></li>
1111
<li><a href="../modules/pjax-base.html">pjax-base</a></li>
1113
<li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
1115
<li><a href="../modules/plugin.html">plugin</a></li>
1117
<li><a href="../modules/pluginhost.html">pluginhost</a></li>
1119
<li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
1121
<li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
1123
<li><a href="../modules/profiler.html">profiler</a></li>
1125
<li><a href="../modules/querystring.html">querystring</a></li>
1127
<li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
1129
<li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
1131
<li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
1133
<li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
1135
<li><a href="../modules/queue-promote.html">queue-promote</a></li>
1137
<li><a href="../modules/range-slider.html">range-slider</a></li>
1139
<li><a href="../modules/recordset.html">recordset</a></li>
1141
<li><a href="../modules/recordset-base.html">recordset-base</a></li>
1143
<li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
1145
<li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
1147
<li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
1149
<li><a href="../modules/resize.html">resize</a></li>
1151
<li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
1153
<li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
1155
<li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
1157
<li><a href="../modules/rollup.html">rollup</a></li>
1159
<li><a href="../modules/router.html">router</a></li>
1161
<li><a href="../modules/scrollview.html">scrollview</a></li>
1163
<li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
1165
<li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
1167
<li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
1169
<li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
1171
<li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
1173
<li><a href="../modules/selection.html">selection</a></li>
1175
<li><a href="../modules/selector-css2.html">selector-css2</a></li>
1177
<li><a href="../modules/selector-css3.html">selector-css3</a></li>
1179
<li><a href="../modules/selector-native.html">selector-native</a></li>
1181
<li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
1183
<li><a href="../modules/slider.html">slider</a></li>
1185
<li><a href="../modules/slider-base.html">slider-base</a></li>
1187
<li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
1189
<li><a href="../modules/sortable.html">sortable</a></li>
1191
<li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
1193
<li><a href="../modules/stylesheet.html">stylesheet</a></li>
1195
<li><a href="../modules/substitute.html">substitute</a></li>
1197
<li><a href="../modules/swf.html">swf</a></li>
1199
<li><a href="../modules/swfdetect.html">swfdetect</a></li>
1201
<li><a href="../modules/tabview.html">tabview</a></li>
1203
<li><a href="../modules/test.html">test</a></li>
1205
<li><a href="../modules/test-console.html">test-console</a></li>
1207
<li><a href="../modules/text.html">text</a></li>
1209
<li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
1211
<li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
1213
<li><a href="../modules/transition.html">transition</a></li>
1215
<li><a href="../modules/uploader.html">uploader</a></li>
1217
<li><a href="../modules/uploader-deprecated.html">uploader-deprecated</a></li>
1219
<li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
1221
<li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
1223
<li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
1225
<li><a href="../modules/view.html">view</a></li>
1227
<li><a href="../modules/view-node-map.html">view-node-map</a></li>
1229
<li><a href="../modules/widget.html">widget</a></li>
1231
<li><a href="../modules/widget-anim.html">widget-anim</a></li>
1233
<li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
1235
<li><a href="../modules/widget-base.html">widget-base</a></li>
1237
<li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
1239
<li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
1241
<li><a href="../modules/widget-child.html">widget-child</a></li>
1243
<li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
1245
<li><a href="../modules/widget-locale.html">widget-locale</a></li>
1247
<li><a href="../modules/widget-modality.html">widget-modality</a></li>
1249
<li><a href="../modules/widget-parent.html">widget-parent</a></li>
1251
<li><a href="../modules/widget-position.html">widget-position</a></li>
1253
<li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
1255
<li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
1257
<li><a href="../modules/widget-skin.html">widget-skin</a></li>
1259
<li><a href="../modules/widget-stack.html">widget-stack</a></li>
1261
<li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
1263
<li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
1265
<li><a href="../modules/yql.html">yql</a></li>
1267
<li><a href="../modules/yui.html">yui</a></li>
1269
<li><a href="../modules/yui-base.html">yui-base</a></li>
1271
<li><a href="../modules/yui-later.html">yui-later</a></li>
1273
<li><a href="../modules/yui-log.html">yui-log</a></li>
1275
<li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
1277
<li><a href="../modules/yui3.html">yui3</a></li>
1286
<div class="yui3-u-3-4">
1287
<div id="api-options">
1289
<label for="api-show-inherited">
1290
<input type="checkbox" id="api-show-inherited" checked>
1294
<label for="api-show-protected">
1295
<input type="checkbox" id="api-show-protected">
1299
<label for="api-show-private">
1300
<input type="checkbox" id="api-show-private">
1306
<div class="apidocs">
1307
<div id="docs-main">
1308
<div class="content">
1309
<h1>DataTable.Base Class</h1>
1310
<div class="box meta">
1314
<ul class="inline commas">
1316
<li><a href="DataTable.Core.html">DataTable.Core</a></li>
1323
<div class="extends">
1324
Extends <a href="../classes/Widget.html" class="crosslink">Widget</a>
1329
<div class="foundat">
1330
Defined in: <a href="../files/datatable_js_base.js.html#l168"><code>datatable/js/base.js:168</code></a>
1336
Module: <a href="../modules/datatable-base.html">datatable-base</a><br>
1337
Parent Module: <a href="../modules/datatable.html">datatable</a>
1342
<p>Available since 3.5.0</p>
1348
<div class="box intro">
1349
<p>The baseline implementation of a DataTable. This class should be used
1350
primarily as a superclass for a custom DataTable with a specific set of
1351
features. Because features can be composed onto <code>Y.DataTable</code>, custom
1352
subclasses of DataTable.Base will remain unmodified when new feature modules
1355
<p>Example usage might look like this:</p>
1357
<pre class="code"><code class="prettyprint">
1358
// Custom subclass with only sorting and mutability added. If other datatable
1359
// feature modules are loaded, this class will not be affected.
1360
var MyTableClass = Y.Base.create('table', Y.DataTable.Base,
1361
[ Y.DataTable.Sort, Y.DataTable.Mutable ]);
1363
var table = new MyTableClass({
1364
columns: ['firstName', 'lastName', 'age'],
1366
{ firstName: 'Frank', lastName: 'Zappa', age: 71 },
1367
{ firstName: 'Frank', lastName: 'Lloyd Wright', age: 144 },
1368
{ firstName: 'Albert', lastName: 'Einstein', age: 132 },
1373
table.render('#over-there');
1375
// DataTable.Base can be instantiated if a featureless table is needed.
1376
var table = new Y.DataTable.Base({
1377
columns: ['firstName', 'lastName', 'age'],
1379
{ firstName: 'Frank', lastName: 'Zappa', age: 71 },
1380
{ firstName: 'Frank', lastName: 'Lloyd Wright', age: 144 },
1381
{ firstName: 'Albert', lastName: 'Einstein', age: 132 },
1386
table.render('#in-here');
1389
<p>DataTable.Base is built from DataTable.Core, and sets the default <code>headerView</code>
1390
to <code>Y.DataTable.HeaderView</code> and default <code>bodyView</code> to <code>Y.DataTable.BodyView</code>.</p>
1395
<div id="classdocs" class="tabview">
1396
<ul class="api-class-tabs">
1397
<li class="api-class-tab index"><a href="#index">Index</a></li>
1400
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
1403
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
1406
<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
1409
<li class="api-class-tab events"><a href="#events">Events</a></li>
1414
<div id="index" class="api-class-tabpanel index">
1415
<h2 class="off-left">Item Index</h2>
1418
<div class="index-section methods">
1421
<ul class="index-list methods">
1423
<li class="index-item method private inherited">
1424
<a href="#method__addAttrs">_addAttrs</a>
1429
<li class="index-item method private inherited">
1430
<a href="#method__addLazyAttr">_addLazyAttr</a>
1435
<li class="index-item method protected inherited">
1436
<a href="#method__afterChildSelectedChange">_afterChildSelectedChange</a>
1441
<li class="index-item method private inherited">
1442
<a href="#method__aggregateAttrs">_aggregateAttrs</a>
1447
<li class="index-item method protected inherited">
1448
<a href="#method__applyParsedConfig">_applyParsedConfig</a>
1453
<li class="index-item method protected inherited">
1454
<a href="#method__applyParser">_applyParser</a>
1459
<li class="index-item method private inherited inherited">
1460
<a href="#method__attrCfgHash">_attrCfgHash</a>
1465
<li class="index-item method private inherited">
1466
<a href="#method__baseDestroy">_baseDestroy</a>
1471
<li class="index-item method private inherited">
1472
<a href="#method__baseInit">_baseInit</a>
1477
<li class="index-item method private inherited">
1478
<a href="#method__bindAttrUI">_bindAttrUI</a>
1483
<li class="index-item method protected inherited">
1484
<a href="#method__bindDOM">_bindDOM</a>
1489
<li class="index-item method protected inherited">
1490
<a href="#method__bindUI">_bindUI</a>
1495
<li class="index-item method protected inherited">
1496
<a href="#method__bindUIChild">_bindUIChild</a>
1501
<li class="index-item method private inherited">
1502
<a href="#method__createUIEvent">_createUIEvent</a>
1507
<li class="index-item method private inherited">
1508
<a href="#method__defAttrChangeFn">_defAttrChangeFn</a>
1513
<li class="index-item method protected inherited">
1514
<a href="#method__defaultCB">_defaultCB</a>
1519
<li class="index-item method protected inherited">
1520
<a href="#method__defDestroyFn">_defDestroyFn</a>
1525
<li class="index-item method protected inherited">
1526
<a href="#method__defInitFn">_defInitFn</a>
1531
<li class="index-item method protected inherited">
1532
<a href="#method__defRenderFn">_defRenderFn</a>
1537
<li class="index-item method protected inherited">
1538
<a href="#method__destroyBox">_destroyBox</a>
1543
<li class="index-item method private inherited">
1544
<a href="#method__destroyHierarchy">_destroyHierarchy</a>
1549
<li class="index-item method private inherited">
1550
<a href="#method__destroyUIEvents">_destroyUIEvents</a>
1555
<li class="index-item method private inherited">
1556
<a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a>
1561
<li class="index-item method private inherited">
1562
<a href="#method__filterAttrCfs">_filterAttrCfs</a>
1567
<li class="index-item method private inherited">
1568
<a href="#method__filterUIEvent">_filterUIEvent</a>
1573
<li class="index-item method private inherited">
1574
<a href="#method__fireAttrChange">_fireAttrChange</a>
1579
<li class="index-item method protected inherited">
1580
<a href="#method__getAttr">_getAttr</a>
1585
<li class="index-item method protected inherited">
1586
<a href="#method__getAttrCfg">_getAttrCfg</a>
1591
<li class="index-item method protected inherited">
1592
<a href="#method__getAttrCfgs">_getAttrCfgs</a>
1597
<li class="index-item method private inherited inherited">
1598
<a href="#method__getAttrInitVal">_getAttrInitVal</a>
1603
<li class="index-item method protected inherited">
1604
<a href="#method__getAttrs">_getAttrs</a>
1609
<li class="index-item method protected inherited">
1610
<a href="#method__getClasses">_getClasses</a>
1615
<li class="index-item method private inherited">
1616
<a href="#method__getHtmlParser">_getHtmlParser</a>
1621
<li class="index-item method protected inherited">
1622
<a href="#method__getSrcNode">_getSrcNode</a>
1627
<li class="index-item method private inherited">
1628
<a href="#method__getStateVal">_getStateVal</a>
1633
<li class="index-item method protected inherited">
1634
<a href="#method__getStrings">_getStrings</a>
1639
<li class="index-item method private inherited">
1640
<a href="#method__getType">_getType</a>
1645
<li class="index-item method protected inherited">
1646
<a href="#method__getUIEventNode">_getUIEventNode</a>
1651
<li class="index-item method protected inherited">
1652
<a href="#method__getUIEventNode">_getUIEventNode</a>
1657
<li class="index-item method protected inherited">
1658
<a href="#method__guid">_guid</a>
1663
<li class="index-item method private inherited">
1664
<a href="#method__initAttrHost">_initAttrHost</a>
1669
<li class="index-item method private inherited inherited">
1670
<a href="#method__initAttribute">_initAttribute</a>
1675
<li class="index-item method protected inherited">
1676
<a href="#method__initAttrs">_initAttrs</a>
1681
<li class="index-item method private inherited inherited">
1682
<a href="#method__initBase">_initBase</a>
1687
<li class="index-item method private inherited">
1688
<a href="#method__initHierarchy">_initHierarchy</a>
1693
<li class="index-item method private inherited">
1694
<a href="#method__initHierarchyData">_initHierarchyData</a>
1699
<li class="index-item method private inherited">
1700
<a href="#method__initUIEvent">_initUIEvent</a>
1705
<li class="index-item method private inherited">
1706
<a href="#method__isLazyAttr">_isLazyAttr</a>
1711
<li class="index-item method private inherited">
1712
<a href="#method__isUIEvent">_isUIEvent</a>
1717
<li class="index-item method protected inherited">
1718
<a href="#method__mapInstance">_mapInstance</a>
1723
<li class="index-item method private inherited">
1724
<a href="#method__monitor">_monitor</a>
1729
<li class="index-item method private inherited inherited">
1730
<a href="#method__normAttrVals">_normAttrVals</a>
1735
<li class="index-item method protected inherited">
1736
<a href="#method__onDocFocus">_onDocFocus</a>
1741
<li class="index-item method protected inherited">
1742
<a href="#method__onDocMouseDown">_onDocMouseDown</a>
1747
<li class="index-item method private inherited">
1748
<a href="#method__parseType">_parseType</a>
1753
<li class="index-item method private inherited">
1754
<a href="#method__preInitEventCfg">_preInitEventCfg</a>
1759
<li class="index-item method protected inherited">
1760
<a href="#method__protectAttrs">_protectAttrs</a>
1765
<li class="index-item method protected inherited">
1766
<a href="#method__removeLoadingClassNames">_removeLoadingClassNames</a>
1771
<li class="index-item method private inherited">
1772
<a href="#method__renderBox">_renderBox</a>
1777
<li class="index-item method protected inherited">
1778
<a href="#method__renderBoxClassNames">_renderBoxClassNames</a>
1783
<li class="index-item method protected inherited">
1784
<a href="#method__renderUI">_renderUI</a>
1789
<li class="index-item method protected inherited inherited">
1790
<a href="#method__set">_set</a>
1795
<li class="index-item method protected inherited">
1796
<a href="#method__setAttr">_setAttr</a>
1801
<li class="index-item method protected inherited">
1802
<a href="#method__setAttrs">_setAttrs</a>
1807
<li class="index-item method private inherited">
1808
<a href="#method__setAttrUI">_setAttrUI</a>
1813
<li class="index-item method private inherited">
1814
<a href="#method__setAttrVal">_setAttrVal</a>
1819
<li class="index-item method private inherited">
1820
<a href="#method__setBB">_setBB</a>
1825
<li class="index-item method private inherited">
1826
<a href="#method__setBox">_setBox</a>
1831
<li class="index-item method private inherited">
1832
<a href="#method__setCB">_setCB</a>
1837
<li class="index-item method private inherited">
1838
<a href="#method__setStateVal">_setStateVal</a>
1843
<li class="index-item method protected inherited">
1844
<a href="#method__setStrings">_setStrings</a>
1849
<li class="index-item method protected inherited">
1850
<a href="#method__strSetter">_strSetter</a>
1855
<li class="index-item method private inherited">
1856
<a href="#method__syncAttrUI">_syncAttrUI</a>
1861
<li class="index-item method protected inherited">
1862
<a href="#method__syncUI">_syncUI</a>
1867
<li class="index-item method protected inherited">
1868
<a href="#method__syncUIChild">_syncUIChild</a>
1873
<li class="index-item method protected inherited">
1874
<a href="#method__uiSetChildSelected">_uiSetChildSelected</a>
1879
<li class="index-item method private inherited">
1880
<a href="#method__uiSetDim">_uiSetDim</a>
1885
<li class="index-item method protected inherited">
1886
<a href="#method__uiSetDisabled">_uiSetDisabled</a>
1891
<li class="index-item method protected inherited">
1892
<a href="#method__uiSetFocused">_uiSetFocused</a>
1897
<li class="index-item method protected inherited">
1898
<a href="#method__uiSetHeight">_uiSetHeight</a>
1903
<li class="index-item method protected inherited">
1904
<a href="#method__uiSetTabIndex">_uiSetTabIndex</a>
1909
<li class="index-item method protected inherited">
1910
<a href="#method__uiSetVisible">_uiSetVisible</a>
1915
<li class="index-item method protected inherited">
1916
<a href="#method__uiSetWidth">_uiSetWidth</a>
1921
<li class="index-item method protected inherited">
1922
<a href="#method__uiSizeCB">_uiSizeCB</a>
1927
<li class="index-item method protected inherited">
1928
<a href="#method__unbindDOM">_unbindDOM</a>
1933
<li class="index-item method protected inherited">
1934
<a href="#method__unbindUI">_unbindUI</a>
1939
<li class="index-item method protected inherited">
1940
<a href="#method__validTabIndex">_validTabIndex</a>
1945
<li class="index-item method inherited">
1946
<a href="#method_addAttr">addAttr</a>
1951
<li class="index-item method inherited">
1952
<a href="#method_addAttrs">addAttrs</a>
1957
<li class="index-item method inherited">
1958
<a href="#method_addTarget">addTarget</a>
1963
<li class="index-item method inherited">
1964
<a href="#method_after">after</a>
1969
<li class="index-item method inherited">
1970
<a href="#method_ancestor">ancestor</a>
1975
<li class="index-item method inherited">
1976
<a href="#method_attrAdded">attrAdded</a>
1981
<li class="index-item method inherited">
1982
<a href="#method_before">before</a>
1987
<li class="index-item method protected inherited">
1988
<a href="#method_bindUI">bindUI</a>
1993
<li class="index-item method inherited">
1994
<a href="#method_blur">blur</a>
1999
<li class="index-item method inherited">
2000
<a href="#method_bubble">bubble</a>
2005
<li class="index-item method inherited inherited">
2006
<a href="#method_destroy">destroy</a>
2011
<li class="index-item method protected inherited">
2012
<a href="#method_destructor">destructor</a>
2017
<li class="index-item method inherited">
2018
<a href="#method_detach">detach</a>
2023
<li class="index-item method inherited">
2024
<a href="#method_detachAll">detachAll</a>
2029
<li class="index-item method inherited">
2030
<a href="#method_disable">disable</a>
2035
<li class="index-item method inherited">
2036
<a href="#method_enable">enable</a>
2041
<li class="index-item method inherited">
2042
<a href="#method_fire">fire</a>
2047
<li class="index-item method inherited">
2048
<a href="#method_focus">focus</a>
2053
<li class="index-item method inherited">
2054
<a href="#method_get">get</a>
2059
<li class="index-item method inherited">
2060
<a href="#method_getAttrs">getAttrs</a>
2065
<li class="index-item method inherited inherited">
2066
<a href="#method_getClassName">getClassName</a>
2071
<li class="index-item method inherited">
2072
<a href="#method_getDefaultLocale">getDefaultLocale</a>
2077
<li class="index-item method inherited">
2078
<a href="#method_getEvent">getEvent</a>
2083
<li class="index-item method inherited">
2084
<a href="#method_getSkinName">getSkinName</a>
2089
<li class="index-item method deprecated inherited inherited">
2090
<a href="#method_getString">getString</a>
2095
<li class="index-item method deprecated inherited inherited">
2096
<a href="#method_getStrings">getStrings</a>
2101
<li class="index-item method inherited">
2102
<a href="#method_getTargets">getTargets</a>
2107
<li class="index-item method inherited">
2108
<a href="#method_hide">hide</a>
2113
<li class="index-item method inherited inherited">
2114
<a href="#method_init">init</a>
2119
<li class="index-item method protected inherited">
2120
<a href="#method_initializer">initializer</a>
2125
<li class="index-item method inherited">
2126
<a href="#method_isRoot">isRoot</a>
2131
<li class="index-item method inherited">
2132
<a href="#method_modifyAttr">modifyAttr</a>
2137
<li class="index-item method inherited">
2138
<a href="#method_next">next</a>
2143
<li class="index-item method inherited">
2144
<a href="#method_on">on</a>
2149
<li class="index-item method inherited">
2150
<a href="#method_once">once</a>
2155
<li class="index-item method inherited">
2156
<a href="#method_onceAfter">onceAfter</a>
2161
<li class="index-item method inherited">
2162
<a href="#method_parseType">parseType</a>
2167
<li class="index-item method inherited">
2168
<a href="#method_previous">previous</a>
2173
<li class="index-item method inherited">
2174
<a href="#method_publish">publish</a>
2179
<li class="index-item method inherited">
2180
<a href="#method_removeAttr">removeAttr</a>
2185
<li class="index-item method inherited">
2186
<a href="#method_removeTarget">removeTarget</a>
2191
<li class="index-item method inherited">
2192
<a href="#method_render">render</a>
2197
<li class="index-item method protected inherited">
2198
<a href="#method_renderer">renderer</a>
2203
<li class="index-item method protected inherited">
2204
<a href="#method_renderUI">renderUI</a>
2209
<li class="index-item method inherited">
2210
<a href="#method_reset">reset</a>
2215
<li class="index-item method inherited inherited">
2216
<a href="#method_set">set</a>
2221
<li class="index-item method inherited inherited">
2222
<a href="#method_setAttrs">setAttrs</a>
2227
<li class="index-item method inherited">
2228
<a href="#method_show">show</a>
2233
<li class="index-item method deprecated inherited">
2234
<a href="#method_subscribe">subscribe</a>
2239
<li class="index-item method protected inherited">
2240
<a href="#method_syncUI">syncUI</a>
2245
<li class="index-item method inherited inherited">
2246
<a href="#method_toString">toString</a>
2251
<li class="index-item method deprecated inherited">
2252
<a href="#method_unsubscribe">unsubscribe</a>
2257
<li class="index-item method deprecated inherited">
2258
<a href="#method_unsubscribeAll">unsubscribeAll</a>
2268
<div class="index-section properties">
2271
<ul class="index-list properties">
2273
<li class="index-item property protected inherited">
2274
<a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a>
2279
<li class="index-item property private inherited">
2280
<a href="#property__UI_ATTRS">_UI_ATTRS</a>
2285
<li class="index-item property inherited">
2286
<a href="#property_BOUNDING_TEMPLATE">BOUNDING_TEMPLATE</a>
2291
<li class="index-item property inherited">
2292
<a href="#property_CONTENT_TEMPLATE">CONTENT_TEMPLATE</a>
2297
<li class="index-item property inherited">
2298
<a href="#property_DEF_PARENT_NODE">DEF_PARENT_NODE</a>
2303
<li class="index-item property inherited">
2304
<a href="#property_DEF_UNIT">DEF_UNIT</a>
2309
<li class="index-item property deprecated inherited">
2310
<a href="#property_name">name</a>
2315
<li class="index-item property inherited">
2316
<a href="#property_UI_EVENTS">UI_EVENTS</a>
2326
<div class="index-section attrs">
2329
<ul class="index-list attrs">
2331
<li class="index-item attr inherited">
2332
<a href="#attr_boundingBox">boundingBox</a>
2335
<li class="index-item attr inherited">
2336
<a href="#attr_contentBox">contentBox</a>
2339
<li class="index-item attr inherited">
2340
<a href="#attr_destroyed">destroyed</a>
2343
<li class="index-item attr inherited">
2344
<a href="#attr_disabled">disabled</a>
2347
<li class="index-item attr inherited">
2348
<a href="#attr_focused">focused</a>
2351
<li class="index-item attr inherited">
2352
<a href="#attr_height">height</a>
2355
<li class="index-item attr inherited">
2356
<a href="#attr_id">id</a>
2359
<li class="index-item attr inherited">
2360
<a href="#attr_initialized">initialized</a>
2363
<li class="index-item attr deprecated inherited">
2364
<a href="#attr_locale">locale</a>
2367
<li class="index-item attr inherited">
2368
<a href="#attr_render">render</a>
2371
<li class="index-item attr inherited">
2372
<a href="#attr_rendered">rendered</a>
2375
<li class="index-item attr inherited">
2376
<a href="#attr_srcNode">srcNode</a>
2379
<li class="index-item attr inherited">
2380
<a href="#attr_strings">strings</a>
2383
<li class="index-item attr inherited">
2384
<a href="#attr_tabIndex">tabIndex</a>
2387
<li class="index-item attr inherited">
2388
<a href="#attr_visible">visible</a>
2391
<li class="index-item attr inherited">
2392
<a href="#attr_width">width</a>
2400
<div class="index-section events">
2403
<ul class="index-list events">
2405
<li class="index-item event inherited">
2406
<a href="#event_destroy">destroy</a>
2411
<li class="index-item event inherited">
2412
<a href="#event_init">init</a>
2417
<li class="index-item event inherited">
2418
<a href="#event_widget:contentUpdate">widget:contentUpdate</a>
2423
<li class="index-item event inherited">
2424
<a href="#event_widget:render">widget:render</a>
2435
<div id="methods" class="api-class-tabpanel">
2436
<h2 class="off-left">Methods</h2>
2439
<div id="method__addAttrs" class="method item private inherited">
2440
<h3 class="name"><code>_addAttrs</code></h3>
2444
<span class="paren">(</span><ul class="args-list inline commas">
2464
</ul><span class="paren">)</span>
2473
<span class="flag private">private</span>
2486
<a href="../classes/AttributeCore.html#method__addAttrs">AttributeCore</a>:
2490
<a href="../files/attribute_js_AttributeCore.js.html#l740"><code>attribute/js/AttributeCore.js:740</code></a>
2500
<div class="description">
2501
<p>Implementation behind the public addAttrs method. </p>
2503
<p>This method is invoked directly by get if it encounters a scenario
2504
in which an attribute's valueFn attempts to obtain the
2505
value an attribute in the same group of attributes, which has not yet
2506
been added (on demand initialization).</p>
2510
<div class="params">
2511
<h4>Parameters:</h4>
2513
<ul class="params-list">
2517
<code class="param-name">cfgs</code>
2518
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2523
<div class="param-description">
2524
<p>An object with attribute name/configuration pairs.</p>
2532
<code class="param-name">values</code>
2533
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2538
<div class="param-description">
2539
<p>An object with attribute name/value pairs, defining the initial values to apply.
2540
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
2548
<code class="param-name">lazy</code>
2549
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
2554
<div class="param-description">
2555
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
2556
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
2557
See <a href="#method_addAttr">addAttr</a>.</p>
2573
<div id="method__addLazyAttr" class="method item private inherited">
2574
<h3 class="name"><code>_addLazyAttr</code></h3>
2578
<span class="paren">(</span><ul class="args-list inline commas">
2586
</ul><span class="paren">)</span>
2595
<span class="flag private">private</span>
2608
<a href="../classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>:
2612
<a href="../files/attribute_js_AttributeCore.js.html#l312"><code>attribute/js/AttributeCore.js:312</code></a>
2622
<div class="description">
2623
<p>Finishes initializing an attribute which has been lazily added.</p>
2627
<div class="params">
2628
<h4>Parameters:</h4>
2630
<ul class="params-list">
2634
<code class="param-name">name</code>
2635
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2640
<div class="param-description">
2641
<p>The name of the attribute</p>
2657
<div id="method__afterChildSelectedChange" class="method item protected inherited">
2658
<h3 class="name"><code>_afterChildSelectedChange</code></h3>
2662
<span class="paren">(</span><ul class="args-list inline commas">
2670
</ul><span class="paren">)</span>
2679
<span class="flag protected">protected</span>
2692
<a href="../classes/Widget.html#method__afterChildSelectedChange">Widget</a>:
2696
<a href="../files/widget-child_js_Widget-Child.js.html#l327"><code>widget-child/js/Widget-Child.js:327</code></a>
2706
<div class="description">
2707
<p>Default attribute change listener for the <code>selected</code>
2708
attribute, responsible for updating the UI, in response to
2709
attribute changes.</p>
2713
<div class="params">
2714
<h4>Parameters:</h4>
2716
<ul class="params-list">
2720
<code class="param-name">event</code>
2721
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
2726
<div class="param-description">
2727
<p>The event facade for the attribute change.</p>
2743
<div id="method__aggregateAttrs" class="method item private inherited">
2744
<h3 class="name"><code>_aggregateAttrs</code></h3>
2748
<span class="paren">(</span><ul class="args-list inline commas">
2752
<code>allAttrs</code>
2756
</ul><span class="paren">)</span>
2761
<span class="returns-inline">
2762
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2769
<span class="flag private">private</span>
2782
<a href="../classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>:
2786
<a href="../files/base_js_BaseCore.js.html#l426"><code>base/js/BaseCore.js:426</code></a>
2796
<div class="description">
2797
<p>A helper method, used by _initHierarchyData to aggregate
2798
attribute configuration across the instances class hierarchy.</p>
2800
<p>The method will protect the attribute configuration value to protect the statically defined
2801
default value in ATTRS if required (if the value is an object literal, array or the
2802
attribute configuration has cloneDefaultValue set to shallow or deep).</p>
2806
<div class="params">
2807
<h4>Parameters:</h4>
2809
<ul class="params-list">
2813
<code class="param-name">allAttrs</code>
2814
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
2819
<div class="param-description">
2820
<p>An array of ATTRS definitions across classes in the hierarchy
2821
(subclass first, Base last)</p>
2832
<div class="returns">
2835
<div class="returns-description">
2838
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
2840
The aggregate set of ATTRS definitions for the instance
2850
<div id="method__applyParsedConfig" class="method item protected inherited">
2851
<h3 class="name"><code>_applyParsedConfig</code></h3>
2854
<span class="paren">()</span>
2858
<span class="returns-inline">
2859
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2866
<span class="flag protected">protected</span>
2879
<a href="../classes/Widget.html#method__applyParsedConfig">Widget</a>:
2883
<a href="../files/widget_js_WidgetHTMLParser.js.html#l84"><code>widget/js/WidgetHTMLParser.js:84</code></a>
2893
<div class="description">
2900
<div class="returns">
2903
<div class="returns-description">
2906
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
2908
The merged configuration literal
2918
<div id="method__applyParser" class="method item protected inherited">
2919
<h3 class="name"><code>_applyParser</code></h3>
2923
<span class="paren">(</span><ul class="args-list inline commas">
2931
</ul><span class="paren">)</span>
2940
<span class="flag protected">protected</span>
2953
<a href="../classes/Widget.html#method__applyParser">Widget</a>:
2957
<a href="../files/widget_js_WidgetHTMLParser.js.html#l93"><code>widget/js/WidgetHTMLParser.js:93</code></a>
2967
<div class="description">
2968
<p>Utilitity method used to apply the <code>HTML_PARSER</code> configuration for the
2969
instance, to retrieve config data values.</p>
2973
<div class="params">
2974
<h4>Parameters:</h4>
2976
<ul class="params-list">
2980
<code class="param-name">config</code>
2981
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
2986
<div class="param-description">
2987
<p>User configuration object (will be populated with values from Node)</p>
3003
<div id="method__attrCfgHash" class="method item private inherited">
3004
<h3 class="name"><code>_attrCfgHash</code></h3>
3007
<span class="paren">()</span>
3015
<span class="flag private">private</span>
3027
<a href="../classes/BaseCore.html#method__attrCfgHash">
3035
<a href="../files/base_js_Base.js.html#l180"><code>base/js/Base.js:180</code></a>
3045
<div class="description">
3046
<p>Utility method to define the attribute hash used to filter/whitelist property mixes for
3058
<div id="method__baseDestroy" class="method item private inherited">
3059
<h3 class="name"><code>_baseDestroy</code></h3>
3062
<span class="paren">()</span>
3070
<span class="flag private">private</span>
3083
<a href="../classes/BaseCore.html#method__baseDestroy">BaseCore</a>:
3087
<a href="../files/base_js_BaseCore.js.html#l263"><code>base/js/BaseCore.js:263</code></a>
3097
<div class="description">
3098
<p>Internal destroy implementation for BaseCore</p>
3109
<div id="method__baseInit" class="method item private inherited">
3110
<h3 class="name"><code>_baseInit</code></h3>
3113
<span class="paren">()</span>
3121
<span class="flag private">private</span>
3134
<a href="../classes/BaseCore.html#method__baseInit">BaseCore</a>:
3138
<a href="../files/base_js_BaseCore.js.html#l235"><code>base/js/BaseCore.js:235</code></a>
3148
<div class="description">
3149
<p>Internal initialization implementation for BaseCore</p>
3160
<div id="method__bindAttrUI" class="method item private inherited">
3161
<h3 class="name"><code>_bindAttrUI</code></h3>
3165
<span class="paren">(</span><ul class="args-list inline commas">
3173
</ul><span class="paren">)</span>
3182
<span class="flag private">private</span>
3195
<a href="../classes/Widget.html#method__bindAttrUI">Widget</a>:
3199
<a href="../files/widget_js_Widget.js.html#l1157"><code>widget/js/Widget.js:1157</code></a>
3209
<div class="description">
3210
<p>Binds after listeners for the list of attributes provided</p>
3214
<div class="params">
3215
<h4>Parameters:</h4>
3217
<ul class="params-list">
3221
<code class="param-name">attrs</code>
3222
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
3227
<div class="param-description">
3244
<div id="method__bindDOM" class="method item protected inherited">
3245
<h3 class="name"><code>_bindDOM</code></h3>
3248
<span class="paren">()</span>
3256
<span class="flag protected">protected</span>
3269
<a href="../classes/Widget.html#method__bindDOM">Widget</a>:
3273
<a href="../files/widget_js_Widget.js.html#l889"><code>widget/js/Widget.js:889</code></a>
3283
<div class="description">
3284
<p>Sets up DOM listeners, on elements rendered by the widget.</p>
3295
<div id="method__bindUI" class="method item protected inherited">
3296
<h3 class="name"><code>_bindUI</code></h3>
3299
<span class="paren">()</span>
3307
<span class="flag protected">protected</span>
3320
<a href="../classes/Widget.html#method__bindUI">Widget</a>:
3324
<a href="../files/widget_js_Widget.js.html#l870"><code>widget/js/Widget.js:870</code></a>
3334
<div class="description">
3335
<p>Sets up DOM and CustomEvent listeners for the widget.</p>
3346
<div id="method__bindUIChild" class="method item protected inherited">
3347
<h3 class="name"><code>_bindUIChild</code></h3>
3350
<span class="paren">()</span>
3358
<span class="flag protected">protected</span>
3371
<a href="../classes/Widget.html#method__bindUIChild">Widget</a>:
3375
<a href="../files/widget-child_js_Widget-Child.js.html#l356"><code>widget-child/js/Widget-Child.js:356</code></a>
3385
<div class="description">
3386
<p>Binds event listeners responsible for updating the UI state in response
3387
to WidgetChild related state changes.</p>
3390
This method is invoked after bindUI is invoked for the Widget class
3391
using YUI's aop infrastructure.
3403
<div id="method__createUIEvent" class="method item private inherited">
3404
<h3 class="name"><code>_createUIEvent</code></h3>
3408
<span class="paren">(</span><ul class="args-list inline commas">
3416
</ul><span class="paren">)</span>
3425
<span class="flag private">private</span>
3438
<a href="../classes/Widget.html#method__createUIEvent">Widget</a>:
3442
<a href="../files/widget_js_WidgetUIEvents.js.html#l73"><code>widget/js/WidgetUIEvents.js:73</code></a>
3452
<div class="description">
3453
<p>Binds a delegated DOM event listener of the specified type to the
3454
Widget's outtermost DOM element to facilitate the firing of a Custom
3455
Event of the same type for the Widget instance.</p>
3459
<div class="params">
3460
<h4>Parameters:</h4>
3462
<ul class="params-list">
3466
<code class="param-name">type</code>
3467
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
3472
<div class="param-description">
3473
<p>String representing the name of the event</p>
3489
<div id="method__defAttrChangeFn" class="method item private inherited">
3490
<h3 class="name"><code>_defAttrChangeFn</code></h3>
3494
<span class="paren">(</span><ul class="args-list inline commas">
3502
</ul><span class="paren">)</span>
3511
<span class="flag private">private</span>
3524
<a href="../classes/AttributeEvents.html#method__defAttrChangeFn">AttributeEvents</a>:
3528
<a href="../files/attribute_js_AttributeEvents.js.html#l148"><code>attribute/js/AttributeEvents.js:148</code></a>
3538
<div class="description">
3539
<p>Default function for attribute change events.</p>
3543
<div class="params">
3544
<h4>Parameters:</h4>
3546
<ul class="params-list">
3550
<code class="param-name">e</code>
3551
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3556
<div class="param-description">
3557
<p>The event object for attribute change events.</p>
3573
<div id="method__defaultCB" class="method item protected inherited">
3574
<h3 class="name"><code>_defaultCB</code></h3>
3577
<span class="paren">()</span>
3585
<span class="flag protected">protected</span>
3598
<a href="../classes/Widget.html#method__defaultCB">Widget</a>:
3602
<a href="../files/widget_js_Widget.js.html#l781"><code>widget/js/Widget.js:781</code></a>
3612
<div class="description">
3613
<p>Returns the default value for the contentBox attribute. </p>
3615
<p>For the Widget class, this will be the srcNode if provided, otherwise null (resulting in
3616
a new contentBox node instance being created)</p>
3627
<div id="method__defDestroyFn" class="method item protected inherited">
3628
<h3 class="name"><code>_defDestroyFn</code></h3>
3632
<span class="paren">(</span><ul class="args-list inline commas">
3640
</ul><span class="paren">)</span>
3649
<span class="flag protected">protected</span>
3662
<a href="../classes/Base.html#method__defDestroyFn">Base</a>:
3666
<a href="../files/base_js_Base.js.html#l325"><code>base/js/Base.js:325</code></a>
3676
<div class="description">
3677
<p>Default destroy event handler</p>
3681
<div class="params">
3682
<h4>Parameters:</h4>
3684
<ul class="params-list">
3688
<code class="param-name">e</code>
3689
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3694
<div class="param-description">
3711
<div id="method__defInitFn" class="method item protected inherited">
3712
<h3 class="name"><code>_defInitFn</code></h3>
3716
<span class="paren">(</span><ul class="args-list inline commas">
3724
</ul><span class="paren">)</span>
3733
<span class="flag protected">protected</span>
3746
<a href="../classes/Base.html#method__defInitFn">Base</a>:
3750
<a href="../files/base_js_Base.js.html#l313"><code>base/js/Base.js:313</code></a>
3760
<div class="description">
3761
<p>Default init event handler</p>
3765
<div class="params">
3766
<h4>Parameters:</h4>
3768
<ul class="params-list">
3772
<code class="param-name">e</code>
3773
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3778
<div class="param-description">
3779
<p>Event object, with a cfg property which
3780
refers to the configuration object passed to the constructor.</p>
3796
<div id="method__defRenderFn" class="method item protected inherited">
3797
<h3 class="name"><code>_defRenderFn</code></h3>
3801
<span class="paren">(</span><ul class="args-list inline commas">
3811
<code>parentNode</code>
3815
</ul><span class="paren">)</span>
3824
<span class="flag protected">protected</span>
3837
<a href="../classes/Widget.html#method__defRenderFn">Widget</a>:
3841
<a href="../files/widget_js_Widget.js.html#l572"><code>widget/js/Widget.js:572</code></a>
3851
<div class="description">
3852
<p>Default render handler</p>
3856
<div class="params">
3857
<h4>Parameters:</h4>
3859
<ul class="params-list">
3863
<code class="param-name">e</code>
3864
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
3869
<div class="param-description">
3870
<p>The Event object</p>
3878
<code class="param-name">parentNode</code>
3879
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
3884
<div class="param-description">
3885
<p>The parent node to render to, if passed in to the <code>render</code> method</p>
3901
<div id="method__destroyBox" class="method item protected inherited">
3902
<h3 class="name"><code>_destroyBox</code></h3>
3905
<span class="paren">()</span>
3913
<span class="flag protected">protected</span>
3926
<a href="../classes/Widget.html#method__destroyBox">Widget</a>:
3930
<a href="../files/widget_js_Widget.js.html#l478"><code>widget/js/Widget.js:478</code></a>
3940
<div class="description">
3941
<p>Removes and destroys the widgets rendered boundingBox, contentBox,
3942
and detaches bound UI events.</p>
3953
<div id="method__destroyHierarchy" class="method item private inherited">
3954
<h3 class="name"><code>_destroyHierarchy</code></h3>
3957
<span class="paren">()</span>
3965
<span class="flag private">private</span>
3978
<a href="../classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>:
3982
<a href="../files/base_js_BaseCore.js.html#l559"><code>base/js/BaseCore.js:559</code></a>
3992
<div class="description">
3993
<p>Destroys the class hierarchy for this instance by invoking
3994
the destructor method on the prototype of each class in the hierarchy.</p>
4005
<div id="method__destroyUIEvents" class="method item private inherited">
4006
<h3 class="name"><code>_destroyUIEvents</code></h3>
4009
<span class="paren">()</span>
4017
<span class="flag private">private</span>
4030
<a href="../classes/Widget.html#method__destroyUIEvents">Widget</a>:
4034
<a href="../files/widget_js_WidgetUIEvents.js.html#l20"><code>widget/js/WidgetUIEvents.js:20</code></a>
4044
<div class="description">
4045
<p>Destructor logic for UI event infrastructure,
4046
invoked during Widget destruction.</p>
4057
<div id="method__filterAdHocAttrs" class="method item private inherited">
4058
<h3 class="name"><code>_filterAdHocAttrs</code></h3>
4062
<span class="paren">(</span><ul class="args-list inline commas">
4066
<code>allAttrs</code>
4072
<code>userVals</code>
4076
</ul><span class="paren">)</span>
4081
<span class="returns-inline">
4082
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4089
<span class="flag private">private</span>
4102
<a href="../classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>:
4106
<a href="../files/base_js_BaseCore.js.html#l342"><code>base/js/BaseCore.js:342</code></a>
4116
<div class="description">
4121
<div class="params">
4122
<h4>Parameters:</h4>
4124
<ul class="params-list">
4128
<code class="param-name">allAttrs</code>
4129
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4134
<div class="param-description">
4135
<p>The set of all attribute configurations for this instance.
4136
Attributes will be removed from this set, if they belong to the filtered class, so
4137
that by the time all classes are processed, allCfgs will be empty.</p>
4145
<code class="param-name">userVals</code>
4146
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4151
<div class="param-description">
4152
<p>The config object passed in by the user, from which adhoc attrs are to be filtered.</p>
4163
<div class="returns">
4166
<div class="returns-description">
4169
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4171
The set of adhoc attributes passed in, in the form
4172
of an object with attribute name/configuration pairs.
4182
<div id="method__filterAttrCfs" class="method item private inherited">
4183
<h3 class="name"><code>_filterAttrCfs</code></h3>
4187
<span class="paren">(</span><ul class="args-list inline commas">
4197
<code>allCfgs</code>
4201
</ul><span class="paren">)</span>
4206
<span class="returns-inline">
4207
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4214
<span class="flag private">private</span>
4227
<a href="../classes/BaseCore.html#method__filterAttrCfs">BaseCore</a>:
4231
<a href="../files/base_js_BaseCore.js.html#l310"><code>base/js/BaseCore.js:310</code></a>
4241
<div class="description">
4242
<p>A helper method used when processing ATTRS across the class hierarchy during
4243
initialization. Returns a disposable object with the attributes defined for
4244
the provided class, extracted from the set of all attributes passed in.</p>
4248
<div class="params">
4249
<h4>Parameters:</h4>
4251
<ul class="params-list">
4255
<code class="param-name">clazz</code>
4256
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
4261
<div class="param-description">
4262
<p>The class for which the desired attributes are required.</p>
4270
<code class="param-name">allCfgs</code>
4271
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4276
<div class="param-description">
4277
<p>The set of all attribute configurations for this instance.
4278
Attributes will be removed from this set, if they belong to the filtered class, so
4279
that by the time all classes are processed, allCfgs will be empty.</p>
4290
<div class="returns">
4293
<div class="returns-description">
4296
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4298
The set of attributes belonging to the class passed in, in the form
4299
of an object with attribute name/configuration pairs.
4309
<div id="method__filterUIEvent" class="method item private inherited">
4310
<h3 class="name"><code>_filterUIEvent</code></h3>
4314
<span class="paren">(</span><ul class="args-list inline commas">
4322
</ul><span class="paren">)</span>
4327
<span class="returns-inline">
4328
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
4335
<span class="flag private">private</span>
4348
<a href="../classes/Widget.html#method__filterUIEvent">Widget</a>:
4352
<a href="../files/widget_js_WidgetUIEvents.js.html#l117"><code>widget/js/WidgetUIEvents.js:117</code></a>
4362
<div class="description">
4363
<p>This method is used to determine if we should fire
4364
the UI Event or not. The default implementation makes sure
4365
that for nested delegates (nested unrelated widgets), we don't
4366
fire the UI event listener more than once at each level.</p>
4368
<p>For example, without the additional filter, if you have nested
4369
widgets, each widget will have a delegate listener. If you
4370
click on the inner widget, the inner delegate listener's
4371
filter will match once, but the outer will match twice
4372
(based on delegate's design) - once for the inner widget,
4373
and once for the outer.</p>
4377
<div class="params">
4378
<h4>Parameters:</h4>
4380
<ul class="params-list">
4384
<code class="param-name">evt</code>
4385
<span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
4390
<div class="param-description">
4402
<div class="returns">
4405
<div class="returns-description">
4408
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
4410
true if it's OK to fire the custom UI event, false if not.
4420
<div id="method__fireAttrChange" class="method item private inherited">
4421
<h3 class="name"><code>_fireAttrChange</code></h3>
4425
<span class="paren">(</span><ul class="args-list inline commas">
4429
<code>attrName</code>
4435
<code>subAttrName</code>
4441
<code>currVal</code>
4457
</ul><span class="paren">)</span>
4466
<span class="flag private">private</span>
4479
<a href="../classes/AttributeEvents.html#method__fireAttrChange">AttributeEvents</a>:
4483
<a href="../files/attribute_js_AttributeEvents.js.html#l94"><code>attribute/js/AttributeEvents.js:94</code></a>
4493
<div class="description">
4494
<p>Utility method to help setup the event payload and fire the attribute change event.</p>
4498
<div class="params">
4499
<h4>Parameters:</h4>
4501
<ul class="params-list">
4505
<code class="param-name">attrName</code>
4506
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4511
<div class="param-description">
4512
<p>The name of the attribute</p>
4520
<code class="param-name">subAttrName</code>
4521
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4526
<div class="param-description">
4527
<p>The full path of the property being changed,
4528
if this is a sub-attribute value being change. Otherwise null.</p>
4536
<code class="param-name">currVal</code>
4537
<span class="type">Any</span>
4542
<div class="param-description">
4543
<p>The current value of the attribute</p>
4551
<code class="param-name">newVal</code>
4552
<span class="type">Any</span>
4557
<div class="param-description">
4558
<p>The new value of the attribute</p>
4566
<code class="param-name">opts</code>
4567
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4572
<div class="param-description">
4573
<p>Any additional event data to mix into the attribute change event's event facade.</p>
4589
<div id="method__getAttr" class="method item protected inherited">
4590
<h3 class="name"><code>_getAttr</code></h3>
4594
<span class="paren">(</span><ul class="args-list inline commas">
4602
</ul><span class="paren">)</span>
4607
<span class="returns-inline">
4608
<span class="type">Any</span>
4615
<span class="flag protected">protected</span>
4623
<span class="flag chainable">chainable</span>
4630
<a href="../classes/AttributeCore.html#method__getAttr">AttributeCore</a>:
4634
<a href="../files/attribute_js_AttributeCore.js.html#l468"><code>attribute/js/AttributeCore.js:468</code></a>
4644
<div class="description">
4645
<p>Provides the common implementation for the public get method,
4646
allowing Attribute hosts to over-ride either method.</p>
4648
<p>See <a href="#method_get">get</a> for argument details.</p>
4652
<div class="params">
4653
<h4>Parameters:</h4>
4655
<ul class="params-list">
4659
<code class="param-name">name</code>
4660
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4665
<div class="param-description">
4666
<p>The name of the attribute.</p>
4677
<div class="returns">
4680
<div class="returns-description">
4683
<span class="type">Any</span>:
4685
The value of the attribute.
4695
<div id="method__getAttrCfg" class="method item protected inherited">
4696
<h3 class="name"><code>_getAttrCfg</code></h3>
4700
<span class="paren">(</span><ul class="args-list inline commas">
4708
</ul><span class="paren">)</span>
4713
<span class="returns-inline">
4714
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4721
<span class="flag protected">protected</span>
4734
<a href="../classes/AttributeExtras.html#method__getAttrCfg">AttributeExtras</a>:
4738
<a href="../files/attribute_js_AttributeExtras.js.html#l112"><code>attribute/js/AttributeExtras.js:112</code></a>
4748
<div class="description">
4749
<p>Returns an object with the configuration properties (and value)
4750
for the given attribute. If attrName is not provided, returns the
4751
configuration properties for all attributes.</p>
4755
<div class="params">
4756
<h4>Parameters:</h4>
4758
<ul class="params-list">
4762
<code class="param-name">name</code>
4763
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4768
<div class="param-description">
4769
<p>Optional. The attribute name. If not provided, the method will return the configuration for all attributes.</p>
4780
<div class="returns">
4783
<div class="returns-description">
4786
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4788
The configuration properties for the given attribute, or all attributes.
4798
<div id="method__getAttrCfgs" class="method item protected inherited">
4799
<h3 class="name"><code>_getAttrCfgs</code></h3>
4802
<span class="paren">()</span>
4806
<span class="returns-inline">
4807
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4814
<span class="flag protected">protected</span>
4827
<a href="../classes/BaseCore.html#method__getAttrCfgs">BaseCore</a>:
4831
<a href="../files/base_js_BaseCore.js.html#l293"><code>base/js/BaseCore.js:293</code></a>
4841
<div class="description">
4842
<p>Returns an aggregated set of attribute configurations, by traversing
4843
the class hierarchy.</p>
4849
<div class="returns">
4852
<div class="returns-description">
4855
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
4857
The hash of attribute configurations, aggregated across classes in the hierarchy
4858
This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
4869
<div id="method__getAttrInitVal" class="method item private inherited">
4870
<h3 class="name"><code>_getAttrInitVal</code></h3>
4874
<span class="paren">(</span><ul class="args-list inline commas">
4890
<code>initValues</code>
4894
</ul><span class="paren">)</span>
4899
<span class="returns-inline">
4900
<span class="type">Any</span>
4907
<span class="flag private">private</span>
4919
<a href="../classes/Attribute.html#method__getAttrInitVal">
4927
<a href="../files/attribute_js_AttributeCore.js.html#l823"><code>attribute/js/AttributeCore.js:823</code></a>
4937
<div class="description">
4938
<p>Returns the initial value of the given attribute from
4939
either the default configuration provided, or the
4940
over-ridden value if it exists in the set of initValues
4941
provided and the attribute is not read-only.</p>
4945
<div class="params">
4946
<h4>Parameters:</h4>
4948
<ul class="params-list">
4952
<code class="param-name">attr</code>
4953
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
4958
<div class="param-description">
4959
<p>The name of the attribute</p>
4967
<code class="param-name">cfg</code>
4968
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4973
<div class="param-description">
4974
<p>The attribute configuration object</p>
4982
<code class="param-name">initValues</code>
4983
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
4988
<div class="param-description">
4989
<p>The object with simple and complex attribute name/value pairs returned from _normAttrVals</p>
5000
<div class="returns">
5003
<div class="returns-description">
5006
<span class="type">Any</span>:
5008
The initial value of the attribute.
5018
<div id="method__getAttrs" class="method item protected inherited">
5019
<h3 class="name"><code>_getAttrs</code></h3>
5023
<span class="paren">(</span><ul class="args-list inline commas">
5031
</ul><span class="paren">)</span>
5036
<span class="returns-inline">
5037
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5044
<span class="flag protected">protected</span>
5057
<a href="../classes/AttributeCore.html#method__getAttrs">AttributeCore</a>:
5061
<a href="../files/attribute_js_AttributeCore.js.html#l677"><code>attribute/js/AttributeCore.js:677</code></a>
5071
<div class="description">
5072
<p>Implementation behind the public getAttrs method, to get multiple attribute values.</p>
5076
<div class="params">
5077
<h4>Parameters:</h4>
5079
<ul class="params-list">
5083
<code class="param-name">attrs</code>
5084
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
5089
<div class="param-description">
5090
<p>Optional. An array of attribute names. If omitted, all attribute values are
5091
returned. If set to true, all attributes modified from their initial values are returned.</p>
5102
<div class="returns">
5105
<div class="returns-description">
5108
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
5110
An object with attribute name/value pairs.
5120
<div id="method__getClasses" class="method item protected inherited">
5121
<h3 class="name"><code>_getClasses</code></h3>
5124
<span class="paren">()</span>
5128
<span class="returns-inline">
5129
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>
5136
<span class="flag protected">protected</span>
5149
<a href="../classes/BaseCore.html#method__getClasses">BaseCore</a>:
5153
<a href="../files/base_js_BaseCore.js.html#l277"><code>base/js/BaseCore.js:277</code></a>
5163
<div class="description">
5164
<p>Returns the class hierarchy for this object, with BaseCore being the last class in the array.</p>
5170
<div class="returns">
5173
<div class="returns-description">
5176
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function[]</a></span>:
5178
An array of classes (constructor functions), making up the class hierarchy for this object.
5179
This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
5190
<div id="method__getHtmlParser" class="method item private inherited">
5191
<h3 class="name"><code>_getHtmlParser</code></h3>
5194
<span class="paren">()</span>
5198
<span class="returns-inline">
5199
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5206
<span class="flag private">private</span>
5219
<a href="../classes/Widget.html#method__getHtmlParser">Widget</a>:
5223
<a href="../files/widget_js_WidgetHTMLParser.js.html#l135"><code>widget/js/WidgetHTMLParser.js:135</code></a>
5233
<div class="description">
5234
<p>Gets the HTML<em>PARSER definition for this instance, by merging HTML</em>PARSER
5235
definitions across the class hierarchy.</p>
5241
<div class="returns">
5244
<div class="returns-description">
5247
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
5249
HTML_PARSER definition for this instance
5259
<div id="method__getSrcNode" class="method item protected inherited">
5260
<h3 class="name"><code>_getSrcNode</code></h3>
5263
<span class="paren">()</span>
5267
<span class="returns-inline">
5268
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
5275
<span class="flag protected">protected</span>
5288
<a href="../classes/Widget.html#method__getSrcNode">Widget</a>:
5292
<a href="../files/widget_js_WidgetHTMLParser.js.html#l75"><code>widget/js/WidgetHTMLParser.js:75</code></a>
5302
<div class="description">
5309
<div class="returns">
5312
<div class="returns-description">
5315
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
5317
The Node to apply HTML_PARSER to
5327
<div id="method__getStateVal" class="method item private inherited">
5328
<h3 class="name"><code>_getStateVal</code></h3>
5332
<span class="paren">(</span><ul class="args-list inline commas">
5340
</ul><span class="paren">)</span>
5345
<span class="returns-inline">
5346
<span class="type">Any</span>
5353
<span class="flag private">private</span>
5366
<a href="../classes/AttributeCore.html#method__getStateVal">AttributeCore</a>:
5370
<a href="../files/attribute_js_AttributeCore.js.html#l522"><code>attribute/js/AttributeCore.js:522</code></a>
5380
<div class="description">
5381
<p>Gets the stored value for the attribute, from either the
5382
internal state object, or the state proxy if it exits</p>
5386
<div class="params">
5387
<h4>Parameters:</h4>
5389
<ul class="params-list">
5393
<code class="param-name">name</code>
5394
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
5399
<div class="param-description">
5400
<p>The name of the attribute</p>
5411
<div class="returns">
5414
<div class="returns-description">
5417
<span class="type">Any</span>:
5419
The stored value of the attribute
5429
<div id="method__getStrings" class="method item protected inherited">
5430
<h3 class="name"><code>_getStrings</code></h3>
5434
<span class="paren">(</span><ul class="args-list inline commas">
5442
</ul><span class="paren">)</span>
5451
<span class="flag protected">protected</span>
5464
<a href="../classes/Widget.html#method__getStrings">Widget</a>:
5468
<a href="../files/widget_js_WidgetLocale.js.html#l53"><code>widget/js/WidgetLocale.js:53</code></a>
5478
<div class="description">
5479
<p>Returns the strings key/value hash for a paricular locale, without locale lookup applied.</p>
5483
<div class="params">
5484
<h4>Parameters:</h4>
5486
<ul class="params-list">
5490
<code class="param-name">locale</code>
5491
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5496
<div class="param-description">
5513
<div id="method__getType" class="method item private inherited">
5514
<h3 class="name"><code>_getType</code></h3>
5517
<span class="paren">()</span>
5525
<span class="flag private">private</span>
5538
<a href="../classes/EventTarget.html#method__getType">EventTarget</a>:
5542
<a href="../files/event-custom_js_event-target.js.html#l36"><code>event-custom/js/event-target.js:36</code></a>
5552
<div class="description">
5553
<p>If the instance has a prefix attribute and the
5554
event type is not prefixed, the instance prefix is
5555
applied to the supplied type.</p>
5566
<div id="method__getUIEventNode" class="method item protected inherited">
5567
<h3 class="name"><code>_getUIEventNode</code></h3>
5570
<span class="paren">()</span>
5578
<span class="flag protected">protected</span>
5591
<a href="../classes/Widget.html#method__getUIEventNode">Widget</a>:
5595
<a href="../files/widget-child_js_Widget-Child.js.html#l167"><code>widget-child/js/Widget-Child.js:167</code></a>
5605
<div class="description">
5606
<p>Returns the node on which to bind delegate listeners.</p>
5608
<p>Override of Widget's implementation of _getUIEventNode() to ensure that
5609
all event listeners are bound to the Widget's topmost DOM element.
5610
This ensures that the firing of each type of Widget UI event (click,
5611
mousedown, etc.) is facilitated by a single, top-level, delegated DOM
5623
<div id="method__getUIEventNode" class="method item protected inherited">
5624
<h3 class="name"><code>_getUIEventNode</code></h3>
5627
<span class="paren">()</span>
5635
<span class="flag protected">protected</span>
5648
<a href="../classes/Widget.html#method__getUIEventNode">Widget</a>:
5652
<a href="../files/widget_js_WidgetUIEvents.js.html#l62"><code>widget/js/WidgetUIEvents.js:62</code></a>
5662
<div class="description">
5663
<p>Returns the node on which to bind delegate listeners.</p>
5674
<div id="method__guid" class="method item protected inherited">
5675
<h3 class="name"><code>_guid</code></h3>
5678
<span class="paren">()</span>
5686
<span class="flag protected">protected</span>
5699
<a href="../classes/Widget.html#method__guid">Widget</a>:
5703
<a href="../files/widget_js_Widget.js.html#l1140"><code>widget/js/Widget.js:1140</code></a>
5713
<div class="description">
5725
<div id="method__initAttrHost" class="method item private inherited">
5726
<h3 class="name"><code>_initAttrHost</code></h3>
5730
<span class="paren">(</span><ul class="args-list inline commas">
5750
</ul><span class="paren">)</span>
5759
<span class="flag private">private</span>
5772
<a href="../classes/AttributeCore.html#method__initAttrHost">AttributeCore</a>:
5776
<a href="../files/attribute_js_AttributeCore.js.html#l109"><code>attribute/js/AttributeCore.js:109</code></a>
5786
<div class="description">
5787
<p>Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the
5792
<div class="params">
5793
<h4>Parameters:</h4>
5795
<ul class="params-list">
5799
<code class="param-name">attrs</code>
5800
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5805
<div class="param-description">
5806
<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>
5814
<code class="param-name">values</code>
5815
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5820
<div class="param-description">
5821
<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>
5829
<code class="param-name">lazy</code>
5830
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
5835
<div class="param-description">
5836
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
5852
<div id="method__initAttribute" class="method item private inherited">
5853
<h3 class="name"><code>_initAttribute</code></h3>
5856
<span class="paren">()</span>
5864
<span class="flag private">private</span>
5876
<a href="../classes/BaseCore.html#method__initAttribute">
5884
<a href="../files/base_js_Base.js.html#l169"><code>base/js/Base.js:169</code></a>
5894
<div class="description">
5895
<p>Initializes Attribute</p>
5906
<div id="method__initAttrs" class="method item protected inherited">
5907
<h3 class="name"><code>_initAttrs</code></h3>
5911
<span class="paren">(</span><ul class="args-list inline commas">
5931
</ul><span class="paren">)</span>
5940
<span class="flag protected">protected</span>
5953
<a href="../classes/AttributeCore.html#method__initAttrs">AttributeCore</a>:
5957
<a href="../files/attribute_js_AttributeCore.js.html#l862"><code>attribute/js/AttributeCore.js:862</code></a>
5967
<div class="description">
5968
<p>Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.</p>
5972
<div class="params">
5973
<h4>Parameters:</h4>
5975
<ul class="params-list">
5979
<code class="param-name">attrs</code>
5980
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
5985
<div class="param-description">
5986
<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>
5994
<code class="param-name">values</code>
5995
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6000
<div class="param-description">
6001
<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>
6009
<code class="param-name">lazy</code>
6010
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
6015
<div class="param-description">
6016
<p>Whether or not to add attributes lazily (passed through to <a href="#method_addAttrs">addAttrs</a>).</p>
6032
<div id="method__initBase" class="method item private inherited">
6033
<h3 class="name"><code>_initBase</code></h3>
6037
<span class="paren">(</span><ul class="args-list inline commas">
6045
</ul><span class="paren">)</span>
6054
<span class="flag private">private</span>
6066
<a href="../classes/BaseCore.html#method__initBase">
6074
<a href="../files/base_js_Base.js.html#l154"><code>base/js/Base.js:154</code></a>
6084
<div class="description">
6085
<p>Internal construction logic for Base.</p>
6089
<div class="params">
6090
<h4>Parameters:</h4>
6092
<ul class="params-list">
6096
<code class="param-name">config</code>
6097
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6102
<div class="param-description">
6103
<p>The constructor configuration object</p>
6119
<div id="method__initHierarchy" class="method item private inherited">
6120
<h3 class="name"><code>_initHierarchy</code></h3>
6124
<span class="paren">(</span><ul class="args-list inline commas">
6128
<code>userVals</code>
6132
</ul><span class="paren">)</span>
6141
<span class="flag private">private</span>
6154
<a href="../classes/BaseCore.html#method__initHierarchy">BaseCore</a>:
6158
<a href="../files/base_js_BaseCore.js.html#l501"><code>base/js/BaseCore.js:501</code></a>
6168
<div class="description">
6169
<p>Initializes the class hierarchy for the instance, which includes
6170
initializing attributes for each class defined in the class's
6171
static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and
6172
invoking the initializer method on the prototype of each class in the hierarchy.</p>
6176
<div class="params">
6177
<h4>Parameters:</h4>
6179
<ul class="params-list">
6183
<code class="param-name">userVals</code>
6184
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6189
<div class="param-description">
6190
<p>Object with configuration property name/value pairs</p>
6206
<div id="method__initHierarchyData" class="method item private inherited">
6207
<h3 class="name"><code>_initHierarchyData</code></h3>
6210
<span class="paren">()</span>
6218
<span class="flag private">private</span>
6231
<a href="../classes/BaseCore.html#method__initHierarchyData">BaseCore</a>:
6235
<a href="../files/base_js_BaseCore.js.html#l372"><code>base/js/BaseCore.js:372</code></a>
6245
<div class="description">
6246
<p>A helper method used by _getClasses and _getAttrCfgs, which determines both
6247
the array of classes and aggregate set of attribute configurations
6248
across the class hierarchy for the instance.</p>
6259
<div id="method__initUIEvent" class="method item private inherited">
6260
<h3 class="name"><code>_initUIEvent</code></h3>
6264
<span class="paren">(</span><ul class="args-list inline commas">
6272
</ul><span class="paren">)</span>
6277
<span class="returns-inline">
6278
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6285
<span class="flag private">private</span>
6298
<a href="../classes/Widget.html#method__initUIEvent">Widget</a>:
6302
<a href="../files/widget_js_WidgetUIEvents.js.html#l176"><code>widget/js/WidgetUIEvents.js:176</code></a>
6312
<div class="description">
6313
<p>Sets up infrastructure required to fire a UI event.</p>
6317
<div class="params">
6318
<h4>Parameters:</h4>
6320
<ul class="params-list">
6324
<code class="param-name">type</code>
6325
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6330
<div class="param-description">
6331
<p>String representing the name of the event</p>
6342
<div class="returns">
6345
<div class="returns-description">
6348
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
6359
<div id="method__isLazyAttr" class="method item private inherited">
6360
<h3 class="name"><code>_isLazyAttr</code></h3>
6364
<span class="paren">(</span><ul class="args-list inline commas">
6372
</ul><span class="paren">)</span>
6377
<span class="returns-inline">
6378
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
6385
<span class="flag private">private</span>
6398
<a href="../classes/AttributeCore.html#method__isLazyAttr">AttributeCore</a>:
6402
<a href="../files/attribute_js_AttributeCore.js.html#l299"><code>attribute/js/AttributeCore.js:299</code></a>
6412
<div class="description">
6413
<p>Checks whether or not the attribute is one which has been
6414
added lazily and still requires initialization.</p>
6418
<div class="params">
6419
<h4>Parameters:</h4>
6421
<ul class="params-list">
6425
<code class="param-name">name</code>
6426
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6431
<div class="param-description">
6432
<p>The name of the attribute</p>
6443
<div class="returns">
6446
<div class="returns-description">
6449
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
6451
true if it's a lazily added attribute, false otherwise.
6461
<div id="method__isUIEvent" class="method item private inherited">
6462
<h3 class="name"><code>_isUIEvent</code></h3>
6466
<span class="paren">(</span><ul class="args-list inline commas">
6474
</ul><span class="paren">)</span>
6479
<span class="returns-inline">
6480
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6487
<span class="flag private">private</span>
6500
<a href="../classes/Widget.html#method__isUIEvent">Widget</a>:
6504
<a href="../files/widget_js_WidgetUIEvents.js.html#l143"><code>widget/js/WidgetUIEvents.js:143</code></a>
6514
<div class="description">
6515
<p>Determines if the specified event is a UI event.</p>
6519
<div class="params">
6520
<h4>Parameters:</h4>
6522
<ul class="params-list">
6526
<code class="param-name">type</code>
6527
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6532
<div class="param-description">
6533
<p>String representing the name of the event</p>
6544
<div class="returns">
6547
<div class="returns-description">
6550
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
6552
Event Returns the name of the UI Event, otherwise
6563
<div id="method__mapInstance" class="method item protected inherited">
6564
<h3 class="name"><code>_mapInstance</code></h3>
6568
<span class="paren">(</span><ul class="args-list inline commas">
6576
</ul><span class="paren">)</span>
6585
<span class="flag protected">protected</span>
6598
<a href="../classes/Widget.html#method__mapInstance">Widget</a>:
6602
<a href="../files/widget_js_Widget.js.html#l415"><code>widget/js/Widget.js:415</code></a>
6612
<div class="description">
6613
<p>Utility method used to add an entry to the boundingBox id to instance map. </p>
6615
<p>This method can be used to populate the instance with lazily created boundingBox Node references.</p>
6619
<div class="params">
6620
<h4>Parameters:</h4>
6622
<ul class="params-list">
6626
<code class="param-name">The</code>
6627
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6632
<div class="param-description">
6633
<p>boundingBox id</p>
6649
<div id="method__monitor" class="method item private inherited">
6650
<h3 class="name"><code>_monitor</code></h3>
6654
<span class="paren">(</span><ul class="args-list inline commas">
6674
</ul><span class="paren">)</span>
6683
<span class="flag private">private</span>
6696
<a href="../classes/EventTarget.html#method__monitor">EventTarget</a>:
6700
<a href="../files/event-custom_js_event-target.js.html#l602"><code>event-custom/js/event-target.js:602</code></a>
6710
<div class="description">
6711
<p>This is the entry point for the event monitoring system.
6712
You can monitor 'attach', 'detach', 'fire', and 'publish'.
6713
When configured, these events generate an event. click ->
6714
click<em>attach, click</em>detach, click_publish -- these can
6715
be subscribed to like other events to monitor the event
6716
system. Inividual published events can have monitoring
6717
turned on or off (publish can't be turned off before it
6718
it published) by setting the events 'monitor' config.</p>
6722
<div class="params">
6723
<h4>Parameters:</h4>
6725
<ul class="params-list">
6729
<code class="param-name">what</code>
6730
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6735
<div class="param-description">
6736
<p>'attach', 'detach', 'fire', or 'publish'</p>
6744
<code class="param-name">type</code>
6745
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
6750
<div class="param-description">
6751
<p>Name of the event being monitored</p>
6759
<code class="param-name">o</code>
6760
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6765
<div class="param-description">
6766
<p>Information about the event interaction, such as
6767
fire() args, subscription category, publish config</p>
6783
<div id="method__normAttrVals" class="method item private inherited">
6784
<h3 class="name"><code>_normAttrVals</code></h3>
6788
<span class="paren">(</span><ul class="args-list inline commas">
6792
<code>valueHash</code>
6796
</ul><span class="paren">)</span>
6801
<span class="returns-inline">
6802
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6809
<span class="flag private">private</span>
6821
<a href="../classes/Attribute.html#method__normAttrVals">
6829
<a href="../files/attribute_js_AttributeCore.js.html#l808"><code>attribute/js/AttributeCore.js:808</code></a>
6839
<div class="description">
6840
<p>Utility method to normalize attribute values. The base implementation
6841
simply merges the hash to protect the original.</p>
6845
<div class="params">
6846
<h4>Parameters:</h4>
6848
<ul class="params-list">
6852
<code class="param-name">valueHash</code>
6853
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
6858
<div class="param-description">
6859
<p>An object with attribute name/value pairs</p>
6870
<div class="returns">
6873
<div class="returns-description">
6876
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
6887
<div id="method__onDocFocus" class="method item protected inherited">
6888
<h3 class="name"><code>_onDocFocus</code></h3>
6892
<span class="paren">(</span><ul class="args-list inline commas">
6900
</ul><span class="paren">)</span>
6909
<span class="flag protected">protected</span>
6922
<a href="../classes/Widget.html#method__onDocFocus">Widget</a>:
6926
<a href="../files/widget_js_Widget.js.html#l1068"><code>widget/js/Widget.js:1068</code></a>
6936
<div class="description">
6937
<p>DOM focus event handler, used to sync the state of the Widget with the DOM</p>
6941
<div class="params">
6942
<h4>Parameters:</h4>
6944
<ul class="params-list">
6948
<code class="param-name">evt</code>
6949
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
6954
<div class="param-description">
6955
<p>The event facade for the DOM focus event</p>
6971
<div id="method__onDocMouseDown" class="method item protected inherited">
6972
<h3 class="name"><code>_onDocMouseDown</code></h3>
6976
<span class="paren">(</span><ul class="args-list inline commas">
6984
</ul><span class="paren">)</span>
6993
<span class="flag protected">protected</span>
7006
<a href="../classes/Widget.html#method__onDocMouseDown">Widget</a>:
7010
<a href="../files/widget_js_Widget.js.html#l1055"><code>widget/js/Widget.js:1055</code></a>
7020
<div class="description">
7021
<p>"mousedown" event handler for the owner document of the
7022
widget's bounding box.</p>
7026
<div class="params">
7027
<h4>Parameters:</h4>
7029
<ul class="params-list">
7033
<code class="param-name">evt</code>
7034
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
7039
<div class="param-description">
7040
<p>The event facade for the DOM focus event</p>
7056
<div id="method__parseType" class="method item private inherited">
7057
<h3 class="name"><code>_parseType</code></h3>
7060
<span class="paren">()</span>
7068
<span class="flag private">private</span>
7081
<a href="../classes/EventTarget.html#method__parseType">EventTarget</a>:
7085
<a href="../files/event-custom_js_event-target.js.html#l52"><code>event-custom/js/event-target.js:52</code></a>
7095
<div class="description">
7096
<p>Returns an array with the detach key (if provided),
7097
and the prefixed event name from _getType
7098
Y.on('detachcategory| menu:click', fn)</p>
7109
<div id="method__preInitEventCfg" class="method item private inherited">
7110
<h3 class="name"><code>_preInitEventCfg</code></h3>
7114
<span class="paren">(</span><ul class="args-list inline commas">
7122
</ul><span class="paren">)</span>
7131
<span class="flag private">private</span>
7144
<a href="../classes/Base.html#method__preInitEventCfg">Base</a>:
7148
<a href="../files/base_js_Base.js.html#l233"><code>base/js/Base.js:233</code></a>
7158
<div class="description">
7159
<p>Handles the special on, after and target properties which allow the user to
7160
easily configure on and after listeners as well as bubble targets during
7161
construction, prior to init.</p>
7165
<div class="params">
7166
<h4>Parameters:</h4>
7168
<ul class="params-list">
7172
<code class="param-name">config</code>
7173
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7178
<div class="param-description">
7179
<p>The user configuration object</p>
7195
<div id="method__protectAttrs" class="method item protected inherited">
7196
<h3 class="name"><code>_protectAttrs</code></h3>
7200
<span class="paren">(</span><ul class="args-list inline commas">
7208
</ul><span class="paren">)</span>
7213
<span class="returns-inline">
7214
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7221
<span class="flag protected">protected</span>
7234
<a href="../classes/AttributeCore.html#method__protectAttrs">AttributeCore</a>:
7238
<a href="../files/attribute_js_AttributeCore.js.html#l786"><code>attribute/js/AttributeCore.js:786</code></a>
7248
<div class="description">
7249
<p>Utility method to protect an attribute configuration
7250
hash, by merging the entire object and the individual
7251
attr config objects.</p>
7255
<div class="params">
7256
<h4>Parameters:</h4>
7258
<ul class="params-list">
7262
<code class="param-name">attrs</code>
7263
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7268
<div class="param-description">
7269
<p>A hash of attribute to configuration object pairs.</p>
7280
<div class="returns">
7283
<div class="returns-description">
7286
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7288
A protected version of the attrs argument.
7298
<div id="method__removeLoadingClassNames" class="method item protected inherited">
7299
<h3 class="name"><code>_removeLoadingClassNames</code></h3>
7302
<span class="paren">()</span>
7310
<span class="flag protected">protected</span>
7323
<a href="../classes/Widget.html#method__removeLoadingClassNames">Widget</a>:
7327
<a href="../files/widget_js_Widget.js.html#l849"><code>widget/js/Widget.js:849</code></a>
7337
<div class="description">
7338
<p>Removes class names representative of the widget's loading state from
7339
the boundingBox.</p>
7350
<div id="method__renderBox" class="method item private inherited">
7351
<h3 class="name"><code>_renderBox</code></h3>
7355
<span class="paren">(</span><ul class="args-list inline commas">
7359
<code>parentNode</code>
7363
</ul><span class="paren">)</span>
7372
<span class="flag private">private</span>
7385
<a href="../classes/Widget.html#method__renderBox">Widget</a>:
7389
<a href="../files/widget_js_Widget.js.html#l711"><code>widget/js/Widget.js:711</code></a>
7399
<div class="description">
7400
<p>Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not
7401
already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used
7402
as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and
7403
the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered
7404
to the current document's body.</p>
7408
<div class="params">
7409
<h4>Parameters:</h4>
7411
<ul class="params-list">
7415
<code class="param-name">parentNode</code>
7416
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
7421
<div class="param-description">
7422
<p>The parentNode to render the widget to. If not provided, and both the boundingBox and
7423
the contentBox are not currently in the document, the widget will be rendered to the current document's body.</p>
7439
<div id="method__renderBoxClassNames" class="method item protected inherited">
7440
<h3 class="name"><code>_renderBoxClassNames</code></h3>
7443
<span class="paren">()</span>
7451
<span class="flag protected">protected</span>
7464
<a href="../classes/Widget.html#method__renderBoxClassNames">Widget</a>:
7468
<a href="../files/widget_js_Widget.js.html#l825"><code>widget/js/Widget.js:825</code></a>
7478
<div class="description">
7479
<p>Applies standard class names to the boundingBox and contentBox</p>
7490
<div id="method__renderUI" class="method item protected inherited">
7491
<h3 class="name"><code>_renderUI</code></h3>
7494
<span class="paren">()</span>
7502
<span class="flag protected">protected</span>
7515
<a href="../classes/Widget.html#method__renderUI">Widget</a>:
7519
<a href="../files/widget_js_Widget.js.html#l814"><code>widget/js/Widget.js:814</code></a>
7529
<div class="description">
7530
<p>Initializes the UI state for the Widget's bounding/content boxes.</p>
7541
<div id="method__set" class="method item protected inherited">
7542
<h3 class="name"><code>_set</code></h3>
7546
<span class="paren">(</span><ul class="args-list inline commas">
7560
</ul><span class="paren">)</span>
7565
<span class="returns-inline">
7566
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7573
<span class="flag protected">protected</span>
7581
<span class="flag chainable">chainable</span>
7587
<a href="../classes/AttributeEvents.html#method__set">
7595
<a href="../files/attribute_js_AttributeCore.js.html#l346"><code>attribute/js/AttributeCore.js:346</code></a>
7605
<div class="description">
7606
<p>Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.</p>
7610
<div class="params">
7611
<h4>Parameters:</h4>
7613
<ul class="params-list">
7617
<code class="param-name">name</code>
7618
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7623
<div class="param-description">
7624
<p>The name of the attribute.</p>
7632
<code class="param-name">val</code>
7633
<span class="type">Any</span>
7638
<div class="param-description">
7639
<p>The value to set the attribute to.</p>
7650
<div class="returns">
7653
<div class="returns-description">
7656
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7658
A reference to the host object.
7668
<div id="method__setAttr" class="method item protected inherited">
7669
<h3 class="name"><code>_setAttr</code></h3>
7673
<span class="paren">(</span><ul class="args-list inline commas">
7699
</ul><span class="paren">)</span>
7704
<span class="returns-inline">
7705
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7712
<span class="flag protected">protected</span>
7720
<span class="flag chainable">chainable</span>
7727
<a href="../classes/AttributeCore.html#method__setAttr">AttributeCore</a>:
7731
<a href="../files/attribute_js_AttributeCore.js.html#l361"><code>attribute/js/AttributeCore.js:361</code></a>
7741
<div class="description">
7742
<p>Provides the common implementation for the public set and protected _set methods.</p>
7744
<p>See <a href="#method_set">set</a> for argument details.</p>
7748
<div class="params">
7749
<h4>Parameters:</h4>
7751
<ul class="params-list">
7755
<code class="param-name">name</code>
7756
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
7761
<div class="param-description">
7762
<p>The name of the attribute.</p>
7770
<code class="param-name">value</code>
7771
<span class="type">Any</span>
7776
<div class="param-description">
7777
<p>The value to set the attribute to.</p>
7785
<code class="param-name">opts</code>
7786
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7791
<div class="param-description">
7792
<p>(Optional) Optional event data to be mixed into
7793
the event facade passed to subscribers of the attribute's change event.
7794
This is currently a hack. There's no real need for the AttributeCore implementation
7795
to support this parameter, but breaking it out into AttributeEvents, results in
7796
additional function hops for the critical path. May change in 3.5.0 PR3.</p>
7804
<code class="param-name">force</code>
7805
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
7810
<div class="param-description">
7811
<p>If true, allows the caller to set values for
7812
readOnly or writeOnce attributes which have already been set.</p>
7823
<div class="returns">
7826
<div class="returns-description">
7829
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7831
A reference to the host object.
7841
<div id="method__setAttrs" class="method item protected inherited">
7842
<h3 class="name"><code>_setAttrs</code></h3>
7846
<span class="paren">(</span><ul class="args-list inline commas">
7854
</ul><span class="paren">)</span>
7859
<span class="returns-inline">
7860
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7867
<span class="flag protected">protected</span>
7875
<span class="flag chainable">chainable</span>
7882
<a href="../classes/AttributeCore.html#method__setAttrs">AttributeCore</a>:
7886
<a href="../files/attribute_js_AttributeCore.js.html#l647"><code>attribute/js/AttributeCore.js:647</code></a>
7896
<div class="description">
7897
<p>Implementation behind the public setAttrs method, to set multiple attribute values.</p>
7901
<div class="params">
7902
<h4>Parameters:</h4>
7904
<ul class="params-list">
7908
<code class="param-name">attrs</code>
7909
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
7914
<div class="param-description">
7915
<p>An object with attributes name/value pairs.</p>
7926
<div class="returns">
7929
<div class="returns-description">
7932
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
7934
A reference to the host object.
7944
<div id="method__setAttrUI" class="method item private inherited">
7945
<h3 class="name"><code>_setAttrUI</code></h3>
7949
<span class="paren">(</span><ul class="args-list inline commas">
7957
</ul><span class="paren">)</span>
7966
<span class="flag private">private</span>
7979
<a href="../classes/Widget.html#method__setAttrUI">Widget</a>:
7983
<a href="../files/widget_js_Widget.js.html#l1188"><code>widget/js/Widget.js:1188</code></a>
7993
<div class="description">
7998
<div class="params">
7999
<h4>Parameters:</h4>
8001
<ul class="params-list">
8005
<code class="param-name">e</code>
8006
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
8011
<div class="param-description">
8028
<div id="method__setAttrVal" class="method item private inherited">
8029
<h3 class="name"><code>_setAttrVal</code></h3>
8033
<span class="paren">(</span><ul class="args-list inline commas">
8037
<code>attrName</code>
8043
<code>subAttrName</code>
8049
<code>prevVal</code>
8059
</ul><span class="paren">)</span>
8064
<span class="returns-inline">
8065
<span class="type">Booolean</span>
8072
<span class="flag private">private</span>
8085
<a href="../classes/AttributeCore.html#method__setAttrVal">AttributeCore</a>:
8089
<a href="../files/attribute_js_AttributeCore.js.html#l554"><code>attribute/js/AttributeCore.js:554</code></a>
8099
<div class="description">
8100
<p>Updates the stored value of the attribute in the privately held State object,
8101
if validation and setter passes.</p>
8105
<div class="params">
8106
<h4>Parameters:</h4>
8108
<ul class="params-list">
8112
<code class="param-name">attrName</code>
8113
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8118
<div class="param-description">
8119
<p>The attribute name.</p>
8127
<code class="param-name">subAttrName</code>
8128
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8133
<div class="param-description">
8134
<p>The sub-attribute name, if setting a sub-attribute property ("x.y.z").</p>
8142
<code class="param-name">prevVal</code>
8143
<span class="type">Any</span>
8148
<div class="param-description">
8149
<p>The currently stored value of the attribute.</p>
8157
<code class="param-name">newVal</code>
8158
<span class="type">Any</span>
8163
<div class="param-description">
8164
<p>The value which is going to be stored.</p>
8175
<div class="returns">
8178
<div class="returns-description">
8181
<span class="type">Booolean</span>:
8183
true if the new attribute value was stored, false if not.
8193
<div id="method__setBB" class="method item private inherited">
8194
<h3 class="name"><code>_setBB</code></h3>
8198
<span class="paren">(</span><ul class="args-list inline commas">
8202
<code>Node/String</code>
8206
</ul><span class="paren">)</span>
8211
<span class="returns-inline">
8212
<span class="type"></span>
8219
<span class="flag private">private</span>
8232
<a href="../classes/Widget.html#method__setBB">Widget</a>:
8236
<a href="../files/widget_js_Widget.js.html#l757"><code>widget/js/Widget.js:757</code></a>
8246
<div class="description">
8247
<p>Setter for the boundingBox attribute</p>
8251
<div class="params">
8252
<h4>Parameters:</h4>
8254
<ul class="params-list">
8258
<code class="param-name">Node/String</code>
8259
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8264
<div class="param-description">
8276
<div class="returns">
8279
<div class="returns-description">
8292
<div id="method__setBox" class="method item private inherited">
8293
<h3 class="name"><code>_setBox</code></h3>
8297
<span class="paren">(</span><ul class="args-list inline commas">
8313
<code>template</code>
8317
</ul><span class="paren">)</span>
8322
<span class="returns-inline">
8323
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
8330
<span class="flag private">private</span>
8343
<a href="../classes/Widget.html#method__setBox">Widget</a>:
8347
<a href="../files/widget_js_Widget.js.html#l794"><code>widget/js/Widget.js:794</code></a>
8357
<div class="description">
8358
<p>Helper method to set the bounding/content box, or create it from
8359
the provided template if not found.</p>
8363
<div class="params">
8364
<h4>Parameters:</h4>
8366
<ul class="params-list">
8370
<code class="param-name">id</code>
8371
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8376
<div class="param-description">
8377
<p>The node's id attribute</p>
8385
<code class="param-name">node</code>
8386
<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>
8391
<div class="param-description">
8392
<p>The node reference</p>
8400
<code class="param-name">template</code>
8401
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8406
<div class="param-description">
8407
<p>HTML string template for the node</p>
8418
<div class="returns">
8421
<div class="returns-description">
8424
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
8436
<div id="method__setCB" class="method item private inherited">
8437
<h3 class="name"><code>_setCB</code></h3>
8441
<span class="paren">(</span><ul class="args-list inline commas">
8449
</ul><span class="paren">)</span>
8454
<span class="returns-inline">
8455
<span class="type"></span>
8462
<span class="flag private">private</span>
8475
<a href="../classes/Widget.html#method__setCB">Widget</a>:
8479
<a href="../files/widget_js_Widget.js.html#l769"><code>widget/js/Widget.js:769</code></a>
8489
<div class="description">
8490
<p>Setter for the contentBox attribute</p>
8494
<div class="params">
8495
<h4>Parameters:</h4>
8497
<ul class="params-list">
8501
<code class="param-name">node</code>
8502
<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>
8507
<div class="param-description">
8519
<div class="returns">
8522
<div class="returns-description">
8535
<div id="method__setStateVal" class="method item private inherited">
8536
<h3 class="name"><code>_setStateVal</code></h3>
8540
<span class="paren">(</span><ul class="args-list inline commas">
8554
</ul><span class="paren">)</span>
8563
<span class="flag private">private</span>
8576
<a href="../classes/AttributeCore.html#method__setStateVal">AttributeCore</a>:
8580
<a href="../files/attribute_js_AttributeCore.js.html#l536"><code>attribute/js/AttributeCore.js:536</code></a>
8590
<div class="description">
8591
<p>Sets the stored value for the attribute, in either the
8592
internal state object, or the state proxy if it exits</p>
8596
<div class="params">
8597
<h4>Parameters:</h4>
8599
<ul class="params-list">
8603
<code class="param-name">name</code>
8604
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8609
<div class="param-description">
8610
<p>The name of the attribute</p>
8618
<code class="param-name">value</code>
8619
<span class="type">Any</span>
8624
<div class="param-description">
8625
<p>The value of the attribute</p>
8641
<div id="method__setStrings" class="method item protected inherited">
8642
<h3 class="name"><code>_setStrings</code></h3>
8646
<span class="paren">(</span><ul class="args-list inline commas">
8650
<code>strings</code>
8660
</ul><span class="paren">)</span>
8669
<span class="flag protected">protected</span>
8682
<a href="../classes/Widget.html#method__setStrings">Widget</a>:
8686
<a href="../files/widget_js_WidgetLocale.js.html#l32"><code>widget/js/WidgetLocale.js:32</code></a>
8696
<div class="description">
8697
<p>Sets strings for a particular locale, merging with any existing
8698
strings which may already be defined for the locale.</p>
8702
<div class="params">
8703
<h4>Parameters:</h4>
8705
<ul class="params-list">
8709
<code class="param-name">strings</code>
8710
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8715
<div class="param-description">
8716
<p>The hash of string key/values to set</p>
8724
<code class="param-name">locale</code>
8725
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8730
<div class="param-description">
8731
<p>The locale for the string values being set</p>
8747
<div id="method__strSetter" class="method item protected inherited">
8748
<h3 class="name"><code>_strSetter</code></h3>
8752
<span class="paren">(</span><ul class="args-list inline commas">
8756
<code>strings</code>
8760
</ul><span class="paren">)</span>
8765
<span class="returns-inline">
8766
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
8773
<span class="flag protected">protected</span>
8786
<a href="../classes/Widget.html#method__strSetter">Widget</a>:
8790
<a href="../files/widget_js_Widget.js.html#l1199"><code>widget/js/Widget.js:1199</code></a>
8800
<div class="description">
8801
<p>The default setter for the strings attribute. Merges partial sets
8802
into the full string set, to allow users to partial sets of strings</p>
8806
<div class="params">
8807
<h4>Parameters:</h4>
8809
<ul class="params-list">
8813
<code class="param-name">strings</code>
8814
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
8819
<div class="param-description">
8831
<div class="returns">
8834
<div class="returns-description">
8837
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
8839
The full set of strings to set
8849
<div id="method__syncAttrUI" class="method item private inherited">
8850
<h3 class="name"><code>_syncAttrUI</code></h3>
8854
<span class="paren">(</span><ul class="args-list inline commas">
8862
</ul><span class="paren">)</span>
8871
<span class="flag private">private</span>
8884
<a href="../classes/Widget.html#method__syncAttrUI">Widget</a>:
8888
<a href="../files/widget_js_Widget.js.html#l1173"><code>widget/js/Widget.js:1173</code></a>
8898
<div class="description">
8899
<p>Invokes the _uiSet=ATTR NAME> method for the list of attributes provided</p>
8903
<div class="params">
8904
<h4>Parameters:</h4>
8906
<ul class="params-list">
8910
<code class="param-name">attrs</code>
8911
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
8916
<div class="param-description">
8933
<div id="method__syncUI" class="method item protected inherited">
8934
<h3 class="name"><code>_syncUI</code></h3>
8937
<span class="paren">()</span>
8945
<span class="flag protected">protected</span>
8958
<a href="../classes/Widget.html#method__syncUI">Widget</a>:
8962
<a href="../files/widget_js_Widget.js.html#l951"><code>widget/js/Widget.js:951</code></a>
8972
<div class="description">
8973
<p>Updates the widget UI to reflect the attribute state.</p>
8984
<div id="method__syncUIChild" class="method item protected inherited">
8985
<h3 class="name"><code>_syncUIChild</code></h3>
8988
<span class="paren">()</span>
8996
<span class="flag protected">protected</span>
9009
<a href="../classes/Widget.html#method__syncUIChild">Widget</a>:
9013
<a href="../files/widget-child_js_Widget-Child.js.html#l341"><code>widget-child/js/Widget-Child.js:341</code></a>
9023
<div class="description">
9024
<p>Synchronizes the UI to match the WidgetChild state.</p>
9027
This method is invoked after bindUI is invoked for the Widget class
9028
using YUI's aop infrastructure.
9040
<div id="method__uiSetChildSelected" class="method item protected inherited">
9041
<h3 class="name"><code>_uiSetChildSelected</code></h3>
9045
<span class="paren">(</span><ul class="args-list inline commas">
9049
<code>selected</code>
9053
</ul><span class="paren">)</span>
9062
<span class="flag protected">protected</span>
9075
<a href="../classes/Widget.html#method__uiSetChildSelected">Widget</a>:
9079
<a href="../files/widget-child_js_Widget-Child.js.html#l305"><code>widget-child/js/Widget-Child.js:305</code></a>
9089
<div class="description">
9090
<p>Updates the UI to reflect the <code>selected</code> attribute value.</p>
9094
<div class="params">
9095
<h4>Parameters:</h4>
9097
<ul class="params-list">
9101
<code class="param-name">selected</code>
9102
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
9107
<div class="param-description">
9108
<p>The selected value to be reflected in the UI.</p>
9124
<div id="method__uiSetDim" class="method item private inherited">
9125
<h3 class="name"><code>_uiSetDim</code></h3>
9129
<span class="paren">(</span><ul class="args-list inline commas">
9143
</ul><span class="paren">)</span>
9152
<span class="flag private">private</span>
9165
<a href="../classes/Widget.html#method__uiSetDim">Widget</a>:
9169
<a href="../files/widget_js_Widget.js.html#l984"><code>widget/js/Widget.js:984</code></a>
9179
<div class="description">
9184
<div class="params">
9185
<h4>Parameters:</h4>
9187
<ul class="params-list">
9191
<code class="param-name">dim</code>
9192
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9197
<div class="param-description">
9198
<p>The dimension - "width" or "height"</p>
9206
<code class="param-name">val</code>
9207
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9212
<div class="param-description">
9213
<p>The value to set</p>
9229
<div id="method__uiSetDisabled" class="method item protected inherited">
9230
<h3 class="name"><code>_uiSetDisabled</code></h3>
9234
<span class="paren">(</span><ul class="args-list inline commas">
9242
</ul><span class="paren">)</span>
9251
<span class="flag protected">protected</span>
9264
<a href="../classes/Widget.html#method__uiSetDisabled">Widget</a>:
9268
<a href="../files/widget_js_Widget.js.html#l1005"><code>widget/js/Widget.js:1005</code></a>
9278
<div class="description">
9279
<p>Sets the disabled state for the UI</p>
9283
<div class="params">
9284
<h4>Parameters:</h4>
9286
<ul class="params-list">
9290
<code class="param-name">val</code>
9291
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9296
<div class="param-description">
9313
<div id="method__uiSetFocused" class="method item protected inherited">
9314
<h3 class="name"><code>_uiSetFocused</code></h3>
9318
<span class="paren">(</span><ul class="args-list inline commas">
9332
</ul><span class="paren">)</span>
9341
<span class="flag protected">protected</span>
9354
<a href="../classes/Widget.html#method__uiSetFocused">Widget</a>:
9358
<a href="../files/widget_js_Widget.js.html#l1016"><code>widget/js/Widget.js:1016</code></a>
9368
<div class="description">
9369
<p>Sets the focused state for the UI</p>
9373
<div class="params">
9374
<h4>Parameters:</h4>
9376
<ul class="params-list">
9380
<code class="param-name">val</code>
9381
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9386
<div class="param-description">
9395
<code class="param-name">src</code>
9396
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
9401
<div class="param-description">
9402
<p>String representing the source that triggered an update to
9419
<div id="method__uiSetHeight" class="method item protected inherited">
9420
<h3 class="name"><code>_uiSetHeight</code></h3>
9424
<span class="paren">(</span><ul class="args-list inline commas">
9432
</ul><span class="paren">)</span>
9441
<span class="flag protected">protected</span>
9454
<a href="../classes/Widget.html#method__uiSetHeight">Widget</a>:
9458
<a href="../files/widget_js_Widget.js.html#l961"><code>widget/js/Widget.js:961</code></a>
9468
<div class="description">
9469
<p>Sets the height on the widget's bounding box element</p>
9473
<div class="params">
9474
<h4>Parameters:</h4>
9476
<ul class="params-list">
9480
<code class="param-name">val</code>
9481
<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/Number" class="crosslink external" target="_blank">Number</a></span>
9486
<div class="param-description">
9503
<div id="method__uiSetTabIndex" class="method item protected inherited">
9504
<h3 class="name"><code>_uiSetTabIndex</code></h3>
9508
<span class="paren">(</span><ul class="args-list inline commas">
9516
</ul><span class="paren">)</span>
9525
<span class="flag protected">protected</span>
9538
<a href="../classes/Widget.html#method__uiSetTabIndex">Widget</a>:
9542
<a href="../files/widget_js_Widget.js.html#l1038"><code>widget/js/Widget.js:1038</code></a>
9552
<div class="description">
9553
<p>Set the tabIndex on the widget's rendered UI</p>
9557
<div class="params">
9558
<h4>Parameters:</h4>
9560
<ul class="params-list">
9564
<code class="param-name">Number</code>
9565
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
9570
<div class="param-description">
9587
<div id="method__uiSetVisible" class="method item protected inherited">
9588
<h3 class="name"><code>_uiSetVisible</code></h3>
9592
<span class="paren">(</span><ul class="args-list inline commas">
9600
</ul><span class="paren">)</span>
9609
<span class="flag protected">protected</span>
9622
<a href="../classes/Widget.html#method__uiSetVisible">Widget</a>:
9626
<a href="../files/widget_js_Widget.js.html#l994"><code>widget/js/Widget.js:994</code></a>
9636
<div class="description">
9637
<p>Sets the visible state for the UI</p>
9641
<div class="params">
9642
<h4>Parameters:</h4>
9644
<ul class="params-list">
9648
<code class="param-name">val</code>
9649
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9654
<div class="param-description">
9671
<div id="method__uiSetWidth" class="method item protected inherited">
9672
<h3 class="name"><code>_uiSetWidth</code></h3>
9676
<span class="paren">(</span><ul class="args-list inline commas">
9684
</ul><span class="paren">)</span>
9693
<span class="flag protected">protected</span>
9706
<a href="../classes/Widget.html#method__uiSetWidth">Widget</a>:
9710
<a href="../files/widget_js_Widget.js.html#l973"><code>widget/js/Widget.js:973</code></a>
9720
<div class="description">
9721
<p>Sets the width on the widget's bounding box element</p>
9725
<div class="params">
9726
<h4>Parameters:</h4>
9728
<ul class="params-list">
9732
<code class="param-name">val</code>
9733
<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/Number" class="crosslink external" target="_blank">Number</a></span>
9738
<div class="param-description">
9755
<div id="method__uiSizeCB" class="method item protected inherited">
9756
<h3 class="name"><code>_uiSizeCB</code></h3>
9760
<span class="paren">(</span><ul class="args-list inline commas">
9768
</ul><span class="paren">)</span>
9777
<span class="flag protected">protected</span>
9790
<a href="../classes/Widget.html#method__uiSizeCB">Widget</a>:
9794
<a href="../files/widget_js_Widget.js.html#l702"><code>widget/js/Widget.js:702</code></a>
9804
<div class="description">
9809
<div class="params">
9810
<h4>Parameters:</h4>
9812
<ul class="params-list">
9816
<code class="param-name">expand</code>
9817
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
9822
<div class="param-description">
9839
<div id="method__unbindDOM" class="method item protected inherited">
9840
<h3 class="name"><code>_unbindDOM</code></h3>
9843
<span class="paren">()</span>
9851
<span class="flag protected">protected</span>
9864
<a href="../classes/Widget.html#method__unbindDOM">Widget</a>:
9868
<a href="../files/widget_js_Widget.js.html#l920"><code>widget/js/Widget.js:920</code></a>
9878
<div class="description">
9890
<div id="method__unbindUI" class="method item protected inherited">
9891
<h3 class="name"><code>_unbindUI</code></h3>
9894
<span class="paren">()</span>
9902
<span class="flag protected">protected</span>
9915
<a href="../classes/Widget.html#method__unbindUI">Widget</a>:
9919
<a href="../files/widget_js_Widget.js.html#l881"><code>widget/js/Widget.js:881</code></a>
9929
<div class="description">
9941
<div id="method__validTabIndex" class="method item protected inherited">
9942
<h3 class="name"><code>_validTabIndex</code></h3>
9946
<span class="paren">(</span><ul class="args-list inline commas">
9950
<code>tabIndex</code>
9954
</ul><span class="paren">)</span>
9963
<span class="flag protected">protected</span>
9976
<a href="../classes/Widget.html#method__validTabIndex">Widget</a>:
9980
<a href="../files/widget_js_Widget.js.html#l1148"><code>widget/js/Widget.js:1148</code></a>
9990
<div class="description">
9995
<div class="params">
9996
<h4>Parameters:</h4>
9998
<ul class="params-list">
10002
<code class="param-name">tabIndex</code>
10003
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
10008
<div class="param-description">
10025
<div id="method_addAttr" class="method item inherited">
10026
<h3 class="name"><code>addAttr</code></h3>
10030
<span class="paren">(</span><ul class="args-list inline commas">
10040
<code>config</code>
10050
</ul><span class="paren">)</span>
10055
<span class="returns-inline">
10056
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10069
<span class="flag chainable">chainable</span>
10076
<a href="../classes/AttributeCore.html#method_addAttr">AttributeCore</a>:
10080
<a href="../files/attribute_js_AttributeCore.js.html#l124"><code>attribute/js/AttributeCore.js:124</code></a>
10090
<div class="description">
10092
Adds an attribute with the provided configuration to the host object.
10096
The config argument object supports the following properties:
10100
<dt>value <Any></dt>
10101
<dd>The initial value to set on the attribute</dd>
10103
<dt>valueFn <Function | String></dt>
10105
<p>A function, which will return the initial value to set on the attribute. This is useful
10106
for cases where the attribute configuration is defined statically, but needs to
10107
reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined,
10108
the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which
10109
case the value property is used.</p>
10111
<p>valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.</p>
10114
<dt>readOnly <boolean></dt>
10115
<dd>Whether or not the attribute is read only. Attributes having readOnly set to true
10116
cannot be modified by invoking the set method.</dd>
10118
<dt>writeOnce <boolean> or <string></dt>
10120
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
10121
can only have their values set once, be it through the default configuration,
10122
constructor configuration arguments, or by invoking set.
10123
<p>The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization
10124
(when used with Base, this means it can only be set during construction)</p>
10127
<dt>setter <Function | String></dt>
10129
<p>The setter function used to massage or normalize the value passed to the set method for the attribute.
10130
The value returned by the setter will be the final stored value. Returning
10131
<a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, from the setter will prevent
10132
the value from being stored.
10135
<p>setter can also be set to a string, representing the name of the instance method to be used as the setter function.</p>
10138
<dt>getter <Function | String></dt>
10141
The getter function used to massage or normalize the value returned by the get method for the attribute.
10142
The value returned by the getter function is the value which will be returned to the user when they
10146
<p>getter can also be set to a string, representing the name of the instance method to be used as the getter function.</p>
10149
<dt>validator <Function | String></dt>
10152
The validator function invoked prior to setting the stored value. Returning
10153
false from the validator function will prevent the value from being stored.
10156
<p>validator can also be set to a string, representing the name of the instance method to be used as the validator function.</p>
10159
<dt>lazyAdd <boolean></dt>
10160
<dd>Whether or not to delay initialization of the attribute until the first call to get/set it.
10161
This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through
10162
the <a href="#method_addAttrs">addAttrs</a> method.</dd>
10166
<p>The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with
10167
the context ("this") set to the host object.</p>
10169
<p>Configuration properties outside of the list mentioned above are considered private properties used internally by attribute,
10170
and are not intended for public use.</p>
10174
<div class="params">
10175
<h4>Parameters:</h4>
10177
<ul class="params-list">
10181
<code class="param-name">name</code>
10182
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10187
<div class="param-description">
10188
<p>The name of the attribute.</p>
10196
<code class="param-name">config</code>
10197
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10202
<div class="param-description">
10203
<p>An object with attribute configuration property/value pairs, specifying the configuration for the attribute.</p>
10206
<strong>NOTE:</strong> The configuration object is modified when adding an attribute, so if you need
10207
to protect the original values, you will need to merge the object.
10216
<code class="param-name">lazy</code>
10217
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10222
<div class="param-description">
10223
<p>(optional) Whether or not to add this attribute lazily (on the first call to get/set).</p>
10234
<div class="returns">
10237
<div class="returns-description">
10240
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
10242
A reference to the host object.
10252
<div id="method_addAttrs" class="method item inherited">
10253
<h3 class="name"><code>addAttrs</code></h3>
10257
<span class="paren">(</span><ul class="args-list inline commas">
10267
<code>values</code>
10277
</ul><span class="paren">)</span>
10282
<span class="returns-inline">
10283
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10296
<span class="flag chainable">chainable</span>
10303
<a href="../classes/AttributeCore.html#method_addAttrs">AttributeCore</a>:
10307
<a href="../files/attribute_js_AttributeCore.js.html#l708"><code>attribute/js/AttributeCore.js:708</code></a>
10317
<div class="description">
10318
<p>Configures a group of attributes, and sets initial values.</p>
10321
<strong>NOTE:</strong> This method does not isolate the configuration object by merging/cloning.
10322
The caller is responsible for merging/cloning the configuration object if required.
10327
<div class="params">
10328
<h4>Parameters:</h4>
10330
<ul class="params-list">
10334
<code class="param-name">cfgs</code>
10335
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10340
<div class="param-description">
10341
<p>An object with attribute name/configuration pairs.</p>
10349
<code class="param-name">values</code>
10350
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10355
<div class="param-description">
10356
<p>An object with attribute name/value pairs, defining the initial values to apply.
10357
Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.</p>
10365
<code class="param-name">lazy</code>
10366
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10371
<div class="param-description">
10372
<p>Whether or not to delay the intialization of these attributes until the first call to get/set.
10373
Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.
10374
See <a href="#method_addAttr">addAttr</a>.</p>
10385
<div class="returns">
10388
<div class="returns-description">
10391
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
10393
A reference to the host object.
10403
<div id="method_addTarget" class="method item inherited">
10404
<h3 class="name"><code>addTarget</code></h3>
10408
<span class="paren">(</span><ul class="args-list inline commas">
10416
</ul><span class="paren">)</span>
10436
<a href="../classes/EventTarget.html#method_addTarget">EventTarget</a>:
10440
<a href="../files/event-custom_js_event-facade.js.html#l382"><code>event-custom/js/event-facade.js:382</code></a>
10450
<div class="description">
10451
<p>Registers another EventTarget as a bubble target. Bubble order
10452
is determined by the order registered. Multiple targets can
10455
<p>Events can only bubble if emitFacade is true.</p>
10457
<p>Included in the event-custom-complex submodule.</p>
10461
<div class="params">
10462
<h4>Parameters:</h4>
10464
<ul class="params-list">
10468
<code class="param-name">o</code>
10469
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
10474
<div class="param-description">
10475
<p>the target to add</p>
10491
<div id="method_after" class="method item inherited">
10492
<h3 class="name"><code>after</code></h3>
10496
<span class="paren">(</span><ul class="args-list inline commas">
10512
<code class="optional">[context]</code>
10518
<code class="optional">[arg*]</code>
10522
</ul><span class="paren">)</span>
10527
<span class="returns-inline">
10528
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
10546
<a href="../classes/EventTarget.html#method_after">EventTarget</a>:
10550
<a href="../files/event-custom_js_event-target.js.html#l730"><code>event-custom/js/event-target.js:730</code></a>
10560
<div class="description">
10561
<p>Subscribe to a custom event hosted by this object. The
10562
supplied callback will execute after any listeners add
10563
via the subscribe method, and after the default function,
10564
if configured for the event, has executed.</p>
10568
<div class="params">
10569
<h4>Parameters:</h4>
10571
<ul class="params-list">
10575
<code class="param-name">type</code>
10576
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10581
<div class="param-description">
10582
<p>The name of the event</p>
10590
<code class="param-name">fn</code>
10591
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
10596
<div class="param-description">
10597
<p>The callback to execute in response to the event</p>
10605
<code class="param-name optional">[context]</code>
10606
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
10607
<span class="flag optional" title="This parameter is optional.">optional</span>
10612
<div class="param-description">
10613
<p>Override <code>this</code> object in callback</p>
10621
<code class="param-name optional">[arg*]</code>
10622
<span class="type">Any</span>
10623
<span class="flag optional" title="This parameter is optional.">optional</span>
10628
<div class="param-description">
10629
<p>0..n additional arguments to supply to the subscriber</p>
10640
<div class="returns">
10643
<div class="returns-description">
10646
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
10648
A subscription handle capable of detaching the
10659
<div id="method_ancestor" class="method item inherited">
10660
<h3 class="name"><code>ancestor</code></h3>
10664
<span class="paren">(</span><ul class="args-list inline commas">
10672
</ul><span class="paren">)</span>
10677
<span class="returns-inline">
10678
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
10696
<a href="../classes/Widget.html#method_ancestor">Widget</a>:
10700
<a href="../files/widget-child_js_Widget-Child.js.html#l279"><code>widget-child/js/Widget-Child.js:279</code></a>
10710
<div class="description">
10711
<p>Returns the Widget instance at the specified depth.</p>
10715
<div class="params">
10716
<h4>Parameters:</h4>
10718
<ul class="params-list">
10722
<code class="param-name">depth</code>
10723
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
10728
<div class="param-description">
10729
<p>Number representing the depth of the ancestor.</p>
10740
<div class="returns">
10743
<div class="returns-description">
10746
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
10758
<div id="method_attrAdded" class="method item inherited">
10759
<h3 class="name"><code>attrAdded</code></h3>
10763
<span class="paren">(</span><ul class="args-list inline commas">
10771
</ul><span class="paren">)</span>
10776
<span class="returns-inline">
10777
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
10795
<a href="../classes/AttributeCore.html#method_attrAdded">AttributeCore</a>:
10799
<a href="../files/attribute_js_AttributeCore.js.html#l272"><code>attribute/js/AttributeCore.js:272</code></a>
10809
<div class="description">
10810
<p>Checks if the given attribute has been added to the host</p>
10814
<div class="params">
10815
<h4>Parameters:</h4>
10817
<ul class="params-list">
10821
<code class="param-name">name</code>
10822
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
10827
<div class="param-description">
10828
<p>The name of the attribute to check.</p>
10839
<div class="returns">
10842
<div class="returns-description">
10845
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
10847
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.
10857
<div id="method_before" class="method item inherited">
10858
<h3 class="name"><code>before</code></h3>
10861
<span class="paren">()</span>
10865
<span class="returns-inline">
10866
<span class="type"></span>
10884
<a href="../classes/EventTarget.html#method_before">EventTarget</a>:
10888
<a href="../files/event-custom_js_event-target.js.html#l767"><code>event-custom/js/event-target.js:767</code></a>
10898
<div class="description">
10899
<p>Executes the callback before a DOM event, custom event
10900
or method. If the first argument is a function, it
10901
is assumed the target is a method. For DOM and custom
10902
events, this is an alias for Y.on.</p>
10904
<p>For DOM and custom events:
10905
type, callback, context, 0-n arguments</p>
10908
callback, object (method host), methodName, context, 0-n arguments</p>
10914
<div class="returns">
10917
<div class="returns-description">
10930
<div id="method_bindUI" class="method item protected inherited">
10931
<h3 class="name"><code>bindUI</code></h3>
10934
<span class="paren">()</span>
10942
<span class="flag protected">protected</span>
10955
<a href="../classes/Widget.html#method_bindUI">Widget</a>:
10959
<a href="../files/widget_js_Widget.js.html#l612"><code>widget/js/Widget.js:612</code></a>
10969
<div class="description">
10970
<p>Configures/Sets up listeners to bind Widget State to UI/DOM</p>
10972
<p>This method is not called by framework and is not chained
10973
automatically for the class hierarchy.</p>
10984
<div id="method_blur" class="method item inherited">
10985
<h3 class="name"><code>blur</code></h3>
10988
<span class="paren">()</span>
11002
<span class="flag chainable">chainable</span>
11009
<a href="../classes/Widget.html#method_blur">Widget</a>:
11013
<a href="../files/widget_js_Widget.js.html#l674"><code>widget/js/Widget.js:674</code></a>
11023
<div class="description">
11024
<p>Causes the Widget to lose focus by setting the "focused" attribute
11036
<div id="method_bubble" class="method item inherited">
11037
<h3 class="name"><code>bubble</code></h3>
11041
<span class="paren">(</span><ul class="args-list inline commas">
11049
</ul><span class="paren">)</span>
11054
<span class="returns-inline">
11055
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
11073
<a href="../classes/EventTarget.html#method_bubble">EventTarget</a>:
11077
<a href="../files/event-custom_js_event-facade.js.html#l419"><code>event-custom/js/event-facade.js:419</code></a>
11087
<div class="description">
11088
<p>Propagate an event. Requires the event-custom-complex module.</p>
11092
<div class="params">
11093
<h4>Parameters:</h4>
11095
<ul class="params-list">
11099
<code class="param-name">evt</code>
11100
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
11105
<div class="param-description">
11106
<p>the custom event to propagate</p>
11117
<div class="returns">
11120
<div class="returns-description">
11123
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
11125
the aggregated return value from Event.Custom.fire
11135
<div id="method_destroy" class="method item inherited">
11136
<h3 class="name"><code>destroy</code></h3>
11140
<span class="paren">(</span><ul class="args-list inline commas">
11144
<code>destroyAllNodes</code>
11148
</ul><span class="paren">)</span>
11153
<span class="returns-inline">
11154
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
11167
<span class="flag chainable">chainable</span>
11173
<a href="../classes/BaseCore.html#method_destroy">
11181
<a href="../files/widget_js_Widget.js.html#l455"><code>widget/js/Widget.js:455</code></a>
11191
<div class="description">
11193
Destroy lifecycle method. Fires the destroy
11194
event, prior to invoking destructors for the
11197
Overrides Base's implementation, to support arguments to destroy
11201
Subscribers to the destroy
11202
event can invoke preventDefault on the event object, to prevent destruction
11208
<div class="params">
11209
<h4>Parameters:</h4>
11211
<ul class="params-list">
11215
<code class="param-name">destroyAllNodes</code>
11216
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
11221
<div class="param-description">
11222
<p>If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.</p>
11233
<div class="returns">
11236
<div class="returns-description">
11239
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
11241
A reference to this object
11251
<div id="method_destructor" class="method item protected inherited">
11252
<h3 class="name"><code>destructor</code></h3>
11255
<span class="paren">()</span>
11263
<span class="flag protected">protected</span>
11276
<a href="../classes/Widget.html#method_destructor">Widget</a>:
11280
<a href="../files/widget_js_Widget.js.html#l430"><code>widget/js/Widget.js:430</code></a>
11290
<div class="description">
11291
<p>Destructor lifecycle implementation for the Widget class. Purges events attached
11292
to the bounding box and content box, removes them from the DOM and removes
11293
the Widget from the list of registered widgets.</p>
11304
<div id="method_detach" class="method item inherited">
11305
<h3 class="name"><code>detach</code></h3>
11309
<span class="paren">(</span><ul class="args-list inline commas">
11325
<code>context</code>
11329
</ul><span class="paren">)</span>
11334
<span class="returns-inline">
11335
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
11353
<a href="../classes/EventTarget.html#method_detach">EventTarget</a>:
11357
<a href="../files/event-custom_js_event-target.js.html#l345"><code>event-custom/js/event-target.js:345</code></a>
11367
<div class="description">
11368
<p>Detach one or more listeners the from the specified event</p>
11372
<div class="params">
11373
<h4>Parameters:</h4>
11375
<ul class="params-list">
11379
<code class="param-name">type</code>
11380
<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>
11385
<div class="param-description">
11386
<p>Either the handle to the subscriber or the
11387
type of event. If the type
11388
is not specified, it will attempt to remove
11389
the listener from all hosted events.</p>
11397
<code class="param-name">fn</code>
11398
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
11403
<div class="param-description">
11404
<p>The subscribed function to unsubscribe, if not
11405
supplied, all subscribers will be removed.</p>
11413
<code class="param-name">context</code>
11414
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
11419
<div class="param-description">
11420
<p>The custom object passed to subscribe. This is
11421
optional, but if supplied will be used to
11422
disambiguate multiple listeners that are the same
11423
(e.g., you subscribe many object using a function
11424
that lives on the prototype)</p>
11435
<div class="returns">
11438
<div class="returns-description">
11441
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
11453
<div id="method_detachAll" class="method item inherited">
11454
<h3 class="name"><code>detachAll</code></h3>
11458
<span class="paren">(</span><ul class="args-list inline commas">
11466
</ul><span class="paren">)</span>
11486
<a href="../classes/EventTarget.html#method_detachAll">EventTarget</a>:
11490
<a href="../files/event-custom_js_event-target.js.html#l465"><code>event-custom/js/event-target.js:465</code></a>
11500
<div class="description">
11501
<p>Removes all listeners from the specified event. If the event type
11502
is not specified, all listeners from all hosted custom events will
11507
<div class="params">
11508
<h4>Parameters:</h4>
11510
<ul class="params-list">
11514
<code class="param-name">type</code>
11515
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11520
<div class="param-description">
11521
<p>The type, or name of the event</p>
11537
<div id="method_disable" class="method item inherited">
11538
<h3 class="name"><code>disable</code></h3>
11541
<span class="paren">()</span>
11555
<span class="flag chainable">chainable</span>
11562
<a href="../classes/Widget.html#method_disable">Widget</a>:
11566
<a href="../files/widget_js_Widget.js.html#l693"><code>widget/js/Widget.js:693</code></a>
11576
<div class="description">
11577
<p>Set the Widget's "disabled" attribute to "true".</p>
11588
<div id="method_enable" class="method item inherited">
11589
<h3 class="name"><code>enable</code></h3>
11592
<span class="paren">()</span>
11606
<span class="flag chainable">chainable</span>
11613
<a href="../classes/Widget.html#method_enable">Widget</a>:
11617
<a href="../files/widget_js_Widget.js.html#l684"><code>widget/js/Widget.js:684</code></a>
11627
<div class="description">
11628
<p>Set the Widget's "disabled" attribute to "false".</p>
11639
<div id="method_fire" class="method item inherited">
11640
<h3 class="name"><code>fire</code></h3>
11644
<span class="paren">(</span><ul class="args-list inline commas">
11654
<code>arguments</code>
11658
</ul><span class="paren">)</span>
11663
<span class="returns-inline">
11664
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
11682
<a href="../classes/EventTarget.html#method_fire">EventTarget</a>:
11686
<a href="../files/event-custom_js_event-target.js.html#l629"><code>event-custom/js/event-target.js:629</code></a>
11696
<div class="description">
11697
<p>Fire a custom event by name. The callback functions will be executed
11698
from the context specified when the event was created, and with the
11699
following parameters.</p>
11701
<p>If the custom event object hasn't been created, then the event hasn't
11702
been published and it has no subscribers. For performance sake, we
11703
immediate exit in this case. This means the event won't bubble, so
11704
if the intention is that a bubble target be notified, the event must
11705
be published on this object first.</p>
11707
<p>The first argument is the event type, and any additional arguments are
11708
passed to the listeners as parameters. If the first of these is an
11709
object literal, and the event is configured to emit an event facade,
11710
that object is mixed into the event facade and the facade is provided
11711
in place of the original object.</p>
11715
<div class="params">
11716
<h4>Parameters:</h4>
11718
<ul class="params-list">
11722
<code class="param-name">type</code>
11723
<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>
11728
<div class="param-description">
11729
<p>The type of the event, or an object that contains
11730
a 'type' property.</p>
11738
<code class="param-name">arguments</code>
11739
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object*</a></span>
11744
<div class="param-description">
11745
<p>an arbitrary set of parameters to pass to
11746
the handler. If the first of these is an object literal and the event is
11747
configured to emit an event facade, the event facade will replace that
11748
parameter after the properties the object literal contains are copied to
11749
the event facade.</p>
11760
<div class="returns">
11763
<div class="returns-description">
11766
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
11778
<div id="method_focus" class="method item inherited">
11779
<h3 class="name"><code>focus</code></h3>
11782
<span class="paren">()</span>
11796
<span class="flag chainable">chainable</span>
11803
<a href="../classes/Widget.html#method_focus">Widget</a>:
11807
<a href="../files/widget_js_Widget.js.html#l664"><code>widget/js/Widget.js:664</code></a>
11817
<div class="description">
11818
<p>Causes the Widget to receive the focus by setting the "focused"
11819
attribute to "true".</p>
11830
<div id="method_get" class="method item inherited">
11831
<h3 class="name"><code>get</code></h3>
11835
<span class="paren">(</span><ul class="args-list inline commas">
11843
</ul><span class="paren">)</span>
11848
<span class="returns-inline">
11849
<span class="type">Any</span>
11867
<a href="../classes/AttributeCore.html#method_get">AttributeCore</a>:
11871
<a href="../files/attribute_js_AttributeCore.js.html#l283"><code>attribute/js/AttributeCore.js:283</code></a>
11881
<div class="description">
11882
<p>Returns the current value of the attribute. If the attribute
11883
has been configured with a 'getter' function, this method will delegate
11884
to the 'getter' to obtain the value of the attribute.</p>
11888
<div class="params">
11889
<h4>Parameters:</h4>
11891
<ul class="params-list">
11895
<code class="param-name">name</code>
11896
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
11901
<div class="param-description">
11902
<p>The name of the attribute. If the value of the attribute is an Object,
11903
dot notation can be used to obtain the value of a property of the object (e.g. <code>get("x.y.z")</code>)</p>
11914
<div class="returns">
11917
<div class="returns-description">
11920
<span class="type">Any</span>:
11922
The value of the attribute
11932
<div id="method_getAttrs" class="method item inherited">
11933
<h3 class="name"><code>getAttrs</code></h3>
11937
<span class="paren">(</span><ul class="args-list inline commas">
11945
</ul><span class="paren">)</span>
11950
<span class="returns-inline">
11951
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
11969
<a href="../classes/AttributeCore.html#method_getAttrs">AttributeCore</a>:
11973
<a href="../files/attribute_js_AttributeCore.js.html#l665"><code>attribute/js/AttributeCore.js:665</code></a>
11983
<div class="description">
11984
<p>Gets multiple attribute values.</p>
11988
<div class="params">
11989
<h4>Parameters:</h4>
11991
<ul class="params-list">
11995
<code class="param-name">attrs</code>
11996
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | boolean</span>
12001
<div class="param-description">
12002
<p>Optional. An array of attribute names. If omitted, all attribute values are
12003
returned. If set to true, all attributes modified from their initial values are returned.</p>
12014
<div class="returns">
12017
<div class="returns-description">
12020
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
12022
An object with attribute name/value pairs.
12032
<div id="method_getClassName" class="method item inherited">
12033
<h3 class="name"><code>getClassName</code></h3>
12037
<span class="paren">(</span><ul class="args-list inline commas">
12045
</ul><span class="paren">)</span>
12064
<a href="../classes/Widget.html#method_getClassName">
12072
<a href="../files/widget_js_Widget.js.html#l309"><code>widget/js/Widget.js:309</code></a>
12082
<div class="description">
12083
<p>Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
12084
by the <code>Y.config.classNamePrefix</code> attribute used by <code>ClassNameManager</code> and
12085
<code>Widget.NAME.toLowerCase()</code> (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
12086
the prefix and widget class name).</p>
12089
The instance based version of this method can be used to generate standard prefixed classnames,
12090
based on the instances NAME, as opposed to Widget.NAME. This method should be used when you
12091
need to use a constant class name across different types instances.
12096
<div class="params">
12097
<h4>Parameters:</h4>
12099
<ul class="params-list">
12103
<code class="param-name">args</code>
12104
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String*</a></span>
12108
<span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
12111
<div class="param-description">
12112
<p>0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name</p>
12128
<div id="method_getDefaultLocale" class="method item inherited">
12129
<h3 class="name"><code>getDefaultLocale</code></h3>
12132
<span class="paren">()</span>
12136
<span class="returns-inline">
12137
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12155
<a href="../classes/Widget.html#method_getDefaultLocale">Widget</a>:
12159
<a href="../files/widget_js_WidgetLocale.js.html#l150"><code>widget/js/WidgetLocale.js:150</code></a>
12169
<div class="description">
12170
<p>Returns the default locale for the widget (the locale value defined by the
12171
widget class, or provided by the user during construction).</p>
12177
<div class="returns">
12180
<div class="returns-description">
12183
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
12185
The default locale for the widget
12195
<div id="method_getEvent" class="method item inherited">
12196
<h3 class="name"><code>getEvent</code></h3>
12200
<span class="paren">(</span><ul class="args-list inline commas">
12210
<code>prefixed</code>
12214
</ul><span class="paren">)</span>
12219
<span class="returns-inline">
12220
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
12238
<a href="../classes/EventTarget.html#method_getEvent">EventTarget</a>:
12242
<a href="../files/event-custom_js_event-target.js.html#l712"><code>event-custom/js/event-target.js:712</code></a>
12252
<div class="description">
12253
<p>Returns the custom event of the provided type has been created, a
12254
falsy value otherwise</p>
12258
<div class="params">
12259
<h4>Parameters:</h4>
12261
<ul class="params-list">
12265
<code class="param-name">type</code>
12266
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12271
<div class="param-description">
12272
<p>the type, or name of the event</p>
12280
<code class="param-name">prefixed</code>
12281
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12286
<div class="param-description">
12287
<p>if true, the type is prefixed already</p>
12298
<div class="returns">
12301
<div class="returns-description">
12304
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
12306
the custom event or null
12316
<div id="method_getSkinName" class="method item inherited">
12317
<h3 class="name"><code>getSkinName</code></h3>
12320
<span class="paren">()</span>
12324
<span class="returns-inline">
12325
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12343
<a href="../classes/Widget.html#method_getSkinName">Widget</a>:
12347
<a href="../files/widget_js_WidgetSkin.js.html#l13"><code>widget/js/WidgetSkin.js:13</code></a>
12357
<div class="description">
12358
<p>Returns the name of the skin that's currently applied to the widget.
12359
This is only really useful after the widget's DOM structure is in the
12360
document, either by render or by progressive enhancement. Searches up
12361
the Widget's ancestor axis for a class yui3-skin-(name), and returns the
12362
(name) portion. Otherwise, returns null.</p>
12368
<div class="returns">
12371
<div class="returns-description">
12374
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
12376
the name of the skin, or null (yui3-skin-sam => sam)
12386
<div id="method_getString" class="method item deprecated inherited">
12387
<h3 class="name"><code>getString</code></h3>
12391
<span class="paren">(</span><ul class="args-list inline commas">
12399
</ul><span class="paren">)</span>
12404
<span class="returns-inline">
12405
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12410
<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
12424
<a href="../classes/Widget.html#method_getString">
12432
<a href="../files/widget_js_Widget.js.html#l1212"><code>widget/js/Widget.js:1212</code></a>
12438
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
12444
<div class="description">
12445
<p>Helper method to get a specific string value</p>
12449
<div class="params">
12450
<h4>Parameters:</h4>
12452
<ul class="params-list">
12456
<code class="param-name">key</code>
12457
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12462
<div class="param-description">
12474
<div class="returns">
12477
<div class="returns-description">
12480
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
12492
<div id="method_getStrings" class="method item deprecated inherited">
12493
<h3 class="name"><code>getStrings</code></h3>
12497
<span class="paren">(</span><ul class="args-list inline commas">
12505
</ul><span class="paren">)</span>
12510
<span class="returns-inline">
12511
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12516
<span class="flag deprecated" title="Used by deprecated WidgetLocale implementations.">deprecated</span>
12530
<a href="../classes/Widget.html#method_getStrings">
12538
<a href="../files/widget_js_Widget.js.html#l1224"><code>widget/js/Widget.js:1224</code></a>
12544
<p>Deprecated: Used by deprecated WidgetLocale implementations.</p>
12550
<div class="description">
12551
<p>Helper method to get the complete set of strings for the widget</p>
12555
<div class="params">
12556
<h4>Parameters:</h4>
12558
<ul class="params-list">
12562
<code class="param-name">key</code>
12563
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
12568
<div class="param-description">
12580
<div class="returns">
12583
<div class="returns-description">
12586
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
12598
<div id="method_getTargets" class="method item inherited">
12599
<h3 class="name"><code>getTargets</code></h3>
12602
<span class="paren">()</span>
12606
<span class="returns-inline">
12607
<span class="type"></span>
12625
<a href="../classes/EventTarget.html#method_getTargets">EventTarget</a>:
12629
<a href="../files/event-custom_js_event-facade.js.html#l400"><code>event-custom/js/event-facade.js:400</code></a>
12639
<div class="description">
12640
<p>Returns an array of bubble targets for this object.</p>
12646
<div class="returns">
12649
<div class="returns-description">
12662
<div id="method_hide" class="method item inherited">
12663
<h3 class="name"><code>hide</code></h3>
12666
<span class="paren">()</span>
12680
<span class="flag chainable">chainable</span>
12687
<a href="../classes/Widget.html#method_hide">Widget</a>:
12691
<a href="../files/widget_js_Widget.js.html#l646"><code>widget/js/Widget.js:646</code></a>
12701
<div class="description">
12702
<p>Hides the Widget by setting the "visible" attribute to "false".</p>
12713
<div id="method_init" class="method item inherited">
12714
<h3 class="name"><code>init</code></h3>
12718
<span class="paren">(</span><ul class="args-list inline commas">
12722
<code>config</code>
12726
</ul><span class="paren">)</span>
12731
<span class="returns-inline">
12732
<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>
12745
<span class="flag chainable">chainable</span>
12751
<a href="../classes/BaseCore.html#method_init">
12759
<a href="../files/base_js_Base.js.html#l191"><code>base/js/Base.js:191</code></a>
12769
<div class="description">
12770
<p>Init lifecycle method, invoked during construction.
12771
Fires the init event prior to setting up attributes and
12772
invoking initializers for the class hierarchy.</p>
12776
<div class="params">
12777
<h4>Parameters:</h4>
12779
<ul class="params-list">
12783
<code class="param-name">config</code>
12784
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
12789
<div class="param-description">
12790
<p>Object with configuration property name/value pairs</p>
12801
<div class="returns">
12804
<div class="returns-description">
12807
<span class="type"><a href="../classes/Base.html" class="crosslink">Base</a></span>:
12809
A reference to this object
12819
<div id="method_initializer" class="method item protected inherited">
12820
<h3 class="name"><code>initializer</code></h3>
12824
<span class="paren">(</span><ul class="args-list inline commas">
12828
<code>config</code>
12832
</ul><span class="paren">)</span>
12841
<span class="flag protected">protected</span>
12854
<a href="../classes/Widget.html#method_initializer">Widget</a>:
12858
<a href="../files/widget_js_Widget.js.html#l382"><code>widget/js/Widget.js:382</code></a>
12868
<div class="description">
12869
<p>Initializer lifecycle implementation for the Widget class. Registers the
12870
widget instance, and runs through the Widget's HTML_PARSER definition.</p>
12874
<div class="params">
12875
<h4>Parameters:</h4>
12877
<ul class="params-list">
12881
<code class="param-name">config</code>
12882
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
12887
<div class="param-description">
12888
<p>Configuration object literal for the widget</p>
12904
<div id="method_isRoot" class="method item inherited">
12905
<h3 class="name"><code>isRoot</code></h3>
12908
<span class="paren">()</span>
12912
<span class="returns-inline">
12913
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
12931
<a href="../classes/Widget.html#method_isRoot">Widget</a>:
12935
<a href="../files/widget-child_js_Widget-Child.js.html#l267"><code>widget-child/js/Widget-Child.js:267</code></a>
12945
<div class="description">
12946
<p>Determines if the Widget is the root Widget in the
12947
object hierarchy.</p>
12953
<div class="returns">
12956
<div class="returns-description">
12959
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
12961
Boolean indicating if Widget is the root Widget in the
12972
<div id="method_modifyAttr" class="method item inherited">
12973
<h3 class="name"><code>modifyAttr</code></h3>
12977
<span class="paren">(</span><ul class="args-list inline commas">
12987
<code>config</code>
12991
</ul><span class="paren">)</span>
13011
<a href="../classes/AttributeExtras.html#method_modifyAttr">AttributeExtras</a>:
13015
<a href="../files/attribute_js_AttributeExtras.js.html#l39"><code>attribute/js/AttributeExtras.js:39</code></a>
13025
<div class="description">
13026
<p>Updates the configuration of an attribute which has already been added.</p>
13029
The properties which can be modified through this interface are limited
13030
to the following subset of attributes, which can be safely modified
13031
after a value has already been set on the attribute: readOnly, writeOnce,
13032
broadcast and getter.
13037
<div class="params">
13038
<h4>Parameters:</h4>
13040
<ul class="params-list">
13044
<code class="param-name">name</code>
13045
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13050
<div class="param-description">
13051
<p>The name of the attribute whose configuration is to be updated.</p>
13059
<code class="param-name">config</code>
13060
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13065
<div class="param-description">
13066
<p>An object with configuration property/value pairs, specifying the configuration properties to modify.</p>
13082
<div id="method_next" class="method item inherited">
13083
<h3 class="name"><code>next</code></h3>
13087
<span class="paren">(</span><ul class="args-list inline commas">
13091
<code>circular</code>
13095
</ul><span class="paren">)</span>
13100
<span class="returns-inline">
13101
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
13119
<a href="../classes/Widget.html#method_next">Widget</a>:
13123
<a href="../files/widget-child_js_Widget-Child.js.html#l191"><code>widget-child/js/Widget-Child.js:191</code></a>
13133
<div class="description">
13134
<p>Returns the Widget's next sibling.</p>
13138
<div class="params">
13139
<h4>Parameters:</h4>
13141
<ul class="params-list">
13145
<code class="param-name">circular</code>
13146
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
13151
<div class="param-description">
13152
<p>Boolean indicating if the parent's first child
13153
should be returned if the child has no next sibling.</p>
13164
<div class="returns">
13167
<div class="returns-description">
13170
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
13182
<div id="method_on" class="method item inherited">
13183
<h3 class="name"><code>on</code></h3>
13187
<span class="paren">(</span><ul class="args-list inline commas">
13203
<code class="optional">[context]</code>
13209
<code class="optional">[arg*]</code>
13213
</ul><span class="paren">)</span>
13218
<span class="returns-inline">
13219
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13237
<a href="../classes/EventTarget.html#method_on">EventTarget</a>:
13241
<a href="../files/event-custom_js_event-target.js.html#l192"><code>event-custom/js/event-target.js:192</code></a>
13251
<div class="description">
13252
<p>Subscribe a callback function to a custom event fired by this object or
13253
from an object that bubbles its events to this object.</p>
13255
<p>Callback functions for events published with <code>emitFacade = true</code> will
13256
receive an <code>EventFacade</code> as the first argument (typically named "e").
13257
These callbacks can then call <code>e.preventDefault()</code> to disable the
13258
behavior published to that event's <code>defaultFn</code>. See the <code>EventFacade</code>
13259
API for all available properties and methods. Subscribers to
13260
non-<code>emitFacade</code> events will receive the arguments passed to <code>fire()</code>
13261
after the event name.</p>
13263
<p>To subscribe to multiple events at once, pass an object as the first
13264
argument, where the key:value pairs correspond to the eventName:callback,
13265
or pass an array of event names as the first argument to subscribe to
13266
all listed events with the same callback.</p>
13268
<p>Returning <code>false</code> from a callback is supported as an alternative to
13269
calling <code>e.preventDefault(); e.stopPropagation();</code>. However, it is
13270
recommended to use the event methods whenever possible.</p>
13274
<div class="params">
13275
<h4>Parameters:</h4>
13277
<ul class="params-list">
13281
<code class="param-name">type</code>
13282
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13287
<div class="param-description">
13288
<p>The name of the event</p>
13296
<code class="param-name">fn</code>
13297
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13302
<div class="param-description">
13303
<p>The callback to execute in response to the event</p>
13311
<code class="param-name optional">[context]</code>
13312
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13313
<span class="flag optional" title="This parameter is optional.">optional</span>
13318
<div class="param-description">
13319
<p>Override <code>this</code> object in callback</p>
13327
<code class="param-name optional">[arg*]</code>
13328
<span class="type">Any</span>
13329
<span class="flag optional" title="This parameter is optional.">optional</span>
13334
<div class="param-description">
13335
<p>0..n additional arguments to supply to the subscriber</p>
13346
<div class="returns">
13349
<div class="returns-description">
13352
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13354
A subscription handle capable of detaching that
13365
<div id="method_once" class="method item inherited">
13366
<h3 class="name"><code>once</code></h3>
13370
<span class="paren">(</span><ul class="args-list inline commas">
13386
<code class="optional">[context]</code>
13392
<code class="optional">[arg*]</code>
13396
</ul><span class="paren">)</span>
13401
<span class="returns-inline">
13402
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13420
<a href="../classes/EventTarget.html#method_once">EventTarget</a>:
13424
<a href="../files/event-custom_js_event-target.js.html#l128"><code>event-custom/js/event-target.js:128</code></a>
13434
<div class="description">
13435
<p>Listen to a custom event hosted by this object one time.
13436
This is the equivalent to <code>on</code> except the
13437
listener is immediatelly detached when it is executed.</p>
13441
<div class="params">
13442
<h4>Parameters:</h4>
13444
<ul class="params-list">
13448
<code class="param-name">type</code>
13449
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13454
<div class="param-description">
13455
<p>The name of the event</p>
13463
<code class="param-name">fn</code>
13464
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13469
<div class="param-description">
13470
<p>The callback to execute in response to the event</p>
13478
<code class="param-name optional">[context]</code>
13479
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13480
<span class="flag optional" title="This parameter is optional.">optional</span>
13485
<div class="param-description">
13486
<p>Override <code>this</code> object in callback</p>
13494
<code class="param-name optional">[arg*]</code>
13495
<span class="type">Any</span>
13496
<span class="flag optional" title="This parameter is optional.">optional</span>
13501
<div class="param-description">
13502
<p>0..n additional arguments to supply to the subscriber</p>
13513
<div class="returns">
13516
<div class="returns-description">
13519
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13521
A subscription handle capable of detaching the
13532
<div id="method_onceAfter" class="method item inherited">
13533
<h3 class="name"><code>onceAfter</code></h3>
13537
<span class="paren">(</span><ul class="args-list inline commas">
13553
<code class="optional">[context]</code>
13559
<code class="optional">[arg*]</code>
13563
</ul><span class="paren">)</span>
13568
<span class="returns-inline">
13569
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
13587
<a href="../classes/EventTarget.html#method_onceAfter">EventTarget</a>:
13591
<a href="../files/event-custom_js_event-target.js.html#l150"><code>event-custom/js/event-target.js:150</code></a>
13601
<div class="description">
13602
<p>Listen to a custom event hosted by this object one time.
13603
This is the equivalent to <code>after</code> except the
13604
listener is immediatelly detached when it is executed.</p>
13608
<div class="params">
13609
<h4>Parameters:</h4>
13611
<ul class="params-list">
13615
<code class="param-name">type</code>
13616
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13621
<div class="param-description">
13622
<p>The name of the event</p>
13630
<code class="param-name">fn</code>
13631
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
13636
<div class="param-description">
13637
<p>The callback to execute in response to the event</p>
13645
<code class="param-name optional">[context]</code>
13646
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
13647
<span class="flag optional" title="This parameter is optional.">optional</span>
13652
<div class="param-description">
13653
<p>Override <code>this</code> object in callback</p>
13661
<code class="param-name optional">[arg*]</code>
13662
<span class="type">Any</span>
13663
<span class="flag optional" title="This parameter is optional.">optional</span>
13668
<div class="param-description">
13669
<p>0..n additional arguments to supply to the subscriber</p>
13680
<div class="returns">
13683
<div class="returns-description">
13686
<span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
13688
A subscription handle capable of detaching that
13699
<div id="method_parseType" class="method item inherited">
13700
<h3 class="name"><code>parseType</code></h3>
13704
<span class="paren">(</span><ul class="args-list inline commas">
13714
<code class="optional">[pre=this._yuievt.config.prefix]</code>
13718
</ul><span class="paren">)</span>
13723
<span class="returns-inline">
13724
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
13742
<a href="../classes/EventTarget.html#method_parseType">EventTarget</a>:
13746
<a href="../files/event-custom_js_event-target.js.html#l172"><code>event-custom/js/event-target.js:172</code></a>
13754
<p>Available since 3.3.0</p>
13758
<div class="description">
13759
<p>Takes the type parameter passed to 'on' and parses out the
13760
various pieces that could be included in the type. If the
13761
event type is passed without a prefix, it will be expanded
13762
to include the prefix one is supplied or the event target
13763
is configured with a default prefix.</p>
13767
<div class="params">
13768
<h4>Parameters:</h4>
13770
<ul class="params-list">
13774
<code class="param-name">type</code>
13775
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13780
<div class="param-description">
13789
<code class="param-name optional">[pre=this._yuievt.config.prefix]</code>
13790
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
13791
<span class="flag optional" title="This parameter is optional.">optional</span>
13796
<div class="param-description">
13808
<div class="returns">
13811
<div class="returns-description">
13814
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
13816
an array containing:
13817
* the detach category, if supplied,
13818
* the prefixed event type,
13819
* whether or not this is an after listener,
13820
* the supplied event type
13830
<div id="method_previous" class="method item inherited">
13831
<h3 class="name"><code>previous</code></h3>
13835
<span class="paren">(</span><ul class="args-list inline commas">
13839
<code>circular</code>
13843
</ul><span class="paren">)</span>
13848
<span class="returns-inline">
13849
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>
13867
<a href="../classes/Widget.html#method_previous">Widget</a>:
13871
<a href="../files/widget-child_js_Widget-Child.js.html#l216"><code>widget-child/js/Widget-Child.js:216</code></a>
13881
<div class="description">
13882
<p>Returns the Widget's previous sibling.</p>
13886
<div class="params">
13887
<h4>Parameters:</h4>
13889
<ul class="params-list">
13893
<code class="param-name">circular</code>
13894
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
13899
<div class="param-description">
13900
<p>Boolean indicating if the parent's last child
13901
should be returned if the child has no previous sibling.</p>
13912
<div class="returns">
13915
<div class="returns-description">
13918
<span class="type"><a href="../classes/Widget.html" class="crosslink">Widget</a></span>:
13930
<div id="method_publish" class="method item inherited">
13931
<h3 class="name"><code>publish</code></h3>
13935
<span class="paren">(</span><ul class="args-list inline commas">
13949
</ul><span class="paren">)</span>
13954
<span class="returns-inline">
13955
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
13973
<a href="../classes/EventTarget.html#method_publish">EventTarget</a>:
13977
<a href="../files/event-custom_js_event-target.js.html#l489"><code>event-custom/js/event-target.js:489</code></a>
13987
<div class="description">
13988
<p>Creates a new custom event of the specified type. If a custom event
13989
by that name already exists, it will not be re-created. In either
13990
case the custom event is returned.</p>
13994
<div class="params">
13995
<h4>Parameters:</h4>
13997
<ul class="params-list">
14001
<code class="param-name">type</code>
14002
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14007
<div class="param-description">
14008
<p>the type, or name of the event</p>
14016
<code class="param-name">opts</code>
14017
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14022
<div class="param-description">
14023
<p>optional config params. Valid properties are:</p>
14027
'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
14030
'bubbles': whether or not this event bubbles (true)
14031
Events can only bubble if emitFacade is true.
14034
'context': the default execution context for the listeners (this)
14037
'defaultFn': the default function to execute when this event fires if preventDefault was not called
14040
'emitFacade': whether or not this event emits a facade (false)
14043
'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
14046
'fireOnce': if an event is configured to fire once, new subscribers after
14047
the fire will be notified immediately.
14050
'async': fireOnce event listeners will fire synchronously if the event has already
14051
fired unless async is true.
14054
'preventable': whether or not preventDefault() has an effect (true)
14057
'preventedFn': a function that is executed when preventDefault is called
14060
'queuable': whether or not this event can be queued during bubbling (false)
14063
'silent': if silent is true, debug messages are not provided for this event.
14066
'stoppedFn': a function that is executed when stopPropagation is called
14070
'monitored': specifies whether or not this event should send notifications about
14071
when the event has been attached, detached, or published.
14074
'type': the event type (valid option if not provided as the first parameter to publish)
14087
<div class="returns">
14090
<div class="returns-description">
14093
<span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
14105
<div id="method_removeAttr" class="method item inherited">
14106
<h3 class="name"><code>removeAttr</code></h3>
14110
<span class="paren">(</span><ul class="args-list inline commas">
14118
</ul><span class="paren">)</span>
14138
<a href="../classes/AttributeExtras.html#method_removeAttr">AttributeExtras</a>:
14142
<a href="../files/attribute_js_AttributeExtras.js.html#l77"><code>attribute/js/AttributeExtras.js:77</code></a>
14152
<div class="description">
14153
<p>Removes an attribute from the host object</p>
14157
<div class="params">
14158
<h4>Parameters:</h4>
14160
<ul class="params-list">
14164
<code class="param-name">name</code>
14165
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14170
<div class="param-description">
14171
<p>The name of the attribute to be removed.</p>
14187
<div id="method_removeTarget" class="method item inherited">
14188
<h3 class="name"><code>removeTarget</code></h3>
14192
<span class="paren">(</span><ul class="args-list inline commas">
14200
</ul><span class="paren">)</span>
14220
<a href="../classes/EventTarget.html#method_removeTarget">EventTarget</a>:
14224
<a href="../files/event-custom_js_event-facade.js.html#l409"><code>event-custom/js/event-facade.js:409</code></a>
14234
<div class="description">
14235
<p>Removes a bubble target</p>
14239
<div class="params">
14240
<h4>Parameters:</h4>
14242
<ul class="params-list">
14246
<code class="param-name">o</code>
14247
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
14252
<div class="param-description">
14253
<p>the target to remove</p>
14269
<div id="method_render" class="method item inherited">
14270
<h3 class="name"><code>render</code></h3>
14274
<span class="paren">(</span><ul class="args-list inline commas">
14278
<code>parentNode</code>
14282
</ul><span class="paren">)</span>
14293
<span class="flag final">final</span>
14299
<span class="flag chainable">chainable</span>
14306
<a href="../classes/Widget.html#method_render">Widget</a>:
14310
<a href="../files/widget_js_Widget.js.html#l514"><code>widget/js/Widget.js:514</code></a>
14320
<div class="description">
14321
<p>Establishes the initial DOM for the widget. Invoking this
14322
method will lead to the creating of all DOM elements for
14323
the widget (or the manipulation of existing DOM elements
14324
for the progressive enhancement use case).</p>
14327
This method should only be invoked once for an initialized
14332
It delegates to the widget specific renderer method to do
14338
<div class="params">
14339
<h4>Parameters:</h4>
14341
<ul class="params-list">
14345
<code class="param-name">parentNode</code>
14346
<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>
14351
<div class="param-description">
14352
<p>Optional. The Node under which the
14353
Widget is to be rendered. This can be a Node instance or a CSS selector string. </p>
14356
If the selector string returns more than one Node, the first node will be used
14357
as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox
14358
are not currently in the document. If it's not provided, the Widget will be rendered
14359
to the body of the current document in this case.
14376
<div id="method_renderer" class="method item protected inherited">
14377
<h3 class="name"><code>renderer</code></h3>
14380
<span class="paren">()</span>
14388
<span class="flag protected">protected</span>
14401
<a href="../classes/Widget.html#method_renderer">Widget</a>:
14405
<a href="../files/widget_js_Widget.js.html#l589"><code>widget/js/Widget.js:589</code></a>
14415
<div class="description">
14416
<p>Creates DOM (or manipulates DOM for progressive enhancement)
14417
This method is invoked by render() and is not chained
14418
automatically for the class hierarchy (unlike initializer, destructor)
14419
so it should be chained manually for subclasses if required.</p>
14430
<div id="method_renderUI" class="method item protected inherited">
14431
<h3 class="name"><code>renderUI</code></h3>
14434
<span class="paren">()</span>
14442
<span class="flag protected">protected</span>
14455
<a href="../classes/Widget.html#method_renderUI">Widget</a>:
14459
<a href="../files/widget_js_Widget.js.html#l623"><code>widget/js/Widget.js:623</code></a>
14469
<div class="description">
14470
<p>Adds nodes to the DOM </p>
14472
<p>This method is not called by framework and is not chained
14473
automatically for the class hierarchy.</p>
14484
<div id="method_reset" class="method item inherited">
14485
<h3 class="name"><code>reset</code></h3>
14489
<span class="paren">(</span><ul class="args-list inline commas">
14497
</ul><span class="paren">)</span>
14502
<span class="returns-inline">
14503
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14516
<span class="flag chainable">chainable</span>
14523
<a href="../classes/AttributeExtras.html#method_reset">AttributeExtras</a>:
14527
<a href="../files/attribute_js_AttributeExtras.js.html#l87"><code>attribute/js/AttributeExtras.js:87</code></a>
14537
<div class="description">
14538
<p>Resets the attribute (or all attributes) to its initial value, as long as
14539
the attribute is not readOnly, or writeOnce.</p>
14543
<div class="params">
14544
<h4>Parameters:</h4>
14546
<ul class="params-list">
14550
<code class="param-name">name</code>
14551
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14556
<div class="param-description">
14557
<p>Optional. The name of the attribute to reset. If omitted, all attributes are reset.</p>
14568
<div class="returns">
14571
<div class="returns-description">
14574
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
14576
A reference to the host object.
14586
<div id="method_set" class="method item inherited">
14587
<h3 class="name"><code>set</code></h3>
14591
<span class="paren">(</span><ul class="args-list inline commas">
14605
</ul><span class="paren">)</span>
14610
<span class="returns-inline">
14611
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14624
<span class="flag chainable">chainable</span>
14630
<a href="../classes/AttributeEvents.html#method_set">
14638
<a href="../files/attribute_js_AttributeCore.js.html#l328"><code>attribute/js/AttributeCore.js:328</code></a>
14648
<div class="description">
14649
<p>Sets the value of an attribute.</p>
14653
<div class="params">
14654
<h4>Parameters:</h4>
14656
<ul class="params-list">
14660
<code class="param-name">name</code>
14661
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
14666
<div class="param-description">
14667
<p>The name of the attribute. If the
14668
current value of the attribute is an Object, dot notation can be used
14669
to set the value of a property within the object (e.g. <code>set("x.y.z", 5)</code>).</p>
14677
<code class="param-name">value</code>
14678
<span class="type">Any</span>
14683
<div class="param-description">
14684
<p>The value to set the attribute to.</p>
14695
<div class="returns">
14698
<div class="returns-description">
14701
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
14703
A reference to the host object.
14713
<div id="method_setAttrs" class="method item inherited">
14714
<h3 class="name"><code>setAttrs</code></h3>
14718
<span class="paren">(</span><ul class="args-list inline commas">
14726
</ul><span class="paren">)</span>
14731
<span class="returns-inline">
14732
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14745
<span class="flag chainable">chainable</span>
14751
<a href="../classes/AttributeEvents.html#method_setAttrs">
14759
<a href="../files/attribute_js_AttributeCore.js.html#l635"><code>attribute/js/AttributeCore.js:635</code></a>
14769
<div class="description">
14770
<p>Sets multiple attribute values.</p>
14774
<div class="params">
14775
<h4>Parameters:</h4>
14777
<ul class="params-list">
14781
<code class="param-name">attrs</code>
14782
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
14787
<div class="param-description">
14788
<p>An object with attributes name/value pairs.</p>
14799
<div class="returns">
14802
<div class="returns-description">
14805
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
14807
A reference to the host object.
14817
<div id="method_show" class="method item inherited">
14818
<h3 class="name"><code>show</code></h3>
14821
<span class="paren">()</span>
14835
<span class="flag chainable">chainable</span>
14842
<a href="../classes/Widget.html#method_show">Widget</a>:
14846
<a href="../files/widget_js_Widget.js.html#l655"><code>widget/js/Widget.js:655</code></a>
14856
<div class="description">
14857
<p>Shows the Widget by setting the "visible" attribute to "true".</p>
14868
<div id="method_subscribe" class="method item deprecated inherited">
14869
<h3 class="name"><code>subscribe</code></h3>
14872
<span class="paren">()</span>
14878
<span class="flag deprecated" title="use on">deprecated</span>
14893
<a href="../classes/EventTarget.html#method_subscribe">EventTarget</a>:
14897
<a href="../files/event-custom_js_event-target.js.html#l335"><code>event-custom/js/event-target.js:335</code></a>
14903
<p>Deprecated: use on</p>
14909
<div class="description">
14910
<p>subscribe to an event</p>
14921
<div id="method_syncUI" class="method item protected inherited">
14922
<h3 class="name"><code>syncUI</code></h3>
14925
<span class="paren">()</span>
14933
<span class="flag protected">protected</span>
14946
<a href="../classes/Widget.html#method_syncUI">Widget</a>:
14950
<a href="../files/widget_js_Widget.js.html#l634"><code>widget/js/Widget.js:634</code></a>
14960
<div class="description">
14961
<p>Refreshes the rendered UI, based on Widget State</p>
14963
<p>This method is not called by framework and is not chained
14964
automatically for the class hierarchy.</p>
14975
<div id="method_toString" class="method item inherited">
14976
<h3 class="name"><code>toString</code></h3>
14979
<span class="paren">()</span>
14983
<span class="returns-inline">
14984
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15001
<a href="../classes/BaseCore.html#method_toString">
15009
<a href="../files/widget_js_Widget.js.html#l1094"><code>widget/js/Widget.js:1094</code></a>
15019
<div class="description">
15020
<p>Generic toString implementation for all widgets.</p>
15026
<div class="returns">
15029
<div class="returns-description">
15032
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
15034
The default string value for the widget [ displays the NAME of the instance, and the unique id ]
15044
<div id="method_unsubscribe" class="method item deprecated inherited">
15045
<h3 class="name"><code>unsubscribe</code></h3>
15048
<span class="paren">()</span>
15054
<span class="flag deprecated" title="use detach">deprecated</span>
15069
<a href="../classes/EventTarget.html#method_unsubscribe">EventTarget</a>:
15073
<a href="../files/event-custom_js_event-target.js.html#l455"><code>event-custom/js/event-target.js:455</code></a>
15079
<p>Deprecated: use detach</p>
15085
<div class="description">
15086
<p>detach a listener</p>
15097
<div id="method_unsubscribeAll" class="method item deprecated inherited">
15098
<h3 class="name"><code>unsubscribeAll</code></h3>
15102
<span class="paren">(</span><ul class="args-list inline commas">
15110
</ul><span class="paren">)</span>
15117
<span class="flag deprecated" title="use detachAll">deprecated</span>
15132
<a href="../classes/EventTarget.html#method_unsubscribeAll">EventTarget</a>:
15136
<a href="../files/event-custom_js_event-target.js.html#l476"><code>event-custom/js/event-target.js:476</code></a>
15142
<p>Deprecated: use detachAll</p>
15148
<div class="description">
15149
<p>Removes all listeners from the specified event. If the event type
15150
is not specified, all listeners from all hosted custom events will
15155
<div class="params">
15156
<h4>Parameters:</h4>
15158
<ul class="params-list">
15162
<code class="param-name">type</code>
15163
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15168
<div class="param-description">
15169
<p>The type, or name of the event</p>
15189
<div id="properties" class="api-class-tabpanel">
15190
<h2 class="off-left">Properties</h2>
15193
<div id="property__allowAdHocAttrs" class="property item protected inherited">
15194
<h3 class="name"><code>_allowAdHocAttrs</code></h3>
15195
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15200
<span class="flag protected">protected</span>
15211
<a href="../classes/BaseCore.html#property__allowAdHocAttrs">BaseCore</a>:
15215
<a href="../files/base_js_BaseCore.js.html#l100"><code>base/js/BaseCore.js:100</code></a>
15224
<div class="description">
15225
<p>This property controls whether or not instances of this class should
15226
allow users to add ad-hoc attributes through the constructor configuration
15229
<p>AdHoc attributes are attributes which are not defined by the class, and are
15230
not handled by the MyClass.<em>NON</em>ATTRS_CFG</p>
15234
<p><strong>Default:</strong> undefined (false)</p>
15243
<div id="property__UI_ATTRS" class="property item private inherited">
15244
<h3 class="name"><code>_UI_ATTRS</code></h3>
15245
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15250
<span class="flag private">private</span>
15261
<a href="../classes/Widget.html#property__UI_ATTRS">Widget</a>:
15265
<a href="../files/widget_js_Widget.js.html#l1236"><code>widget/js/Widget.js:1236</code></a>
15274
<div class="description">
15275
<p>The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations</p>
15286
<div id="property_BOUNDING_TEMPLATE" class="property item inherited">
15287
<h3 class="name"><code>BOUNDING_TEMPLATE</code></h3>
15288
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15302
<a href="../classes/Widget.html#property_BOUNDING_TEMPLATE">Widget</a>:
15306
<a href="../files/widget_js_Widget.js.html#l1132"><code>widget/js/Widget.js:1132</code></a>
15315
<div class="description">
15316
<p>Property defining the markup template for bounding box.</p>
15327
<div id="property_CONTENT_TEMPLATE" class="property item inherited">
15328
<h3 class="name"><code>CONTENT_TEMPLATE</code></h3>
15329
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15343
<a href="../classes/Widget.html#property_CONTENT_TEMPLATE">Widget</a>:
15347
<a href="../files/widget_js_Widget.js.html#l1122"><code>widget/js/Widget.js:1122</code></a>
15356
<div class="description">
15357
<p>Property defining the markup template for content box. If your Widget doesn't
15358
need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null,
15359
and contentBox and boundingBox will both point to the same Node.</p>
15370
<div id="property_DEF_PARENT_NODE" class="property item inherited">
15371
<h3 class="name"><code>DEF_PARENT_NODE</code></h3>
15372
<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>
15386
<a href="../classes/Widget.html#property_DEF_PARENT_NODE">Widget</a>:
15390
<a href="../files/widget_js_Widget.js.html#l1113"><code>widget/js/Widget.js:1113</code></a>
15399
<div class="description">
15400
<p>Default node to render the bounding box to. If not set,
15401
will default to the current document body.</p>
15412
<div id="property_DEF_UNIT" class="property item inherited">
15413
<h3 class="name"><code>DEF_UNIT</code></h3>
15414
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15428
<a href="../classes/Widget.html#property_DEF_UNIT">Widget</a>:
15432
<a href="../files/widget_js_Widget.js.html#l1105"><code>widget/js/Widget.js:1105</code></a>
15441
<div class="description">
15442
<p>Default unit to use for dimension values</p>
15453
<div id="property_name" class="property item deprecated inherited">
15454
<h3 class="name"><code>name</code></h3>
15455
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15458
<span class="flag deprecated" title="Use this.constructor.NAME">deprecated</span>
15471
<a href="../classes/BaseCore.html#property_name">BaseCore</a>:
15475
<a href="../files/base_js_BaseCore.js.html#l196"><code>base/js/BaseCore.js:196</code></a>
15480
<p>Deprecated: Use this.constructor.NAME</p>
15486
<div class="description">
15487
<p>The string used to identify the class of this object.</p>
15498
<div id="property_UI_EVENTS" class="property item inherited">
15499
<h3 class="name"><code>UI_EVENTS</code></h3>
15500
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
15514
<a href="../classes/Widget.html#property_UI_EVENTS">Widget</a>:
15518
<a href="../files/widget_js_WidgetUIEvents.js.html#l52"><code>widget/js/WidgetUIEvents.js:52</code></a>
15527
<div class="description">
15528
<p>Map of DOM events that should be fired as Custom Events by the
15529
Widget instance.</p>
15544
<div id="attrs" class="api-class-tabpanel">
15545
<h2 class="off-left">Attributes</h2>
15548
<div id="attr_boundingBox" class="attr item inherited">
15549
<a name="config_boundingBox"></a>
15550
<h3 class="name"><code>boundingBox</code></h3>
15551
<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>
15565
<a href="../classes/Widget.html#attr_boundingBox">Widget</a>:
15569
<a href="../files/widget_js_Widget.js.html#l175"><code>widget/js/Widget.js:175</code></a>
15578
<div class="description">
15579
<p>The outermost DOM node for the Widget, used for sizing and positioning
15580
of a Widget as well as a containing element for any decorator elements used
15587
<div class="emits box">
15588
<h4>Fires event <code>boundingBoxChange</code></h4>
15591
Fires when the value for the configuration attribute <code>boundingBox</code> is
15592
changed. You can listen for the event using the <code>on</code> method if you
15593
wish to be notified before the attribute's value has changed, or
15594
using the <code>after</code> method if you wish to be notified after the
15595
attribute's value has changed.
15598
<div class="params">
15599
<h4>Parameters:</h4>
15601
<ul class="params-list">
15603
<code class="param-name">e</code>
15604
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
15606
<div class="param-description">
15607
An Event Facade object with the following
15608
attribute-specific properties added:
15611
<ul class="params-list">
15613
<code class="param-name">prevVal</code>
15614
<span class="type">Any</span>
15615
<div class="param-description">The value of the attribute, prior to it being set.</div>
15618
<code class="param-name">newVal</code>
15619
<span class="type">Any</span>
15620
<div class="param-description">The value the attribute is to be set to.</div>
15623
<code class="param-name">attrName</code>
15624
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15625
<div class="param-description">The name of the attribute being set.</div>
15628
<code class="param-name">subAttrName</code>
15629
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15630
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
15643
<div id="attr_contentBox" class="attr item inherited">
15644
<a name="config_contentBox"></a>
15645
<h3 class="name"><code>contentBox</code></h3>
15646
<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>
15660
<a href="../classes/Widget.html#attr_contentBox">Widget</a>:
15664
<a href="../files/widget_js_Widget.js.html#l189"><code>widget/js/Widget.js:189</code></a>
15673
<div class="description">
15674
<p>A DOM node that is a direct descendant of a Widget's bounding box that
15675
houses its content.</p>
15681
<div class="emits box">
15682
<h4>Fires event <code>contentBoxChange</code></h4>
15685
Fires when the value for the configuration attribute <code>contentBox</code> is
15686
changed. You can listen for the event using the <code>on</code> method if you
15687
wish to be notified before the attribute's value has changed, or
15688
using the <code>after</code> method if you wish to be notified after the
15689
attribute's value has changed.
15692
<div class="params">
15693
<h4>Parameters:</h4>
15695
<ul class="params-list">
15697
<code class="param-name">e</code>
15698
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
15700
<div class="param-description">
15701
An Event Facade object with the following
15702
attribute-specific properties added:
15705
<ul class="params-list">
15707
<code class="param-name">prevVal</code>
15708
<span class="type">Any</span>
15709
<div class="param-description">The value of the attribute, prior to it being set.</div>
15712
<code class="param-name">newVal</code>
15713
<span class="type">Any</span>
15714
<div class="param-description">The value the attribute is to be set to.</div>
15717
<code class="param-name">attrName</code>
15718
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15719
<div class="param-description">The name of the attribute being set.</div>
15722
<code class="param-name">subAttrName</code>
15723
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15724
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
15737
<div id="attr_destroyed" class="attr item inherited">
15738
<a name="config_destroyed"></a>
15739
<h3 class="name"><code>destroyed</code></h3>
15740
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15754
<a href="../classes/BaseCore.html#attr_destroyed">BaseCore</a>:
15758
<a href="../files/base_js_BaseCore.js.html#l157"><code>base/js/BaseCore.js:157</code></a>
15767
<div class="description">
15768
<p>Flag indicating whether or not this object
15769
has been through the destroy lifecycle phase.</p>
15773
<p><strong>Default:</strong> false</p>
15777
<div class="emits box">
15778
<h4>Fires event <code>destroyedChange</code></h4>
15781
Fires when the value for the configuration attribute <code>destroyed</code> is
15782
changed. You can listen for the event using the <code>on</code> method if you
15783
wish to be notified before the attribute's value has changed, or
15784
using the <code>after</code> method if you wish to be notified after the
15785
attribute's value has changed.
15788
<div class="params">
15789
<h4>Parameters:</h4>
15791
<ul class="params-list">
15793
<code class="param-name">e</code>
15794
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
15796
<div class="param-description">
15797
An Event Facade object with the following
15798
attribute-specific properties added:
15801
<ul class="params-list">
15803
<code class="param-name">prevVal</code>
15804
<span class="type">Any</span>
15805
<div class="param-description">The value of the attribute, prior to it being set.</div>
15808
<code class="param-name">newVal</code>
15809
<span class="type">Any</span>
15810
<div class="param-description">The value the attribute is to be set to.</div>
15813
<code class="param-name">attrName</code>
15814
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15815
<div class="param-description">The name of the attribute being set.</div>
15818
<code class="param-name">subAttrName</code>
15819
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15820
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
15833
<div id="attr_disabled" class="attr item inherited">
15834
<a name="config_disabled"></a>
15835
<h3 class="name"><code>disabled</code></h3>
15836
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15850
<a href="../classes/Widget.html#attr_disabled">Widget</a>:
15854
<a href="../files/widget_js_Widget.js.html#l231"><code>widget/js/Widget.js:231</code></a>
15863
<div class="description">
15864
<p>Boolean indicating if the Widget should be disabled. The disabled implementation
15865
is left to the specific classes extending widget.</p>
15869
<p><strong>Default:</strong> false</p>
15873
<div class="emits box">
15874
<h4>Fires event <code>disabledChange</code></h4>
15877
Fires when the value for the configuration attribute <code>disabled</code> is
15878
changed. You can listen for the event using the <code>on</code> method if you
15879
wish to be notified before the attribute's value has changed, or
15880
using the <code>after</code> method if you wish to be notified after the
15881
attribute's value has changed.
15884
<div class="params">
15885
<h4>Parameters:</h4>
15887
<ul class="params-list">
15889
<code class="param-name">e</code>
15890
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
15892
<div class="param-description">
15893
An Event Facade object with the following
15894
attribute-specific properties added:
15897
<ul class="params-list">
15899
<code class="param-name">prevVal</code>
15900
<span class="type">Any</span>
15901
<div class="param-description">The value of the attribute, prior to it being set.</div>
15904
<code class="param-name">newVal</code>
15905
<span class="type">Any</span>
15906
<div class="param-description">The value the attribute is to be set to.</div>
15909
<code class="param-name">attrName</code>
15910
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15911
<div class="param-description">The name of the attribute being set.</div>
15914
<code class="param-name">subAttrName</code>
15915
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
15916
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
15929
<div id="attr_focused" class="attr item inherited">
15930
<a name="config_focused"></a>
15931
<h3 class="name"><code>focused</code></h3>
15932
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
15946
<a href="../classes/Widget.html#attr_focused">Widget</a>:
15950
<a href="../files/widget_js_Widget.js.html#l218"><code>widget/js/Widget.js:218</code></a>
15959
<div class="description">
15960
<p>Boolean indicating if the Widget, or one of its descendants,
15965
<p><strong>Default:</strong> false</p>
15969
<div class="emits box">
15970
<h4>Fires event <code>focusedChange</code></h4>
15973
Fires when the value for the configuration attribute <code>focused</code> is
15974
changed. You can listen for the event using the <code>on</code> method if you
15975
wish to be notified before the attribute's value has changed, or
15976
using the <code>after</code> method if you wish to be notified after the
15977
attribute's value has changed.
15980
<div class="params">
15981
<h4>Parameters:</h4>
15983
<ul class="params-list">
15985
<code class="param-name">e</code>
15986
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
15988
<div class="param-description">
15989
An Event Facade object with the following
15990
attribute-specific properties added:
15993
<ul class="params-list">
15995
<code class="param-name">prevVal</code>
15996
<span class="type">Any</span>
15997
<div class="param-description">The value of the attribute, prior to it being set.</div>
16000
<code class="param-name">newVal</code>
16001
<span class="type">Any</span>
16002
<div class="param-description">The value the attribute is to be set to.</div>
16005
<code class="param-name">attrName</code>
16006
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16007
<div class="param-description">The name of the attribute being set.</div>
16010
<code class="param-name">subAttrName</code>
16011
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16012
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16025
<div id="attr_height" class="attr item inherited">
16026
<a name="config_height"></a>
16027
<h3 class="name"><code>height</code></h3>
16028
<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/Number" class="crosslink external" target="_blank">Number</a></span>
16042
<a href="../classes/Widget.html#attr_height">Widget</a>:
16046
<a href="../files/widget_js_Widget.js.html#l252"><code>widget/js/Widget.js:252</code></a>
16055
<div class="description">
16056
<p>String with units, or number, representing the height of the Widget. If a number is provided,
16057
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
16061
<p><strong>Default:</strong> EMPTY_STR</p>
16065
<div class="emits box">
16066
<h4>Fires event <code>heightChange</code></h4>
16069
Fires when the value for the configuration attribute <code>height</code> is
16070
changed. You can listen for the event using the <code>on</code> method if you
16071
wish to be notified before the attribute's value has changed, or
16072
using the <code>after</code> method if you wish to be notified after the
16073
attribute's value has changed.
16076
<div class="params">
16077
<h4>Parameters:</h4>
16079
<ul class="params-list">
16081
<code class="param-name">e</code>
16082
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16084
<div class="param-description">
16085
An Event Facade object with the following
16086
attribute-specific properties added:
16089
<ul class="params-list">
16091
<code class="param-name">prevVal</code>
16092
<span class="type">Any</span>
16093
<div class="param-description">The value of the attribute, prior to it being set.</div>
16096
<code class="param-name">newVal</code>
16097
<span class="type">Any</span>
16098
<div class="param-description">The value the attribute is to be set to.</div>
16101
<code class="param-name">attrName</code>
16102
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16103
<div class="param-description">The name of the attribute being set.</div>
16106
<code class="param-name">subAttrName</code>
16107
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16108
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16121
<div id="attr_id" class="attr item inherited">
16122
<a name="config_id"></a>
16123
<h3 class="name"><code>id</code></h3>
16124
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16138
<a href="../classes/Widget.html#attr_id">Widget</a>:
16142
<a href="../files/widget_js_Widget.js.html#l149"><code>widget/js/Widget.js:149</code></a>
16151
<div class="description">
16156
<p><strong>Default:</strong> Generated using guid()</p>
16160
<div class="emits box">
16161
<h4>Fires event <code>idChange</code></h4>
16164
Fires when the value for the configuration attribute <code>id</code> is
16165
changed. You can listen for the event using the <code>on</code> method if you
16166
wish to be notified before the attribute's value has changed, or
16167
using the <code>after</code> method if you wish to be notified after the
16168
attribute's value has changed.
16171
<div class="params">
16172
<h4>Parameters:</h4>
16174
<ul class="params-list">
16176
<code class="param-name">e</code>
16177
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16179
<div class="param-description">
16180
An Event Facade object with the following
16181
attribute-specific properties added:
16184
<ul class="params-list">
16186
<code class="param-name">prevVal</code>
16187
<span class="type">Any</span>
16188
<div class="param-description">The value of the attribute, prior to it being set.</div>
16191
<code class="param-name">newVal</code>
16192
<span class="type">Any</span>
16193
<div class="param-description">The value the attribute is to be set to.</div>
16196
<code class="param-name">attrName</code>
16197
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16198
<div class="param-description">The name of the attribute being set.</div>
16201
<code class="param-name">subAttrName</code>
16202
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16203
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16216
<div id="attr_initialized" class="attr item inherited">
16217
<a name="config_initialized"></a>
16218
<h3 class="name"><code>initialized</code></h3>
16219
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16233
<a href="../classes/BaseCore.html#attr_initialized">BaseCore</a>:
16237
<a href="../files/base_js_BaseCore.js.html#l143"><code>base/js/BaseCore.js:143</code></a>
16246
<div class="description">
16247
<p>Flag indicating whether or not this object
16248
has been through the init lifecycle phase.</p>
16252
<p><strong>Default:</strong> false</p>
16256
<div class="emits box">
16257
<h4>Fires event <code>initializedChange</code></h4>
16260
Fires when the value for the configuration attribute <code>initialized</code> is
16261
changed. You can listen for the event using the <code>on</code> method if you
16262
wish to be notified before the attribute's value has changed, or
16263
using the <code>after</code> method if you wish to be notified after the
16264
attribute's value has changed.
16267
<div class="params">
16268
<h4>Parameters:</h4>
16270
<ul class="params-list">
16272
<code class="param-name">e</code>
16273
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16275
<div class="param-description">
16276
An Event Facade object with the following
16277
attribute-specific properties added:
16280
<ul class="params-list">
16282
<code class="param-name">prevVal</code>
16283
<span class="type">Any</span>
16284
<div class="param-description">The value of the attribute, prior to it being set.</div>
16287
<code class="param-name">newVal</code>
16288
<span class="type">Any</span>
16289
<div class="param-description">The value the attribute is to be set to.</div>
16292
<code class="param-name">attrName</code>
16293
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16294
<div class="param-description">The name of the attribute being set.</div>
16297
<code class="param-name">subAttrName</code>
16298
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16299
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16312
<div id="attr_locale" class="attr item deprecated inherited">
16313
<a name="config_locale"></a>
16314
<h3 class="name"><code>locale</code></h3>
16315
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16318
<span class="flag deprecated" title="Use Y.config.lang and Y.Intl externalization support">deprecated</span>
16331
<a href="../classes/Widget.html#attr_locale">Widget</a>:
16335
<a href="../files/widget_js_WidgetLocale.js.html#l14"><code>widget/js/WidgetLocale.js:14</code></a>
16340
<p>Deprecated: Use Y.config.lang and Y.Intl externalization support</p>
16346
<div class="description">
16347
<p>The default locale for the widget. NOTE: Using get/set on the "strings" attribute will
16348
return/set strings for this locale.</p>
16352
<p><strong>Default:</strong> "en"</p>
16356
<div class="emits box">
16357
<h4>Fires event <code>localeChange</code></h4>
16360
Fires when the value for the configuration attribute <code>locale</code> is
16361
changed. You can listen for the event using the <code>on</code> method if you
16362
wish to be notified before the attribute's value has changed, or
16363
using the <code>after</code> method if you wish to be notified after the
16364
attribute's value has changed.
16367
<div class="params">
16368
<h4>Parameters:</h4>
16370
<ul class="params-list">
16372
<code class="param-name">e</code>
16373
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16375
<div class="param-description">
16376
An Event Facade object with the following
16377
attribute-specific properties added:
16380
<ul class="params-list">
16382
<code class="param-name">prevVal</code>
16383
<span class="type">Any</span>
16384
<div class="param-description">The value of the attribute, prior to it being set.</div>
16387
<code class="param-name">newVal</code>
16388
<span class="type">Any</span>
16389
<div class="param-description">The value the attribute is to be set to.</div>
16392
<code class="param-name">attrName</code>
16393
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16394
<div class="param-description">The name of the attribute being set.</div>
16397
<code class="param-name">subAttrName</code>
16398
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16399
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16412
<div id="attr_render" class="attr item inherited">
16413
<a name="config_render"></a>
16414
<h3 class="name"><code>render</code></h3>
16415
<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>
16429
<a href="../classes/Widget.html#attr_render">Widget</a>:
16433
<a href="../files/widget_js_Widget.js.html#l286"><code>widget/js/Widget.js:286</code></a>
16442
<div class="description">
16443
<p>Whether or not to render the widget automatically after init, and optionally, to which parent node.</p>
16449
<div class="emits box">
16450
<h4>Fires event <code>renderChange</code></h4>
16453
Fires when the value for the configuration attribute <code>render</code> is
16454
changed. You can listen for the event using the <code>on</code> method if you
16455
wish to be notified before the attribute's value has changed, or
16456
using the <code>after</code> method if you wish to be notified after the
16457
attribute's value has changed.
16460
<div class="params">
16461
<h4>Parameters:</h4>
16463
<ul class="params-list">
16465
<code class="param-name">e</code>
16466
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16468
<div class="param-description">
16469
An Event Facade object with the following
16470
attribute-specific properties added:
16473
<ul class="params-list">
16475
<code class="param-name">prevVal</code>
16476
<span class="type">Any</span>
16477
<div class="param-description">The value of the attribute, prior to it being set.</div>
16480
<code class="param-name">newVal</code>
16481
<span class="type">Any</span>
16482
<div class="param-description">The value the attribute is to be set to.</div>
16485
<code class="param-name">attrName</code>
16486
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16487
<div class="param-description">The name of the attribute being set.</div>
16490
<code class="param-name">subAttrName</code>
16491
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16492
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16505
<div id="attr_rendered" class="attr item inherited">
16506
<a name="config_rendered"></a>
16507
<h3 class="name"><code>rendered</code></h3>
16508
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16522
<a href="../classes/Widget.html#attr_rendered">Widget</a>:
16526
<a href="../files/widget_js_Widget.js.html#l161"><code>widget/js/Widget.js:161</code></a>
16535
<div class="description">
16536
<p>Flag indicating whether or not this Widget
16537
has been through the render lifecycle phase.</p>
16541
<p><strong>Default:</strong> false</p>
16545
<div class="emits box">
16546
<h4>Fires event <code>renderedChange</code></h4>
16549
Fires when the value for the configuration attribute <code>rendered</code> is
16550
changed. You can listen for the event using the <code>on</code> method if you
16551
wish to be notified before the attribute's value has changed, or
16552
using the <code>after</code> method if you wish to be notified after the
16553
attribute's value has changed.
16556
<div class="params">
16557
<h4>Parameters:</h4>
16559
<ul class="params-list">
16561
<code class="param-name">e</code>
16562
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16564
<div class="param-description">
16565
An Event Facade object with the following
16566
attribute-specific properties added:
16569
<ul class="params-list">
16571
<code class="param-name">prevVal</code>
16572
<span class="type">Any</span>
16573
<div class="param-description">The value of the attribute, prior to it being set.</div>
16576
<code class="param-name">newVal</code>
16577
<span class="type">Any</span>
16578
<div class="param-description">The value the attribute is to be set to.</div>
16581
<code class="param-name">attrName</code>
16582
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16583
<div class="param-description">The name of the attribute being set.</div>
16586
<code class="param-name">subAttrName</code>
16587
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16588
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16601
<div id="attr_srcNode" class="attr item inherited">
16602
<a name="config_srcNode"></a>
16603
<h3 class="name"><code>srcNode</code></h3>
16604
<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>
16618
<a href="../classes/Widget.html#attr_srcNode">Widget</a>:
16622
<a href="../files/widget_js_WidgetHTMLParser.js.html#l59"><code>widget/js/WidgetHTMLParser.js:59</code></a>
16631
<div class="description">
16632
<p>The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition</p>
16638
<div class="emits box">
16639
<h4>Fires event <code>srcNodeChange</code></h4>
16642
Fires when the value for the configuration attribute <code>srcNode</code> is
16643
changed. You can listen for the event using the <code>on</code> method if you
16644
wish to be notified before the attribute's value has changed, or
16645
using the <code>after</code> method if you wish to be notified after the
16646
attribute's value has changed.
16649
<div class="params">
16650
<h4>Parameters:</h4>
16652
<ul class="params-list">
16654
<code class="param-name">e</code>
16655
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16657
<div class="param-description">
16658
An Event Facade object with the following
16659
attribute-specific properties added:
16662
<ul class="params-list">
16664
<code class="param-name">prevVal</code>
16665
<span class="type">Any</span>
16666
<div class="param-description">The value of the attribute, prior to it being set.</div>
16669
<code class="param-name">newVal</code>
16670
<span class="type">Any</span>
16671
<div class="param-description">The value the attribute is to be set to.</div>
16674
<code class="param-name">attrName</code>
16675
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16676
<div class="param-description">The name of the attribute being set.</div>
16679
<code class="param-name">subAttrName</code>
16680
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16681
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16694
<div id="attr_strings" class="attr item inherited">
16695
<a name="config_strings"></a>
16696
<h3 class="name"><code>strings</code></h3>
16697
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
16711
<a href="../classes/Widget.html#attr_strings">Widget</a>:
16715
<a href="../files/widget_js_Widget.js.html#l274"><code>widget/js/Widget.js:274</code></a>
16724
<div class="description">
16725
<p>Collection of strings used to label elements of the Widget's UI.</p>
16729
<p><strong>Default:</strong> null</p>
16733
<div class="emits box">
16734
<h4>Fires event <code>stringsChange</code></h4>
16737
Fires when the value for the configuration attribute <code>strings</code> is
16738
changed. You can listen for the event using the <code>on</code> method if you
16739
wish to be notified before the attribute's value has changed, or
16740
using the <code>after</code> method if you wish to be notified after the
16741
attribute's value has changed.
16744
<div class="params">
16745
<h4>Parameters:</h4>
16747
<ul class="params-list">
16749
<code class="param-name">e</code>
16750
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16752
<div class="param-description">
16753
An Event Facade object with the following
16754
attribute-specific properties added:
16757
<ul class="params-list">
16759
<code class="param-name">prevVal</code>
16760
<span class="type">Any</span>
16761
<div class="param-description">The value of the attribute, prior to it being set.</div>
16764
<code class="param-name">newVal</code>
16765
<span class="type">Any</span>
16766
<div class="param-description">The value the attribute is to be set to.</div>
16769
<code class="param-name">attrName</code>
16770
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16771
<div class="param-description">The name of the attribute being set.</div>
16774
<code class="param-name">subAttrName</code>
16775
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16776
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16789
<div id="attr_tabIndex" class="attr item inherited">
16790
<a name="config_tabIndex"></a>
16791
<h3 class="name"><code>tabIndex</code></h3>
16792
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>
16806
<a href="../classes/Widget.html#attr_tabIndex">Widget</a>:
16810
<a href="../files/widget_js_Widget.js.html#l202"><code>widget/js/Widget.js:202</code></a>
16819
<div class="description">
16820
<p>Number (between -32767 to 32767) indicating the widget's
16821
position in the default tab flow. The value is used to set the
16822
"tabIndex" attribute on the widget's bounding box. Negative values allow
16823
the widget to receive DOM focus programmatically (by calling the focus
16824
method), while being removed from the default tab flow. A value of
16825
null removes the "tabIndex" attribute from the widget's bounding box.</p>
16829
<p><strong>Default:</strong> null</p>
16833
<div class="emits box">
16834
<h4>Fires event <code>tabIndexChange</code></h4>
16837
Fires when the value for the configuration attribute <code>tabIndex</code> is
16838
changed. You can listen for the event using the <code>on</code> method if you
16839
wish to be notified before the attribute's value has changed, or
16840
using the <code>after</code> method if you wish to be notified after the
16841
attribute's value has changed.
16844
<div class="params">
16845
<h4>Parameters:</h4>
16847
<ul class="params-list">
16849
<code class="param-name">e</code>
16850
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16852
<div class="param-description">
16853
An Event Facade object with the following
16854
attribute-specific properties added:
16857
<ul class="params-list">
16859
<code class="param-name">prevVal</code>
16860
<span class="type">Any</span>
16861
<div class="param-description">The value of the attribute, prior to it being set.</div>
16864
<code class="param-name">newVal</code>
16865
<span class="type">Any</span>
16866
<div class="param-description">The value the attribute is to be set to.</div>
16869
<code class="param-name">attrName</code>
16870
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16871
<div class="param-description">The name of the attribute being set.</div>
16874
<code class="param-name">subAttrName</code>
16875
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16876
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16889
<div id="attr_visible" class="attr item inherited">
16890
<a name="config_visible"></a>
16891
<h3 class="name"><code>visible</code></h3>
16892
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
16906
<a href="../classes/Widget.html#attr_visible">Widget</a>:
16910
<a href="../files/widget_js_Widget.js.html#l242"><code>widget/js/Widget.js:242</code></a>
16919
<div class="description">
16920
<p>Boolean indicating weather or not the Widget is visible.</p>
16924
<p><strong>Default:</strong> TRUE</p>
16928
<div class="emits box">
16929
<h4>Fires event <code>visibleChange</code></h4>
16932
Fires when the value for the configuration attribute <code>visible</code> is
16933
changed. You can listen for the event using the <code>on</code> method if you
16934
wish to be notified before the attribute's value has changed, or
16935
using the <code>after</code> method if you wish to be notified after the
16936
attribute's value has changed.
16939
<div class="params">
16940
<h4>Parameters:</h4>
16942
<ul class="params-list">
16944
<code class="param-name">e</code>
16945
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
16947
<div class="param-description">
16948
An Event Facade object with the following
16949
attribute-specific properties added:
16952
<ul class="params-list">
16954
<code class="param-name">prevVal</code>
16955
<span class="type">Any</span>
16956
<div class="param-description">The value of the attribute, prior to it being set.</div>
16959
<code class="param-name">newVal</code>
16960
<span class="type">Any</span>
16961
<div class="param-description">The value the attribute is to be set to.</div>
16964
<code class="param-name">attrName</code>
16965
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16966
<div class="param-description">The name of the attribute being set.</div>
16969
<code class="param-name">subAttrName</code>
16970
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
16971
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
16984
<div id="attr_width" class="attr item inherited">
16985
<a name="config_width"></a>
16986
<h3 class="name"><code>width</code></h3>
16987
<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/Number" class="crosslink external" target="_blank">Number</a></span>
17001
<a href="../classes/Widget.html#attr_width">Widget</a>:
17005
<a href="../files/widget_js_Widget.js.html#l263"><code>widget/js/Widget.js:263</code></a>
17014
<div class="description">
17015
<p>String with units, or number, representing the width of the Widget. If a number is provided,
17016
the default unit, defined by the Widgets DEF_UNIT, property is used.</p>
17020
<p><strong>Default:</strong> EMPTY_STR</p>
17024
<div class="emits box">
17025
<h4>Fires event <code>widthChange</code></h4>
17028
Fires when the value for the configuration attribute <code>width</code> is
17029
changed. You can listen for the event using the <code>on</code> method if you
17030
wish to be notified before the attribute's value has changed, or
17031
using the <code>after</code> method if you wish to be notified after the
17032
attribute's value has changed.
17035
<div class="params">
17036
<h4>Parameters:</h4>
17038
<ul class="params-list">
17040
<code class="param-name">e</code>
17041
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17043
<div class="param-description">
17044
An Event Facade object with the following
17045
attribute-specific properties added:
17048
<ul class="params-list">
17050
<code class="param-name">prevVal</code>
17051
<span class="type">Any</span>
17052
<div class="param-description">The value of the attribute, prior to it being set.</div>
17055
<code class="param-name">newVal</code>
17056
<span class="type">Any</span>
17057
<div class="param-description">The value the attribute is to be set to.</div>
17060
<code class="param-name">attrName</code>
17061
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17062
<div class="param-description">The name of the attribute being set.</div>
17065
<code class="param-name">subAttrName</code>
17066
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
17067
<div class="param-description">If setting a property within the attribute's value, the name of the sub-attribute property being set.</div>
17084
<div id="events" class="api-class-tabpanel">
17085
<h2 class="off-left">Events</h2>
17088
<div id="event_destroy" class="events item inherited">
17089
<h3 class="name"><code>destroy</code></h3>
17090
<span class="type"></span>
17104
<a href="../classes/Base.html#event_destroy">Base</a>:
17108
<a href="../files/base_js_Base.js.html#l285"><code>base/js/Base.js:285</code></a>
17117
<div class="description">
17119
Lifecycle event for the destroy phase,
17120
fired prior to destruction. Invoking the preventDefault
17121
method on the event object provided to subscribers will
17122
prevent destruction from proceeding.
17126
Subscribers to the "after" moment of this event, will be notified
17127
after destruction is complete (and as a result cannot prevent
17133
<div class="params">
17134
<h4>Event Payload:</h4>
17136
<ul class="params-list">
17140
<code class="param-name">e</code>
17141
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17146
<div class="param-description">
17147
<p>Event object</p>
17162
<div id="event_init" class="events item inherited">
17163
<h3 class="name"><code>init</code></h3>
17164
<span class="type"></span>
17178
<a href="../classes/Base.html#event_init">Base</a>:
17182
<a href="../files/base_js_Base.js.html#l202"><code>base/js/Base.js:202</code></a>
17191
<div class="description">
17193
Lifecycle event for the init phase, fired prior to initialization.
17194
Invoking the preventDefault() method on the event object provided
17195
to subscribers will prevent initialization from occuring.
17199
Subscribers to the "after" momemt of this event, will be notified
17200
after initialization of the object is complete (and therefore
17201
cannot prevent initialization).
17206
<div class="params">
17207
<h4>Event Payload:</h4>
17209
<ul class="params-list">
17213
<code class="param-name">e</code>
17214
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17219
<div class="param-description">
17220
<p>Event object, with a cfg property which
17221
refers to the configuration object passed to the constructor.</p>
17236
<div id="event_widget:contentUpdate" class="events item inherited">
17237
<h3 class="name"><code>widget:contentUpdate</code></h3>
17238
<span class="type"></span>
17252
<a href="../classes/Widget.html#event_widget:contentUpdate">Widget</a>:
17256
<a href="../files/widget_js_Widget.js.html#l398"><code>widget/js/Widget.js:398</code></a>
17265
<div class="description">
17266
<p>Notification event, which widget implementations can fire, when
17267
they change the content of the widget. This event has no default
17268
behavior and cannot be prevented, so the "on" or "after"
17269
moments are effectively equivalent (with on listeners being invoked before
17270
after listeners).</p>
17274
<div class="params">
17275
<h4>Event Payload:</h4>
17277
<ul class="params-list">
17281
<code class="param-name">e</code>
17282
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17287
<div class="param-description">
17288
<p>The Event Facade</p>
17303
<div id="event_widget:render" class="events item inherited">
17304
<h3 class="name"><code>widget:render</code></h3>
17305
<span class="type"></span>
17319
<a href="../classes/Widget.html#event_widget:render">Widget</a>:
17323
<a href="../files/widget_js_Widget.js.html#l544"><code>widget/js/Widget.js:544</code></a>
17332
<div class="description">
17333
<p>Lifecycle event for the render phase, fired prior to rendering the UI
17334
for the widget (prior to invoking the widget's renderer method).</p>
17337
Subscribers to the "on" moment of this event, will be notified
17338
before the widget is rendered.
17342
Subscribers to the "after" moment of this event, will be notified
17343
after rendering is complete.
17348
<div class="params">
17349
<h4>Event Payload:</h4>
17351
<ul class="params-list">
17355
<code class="param-name">e</code>
17356
<span class="type"><a href="../classes/EventFacade.html" class="crosslink">EventFacade</a></span>
17361
<div class="param-description">
17362
<p>The Event Facade</p>
17388
<script src="../assets/vendor/prettify/prettify-min.js"></script>
17389
<script>prettyPrint();</script>
17390
<script src="../assets/js/yui-prettify.js"></script>
17391
<script src="../assets/../api.js"></script>
17392
<script src="../assets/js/api-filter.js"></script>
17393
<script src="../assets/js/api-list.js"></script>
17394
<script src="../assets/js/api-search.js"></script>
17395
<script src="../assets/js/apidocs.js"></script>
added
removed
lib/yui/api/classes/DataTable.Base.html
