--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/cm/media/js/lib/yui/yui_3.10.3/api/classes/Event.html Tue Jul 16 14:29:46 2013 +0200
@@ -0,0 +1,9690 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <title>Event - YUI 3</title>
+ <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+ <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+ <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+ <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
+ <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+ <div id="hd" class="yui3-g header">
+ <div class="yui3-u-3-4">
+
+ <h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
+
+ </div>
+ <div class="yui3-u-1-4 version">
+ <em>API Docs for: 3.10.3</em>
+ </div>
+ </div>
+ <div id="bd" class="yui3-g">
+
+ <div class="yui3-u-1-4">
+ <div id="docs-sidebar" class="sidebar apidocs">
+ <div id="api-list">
+ <h2 class="off-left">APIs</h2>
+ <div id="api-tabview" class="tabview">
+ <ul class="tabs">
+ <li><a href="#api-classes">Classes</a></li>
+ <li><a href="#api-modules">Modules</a></li>
+ </ul>
+
+ <div id="api-tabview-filter">
+ <input type="search" id="api-filter" placeholder="Type to filter APIs">
+ </div>
+
+ <div id="api-tabview-panel">
+ <ul id="api-classes" class="apis classes">
+
+ <li><a href="../classes/Anim.html">Anim</a></li>
+
+ <li><a href="../classes/App.html">App</a></li>
+
+ <li><a href="../classes/App.Base.html">App.Base</a></li>
+
+ <li><a href="../classes/App.Content.html">App.Content</a></li>
+
+ <li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
+
+ <li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
+
+ <li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
+
+ <li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
+
+ <li><a href="../classes/Array.html">Array</a></li>
+
+ <li><a href="../classes/ArrayList.html">ArrayList</a></li>
+
+ <li><a href="../classes/ArraySort.html">ArraySort</a></li>
+
+ <li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
+
+ <li><a href="../classes/Attribute.html">Attribute</a></li>
+
+ <li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
+
+ <li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
+
+ <li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
+
+ <li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
+
+ <li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li>
+
+ <li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
+
+ <li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
+
+ <li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
+
+ <li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
+
+ <li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
+
+ <li><a href="../classes/Axis.html">Axis</a></li>
+
+ <li><a href="../classes/AxisBase.html">AxisBase</a></li>
+
+ <li><a href="../classes/BarSeries.html">BarSeries</a></li>
+
+ <li><a href="../classes/Base.html">Base</a></li>
+
+ <li><a href="../classes/BaseCore.html">BaseCore</a></li>
+
+ <li><a href="../classes/BaseObservable.html">BaseObservable</a></li>
+
+ <li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
+
+ <li><a href="../classes/Button.html">Button</a></li>
+
+ <li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
+
+ <li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
+
+ <li><a href="../classes/Cache.html">Cache</a></li>
+
+ <li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
+
+ <li><a href="../classes/Calendar.html">Calendar</a></li>
+
+ <li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
+
+ <li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li>
+
+ <li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
+
+ <li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
+
+ <li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
+
+ <li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
+
+ <li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
+
+ <li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
+
+ <li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
+
+ <li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
+
+ <li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
+
+ <li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
+
+ <li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
+
+ <li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li>
+
+ <li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li>
+
+ <li><a href="../classes/Chart.html">Chart</a></li>
+
+ <li><a href="../classes/ChartBase.html">ChartBase</a></li>
+
+ <li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
+
+ <li><a href="../classes/Circle.html">Circle</a></li>
+
+ <li><a href="../classes/CircleGroup.html">CircleGroup</a></li>
+
+ <li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
+
+ <li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
+
+ <li><a href="../classes/Color.html">Color</a></li>
+
+ <li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li>
+
+ <li><a href="../classes/Color.HSL.html">Color.HSL</a></li>
+
+ <li><a href="../classes/Color.HSV.html">Color.HSV</a></li>
+
+ <li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
+
+ <li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
+
+ <li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
+
+ <li><a href="../classes/config.html">config</a></li>
+
+ <li><a href="../classes/Console.html">Console</a></li>
+
+ <li><a href="../classes/Controller.html">Controller</a></li>
+
+ <li><a href="../classes/Cookie.html">Cookie</a></li>
+
+ <li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
+
+ <li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
+
+ <li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
+
+ <li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
+
+ <li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
+
+ <li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
+
+ <li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
+
+ <li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
+
+ <li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
+
+ <li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
+
+ <li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
+
+ <li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
+
+ <li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
+
+ <li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
+
+ <li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
+
+ <li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
+
+ <li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
+
+ <li><a href="../classes/DataTable.html">DataTable</a></li>
+
+ <li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
+
+ <li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li>
+
+ <li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
+
+ <li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
+
+ <li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
+
+ <li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
+
+ <li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
+
+ <li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
+
+ <li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
+
+ <li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li>
+
+ <li><a href="../classes/Date.html">Date</a></li>
+
+ <li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
+
+ <li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
+
+ <li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
+
+ <li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
+
+ <li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
+
+ <li><a href="../classes/Dial.html">Dial</a></li>
+
+ <li><a href="../classes/Do.html">Do</a></li>
+
+ <li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
+
+ <li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
+
+ <li><a href="../classes/Do.Error.html">Do.Error</a></li>
+
+ <li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
+
+ <li><a href="../classes/Do.Method.html">Do.Method</a></li>
+
+ <li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
+
+ <li><a href="../classes/DOM.html">DOM</a></li>
+
+ <li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
+
+ <li><a href="../classes/Drawing.html">Drawing</a></li>
+
+ <li><a href="../classes/Easing.html">Easing</a></li>
+
+ <li><a href="../classes/EditorBase.html">EditorBase</a></li>
+
+ <li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
+
+ <li><a href="../classes/Ellipse.html">Ellipse</a></li>
+
+ <li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
+
+ <li><a href="../classes/Escape.html">Escape</a></li>
+
+ <li><a href="../classes/Event.html">Event</a></li>
+
+ <li><a href="../classes/EventFacade.html">EventFacade</a></li>
+
+ <li><a href="../classes/EventHandle.html">EventHandle</a></li>
+
+ <li><a href="../classes/EventTarget.html">EventTarget</a></li>
+
+ <li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
+
+ <li><a href="../classes/Features.html">Features</a></li>
+
+ <li><a href="../classes/File.html">File</a></li>
+
+ <li><a href="../classes/FileFlash.html">FileFlash</a></li>
+
+ <li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
+
+ <li><a href="../classes/Fills.html">Fills</a></li>
+
+ <li><a href="../classes/Frame.html">Frame</a></li>
+
+ <li><a href="../classes/Get.html">Get</a></li>
+
+ <li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
+
+ <li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
+
+ <li><a href="../classes/Graph.html">Graph</a></li>
+
+ <li><a href="../classes/Graphic.html">Graphic</a></li>
+
+ <li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
+
+ <li><a href="../classes/Gridlines.html">Gridlines</a></li>
+
+ <li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
+
+ <li><a href="../classes/GroupRect.html">GroupRect</a></li>
+
+ <li><a href="../classes/Handlebars.html">Handlebars</a></li>
+
+ <li><a href="../classes/Highlight.html">Highlight</a></li>
+
+ <li><a href="../classes/Histogram.html">Histogram</a></li>
+
+ <li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
+
+ <li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
+
+ <li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
+
+ <li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
+
+ <li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
+
+ <li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
+
+ <li><a href="../classes/Intl.html">Intl</a></li>
+
+ <li><a href="../classes/IO.html">IO</a></li>
+
+ <li><a href="../classes/JSON.html">JSON</a></li>
+
+ <li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
+
+ <li><a href="../classes/Lang.html">Lang</a></li>
+
+ <li><a href="../classes/LazyModelList.html">LazyModelList</a></li>
+
+ <li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
+
+ <li><a href="../classes/Lines.html">Lines</a></li>
+
+ <li><a href="../classes/LineSeries.html">LineSeries</a></li>
+
+ <li><a href="../classes/Loader.html">Loader</a></li>
+
+ <li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
+
+ <li><a href="../classes/Matrix.html">Matrix</a></li>
+
+ <li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li>
+
+ <li><a href="../classes/Model.html">Model</a></li>
+
+ <li><a href="../classes/ModelList.html">ModelList</a></li>
+
+ <li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li>
+
+ <li><a href="../classes/Node.html">Node</a></li>
+
+ <li><a href="../classes/NodeList.html">NodeList</a></li>
+
+ <li><a href="../classes/Number.html">Number</a></li>
+
+ <li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
+
+ <li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li>
+
+ <li><a href="../classes/NumericImpl.html">NumericImpl</a></li>
+
+ <li><a href="../classes/Object.html">Object</a></li>
+
+ <li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li>
+
+ <li><a href="../classes/Overlay.html">Overlay</a></li>
+
+ <li><a href="../classes/Panel.html">Panel</a></li>
+
+ <li><a href="../classes/Parallel.html">Parallel</a></li>
+
+ <li><a href="../classes/Path.html">Path</a></li>
+
+ <li><a href="../classes/PieChart.html">PieChart</a></li>
+
+ <li><a href="../classes/PieSeries.html">PieSeries</a></li>
+
+ <li><a href="../classes/Pjax.html">Pjax</a></li>
+
+ <li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
+
+ <li><a href="../classes/PjaxContent.html">PjaxContent</a></li>
+
+ <li><a href="../classes/Plots.html">Plots</a></li>
+
+ <li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
+
+ <li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
+
+ <li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
+
+ <li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li>
+
+ <li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
+
+ <li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
+
+ <li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
+
+ <li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
+
+ <li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
+
+ <li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
+
+ <li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
+
+ <li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
+
+ <li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
+
+ <li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
+
+ <li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
+
+ <li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
+
+ <li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
+
+ <li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
+
+ <li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
+
+ <li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
+
+ <li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
+
+ <li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
+
+ <li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
+
+ <li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
+
+ <li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
+
+ <li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
+
+ <li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
+
+ <li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
+
+ <li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
+
+ <li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
+
+ <li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
+
+ <li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
+
+ <li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
+
+ <li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
+
+ <li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
+
+ <li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li>
+
+ <li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
+
+ <li><a href="../classes/Pollable.html">Pollable</a></li>
+
+ <li><a href="../classes/Promise.html">Promise</a></li>
+
+ <li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li>
+
+ <li><a href="../classes/QueryString.html">QueryString</a></li>
+
+ <li><a href="../classes/Queue.html">Queue</a></li>
+
+ <li><a href="../classes/RangeSeries.html">RangeSeries</a></li>
+
+ <li><a href="../classes/Record.html">Record</a></li>
+
+ <li><a href="../classes/Recordset.html">Recordset</a></li>
+
+ <li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
+
+ <li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
+
+ <li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
+
+ <li><a href="../classes/Rect.html">Rect</a></li>
+
+ <li><a href="../classes/Renderer.html">Renderer</a></li>
+
+ <li><a href="../classes/Resize.html">Resize</a></li>
+
+ <li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
+
+ <li><a href="../classes/Router.html">Router</a></li>
+
+ <li><a href="../classes/ScrollView.html">ScrollView</a></li>
+
+ <li><a href="../classes/Selector.html">Selector</a></li>
+
+ <li><a href="../classes/SeriesBase.html">SeriesBase</a></li>
+
+ <li><a href="../classes/Shape.html">Shape</a></li>
+
+ <li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
+
+ <li><a href="../classes/Slider.html">Slider</a></li>
+
+ <li><a href="../classes/SliderBase.html">SliderBase</a></li>
+
+ <li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
+
+ <li><a href="../classes/soon.html">soon</a></li>
+
+ <li><a href="../classes/Sortable.html">Sortable</a></li>
+
+ <li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
+
+ <li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
+
+ <li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
+
+ <li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li>
+
+ <li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
+
+ <li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
+
+ <li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
+
+ <li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
+
+ <li><a href="../classes/StackedImpl.html">StackedImpl</a></li>
+
+ <li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
+
+ <li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
+
+ <li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
+
+ <li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
+
+ <li><a href="../classes/State.html">State</a></li>
+
+ <li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
+
+ <li><a href="../classes/Subscriber.html">Subscriber</a></li>
+
+ <li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
+
+ <li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
+
+ <li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
+
+ <li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
+
+ <li><a href="../classes/SVGPath.html">SVGPath</a></li>
+
+ <li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
+
+ <li><a href="../classes/SVGRect.html">SVGRect</a></li>
+
+ <li><a href="../classes/SVGShape.html">SVGShape</a></li>
+
+ <li><a href="../classes/SWF.html">SWF</a></li>
+
+ <li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
+
+ <li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
+
+ <li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
+
+ <li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
+
+ <li><a href="../classes/Tab.html">Tab</a></li>
+
+ <li><a href="../classes/TabView.html">TabView</a></li>
+
+ <li><a href="../classes/Template.html">Template</a></li>
+
+ <li><a href="../classes/Template.Micro.html">Template.Micro</a></li>
+
+ <li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
+
+ <li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
+
+ <li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
+
+ <li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
+
+ <li><a href="../classes/Test.Console.html">Test.Console</a></li>
+
+ <li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
+
+ <li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
+
+ <li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
+
+ <li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
+
+ <li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
+
+ <li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
+
+ <li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
+
+ <li><a href="../classes/Test.Results.html">Test.Results</a></li>
+
+ <li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
+
+ <li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
+
+ <li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
+
+ <li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
+
+ <li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
+
+ <li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
+
+ <li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
+
+ <li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
+
+ <li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
+
+ <li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
+
+ <li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
+
+ <li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
+
+ <li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
+
+ <li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
+
+ <li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li>
+
+ <li><a href="../classes/TimeImpl.html">TimeImpl</a></li>
+
+ <li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
+
+ <li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
+
+ <li><a href="../classes/Transition.html">Transition</a></li>
+
+ <li><a href="../classes/Tree.html">Tree</a></li>
+
+ <li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.html">Tree.Node</a></li>
+
+ <li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li>
+
+ <li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li>
+
+ <li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li>
+
+ <li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li>
+
+ <li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li>
+
+ <li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li>
+
+ <li><a href="../classes/UA.html">UA</a></li>
+
+ <li><a href="../classes/Uploader.html">Uploader</a></li>
+
+ <li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
+
+ <li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
+
+ <li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
+
+ <li><a href="../classes/ValueChange.html">ValueChange</a></li>
+
+ <li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
+
+ <li><a href="../classes/View.html">View</a></li>
+
+ <li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
+
+ <li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
+
+ <li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
+
+ <li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
+
+ <li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
+
+ <li><a href="../classes/VMLPath.html">VMLPath</a></li>
+
+ <li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
+
+ <li><a href="../classes/VMLRect.html">VMLRect</a></li>
+
+ <li><a href="../classes/VMLShape.html">VMLShape</a></li>
+
+ <li><a href="../classes/Widget.html">Widget</a></li>
+
+ <li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
+
+ <li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
+
+ <li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
+
+ <li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
+
+ <li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
+
+ <li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
+
+ <li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
+
+ <li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
+
+ <li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
+
+ <li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
+
+ <li><a href="../classes/XML.html">XML</a></li>
+
+ <li><a href="../classes/YQL.html">YQL</a></li>
+
+ <li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
+
+ <li><a href="../classes/YUI.html">YUI</a></li>
+
+ <li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
+
+ </ul>
+
+ <ul id="api-modules" class="apis modules">
+
+ <li><a href="../modules/align-plugin.html">align-plugin</a></li>
+
+ <li><a href="../modules/anim.html">anim</a></li>
+
+ <li><a href="../modules/anim-base.html">anim-base</a></li>
+
+ <li><a href="../modules/anim-color.html">anim-color</a></li>
+
+ <li><a href="../modules/anim-curve.html">anim-curve</a></li>
+
+ <li><a href="../modules/anim-easing.html">anim-easing</a></li>
+
+ <li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
+
+ <li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
+
+ <li><a href="../modules/anim-shape.html">anim-shape</a></li>
+
+ <li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
+
+ <li><a href="../modules/anim-xy.html">anim-xy</a></li>
+
+ <li><a href="../modules/app.html">app</a></li>
+
+ <li><a href="../modules/app-base.html">app-base</a></li>
+
+ <li><a href="../modules/app-content.html">app-content</a></li>
+
+ <li><a href="../modules/app-transitions.html">app-transitions</a></li>
+
+ <li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
+
+ <li><a href="../modules/array-extras.html">array-extras</a></li>
+
+ <li><a href="../modules/array-invoke.html">array-invoke</a></li>
+
+ <li><a href="../modules/arraylist.html">arraylist</a></li>
+
+ <li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
+
+ <li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
+
+ <li><a href="../modules/arraysort.html">arraysort</a></li>
+
+ <li><a href="../modules/async-queue.html">async-queue</a></li>
+
+ <li><a href="../modules/attribute.html">attribute</a></li>
+
+ <li><a href="../modules/attribute-base.html">attribute-base</a></li>
+
+ <li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
+
+ <li><a href="../modules/attribute-core.html">attribute-core</a></li>
+
+ <li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
+
+ <li><a href="../modules/attribute-observable.html">attribute-observable</a></li>
+
+ <li><a href="../modules/autocomplete.html">autocomplete</a></li>
+
+ <li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
+
+ <li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
+
+ <li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
+
+ <li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
+
+ <li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
+
+ <li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
+
+ <li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
+
+ <li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
+
+ <li><a href="../modules/axis.html">axis</a></li>
+
+ <li><a href="../modules/axis-base.html">axis-base</a></li>
+
+ <li><a href="../modules/axis-category.html">axis-category</a></li>
+
+ <li><a href="../modules/axis-category-base.html">axis-category-base</a></li>
+
+ <li><a href="../modules/axis-numeric.html">axis-numeric</a></li>
+
+ <li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li>
+
+ <li><a href="../modules/axis-stacked.html">axis-stacked</a></li>
+
+ <li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li>
+
+ <li><a href="../modules/axis-time.html">axis-time</a></li>
+
+ <li><a href="../modules/axis-time-base.html">axis-time-base</a></li>
+
+ <li><a href="../modules/base.html">base</a></li>
+
+ <li><a href="../modules/base-base.html">base-base</a></li>
+
+ <li><a href="../modules/base-build.html">base-build</a></li>
+
+ <li><a href="../modules/base-core.html">base-core</a></li>
+
+ <li><a href="../modules/base-observable.html">base-observable</a></li>
+
+ <li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
+
+ <li><a href="../modules/button.html">button</a></li>
+
+ <li><a href="../modules/button-core.html">button-core</a></li>
+
+ <li><a href="../modules/button-group.html">button-group</a></li>
+
+ <li><a href="../modules/button-plugin.html">button-plugin</a></li>
+
+ <li><a href="../modules/cache.html">cache</a></li>
+
+ <li><a href="../modules/cache-base.html">cache-base</a></li>
+
+ <li><a href="../modules/cache-offline.html">cache-offline</a></li>
+
+ <li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
+
+ <li><a href="../modules/calendar.html">calendar</a></li>
+
+ <li><a href="../modules/calendar-base.html">calendar-base</a></li>
+
+ <li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
+
+ <li><a href="../modules/charts.html">charts</a></li>
+
+ <li><a href="../modules/charts-base.html">charts-base</a></li>
+
+ <li><a href="../modules/charts-legend.html">charts-legend</a></li>
+
+ <li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
+
+ <li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
+
+ <li><a href="../modules/collection.html">collection</a></li>
+
+ <li><a href="../modules/color.html">color</a></li>
+
+ <li><a href="../modules/color-base.html">color-base</a></li>
+
+ <li><a href="../modules/color-harmony.html">color-harmony</a></li>
+
+ <li><a href="../modules/color-hsl.html">color-hsl</a></li>
+
+ <li><a href="../modules/color-hsv.html">color-hsv</a></li>
+
+ <li><a href="../modules/console.html">console</a></li>
+
+ <li><a href="../modules/console-filters.html">console-filters</a></li>
+
+ <li><a href="../modules/cookie.html">cookie</a></li>
+
+ <li><a href="../modules/createlink-base.html">createlink-base</a></li>
+
+ <li><a href="../modules/dataschema.html">dataschema</a></li>
+
+ <li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
+
+ <li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
+
+ <li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
+
+ <li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
+
+ <li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
+
+ <li><a href="../modules/datasource.html">datasource</a></li>
+
+ <li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
+
+ <li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
+
+ <li><a href="../modules/datasource-function.html">datasource-function</a></li>
+
+ <li><a href="../modules/datasource-get.html">datasource-get</a></li>
+
+ <li><a href="../modules/datasource-io.html">datasource-io</a></li>
+
+ <li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
+
+ <li><a href="../modules/datasource-local.html">datasource-local</a></li>
+
+ <li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
+
+ <li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
+
+ <li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
+
+ <li><a href="../modules/datatable.html">datatable</a></li>
+
+ <li><a href="../modules/datatable-base.html">datatable-base</a></li>
+
+ <li><a href="../modules/datatable-body.html">datatable-body</a></li>
+
+ <li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
+
+ <li><a href="../modules/datatable-core.html">datatable-core</a></li>
+
+ <li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
+
+ <li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li>
+
+ <li><a href="../modules/datatable-head.html">datatable-head</a></li>
+
+ <li><a href="../modules/datatable-message.html">datatable-message</a></li>
+
+ <li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
+
+ <li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
+
+ <li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
+
+ <li><a href="../modules/datatable-table.html">datatable-table</a></li>
+
+ <li><a href="../modules/datatype.html">datatype</a></li>
+
+ <li><a href="../modules/datatype-date.html">datatype-date</a></li>
+
+ <li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
+
+ <li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
+
+ <li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
+
+ <li><a href="../modules/datatype-number.html">datatype-number</a></li>
+
+ <li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
+
+ <li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
+
+ <li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
+
+ <li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
+
+ <li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
+
+ <li><a href="../modules/dd.html">dd</a></li>
+
+ <li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
+
+ <li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
+
+ <li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
+
+ <li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
+
+ <li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
+
+ <li><a href="../modules/dd-drag.html">dd-drag</a></li>
+
+ <li><a href="../modules/dd-drop.html">dd-drop</a></li>
+
+ <li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
+
+ <li><a href="../modules/dd-gestures.html">dd-gestures</a></li>
+
+ <li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
+
+ <li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
+
+ <li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
+
+ <li><a href="../modules/dial.html">dial</a></li>
+
+ <li><a href="../modules/dom.html">dom</a></li>
+
+ <li><a href="../modules/dom-base.html">dom-base</a></li>
+
+ <li><a href="../modules/dom-screen.html">dom-screen</a></li>
+
+ <li><a href="../modules/dom-style.html">dom-style</a></li>
+
+ <li><a href="../modules/dump.html">dump</a></li>
+
+ <li><a href="../modules/editor.html">editor</a></li>
+
+ <li><a href="../modules/editor-base.html">editor-base</a></li>
+
+ <li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
+
+ <li><a href="../modules/editor-br.html">editor-br</a></li>
+
+ <li><a href="../modules/editor-lists.html">editor-lists</a></li>
+
+ <li><a href="../modules/editor-para.html">editor-para</a></li>
+
+ <li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
+
+ <li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
+
+ <li><a href="../modules/editor-tab.html">editor-tab</a></li>
+
+ <li><a href="../modules/escape.html">escape</a></li>
+
+ <li><a href="../modules/event.html">event</a></li>
+
+ <li><a href="../modules/event-base.html">event-base</a></li>
+
+ <li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
+
+ <li><a href="../modules/event-custom.html">event-custom</a></li>
+
+ <li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
+
+ <li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
+
+ <li><a href="../modules/event-delegate.html">event-delegate</a></li>
+
+ <li><a href="../modules/event-flick.html">event-flick</a></li>
+
+ <li><a href="../modules/event-focus.html">event-focus</a></li>
+
+ <li><a href="../modules/event-gestures.html">event-gestures</a></li>
+
+ <li><a href="../modules/event-hover.html">event-hover</a></li>
+
+ <li><a href="../modules/event-key.html">event-key</a></li>
+
+ <li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
+
+ <li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
+
+ <li><a href="../modules/event-move.html">event-move</a></li>
+
+ <li><a href="../modules/event-outside.html">event-outside</a></li>
+
+ <li><a href="../modules/event-resize.html">event-resize</a></li>
+
+ <li><a href="../modules/event-simulate.html">event-simulate</a></li>
+
+ <li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
+
+ <li><a href="../modules/event-tap.html">event-tap</a></li>
+
+ <li><a href="../modules/event-touch.html">event-touch</a></li>
+
+ <li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
+
+ <li><a href="../modules/exec-command.html">exec-command</a></li>
+
+ <li><a href="../modules/features.html">features</a></li>
+
+ <li><a href="../modules/file.html">file</a></li>
+
+ <li><a href="../modules/file-flash.html">file-flash</a></li>
+
+ <li><a href="../modules/file-html5.html">file-html5</a></li>
+
+ <li><a href="../modules/frame.html">frame</a></li>
+
+ <li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li>
+
+ <li><a href="../modules/get.html">get</a></li>
+
+ <li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
+
+ <li><a href="../modules/graphics.html">graphics</a></li>
+
+ <li><a href="../modules/graphics-group.html">graphics-group</a></li>
+
+ <li><a href="../modules/handlebars.html">handlebars</a></li>
+
+ <li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
+
+ <li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
+
+ <li><a href="../modules/highlight.html">highlight</a></li>
+
+ <li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
+
+ <li><a href="../modules/highlight-base.html">highlight-base</a></li>
+
+ <li><a href="../modules/history.html">history</a></li>
+
+ <li><a href="../modules/history-base.html">history-base</a></li>
+
+ <li><a href="../modules/history-hash.html">history-hash</a></li>
+
+ <li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
+
+ <li><a href="../modules/history-html5.html">history-html5</a></li>
+
+ <li><a href="../modules/imageloader.html">imageloader</a></li>
+
+ <li><a href="../modules/intl.html">intl</a></li>
+
+ <li><a href="../modules/io.html">io</a></li>
+
+ <li><a href="../modules/io-base.html">io-base</a></li>
+
+ <li><a href="../modules/io-form.html">io-form</a></li>
+
+ <li><a href="../modules/io-nodejs.html">io-nodejs</a></li>
+
+ <li><a href="../modules/io-queue.html">io-queue</a></li>
+
+ <li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
+
+ <li><a href="../modules/io-xdr.html">io-xdr</a></li>
+
+ <li><a href="../modules/json.html">json</a></li>
+
+ <li><a href="../modules/json-parse.html">json-parse</a></li>
+
+ <li><a href="../modules/json-stringify.html">json-stringify</a></li>
+
+ <li><a href="../modules/jsonp.html">jsonp</a></li>
+
+ <li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
+
+ <li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li>
+
+ <li><a href="../modules/loader.html">loader</a></li>
+
+ <li><a href="../modules/loader-base.html">loader-base</a></li>
+
+ <li><a href="../modules/loader-yui3.html">loader-yui3</a></li>
+
+ <li><a href="../modules/matrix.html">matrix</a></li>
+
+ <li><a href="../modules/model.html">model</a></li>
+
+ <li><a href="../modules/model-list.html">model-list</a></li>
+
+ <li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li>
+
+ <li><a href="../modules/node.html">node</a></li>
+
+ <li><a href="../modules/node-base.html">node-base</a></li>
+
+ <li><a href="../modules/node-core.html">node-core</a></li>
+
+ <li><a href="../modules/node-data.html">node-data</a></li>
+
+ <li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
+
+ <li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
+
+ <li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
+
+ <li><a href="../modules/node-flick.html">node-flick</a></li>
+
+ <li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
+
+ <li><a href="../modules/node-load.html">node-load</a></li>
+
+ <li><a href="../modules/node-menunav.html">node-menunav</a></li>
+
+ <li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
+
+ <li><a href="../modules/node-screen.html">node-screen</a></li>
+
+ <li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li>
+
+ <li><a href="../modules/node-style.html">node-style</a></li>
+
+ <li><a href="../modules/oop.html">oop</a></li>
+
+ <li><a href="../modules/overlay.html">overlay</a></li>
+
+ <li><a href="../modules/panel.html">panel</a></li>
+
+ <li><a href="../modules/parallel.html">parallel</a></li>
+
+ <li><a href="../modules/pjax.html">pjax</a></li>
+
+ <li><a href="../modules/pjax-base.html">pjax-base</a></li>
+
+ <li><a href="../modules/pjax-content.html">pjax-content</a></li>
+
+ <li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
+
+ <li><a href="../modules/plugin.html">plugin</a></li>
+
+ <li><a href="../modules/pluginhost.html">pluginhost</a></li>
+
+ <li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
+
+ <li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
+
+ <li><a href="../modules/promise.html">promise</a></li>
+
+ <li><a href="../modules/querystring.html">querystring</a></li>
+
+ <li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
+
+ <li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
+
+ <li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
+
+ <li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
+
+ <li><a href="../modules/queue-promote.html">queue-promote</a></li>
+
+ <li><a href="../modules/range-slider.html">range-slider</a></li>
+
+ <li><a href="../modules/recordset.html">recordset</a></li>
+
+ <li><a href="../modules/recordset-base.html">recordset-base</a></li>
+
+ <li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
+
+ <li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
+
+ <li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
+
+ <li><a href="../modules/resize.html">resize</a></li>
+
+ <li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
+
+ <li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
+
+ <li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
+
+ <li><a href="../modules/rollup.html">rollup</a></li>
+
+ <li><a href="../modules/router.html">router</a></li>
+
+ <li><a href="../modules/scrollview.html">scrollview</a></li>
+
+ <li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
+
+ <li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
+
+ <li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
+
+ <li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
+
+ <li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
+
+ <li><a href="../modules/selection.html">selection</a></li>
+
+ <li><a href="../modules/selector-css2.html">selector-css2</a></li>
+
+ <li><a href="../modules/selector-css3.html">selector-css3</a></li>
+
+ <li><a href="../modules/selector-native.html">selector-native</a></li>
+
+ <li><a href="../modules/series-area.html">series-area</a></li>
+
+ <li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li>
+
+ <li><a href="../modules/series-areaspline.html">series-areaspline</a></li>
+
+ <li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li>
+
+ <li><a href="../modules/series-bar.html">series-bar</a></li>
+
+ <li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li>
+
+ <li><a href="../modules/series-base.html">series-base</a></li>
+
+ <li><a href="../modules/series-candlestick.html">series-candlestick</a></li>
+
+ <li><a href="../modules/series-cartesian.html">series-cartesian</a></li>
+
+ <li><a href="../modules/series-column.html">series-column</a></li>
+
+ <li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li>
+
+ <li><a href="../modules/series-combo.html">series-combo</a></li>
+
+ <li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li>
+
+ <li><a href="../modules/series-combospline.html">series-combospline</a></li>
+
+ <li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li>
+
+ <li><a href="../modules/series-curve-util.html">series-curve-util</a></li>
+
+ <li><a href="../modules/series-fill-util.html">series-fill-util</a></li>
+
+ <li><a href="../modules/series-histogram.html">series-histogram</a></li>
+
+ <li><a href="../modules/series-line.html">series-line</a></li>
+
+ <li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li>
+
+ <li><a href="../modules/series-line-util.html">series-line-util</a></li>
+
+ <li><a href="../modules/series-marker.html">series-marker</a></li>
+
+ <li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li>
+
+ <li><a href="../modules/series-ohlc.html">series-ohlc</a></li>
+
+ <li><a href="../modules/series-pie.html">series-pie</a></li>
+
+ <li><a href="../modules/series-plot-util.html">series-plot-util</a></li>
+
+ <li><a href="../modules/series-range.html">series-range</a></li>
+
+ <li><a href="../modules/series-spline.html">series-spline</a></li>
+
+ <li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li>
+
+ <li><a href="../modules/series-stacked.html">series-stacked</a></li>
+
+ <li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
+
+ <li><a href="../modules/slider.html">slider</a></li>
+
+ <li><a href="../modules/slider-base.html">slider-base</a></li>
+
+ <li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
+
+ <li><a href="../modules/sortable.html">sortable</a></li>
+
+ <li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
+
+ <li><a href="../modules/stylesheet.html">stylesheet</a></li>
+
+ <li><a href="../modules/substitute.html">substitute</a></li>
+
+ <li><a href="../modules/swf.html">swf</a></li>
+
+ <li><a href="../modules/swfdetect.html">swfdetect</a></li>
+
+ <li><a href="../modules/tabview.html">tabview</a></li>
+
+ <li><a href="../modules/template.html">template</a></li>
+
+ <li><a href="../modules/template-base.html">template-base</a></li>
+
+ <li><a href="../modules/template-micro.html">template-micro</a></li>
+
+ <li><a href="../modules/test.html">test</a></li>
+
+ <li><a href="../modules/test-console.html">test-console</a></li>
+
+ <li><a href="../modules/text.html">text</a></li>
+
+ <li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
+
+ <li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
+
+ <li><a href="../modules/timers.html">timers</a></li>
+
+ <li><a href="../modules/transition.html">transition</a></li>
+
+ <li><a href="../modules/transition-timer.html">transition-timer</a></li>
+
+ <li><a href="../modules/tree.html">tree</a></li>
+
+ <li><a href="../modules/tree-labelable.html">tree-labelable</a></li>
+
+ <li><a href="../modules/tree-lazy.html">tree-lazy</a></li>
+
+ <li><a href="../modules/tree-node.html">tree-node</a></li>
+
+ <li><a href="../modules/tree-openable.html">tree-openable</a></li>
+
+ <li><a href="../modules/tree-selectable.html">tree-selectable</a></li>
+
+ <li><a href="../modules/tree-sortable.html">tree-sortable</a></li>
+
+ <li><a href="../modules/uploader.html">uploader</a></li>
+
+ <li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
+
+ <li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
+
+ <li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
+
+ <li><a href="../modules/view.html">view</a></li>
+
+ <li><a href="../modules/view-node-map.html">view-node-map</a></li>
+
+ <li><a href="../modules/widget.html">widget</a></li>
+
+ <li><a href="../modules/widget-anim.html">widget-anim</a></li>
+
+ <li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
+
+ <li><a href="../modules/widget-base.html">widget-base</a></li>
+
+ <li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
+
+ <li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
+
+ <li><a href="../modules/widget-child.html">widget-child</a></li>
+
+ <li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
+
+ <li><a href="../modules/widget-locale.html">widget-locale</a></li>
+
+ <li><a href="../modules/widget-modality.html">widget-modality</a></li>
+
+ <li><a href="../modules/widget-parent.html">widget-parent</a></li>
+
+ <li><a href="../modules/widget-position.html">widget-position</a></li>
+
+ <li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
+
+ <li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
+
+ <li><a href="../modules/widget-skin.html">widget-skin</a></li>
+
+ <li><a href="../modules/widget-stack.html">widget-stack</a></li>
+
+ <li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
+
+ <li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
+
+ <li><a href="../modules/yql.html">yql</a></li>
+
+ <li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li>
+
+ <li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li>
+
+ <li><a href="../modules/yql-winjs.html">yql-winjs</a></li>
+
+ <li><a href="../modules/yui.html">yui</a></li>
+
+ <li><a href="../modules/yui-base.html">yui-base</a></li>
+
+ <li><a href="../modules/yui-later.html">yui-later</a></li>
+
+ <li><a href="../modules/yui-log.html">yui-log</a></li>
+
+ <li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
+
+ </ul>
+ </div>
+ </div>
+</div>
+
+ </div>
+ </div>
+ <div class="yui3-u-3-4">
+ <div id="api-options">
+ Show:
+ <label for="api-show-inherited">
+ <input type="checkbox" id="api-show-inherited" checked>
+ Inherited
+ </label>
+
+ <label for="api-show-protected">
+ <input type="checkbox" id="api-show-protected">
+ Protected
+ </label>
+
+ <label for="api-show-private">
+ <input type="checkbox" id="api-show-private">
+ Private
+ </label>
+ <label for="api-show-deprecated">
+ <input type="checkbox" id="api-show-deprecated">
+ Deprecated
+ </label>
+
+ </div>
+
+
+ <div class="apidocs">
+ <div id="docs-main">
+ <div class="content">
+ <h1>Event Class</h1>
+<div class="box meta">
+
+
+
+
+
+ <div class="foundat">
+ Defined in: <a href="../files/event_js_event-dom.js.html#l12"><code>event/js/event-dom.js:12</code></a>
+ </div>
+
+
+
+
+ Module: <a href="../modules/event-base.html">event-base</a><br>
+ Parent Module: <a href="../modules/event.html">event</a>
+
+
+
+
+</div>
+
+
+
+<div class="box intro">
+ <p>The event utility provides functions to add and remove event listeners,
+event cleansing. It also tries to automatically remove listeners it
+registers during the unload event.</p>
+</div>
+
+
+
+<div id="classdocs" class="tabview">
+ <ul class="api-class-tabs">
+ <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+
+ <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
+
+
+ <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
+
+
+
+ <li class="api-class-tab events"><a href="#events">Events</a></li>
+
+ </ul>
+
+ <div>
+ <div id="index" class="api-class-tabpanel index">
+ <h2 class="off-left">Item Index</h2>
+
+
+ <div class="index-section methods">
+ <h3>Methods</h3>
+
+ <ul class="index-list methods">
+
+ <li class="index-item method protected">
+ <a href="#method__applyFilter">_applyFilter</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__calculateDefaultPoint">_calculateDefaultPoint</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__clean">_clean</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__createTouchList">_createTouchList</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__getDims">_getDims</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__getEmptyTouchList">_getEmptyTouchList</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__isSingleTouch">_isSingleTouch</a>
+
+
+
+ </li>
+
+ <li class="index-item method private deprecated">
+ <a href="#method__isValidCollection">_isValidCollection</a>
+
+
+ <span class="flag static">static</span>
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__load">_load</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__move">_move</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__poll">_poll</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__simulateEvent">_simulateEvent</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__toRadian">_toRadian</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method__unload">_unload</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_attach">attach</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_compileFilter">compileFilter</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_define">define</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_defineOutside">defineOutside</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_delegate">delegate</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method public">
+ <a href="#method_delegate">delegate</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_detach">detach</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method public">
+ <a href="#method_detach">detach</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method public">
+ <a href="#method_detachDelegate">detachDelegate</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_flick">flick</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_generateId">generateId</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_getEvent">getEvent</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_getListeners">getListeners</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_move">move</a>
+
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method_nativeAdd">nativeAdd</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method_nativeRemove">nativeRemove</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method_notifySub">notifySub</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method public">
+ <a href="#method_on">on</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method deprecated">
+ <a href="#method_onAvailable">onAvailable</a>
+
+
+ <span class="flag static">static</span>
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method deprecated">
+ <a href="#method_onContentReady">onContentReady</a>
+
+
+ <span class="flag static">static</span>
+
+
+ <span class="flag deprecated">deprecated</span>
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_pinch">pinch</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_purgeElement">purgeElement</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_rotate">rotate</a>
+
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_simulate">simulate</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_simulateGesture">simulateGesture</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method private">
+ <a href="#method_startInterval">startInterval</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method">
+ <a href="#method_tap">tap</a>
+
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method_touchEnd">touchEnd</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method_touchMove">touchMove</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item method protected">
+ <a href="#method_touchStart">touchStart</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="index-section properties">
+ <h3>Properties</h3>
+
+ <ul class="index-list properties">
+
+ <li class="index-item property private">
+ <a href="#property__avail">_avail</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property protected">
+ <a href="#property__disabledRE">_disabledRE</a>
+
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__dri">_dri</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__el_events">_el_events</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__interval">_interval</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__loadComplete">_loadComplete</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__retryCount">_retryCount</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property private">
+ <a href="#property__wrappers">_wrappers</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_DOMReady">DOMReady</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_lastError">lastError</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_POLL_INTERVAL">POLL_INTERVAL</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ <li class="index-item property">
+ <a href="#property_POLL_RETRYS">POLL_RETRYS</a>
+
+
+ <span class="flag static">static</span>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+ <div class="index-section events">
+ <h3>Events</h3>
+
+ <ul class="index-list events">
+
+ <li class="index-item event">
+ <a href="#event_tap">tap</a>
+
+
+
+ </li>
+
+ </ul>
+ </div>
+
+ </div>
+
+
+ <div id="methods" class="api-class-tabpanel">
+ <h2 class="off-left">Methods</h2>
+
+
+ <div id="method__applyFilter" class="method item protected">
+ <h3 class="name"><code>_applyFilter</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>filter</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>ce</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="../classes/Node.html" class="crosslink">Node[]</a> | Undefined</span>
+ </span>
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l226"><code>event/js/delegate.js:226</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Walks up the parent axis of an event's target, and tests each element
+against a supplied filter function. If any Nodes, including the container,
+satisfy the filter, the delegated callback will be triggered for each.</p>
+
+<p>Hosted as a protected property of the <code>delegate</code> method (e.g.
+<code>Y.delegate._applyFilter</code>).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">filter</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>boolean function to test for inclusion in event
+ notification</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the arguments that would be passed to subscribers</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">ce</code>
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the DOM event wrapper</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="../classes/Node.html" class="crosslink">Node[]</a> | Undefined</span>:
+
+ The Node or Nodes that satisfy the filter
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__calculateDefaultPoint" class="method item private">
+ <h3 class="name"><code>_calculateDefaultPoint</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>point</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l149"><code>gesture-simulate/js/gesture-simulate.js:149</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to convert a point relative to the node element into
+the point in the page coordination.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">point</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A point relative to the node element.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ The same point in the page coordination.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__clean" class="method item private">
+ <h3 class="name"><code>_clean</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>wrapper</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l806"><code>event/js/event-dom.js:806</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.4.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Removes all object references and the DOM proxy subscription for
+a given event for a DOM node.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">wrapper</code>
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Custom event proxy for the DOM
+ subscription</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__createTouchList" class="method item private">
+ <h3 class="name"><code>_createTouchList</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>touchPoints</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">TouchList | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l929"><code>gesture-simulate/js/gesture-simulate.js:929</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to convert an array with touch points to TouchList object as
+defined in http://www.w3.org/TR/touch-events/</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">touchPoints</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">TouchList | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ If underlaying platform support creating touch list
+ a TouchList object will be returned otherwise a fake Array object
+ will be returned.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getDims" class="method item private">
+ <h3 class="name"><code>_getDims</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l109"><code>gesture-simulate/js/gesture-simulate.js:109</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to get height/width while accounting for
+rotation/scale transforms where possible by using the
+bounding client rectangle height/width instead of the
+offsetWidth/Height which region uses.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ Array with [height, width]
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__getEmptyTouchList" class="method item private">
+ <h3 class="name"><code>_getEmptyTouchList</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+ <span class="returns-inline">
+ <span class="type">TouchList | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l914"><code>gesture-simulate/js/gesture-simulate.js:914</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to return a singleton instance of empty touch list.</p>
+ </div>
+
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">TouchList | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
+
+ An empty touch list object.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__isSingleTouch" class="method item private">
+ <h3 class="name"><code>_isSingleTouch</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>touches</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>targetTouches</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>changedTouches</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l1065"><code>gesture-simulate/js/gesture-simulate.js:1065</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to check the single touch.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">touches</code>
+ <span class="type">TouchList</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">targetTouches</code>
+ <span class="type">TouchList</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">changedTouches</code>
+ <span class="type">TouchList</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__isValidCollection" class="method item private deprecated">
+ <h3 class="name"><code>_isValidCollection</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>o</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+ <span class="flag deprecated" title="was not meant to be used directly">deprecated</span>
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l612"><code>event/js/event-dom.js:612</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: was not meant to be used directly</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>We want to be able to use getElementsByTagName as a collection
+to attach a group of events to. Unfortunately, different
+browsers return different types of collections. This function
+tests to determine if the object is array-like. It will also
+fail if the object is an array, but is empty.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">o</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the object to test</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ true if the object is array-like and populated
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__load" class="method item private">
+ <h3 class="name"><code>_load</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l627"><code>event/js/event-dom.js:627</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>hook up any deferred listeners</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__move" class="method item private">
+ <h3 class="name"><code>_move</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>duration</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l738"><code>gesture-simulate/js/gesture-simulate.js:738</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>A base method on top of "move" and "flick" methods. The method takes
+the path with start/end properties and duration to generate a set of
+touch events for the movement gesture.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with "start" and "end" properties. Each
+ property should be an array with x and y coordination (e.g. start: [100, 50])</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">duration</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A duration of the gesture in millisecond.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method__poll" class="method item private">
+ <h3 class="name"><code>_poll</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l652"><code>event/js/event-dom.js:652</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Polling function that runs before the onload event fires,
+attempting to attach to DOM Nodes as soon as they are
+available</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method__simulateEvent" class="method item private">
+ <h3 class="name"><code>_simulateEvent</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>target</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>options</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Void</span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l1011"><code>gesture-simulate/js/gesture-simulate.js:1011</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">target</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The DOM element that's the target of the event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type of event or name of the supported gesture to simulate
+ (i.e., "click", "doubletap", "flick").</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">options</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>(Optional) Extra options to copy onto the event object.
+ For gestures, options are used to refine the gesture behavior.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Void</span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__toRadian" class="method item private">
+ <h3 class="name"><code>_toRadian</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>deg</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l97"><code>gesture-simulate/js/gesture-simulate.js:97</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Helper method to convert a degree to a radian.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">deg</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A degree to be converted to a radian.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
+
+ The degree in radian.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method__unload" class="method item private">
+ <h3 class="name"><code>_unload</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l876"><code>event/js/event-dom.js:876</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners registered by pe.event. Called
+automatically during the unload event.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_attach" class="method item">
+ <h3 class="name"><code>attach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l289"><code>event/js/event-dom.js:289</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Adds an event listener</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type of event to append</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="../classes/NodeList.html" class="crosslink">NodeList</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An id, an element
+ reference, or a collection of ids and/or elements to assign the
+ listener to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional context object</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>0..n arguments to pass to the callback</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ an object to that can be used to detach the listener
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_compileFilter" class="method item">
+ <h3 class="name"><code>compileFilter</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>selector</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l183"><code>event/js/delegate.js:183</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.2.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Compiles a selector string into a filter function to identify whether
+Nodes along the parent axis of an event's target should trigger event
+notification.</p>
+
+<p>This function is memoized, so previously compiled filter functions are
+returned if the same selector string is provided.</p>
+
+<p>This function may be useful when defining synthetic events for delegate
+handling.</p>
+
+<p>Hosted as a property of the <code>delegate</code> method (e.g. <code>Y.delegate.compileFilter</code>).</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">selector</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the selector string to base the filtration on</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_define" class="method item">
+ <h3 class="name"><code>define</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>config</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>force</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/SyntheticEvent.html" class="crosslink">SyntheticEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-synthetic.html">event-synthetic</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_synthetic.js.html#l676"><code>event/js/synthetic.js:676</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.1.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Defines a new event in the DOM event system. Implementers are
+responsible for monitoring for a scenario whereby the event is fired. A
+notifier object is provided to the functions identified below. When the
+criteria defining the event are met, call notifier.fire( [args] ); to
+execute event subscribers.</p>
+
+<p>The first parameter is the name of the event. The second parameter is a
+configuration object which define the behavior of the event system when the
+new event is subscribed to or detached from. The methods that should be
+defined in this configuration object are <code>on</code>,
+<code>detach</code>, <code>delegate</code>, and <code>detachDelegate</code>.
+You are free to define any other methods or properties needed to define your
+event. Be aware, however, that since the object is used to subclass
+SyntheticEvent, you should avoid method names used by SyntheticEvent unless
+your intention is to override the default behavior.</p>
+
+<p>This is a list of properties and methods that you can or should specify
+in the configuration object:</p>
+
+<dl>
+ <dt><code>on</code></dt>
+ <dd><code>function (node, subscription, notifier)</code> The
+ implementation logic for subscription. Any special setup you need to
+ do to create the environment for the event being fired--E.g. native
+ DOM event subscriptions. Store subscription related objects and
+ state on the <code>subscription</code> object. When the
+ criteria have been met to fire the synthetic event, call
+ <code>notifier.fire(e)</code>. See Notifier's <code>fire()</code>
+ method for details about what to pass as parameters.</dd>
+
+ <dt><code>detach</code></dt>
+ <dd><code>function (node, subscription, notifier)</code> The
+ implementation logic for cleaning up a detached subscription. E.g.
+ detach any DOM subscriptions added in <code>on</code>.</dd>
+
+ <dt><code>delegate</code></dt>
+ <dd><code>function (node, subscription, notifier, filter)</code> The
+ implementation logic for subscription via <code>Y.delegate</code> or
+ <code>node.delegate</code>. The filter is typically either a selector
+ string or a function. You can use
+ <code>Y.delegate.compileFilter(selectorString)</code> to create a
+ filter function from a selector string if needed. The filter function
+ expects an event object as input and should output either null, a
+ matching Node, or an array of matching Nodes. Otherwise, this acts
+ like <code>on</code> DOM event subscriptions. Store subscription
+ related objects and information on the <code>subscription</code>
+ object. When the criteria have been met to fire the synthetic event,
+ call <code>notifier.fire(e)</code> as noted above.</dd>
+
+ <dt><code>detachDelegate</code></dt>
+ <dd><code>function (node, subscription, notifier)</code> The
+ implementation logic for cleaning up a detached delegate subscription.
+ E.g. detach any DOM delegate subscriptions added in
+ <code>delegate</code>.</dd>
+
+ <dt><code>publishConfig</code></dt>
+ <dd>(Object) The configuration object that will be used to instantiate
+ the underlying CustomEvent. See Notifier's <code>fire</code> method
+ for details.</dd>
+
+ <dt><code>processArgs</code></dt
+ <dd>
+ <p><code>function (argArray, fromDelegate)</code> Optional method
+ to extract any additional arguments from the subscription
+ signature. Using this allows <code>on</code> or
+ <code>delegate</code> signatures like
+ <code>node.on("hover", overCallback,
+ outCallback)</code>.</p>
+ <p>When processing an atypical argument signature, make sure the
+ args array is returned to the normal signature before returning
+ from the function. For example, in the "hover" example
+ above, the <code>outCallback</code> needs to be <code>splice</code>d
+ out of the array. The expected signature of the args array for
+ <code>on()</code> subscriptions is:</p>
+ <pre>
+ <code>[type, callback, target, contextOverride, argN...]</code>
+ </pre>
+ <p>And for <code>delegate()</code>:</p>
+ <pre>
+ <code>[type, callback, target, filter, contextOverride, argN...]</code>
+ </pre>
+ <p>where <code>target</code> is the node the event is being
+ subscribed for. You can see these signatures documented for
+ <code>Y.on()</code> and <code>Y.delegate()</code> respectively.</p>
+ <p>Whatever gets returned from the function will be stored on the
+ <code>subscription</code> object under
+ <code>subscription._extra</code>.</p></dd>
+ <dt><code>subMatch</code></dt>
+ <dd>
+ <p><code>function (sub, args)</code> Compares a set of
+ subscription arguments against a Subscription object to determine
+ if they match. The default implementation compares the callback
+ function against the second argument passed to
+ <code>Y.on(...)</code> or <code>node.detach(...)</code> etc.</p>
+ </dd>
+</dl>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the name of the event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">config</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the prototype definition for the new event (see above)</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">force</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>override an existing event (use with caution)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/SyntheticEvent.html" class="crosslink">SyntheticEvent</a></span>:
+
+ the subclass implementation instance created to
+ handle event subscriptions of this type
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_defineOutside" class="method item">
+ <h3 class="name"><code>defineOutside</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>event</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-outside.html">event-outside</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_outside.js.html#l48"><code>event/js/outside.js:48</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Defines a new outside event to correspond with the given DOM event.</p>
+
+<p>By default, the created synthetic event name will be the name of the event
+with "outside" appended (e.g. "click" becomes "clickoutside"). If you want
+a different name for the created Event, pass it as a second argument like so:
+<code>Y.Event.defineOutside(eventType, "yonderclick")</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">event</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>DOM event</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>(optional) custom outside event name</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_delegate" class="method item">
+ <h3 class="name"><code>delegate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>filter</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l16"><code>event/js/delegate.js:16</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up event delegation on a container element. The delegated event
+will use a supplied selector or filtering function to test if the event
+references at least one node that should trigger the subscription
+callback.</p>
+
+<p>Selector string filters will trigger the callback if the event originated
+from a node that matches it or is contained in a node that matches it.
+Function filters are called for each Node up the parent axis to the
+subscribing container node, and receive at each level the Node and the event
+object. The function should return true (or a truthy value) if that Node
+should trigger the subscription callback. Note, it is possible for filters
+to match multiple Nodes for a single event. In this case, the delegate
+callback will be executed for each matching Node.</p>
+
+<p><p>For each matching Node, the callback will be executed with its 'this'
+object set to the Node matched by the filter (unless a specific context was
+provided during subscription), and the provided event's
+<code>currentTarget</code> will also be set to the matching Node. The
+containing Node from which the subscription was originally made can be
+referenced as <code>e.container</code>.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the event type to delegate</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback function to execute. This function
+ will be provided the event object for the delegated event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element that is the delegation container</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">filter</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>a selector that must match the target of the
+ event or a function to test target and its parents for a match</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional argument that specifies what 'this' refers to.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+ <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
+
+
+ <div class="param-description">
+ <p>0..n additional arguments to pass on to the callback function.
+ These arguments will be added after the event object.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>:
+
+ the detach handle
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_delegate" class="method item public">
+ <h3 class="name"><code>delegate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>filter</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag public">public</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l102"><code>event/js/tap.js:102</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Event delegation for the 'tap' event. The delegated event will use a
+supplied selector or filtering function to test if the event references at least one
+node that should trigger the subscription callback.</p>
+
+<p>Usage:</p>
+
+<pre class="code prettyprint"><code>node.delegate('tap', function (e) {
+ Y.log('li a inside node was tapped.');
+}, 'li a');
+</code></pre>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">filter</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_detach" class="method item">
+ <h3 class="name"><code>detach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l499"><code>event/js/event-dom.js:499</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes an event listener. Supports the signature the event was bound
+with, but the preferred way to remove listeners is using the handle
+that is returned when using Y.on</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type of event to remove.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the method the event invokes. If fn is
+undefined, then all event handlers for the type of event are
+removed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | <a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="../classes/NodeList.html" class="crosslink">NodeList</a> | <a href="../classes/EventHandle.html" class="crosslink">EventHandle</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An
+event handle, an id, an element reference, or a collection
+of ids and/or elements to remove the listener from.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ true if the unbind was successful, false otherwise.
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_detach" class="method item public">
+ <h3 class="name"><code>detach</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag public">public</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l88"><code>event/js/tap.js:88</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Detaches all event subscriptions set up by the event-tap module</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_detachDelegate" class="method item public">
+ <h3 class="name"><code>detachDelegate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag public">public</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l127"><code>event/js/tap.js:127</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Detaches the delegated event subscriptions set up by the event-tap module.
+Only used if you use node.delegate(...) instead of node.on(...);</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_flick" class="method item">
+ <h3 class="name"><code>flick</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>point</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>axis</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>distance</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>duration</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l613"><code>gesture-simulate/js/gesture-simulate.js:613</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The "flick" gesture is a specialized "move" that has some velocity
+and the movement always runs either x or y axis. The velocity is calculated
+with "distance" and "duration" arguments. If the calculated velocity is
+below than the minimum velocity, the given duration will be ignored and
+new duration will be created to make a valid flick gesture.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">point</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A point(relative to the top left corner of the
+ target node element) where the flick gesture should start. The default
+ is the center of the taget node.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">axis</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>Either "x" or "y".</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">distance</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A distance in pixels to flick.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">duration</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A duration of the gesture in millisecond.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_generateId" class="method item">
+ <h3 class="name"><code>generateId</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l600"><code>event/js/event-dom.js:600</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Generates an unique ID for the element if it does not already
+have one.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element to create the id for</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
+
+ the resulting id of the element
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getEvent" class="method item">
+ <h3 class="name"><code>getEvent</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>e</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l581"><code>event/js/event-dom.js:581</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Finds the event in the window object, the caller's arguments, or
+in the arguments of another method in the callstack. This is
+executed automatically for events registered through the event
+manager, so the implementer should not normally need to execute
+this function at all.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">e</code>
+ <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the event parameter from the handler</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element the listener was attached to</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>:
+
+ the event
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_getListeners" class="method item">
+ <h3 class="name"><code>getListeners</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l832"><code>event/js/event-dom.js:832</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Returns all listeners attached to the given element via addListener.
+Optionally, you can specify a specific type of event to return.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element or element id to inspect</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional type of listener to return. If
+left out, all listeners will be returned</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>:
+
+ the custom event wrapper for the DOM event(s)
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_move" class="method item">
+ <h3 class="name"><code>move</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>path</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>duration</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l677"><code>gesture-simulate/js/gesture-simulate.js:677</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The "move" gesture simulate the movement of any direction between
+the straight line of start and end point for the given duration.
+The path argument is an object with "point", "xdist" and "ydist" properties.
+The "point" property is an array with x and y coordinations(relative to the
+top left corner of the target node element) while "xdist" and "ydist"
+properties are used for the distance along the x and y axis. A negative
+distance number can be used to drag either left or up direction. </p>
+
+<p>If no arguments are given, it will simulate the default move, which
+is moving 200 pixels from the center of the element to the positive X-axis
+direction for 1 sec.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">path</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>An object with "point", "xdist" and "ydist".</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">duration</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A duration of the gesture in millisecond.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_nativeAdd" class="method item private">
+ <h3 class="name"><code>nativeAdd</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>capture</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l893"><code>event/js/event-dom.js:893</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Adds a DOM event directly without the caching, cleanup, context adj, etc</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element to bind the handler to</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type of event handler</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback to invoke</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">capture</code>
+ <span class="type">Boolen</span>
+
+
+
+
+ <div class="param-description">
+ <p>capture or bubble phase</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_nativeRemove" class="method item private">
+ <h3 class="name"><code>nativeRemove</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>capture</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l906"><code>event/js/event-dom.js:906</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Basic remove listener</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element to bind the handler to</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the type of event handler</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the callback to invoke</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">capture</code>
+ <span class="type">Boolen</span>
+
+
+
+
+ <div class="param-description">
+ <p>capture or bubble phase</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_notifySub" class="method item private">
+ <h3 class="name"><code>notifySub</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>thisObj</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>args</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>ce</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+ </span>
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l129"><code>event/js/delegate.js:129</code></a>
+
+ </p>
+
+
+
+
+
+ <p>Available since 3.2.0</p>
+
+ </div>
+
+ <div class="description">
+ <p>Overrides the <code>_notify</code> method on the normal DOM subscription to
+inject the filtering logic and only proceed in the case of a match.</p>
+
+<p>This method is hosted as a private property of the <code>delegate</code> method
+(e.g. <code>Y.delegate.notifySub</code>)</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">thisObj</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>default 'this' object for the callback</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">args</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>arguments passed to the event's <code>fire()</code></p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">ce</code>
+ <span class="type"><a href="../classes/CustomEvent.html" class="crosslink">CustomEvent</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the custom event managing the DOM subscriptions for
+ the subscribed event on the subscribing node.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>:
+
+ false if the event was stopped
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_on" class="method item public">
+ <h3 class="name"><code>on</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag public">public</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l68"><code>event/js/tap.js:68</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>This function should set up the node that will eventually fire the event.</p>
+
+<p>Usage:</p>
+
+<pre class="code prettyprint"><code>node.on('tap', function (e) {
+ Y.log('the node was tapped on');
+});
+</code></pre>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_onAvailable" class="method item deprecated">
+ <h3 class="name"><code>onAvailable</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>id</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>p_obj</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>p_override</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>checkContent</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+ <span class="flag deprecated" title="Use Y.on("available")">deprecated</span>
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l190"><code>event/js/event-dom.js:190</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: Use Y.on("available")</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Executes the supplied callback when the item with the supplied
+id is found. This is meant to be used to execute behavior as
+soon as possible as the page loads. If you use this after the
+initial page load it will poll for a fixed time for the element.
+The number of times it will poll and the frequency are
+configurable. By default it will poll for 10 seconds.</p>
+
+<p>The callback is executed with a single parameter:
+the custom object parameter, if provided.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">id</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the id of the element, or an array
+of ids to look for.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>what to execute when the element is found.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">p_obj</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an optional object to be passed back as
+ a parameter to fn.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">p_override</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If set to true, fn will execute
+ in the context of p_obj, if set to an object it
+ will execute in the context of that object</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">checkContent</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>check child node readiness (onContentReady)</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_onContentReady" class="method item deprecated">
+ <h3 class="name"><code>onContentReady</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>id</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>fn</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>obj</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>override</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+ <span class="flag deprecated" title="Use Y.on("contentready")">deprecated</span>
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l263"><code>event/js/event-dom.js:263</code></a>
+
+ </p>
+
+
+
+ <p>Deprecated: Use Y.on("contentready")</p>
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Works the same way as onAvailable, but additionally checks the
+state of sibling elements to determine if the content of the
+available element is safe to modify.</p>
+
+<p>The callback is executed with a single parameter:
+the custom object parameter, if provided.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">id</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the id of the element to look for.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>what to execute when the element is ready.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">obj</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>an optional object to be passed back as
+ a parameter to fn.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">override</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If set to true, fn will execute
+ in the context of p_obj. If an object, fn will
+ exectute in the context of that object</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_pinch" class="method item">
+ <h3 class="name"><code>pinch</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>center</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>startRadius</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>endRadius</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>duration</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>start</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>rotation</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l220"><code>gesture-simulate/js/gesture-simulate.js:220</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The "rotate" and "pinch" methods are essencially same with the exact same
+arguments. Only difference is the required parameters. The rotate method
+requires "rotation" parameter while the pinch method requires "startRadius"
+and "endRadius" parameters.</p>
+
+<p>The "pinch" gesture can simulate various 2 finger gestures such as pinch,
+spread and/or rotation. The "startRadius" and "endRadius" are required.
+If endRadius is larger than startRadius, it becomes a spread gesture
+otherwise a pinch gesture.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">center</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A center point where the pinch gesture of two fingers
+ should happen. It is relative to the top left corner of the target
+ node element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">startRadius</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A radius of start circle where 2 fingers are
+ on when the gesture starts. This paramenter is required.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">endRadius</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A radius of end circle where 2 fingers will be on when
+ the pinch or spread gestures are completed. This parameter is required.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">duration</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A duration of the gesture in millisecond.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">start</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A start angle(0 degree at 12 o'clock) where the
+ gesture should start. Default is 0.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">rotation</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>If rotation is desired during the pinch or
+ spread gestures, this parameter can be used. Default is 0 degree.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_purgeElement" class="method item">
+ <h3 class="name"><code>purgeElement</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>el</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>recurse</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l769"><code>event/js/event-dom.js:769</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Removes all listeners attached to the given element via addListener.
+Optionally, the node's children can also be purged.
+Optionally, you can specify a specific type of event to remove.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">el</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>the element to purge</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">recurse</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>recursively purge this element's children
+as well. Use with caution.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>optional type of listener to purge. If
+left out, all listeners will be removed</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_rotate" class="method item">
+ <h3 class="name"><code>rotate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>center</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>startRadius</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>endRadius</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>duration</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>start</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>rotation</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l177"><code>gesture-simulate/js/gesture-simulate.js:177</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The "rotate" and "pinch" methods are essencially same with the exact same
+arguments. Only difference is the required parameters. The rotate method
+requires "rotation" parameter while the pinch method requires "startRadius"
+and "endRadius" parameters.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">center</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A center point where the pinch gesture of two fingers
+ should happen. It is relative to the top left corner of the target
+ node element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">startRadius</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A radius of start circle where 2 fingers are
+ on when the gesture starts. This is optional. The default is a fourth of
+ either target node width or height whichever is smaller.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">endRadius</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A radius of end circle where 2 fingers will be on when
+ the pinch or spread gestures are completed. This is optional.
+ The default is a fourth of either target node width or height whichever is less.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">duration</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A duration of the gesture in millisecond.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">start</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A start angle(0 degree at 12 o'clock) where the
+ gesture should start. Default is 0.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">rotation</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A rotation in degree. It is required.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_simulate" class="method item">
+ <h3 class="name"><code>simulate</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>target</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>type</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>options</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Void</span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-simulate.html">event-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event-simulate_js_event-simulate.js.html#l888"><code>event-simulate/js/event-simulate.js:888</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Simulates the event or gesture with the given name on a target.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">target</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The DOM element that's the target of the event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The type of event or name of the supported gesture to simulate
+ (i.e., "click", "doubletap", "flick").</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">options</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>(Optional) Extra options to copy onto the event object.
+ For gestures, options are used to refine the gesture behavior.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Void</span>:
+
+
+ </div>
+ </div>
+
+
+
+</div>
+
+
+ <div id="method_simulateGesture" class="method item">
+ <h3 class="name"><code>simulateGesture</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>name</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[options]</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code class="optional">[cb]</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+ <span class="returns-inline">
+ <span class="type">Void</span>
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l1097"><code>gesture-simulate/js/gesture-simulate.js:1097</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Simulates the higher user level gesture of the given name on a target.
+This method generates a set of low level touch events(Apple specific gesture
+events as well for the iOS platforms) asynchronously. Note that gesture <br />
+simulation is relying on <code>Y.Event.simulate()</code> method to generate
+the touch events under the hood. The <code>Y.Event.simulate()</code> method
+itself is a synchronous method.</p>
+
+<p>Users are suggested to use <code>Node.simulateGesture()</code> method which
+basically calls this method internally. Supported gestures are <code>tap</code>,
+<code>doubletap</code>, <code>press</code>, <code>move</code>, <code>flick</code>, <code>pinch</code> and <code>rotate</code>.</p>
+
+<p>The <code>pinch</code> gesture is used to simulate the pinching and spreading of two
+fingers. During a pinch simulation, rotation is also possible. Essentially
+<code>pinch</code> and <code>rotate</code> simulations share the same base implementation to allow
+both pinching and rotation at the same time. The only difference is <code>pinch</code>
+requires <code>start</code> and <code>end</code> option properties while <code>rotate</code> requires <code>rotation</code>
+option property.</p>
+
+<p>The <code>pinch</code> and <code>rotate</code> gestures can be described as placing 2 fingers along a
+circle. Pinching and spreading can be described by start and end circles while
+rotation occurs on a single circle. If the radius of the start circle is greater
+than the end circle, the gesture becomes a pinch, otherwise it is a spread spread.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/Document_Object_Model_(DOM)/HTMLElement" class="crosslink external" target="_blank">HTMLElement</a> | <a href="../classes/Node.html" class="crosslink">Node</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The YUI node or HTML element that's the target
+ of the event.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">name</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The name of the supported gesture to simulate. The
+ supported gesture name is one of "tap", "doubletap", "press", "move",
+ "flick", "pinch" and "rotate".</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[options]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>Extra options used to define the gesture behavior:</p>
+
+<pre><code> Valid options properties for the <code>tap</code> gesture:
+</code></pre>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[point]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the [x,y] coordinates
+ where the tap should be simulated. Default is the center of the node
+ element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[hold=10]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The hold time in milliseconds.
+ This is the time between <code>touchstart</code> and <code>touchend</code> event generation.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[times=1]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the number of taps.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[delay=10]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The number of milliseconds
+ before the next tap simulation happens. This is valid only when <code>times</code>
+ is more than 1. </p>
+
+<pre><code> Valid options properties for the <code>doubletap</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[point]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the [x,y] coordinates
+ where the doubletap should be simulated. Default is the center of the
+ node element.</p>
+
+<pre><code> Valid options properties for the <code>press</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[point]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the [x,y] coordinates
+ where the press should be simulated. Default is the center of the node
+ element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[hold=3000]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The hold time in milliseconds.
+ This is the time between <code>touchstart</code> and <code>touchend</code> event generation.
+ Default is 3000ms (3 seconds).</p>
+
+<pre><code> Valid options properties for the <code>move</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[path]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the path of the finger
+ movement. It's an object with three optional properties: <code>point</code>,
+ <code>xdist</code> and <code>ydist</code>.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name optional">[point]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ A starting point of the gesture.
+ Default is the center of the node element.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[xdist=200]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ A distance to move in pixels
+ along the X axis. A negative distance value indicates moving left.
+ </div>
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[ydist=0]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ A distance to move in pixels
+ along the Y axis. A negative distance value indicates moving up.
+ </div>
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[duration=1000]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The duration of the
+ gesture in milliseconds.</p>
+
+<pre><code> Valid options properties for the <code>flick</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[point]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Indicates the [x, y] coordinates
+ where the flick should be simulated. Default is the center of the
+ node element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[axis='x']</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Valid values are either
+ "x" or "y". Indicates axis to move along. The flick can move to one of
+ 4 directions(left, right, up and down).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[distance=200]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Distance to move in pixels</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[duration=1000]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The duration of the
+ gesture in milliseconds. User given value could be automatically
+ adjusted by the framework if it is below the minimum velocity to be
+ a flick gesture.</p>
+
+<pre><code> Valid options properties for the <code>pinch</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[center]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The center of the circle where
+ two fingers are placed. Default is the center of the node element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[r1]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Required) Pixel radius of the start circle
+ where 2 fingers will be on when the gesture starts. The circles are
+ centered at the center of the element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[r2]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Required) Pixel radius of the end circle
+ when this gesture ends.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[duration=1000]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The duration of the
+ gesture in milliseconds.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[start=0]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Starting degree of the first
+ finger. The value is relative to the path of the north. Default is 0
+ (i.e., 12:00 on a clock).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[rotation=0]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Degrees to rotate from
+ the starting degree. A negative value means rotation to the
+ counter-clockwise direction.</p>
+
+<pre><code> Valid options properties for the <code>rotate</code> gesture:
+</code></pre>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[center]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The center of the circle where
+ two fingers are placed. Default is the center of the node element.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[r1]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Pixel radius of the start circle
+ where 2 fingers will be on when the gesture starts. The circles are
+ centered at the center of the element. Default is a fourth of the node
+ element width or height, whichever is smaller.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[r2]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Pixel radius of the end circle
+ when this gesture ends. Default is a fourth of the node element width or
+ height, whichever is smaller.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[duration=1000]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) The duration of the
+ gesture in milliseconds.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[start=0]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Optional) Starting degree of the first
+ finger. The value is relative to the path of the north. Default is 0
+ (i.e., 12:00 on a clock).</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[rotation]</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+ <div class="param-description">
+ <p>(Required) Degrees to rotate from
+ the starting degree. A negative value means rotation to the
+ counter-clockwise direction.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name optional">[cb]</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+ <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the asynchronouse gesture <br />
+ simulation is completed.</p>
+ </div>
+
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">err</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a></span>
+
+
+ <div class="param-description">
+ <p>An error object if the simulation is failed.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div class="returns">
+ <h4>Returns:</h4>
+
+ <div class="returns-description">
+
+
+ <span class="type">Void</span>:
+
+
+ </div>
+ </div>
+
+
+
+ <div class="example">
+ <h4>Example:</h4>
+
+ <div class="example-content">
+ <pre class="code prettyprint"><code>var node = Y.one("#target");
+
+// double tap example
+node.simulateGesture("doubletap", function() {
+ // my callback function
+});
+
+// flick example from the center of the node, move 50 pixels down for 50ms)
+node.simulateGesture("flick", {
+ axis: y,
+ distance: -100
+ duration: 50
+}, function() {
+ // my callback function
+});
+
+// simulate rotating a node 75 degrees counter-clockwise
+node.simulateGesture("rotate", {
+ rotation: -75
+});
+
+// simulate a pinch and a rotation at the same time.
+// fingers start on a circle of radius 100 px, placed at top/bottom
+// fingers end on a circle of radius 50px, placed at right/left
+node.simulateGesture("pinch", {
+ r1: 100,
+ r2: 50,
+ start: 0
+ rotation: 90
+});
+</code></pre>
+ </div>
+ </div>
+
+</div>
+
+
+ <div id="method_startInterval" class="method item private">
+ <h3 class="name"><code>startInterval</code></h3>
+
+
+ <span class="paren">()</span>
+
+
+
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l179"><code>event/js/event-dom.js:179</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="method_tap" class="method item">
+ <h3 class="name"><code>tap</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>cb</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>point</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>times</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>hold</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>delay</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/gesture-simulate.html">gesture-simulate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/gesture-simulate_js_gesture-simulate.js.html#l509"><code>gesture-simulate/js/gesture-simulate.js:509</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The "tap" gesture can be used for various single touch point gestures
+such as single tap, N number of taps, long press. The default is a single
+tap.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">cb</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The callback to execute when the gesture simulation
+ is completed.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">point</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>A point(relative to the top left corner of the
+ target node element) where the tap gesture should start. The default
+ is the center of the taget node.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">times</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The number of taps. Default is 1.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">hold</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The hold time in milliseconds between "touchstart" and
+ "touchend" event generation. Default is 10ms.</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">delay</code>
+ <span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The time gap in millisecond between taps if this
+ gesture has more than 1 tap. Default is 10ms.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_touchEnd" class="method item protected">
+ <h3 class="name"><code>touchEnd</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>event</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>delegate</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l209"><code>event/js/tap.js:209</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Called when the monitor(s) fires a touchend event (or the mouse equivalent).
+This method fires the 'tap' event if certain requirements are met.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">event</code>
+ <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">delegate</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_touchMove" class="method item protected">
+ <h3 class="name"><code>touchMove</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>event</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>delegate</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>context</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l189"><code>event/js/tap.js:189</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Called when the monitor(s) fires a touchmove or touchcancel event (or the mouse equivalent).
+This method detaches event handlers so that 'tap' is not fired.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">event</code>
+ <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">delegate</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">context</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ <div id="method_touchStart" class="method item protected">
+ <h3 class="name"><code>touchStart</code></h3>
+
+
+ <div class="args">
+ <span class="paren">(</span><ul class="args-list inline commas">
+
+ <li class="arg">
+
+ <code>event</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>node</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>subscription</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>notifier</code>
+
+ </li>
+
+ <li class="arg">
+
+ <code>delegate</code>
+
+ </li>
+
+ </ul><span class="paren">)</span>
+ </div>
+
+
+
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l143"><code>event/js/tap.js:143</code></a>
+
+ </p>
+
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Called when the monitor(s) are tapped on, either through touchstart or mousedown.</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Parameters:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">event</code>
+ <span class="type"><a href="../classes/DOMEventFacade.html" class="crosslink">DOMEventFacade</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">node</code>
+ <span class="type">Y.Node</span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">subscription</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">notifier</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">delegate</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <div class="param-description">
+
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+
+</div>
+
+
+ </div>
+
+
+
+ <div id="properties" class="api-class-tabpanel">
+ <h2 class="off-left">Properties</h2>
+
+
+ <div id="property__avail" class="property item private">
+ <h3 class="name"><code>_avail</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l89"><code>event/js/event-dom.js:89</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>onAvailable listeners</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__disabledRE" class="property item protected">
+ <h3 class="name"><code>_disabledRE</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp" class="crosslink external" target="_blank">RegExp</a></span>
+
+
+
+
+ <span class="flag protected">protected</span>
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-delegate.html">event-delegate</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_delegate.js.html#l209"><code>event/js/delegate.js:209</code></a>
+
+ </p>
+
+
+
+
+ <p>Available since 3.8.1</p>
+
+ </div>
+
+ <div class="description">
+ <p>Regex to test for disabled elements during filtering. This is only relevant to
+IE to normalize behavior with other browsers, which swallow events that occur
+to disabled elements. IE fires the event from the parent element instead of the
+original target, though it does preserve <code>event.srcElement</code> as the disabled
+element. IE also supports disabled on <code><a></code>, but the event still bubbles, so it
+acts more like <code>e.preventDefault()</code> plus styling. That issue is not handled here
+because other browsers fire the event on the <code><a></code>, so delegate is supported in
+both cases.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__dri" class="property item private">
+ <h3 class="name"><code>_dri</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l163"><code>event/js/event-dom.js:163</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>document readystate poll handle</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__el_events" class="property item private">
+ <h3 class="name"><code>_el_events</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l109"><code>event/js/event-dom.js:109</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Custom event wrapper map DOM events. Key is
+Element uid stamp. Each item is a hash of custom event
+wrappers as provided in the _wrappers collection. This
+provides the infrastructure for getListeners.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__interval" class="property item private">
+ <h3 class="name"><code>_interval</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l155"><code>event/js/event-dom.js:155</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>poll handle</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__loadComplete" class="property item private">
+ <h3 class="name"><code>_loadComplete</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l70"><code>event/js/event-dom.js:70</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>True after the onload event has fired</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__retryCount" class="property item private">
+ <h3 class="name"><code>_retryCount</code></h3>
+ <span class="type">Unknown</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l79"><code>event/js/event-dom.js:79</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The number of times to poll after window.onload. This number is
+increased if additional late-bound handlers are requested after
+the page load.</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property__wrappers" class="property item private">
+ <h3 class="name"><code>_wrappers</code></h3>
+ <span class="type">Y.Event.Custom</span>
+
+
+
+
+ <span class="flag private">private</span>
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l97"><code>event/js/event-dom.js:97</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Custom event wrappers for DOM events. Key is
+'event:' + Element uid stamp + event type</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_DOMReady" class="property item">
+ <h3 class="name"><code>DOMReady</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l171"><code>event/js/event-dom.js:171</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>True when the document is initially usable</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_lastError" class="property item">
+ <h3 class="name"><code>lastError</code></h3>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a></span>
+
+
+
+
+
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l144"><code>event/js/event-dom.js:144</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>addListener/removeListener can throw errors in unexpected scenarios.
+These errors are suppressed, the method returns false, and this property
+is set</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_POLL_INTERVAL" class="property item">
+ <h3 class="name"><code>POLL_INTERVAL</code></h3>
+ <span class="type">Int</span>
+
+
+
+
+
+
+ <span class="flag final">final</span>
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l135"><code>event/js/event-dom.js:135</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The poll interval in milliseconds</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ <div id="property_POLL_RETRYS" class="property item">
+ <h3 class="name"><code>POLL_RETRYS</code></h3>
+ <span class="type">Int</span>
+
+
+
+
+
+
+ <span class="flag final">final</span>
+
+
+
+ <span class="flag static">static</span>
+
+
+ <div class="meta">
+
+
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_event-dom.js.html#l122"><code>event/js/event-dom.js:122</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>The number of times we should look for elements that are not
+in the DOM at the time the event is requested after the document
+has been loaded. The default is 1000@amp;40 ms, so it will poll
+for 40 seconds or until all outstanding handlers are bound
+(whichever comes first).</p>
+ </div>
+
+
+
+
+
+
+</div>
+
+
+ </div>
+
+
+
+
+
+ <div id="events" class="api-class-tabpanel">
+ <h2 class="off-left">Events</h2>
+
+
+ <div id="event_tap" class="events item">
+ <h3 class="name"><code>tap</code></h3>
+ <span class="type"></span>
+
+
+
+
+
+
+
+
+
+ <div class="meta">
+
+
+
+ <p>Provided by the <a href="../modules/event-tap.html">event-tap</a> module.</p>
+
+ <p>
+
+ Defined in
+
+
+
+
+ <a href="../files/event_js_tap.js.html#l55"><code>event/js/tap.js:55</code></a>
+
+ </p>
+
+
+
+
+ </div>
+
+ <div class="description">
+ <p>Sets up a "tap" event, that is fired on touch devices in response to a tap event (finger down, finder up).
+This event can be used instead of listening for click events which have a 500ms delay on most touch devices.
+This event can also be listened for using node.delegate().</p>
+ </div>
+
+
+ <div class="params">
+ <h4>Event Payload:</h4>
+
+ <ul class="params-list">
+
+ <li class="param">
+
+ <code class="param-name">type</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>"tap"</p>
+ </div>
+
+
+ </li>
+
+ <li class="param">
+
+ <code class="param-name">fn</code>
+ <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
+
+
+
+
+ <div class="param-description">
+ <p>The method the event invokes. It receives the event facade of the underlying DOM event.</p>
+ </div>
+
+
+ </li>
+
+ </ul>
+ </div>
+
+
+
+
+</div>
+
+
+ </div>
+
+ </div>
+</div>
+
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>