This plugin adds the ability to control which Console entries display by filtering on category and source. Two groups of checkboxes are added to the Console footer, one for categories and the other for sources. Only those messages that match a checked category or source are displayed.
", "submodules": [], "classlist": ["Plugin.ConsoleFilters"], "filelist": ["console-filters.js"], "subdata": {}, "name": "console-filters"}, "dump": {"description": "Returns a simple string representation of the object or array.\nOther types of objects will be returned unprocessed. Arrays\nare expected to be indexed. Use object notation for\nassociative arrays.\nIf included, the dump method is added to the YUI instance.", "submodules": [], "classlist": ["YUI~dump"], "filelist": ["dump.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "dump"}, "attribute": {"description": "The attribute module provides an augmentable Attribute implementation, which \nadds configurable attributes and attribute change events to the class being \naugmented. It also provides a State class, which is used internally by Attribute,\nbut can also be used independently to provide a name/property/value data structure to\nstore state.", "submodules": ["attribute-complex", "attribute-base"], "classlist": ["Attribute", "State"], "filelist": ["ComplexAttribute.js", "Attribute.js", "State.js"], "subdata": {"attribute-base": {"name": "State", "description": "The attribute-base submodule provides core attribute handling support, with everything\naside from complex attribute handling in the provider's constructor."}, "attribute-complex": {"name": "Attribute", "description": "Adds support for attribute providers to handle complex attributes in the constructor"}}, "guessedname": "O", "guessedtype": "property", "name": "attribute"}, "widget-stack": {"description": "Provides stackable (z-index) support for Widgets through an extension.", "submodules": [], "classlist": ["WidgetStack"], "filelist": ["Widget-Stack.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "widget-stack"}, "async-queue": {"description": "
AsyncQueue allows you create a chain of function callbacks executed\nvia setTimeout (or synchronously) that are guaranteed to run in order.\nItems in the queue can be promoted or removed. Start or resume the\nexecution chain with run(). pause() to temporarily delay execution, or\nstop() to halt and clear the queue.
", "submodules": [], "classlist": ["AsyncQueue"], "filelist": ["async-queue.js"], "subdata": {}, "name": "async-queue"}, "io": {"description": "Base IO functionality. Provides basic XHR transport support.", "submodules": ["io-base", "io-queue", "io-upload-iframe", "io-xdr", "io-form"], "classlist": ["io"], "filelist": ["io-base.js", "io-queue.js", "io-upload-iframe.js", "io-xdr.js", "io-form.js"], "subdata": {"io-xdr": {"name": "io", "description": "Extends the IO base class to provide an alternate, Flash transport, for making\ncross-domain requests."}, "io-form": {"name": "io", "description": "Extends the IO base class to enable HTML form data serialization, when specified\nin the transaction's configuration object."}, "io-base": {"name": "io", "description": "Base IO functionality. Provides basic XHR transport support."}, "io-queue": {"name": "io", "description": "Extends the IO base class to implement Queue for synchronous\ntransaction processing."}, "io-upload-iframe": {"name": "io", "description": "Extends the IO base class to enable file uploads, with HTML forms,\nusing an iframe as the transport medium."}}, "guessedname": "w", "guessedtype": "property", "name": "io"}, "event": {"description": "Functionality to listen for one or more specific key combinations.", "submodules": ["event-key", "event-focus", "event-base", "event-resize", "event-mousewheel", "event-delegate", "event-mouseenter"], "classlist": ["Event", "DOMEventFacade"], "filelist": ["key.js", "event-ready-base.js", "event-ready.js", "focusblur.js", "event-dom.js", "available.js", "resize-window.js", "mousewheel.js", "delegate.js", "event-facade-dom.js", "mouseentermouseleave.js"], "subdata": {"event-focus": {"name": "YUI", "description": "Adds focus and blur event listener support. These events normally\ndo not bubble, so this adds support for that so these events\ncan be used in event delegation scenarios."}, "event-key": {"name": "", "description": "Functionality to listen for one or more specific key combinations."}, "event-base": {"name": "DOMEventFacade", "description": "Custom event engine, DOM event listener abstraction layer, synthetic DOM \nevents."}, "event-resize": {"name": "YUI", "description": "Adds a window resize event that has its behavior normalized to fire at the\nend of the resize rather than constantly during the resize."}, "event-mouseenter": {"name": "DOMEventFacade", "description": "Adds support for mouseenter/mouseleave events"}, "event-delegate": {"name": "YUI", "description": "Adds event delegation support to the library."}, "event-mousewheel": {"name": "YUI", "description": "Adds mousewheel event support"}}, "guessedname": "DOM_MOUSE_SCROLL", "guessedtype": "property", "name": "event"}, "substitute": {"description": "String variable substitution and string formatting.\nIf included, the substitute method is added to the YUI instance.", "submodules": [], "classlist": ["YUI~substitute"], "filelist": ["substitute.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "substitute"}, "console": {"description": "Console creates a visualization for messages logged through calls to a YUI\ninstance's Y.log( message, category, source ) method. The\ndebug versions of YUI modules will include logging statements to offer some\ninsight into the steps executed during that module's operation. Including\nlog statements in your code will cause those messages to also appear in the\nConsole. Use Console to aid in developing your page or application.\nEntry categories "info", "warn", and "error"\nare also referred to as the log level, and entries are filtered against the\nconfigured logLevel.", "submodules": [], "classlist": ["Console"], "filelist": ["console.js"], "subdata": {}, "name": "console"}, "overlay": {"description": "Provides a basic Overlay widget, with Standard Module content support. The Overlay widget\nprovides Page XY positioning support, alignment and centering support along with basic \nstackable support (z-index and shimming).", "submodules": [], "classlist": ["Overlay"], "filelist": ["Overlay.js"], "subdata": {}, "name": "overlay"}, "event-simulate": {"description": "Synthetic DOM events", "submodules": [], "classlist": [], "filelist": ["event-simulate.js"], "subdata": {}, "requires": "event", "name": "event-simulate"}, "cache": {"description": "The Cache utility provides a common configurable interface for components to\ncache and retrieve data from a local JavaScript struct.", "submodules": [], "classlist": ["Cache"], "filelist": ["cache.js"], "subdata": {}, "guessedname": "LANG", "guessedtype": "property", "name": "cache"}, "stylesheet": {"description": "The StyleSheet component is a module for creating and modifying CSS\nstylesheets.", "submodules": [], "classlist": ["StyleSheet"], "filelist": ["stylesheet.js"], "subdata": {}, "guessedname": "d", "guessedtype": "property", "name": "stylesheet"}, "widget-position": {"description": "Provides basic XY positioning support for Widgets, though an extension", "submodules": [], "classlist": ["WidgetPosition"], "filelist": ["Widget-Position.js"], "subdata": {}, "guessedname": "Lang", "guessedtype": "property", "name": "widget-position"}, "json": {"description": "
The JSON module adds support for serializing JavaScript objects into\nJSON strings and parsing JavaScript objects from strings in JSON format.
\n
The JSON namespace is added to your YUI instance including static methods\nY.JSON.parse(..) and Y.JSON.stringify(..).
\n
The functionality and method signatures follow the ECMAScript 5\nspecification. In browsers with native JSON support, the native\nimplementation is used.
\n
The json module is a rollup of json-parse and\njson-stringify.
\n
As their names suggest, json-parse adds support for parsing\nJSON data (Y.JSON.parse) and json-stringify for serializing\nJavaScript data into JSON strings (Y.JSON.stringify). You may choose to\ninclude either of the submodules individually if you don't need the\ncomplementary functionality, or include the rollup for both.
The MenuNav Node Plugin makes it easy to transform existing list-based \nmarkup into traditional, drop down navigational menus that are both accessible \nand easy to customize, and only require a small set of dependencies.
\n
To use the MenuNav Node Plugin, simply pass a reference to the plugin to a \nNode instance's plug method.
\n
\n\n<script type=\"text/javascript\"> \n \n//\tCall the \"use\" method, passing in \"node-menunav\". This will \n//\tload the script and CSS for the MenuNav Node Plugin and all of \n//\tthe required dependencies. \n \nYUI().use(\"node-menunav\", function(Y) { \n \n//\tUse the \"contentready\" event to initialize the menu when \n//\tthe subtree of element representing the root menu \n//\t(<div id=\"menu-1\">) is ready to be scripted. \n \nY.on(\"contentready\", function () { \n \n//\tThe scope of the callback will be a Node instance \n//\trepresenting the root menu (<div id=\"menu-1\">). \n//\tTherefore, since \"this\" represents a Node instance, it \n//\tis possible to just call \"this.plug\" passing in a \n//\treference to the MenuNav Node Plugin. \n \nthis.plug(Y.Plugin.NodeMenuNav); \n \n}, \"#menu-1\"); \n \t\t\n}); \n \t\n</script> \n\n
\n
The MenuNav Node Plugin has several configuration properties that can be \nset via an object literal that is passed as a second argument to a Node \ninstance's plug method.\n
\n
\n\n<script type=\"text/javascript\"> \n \n//\tCall the \"use\" method, passing in \"node-menunav\". This will \n//\tload the script and CSS for the MenuNav Node Plugin and all of \n//\tthe required dependencies. \n \nYUI().use(\"node-menunav\", function(Y) { \n \n//\tUse the \"contentready\" event to initialize the menu when \n//\tthe subtree of element representing the root menu \n//\t(<div id=\"menu-1\">) is ready to be scripted. \n \nY.on(\"contentready\", function () { \n \n//\tThe scope of the callback will be a Node instance \n//\trepresenting the root menu (<div id=\"menu-1\">). \n//\tTherefore, since \"this\" represents a Node instance, it \n//\tis possible to just call \"this.plug\" passing in a \n//\treference to the MenuNav Node Plugin. \n \nthis.plug(Y.Plugin.NodeMenuNav, { mouseOutHideDelay: 1000 });\n
", "submodules": [], "classlist": ["plugin.NodeMenuNav"], "filelist": ["node-menunav.js"], "subdata": {}, "name": "node-menunav"}, "test": {"description": "YUI JavaScript Testing Framework", "submodules": [], "classlist": ["Assert", "Assert.Error", "Assert.ComparisonFailure", "Assert.UnexpectedValue", "Assert.ShouldFail", "Assert.ShouldError", "Assert.UnexpectedError", "Assert.ObjectAssert", "Test.Suite", "Test.Format.Mock", "Test.Case", "Test.Wait", "Test.TestNode", "Test.Runner", "Test.DateAssert", "Test.Reporter", "Test.Manager", "Test.ArrayAssert"], "filelist": ["Assert.js", "ObjectAssert.js", "TestSuite.js", "TestFormat.js", "Mock.js", "TestCase.js", "TestRunner.js", "DateAssert.js", "TestReporter.js", "TestManager.js", "ArrayAssert.js"], "subdata": {}, "name": "test"}, "datasource": {"description": "The DataSource utility provides a common configurable interface for widgets to\naccess a variety of data, from JavaScript arrays to online database servers.", "submodules": ["datasource-get", "datasource-function", "datasource-polling", "datasource-arrayschema", "datasource-xmlschema", "datasource-jsonschema", "datasource-io", "datasource-local", "datasource-cache", "datasource-textschema"], "classlist": ["DataSource.Get", "DataSource.Function", "Pollable", "DataSourceArraySchema", "DataSourceXMLSchema", "DataSourceJSONSchema", "DataSource.IO", "DataSource.Local", "DataSourceCache", "DataSourceTextSchema"], "filelist": ["datasource-get.js", "datasource-function.js", "datasource-polling.js", "datasource-arrayschema.js", "datasource-xmlschema.js", "datasource-jsonschema.js", "datasource-io.js", "datasource-local.js", "datasource-cache.js", "datasource-textschema.js"], "subdata": {"datasource-io": {"name": "DataSource.IO", "description": "Provides a DataSource implementation which can be used to retrieve data via the IO Utility."}, "datasource-function": {"name": "DataSource.Function", "description": "Provides a DataSource implementation which can be used to retrieve data from a custom function."}, "datasource-arrayschema": {"name": "DataSourceArraySchema", "description": "Extends DataSource with schema-parsing on array data."}, "datasource-textschema": {"name": "DataSourceTextSchema", "description": "Extends DataSource with schema-parsing on text data."}, "datasource-cache": {"name": "DataSourceCache", "description": "Extends DataSource with caching functionality."}, "datasource-jsonschema": {"name": "DataSourceJSONSchema", "description": "Extends DataSource with schema-parsing on JSON data."}, "datasource-polling": {"name": "Pollable", "description": "Extends DataSource with polling functionality."}, "datasource-local": {"name": "DataSource.Local", "description": "Provides the base DataSource implementation, which can be extended to\ncreate DataSources for specific data protocols, such as the IO Utility, the\nGet Utility, or custom functions."}, "datasource-get": {"name": "DataSource.Get", "description": "Provides a DataSource implementation which can be used to retrieve data via the Get Utility."}, "datasource-xmlschema": {"name": "DataSourceXMLSchema", "description": "Extends DataSource with schema-parsing on XML data."}}, "name": "datasource"}, "node": {"description": "Adds functionality to simulate events.", "submodules": ["node-event-simulate", "nodelist", "node-base", "node-style", "node-event-delegate", "node-screen"], "classlist": ["NodeList", "Node"], "filelist": ["node-pluginhost.js", "node-event-simulate.js", "nodelist.js", "node-imports.js", "node.js", "node-style.js", "node-event-delegate.js", "node-screen.js", "node-class.js", "node-region.js", "node-ie.js"], "subdata": {"nodelist": {"name": "NodeList", "description": "The NodeList module provides support for managing collections of Nodes."}, "node-event-simulate": {"name": "YUI", "description": "Adds functionality to simulate events."}, "node-event-delegate": {"name": "NodeList", "description": "Functionality to make the node a delegated event container"}, "node-base": {"name": "Node", "description": "The Node Utility provides a DOM-like interface for interacting with DOM nodes."}, "node-style": {"name": "Node", "description": "Extended Node interface for managing node styles."}, "node-screen": {"name": "Node", "description": "Extended Node interface for managing regions and screen positioning.\nAdds support for positioning elements and normalizes window size and scroll detection."}}, "guessedname": "methods", "guessedtype": "property", "name": "node"}, "widget": {"description": "Provides the base Widget class", "submodules": [], "classlist": ["Widget"], "filelist": ["Widget.js"], "subdata": {}, "name": "widget"}, "anim": {"name": "anim", "submodules": ["anim-scroll", "anim-curve", "anim-easing", "anim-xy", "anim-node-plugin", "anim-color", "anim-base"], "classlist": ["Easing", "Plugin.NodeFX", "Anim"], "filelist": ["anim-scroll.js", "anim-curve.js", "anim-easing.js", "anim-xy.js", "anim-node-plugin.js", "anim-color.js", "anim.js"], "subdata": {"anim-node-plugin": {"name": "Plugin.NodeFX", "description": "Binds an Anim instance to a Node instance"}, "anim-base": {"name": "Anim", "description": "Provides the base Anim class, for animating numeric properties."}, "anim-scroll": {"name": "", "description": "Adds support for the scroll property in to\nand from attributes."}, "anim-xy": {"name": "Easing", "description": "Adds support for the xy property in from and \nto attributes."}, "anim-color": {"name": "Plugin.NodeFX", "description": "Adds support for color properties in to\nand from attributes."}, "anim-curve": {"name": "", "description": "Adds support for the curve property for the to \nattribute. A curve is zero or more control points and an end point."}, "anim-easing": {"name": "Easing", "description": "The easing module provides methods for customizing\nhow an animation behaves during each run."}}, "guessedname": "NUM", "guessedtype": "property", "description": "The Animation Utility provides an API for creating advanced transitions."}, "dd": {"description": "Extends the dd-ddm Class to add support for the placement of Drop Target shims inside the viewport shim. It also handles all Drop Target related events and interactions.", "submodules": ["dd-ddm-drop", "dd-scroll", "dd-drop-plugin", "dd-constrain", "dd-drag", "dd-ddm", "dd-drop", "dd-ddm-base", "dd-proxy", "dd-plugin"], "classlist": ["DD.Scroll", "Plugin.DDWindowScroll", "Plugin.DDNodeScroll", "Plugin.Drop", "Plugin.DragConstrained", "DD.Drag", "DD.Drop", "DD.DDM", "Plugin.DDProxy", "Plugin.Drag"], "filelist": ["ddm-drop.js", "scroll.js", "dd-drop-plugin.js", "constrain.js", "drag.js", "ddm.js", "drop.js", "ddm-base.js", "proxy.js", "dd-plugin.js"], "subdata": {"dd-ddm-drop": {"name": "DD.DDM", "description": "Extends the dd-ddm Class to add support for the placement of Drop Target shims inside the viewport shim. It also handles all Drop Target related events and interactions."}, "dd-constrain": {"name": "Plugin.DragConstrained", "description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic."}, "dd-drop": {"name": "DD.Drop", "description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic."}, "dd-scroll": {"name": "Plugin.DDNodeScroll", "description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic."}, "dd-ddm": {"name": "DD.DDM", "description": "Extends the dd-ddm-base Class to add support for the viewport shim to allow a draggable node to drag to be dragged over an iframe or any other node that traps mousemove events.\nIt is also required to have Drop Targets enabled, as the viewport shim will contain the shims for the Drop Targets."}, "dd-plugin": {"name": "Plugin.Drag", "description": "This is a simple Drag plugin that can be attached to a Node via the plug method."}, "dd-drag": {"name": "DD.Drag", "description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic."}, "dd-proxy": {"name": "Plugin.DDProxy", "description": "The Drag & Drop Utility allows you to create a draggable interface efficiently, buffering you from browser-level abnormalities and enabling you to focus on the interesting logic surrounding your particular implementation. This component enables you to create a variety of standard draggable objects with just a few lines of code and then, using its extensive API, add your own specific implementation logic."}, "dd-drop-plugin": {"name": "Plugin.Drop", "description": "This is a simple Drop plugin that can be attached to a Node via the plug method."}, "dd-ddm-base": {"name": "DD.DDM", "description": "Provides the base Drag Drop Manger required for making a Node draggable."}}, "name": "dd"}, "collection": {"description": "Collection utilities beyond what is provided in the YUI core", "submodules": [], "classlist": ["YUI~array~extras"], "filelist": ["array-extras.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "collection"}, "slider": {"description": "Create a sliding value range input visualized as a draggable thumb on a\nbackground element.", "submodules": [], "classlist": ["Slider"], "filelist": ["slider.js"], "subdata": {}, "guessedname": "SLIDER", "guessedtype": "property", "name": "slider"}, "base": {"description": "The base module provides the Base class, which objects requiring attribute and custom event support can extend. \nThe module also provides two ways to reuse code - An augmentable Plugin.Host interface which provides plugin support \n(which is augmented to the Base class) and Base.build which provides a way to \nbuild custom classes using extensions.", "submodules": ["base-base", "base-pluginhost", "base-build"], "classlist": ["Base"], "filelist": ["Base.js", "BasePluginHost.js", "BaseBuild.js"], "subdata": {"base-pluginhost": {"name": "Base", "description": "The base-pluginhost submodule adds Plugin support to Base, by augmenting Base with \nPlugin.Host and setting up static (class level) Base.plug and Base.unplug methods."}, "base-build": {"name": "Base", "description": "The base-build submodule provides Base.build functionality, which\ncan be used to create custom classes, by aggregating extensions onto \na main class."}, "base-base": {"name": "Base", "description": "The base-base submodule provides the Base class without the Plugin support, provided by Plugin.Host, \nand without the extension support provided by Base.build."}}, "guessedname": "O", "guessedtype": "property", "name": "base"}, "cookie": {"description": "Utilities for cookie management", "submodules": [], "classlist": ["Cookie"], "filelist": ["Cookie.js"], "subdata": {}, "name": "cookie"}, "oop": {"description": "Supplies object inheritance and manipulation utilities. This adds\nadditional functionaity to what is provided in yui-base, and the\nmethods are applied directly to the YUI instance. This module\nis required for most YUI components.", "submodules": [], "classlist": ["YUI~oop"], "filelist": ["oop.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "oop"}, "widget-stdmod": {"description": "Provides standard module support for Widgets through an extension.", "submodules": [], "classlist": ["WidgetStdMod"], "filelist": ["Widget-StdMod.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "widget-stdmod"}, "dataschema": {"description": "The DataSchema utility provides a common configurable interface for widgets to\napply a given schema to a variety of data.", "submodules": ["dataschema-text", "dataschema-xml", "dataschema-json", "dataschema-base", "dataschema-array"], "classlist": ["DataSchema.Text", "DataSchema.XML", "DataSchema.JSON", "DataSchema.Base", "DataSchema.Array"], "filelist": ["dataschema-text.js", "dataschema-xml.js", "dataschema-json.js", "dataschema-base.js", "dataschema-array.js"], "subdata": {"dataschema-array": {"name": "DataSchema.Array", "description": "Provides a DataSchema implementation which can be used to work with data stored in arrays."}, "dataschema-base": {"name": "DataSchema.Base", "description": "Provides the base DataSchema implementation, which can be extended to \ncreate DataSchemas for specific data formats, such XML, JSON, text and\narrays."}, "dataschema-xml": {"name": "DataSchema.XML", "description": "Provides a DataSchema implementation which can be used to work with XML data."}, "dataschema-text": {"name": "DataSchema.Text", "description": "Provides a DataSchema implementation which can be used to work with delimited text data."}, "dataschema-json": {"name": "DataSchema.JSON", "description": "Provides a DataSchema implementation which can be used to work with JSON data."}}, "guessedname": "LANG", "guessedtype": "property", "name": "dataschema"}, "widget-position-ext": {"description": "Provides extended/advanced XY positioning support for Widgets, through an extension.\nIt builds on top of the widget-position module, to provide alignmentment and centering support.\nFuture releases aim to add constrained and fixed positioning support.", "submodules": [], "classlist": ["WidgetPositionExt"], "filelist": ["Widget-PositionExt.js"], "subdata": {}, "guessedname": "L", "guessedtype": "property", "name": "widget-position-ext"}, "queue-promote": {"description": "Adds methods promote, remove, and indexOf to Queue instances.", "submodules": [], "classlist": [], "filelist": ["queue-promote.js"], "subdata": {}, "name": "queue-promote"}, "dom": {"description": "Add style management functionality to DOM.", "submodules": ["dom-style", "selector-native", "dom-screen", "dom-base", "selector-css3", "selector-css2"], "classlist": ["Selector", "DOM"], "filelist": ["dom-style.js", "selector-native.js", "color.js", "dom-region.js", "dom-screen.js", "dom-class.js", "dom-ie-style.js", "dom.js", "selector-css3.js", "selector-css2.js"], "subdata": {"selector-css2": {"name": "Selector", "description": "The selector module provides helper methods allowing CSS2 Selectors to be used with DOM elements."}, "selector-css3": {"name": "Selector", "description": "The selector css3 module provides support for css3 selectors."}, "dom-base": {"name": "DOM", "description": "The DOM utility provides a cross-browser abtraction layer\nnormalizing DOM tasks, and adds extra helper functionality\nfor other common tasks."}, "dom-style": {"name": "DOM", "description": "Add style management functionality to DOM."}, "selector-native": {"name": "Selector", "description": "The selector-native module provides support for native querySelector"}, "dom-screen": {"name": "DOM", "description": "Adds position and region management functionality to DOM."}}, "guessedname": "DOCUMENT_ELEMENT", "guessedtype": "property", "name": "dom"}, "datatype": {"description": "The DataType Utility provides type-conversion and string-formatting\nconvenience methods for various JavaScript object types.", "submodules": ["datatype-date", "datatype-date-format", "datatype-number-parse", "datatype-date-parse", "datatype-xml-parse", "datatype-xml-format", "datatype-xml", "datatype-number", "datatype-number-format"], "classlist": ["DataType.Date", "DataType.Date.Locale", "DataType.XML", "DataType.Number"], "filelist": ["datatype-date-format.js", "datatype-number-parse.js", "datatype-date-locale.js", "datatype-date-parse.js", "datatype-xml-parse.js", "datatype-xml-format.js", "datatype-number-format.js"], "subdata": {"datatype-xml-parse": {"name": "DataType.XML", "description": "Parse XML submodule."}, "datatype-number-format": {"name": "DataType.Number", "description": "Format number submodule."}, "datatype-date": {"name": "", "description": "Date submodule."}, "datatype-xml-format": {"name": "DataType.XML", "description": "Format XML submodule."}, "datatype-xml": {"name": "DataType.XML", "description": "XML submodule."}, "datatype-date-format": {"name": "DataType.Date", "description": "Format date submodule implements strftime formatters for javascript based on the\nOpen Group specification defined at\nhttp://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html\nThis implementation does not include modified conversion specifiers (i.e., Ex and Ox)"}, "datatype-date-parse": {"name": "DataType.Date", "description": "Parse number submodule."}, "datatype-number-parse": {"name": "DataType.Number", "description": "Parse number submodule."}, "datatype-number": {"name": "DataType.XML", "description": "Number submodule."}}, "guessedname": "LANG", "guessedtype": "property", "name": "datatype"}, "plugin": {"description": "Provides the base Plugin class, which plugin developers should extend, when creating custom plugins", "submodules": [], "classlist": ["Plugin.Base"], "filelist": ["plugin.js"], "subdata": {}, "name": "plugin"}, "classnamemanager": {"description": "Contains a singleton (ClassNameManager) that enables easy creation and caching of \nprefixed class names.", "submodules": [], "classlist": ["ClassNameManager"], "filelist": ["classnamemanager.js"], "subdata": {}, "name": "classnamemanager"}, "profiler": {"description": "The YUI JavaScript profiler.", "submodules": [], "classlist": ["Profiler"], "filelist": ["Profiler.js"], "subdata": {}, "requires": "yui", "name": "profiler"}, "yui": {"description": "The YUI module contains the components required for building the YUI seed file.\nThis includes the script loading mechanism, a simple queue, and the core utilities for the library.", "submodules": ["yui-base", "yui-later", "get", "yui-log"], "classlist": ["Object", "YUI", "config", "Get", "Array", "UA", "Queue", "Lang"], "filelist": ["yui-object.js", "yui-base.js", "yui.js", "_module.js", "yui-core.js", "yui-later.js", "get.js", "yui-array.js", "yui-init.js", "yui-log.js", "yui-ua.js", "queue-base.js", "yui-lang.js"], "subdata": {"yui-later": {"name": "YUI", "description": "Provides a setTimeout/setInterval wrapper"}, "yui-base": {"name": "Lang", "description": "The YUI module contains the components required for building the YUI seed file.\nThis includes the script loading mechanism, a simple queue, and the core utilities for the library."}, "yui-log": {"name": "Array", "description": "Provides console log capability and exposes a custom event for\nconsole implementations."}, "get": {"name": "Get", "description": "Provides a mechanism to fetch remote resources and\ninsert them into a document."}}, "guessedname": "ua", "guessedtype": "property", "name": "yui"}, "imageloader": {"description": "The ImageLoader Utility is a framework to dynamically load images according to certain triggers,\nenabling faster load times and a more responsive UI.", "submodules": [], "classlist": ["ImgLoadGroup", "ImgLoadImgObj"], "filelist": ["imageloader.js"], "subdata": {}, "requires": "base-base, node-style, node-screen", "name": "imageloader"}, "event-custom": {"description": "Custom event engine, DOM event listener abstraction layer, synthetic DOM\nevents.", "submodules": ["event-custom-complex", "event-custom-base"], "classlist": ["EventFacade", "EventTarget", "Do", "Do.Method", "Do.AlterArgs", "Do.AlterReturn", "Do.Halt", "Do.Prevent", "Do.Error", "EventHandle", "CustomEvent", "Subscriber"], "filelist": ["event.js", "event-facade.js", "event-target.js", "event-do.js", "event-custom.js"], "subdata": {"event-custom-base": {"name": "Subscriber", "description": "Custom event engine, DOM event listener abstraction layer, synthetic DOM \nevents."}, "event-custom-complex": {"name": "EventFacade", "description": "Adds event facades, preventable default behavior, and bubbling.\nevents."}}, "guessedname": "evt", "guessedtype": "property", "name": "event-custom"}, "node-focusmanager": {"description": "
The Focus Manager Node Plugin makes it easy to manage focus among \na Node's descendants. Primarily intended to help with widget development, \nthe Focus Manager Node Plugin can be used to improve the keyboard \naccessibility of widgets.
\n
\nWhen designing widgets that manage a set of descendant controls (i.e. buttons\nin a toolbar, tabs in a tablist, menuitems in a menu, etc.) it is important to \nlimit the number of descendants in the browser's default tab flow. The fewer \nnumber of descendants in the default tab flow, the easier it is for keyboard \nusers to navigate between widgets by pressing the tab key. When a widget has \nfocus it should provide a set of shortcut keys (typically the arrow keys) \nto move focus among its descendants.\n
\n
\nTo this end, the Focus Manager Node Plugin makes it easy to define a Node's \nfocusable descendants, define which descendant should be in the default tab \nflow, and define the keys that move focus among each descendant.\nAdditionally, as the CSS \n:focus \npseudo class is not supported on all elements in all \nA-Grade browsers,\nthe Focus Manager Node Plugin provides an easy, cross-browser means of \nstyling focus.\n
", "submodules": [], "classlist": ["plugin.NodeFocusManager"], "filelist": ["node-focusmanager.js"], "subdata": {}, "name": "node-focusmanager"}, "history": {"description": "The Browser History Utility provides the ability to use the back/forward\nnavigation buttons in a DHTML application. It also allows a DHTML\napplication to be bookmarked in a specific state.\nThis utility requires the following static markup:\n<iframe id=\"yui-history-iframe\" src=\"path-to-real-asset-in-same-domain\"></iframe>\n<input id=\"yui-history-field\" type=\"hidden\">", "submodules": [], "classlist": ["History", "History.Module"], "filelist": ["history.js"], "subdata": {}, "name": "history"}}, "classmap": {"Console": {"name": "Console", "constructors": [{"params": [{"type": "Object", "name": "conf", "description": " Configuration object (see Configuration attributes)"}], "description": "Console creates a visualization for messages logged through calls to a YUI\ninstance's Y.log( message, category, source ) method. The\ndebug versions of YUI modules will include logging statements to offer some\ninsight into the steps executed during that module's operation. Including\nlog statements in your code will cause those messages to also appear in the\nConsole. Use Console to aid in developing your page or application.\nEntry categories "info", "warn", and "error"\nare also referred to as the log level, and entries are filtered against the\nconfigured logLevel."}], "namespace": "", "module": "console", "events": {"scrollIntoViewChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "scrollIntoViewChange", "description": "Fires when the value for the configuration attribute 'scrollIntoView' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "heightChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "heightChange", "description": "Fires when the value for the configuration attribute 'height' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "lastTimeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "lastTimeChange", "description": "Fires when the value for the configuration attribute 'lastTime' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "consoleLimitChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "consoleLimitChange", "description": "Fires when the value for the configuration attribute 'consoleLimit' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "newestOnTopChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "newestOnTopChange", "description": "Fires when the value for the configuration attribute 'newestOnTop' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "stringsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "stringsChange", "description": "Fires when the value for the configuration attribute 'strings' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "logSourceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "logSourceChange", "description": "Fires when the value for the configuration attribute 'logSource' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "logLevelChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "logLevelChange", "description": "Fires when the value for the configuration attribute 'logLevel' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "startTimeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "startTimeChange", "description": "Fires when the value for the configuration attribute 'startTime' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "defaultSourceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "defaultSourceChange", "description": "Fires when the value for the configuration attribute 'defaultSource' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "entryTemplateChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "entryTemplateChange", "description": "Fires when the value for the configuration attribute 'entryTemplate' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "logEventChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "logEventChange", "description": "Fires when the value for the configuration attribute 'logEvent' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "printLimitChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "printLimitChange", "description": "Fires when the value for the configuration attribute 'printLimit' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "defaultCategoryChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "defaultCategoryChange", "description": "Fires when the value for the configuration attribute 'defaultCategory' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "pausedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "pausedChange", "description": "Fires when the value for the configuration attribute 'paused' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "printTimeoutChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "printTimeoutChange", "description": "Fires when the value for the configuration attribute 'printTimeout' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "useBrowserConsoleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "useBrowserConsoleChange", "description": "Fires when the value for the configuration attribute 'useBrowserConsole' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "collapsedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "collapsedChange", "description": "Fires when the value for the configuration attribute 'collapsed' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "reset": {"preventable": "_defResetFn", "params": [{"type": "Event.Facade", "name": "event", "description": " Event Facade object"}], "description": "Triggers the reset behavior via the default logic in _defResetFn.", "guessedname": "defaultFn", "guessedtype": "property"}, "styleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "styleChange", "description": "Fires when the value for the configuration attribute 'style' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "entry": {"preventable": "_defEntryFn", "params": [{"type": "Event.Facade", "name": "event", "description": " An Event Facade object with the following attribute specific properties added:\n
\n
message
\n
The message data normalized into an object literal (see _normalizeMessage)
\n
"}], "description": "Transfers a received message to the print loop buffer. Default\nbehavior defined in _defEntryFn.", "guessedname": "defaultFn", "guessedtype": "property"}, "widthChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "widthChange", "description": "Fires when the value for the configuration attribute 'width' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"height": {"default": "\"300px\"", "type": "{String | Number}", "description": "String with units, or number, representing the height of the Console,\ninclusive of header and footer. If a number is provided, the default\nunit, defined by Widget's DEF_UNIT, property is used.", "guessedname": "height", "guessedtype": "property"}, "consoleLimit": {"default": "300", "type": "Number", "description": "Maximum number of Console entries allowed in the Console body at one\ntime. This is used to keep acquired messages from exploding the\nDOM tree and impacting page performance.", "guessedname": "consoleLimit", "guessedtype": "property"}, "width": {"default": "\"300px\"", "type": "{String | Number}", "description": "String with units, or number, representing the width of the Console.\nIf a number is provided, the default unit, defined by Widget's\nDEF_UNIT, property is used.", "guessedname": "width", "guessedtype": "property"}, "logLevel": {"default": "Y.config.logLevel or Console.LOG_LEVEL_INFO", "type": "String", "description": "Minimum entry log level to render into the Console. The initial\nlogLevel value for all Console instances defaults from the\nY.config.logLevel YUI configuration, or Console.LOG_LEVEL_INFO if\nthat configuration is not set.\nPossible values are "info", "warn",\n"error" (case insensitive), or their corresponding statics\nConsole.LOG_LEVEL_INFO and so on.", "guessedname": "logLevel", "guessedtype": "property"}, "printLimit": {"default": "50", "type": "Number", "description": "Maximum number of entries printed in each iteration of the print\nloop. This is used to prevent excessive logging locking the page UI.", "guessedname": "printLimit", "guessedtype": "property"}, "collapsed": {"default": "false", "type": "Boolean", "description": "Controls the collapsed state of the Console", "guessedname": "collapsed", "guessedtype": "property"}, "useBrowserConsole": {"default": "false", "type": "{Boolean}", "description": "Pass through to the YUI instance useBrowserConsole configuration.\nBy default this is set to false, which will disable logging to the\nbrowser console when a Console instance is created. If the\nlogSource is not a YUI instance, this has no effect.", "guessedname": "useBrowserConsole", "guessedtype": "property"}, "logSource": {"default": "Y", "type": "EventTarget", "description": "Object that will emit the log events. By default the YUI instance.\nTo have a single Console capture events from all YUI instances, set\nthis to the Y.Global object.", "guessedname": "logSource", "guessedtype": "property"}, "printTimeout": {"default": "100", "type": "Number", "description": "Millisecond timeout between iterations of the print loop, moving\nentries from the buffer to the UI.", "guessedname": "printTimeout", "guessedtype": "property"}, "defaultSource": {"default": "\"global\"", "type": "String", "description": "If a source is not specified in the Y.log(..) statement, this\nsource will be used.", "guessedname": "defaultSource", "guessedtype": "property"}, "paused": {"default": "false", "type": "boolean", "description": "Boolean to pause the outputting of new messages to the console.\nWhen paused, messages will accumulate in the buffer.", "guessedname": "paused", "guessedtype": "property"}, "newestOnTop": {"default": "true", "type": "Boolean", "description": "New entries should display at the top of the Console or the bottom?", "guessedname": "newestOnTop", "guessedtype": "property"}, "logEvent": {"default": "\"yui:log\"", "type": "String", "description": "Name of the custom event that will communicate log messages.", "guessedname": "logEvent", "guessedtype": "property"}, "style": {"default": "'separate'", "type": "{String}", "description": "Allows the Console to flow in the document. Available values are\n'inline', 'block', and 'separate' (the default).", "guessedname": "style", "guessedtype": "property"}, "startTime": {"default": "The moment the console module is used", "type": "Date", "description": "The baseline time for this Console instance, used to measure elapsed\ntime from the moment the console module is used to the\nmoment each new entry is logged (not rendered).\nThis value is reset by the instance method myConsole.reset().", "guessedname": "startTime", "guessedtype": "property"}, "entryTemplate": {"default": "Console.ENTRY_TEMPLATE", "type": "String", "description": "Markup template used to create the DOM structure for Console entries.", "guessedname": "entryTemplate", "guessedtype": "property"}, "scrollIntoView": {"default": "true", "type": "Boolean", "description": "When new entries are added to the Console UI, should they be\nscrolled into view?", "guessedname": "scrollIntoView", "guessedtype": "property"}, "lastTime": {"default": "The moment the console module is used", "type": "Date", "description": "The precise time the last entry was logged. Used to measure elapsed\ntime between log messages.", "guessedname": "lastTime", "guessedtype": "property"}, "defaultCategory": {"default": "\"info\"", "type": "String", "description": "If a category is not specified in the Y.log(..) statement, this\ncategory will be used. Categories "info",\n"warn", and "error" are also called log level.", "guessedname": "defaultCategory", "guessedtype": "property"}, "strings": {"type": "Object", "description": "Collection of strings used to label elements in the Console UI.\nDefault collection contains the following name:value pairs:\n
\n
title : "Log Console"
\n
pause : "Pause"
\n
clear : "Clear"
\n
collapse : "Collapse"
\n
expand : "Expand"
\n
", "guessedname": "strings", "guessedtype": "property"}}, "methods": {"_normalizeMessage": {"return": {"type": "", "description": "Object the message object"}, "description": "Create a log entry message from the inputs including the following keys:\n
\n
time - this moment
\n
message - leg message
\n
category - logLevel or custom category for the message
\n
source - when provided, the widget or util calling Y.log
\n
sourceAndDetail - same as source but can include instance info
\n
localTime - readable version of time
\n
elapsedTime - ms since last entry
\n
totalTime - ms since Console was instantiated or reset
\n
", "protected": "", "params": [{"type": "Event", "name": "e", "description": " custom event containing the log message"}], "guessedname": "_normalizeMessage", "guessedtype": "function"}, "_uiUpdateCollapsed": {"protected": "", "params": [{"type": "Boolean", "name": "v", "description": " true for collapsed, false for expanded"}], "description": "Updates the UI to reflect the new Collapsed state", "guessedname": "_uiUpdateCollapsed", "guessedtype": "function"}, "_afterStringsChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Custom event for the attribute change"}], "description": "Updates the UI if changes are made to any of the strings in the strings\nattribute.", "guessedname": "_afterStringsChange", "guessedtype": "function"}, "initializer": {"protected": "", "description": "Constructor code. Set up the buffer and entry template, publish\ninternal events, and subscribe to the configured logEvent.", "guessedname": "initializer", "guessedtype": "function"}, "_cancelPrintLoop": {"protected": "", "description": "Clears the timeout for printing buffered messages.", "guessedname": "_cancelPrintLoop", "guessedtype": "function"}, "_trimOldEntries": {"protected": "", "description": "Removes the oldest message entries from the UI to maintain the limit\nspecified in the consoleLimit configuration.", "guessedname": "_trimOldEntries", "guessedtype": "function"}, "_defResetFn": {"protected": "", "description": "Clears the console, resets the startTime attribute, enables and\nunpauses the widget.", "guessedname": "_defResetFn", "guessedtype": "function"}, "_encodeHTML": {"return": {"type": "", "description": "String the encoded string"}, "description": "Returns the input string with ampersands (&), <, and > encoded\nas HTML entities.", "protected": "", "params": [{"type": "String", "name": "s", "description": " the raw string"}], "guessedname": "_encodeHTML", "guessedtype": "function"}, "_uiSetHeight": {"protected": "", "params": [{"type": "String|Number", "name": "v", "description": " the new height"}], "description": "Set the height of the Console container. Set the body height to the difference between the configured height and the calculated heights of the header and footer.\nOverrides Widget.prototype._uiSetHeight.", "guessedname": "_uiSetHeight", "guessedtype": "function"}, "_onCollapseClick": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " DOM event facade for the click event"}], "description": "Event handler for clicking on the Collapse/Expand button. Sets the\n"collapsed" attribute accordingly.", "guessedname": "_onCollapseClick", "guessedtype": "function"}, "log": {"chainable": "", "params": [{"type": "MIXED", "name": "arg*", "description": " (all arguments passed through to Y.log)"}], "description": "Wrapper for Y.log.", "guessedname": "log", "guessedtype": "function"}, "_initBody": {"protected": "", "description": "Create the DOM structure for the console body—where messages are\nrendered.", "guessedname": "_initBody", "guessedtype": "function"}, "_onLogEvent": {"protected": "", "params": [{"type": "String", "name": "msg", "description": " the log message"}, {"type": "String", "name": "cat", "description": " OPTIONAL the category or logLevel of the message"}, {"type": "String", "name": "src", "description": " OPTIONAL the source of the message (e.g. widget name)"}], "description": "Responds to log events by normalizing qualifying messages and passing\nthem along through the entry event for buffering etc.", "guessedname": "_onLogEvent", "guessedtype": "function"}, "_afterPausedChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Custom event for the attribute change"}], "description": "Updates the UI and schedules or cancels the print loop.", "guessedname": "_afterPausedChange", "guessedtype": "function"}, "_validateStyle": {"return": {"type": "Boolean", "description": "pass/fail"}, "description": "Validates input value for style attribute. Accepts only values 'inline',\n'block', and 'separate'.", "protected": "", "params": [{"type": "String", "name": "style", "description": " the proposed value"}], "guessedname": "_validateStyle", "guessedtype": "function"}, "destructor": {"protected": "", "description": "Tears down the instance, flushing event subscriptions and purging the UI.", "guessedname": "destructor", "guessedtype": "function"}, "_initHead": {"protected": "", "description": "Create the DOM structure for the header elements.", "guessedname": "_initHead", "guessedtype": "function"}, "_afterConsoleLimitChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Custom event for the attribute change"}], "description": "Calls this._trimOldEntries() in response to changes in the configured\nconsoleLimit attribute.", "guessedname": "_afterConsoleLimitChange", "guessedtype": "function"}, "bindUI": {"protected": "", "description": "Set up event listeners to wire up the UI to the internal state.", "guessedname": "bindUI", "guessedtype": "function"}, "_defEntryFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The Custom event carrying the message in its payload"}], "description": "Buffers incoming message objects and schedules the printing.", "guessedname": "_defEntryFn", "guessedtype": "function"}, "_htmlEscapeMessage": {"return": {"type": "", "description": "Object the message object with proper escapement"}, "description": "Performs HTML escaping on strings in the message object.", "protected": "", "params": [{"type": "Object", "name": "m", "description": " the normalized message object"}], "guessedname": "_htmlEscapeMessage", "guessedtype": "function"}, "collapse": {"chainable": "", "description": "Collapses the body and footer.", "guessedname": "collapse", "guessedtype": "function"}, "_onPauseClick": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " DOM event facade for the click event"}], "description": "Event handler for clicking on the Pause checkbox to update the paused\nattribute.", "guessedname": "_onPauseClick", "guessedtype": "function"}, "_afterVisibleChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the visibleChange event"}], "description": "Makes adjustments to the UI if needed when the Console is hidden or shown", "guessedname": "_afterVisibleChange", "guessedtype": "function"}, "scrollToLatest": {"chainable": "", "description": "Scrolls to the most recent entry", "guessedname": "scrollToLatest", "guessedtype": "function"}, "_onClearClick": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " DOM event facade for the click event"}], "description": "Event handler for clicking on the Clear button. Pass-through to\nthis.clearConsole().", "guessedname": "_onClearClick", "guessedtype": "function"}, "_schedulePrint": {"protected": "", "description": "Sets an interval for buffered messages to be output to the console.", "guessedname": "_schedulePrint", "guessedtype": "function"}, "_uiUpdateFromHideShow": {"protected": "", "params": [{"type": "Boolean", "name": "v", "description": " true for visible, false for hidden"}], "description": "Recalculates dimensions and updates appropriately when shown", "guessedname": "_uiUpdateFromHideShow", "guessedtype": "function"}, "_createEntryHTML": {"return": {"type": "", "description": "String"}, "description": "Translates message meta into the markup for a console entry.", "protected": "", "params": [{"type": "Object", "name": "m", "description": " object literal containing normalized message metadata"}], "guessedname": "_createEntryHTML", "guessedtype": "function"}, "expand": {"chainable": "", "description": "Expands the body and footer if collapsed.", "guessedname": "expand", "guessedtype": "function"}, "_uiUpdatePaused": {"protected": "", "params": [{"type": "Boolean", "name": "on", "description": " the new checked state"}], "description": "Checks or unchecks the paused checkbox", "guessedname": "_uiUpdatePaused", "guessedtype": "function"}, "reset": {"chainable": "", "description": "Clears the console and resets internal timers.", "guessedname": "reset", "guessedtype": "function"}, "syncUI": {"description": "Sync the UI state to the current attribute state.", "guessedname": "syncUI", "guessedtype": "function"}, "_afterCollapsedChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Custom event for the attribute change"}], "description": "Updates the className of the contentBox, which should trigger CSS to\nhide or show the body and footer sections depending on the new value.", "guessedname": "_afterCollapsedChange", "guessedtype": "function"}, "_initFoot": {"protected": "", "description": "Create the DOM structure for the footer elements.", "guessedname": "_initFoot", "guessedtype": "function"}, "printBuffer": {"chainable": "", "params": [{"type": "Number", "name": "limit", "description": " (optional) max number of buffered entries to write"}], "description": "Outputs buffered messages to the console UI. This is typically called\nfrom a scheduled interval until the buffer is empty (referred to as the\nprint loop). The number of buffered messages output to the Console is\nlimited to the number provided as an argument. If no limit is passed,\nall buffered messages are rendered.", "guessedname": "printBuffer", "guessedtype": "function"}, "_setLogLevel": {"return": {"type": "", "description": "String One of Console.LOG_LEVEL_INFO, _WARN, or _ERROR"}, "description": "Setter method for logLevel attribute. Acceptable values are\n"error", "warn", and "info" (case\ninsensitive). Other values are treated as "info".", "protected": "", "params": [{"type": "String", "name": "v", "description": " the desired log level"}], "guessedname": "_setLogLevel", "guessedtype": "function"}, "clearConsole": {"chainable": "", "description": "Clear the console of messages and flush the buffer of pending messages.", "guessedname": "clearConsole", "guessedtype": "function"}, "_isInLogLevel": {"protected": "", "description": "Determine if incoming log messages are within the configured logLevel\nto be buffered for printing.", "guessedname": "_isInLogLevel", "guessedtype": "function"}, "renderUI": {"protected": "", "description": "Generate the Console UI.", "guessedname": "renderUI", "guessedtype": "function"}}, "extends": "Widget", "superclass": "Widget", "file": "console.js", "shortname": "Console", "properties": {"_printLoop": {"description": "Holds the object API returned from Y.later for the print\nloop interval.", "default": "null", "protected": "", "guessedname": "_printLoop", "guessedtype": "property", "type": "Object"}, "Console.LOG_LEVEL_INFO": {"type": "String", "static": "", "description": "Static identifier for logLevel configuration setting to allow all\nincoming messages to generate Console entries.", "guessedname": "LOG_LEVEL_INFO", "guessedtype": "property"}, "Console.BODY_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to generate the DOM structure for the Console body\n(where the messages are inserted) when it is rendered. The template\nincludes only the {placeholder} "console_bd_class", which is\nconstributed by Console.CHROME_CLASSES.", "guessedname": "BODY_TEMPLATE", "guessedtype": "property"}, "Console.HEADER_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to generate the DOM structure for the header\nsection of the Console when it is rendered. The template includes\nthese {placeholder}s:\n
\n
console_button_class - contributed by Console.CHROME_CLASSES
\n
console_collapse_class - contributed by Console.CHROME_CLASSES
\n
console_hd_class - contributed by Console.CHROME_CLASSES
\n
console_title_class - contributed by Console.CHROME_CLASSES
\n
str_collapse - pulled from attribute strings.collapse
\n
str_title - pulled from attribute strings.title
\n
", "guessedname": "HEADER_TEMPLATE", "guessedtype": "property"}, "buffer": {"description": "Array of normalized message objects awaiting printing.", "default": "null", "protected": "", "guessedname": "buffer", "guessedtype": "property", "type": "Array"}, "Console.ENTRY_TEMPLATE": {"type": "String", "static": "", "description": "Default markup template used to create the DOM structure for Console\nentries. The markup contains {placeholder}s for content and classes\nthat are replaced via Y.substitute. The default template contains\nthe {placeholder}s identified in Console.ENTRY_CLASSES as well as the\nfollowing placeholders that will be populated by the log entry data:\n
\n
cat_class
\n
src_class
\n
totalTime
\n
elapsedTime
\n
localTime
\n
sourceAndDetail
\n
message
\n
", "guessedname": "ENTRY_TEMPLATE", "guessedtype": "property"}, "_body": {"description": "Reference to the Node instance that will house the console messages.", "default": "null", "protected": "", "guessedname": "_body", "guessedtype": "property", "type": "Node"}, "_head": {"description": "Reference to the Node instance containing the header contents.", "default": "null", "protected": "", "guessedname": "_head", "guessedtype": "property", "type": "Node"}, "Console.LOG_LEVEL_WARN": {"type": "String", "static": "", "description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "warn" or "error"\nto generate Console entries.", "guessedname": "LOG_LEVEL_WARN", "guessedtype": "property"}, "_foot": {"description": "Reference to the Node instance containing the footer contents.", "default": "null", "protected": "", "guessedname": "_foot", "guessedtype": "property", "type": "Node"}, "Console.ENTRY_CLASSES": {"type": "Object", "static": "", "description": "Map (object) of classNames used to populate the placeholders in the\nConsole.ENTRY_TEMPLATE markup when rendering a new Console entry.\n
By default, the keys contained in the object are:
\n
\n
entry_class
\n
entry_meta_class
\n
entry_cat_class
\n
entry_src_class
\n
entry_time_class
\n
entry_content_class
\n
", "guessedname": "ENTRY_CLASSES", "guessedtype": "property"}, "Console.FOOTER_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to generate the DOM structure for the footer\nsection of the Console when it is rendered. The template includes\nmany of the {placeholder}s from Console.CHROME_CLASSES as well as:\n
\n
id_guid - generated unique id, relates the label and checkbox
\n
str_pause - pulled from attribute strings.pause
\n
str_clear - pulled from attribute strings.clear
\n
", "guessedname": "FOOTER_TEMPLATE", "guessedtype": "property"}, "Console.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute configuration of\nthe Widget.", "guessedname": "ATTRS", "guessedtype": "property"}, "Console.NAME": {"type": "String", "static": "", "description": "The identity of the widget.", "guessedname": "NAME", "guessedtype": "property"}, "Console.LOG_LEVEL_ERROR": {"type": "String", "static": "", "description": "Static identifier for logLevel configuration setting to allow only\nincoming messages of logLevel "error" to generate\nConsole entries.", "guessedname": "LOG_LEVEL_ERROR", "guessedtype": "property"}, "_evtCat": {"protected": "", "type": "string", "description": "Category to prefix all event subscriptions to allow for ease of detach\nduring destroy.", "guessedname": "_evtCat", "guessedtype": "property"}, "Console.CHROME_CLASSES": {"type": "Object", "static": "", "description": "Map (object) of classNames used to populate the placeholders in the\nConsole.HEADER_TEMPLATE, Console.BODY_TEMPLATE, and\nConsole.FOOTER_TEMPLATE markup when rendering the Console UI.\n
By default, the keys contained in the object are:
\n
\n
console_hd_class
\n
console_bd_class
\n
console_ft_class
\n
console_controls_class
\n
console_checkbox_class
\n
console_pause_class
\n
console_pause_label_class
\n
console_button_class
\n
console_clear_class
\n
console_collapse_class
\n
console_title_class
\n
", "guessedname": "CHROME_CLASSES", "guessedtype": "property"}}, "description": "Console creates a visualization for messages logged through calls to a YUI\ninstance's Y.log( message, category, source ) method. The\ndebug versions of YUI modules will include logging statements to offer some\ninsight into the steps executed during that module's operation. Including\nlog statements in your code will cause those messages to also appear in the\nConsole. Use Console to aid in developing your page or application.\nEntry categories "info", "warn", and "error"\nare also referred to as the log level, and entries are filtered against the\nconfigured logLevel."}, "DOMEventFacade": {"name": "DOMEventFacade", "namespace": "", "module": "event", "methods": {"resolve": {"private": "", "description": "Returns a wrapped node. Intended to be used on event targets,\nso it will return the node's parent if the target is a text\nnode.\nIf accessing a property of the node throws an error, this is\nprobably the anonymous div wrapper Gecko adds inside text\nnodes. This likely will only occur when attempting to access\nthe relatedTarget. In this case, we now return null because\nthe anonymous div is completely useless and we do not know\nwhat the related target was because we can't even get to\nthe element's parent node.", "guessedname": "resolve", "guessedtype": "function"}, "preventDefault": {"params": [{"type": "string", "name": "returnValue", "description": " sets the returnValue of the event to this value\n(rather than the default false value). This can be used to add a customized \nconfirmation query to the beforeunload event)."}], "description": "Prevents the event's default behavior", "guessedname": "preventDefault", "guessedtype": "function"}, "stopPropagation": {"description": "Stops the propagation to the next bubble target", "guessedname": "stopPropagation", "guessedtype": "function"}, "stopImmediatePropagation": {"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.", "guessedname": "stopImmediatePropagation", "guessedtype": "function"}, "halt": {"params": [{"type": "boolean", "name": "immediate", "description": " if true additional listeners\non the current target will not be executed"}], "description": "Stops the event propagation and prevents the default\nevent behavior.", "guessedname": "halt", "guessedtype": "function"}}, "param": "ev {Event} the DOM event", "file": "event-facade-dom.js", "shortname": "DOMEventFacade", "properties": {"webkitKeymap": {"private": "", "description": "webkit key remapping required for Safari < 3.1", "guessedname": "webkitKeymap", "guessedtype": "property"}, "which": {"type": "int", "description": "The button that was pushed. Same as button.", "guessedname": "which", "guessedtype": "property"}, "relatedTarget": {"type": "Node", "propery": "relatedTarget", "description": "Node reference to the relatedTarget", "guessedname": "relatedTarget", "guessedtype": "property"}, "button": {"type": "int", "description": "The button that was pushed.", "guessedname": "button", "guessedtype": "property"}, "_event": {"description": "The native event", "guessedname": "_event", "guessedtype": "property"}, "wheelDelta": {"type": "int", "description": "Number representing the direction and velocity of the movement of the mousewheel.\nNegative is down, the higher the number, the faster. Applies to the mousewheel event.", "guessedname": "type", "guessedtype": "property"}, "currentTarget": {"type": "Node", "propery": "currentTarget", "description": "Node reference for the element that the listener was attached to.", "guessedname": "currentTarget", "guessedtype": "property"}, "pageX": {"type": "int", "description": "The X location of the event on the page (including scroll)", "guessedname": "pageX", "guessedtype": "property"}, "pageY": {"type": "int", "description": "The Y location of the event on the page (including scroll)", "guessedname": "pageY", "guessedtype": "property"}, "charCode": {"type": "int", "description": "The charCode for key events. Same as keyCode", "guessedname": "charCode", "guessedtype": "property"}, "keyCode": {"type": "int", "description": "The keyCode for key events. Uses charCode if keyCode is not available", "guessedname": "keyCode", "guessedtype": "property"}, "target": {"type": "Node", "propery": "target", "description": "Node reference for the targeted element", "guessedname": "target", "guessedtype": "property"}}, "description": "Wraps a DOM event, properties requiring browser abstraction are\nfixed here. Provids a security layer when required."}, "Plugin.DragConstrained": {"name": "Plugin.DragConstrained", "configs": {"tickX": {"type": "Number/false", "description": "The X tick offset the drag node should snap to on each drag move. False for no ticks. Default: false", "guessedname": "tickX", "guessedtype": "property"}, "tickY": {"type": "Number/false", "description": "The Y tick offset the drag node should snap to on each drag move. False for no ticks. Default: false", "guessedname": "tickY", "guessedtype": "property"}, "constrain2region": {"type": "Object", "description": "An Object Literal containing a valid region (top, right, bottom, left) of page positions to constrain the drag node to.", "guessedname": "constrain2region", "guessedtype": "property"}, "tickYArray": {"type": "Array", "description": "An array of page coordinates to use as Y ticks for drag movement.", "guessedname": "tickYArray", "guessedtype": "property"}, "constrain2node": {"type": "Object", "description": "Will attempt to constrain the drag node to the boundaries of this node.", "guessedname": "constrain2node", "guessedtype": "property"}, "stickX": {"type": "Boolean", "description": "Stick the drag movement to the X-Axis. Default: false", "guessedname": "stickX", "guessedtype": "property"}, "stickY": {"type": "Boolean", "description": "Stick the drag movement to the Y-Axis", "guessedname": "stickY", "guessedtype": "property"}, "gutter": {"type": "String", "description": "CSS style string for the gutter of a region (supports negative values): '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)", "guessedname": "gutter", "guessedtype": "property"}, "constrain2view": {"type": "Object", "description": "Will attempt to constrain the drag node to the boundaries of the viewport region.", "guessedname": "constrain2view", "guessedtype": "property"}, "tickXArray": {"type": "Array", "description": "An array of page coordinates to use as X ticks for drag movement.", "guessedname": "tickXArray", "guessedtype": "property"}}, "constructors": [{"description": "This is a plugin for the dd-drag module to add the constraining methods to it. It supports constraining to a renodenode or viewport. It anode* supports tick based moves and XY axis constraints."}], "namespace": "Plugin", "module": "dd", "events": {"constrain2viewChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "constrain2viewChange", "description": "Fires when the value for the configuration attribute 'constrain2view' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "tickXChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "tickXChange", "description": "Fires when the value for the configuration attribute 'tickX' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "tickXArrayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "tickXArrayChange", "description": "Fires when the value for the configuration attribute 'tickXArray' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "gutterChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "gutterChange", "description": "Fires when the value for the configuration attribute 'gutter' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "constrain2nodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "constrain2nodeChange", "description": "Fires when the value for the configuration attribute 'constrain2node' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "stickYChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "stickYChange", "description": "Fires when the value for the configuration attribute 'stickY' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "tickYArrayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "tickYArrayChange", "description": "Fires when the value for the configuration attribute 'tickYArray' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "stickXChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "stickXChange", "description": "Fires when the value for the configuration attribute 'stickX' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "tickYChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "tickYChange", "description": "Fires when the value for the configuration attribute 'tickY' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "constrain2regionChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "constrain2regionChange", "description": "Fires when the value for the configuration attribute 'constrain2region' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "DRAG_NODE", "methods": {"_checkRegion": {"return": {"type": "Array", "description": "The new XY that is inside the region"}, "description": "Check if xy is inside a given region, if not change to it be inside.", "private": "", "params": [{"type": "Array", "name": "_xy", "description": " The XY to check if it's in the current region, if it isn't inside the region, it will reset the xy array to be inside the region."}], "guessedname": "_checkRegion", "guessedtype": "function"}, "_checkTicks": {"return": {"type": "Array", "description": "The calced XY coords"}, "description": "This method delegates the proper helper method for tick calculations", "private": "", "params": [{"type": "Array", "name": "xy", "description": " The XY coords for the Drag"}, {"type": "Object", "name": "r", "description": " The optional region that we are bound to."}], "guessedname": "_checkTicks", "guessedtype": "function"}, "getRegion": {"return": {"type": "Object", "description": ""}, "params": [{"type": "Boolean", "name": "inc", "description": " Include the node's height and width"}], "description": "Get the active region: viewport, node, custom region", "guessedname": "getRegion", "guessedtype": "function"}, "align": {"description": "Modifies the Drag.actXY method from the after drag:align event. This is where the constraining happens.", "guessedname": "align", "guessedtype": "function"}, "_handleStart": {"description": "Fires on drag:start and clears the _regionCache", "private": "", "guessedname": "_handleStart", "guessedtype": "function"}, "inRegion": {"return": {"type": "Boolean", "description": "True if the XY is inside the region, false otherwise."}, "params": [{"type": "Array", "name": "xy", "description": " Optional XY to check, if not supplied this.get('dragNode').getXY() is used."}], "description": "Checks if the XY passed or the dragNode is inside the active region.", "guessedname": "inRegion", "guessedtype": "function"}, "_cacheRegion": {"description": "Get's the region and caches it, called from window.resize and when the cache is null", "private": "", "guessedname": "_cacheRegion", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "constrain.js", "guessedtype": "property", "shortname": "DragConstrained", "properties": {"_regionCache": {"guessedname": "_regionCache", "type": "Object", "description": "Store a cache of the region that we are constraining to", "private": "", "guessedtype": "property"}, "con": {"type": "{String}", "description": "The Constrained instance will be placed on the Drag instance under the con namespace.", "guessedname": "NS", "guessedtype": "property"}}, "description": "This is a plugin for the dd-drag module to add the constraining methods to it. It supports constraining to a renodenode or viewport. It anode* supports tick based moves and XY axis constraints."}, "YUI": {"global": "", "name": "YUI", "constructors": [{"params": [{"type": "", "name": "o*", "description": " Up to five optional configuration objects. This object is stored\nin YUI.config. See config for the list of supported properties."}], "description": "The YUI global namespace object. If YUI is already defined, the\nexisting YUI object will not be overwritten so that defined\nnamespaces are preserved."}], "namespace": "", "module": "yui", "properties": {"Global": {"type": "EventTarget", "description": "Hosts YUI page level events. This is where events bubble to\nwhen the broadcast config is set to 2. This property is\nonly available if the custom event module is loaded.", "guessedname": "Global", "guessedtype": "property"}}, "methods": {"mix": {"return": {"type": "object", "description": "the augmented object"}, "description": "Applies the supplier's properties to the receiver. By default\nall prototype and static propertes on the supplier are applied\nto the corresponding spot on the receiver. By default all\nproperties are applied, and a property that is already on the\nreciever will not be overwritten. The default behavior can\nbe modified by supplying the appropriate parameters.", "params": [{"type": "Function", "name": "r", "description": " the object to receive the augmentation"}, {"type": "Function", "name": "s", "description": " the object that supplies the properties to augment"}, {"type": "boolean", "name": "ov", "description": " if true, properties already on the receiver\nwill be overwritten if found on the supplier."}, {"type": "string[]", "name": "wl", "description": " a whitelist. If supplied, only properties in \nthis list will be applied to the receiver."}, {"type": "int", "name": "mode", "description": " what should be copies, and to where\ndefault(0): object to object\n1: prototype to prototype (old augment)\n2: prototype to prototype and object props (new augment)\n3: prototype to object\n4: object to prototype"}, {"type": "boolean", "name": "merge", "description": " merge objects instead of overwriting/ignoring\nUsed by Y.aggregate"}], "guessedname": "mix", "guessedtype": "function", "todo": "add constants for the modes"}, "use": {"return": {"type": "YUI", "description": "the YUI instance"}, "description": "Bind a module to a YUI instance", "params": [{"type": "string", "name": "modules*", "description": " 1-n modules to bind (uses arguments array)"}, {"type": "function", "name": "*callback", "description": " callback function executed when \nthe instance has the required functionality. If included, it\nmust be the last parameter."}], "guessedname": "use", "guessedtype": "function", "todo": "Implement versioning? loader can load different versions?\nShould sub-modules/plugins be normal modules, or do\nwe add syntax for specifying these?\nYUI().use('dragdrop')\nYUI().use('dragdrop:2.4.0'); // specific version\nYUI().use('dragdrop:2.4.0-'); // at least this version\nYUI().use('dragdrop:2.4.0-2.9999.9999'); // version range\nYUI().use('*'); // use all available modules\nYUI().use('lang+dump+substitute'); // use lang and some plugins\nYUI().use('lang+*'); // use lang and all known plugins"}, "on": {"return": {"type": "", "description": "the event target or a detach handle per 'chain' config"}, "params": [{"type": "", "name": "type**", "description": " event type (this parameter does not apply for function events)"}, {"type": "", "name": "fn", "description": " the callback"}, {"type": "", "name": "target**", "description": " a descriptor for the target (applies to custom events only).\nFor function events, this is the object that contains the function to\nexecute."}, {"type": "", "name": "extra**", "description": " 0..n Extra information a particular event may need. These\nwill be documented with the event. In the case of function events, this\nis the name of the function to execute on the host. In the case of\ndelegate listeners, this is the event delegation specification."}, {"type": "", "name": "context", "description": " optionally change the value of 'this' in the callback"}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass to the callback."}], "description": "YUI's on method is a unified interface for subscribing to\nmost events exposed by YUI. This includes custom events, DOM events, and \nfunction events. detach is also provided to remove listeners\nserviced by this function.\nThe signature that on accepts varies depending on the type\nof event being consumed. Refer to the specific methods that will\nservice a specific request for additional information about subscribing\nto that type of event.\n
\n
Custom events. These events are defined by various\nmodules in the library. This type of event is delegated to\nEventTarget's on method.\n
\n
The type of the event
\n
The callback to execute
\n
An optional context object
\n
0..n additional arguments to supply the callback.
\n
\nExample: \nY.on('domready', function() { // start work });\n
\n
DOM events. These are moments reported by the browser related\nto browser functionality and user interaction.\nThis type of event is delegated to Event's \nattach method.\n
\n
The type of the event
\n
The callback to execute
\n
The specification for the Node(s) to attach the listener\nto. This can be a selector, collections, or Node/Element\nrefereces.
\n
An optional context object
\n
0..n additional arguments to supply the callback.
\n
\nExample: \nY.on('click', function(e) { // something was clicked }, '#someelement');\n
\n
Function events. These events can be used to react before or after a\nfunction is executed. This type of event is delegated to Event.Do's \nbefore method.\n
\n
The callback to execute
\n
The object that has the function that will be listened for.
\non corresponds to the moment before any default behavior of\nthe event. after works the same way, but these listeners\nexecute after the event's default behavior. before is an\nalias for on."}, "log": {"return": {"type": "YUI", "description": "YUI instance"}, "params": [{"type": "String", "name": "msg", "description": " The message to log."}, {"type": "String", "name": "cat", "description": " The log category for the message. Default\ncategories are \"info\", \"warn\", \"error\", time\".\nCustom categories can be used as well. (opt)"}, {"type": "String", "name": "src", "description": " The source of the the message (opt)"}, {"type": "boolean", "name": "silent", "description": " If true, the log event won't fire"}], "description": "If the 'debug' config is true, a 'yui:log' event will be\ndispatched, which the Console widget and anything else\ncan consume. If the 'useBrowserConsole' config is true, it will\nwrite to the browser console if available. YUI-specific log\nmessages will only be present in the -debug versions of the\nJS files. The build system is supposed to remove log statements\nfrom the raw and minified versions of the files.", "guessedname": "log", "guessedtype": "function"}, "merge": {"return": {"type": "object", "description": "the new merged object"}, "params": [{"type": "Object*", "name": "arguments", "description": " the objects to merge"}], "description": "Returns a new object containing all of the properties of\nall the supplied objects. The properties from later objects\nwill overwrite those in earlier objects. Passing in a\nsingle object will create a shallow copy of it. For a deep\ncopy, use clone.", "guessedname": "merge", "guessedtype": "function"}, "applyTo": {"return": {"type": "object", "description": "the return value from the applied method or null"}, "params": [{"type": "string", "name": "id", "description": " the YUI instance id"}, {"type": "string", "name": "method", "description": " the name of the method to exectute.\nEx: 'Object.keys'"}, {"type": "Array", "name": "args", "description": " the arguments to apply to the method"}], "description": "Executes a method on a YUI instance with\nthe specified id if the specified method is whitelisted.", "guessedname": "applyTo", "guessedtype": "function"}, "namespace": {"return": {"type": "object", "description": "A reference to the last namespace object created"}, "params": [{"type": "string*", "name": "arguments", "description": " 1-n namespaces to create"}], "description": "Returns the namespace specified and creates it if it doesn't exist\n
\nEither of the above would create YUI.property, then\nYUI.property.package (YAHOO is scrubbed out, this is\nto remain compatible with YUI2)\nBe careful when naming packages. Reserved words may work in some browsers\nand not others. For instance, the following will fail in Safari:\n
\nThis fails because \"long\" is a future reserved word in ECMAScript", "guessedname": "namespace", "guessedtype": "function"}, "later": {"return": {"type": "object", "description": "a timer object. Call the cancel() method on this object to \nstop the timer."}, "params": [{"type": "int", "name": "when", "description": " the number of milliseconds to wait until the fn \nis executed."}, {"type": "", "name": "o", "description": " the context object."}, {"type": "Function|String", "name": "fn", "description": " the function to execute or the name of \nthe method in the 'o' object to execute."}, {"type": "", "name": "data", "description": " [Array] data that is provided to the function. This accepts\neither a single item or an array. If an array is provided, the\nfunction is executed with one parameter for each array item. If\nyou need to pass a single array parameter, it needs to be wrapped in\nan array [myarray]."}, {"type": "boolean", "name": "periodic", "description": " if true, executes continuously at supplied \ninterval until canceled."}], "description": "Executes the supplied function in the context of the supplied \nobject 'when' milliseconds later. Executes the function a \nsingle time unless periodic is set to true.", "guessedname": "later", "guessedtype": "function"}, "_setup": {"private": "", "description": "Finishes the instance setup. Attaches whatever modules were defined\nwhen the yui modules was registered.", "guessedname": "_setup", "guessedtype": "function"}, "stamp": {"return": {"type": "string", "description": "The object's guid or null"}, "params": [{"type": "", "name": "o", "description": " The object to stamp"}, {"type": "boolean", "name": "readOnly", "description": " if true, a valid guid will only\nbe returned if the object has one assigned to it."}], "description": "Returns a guid associated with an object. If the object\ndoes not have one, a new one is created unless readOnly\nis specified.", "guessedname": "stamp", "guessedtype": "function"}, "add": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "string", "name": "name", "description": " module name"}, {"type": "Function", "name": "fn", "description": " entry point into the module that\nis used to bind module to the YUI instance"}, {"type": "string", "name": "version", "description": " version string"}, {"type": "", "name": "details", "description": " optional config data: \nrequires - features that should be present before loading\noptional - optional features that should be present if load optional defined\nuse - features that should be attached automatically\nskinnable -\nrollup\nomit - features that should not be loaded if this module is present"}], "description": "Register a module", "guessedname": "add", "guessedtype": "function"}, "Node.plug": {"static": "", "params": [{"type": "Function | Array", "name": "plugin", "description": " Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)"}, {"type": "Object", "name": "config", "description": " (Optional) If plugin is the plugin class, the configuration for the plugin"}], "description": "Registers plugins to be instantiated at the class level (plugins \nwhich should be plugged into every instance of Node by default).", "guessedname": "plug", "guessedtype": "function"}, "Node.unplug": {"static": "", "params": [{"type": "Function | Array", "name": "plugin", "description": " The plugin class, or an array of plugin classes"}], "description": "Unregisters any class level plugins which have been registered by the Node", "guessedname": "unplug", "guessedtype": "function"}, "delegate": {"return": {"type": "EventHandle", "description": "the detach handle"}, "params": [{"type": "string", "name": "type", "description": " the event type to delegate"}, {"type": "function", "name": "fn", "description": " the callback function to execute. This function\nwill be provided the event object for the delegated event."}, {"type": "string|node", "name": "el", "description": " the element that is the delegation container"}, {"type": "string", "name": "spec", "description": " a selector that must match the target of the\nevent."}, {"type": "", "name": "context", "description": " optional argument that specifies what 'this' refers to."}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object."}], "description": "Sets up event delegation on a container element. The delegated event\nwill use a supplied selector to test if the target or one of the\ndescendants of the target match it. The supplied callback function \nwill only be executed if a match was encountered, and, in fact, \nwill be executed for each element that matches if you supply an \nambiguous selector.\nThe event object for the delegated event is supplied to the callback\nfunction. It is modified slightly in order to support all properties\nthat may be needed for event delegation. 'currentTarget' is set to\nthe element that matched the delegation specifcation. 'container' is\nset to the element that the listener is bound to (this normally would\nbe the 'currentTarget').", "guessedname": "delegate", "guessedtype": "function"}, "simulate": {"return": {"type": "void", "description": ""}, "description": "Simulates the event with the given name on a target.", "static": "", "guessedname": "simulate", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "target", "description": " The DOM element that's the target of the event."}, {"type": "String", "name": "type", "description": " The type of event to simulate (i.e., \"click\")."}, {"type": "Object", "name": "options", "description": " (Optional) Extra options to copy onto the event object."}]}, "error": {"return": {"type": "YUI", "description": "this YUI instance"}, "params": [{"type": "string", "name": "msg", "description": " the error message"}, {"type": "Error", "name": "e", "description": " Optional JS error that was caught. If supplied\nand throwFail is specified, this error will be re-thrown."}], "description": "Report an error. The reporting mechanism is controled by\nthe 'throwFail' configuration attribute. If throwFail is\nnot specified, the message is written to the Logger, otherwise\na JS error is thrown", "guessedname": "error", "guessedtype": "function"}, "cached": {"function": "cached", "return": {"type": "Function", "description": "the wrapped function"}, "description": "Returns a wrapper for a function which caches the\nreturn value of that function, keyed off of the combined \nargument values.", "params": [{"type": "function", "name": "source", "description": " the function to memoize"}, {"type": "", "name": "cache", "description": " an optional cache seed"}, {"type": "", "name": "refetch", "description": " if supplied, this value is tested against the cached\nvalue. If the values are equal, the wrapped function is executed again."}], "guessedname": "cached", "guessedtype": "function"}, "message": {"return": {"type": "YUI", "description": "YUI instance"}, "params": [{"type": "String", "name": "msg", "description": " The message to log."}, {"type": "String", "name": "cat", "description": " The log category for the message. Default\ncategories are \"info\", \"warn\", \"error\", time\".\nCustom categories can be used as well. (opt)"}, {"type": "String", "name": "src", "description": " The source of the the message (opt)"}, {"type": "boolean", "name": "silent", "description": " If true, the log event won't fire"}], "description": "Write a system message. This message will be preserved in the\nminified and raw versions of the YUI files, unlike log statements.", "guessedname": "message", "guessedtype": "function"}, "guid": {"return": {"type": "string", "description": "the guid"}, "params": [{"type": "string", "name": "pre", "description": " optional guid prefix"}], "description": "Generate an id that is unique among all YUI instances", "guessedname": "guid", "guessedtype": "function"}, "_init": {"private": "", "description": "Initialize this YUI instance", "guessedname": "_init", "guessedtype": "function"}, "after": {"return": {"type": "", "description": "the event target or a detach handle per 'chain' config"}, "params": [{"type": "", "name": "type", "description": " event type (this parameter does not apply for function events)"}, {"type": "", "name": "fn", "description": " the callback"}, {"type": "", "name": "target", "description": " a descriptor for the target (applies to custom events only).\nFor function events, this is the object that contains the function to\nexecute."}, {"type": "", "name": "extra", "description": " 0..n Extra information a particular event may need. These\nwill be documented with the event. In the case of function events, this\nis the name of the function to execute on the host. In the case of\ndelegate listeners, this is the event delegation specification."}, {"type": "", "name": "context", "description": " optionally change the value of 'this' in the callback"}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass to the callback."}], "description": "after() is a unified interface for subscribing to\nmost events exposed by YUI. This includes custom events,\nDOM events, and AOP events. This works the same way as\nthe on() function, only it operates after any default\nbehavior for the event has executed. @see on for more \ninformation."}}, "uses": ["EventTarget"], "file": "yui.js", "shortname": "YUI", "events": {"available": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'available'"}, {"type": "function", "name": "fn", "description": " the callback function to execute."}, {"type": "string|HTMLElement|collection", "name": "el", "description": " the element(s) to attach"}, {"type": "", "name": "context", "description": " optional argument that specifies what 'this' refers to."}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object."}], "description": "Executes the callback as soon as the specified element \nis detected in the DOM.", "guessedname": "available", "guessedtype": "property"}, "contentready": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'contentready'"}, {"type": "function", "name": "fn", "description": " the callback function to execute."}, {"type": "string|HTMLElement|collection", "name": "el", "description": " the element(s) to attach"}, {"type": "", "name": "context", "description": " optional argument that specifies what 'this' refers to."}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object."}], "description": "Executes the callback as soon as the specified element \nis detected in the DOM with a nextSibling property\n(indicating that the element's children are available)", "guessedname": "contentready", "guessedtype": "property"}, "mousewheel": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'mousewheel'"}, {"type": "function", "name": "fn", "description": " the callback to execute"}, {"type": "", "name": "context", "description": " optional context object"}, {"type": "", "name": "args", "description": " 0..n additional arguments to provide to the listener."}], "description": "Mousewheel event. This listener is automatically attached to the\ncorrect target, so one should not be supplied. Mouse wheel \ndirection and velocity is stored in the 'mouseDelta' field.", "guessedname": "mousewheel", "guessedtype": "property"}, "mouseleave": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " \"mouseleave\""}, {"type": "function", "name": "fn", "description": " The method the event invokes."}, {"type": "string|node", "name": "el", "description": " The element(s) to assign the listener to."}, {"type": "string", "name": "spec", "description": " Optional. String representing a selector that must \nmatch the target of the event in order for the listener to be called."}], "description": "Sets up a \"mouseleave\" listener—a listener that is called the first time \nthe user's mouse leaves the specified element(s).", "guessedname": "mouseleave", "guessedtype": "property"}, "focus": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'focus'"}, {"type": "function", "name": "fn", "description": " the callback function to execute"}, {"type": "string|HTMLElement|collection", "name": "o", "description": " the element(s) to bind"}, {"type": "", "name": "context", "description": " optional context object"}, {"type": "", "name": "args", "description": " 0..n additional arguments to provide to the listener."}], "description": "Adds a DOM focus listener. Uses the focusin event in IE, \nDOMFocusIn for Opera and Webkit, and the capture phase for Gecko so that\nthe event propagates in a way that enables event delegation.", "guessedname": "focus", "guessedtype": "property"}, "windowresize": {"description": "Firefox fires the window resize event once when the resize action\nfinishes, other browsers fire the event periodically during the\nresize. This code uses timeout logic to simulate the Firefox \nbehavior in other browsers.", "guessedname": "windowresize", "guessedtype": "property"}, "delegate": {"return": "{EventHandle} the detach handle", "description": "Sets up event delegation on a container element. The delegated event\nwill use a supplied selector to test if the target or one of the\ndescendants of the target match it. The supplied callback function \nwill only be executed if a match was encountered, and, in fact, \nwill be executed for each element that matches if you supply an \nambiguous selector.\nThe event object for the delegated event is supplied to the callback\nfunction. It is modified slightly in order to support all properties\nthat may be needed for event delegation. 'currentTarget' is set to\nthe element that matched the delegation specifcation. 'container' is\nset to the element that the listener is bound to (this normally would\nbe the 'currentTarget').", "deprecated": "use Y.delegate", "params": [{"type": "string", "name": "type", "description": " 'delegate'"}, {"type": "function", "name": "fn", "description": " the callback function to execute. This function\nwill be provided the event object for the delegated event."}, {"type": "string|node", "name": "el", "description": " the element that is the delegation container"}, {"type": "string", "name": "delegateType", "description": " the event type to delegate"}, {"type": "string", "name": "spec", "description": " a selector that must match the target of the\nevent."}, {"type": "", "name": "context", "description": " optional argument that specifies what 'this' refers to."}, {"type": "", "name": "args*", "description": " 0..n additional arguments to pass on to the callback function.\nThese arguments will be added after the event object."}], "guessedname": "delegate", "guessedtype": "property"}, "key": {"return": "{Event.Handle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'key'"}, {"type": "function", "name": "fn", "description": " the function to execute"}, {"type": "string|HTMLElement|collection", "name": "id", "description": " the element(s) to bind"}, {"type": "string", "name": "spec", "description": " the keyCode and modifier specification"}, {"type": "", "name": "o", "description": " optional context object"}, {"type": "", "name": "args", "description": " 0..n additional arguments to provide to the listener."}], "description": "Add a key listener. The listener will only be notified if the\nkeystroke detected meets the supplied specification. The\nspec consists of the key event type, followed by a colon,\nfollowed by zero or more comma separated key codes, followed\nby zero or more modifiers delimited by a plus sign. Ex:\npress:12,65+shift+ctrl", "guessedname": "key", "guessedtype": "property"}, "blur": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " 'blur'"}, {"type": "function", "name": "fn", "description": " the callback function to execute"}, {"type": "string|HTMLElement|collection", "name": "o", "description": " the element(s) to bind"}, {"type": "", "name": "context", "description": " optional context object"}, {"type": "", "name": "args", "description": " 0..n additional arguments to provide to the listener."}], "description": "Adds a DOM blur listener. Uses the focusout event in IE, \nDOMFocusOut for Opera and Webkit, and the capture phase for Gecko so that\nthe event propagates in a way that enables event delegation.", "guessedname": "blur", "guessedtype": "property"}, "mouseenter": {"return": "{EventHandle} the detach handle", "params": [{"type": "string", "name": "type", "description": " \"mouseenter\""}, {"type": "function", "name": "fn", "description": " The method the event invokes."}, {"type": "string|node", "name": "el", "description": " The element(s) to assign the listener to."}, {"type": "string", "name": "spec", "description": " Optional. String representing a selector that must \nmatch the target of the event in order for the listener to be called."}], "description": "Sets up a \"mouseenter\" listener—a listener that is called the first time \nthe user's mouse enters the specified element(s).", "guessedname": "mouseenter", "guessedtype": "property"}}, "description": "The YUI global namespace object. If YUI is already defined, the\nexisting YUI object will not be overwritten so that defined\nnamespaces are preserved."}, "DataSource.Local": {"name": "DataSource.Local", "configs": {"source": {"default": "null", "type": "MIXED", "description": "Pointer to live data.", "guessedname": "source", "guessedtype": "property"}}, "constructors": [{"description": "Base class for the DataSource Utility."}], "namespace": "", "module": "datasource", "events": {"data": {"preventable": "_defDataFn", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
data (Object)
Raw data.
\n
"}], "description": "Fired when raw data is received.", "guessedname": "defaultFn", "guessedtype": "property"}, "sourceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "sourceChange", "description": "Fires when the value for the configuration attribute 'source' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "request": {"preventable": "_defRequestFn", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object.
\n
cfg (Object)
Configuration object.
\n
"}], "description": "Fired when a data request is received.", "guessedname": "defaultFn", "guessedtype": "property"}, "response": {"preventable": "_defResponseFn", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
data (Object)
Raw data.
\n
response (Object)
Normalized response object with the following properties:\n
\n
results (Object)
Parsed results.
\n
meta (Object)
Parsed meta data.
\n
error (Boolean)
Error flag.
\n
\n
\n
"}], "description": "Fired when response is returned.", "guessedname": "defaultFn", "guessedtype": "property"}, "error": {"params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
data (Object)
Raw data.
\n
response (Object)
Normalized response object with the following properties:\n
\n
results (Object)
Parsed results.
\n
meta (Object)
Parsed meta data.
\n
error (Object)
Error object.
\n
\n
\n
"}], "description": "Fired when an error is encountered."}}, "guessedname": "LANG", "methods": {"_initEvents": {"private": "", "description": "This method creates all the events for this module.", "guessedname": "_initEvents", "guessedtype": "function"}, "_defResponseFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
data (Object)
Raw data.
\n
response (Object)
Normalized response object with the following properties:\n
\n
results (Object)
Parsed results.
\n
meta (Object)
Parsed meta data.
\n
error (Boolean)
Error flag.
\n
\n
\n
"}], "description": "Sends data as a normalized response to callback.", "guessedname": "_defResponseFn", "guessedtype": "function"}, "_defRequestFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facadewith the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
"}], "description": "Manages request/response transaction. Must fire response\nevent when response is received. This method should be implemented by\nsubclasses to achieve more complex behavior such as accessing remote data.", "guessedname": "_defRequestFn", "guessedtype": "function"}, "DataSource.issueCallback": {"static": "", "params": [{"type": "Object", "name": "callback", "description": " The callback object."}, {"type": "Array", "name": "params", "description": " params to be passed to the callback method"}, {"type": "Boolean", "name": "error", "description": " whether an error occurred"}], "description": "Executes a given callback. The third param determines whether to execute", "guessedname": "issueCallback", "guessedtype": "function"}, "_defDataFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
data (Object)
Raw data.
\n
"}], "description": "Normalizes raw data into a response that includes results and meta properties.", "guessedname": "_defDataFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}, "sendRequest": {"return": {"type": "Number", "description": "Transaction ID."}, "params": [{"type": "Object", "name": "request", "description": " Request."}, {"type": "Object", "name": "callback", "description": " An object literal with the following properties:\n
\n
success
\n
The function to call when the data is ready.
\n
failure
\n
The function to call upon a response failure condition.
\n
argument
\n
Arbitrary data payload that will be passed back to the success and failure handlers.
\n
"}, {"type": "Object", "name": "cfg", "description": " Configuration object"}], "description": "Generates a unique transaction ID and fires request event.", "guessedname": "sendRequest", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "datasource-local.js", "guessedtype": "property", "shortname": "DataSource.Local", "properties": {"DataSource._tId": {"description": "Global transaction counter.", "default": "0", "private": "", "static": "", "guessedname": "_tId", "guessedtype": "property", "type": "Number"}, "NAME": {"description": "Class name.", "value": "\"dataSourceLocal\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Base class for the DataSource Utility."}, "NodeList": {"name": "NodeList", "constructors": [{"description": "The NodeList class provides a wrapper for manipulating DOM NodeLists.\nNodeList properties can be accessed via the set/get methods.\nUse Y.all() to retrieve NodeList instances."}], "namespace": "", "module": "node", "guessedname": "NodeList", "methods": {"set": {"see": "Node.set", "description": "Called on each Node instance"}, "getAttribute": {"return": {"type": "string", "description": "The attribute value"}, "see": "Node", "params": [{"type": "string", "name": "name", "description": " The attribute name"}], "description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes."}, "replaceClass": {"see": "Node.replaceClass", "params": [{"type": "String", "name": "oldClassName", "description": " the class name to be replaced"}, {"type": "String", "name": "newClassName", "description": " the class name that will be replacing the old class name"}], "chainable": "", "description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added."}, "some": {"return": {"type": "Boolean", "description": "Whether or not the function returned true for any node."}, "params": [{"type": "Function", "name": "fn", "description": " The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance"}, {"type": "Object", "name": "context", "description": " optional An optional context to execute the function from.\nDefault context is the current Node instance"}], "description": "Executes the function once for each node until a true value is returned.", "guessedname": "some", "guessedtype": "function"}, "setStyle": {"see": "Node.setStyle", "params": [{"type": "String", "name": "attr", "description": " The style attribute to set."}, {"type": "String|Number", "name": "val", "description": " The value."}], "chainable": "", "description": "Sets a style property on each node."}, "remove": {"see": "Node.remove", "description": "Called on each Node instance"}, "setStyles": {"see": "Node.setStyles", "params": [{"type": "Object", "name": "hash", "description": " An object literal of property:value pairs."}], "chainable": "", "description": "Sets multiple style properties on each node."}, "odd": {"return": {"type": "NodeList", "description": "NodeList containing the updated collection"}, "description": "Creates a new NodeList containing all nodes at odd indices\n(zero-based index).", "guessedname": "odd", "guessedtype": "function"}, "setContent": {"see": "Node.setContent", "description": "Called on each Node instance"}, "append": {"see": "Node.append", "description": "Called on each Node instance"}, "size": {"return": {"type": "Int", "description": "The number of items in the NodeList."}, "description": "Returns the current number of items in the NodeList.", "guessedname": "size", "guessedtype": "function"}, "even": {"return": {"type": "NodeList", "description": "NodeList containing the updated collection"}, "description": "Creates a new NodeList containing all nodes at even indices\n(zero-based index), including zero.", "guessedname": "even", "guessedtype": "function"}, "NodeList.getDOMNodes": {"return": {"type": "Array", "description": "The array of DOM nodes bound to the NodeList"}, "description": "Retrieves the DOM nodes bound to a NodeList instance", "static": "", "guessedname": "getDOMNodes", "guessedtype": "function", "params": [{"type": "Y.NodeList", "name": "node", "description": " The NodeList instance"}]}, "get": {"see": "Node", "description": "Called on each Node instance", "guessedname": "get", "guessedtype": "function"}, "getComputedStyle": {"return": {"type": "Array", "description": "The computed values for each node."}, "see": "Node.getComputedStyle", "params": [{"type": "String", "name": "attr", "description": " The style attribute to retrieve."}], "description": "Returns an array of the computed value for each node."}, "prepend": {"see": "Node.prepend", "description": "Called on each Node instance"}, "toDocFrag": {"return": {"type": "", "description": "Node a Node instance bound to the documentFragment"}, "description": "Creates a documenFragment from the nodes bound to the NodeList instance", "guessedname": "toFrag", "guessedtype": "function"}, "toggleClass": {"see": "Node.toggleClass", "params": [{"type": "String", "name": "className", "description": " the class name to be toggled"}], "chainable": "", "description": "If the className exists on the node it is removed, if it doesn't exist it is added."}, "modulus": {"return": {"type": "NodeList", "description": "NodeList containing the updated collection"}, "params": [{"type": "Int", "name": "n", "description": " The offset to use (return every nth node)"}, {"type": "Int", "name": "r", "description": " An optional remainder to use with the modulus operation (defaults to zero)"}], "description": "Creates a new NodeList containing all nodes at every n indices, where \nremainder n % index equals r.\n(zero-based index).", "guessedname": "modulus", "guessedtype": "function"}, "addClass": {"see": "Node.addClass", "params": [{"type": "String", "name": "className", "description": " the class name to add to the node's class attribute"}], "chainable": "", "description": "Adds a class name to each node."}, "removeClass": {"see": "Node.removeClass", "params": [{"type": "String", "name": "className", "description": " the class name to remove from the node's class attribute"}], "chainable": "", "description": "Removes a class name from each node."}, "insert": {"see": "NodeInsert", "description": "Called on each Node instance"}, "indexOf": {"return": {"type": "Int", "description": "the index of the node value or -1 if not found"}, "params": [{"type": "Y.Node || DOMNode", "name": "node", "description": " the node to search for"}], "description": "Returns the index of the node in the NodeList instance\nor -1 if the node isn't found.", "guessedname": "indexOf", "guessedtype": "function"}, "after": {"return": {"type": "Object", "description": "Returns an event handle that can later be use to detach()."}, "description": "Applies an event listener to each Node bound to the NodeList. \nThe handler is called only after all on() handlers are called\nand the event is not prevented.", "see": "Event.on", "params": [{"type": "String", "name": "type", "description": " The event being listened for"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}, {"type": "Object", "name": "context", "description": " The context to call the handler with.\nDefault is the NodeList instance."}], "guessedname": "after", "guessedtype": "function"}, "getStyle": {"return": {"type": "Array", "description": "The current values of the style property for the element."}, "see": "Node.getStyle", "params": [{"type": "String", "name": "attr", "description": " The style attribute to retrieve."}], "description": "Returns an array of values for each node."}, "detach": {"see": "Node.detach", "description": "Called on each Node instance"}, "on": {"return": {"type": "Object", "description": "Returns an event handle that can later be use to detach()."}, "description": "Applies an event listener to each Node bound to the NodeList.", "see": "Event.on", "params": [{"type": "String", "name": "type", "description": " The event being listened for"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}, {"type": "Object", "name": "context", "description": " The context to call the handler with.\nDefault is the NodeList instance."}], "guessedname": "on", "guessedtype": "function"}, "setAttribute": {"chainable": "", "params": [{"type": "string", "name": "name", "description": " The attribute name"}, {"type": "string", "name": "value", "description": " The value to set"}], "description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes.", "see": "Node"}, "refresh": {"chainable": "", "description": "Reruns the initial query, when created using a selector query", "guessedname": "refresh", "guessedtype": "function"}, "detachAll": {"see": "Node.detachAll", "description": "Called on each Node instance"}, "filter": {"return": {"type": "NodeList", "description": "NodeList containing the updated collection"}, "description": "Filters the NodeList instance down to only nodes matching the given selector.", "see": "Selector", "params": [{"type": "String", "name": "selector", "description": " The selector to filter against"}], "guessedname": "filter", "guessedtype": "function"}, "item": {"return": {"type": "Node", "description": "The Node instance at the given index."}, "params": [{"type": "Number", "name": "index", "description": " The index of the target Node."}], "description": "Retrieves the Node instance at the given index.", "guessedname": "item", "guessedtype": "function"}, "each": {"chainable": "", "params": [{"type": "Function", "name": "fn", "description": " The function to apply. It receives 3 arguments:\nthe current node instance, the node's index, and the NodeList instance"}, {"type": "Object", "name": "context", "description": " optional An optional context to apply the function with\nDefault context is the current Node instance"}], "description": "Applies the given function to each Node in the NodeList.", "guessedname": "each", "guessedtype": "function"}, "hasClass": {"return": {"type": "Array", "description": "An array of booleans for each node bound to the NodeList."}, "see": "Node.hasClass", "params": [{"type": "String", "name": "className", "description": " the class name to search for"}], "description": "Determines whether each node has the given className."}}, "file": "nodelist.js", "guessedtype": "function", "shortname": "NodeList", "description": "The NodeList class provides a wrapper for manipulating DOM NodeLists.\nNodeList properties can be accessed via the set/get methods.\nUse Y.all() to retrieve NodeList instances."}, "Widget": {"name": "Widget", "constructors": [{"params": [{"type": "Object", "name": "config", "description": " Object literal specifying widget configuration \nproperties."}], "description": "A base class for widgets, providing:\n
\n
The render lifecycle method, in addition to the init and destroy \nlifecycle methods provide by Base
\n
Abstract methods to support consistent MVC structure across \nwidgets: renderer, renderUI, bindUI, syncUI
\n
Support for common widget attributes, such as boundingBox, contentBox, visible, \ndisabled, focused, strings
\n
"}], "namespace": "", "module": "widget", "events": {"tabIndexChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "tabIndexChange", "description": "Fires when the value for the configuration attribute 'tabIndex' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "stringsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "stringsChange", "description": "Fires when the value for the configuration attribute 'strings' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "heightChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "heightChange", "description": "Fires when the value for the configuration attribute 'height' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "widget:contentUpdate": {"preventable": "false", "params": [{"type": "EventFacade", "name": "e", "description": " The Event Facade"}], "description": "Notification event, which widget implementations can fire, when\nthey change the content of the widget. This event has no default\nbehavior and cannot be prevented, so the \"on\" or \"after\"\nmoments are effectively equivalent (with on listeners being invoked before \nafter listeners).", "guessedname": "preventable", "guessedtype": "property"}, "boundingBoxChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "boundingBoxChange", "description": "Fires when the value for the configuration attribute 'boundingBox' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "focusedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "focusedChange", "description": "Fires when the value for the configuration attribute 'focused' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "visibleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "visibleChange", "description": "Fires when the value for the configuration attribute 'visible' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "moveStylesChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "moveStylesChange", "description": "Fires when the value for the configuration attribute 'moveStyles' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "contentBoxChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "contentBoxChange", "description": "Fires when the value for the configuration attribute 'contentBox' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "renderedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "renderedChange", "description": "Fires when the value for the configuration attribute 'rendered' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "localeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "localeChange", "description": "Fires when the value for the configuration attribute 'locale' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "widget:render": {"preventable": "_defRenderFn", "params": [{"type": "EventFacade", "name": "e", "description": " The Event Facade"}], "description": "Lifcyle event for the render phase, fired prior to rendering the UI \nfor the widget (prior to invoking the widgets renderer method).\n
\nSubscribers to the \"on\" moment of this event, will be notified \nbefore the widget is rendered.\n
\n
\nSubscribers to the \"after\" momemt of this event, will be notified\nafter rendering is complete.\n
", "guessedname": "queuable", "guessedtype": "property"}, "disabledChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "disabledChange", "description": "Fires when the value for the configuration attribute 'disabled' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "widthChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "widthChange", "description": "Fires when the value for the configuration attribute 'width' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"rendered": {"description": "Flag indicating whether or not this object\nhas been through the render lifecycle phase.", "default": "false", "readonly": "", "guessedname": "rendered", "guessedtype": "property", "type": "boolean"}, "width": {"default": "\"\"", "type": "{String | Number}", "description": "String with units, or number, representing the width of the Widget. If a number is provided,\nthe default unit, defined by the Widgets DEF_UNIT, property is used.", "guessedname": "width", "guessedtype": "property"}, "locale": {"default": "\"en\"", "type": "String", "description": "The default locale for the widget. NOTE: Using get/set on the \"strings\" attribute will\nreturn/set strings for this locale.", "guessedname": "locale", "guessedtype": "property"}, "height": {"default": "\"\"", "type": "{String | Number}", "description": "String with units, or number, representing the height of the Widget. If a number is provided,\nthe default unit, defined by the Widgets DEF_UNIT, property is used.", "guessedname": "height", "guessedtype": "property"}, "disabled": {"default": "false", "type": "boolean", "description": "Boolean indicating if the Widget should be disabled. The disabled implementation\nis left to the specific classes extending widget.", "guessedname": "disabled", "guessedtype": "property"}, "visible": {"default": "true", "type": "boolean", "description": "Boolean indicating weather or not the Widget is visible.", "guessedname": "visible", "guessedtype": "property"}, "focused": {"description": "Boolean indicating if the Widget, or one of its descendants, \nhas focus.", "default": "false", "readonly": "", "guessedname": "focused", "guessedtype": "property", "type": "boolean"}, "moveStyles": {"default": "false", "type": "boolean", "description": "Flag defining whether or not style properties from the content box\nshould be moved to the bounding box when wrapped (as defined by the WRAP_STYLES property)", "guessedname": "moveStyles", "guessedtype": "property"}, "boundingBox": {"type": "Node", "description": "The outermost DOM node for the Widget, used for sizing and positioning \nof a Widget as well as a containing element for any decorator elements used \nfor skinning.", "guessedname": "boundingBox", "guessedtype": "property"}, "contentBox": {"type": "Node", "description": "A DOM node that is a direct descendent of a Widget's bounding box that \nhouses its content.", "guessedname": "contentBox", "guessedtype": "property"}, "strings": {"default": "null", "type": "Object", "description": "Collection of strings used to label elements of the Widget's UI.", "guessedname": "strings", "guessedtype": "property"}, "tabIndex": {"default": "null", "type": "Number", "description": "Number (between -32767 to 32767) indicating the widget's \nposition in the default tab flow. The value is used to set the \n\"tabIndex\" attribute on the widget's bounding box. Negative values allow\nthe widget to receive DOM focus programmatically (by calling the focus\nmethod), while being removed from the default tab flow. A value of \nnull removes the \"tabIndex\" attribute from the widget's bounding box.", "guessedname": "tabIndex", "guessedtype": "property"}}, "methods": {"_uiSetVisible": {"protected": "", "params": [{"type": "boolean", "name": "val", "description": ""}], "description": "Sets the visible state for the UI", "guessedname": "_uiSetVisible", "guessedtype": "function"}, "render": {"description": "Establishes the initial DOM for the widget. Invoking this\nmethod will lead to the creating of all DOM elements for\nthe widget (or the manipulation of existing DOM elements \nfor the progressive enhancement use case).\n
\nThis method should only be invoked once for an initialized\nwidget.\n
\n
\nIt delegates to the widget specific renderer method to do\nthe actual work.\n
", "chainable": "", "params": [{"type": "Object | String", "name": "parentNode", "description": " Optional. The Node under which the \nWidget is to be rendered. This can be a Node instance or a CSS selector string. \n
\nIf the selector string returns more than one Node, the first node will be used \nas the parentNode. NOTE: This argument is required if both the boundingBox and contentBox\nare not currently in the document. If it's not provided, the Widget will be rendered\nto the body of the current document in this case.\n
"}], "guessedname": "render", "guessedtype": "function", "final": ""}, "show": {"description": "Shows the Module element by setting the \"visible\" attribute to \"true\".", "guessedname": "show", "guessedtype": "function"}, "focus": {"description": "Causes the Widget to receive the focus by setting the \"focused\" \nattribute to \"true\".", "guessedname": "focus", "guessedtype": "function"}, "initializer": {"protected": "", "params": [{"type": "Object", "name": "config", "description": " Configuration object literal for the widget"}], "description": "Initializer lifecycle implementation for the Widget class. Registers the \nwidget instance, and runs through the Widget's HTML_PARSER definition.", "guessedname": "initializer", "guessedtype": "function"}, "disabled": {"description": "Set the Widget's \"disabled\" attribute to \"true\".", "guessedname": "disable", "guessedtype": "function"}, "_uiSetDisabled": {"protected": "", "params": [{"type": "boolean", "name": "val", "description": ""}], "description": "Sets the disabled state for the UI", "guessedname": "_uiSetDisabled", "guessedtype": "function"}, "_setBox": {"return": {"type": "Node", "description": "The node"}, "description": "Helper method to set the bounding/content box, or create it from\nthe provided template if not found.", "private": "", "params": [{"type": "Node|String", "name": "node", "description": " The node reference"}, {"type": "String", "name": "template", "description": " HTML string template for the node"}], "guessedname": "_setBox", "guessedtype": "function"}, "_afterHeightChange": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the attribute change"}], "description": "Default height attribute state change handler", "guessedname": "_afterHeightChange", "guessedtype": "function"}, "renderer": {"protected": "", "description": "Creates DOM (or manipulates DOM for progressive enhancement)\nThis method is invoked by render() and is not chained \nautomatically for the class hierarchy (like initializer, destructor) \nso it should be chained manually for subclasses if required.", "guessedname": "renderer", "guessedtype": "function"}, "_syncUI": {"protected": "", "description": "Updates the widget UI to reflect the attribute state.", "guessedname": "_syncUI", "guessedtype": "function"}, "_uiSetHeight": {"protected": "", "params": [{"type": "String | Number", "name": "val", "description": ""}], "description": "Sets the height on the widget's bounding box element", "guessedname": "_uiSetHeight", "guessedtype": "function"}, "hide": {"description": "Shows the Module element by setting the \"visible\" attribute to \"false\".", "guessedname": "hide", "guessedtype": "function"}, "getString": {"params": [{"type": "String", "name": "key", "description": " The key."}, {"type": "String", "name": "locale", "description": " (optional) The locale for which the string value is required. Defaults to the current locale, if not provided."}], "description": "Gets the string for a particular key, for a particular locale, performing locale lookup.\n
\nIf no values if defined for the key, for the given locale, the value for the \ndefault locale (in initial locale set for the class) is returned.\n
", "guessedname": "getString", "guessedtype": "function"}, "_bindUI": {"protected": "", "description": "Sets up DOM and CustomEvent listeners for the widget.", "guessedname": "_bindUI", "guessedtype": "function"}, "Widget.getByNode": {"return": {"type": "Widget", "description": "Widget instance, or null if not found."}, "description": "Returns the widget instance whose bounding box contains, or is, the given node. \n
\nIn the case of nested widgets, the nearest bounding box ancestor is used to\nreturn the widget instance.\n
", "static": "", "guessedname": "getByNode", "guessedtype": "function", "params": [{"type": "Node | String", "name": "node", "description": " The node for which to return a Widget instance. If a selector\nstring is passed in, which selects more than one node, the first node found is used."}]}, "destructor": {"protected": "", "description": "Descructor lifecycle implementation for the Widget class. Purges events attached\nto the bounding box (and all child nodes) and removes the Widget from the \nlist of registered widgets.", "guessedname": "destructor", "guessedtype": "function"}, "getDefaultLocale": {"return": {"type": "String", "description": "The default locale for the widget"}, "description": "Returns the default locale for the widget (the locale value defined by the\nwidget class, or provided by the user during construction).", "guessedname": "getDefaultLocale", "guessedtype": "function"}, "_getStrings": {"protected": "", "params": [{"type": "Object", "name": "locale", "description": ""}], "description": "Returns the strings key/value hash for a paricular locale, without locale lookup applied.", "guessedname": "_getStrings", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The default string value for the widget [ displays the NAME of the instance, and the unique id ]"}, "description": "Generic toString implementation for all widgets.", "guessedname": "toString", "guessedtype": "function"}, "blur": {"description": "Causes the Widget to lose focus by setting the \"focused\" attribute \nto \"false\"", "guessedname": "blur", "guessedtype": "function"}, "bindUI": {"protected": "", "description": "Configures/Sets up listeners to bind Widget State to UI/DOM\nThis method is not called by framework and is not chained \nautomatically for the class hierarchy.", "guessedname": "bindUI", "guessedtype": "function"}, "_renderBox": {"guessedname": "_renderBox", "params": [{"type": "Node", "name": "parentNode", "description": " The parentNode to render the widget to. If not provided, and both the boundingBox and\nthe contentBox are not currently in the document, the widget will be rendered to the current document's body."}], "description": "Helper method to collect the boundingBox and contentBox, set styles and append to the provided parentNode, if not\nalready a child. The owner document of the boundingBox, or the owner document of the contentBox will be used \nas the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and\nthe contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered \nto the current document's body.", "private": "", "guessedtype": "function"}, "_onDocMouseDown": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the DOM focus event"}], "description": "\"mousedown\" event handler for the owner document of the \nwidget's bounding box.", "guessedname": "_onDocMouseDown", "guessedtype": "function"}, "_parseHTML": {"return": {"type": "Object", "description": "config configuration object, with values found in the HTML, populated"}, "description": "Utilitity method used to apply the HTML_PARSER configuration for the \ninstance, to retrieve config data values.", "private": "", "params": [{"type": "Node", "name": "node", "description": " Root node to use to parse markup for configuration data"}], "guessedname": "_parseHTML", "guessedtype": "function"}, "_uiSetTabIndex": {"protected": "", "params": [{"type": "", "name": "Number", "description": ""}], "description": "Set the tabIndex on the widget's rendered UI", "guessedname": "_uiSetTabIndex", "guessedtype": "function"}, "enable": {"description": "Set the Widget's \"disabled\" attribute to \"false\".", "guessedname": "enable", "guessedtype": "function"}, "getStrings": {"params": [{"type": "String", "name": "locale", "description": " (optional) The locale for which the string value is required. Defaults to the current locale, if not provided."}], "description": "Gets the entire strings hash for a particular locale, performing locale lookup.\n
\nIf no values of the key are defined for a particular locale the value for the \ndefault locale (in initial locale set for the class) is returned.\n
"}, "_uiSetFocused": {"protected": "", "params": [{"type": "boolean", "name": "val", "description": ""}, {"type": "string", "name": "src", "description": " String representing the source that triggered an update to \nthe UI."}], "description": "Sets the focused state for the UI", "guessedname": "_uiSetFocused", "guessedtype": "function"}, "_onFocus": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the DOM focus event"}], "description": "DOM focus event handler, used to sync the state of the Widget with the DOM", "guessedname": "_onFocus", "guessedtype": "function"}, "_afterWidthChange": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the attribute change"}], "description": "Default widget attribute state change handler", "guessedname": "_afterWidthChange", "guessedtype": "function"}, "_renderBoxClassNames": {"protected": "", "description": "Applies standard class names to the boundingBox and contentBox", "guessedname": "_renderBoxClassNames", "guessedtype": "function"}, "_afterFocusedChange": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the attribute change"}], "description": "Default focused attribute state change handler", "guessedname": "_afterFocusedChange", "guessedtype": "function"}, "_afterVisibleChange": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the attribute change"}], "description": "Default visible attribute state change handler", "guessedname": "_afterVisibleChange", "guessedtype": "function"}, "_renderUI": {"protected": "", "params": [{"type": "Node", "name": "The", "description": " parent node to rendering the widget into"}], "description": "Initializes the UI state for the Widget's bounding/content boxes.", "guessedname": "_renderUI", "guessedtype": "function"}, "_uiSetWidth": {"protected": "", "params": [{"type": "String | Number", "name": "val", "description": ""}], "description": "Sets the width on the widget's bounding box element", "guessedname": "_uiSetWidth", "guessedtype": "function"}, "_getHtmlParser": {"return": {"type": "Object", "description": "HTML_PARSER definition for this instance"}, "description": "Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER\ndefinitions across the class hierarchy.", "guessedname": "_getHtmlParser", "guessedtype": "function"}, "syncUI": {"description": "Refreshes the rendered UI, based on Widget State\nThis method is not called by framework and is not chained\nautomatically for the class hierarchy.", "guessedname": "syncUI", "guessedtype": "function"}, "_setContentBox": {"return": {"type": "", "description": "Node"}, "description": "Setter for the contentBox attribute", "private": "", "params": [{"type": "Node|String", "name": "node", "description": ""}], "guessedname": "_setContentBox", "guessedtype": "function"}, "_bindDOMListeners": {"protected": "", "description": "Sets up DOM listeners, on elements rendered by the widget.", "guessedname": "_bindDOMListeners", "guessedtype": "function"}, "_defRenderFn": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The Event object"}, {"type": "Node", "name": "parentNode", "description": " The parent node to render to, if passed in to the render method"}], "description": "Default render handler", "guessedname": "_defRenderFn", "guessedtype": "function"}, "_setStrings": {"protected": "", "params": [{"type": "Object", "name": "strings", "description": " The hash of string key/values to set"}, {"type": "Object", "name": "locale", "description": " The locale for the string values being set"}], "description": "Sets strings for a particular locale, merging with any existing\nstrings which may already be defined for the locale.", "guessedname": "_setStrings", "guessedtype": "function"}, "_moveStyles": {"guessedname": "_moveStyles", "params": [{"type": "Node", "name": "nodeFrom", "description": " The node to gather the styles from"}, {"type": "Node", "name": "nodeTo", "description": " The node to apply the styles to"}], "description": "Moves a pre-defined set of style rules (WRAP_STYLES) from one node to another.", "private": "", "guessedtype": "function"}, "getClassName": {"param": "{String}+ One or more classname bits to be joined and prefixed", "params": [{"type": "String*", "name": "args*", "description": " 0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name"}], "description": "Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined\nby the Y.config.classNamePrefix attribute used by ClassNameManager and \nWidget.NAME.toLowerCase() (e.g. \"yui-widget-xxxxx-yyyyy\", based on default values for \nthe prefix and widget class name).\n
\nThe instance based version of this method can be used to generate standard prefixed classnames,\nbased on the instances NAME, as opposed to Widget.NAME. This method should be used when you\nneed to use a constant class name across different types instances.\n
", "guessedname": "getClassName", "guessedtype": "function"}, "_afterDisabledChange": {"protected": "", "params": [{"type": "EventFacade", "name": "evt", "description": " The event facade for the attribute change"}], "description": "Default disabled attribute state change handler", "guessedname": "_afterDisabledChange", "guessedtype": "function"}, "renderUI": {"protected": "", "description": "Adds nodes to the DOM \nThis method is not called by framework and is not chained \nautomatically for the class hierarchy.", "guessedname": "renderUI", "guessedtype": "function"}, "_setBoundingBox": {"return": {"type": "", "description": "Node"}, "description": "Setter for the boundingBox attribute", "private": "", "params": [{"type": "", "name": "Node/String", "description": ""}], "guessedname": "_setBoundingBox", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "Widget.js", "shortname": "Widget", "properties": {"CONTENT_TEMPLATE": {"type": "String", "description": "Static property defining the markup template for content box.", "guessedname": "CONTENT_TEMPLATE", "guessedtype": "property"}, "_strings": {"guessedname": "_strings", "type": "Object", "description": "Private stings hash, used to store strings in locale specific buckets.", "private": "", "guessedtype": "property"}, "Widget._NAME_LOWERCASE": {"guessedname": "_NAME_LOWERCASE", "static": "", "description": "Cached lowercase version of Widget.NAME", "private": "", "guessedtype": "property"}, "DEF_UNIT": {"description": "Default unit to use for dimension values", "guessedname": "DEF_UNIT", "guessedtype": "property"}, "Widget.HTML_PARSER": {"type": "Object", "static": "", "description": "Object hash, defining how attribute values are to be parsed from\nmarkup contained in the widget's content box. e.g.:\n
\n{\n// Set single Node references using selector syntax \n// (selector is run through node.query)\ntitleNode: \"span.yui-title\",\n// Set NodeList references using selector syntax \n// (array indicates selector is to be run through node.queryAll)\nlistNodes: [\"li.yui-item\"],\n// Set other attribute types, using a parse function. \n// Context is set to the widget instance.\nlabel: function(contentBox) {\nreturn contentBox.query(\"span.title\").get(\"innerHTML\");\n}\n}\n
", "guessedname": "HTML_PARSER", "guessedtype": "property"}, "BOUNDING_TEMPLATE": {"type": "String", "description": "Static property defining the markup template for bounding box.", "guessedname": "BOUNDING_TEMPLATE", "guessedtype": "property"}, "_buildCfg": {"description": "The build configuration for the Widget class.\n
\nDefines the static fields which need to be aggregated,\nwhen this class is used as the main class passed to \nthe Base.build method.\n
", "private": "", "static": "", "guessedname": "_buildCfg", "guessedtype": "property", "type": "Object", "final": ""}, "Widget.UI_SRC": {"description": "Constant used to identify state changes originating from\nthe DOM (as opposed to the JavaScript model).", "static": "", "guessedname": "UI_SRC", "guessedtype": "property", "type": "String", "final": ""}, "Widget.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute \nconfiguration for the Widget.", "guessedname": "ATTRS", "guessedtype": "property"}, "Widget.NAME": {"type": "String", "static": "", "description": "Static property provides a string to identify the class.\n
\nCurrently used to apply class identifiers to the bounding box \nand to classify events fired by the widget.\n
", "guessedname": "NAME", "guessedtype": "property"}, "WRAP_STYLES": {"type": "Object", "description": "Static property listing the styles that are mimiced on the bounding box from the content box.", "guessedname": "WRAP_STYLES", "guessedtype": "property"}}, "description": "A base class for widgets, providing:\n
\n
The render lifecycle method, in addition to the init and destroy \nlifecycle methods provide by Base
\n
Abstract methods to support consistent MVC structure across \nwidgets: renderer, renderUI, bindUI, syncUI
\n
Support for common widget attributes, such as boundingBox, contentBox, visible, \ndisabled, focused, strings
\n
"}, "DataSource.Function": {"name": "DataSource.Function", "configs": {"source": {"default": "null", "type": "MIXED", "description": "Pointer to live data.", "guessedname": "source", "guessedtype": "property"}}, "constructors": [{"description": "Function subclass for the DataSource Utility."}], "namespace": "", "module": "datasource", "events": {"sourceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "sourceChange", "description": "Fires when the value for the configuration attribute 'source' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "LANG", "methods": {"_defRequestFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
"}], "description": "Passes query string to IO. Fires response event when\nresponse is received asynchronously.", "guessedname": "_defRequestFn", "guessedtype": "function"}}, "extends": "DataSource.Local", "superclass": "DataSource.Local", "file": "datasource-function.js", "guessedtype": "property", "shortname": "DataSource.Function", "properties": {"NAME": {"description": "Class name.", "value": "\"dataSourceFunction\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Function subclass for the DataSource Utility."}, "Object": {"name": "Object", "namespace": "", "module": "yui", "methods": {"setValue": {"return": {"type": "Object", "description": "The modified object, with the new sub value set, or \nundefined, if the path was invalid."}, "params": [{"type": "", "name": "o", "description": " The object on which to set the sub value."}, {"type": "Array", "name": "path", "description": " A path array, specifying the object traversal path\nat which to set the sub value."}, {"type": "Any", "name": "val", "description": " The new value for the sub-attribute."}], "description": "Sets the sub-attribute value at the provided path on the \nvalue object. Returns the modified value object, or \nundefined if the path is invalid.", "guessedname": "setValue", "guessedtype": "function"}, "keys": {"return": {"type": "string[]", "description": "the keys"}, "description": "Returns an array containing the object's keys", "static": "", "guessedname": "keys", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " an object"}], "todo": "use native Object.keys() if available"}, "_extract": {"return": {"type": "boolean|Array", "description": "the extracted info"}, "description": "Extracts the keys, values, or size from an object", "private": "", "static": "", "guessedname": "_extract", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " the object"}, {"type": "", "name": "what", "description": " what to extract (0: keys, 1: values, 2: size)"}]}, "hasValue": {"return": {"type": "boolean", "description": "true if the object contains the value"}, "description": "Returns true if the object contains a given value", "static": "", "guessedname": "hasValue", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " an object"}, {"type": "", "name": "v", "description": " the value to query"}]}, "getValue": {"return": {"type": "Any", "description": "The value stored in the path, undefined if not found.\nReturns the source object if an empty path is provided."}, "params": [{"type": "", "name": "o", "description": " The object from which to extract the property value"}, {"type": "Array", "name": "path", "description": " A path array, specifying the object traversal path\nfrom which to obtain the sub value."}], "description": "Retrieves the sub value at the provided path,\nfrom the value object provided.", "guessedname": "getValue", "guessedtype": "function"}, "each": {"return": {"type": "YUI", "description": "the YUI instance"}, "description": "Executes a function on each item. The function\nreceives the value, the key, and the object\nas paramters (in that order).", "static": "", "guessedname": "each", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " the object to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item. The function \nreceives three arguments: the value, the the key, the full object."}, {"type": "", "name": "c", "description": " the execution context"}, {"type": "boolean", "name": "proto", "description": " include proto"}]}, "()": {"return": {"type": "Object", "description": "the new object"}, "description": "Y.Object(o) returns a new object based upon the supplied object.", "static": "", "guessedname": "Object", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " the supplier object"}], "todo": "Use native Object.create() when available"}, "values": {"return": {"type": "Array", "description": "the values"}, "description": "Returns an array containing the object's values", "static": "", "guessedname": "values", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " an object"}], "todo": "use native Object.values() if available"}, "owns": {"return": {"type": "boolean", "description": "true if the object has the property on the instance"}, "description": "Determines whether or not the property was added\nto the object instance. Returns false if the property is not present\nin the object, or was inherited from the prototype.", "deprecated": "Safari 1.x support has been removed, so this is simply a \nwrapper for the native implementation. Use the native implementation\ndirectly instead.", "static": "", "guessedname": "owns", "guessedtype": "function", "params": [{"type": "any", "name": "o", "description": " The object being testing"}, {"type": "string", "name": "p", "description": " the property to look for"}], "todo": "Remove in B1"}, "hasKey": {"return": {"type": "boolean", "description": "true if the object contains the key"}, "description": "Returns true if the object contains a given key", "static": "", "guessedname": "hasKey", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " an object"}, {"type": "", "name": "k", "description": " the key to query"}]}, "size": {"return": {"type": "int", "description": "the size"}, "description": "Returns the size of an object", "static": "", "guessedname": "size", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " an object"}], "todo": "use native Object.size() if available"}}, "file": "yui-object.js", "shortname": "Object", "description": "Adds the following Object utilities to the YUI instance"}, "YUI~array~extras": {"name": "YUI~array~extras", "namespace": "", "module": "collection", "methods": {"Array.every": {"return": {"type": "boolean", "description": "true if every item in the array returns true\nfrom the supplied function."}, "description": "Executes the supplied function on each item in the array.", "static": "", "guessedname": "every", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item"}, {"type": "", "name": "o", "description": " Optional context object"}]}, "Array.filter": {"return": {"type": "Array", "description": "The items on which the supplied function\nreturned true. If no items matched an empty array is \nreturned."}, "description": "Executes the supplied function on each item in the array.\nReturns a new array containing the items that the supplied\nfunction returned true for.", "static": "", "guessedname": "filter", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item"}, {"type": "", "name": "o", "description": " Optional context object"}]}, "Array.partition": {"return": {"type": "", "description": "An object with two members, 'matches' and 'rejects',\nthat are arrays containing the items that were selected or \nrejected by the test function (or an empty array)."}, "description": "Partitions an array into two new arrays, one with the items\nthat match the supplied function, and one with the items that\ndo not.", "paran": "f {Function} a function that will receive each item \nin the collection and its index.", "static": "", "guessedname": "partition", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " a collection to iterate over"}, {"type": "", "name": "o", "description": " Optional execution context of f."}]}, "Array.reject": {"return": {"type": "Array", "description": "The items on which the supplied function\nreturned false."}, "description": "The inverse of filter. Executes the supplied function on each item. \nReturns a new array containing the items that the supplied\nfunction returned *false* for.", "static": "", "guessedname": "reject", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item"}, {"type": "", "name": "o", "description": " Optional context object"}]}, "Array.grep": {"return": {"type": "Array", "description": "All the items in the collection that \nproduce a match against the supplied regular expression. \nIf no items match, an empty array is returned."}, "description": "Iterates over an array, returning a new array of all the elements\nthat match the supplied regular expression", "static": "", "guessedname": "grep", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " a collection to iterate over"}, {"type": "RegExp", "name": "pattern", "description": " The regular expression to test against \neach item"}]}, "Array.map": {"return": {"type": "Array", "description": "A new array containing the return value\nof the supplied function for each item in the original\narray."}, "description": "Executes the supplied function on each item in the array.", "static": "", "guessedname": "map", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item"}, {"type": "", "name": "o", "description": " Optional context object"}]}, "Array.unique": {"return": {"type": "Array", "description": "a copy of the array with duplicate entries removed"}, "description": "Returns a copy of the array with the duplicate entries removed", "static": "", "guessedname": "unique", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " the array to find the subset of uniques for"}, {"type": "bool", "name": "sort", "description": " flag to denote if the array is sorted or not. Defaults to false, the more general operation"}]}, "Array.find": {"return": {"type": "object", "description": "the first item that the supplied function\nreturns true for, or null if it never returns true"}, "description": "Executes the supplied function on each item in the array,\nsearching for the first item that matches the supplied\nfunction.", "static": "", "guessedname": "find", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " the array to search"}, {"type": "Function", "name": "f", "description": " the function to execute on each item. \nIteration is stopped as soon as this function returns true\non an item."}, {"type": "", "name": "o", "description": " Optional context object"}]}, "Array.zip": {"return": {"type": "", "description": "An array of arrays formed by pairing each element \nof the first collection with an item in the second collection \nhaving the corresponding index."}, "description": "Creates an array of arrays by pairing the corresponding\nelements of two arrays together into a new array.", "static": "", "guessedname": "zip", "guessedtype": "function", "params": [{"type": "Array", "name": "a", "description": " a collection to iterate over"}, {"type": "Array", "name": "a2", "description": " another collection whose members will be \npaired with members of the first parameter"}]}, "Array.reduce": {"return": {"type": "", "description": "A value that results from iteratively applying the\nsupplied function to each element in the array."}, "description": "Executes the supplied function on each item in the array.\nReduce \"folds\" the array into a single value.", "static": "", "guessedname": "reduce", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "", "name": "init", "description": " The initial value to start from"}, {"type": "Function", "name": "f", "description": " the function to execute on each item. It\nis responsible for returning the updated value of the\ncomputation."}, {"type": "", "name": "o", "description": " Optional context object"}]}}, "file": "array-extras.js", "shortname": "YUI~array~extras", "properties": {"lastIndexOf": {"return": "{int} the index of hte item that contains the value or -1", "description": "Returns the index of the last item in the array\nthat contains the specified value, -1 if the\nvalue isn't found.\nmethod Array.lastIndexOf", "param": "a {Array} the array to search", "static": "", "guessedname": "lastIndexOf", "guessedtype": "property"}}, "description": "Adds the following array utilities to the YUI instance\n(Y.Array). This is in addition to the methods provided\nin the core."}, "Base": {"name": "Base", "constructors": [{"params": [{"type": "Object", "name": "config", "description": " Object with configuration property name/value pairs"}], "description": "
\nA base class which objects requiring attributes and custom event support can \nextend. Base also handles the chaining of initializer and destructor methods across \nthe hierarchy as part of object construction and destruction. Additionally, attributes configured \nthrough the static ATTRS property for each class \nin the hierarchy will be initialized by Base.\n
\n
\nThe static NAME property of each class extending \nfrom Base will be used as the identifier for the class, and is used by Base to prefix \nall events fired by instances of that class.\n
\nLifecycle event for the destroy phase, \nfired prior to destruction. Invoking the preventDefault \nmethod on the event object provided to subscribers will \nprevent destruction from proceeding.\n
\n
\nSubscribers to the \"after\" moment of this event, will be notified\nafter destruction is complete (and as a result cannot prevent\ndestruction).\n
"}, "destroyedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "destroyedChange", "description": "Fires when the value for the configuration attribute 'destroyed' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "init": {"preventable": "_defInitFn", "params": [{"type": "EventFacade", "name": "e", "description": " Event object, with a cfg property which \nrefers to the configuration object passed to the constructor."}], "description": "
\nLifecycle event for the init phase, fired prior to initialization. \nInvoking the preventDefault() method on the event object provided \nto subscribers will prevent initialization from occuring.\n
\n
\nSubscribers to the \"after\" momemt of this event, will be notified\nafter initialization of the object is complete (and therefore\ncannot prevent initialization).\n
"}, "initializedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "initializedChange", "description": "Fires when the value for the configuration attribute 'initialized' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"destroyed": {"description": "Flag indicating whether or not this object\nhas been through the destroy lifecycle phase.", "default": "false", "readonly": "", "guessedname": "destroyed", "guessedtype": "property", "type": "boolean"}, "initialized": {"description": "Flag indicating whether or not this object\nhas been through the init lifecycle phase.", "default": "false", "readonly": "", "guessedname": "initialized", "guessedtype": "property", "type": "boolean"}}, "methods": {"Base.unplug": {"static": "", "description": "Alias for Plugin.Host.unplug. See the \naliased method for argument and return value details.", "guessedname": "unplug", "guessedtype": "property"}, "toString": {"return": {"type": "String", "description": "String representation for this object"}, "description": "Default toString implementation. Provides the constructor NAME\nand the instance ID.", "guessedname": "toString", "guessedtype": "function"}, "_defInitFn": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " Event object, with a cfg property which \nrefers to the configuration object passed to the constructor."}], "description": "Default init event handler", "guessedname": "_defInitFn", "guessedtype": "function"}, "_initHierarchyData": {"private": "", "description": "A helper method used by _getClasses and _getAttrCfgs, which determines both\nthe array of classes and aggregate set of attribute configurations\nacross the class hierarchy for the instance.", "guessedname": "_initHierarchyData", "guessedtype": "function"}, "_aggregateAttrs": {"return": {"type": "Object", "description": "The aggregate set of ATTRS definitions for the instance"}, "description": "A helper method, used by _initHierarchyData to aggregate \nattribute configuration across the instances class hierarchy.\nThe method will potect the attribute configuration value to protect the statically defined \ndefault value in ATTRS if required (if the value is an object literal, array or the \nattribute configuration has cloneDefaultValue set to shallow or deep).", "private": "", "params": [{"type": "Array", "name": "allAttrs", "description": " An array of ATTRS definitions across classes in the hierarchy \n(subclass first, Base last)"}], "guessedname": "_aggregateAttrs", "guessedtype": "function"}, "_destroyHierarchy": {"private": "", "description": "Destroys the class hierarchy for this instance by invoking\nthe descructor method on the prototype of each class in the hierarchy.", "guessedname": "_destroyHierarchy", "guessedtype": "function"}, "init": {"return": {"type": "Base", "description": "A reference to this object"}, "description": "Init lifecycle method, invoked during construction.\nFires the init event prior to setting up attributes and \ninvoking initializers for the class hierarchy.", "chainable": "", "params": [{"type": "Object", "name": "config", "description": " Object with configuration property name/value pairs"}], "guessedname": "init", "guessedtype": "function", "final": ""}, "_defDestroyFn": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " Event object"}], "description": "Default destroy event handler", "guessedname": "_defDestroyFn", "guessedtype": "function"}, "_getClasses": {"protected": "", "return": {"type": "Function[]", "description": "An array of classes (constructor functions), making up the class hierarchy for this object.\nThis value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the \ncached value."}, "description": "Returns the class hierarchy for this object, with Base being the last class in the array.", "guessedname": "_getClasses", "guessedtype": "function"}, "Base.plug": {"static": "", "description": "Alias for Plugin.Host.plug. See aliased \nmethod for argument and return value details.", "guessedname": "plug", "guessedtype": "property"}, "_getAttrCfgs": {"protected": "", "return": {"type": "Object", "description": "The hash of attribute configurations, aggregated across classes in the hierarchy\nThis value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return\nthe cached value."}, "description": "Returns an aggregated set of attribute configurations, by traversing the class hierarchy.", "guessedname": "_getAttrCfgs", "guessedtype": "function"}, "_filterAttrCfs": {"return": {"type": "Object", "description": "The set of attributes belonging to the class passed in, in the form\nof an object with attribute name/configuration pairs."}, "description": "A helper method used when processing ATTRS across the class hierarchy during \ninitialization. Returns a disposable object with the attributes defined for \nthe provided class, extracted from the set of all attributes passed in .", "private": "", "params": [{"type": "Function", "name": "clazz", "description": " The class for which the desired attributes are required."}, {"type": "Object", "name": "allCfgs", "description": " The set of all attribute configurations for this instance. \nAttributes will be removed from this set, if they belong to the filtered class, so\nthat by the time all classes are processed, allCfgs will be empty."}], "guessedname": "_filterAttrCfgs", "guessedtype": "function"}, "destroy": {"return": {"type": "Base", "description": "A reference to this object"}, "description": "
\nDestroy lifecycle method. Fires the destroy\nevent, prior to invoking destructors for the\nclass hierarchy.\n
\n
\nSubscribers to the destroy\nevent can invoke preventDefault on the event object, to prevent destruction\nfrom proceeding.\n
", "chainable": "", "guessedname": "destroy", "guessedtype": "function", "final": ""}, "_initHierarchy": {"guessedname": "_initHierarchy", "params": [{"type": "Object", "name": "userVals", "description": " Object with configuration property name/value pairs"}], "description": "Initializes the class hierarchy for the instance, which includes \ninitializing attributes for each class defined in the class's \nstatic ATTRS property and \ninvoking the initializer method on the prototype of each class in the hierarchy.", "private": "", "guessedtype": "function"}, "Base.build": {"return": {"type": "Function", "description": "A custom class, created from the provided main and extension classes"}, "description": "
\nBuilds a custom constructor function (class) from the\nmain function, and array of extension functions (classes)\nprovided. The NAME field for the constructor function is \ndefined by the first argument passed in.\n
\n
\nThe cfg object supports the following properties\n
\n
\n
dynamic <boolean>
\n
\n
If true (default), a completely new class\nis created which extends the main class, and acts as the \nhost on which the extension classes are augmented.
\n
If false, the extensions classes are augmented directly to\nthe main class, modifying the main class' prototype.
\n
\n
aggregates <String[]>
\n
An array of static property names, which will get aggregated\non to the built class, in addition to the default properties build \nwill always aggregate as defined by the main class' static _buildCfg\nproperty.\n
\n
", "static": "", "guessedname": "build", "guessedtype": "function", "params": [{"type": "Function", "name": "name", "description": " The name of the new class. Used to defined the NAME property for the new class."}, {"type": "Function", "name": "main", "description": " The main class on which to base the built class"}, {"type": "Function[]", "name": "extensions", "description": " The set of extension classes which will be\naugmented/aggregated to the built class."}, {"type": "Object", "name": "cfg", "description": " Optional. Build configuration for the class (see description)."}]}}, "uses": ["Attribute", "Plugin.Host"], "file": "Base.js", "shortname": "Base", "properties": {"Base._buildCfg": {"description": "The build configuration for the Base class.\nDefines the static fields which need to be aggregated\nwhen the Base class is used as the main class passed to \nthe Base.build method.", "private": "", "static": "", "guessedname": "_buildCfg", "guessedtype": "property", "type": "Object", "final": ""}, "Base.ATTRS": {"type": "Object", "static": "", "description": "The default set of attributes which will be available for instances of this class, and \ntheir configuration. In addition to the configuration properties listed by \nAttribute's addAttr method, the attribute \ncan also be configured with a \"cloneDefaultValue\" property, which defines how the statically\ndefined value field should be protected (\"shallow\", \"deep\" and false are supported values). \nBy default if the value is an object literal or an array it will be \"shallow\" cloned, to \nprotect the default value.", "guessedname": "ATTRS", "guessedtype": "property"}, "name": {"deprecated": "Use this.constructor.NAME", "type": "String", "description": "The string used to identify the class of this object.", "guessedname": "prefix", "guessedtype": "property"}, "Base._ATTR_CFG": {"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce, readOnly etc.)", "private": "", "static": "", "guessedname": "_ATTR_CFG", "guessedtype": "property", "type": "Array"}, "Base.NAME": {"type": "String", "static": "", "description": "
\nThe string to be used to identify instances of \nthis class, for example in prefixing events.\n
\n
\nClasses extending Base, should define their own\nstatic NAME property, which should be camelCase by\nconvention (e.g. MyClass.NAME = \"myClass\";).\n
\nA base class which objects requiring attributes and custom event support can \nextend. Base also handles the chaining of initializer and destructor methods across \nthe hierarchy as part of object construction and destruction. Additionally, attributes configured \nthrough the static ATTRS property for each class \nin the hierarchy will be initialized by Base.\n
\n
\nThe static NAME property of each class extending \nfrom Base will be used as the identifier for the class, and is used by Base to prefix \nall events fired by instances of that class.\n
"}, "History.Module": {"name": "History.Module", "constructors": [{"params": [{"type": "String", "name": "id", "description": " the module identifier"}, {"type": "String", "name": "initialState", "description": " the module's initial state"}], "description": "This class represents a browser history module."}], "namespace": "", "module": "history", "guessedname": "Module", "file": "history.js", "guessedtype": "function", "shortname": "History.Module", "properties": {"upcomingState": {"description": "The module's upcoming state. There can be a slight delay between the\ntime a state is changed, and the time a state change is detected.\nThis property allows us to not fire the module state changed event\nmultiple times, making client code simpler.", "private": "", "guessedname": "upcomingState", "guessedtype": "property", "type": "String", "final": ""}, "id": {"final": "", "type": "String", "description": "The module identifier", "guessedname": "id", "guessedtype": "property"}, "currentState": {"final": "", "type": "String", "description": "The module's current state", "guessedname": "currentState", "guessedtype": "property"}, "initialState": {"final": "", "type": "String", "description": "The module's initial state", "guessedname": "initialState", "guessedtype": "property"}}, "description": "This class represents a browser history module."}, "Plugin.Base": {"name": "Plugin.Base", "namespace": "", "module": "plugin", "events": {"hostChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "hostChange", "description": "Fires when the value for the configuration attribute 'host' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"host": {"guessedtype": "property", "type": "Plugin.Host", "description": "The plugin's host object.", "guessedname": "host", "writeonce": ""}}, "methods": {"doAfter": {"return": {"type": "EventHandle", "description": "handle The detach handle for the handler."}, "params": [{"type": "String", "name": "sFn", "description": " The event to listen for, or method to inject logic after."}, {"type": "Function", "name": "fn", "description": " The handler function. For events, the \"after\" moment listener. For methods, the function to execute after the given method is executed."}, {"type": "Object", "name": "context", "description": " An optional context to call the handler with. The default context is the plugin instance."}], "description": "Listens for the \"after\" moment of events fired by the host, \nor injects code \"after\" a given method on the host.", "guessedname": "doAfter", "guessedtype": "function"}, "destructor": {"description": "Destructor lifecycle implementation.\nRemoves any event listeners or injected methods applied by the Plugin", "guessedname": "destructor", "guessedtype": "function"}, "doBefore": {"return": {"type": "EventHandle", "description": "handle The detach handle for the handler."}, "params": [{"type": "String", "name": "sFn", "description": " The event to listen for, or method to inject logic before."}, {"type": "Function", "name": "fn", "description": " The handler function. For events, the \"on\" moment listener. For methods, the function to execute before the given method is executed."}, {"type": "Object", "name": "context", "description": " An optional context to call the handler with. The default context is the plugin instance."}], "description": "Listens for the \"on\" moment of events fired by the host, \nor injects code \"before\" a given method on the host.", "guessedname": "doBefore", "guessedtype": "function"}, "initializer": {"params": [{"type": "Object", "name": "config", "description": " Configuration object with property name/value pairs."}], "description": "Initializer lifecycle implementation.", "guessedname": "initializer", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "plugin.js", "shortname": "Plugin.Base", "param": "{Object} config Configuration object with property name/value pairs.", "properties": {"_handles": {"description": "The list of event handles for event listeners or AOP injected methods\napplied by the plugin to the host object.", "private": "", "value": "null", "guessedname": "_handles", "guessedtype": "property", "type": "Array"}, "Plugin.NS": {"type": "String", "static": "", "description": "The name of the property the the plugin will be attached to\nwhen plugged into a Plugin Host. Plugins extending Plugin.Base,\nshould set their own NS value.", "guessedname": "NS", "guessedtype": "property"}, "Plugin.Base.ATTRS": {"type": "Object", "static": "", "description": "Object defining the set of attributes supported by the Plugin.Base class", "guessedname": "ATTRS", "guessedtype": "property"}, "Plugin.Base.NAME": {"type": "String", "static": "", "description": "The string identifying the Plugin.Base class. Plugins extending\nPlugin.Base should set their own NAME value.", "guessedname": "NAME", "guessedtype": "property"}}, "description": "The base class for all Plugin instances."}, "Do.AlterArgs": {"name": "Do.AlterArgs", "namespace": "", "module": "event-custom", "guessedname": "AlterArgs", "file": "event-do.js", "guessedtype": "function", "shortname": "Do.AlterArgs", "description": "Return an AlterArgs object when you want to change the arguments that\nwere passed into the function. An example would be a service that scrubs\nout illegal characters prior to executing the core business logic."}, "Pollable": {"name": "Pollable", "namespace": "", "module": "datasource", "guessedname": "LANG", "methods": {"setInterval": {"return": {"type": "Number", "description": "Interval ID."}, "params": [{"type": "Number", "name": "msec", "description": " Length of interval in milliseconds."}, {"type": "Object", "name": "request", "description": " Request object."}, {"type": "Object", "name": "callback", "description": " An object literal with the following properties:\n
\n
success
\n
The function to call when the data is ready.
\n
failure
\n
The function to call upon a response failure condition.
\n
argument
\n
Arbitrary data that will be passed back to the success and failure handlers.
\n
"}], "description": "Sets up a polling mechanism to send requests at set intervals and forward\nresponses to given callback.", "guessedname": "setInterval", "guessedtype": "function"}, "clearInterval": {"params": [{"type": "Number", "name": "id", "description": " Interval ID."}], "description": "Disables polling mechanism associated with the given interval ID.", "guessedname": "clearInterval", "guessedtype": "function"}, "clearAllIntervals": {"description": "Clears all intervals.", "guessedname": "clearAllIntervals", "guessedtype": "function"}}, "extends": "DataSource.Local", "superclass": "DataSource.Local", "file": "datasource-polling.js", "guessedtype": "property", "shortname": "Pollable", "properties": {"_intervals": {"private": "", "description": "Hash of polling interval IDs that have been enabled,\nstored here to be able to clear all intervals.", "guessedname": "_intervals", "guessedtype": "property"}}, "description": "Adds polling to the DataSource Utility."}, "ClassNameManager": {"name": "ClassNameManager", "namespace": "", "module": "classnamemanager", "methods": {"getClassName": {"params": [{"type": "String", "name": "+", "description": " one or more classname bits to be joined and prefixed"}], "description": "Returns a class name prefixed with the the value of the \nY.config.classNamePrefix attribute + the provided strings.\nUses the Y.config.classNameDelimiter attribute to delimit the \nprovided strings. E.g. Y.ClassNameManager.getClassName('foo','bar'); // yui-foo-bar", "guessedname": "getClassName", "guessedtype": "function"}}, "static": "", "file": "classnamemanager.js", "shortname": "ClassNameManager", "properties": {"Y.config.classNameDelimiter": {"default": "\"-\"", "type": "{String}", "static": "", "description": "Configuration property indicating the delimiter used to compose all CSS class names in\nthis YUI instance."}, "Y.config.classNamePrefix": {"default": "\"yui\"", "type": "{String}", "static": "", "description": "Configuration property indicating the prefix for all CSS class names in this YUI instance."}}, "description": "A singleton class providing: \n
\n
Easy creation of prefixed class names
\n
Caching of previously created class names for improved performance.
\n
"}, "Assert.ObjectAssert": {"name": "Assert.ObjectAssert", "namespace": "Assert", "module": "test", "guessedname": "ObjectAssert", "methods": {"hasKeys": {"static": "", "params": [{"type": "Array", "name": "properties", "description": " An array of property names that should be on the object."}, {"type": "Object", "name": "object", "description": " The object to search."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an object has all properties of a reference object.", "guessedname": "hasKeys", "guessedtype": "function"}, "ownsKeys": {"static": "", "params": [{"type": "Array", "name": "properties", "description": " An array of property names that should be on the object."}, {"type": "Object", "name": "object", "description": " The object to search."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that all properties exist on an object instance (not on its prototype).", "guessedname": "ownsKeys", "guessedtype": "function"}, "hasKey": {"static": "", "params": [{"type": "String", "name": "propertyName", "description": " The name of the property to test."}, {"type": "Object", "name": "object", "description": " The object to search."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an object has a property with the given name.", "guessedname": "hasKey", "guessedtype": "function"}, "ownsNoKeys": {"static": "", "params": [{"type": "Object", "name": "object", "description": " The object to check."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an object owns no properties.", "guessedname": "ownsNoKeys", "guessedtype": "function"}, "ownsKey": {"static": "", "params": [{"type": "String", "name": "propertyName", "description": " The name of the property to test."}, {"type": "Object", "name": "object", "description": " The object to search."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a property with the given name exists on an object instance (not on its prototype).", "guessedname": "ownsKey", "guessedtype": "function"}}, "static": "", "file": "ObjectAssert.js", "guessedtype": "property", "shortname": "ObjectAssert", "description": "The ObjectAssert object provides functions to test JavaScript objects\nfor a variety of cases."}, "Plugin.DDWindowScroll": {"name": "Plugin.DDWindowScroll", "constructors": [{"description": "Extends the Scroll class to make the window scroll while dragging."}], "namespace": "Plugin", "module": "dd", "events": {"windowScrollChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "windowScrollChange", "description": "Fires when the value for the configuration attribute 'windowScroll' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "WS", "extends": "DD.Scroll", "superclass": "DD.Scroll", "file": "scroll.js", "guessedtype": "function", "shortname": "DDWindowScroll", "configs": {"windowScroll": {"type": "Boolean", "description": "Turn on window scroll support, default: true", "guessedname": "windowScroll", "guessedtype": "property"}}, "description": "Extends the Scroll class to make the window scroll while dragging."}, "plugin.NodeFocusManager": {"name": "plugin.NodeFocusManager", "namespace": "plugin", "module": "node-focusmanager", "events": {"circularChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "circularChange", "description": "Fires when the value for the configuration attribute 'circular' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "keysChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "keysChange", "description": "Fires when the value for the configuration attribute 'keys' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "focusClassChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "focusClassChange", "description": "Fires when the value for the configuration attribute 'focusClass' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "activeDescendantChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "activeDescendantChange", "description": "Fires when the value for the configuration attribute 'activeDescendant' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "focusedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "focusedChange", "description": "Fires when the value for the configuration attribute 'focused' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "descendantsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "descendantsChange", "description": "Fires when the value for the configuration attribute 'descendants' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "NodeFocusManager", "methods": {"_onDocMouseDown": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mousedown\" event handler for the owner document of the \nFocus Manager's Node.", "guessedname": "_onDocMouseDown", "guessedtype": "function"}, "_detachEventHandlers": {"protected": "", "description": "Detaches all event handlers used by the Focus Manager.", "guessedname": "_detachEventHandlers", "guessedtype": "function"}, "_preventScroll": {"protected": "", "description": "Prevents the viewport from scolling when the user presses \nthe up, down, left, or right key.", "guessedname": "_preventScroll", "guessedtype": "function"}, "_focusPrevious": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}, {"type": "Number", "name": "activeDescendant", "description": " Number representing the index of the \nnext descendant to be focused."}], "description": "Keydown event handler that moves focus to the previous \nenabled descendant.", "guessedname": "_focusPrevious", "guessedtype": "function"}, "_onDocFocus": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"focus\" event handler for the owner document of the \nFocus Manager's Node.", "guessedname": "_onDocFocus", "guessedtype": "function"}, "_initDescendants": {"protected": "", "description": "Sets the tabIndex attribute of all of the \ndescendants to -1, except the active descendant, whose \ntabIndex attribute is set to 0.", "guessedname": "_initDescendants", "guessedtype": "function"}, "_afterActiveDescendantChange": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the change event."}], "description": "afterChange event handler for the \n\"activeDescendant\" attribute.", "guessedname": "_afterActiveDescendantChange", "guessedtype": "function"}, "_focusNext": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}, {"type": "Number", "name": "activeDescendant", "description": " Number representing the index of the \nnext descendant to be focused"}], "description": "Keydown event handler that moves focus to the next \nenabled descendant.", "guessedname": "_focusNext", "guessedtype": "function"}, "blur": {"description": "Blurs the current active descendant and sets the \nfocused attribute to false.", "guessedname": "blur", "guessedtype": "function"}, "stop": {"description": "Disables the Focus Manager by detaching all event handlers.", "guessedname": "stop", "guessedtype": "function"}, "focus": {"params": [{"type": "Number", "name": "index", "description": " Optional. Number representing the index of the \ndescendant to be set as the active descendant."}, {"type": "Node", "name": "index", "description": " Optional. Node instance representing the \ndescendant to be set as the active descendant."}], "description": "Focuses the active descendant and sets the \nfocused attribute to true.", "guessedname": "focus", "guessedtype": "function"}, "refresh": {"description": "Refreshes the Focus Manager's descendants by re-executing the \nCSS selector query specified by the descendants attribute.", "guessedname": "refresh", "guessedtype": "function"}, "start": {"description": "Enables the Focus Manager.", "guessedname": "start", "guessedtype": "function"}, "_removeFocusClass": {"protected": "", "description": "Removes the class name representing focus (as specified by \nthe \"focusClass\" attribute) from the Node instance to which it is \ncurrently applied.", "guessedname": "_removeFocusClass", "guessedtype": "function"}, "_isDescendant": {"return": {"type": "Boolean", "description": "Boolean indicating if the specified Node instance is a \ndescendant managed by the Focus Manager."}, "description": "Determines if the specified Node instance is a descendant\nmanaged by the Focus Manager.", "protected": "", "params": [{"type": "Node", "name": "node", "description": " Node instance to be checked."}], "guessedname": "_isDescendant", "guessedtype": "function"}, "_detachKeyHandler": {"protected": "", "description": "Detaches the \"key\" event handlers used to support the \"keys\"\nattribute.", "guessedname": "_detachKeyHandler", "guessedtype": "function"}, "_attachKeyHandler": {"protected": "", "description": "Attaches the \"key\" event handlers used to support the \"keys\"\nattribute.", "guessedname": "_attachKeyHandler", "guessedtype": "function"}}, "file": "node-focusmanager.js", "guessedtype": "function", "shortname": "NodeFocusManager", "configs": {"descendants": {"type": "Y.NodeList", "description": "String representing the CSS selector used to define the descendant Nodes \nwhose focus should be managed.", "guessedname": "descendants", "guessedtype": "property"}, "keys": {"type": "Object", "description": "Object literal representing the keys to be used to navigate between the \nnext/previous descendant. The format for the attribute's value is \n{ next: \"down:40\", previous: \"down:38\" }. The value for the \n\"next\" and \"previous\" properties are used to attach \nkey event listeners. See \nthe Using the key Event section of \nthe Event documentation for more information on \"key\" event listeners.", "guessedname": "keys", "guessedtype": "property"}, "focusClass": {"type": "String|Object", "description": "String representing the name of class applied to the focused active \ndescendant Node. Can also be an object literal used to define both the \nclass name, and the Node to which the class should be applied. If using \nan object literal, the format is:\n{ className: \"focus\", fn: myFunction }. The function \nreferenced by the fn property in the object literal will be\npassed a reference to the currently focused active descendant Node.", "guessedname": "focusClass", "guessedtype": "property"}, "focused": {"description": "Boolean indicating that one of the descendants is focused.", "default": "false", "readonly": "", "guessedname": "focused", "guessedtype": "property", "type": "boolean"}, "activeDescendant": {"type": "Number", "description": "
Node, or index of the Node, representing the descendant that is either \nfocused or is focusable (tabIndex attribute is set to 0). \nThe value cannot represent a disabled descendant Node. Use a value of -1\nto remove all descendant Nodes from the default tab flow.\nIf no value is specified, the active descendant will be inferred using \nthe following criteria:
\n\n
Examining the tabIndex attribute of each descendant and \nusing the first descendant whose tabIndex attribute is set \nto 0
\n
If no default can be inferred then the value is set to either 0 or \nthe index of the first enabled descendant.
\n", "guessedname": "activeDescendant", "guessedtype": "property"}, "circular": {"type": "Boolean", "description": "Boolean indicating if focus should be set to the first/last descendant \nwhen the end or beginning of the descendants has been reached.", "guessedname": "circular", "guessedtype": "property"}}, "description": "The NodeFocusManager class is a plugin for a Node instance. The class is used \nvia the plug method of Node \nand should not be instantiated directly."}, "Assert.ComparisonFailure": {"name": "Assert.ComparisonFailure", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}, {"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value that caused the assertion to fail."}], "description": "ComparisonFailure is subclass of Error that is thrown whenever\na comparison between two values fails. It provides mechanisms to retrieve\nboth the expected and actual value."}], "namespace": "Assert", "module": "test", "guessedname": "ComparisonFailure", "methods": {"toString": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. This message\nprovides information about the expected and actual values.", "guessedname": "getMessage", "guessedtype": "function"}}, "extends": "Assert.Error", "superclass": "Assert.Error", "file": "Assert.js", "guessedtype": "function", "shortname": "ComparisonFailure", "properties": {"expected": {"type": "Object", "description": "The expected value.", "guessedname": "expected", "guessedtype": "property"}, "actual": {"type": "Object", "description": "The actual value.", "guessedname": "actual", "guessedtype": "property"}, "name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}}, "description": "ComparisonFailure is subclass of Error that is thrown whenever\na comparison between two values fails. It provides mechanisms to retrieve\nboth the expected and actual value."}, "DataSchema.XML": {"name": "DataSchema.XML", "namespace": "", "module": "dataschema", "guessedname": "SchemaXML", "methods": {"apply": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Applies a given schema to given XML data.", "static": "", "guessedname": "apply", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to apply."}, {"type": "XMLDoc", "name": "data", "description": " XML document."}]}, "_getLocationValue": {"return": {"type": "Object", "description": "Data value or null."}, "description": "Get an XPath-specified value for a given field from an XML node or document.", "protected": "", "static": "", "guessedname": "_getLocationValue", "guessedtype": "function", "params": [{"type": "String | Object", "name": "field", "description": " Field definition."}, {"type": "Object", "name": "context", "description": " XML node or document to search within."}]}, "_parseResults": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Schema-parsed list of results from full data", "protected": "", "static": "", "guessedname": "_parseResults", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to parse against."}, {"type": "Object", "name": "xmldoc_in", "description": " XML document parse."}, {"type": "Object", "name": "data_out", "description": " In-progress schema-parsed data to update."}]}, "_parseMeta": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Parses results data according to schema", "protected": "", "static": "", "guessedname": "_parseMeta", "guessedtype": "function", "params": [{"type": "Object", "name": "xmldoc_in", "description": " XML document parse."}, {"type": "Object", "name": "data_out", "description": " In-progress schema-parsed data to update."}]}}, "static": "", "superclass": "DataSchema.Base", "file": "dataschema-xml.js", "guessedtype": "property", "extends": "DataSchema.Base", "shortname": "DataSchema.XML", "description": "XML subclass for the DataSchema Utility."}, "YUI~dump": {"name": "YUI~dump", "namespace": "", "module": "dump", "methods": {"dump": {"return": {"type": "string", "description": "the dump result"}, "description": "Returns a simple string representation of the object or array.\nOther types of objects will be returned unprocessed. Arrays\nare expected to be indexed. Use object notation for\nassociative arrays.", "params": [{"type": "object", "name": "o", "description": " The object to dump"}, {"type": "int", "name": "d", "description": " How deep to recurse child objects, default 3"}], "guessedname": "dump", "guessedtype": "function", "todo": "dumping a window is causing an unhandled exception in\nFireFox.\nThis method is in the 'dump' module, which is not bundled with\nthe core YUI object"}}, "file": "dump.js", "shortname": "YUI~dump", "description": "The following methods are added to the YUI instance"}, "WidgetPosition": {"name": "WidgetPosition", "namespace": "", "module": "widget-position", "events": {"yChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "yChange", "description": "Fires when the value for the configuration attribute 'y' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "xyChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "xyChange", "description": "Fires when the value for the configuration attribute 'xy' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "xChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "xChange", "description": "Fires when the value for the configuration attribute 'x' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"y": {"default": "0", "type": "number", "description": "Page Y co-ordinate for the widget. This attribute acts as a facade for the \nxy attribute. Changes in position can be monitored by listening for xyChange events.", "guessedname": "y", "guessedtype": "property"}, "x": {"default": "0", "type": "number", "description": "Page X co-ordinate for the widget. This attribute acts as a facade for the \nxy attribute. Changes in position can be monitored by listening for xyChange events.", "guessedname": "x", "guessedtype": "property"}, "xy": {"default": "[0,0]", "type": "Array", "description": "Page XY co-ordinate pair for the widget.", "guessedname": "xy", "guessedtype": "property"}}, "methods": {"_getX": {"return": {"type": "Number", "description": "The X page co-ordinate value"}, "description": "Default getter for the X attribute. The value is retrieved from \nthe XY attribute, which is the sole store for the XY state.", "guessedname": "_getX", "guessedtype": "function"}, "_validateXY": {"return": {"type": "boolean", "description": "true if valid, false if not."}, "params": [{"type": "Array", "name": "val", "description": " The XY page co-ordinate value which is being set."}], "description": "Default validator for the XY attribute", "guessedname": "_validateXY", "guessedtype": "function"}, "_setX": {"params": [{"type": "Number", "name": "val", "description": " The X page co-ordinate value"}], "description": "Default setter for the X attribute. The setter passes the X value through\nto the XY attribute, which is the sole store for the XY state.", "guessedname": "_setX", "guessedtype": "function"}, "_uiSetXY": {"protected": "", "params": [{"type": "String", "name": "val", "description": " The XY page co-ordinates value to be reflected in the UI"}], "description": "Updates the UI to reflect the XY page co-ordinates passed in.", "guessedname": "_uiSetXY", "guessedtype": "function"}, "move": {"params": [{"type": "Number", "name": "x", "description": " The new x position"}, {"type": "Number", "name": "y", "description": " The new y position\n
Or
"}, {"type": "Array", "name": "x,", "description": " y values passed as an array ([x, y]), to support\nsimple pass through of Node.getXY results"}], "description": "Moves the Widget to the specified page xy co-ordinate position.", "guessedname": "move", "guessedtype": "function"}, "_syncUIPosition": {"protected": "", "description": "Synchronizes the UI to match the Widgets xy page position state.\n
\nThis method in invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_syncUIPosition", "guessedtype": "function"}, "_getY": {"return": {"type": "Number", "description": "The Y page co-ordinate value"}, "description": "Default getter for the Y attribute. The value is retrieved from \nthe XY attribute, which is the sole store for the XY state.", "guessedname": "_getY", "guessedtype": "function"}, "syncXY": {"description": "Synchronizes the Panel's \"xy\", \"x\", and \"y\" properties with the \nWidget's position in the DOM.", "guessedname": "syncXY", "guessedtype": "function"}, "_setY": {"params": [{"type": "Number", "name": "val", "description": " The Y page co-ordinate value"}], "description": "Default setter for the Y attribute. The setter passes the Y value through\nto the XY attribute, which is the sole store for the XY state.", "guessedname": "_setY", "guessedtype": "function"}, "_afterXYChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the xy attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterXYChange", "guessedtype": "function"}, "_renderUIPosition": {"protected": "", "description": "Creates/Initializes the DOM to support xy page positioning.\n
\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_renderUIPosition", "guessedtype": "function"}, "_bindUIPosition": {"protected": "", "description": "Binds event listeners responsible for updating the UI state in response to \nWidget position related state changes.\n
\nThis method in invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_bindUIPosition", "guessedtype": "function"}}, "param": "{Object} config User configuration object", "file": "Widget-Position.js", "shortname": "WidgetPosition", "properties": {"WidgetPosition.POSITIONED_CLASS_NAME": {"description": "Default class used to mark the boundingBox of a positioned widget.", "default": "\"yui-widget-positioned\"", "static": "", "guessedname": "POSITIONED_CLASS_NAME", "guessedtype": "property", "type": "String"}, "WidgetPosition.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute \nconfiguration introduced by WidgetPosition.", "guessedname": "ATTRS", "guessedtype": "property"}}, "description": "Widget extension, which can be used to add positioning support to the base Widget class, \nthrough the Base.build method."}, "Do.Prevent": {"name": "Do.Prevent", "namespace": "", "module": "event-custom", "guessedname": "Prevent", "file": "event-do.js", "guessedtype": "function", "shortname": "Do.Prevent", "description": "Return a Prevent object when you want to prevent the wrapped function\nfrom executing, but want the remaining listeners to execute"}, "State": {"name": "State", "constructors": [{"description": "The State class maintains state for a collection of named items, with \na varying number of properties defined.\nIt avoids the need to create a separate class for the item, and separate instances \nof these classes for each item, by storing the state in a 2 level hash table, \nimproving performance when the number of items is likely to be large."}], "namespace": "", "module": "attribute", "guessedname": "State", "methods": {"addAll": {"params": [{"type": "String", "name": "name", "description": " The name of the item."}, {"type": "Object", "name": "o", "description": " A hash of property/value pairs."}], "description": "Adds multiple properties to an item.", "guessedname": "addAll", "guessedtype": "function"}, "get": {"return": {"type": "Any", "description": "The value of the supplied property."}, "params": [{"type": "String", "name": "name", "description": " The name of the item"}, {"type": "String", "name": "key", "description": " Optional. The property value to retrieve."}], "description": "For a given item, returns the value of the property requested, or undefined if not found.", "guessedname": "get", "guessedtype": "function"}, "getAll": {"return": {"type": "Object", "description": "An object with property/value pairs for the item."}, "params": [{"type": "String", "name": "name", "description": " The name of the item"}], "description": "For the given item, returns a disposable object with all of the\nitem's property/value pairs.", "guessedname": "getAll", "guessedtype": "function"}, "remove": {"params": [{"type": "String", "name": "name", "description": " The name of the item."}, {"type": "String", "name": "key", "description": " The property to remove."}], "description": "Removes a property from an item.", "guessedname": "remove", "guessedtype": "function"}, "removeAll": {"params": [{"type": "String", "name": "name", "description": " The name of the item."}, {"type": "Object|Array", "name": "o", "description": " Collection of properties to delete. If not provided, the entire item is removed."}], "description": "Removes multiple properties from an item, or remove the item completely.", "guessedname": "removeAll", "guessedtype": "function"}, "add": {"params": [{"type": "String", "name": "name", "description": " The name of the item."}, {"type": "String", "name": "key", "description": " The name of the property."}, {"type": "Any", "name": "val", "description": " The value of the property."}], "description": "Adds a property to an item.", "guessedname": "add", "guessedtype": "function"}}, "file": "State.js", "guessedtype": "function", "shortname": "State", "properties": {"data": {"description": "Hash of attributes", "guessedname": "data", "guessedtype": "property"}}, "description": "The State class maintains state for a collection of named items, with \na varying number of properties defined.\nIt avoids the need to create a separate class for the item, and separate instances \nof these classes for each item, by storing the state in a 2 level hash table, \nimproving performance when the number of items is likely to be large."}, "CustomEvent": {"name": "CustomEvent", "description": "The CustomEvent class lets you define events for your application\nthat can be subscribed to by one or more independent component.", "constructors": [{"params": [{"type": "String", "name": "type", "description": " The type of event, which is passed to the callback\nwhen the event fires"}, {"type": "", "name": "o", "description": " configuration object"}], "description": "The CustomEvent class lets you define events for your application\nthat can be subscribed to by one or more independent component."}], "namespace": "", "module": "event-custom", "guessedname": "CustomEvent", "file": "event-custom.js", "guessedtype": "function", "shortname": "CustomEvent", "properties": {"queuable": {"default": "false", "type": "boolean", "description": "Specifies whether this event should be queued when the host is actively\nprocessing an event. This will effect exectution order of the callbacks\nfor the various events."}, "silent": {"type": "boolean", "description": "By default all custom events are logged in the debug build, set silent\nto true to disable debug outpu for this event.", "guessedname": "silent", "guessedtype": "property"}, "defaultFn": {"type": "Function", "description": "The default function to execute after event listeners\nhave fire, but only if the default action was not\nprevented."}, "fireOnce": {"default": "false;", "type": "boolean", "description": "This event should only fire one time if true, and if\nit has fired, any new subscribers should be notified\nimmediately."}, "prevented": {"type": "int", "description": "Flag for preventDefault that is modified during fire().\nif it is not 0, the default behavior for this event"}, "preventedFn": {"type": "Function", "description": "The function to execute if a subscriber calls\npreventDefault"}, "subscribers": {"type": "Subscriber{}", "description": "The subscribers to this event", "guessedname": "subscribers", "guessedtype": "property"}, "emitFacade": {"default": "false", "type": "boolean", "description": "If set to true, the custom event will deliver an EventFacade object\nthat is similar to a DOM event object."}, "broadcast": {"type": "int", "description": "If 0, this event does not broadcast. If 1, the YUI instance is notified\nevery time this event fires. If 2, the YUI instance and the YUI global\n(if event is enabled on the global) are notified every time this event\nfires."}, "firedWith": {"type": "Array", "description": "An array containing the arguments the custom event\nwas last fired with."}, "host": {"type": "EventTarget", "description": "Specifies the host for this custom event. This is used\nto enable event bubbling"}, "stopped": {"type": "int", "description": "Flag for stopPropagation that is modified during fire()\n1 means to stop propagation to bubble targets. 2 means\nto also stop additional subscribers on this target."}, "context": {"type": "object", "description": "The context the the event will fire from by default. Defaults to the YUI\ninstance.", "guessedname": "context", "guessedtype": "property"}, "signature": {"default": "9", "type": "int", "description": "Supports multiple options for listener signatures in order to\nport YUI 2 apps.", "guessedname": "signature", "guessedtype": "property"}, "preventable": {"default": "true", "type": "boolean", "description": "Specifies whether or not this event's default function\ncan be cancelled by a subscriber by executing preventDefault() \non the event facade", "guessedname": "preventable", "guessedtype": "property"}, "stoppedFn": {"type": "Function", "description": "The function to execute if a subscriber calls\nstopPropagation or stopImmediatePropagation"}, "fired": {"default": "false;", "type": "boolean", "description": "This event has fired if true"}, "type": {"type": "string", "description": "The type of event, returned to subscribers when the event fires", "guessedname": "type", "guessedtype": "property"}, "bubbles": {"default": "true", "type": "boolean", "description": "Specifies whether or not a subscriber can stop the event propagation\nvia stopPropagation(), stopImmediatePropagation(), or halt()", "guessedname": "bubbles", "guessedtype": "property"}, "afters": {"type": "Subscriber{}", "description": "'After' subscribers", "guessedname": "afters", "guessedtype": "property"}}, "methods": {"on": {"return": {"type": "EventHandle|EventTarget", "description": "unsubscribe handle or a\nchainable event target depending on the 'chain' config."}, "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}], "description": "Listen for this event", "guessedname": "on", "guessedtype": "function"}, "preventDefault": {"description": "Prevents the execution of this event's defaultFn", "guessedname": "preventDefault", "guessedtype": "function"}, "halt": {"params": [{"type": "boolean", "name": "immediate", "description": " if true additional listeners\non the current target will not be executed"}], "description": "Stops the event propagation and prevents the default\nevent behavior.", "guessedname": "halt", "guessedtype": "function"}, "_delete": {"params": [{"type": "", "name": "subscriber", "description": " object"}], "private": "", "guessedname": "_delete", "guessedtype": "function"}, "fire": {"return": {"type": "boolean", "description": "false if one of the subscribers returned false, \ntrue otherwise"}, "params": [{"type": "Object*", "name": "arguments", "description": " an arbitrary set of parameters to pass to \nthe handler."}], "description": "Notifies the subscribers. The callback functions will be executed\nfrom the context specified when the event was created, and with the \nfollowing parameters:\n
\n
The type of event
\n
All of the arguments fire() was executed with as an array
\n
The custom object (if any) that was passed into the subscribe() \nmethod
\n
", "guessedname": "fire", "guessedtype": "function"}, "unsubscribeAll": {"deprecated": "use detachAll", "return": {"type": "int", "description": "The number of listeners unsubscribed"}, "description": "Removes all listeners", "guessedname": "unsubscribeAll", "guessedtype": "function"}, "stopImmediatePropagation": {"description": "Stops propagation to bubble targets, and prevents any remaining\nsubscribers on the current target from executing.", "guessedname": "stopImmediatePropagation", "guessedtype": "function"}, "applyConfig": {"params": [{"type": "", "name": "o", "description": " hash of properties to apply"}, {"type": "boolean", "name": "force", "description": " if true, properties that exist on the event \nwill be overwritten."}], "description": "Apply configuration properties. Only applies the CONFIG whitelist", "guessedname": "applyConfig", "guessedtype": "function"}, "detachAll": {"return": {"type": "int", "description": "The number of listeners unsubscribed"}, "description": "Removes all listeners", "guessedname": "detachAll", "guessedtype": "function"}, "_notify": {"guessedname": "_notify", "params": [{"type": "Subscriber", "name": "s", "description": " the subscriber"}, {"type": "Array", "name": "args", "description": " the arguments array to apply to the listener"}], "description": "Notify a single subscriber", "private": "", "guessedtype": "function"}, "subscribe": {"return": {"type": "EventHandle|EventTarget", "description": "unsubscribe handle or a\nchainable event target depending on the 'chain' config."}, "description": "Listen for this event", "deprecated": "use on", "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}], "guessedname": "subscribe", "guessedtype": "function"}, "unsubscribe": {"return": {"type": "boolean|EventTarget", "description": "returns a chainable event target\nor a boolean for legacy detach support."}, "description": "Detach listeners.", "deprecated": "use detach", "params": [{"type": "Function", "name": "fn", "description": " The subscribed function to remove, if not supplied\nall will be removed"}, {"type": "Object", "name": "context", "description": " The context object passed to subscribe."}], "guessedname": "unsubscribe", "guessedtype": "function"}, "detach": {"return": {"type": "int|EventTarget", "description": "returns a chainable event target\nor the number of subscribers unsubscribed."}, "params": [{"type": "Function", "name": "fn", "description": " The subscribed function to remove, if not supplied\nall will be removed"}, {"type": "Object", "name": "context", "description": " The context object passed to subscribe."}], "description": "Detach listeners.", "guessedname": "detach", "guessedtype": "function"}, "stopPropagation": {"description": "Stop propagation to bubble targets", "guessedname": "stopPropagation", "guessedtype": "function"}, "after": {"return": {"type": "EventHandle|EventTarget", "description": "unsubscribe handle or a\nchainable event target depending on the 'chain' config."}, "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}], "description": "Listen for this event after the normal subscribers have been notified and\nthe default behavior has been applied. If a normal subscriber prevents the \ndefault behavior, it also prevents after listeners from firing.", "guessedname": "after", "guessedtype": "function"}, "log": {"params": [{"type": "string", "name": "msg", "description": " message to log"}, {"type": "string", "name": "cat", "description": " log category"}], "description": "Logger abstraction to centralize the application of the silent flag", "guessedname": "log", "guessedtype": "function"}}}, "Plugin.Drop": {"name": "Plugin.Drop", "constructors": [{"description": "This is a simple Drop plugin that can be attached to a Node via the plug method."}], "namespace": "Plugin", "module": "dd", "guessedname": "Drop", "extends": "DD.Drop", "superclass": "DD.Drop", "file": "dd-drop-plugin.js", "guessedtype": "function", "shortname": "Drop", "properties": {"NS": {"type": "{String}", "description": "The Drop instance will be placed on the Node instance under the drop namespace. It can be accessed via Node.drop;", "guessedname": "NS", "guessedtype": "property"}, "NAME": {"type": "{String}", "description": "dd-drop-plugin", "guessedname": "NAME", "guessedtype": "property"}}, "description": "This is a simple Drop plugin that can be attached to a Node via the plug method."}, "DataSource.Get": {"name": "DataSource.Get", "configs": {"scriptCallbackParam": {"default": "\"callback\"", "type": "String", "description": "Callback string parameter name sent to the remote script. By default,\nrequests are sent to\n<URI>?<scriptCallbackParam>=callbackFunction", "guessedname": "scriptCallbackParam", "guessedtype": "property"}, "asyncMode": {"default": "\"allowAll\"", "type": "String", "description": "Defines request/response management in the following manner:\n
\n\n
ignoreStaleResponses
\n
Send all requests, but handle only the response for the most recently sent request.
\n
allowAll
\n
Send all requests and handle all responses.
\n
", "guessedname": "asyncMode", "guessedtype": "property"}, "generateRequestCallback": {"type": "Function", "description": "Accepts the DataSource instance and a callback ID, and returns a callback\nparam/value string that gets appended to the script URI. Implementers\ncan customize this string to match their server's query syntax.", "guessedname": "generateRequestCallback", "guessedtype": "property"}, "get": {"default": "Y.Get", "type": "Y.Get", "description": "Pointer to Get Utility.", "guessedname": "get", "guessedtype": "property"}}, "constructors": [{"description": "Get Utility subclass for the DataSource Utility."}], "namespace": "", "module": "datasource", "events": {"generateRequestCallbackChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "generateRequestCallbackChange", "description": "Fires when the value for the configuration attribute 'generateRequestCallback' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "scriptCallbackParamChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "scriptCallbackParamChange", "description": "Fires when the value for the configuration attribute 'scriptCallbackParam' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "getChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "getChange", "description": "Fires when the value for the configuration attribute 'get' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "asyncModeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "asyncModeChange", "description": "Fires when the value for the configuration attribute 'asyncMode' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "DSGet", "methods": {"_defRequestFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
cfg (Object)
Configuration object.
\n
"}], "description": "Passes query string to Get Utility. Fires response event when\nresponse is received asynchronously.", "guessedname": "_defRequestFn", "guessedtype": "function"}}, "extends": "DataSource.Local", "superclass": "DataSource.Local", "file": "datasource-get.js", "guessedtype": "function", "shortname": "DataSource.Get", "properties": {"callbacks": {"type": "Function[]", "static": "", "description": "Global array of callback functions, one for each request sent.", "guessedname": "callbacks", "guessedtype": "property"}, "NAME": {"description": "Class name.", "value": "\"dataSourceGet\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}, "_tId": {"description": "Unique ID to track requests.", "private": "", "static": "", "guessedname": "_tId", "guessedtype": "property", "type": "Number"}}, "description": "Get Utility subclass for the DataSource Utility."}, "Selector": {"name": "Selector", "for": "Selector", "namespace": "", "module": "dom", "methods": {"_tokenize": {"description": "Break selector into token units per simple selector.\nCombinator is attached to the previous token.", "guessedname": "_tokenize", "guessedtype": "function"}, "viewportRegion": {"return": {"type": "Object", "description": "Object literal containing the following about the visible region of the viewport: (top, right, bottom, left)"}, "description": "Returns an Object literal containing the following about the visible region of viewport: (top, right, bottom, left)", "guessedname": "viewportRegion", "guessedtype": "function"}, "region": {"return": {"type": "Object", "description": "Object literal containing the following about this element: (top, right, bottom, left)"}, "params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}], "description": "Returns an Object literal containing the following about this element: (top, right, bottom, left)", "guessedname": "region", "guessedtype": "function"}, "inRegion": {"return": {"type": "Boolean", "description": "True if in region, false if not."}, "params": [{"type": "Object} node2 The node to get the region from or an Object literal of the region\n$param {Boolean", "name": "all", "description": " Should all of the node be inside the region"}, {"type": "Object", "name": "altRegion", "description": " An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)"}], "description": "Check if any part of this node is in the passed region", "guessedname": "inRegion", "guessedtype": "function"}, "intersect": {"return": {"type": "Object", "description": "Object literal containing the following intersection data: (top, right, bottom, left, area, yoff, xoff, inRegion)"}, "params": [{"type": "HTMLElement", "name": "element", "description": " The first element"}, {"type": "HTMLElement | Object", "name": "element2", "description": " The element or region to check the interect with"}, {"type": "Object", "name": "altRegion", "description": " An object literal containing the region for the first element if we already have the data (for performance i.e. DragDrop)"}], "description": "Find the intersect information for the passes nodes.", "guessedname": "intersect", "guessedtype": "function"}, "query": {"return": {"type": "Array", "description": "An array of nodes that match the given selector."}, "description": "Retrieves a set of nodes based on a given CSS selector.", "static": "", "guessedname": "query", "guessedtype": "function", "params": [{"type": "string", "name": "selector", "description": " The CSS Selector to test the node against."}, {"type": "HTMLElement", "name": "root", "description": " optional An HTMLElement to start the query from. Defaults to Y.config.doc"}, {"type": "Boolean", "name": "firstOnly", "description": " optional Whether or not to return only the first match."}]}, "inViewportRegion": {"return": {"type": "Boolean", "description": "True if in region, false if not."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "Boolean", "name": "all", "description": " Should all of the node be inside the region"}, {"type": "Object", "name": "altRegion", "description": " An object literal containing the region for this node if we already have the data (for performance i.e. DragDrop)"}], "description": "Check if any part of this element is in the viewport", "guessedname": "inViewportRegion", "guessedtype": "function"}}, "static": "", "file": "selector-native.js", "shortname": "Selector", "properties": {"shorthand": {"type": "object", "description": "Mapping of shorthand tokens to corresponding attribute selector", "guessedname": "shorthand", "guessedtype": "property"}, "operators": {"type": "object", "description": "List of operators and corresponding boolean functions. \nThese functions are passed the attribute and the current node's value of the attribute.", "guessedname": "operators", "guessedtype": "property"}, "PARENT_NODE": {"description": "Provides helper methods for collecting and filtering DOM elements.", "guessedname": "PARENT_NODE", "guessedtype": "property"}}, "description": "Provides support for using CSS selectors to query the DOM"}, "DataSourceXMLSchema": {"name": "DataSourceXMLSchema", "namespace": "", "module": "datasource", "guessedname": "DataSourceXMLSchema", "methods": {"_beforeDefDataFn\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
data (Object)
Raw data.
\n
": {"protected": "", "description": "Parses raw data into a normalized response.", "guessedname": "_beforeDefDataFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}}, "extends": "Plugin.Base", "superclass": "Plugin.Base", "file": "datasource-xmlschema.js", "guessedtype": "function", "shortname": "DataSourceXMLSchema", "properties": {"NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"schema\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"dataSourceXMLSchema\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Adds schema-parsing to the DataSource Utility."}, "DD.Drop": {"name": "DD.Drop", "configs": {"node": {"type": "Node", "description": "Y.Node instanace to use as the element to make a Drop Target", "guessedname": "node", "guessedtype": "property"}, "padding": {"type": "String", "description": "CSS style padding to make the Drop Target bigger than the node.", "guessedname": "padding", "guessedtype": "property"}, "bubbles": {"type": "Object", "description": "Controls the default bubble parent for this Drop instance. Default: Y.DD.DDM. Set to false to disable bubbling.", "guessedname": "bubbles", "guessedtype": "property"}, "groups": {"type": "Array", "description": "Array of groups to add this drop into.", "guessedname": "groups", "guessedtype": "property"}, "lock": {"type": "Boolean", "description": "Set to lock this drop element.", "guessedname": "lock", "guessedtype": "property"}}, "constructors": [{"description": "This class provides the ability to create a Drop Target."}], "namespace": "DD", "module": "dd", "properties": {"_groups": {"guessedname": "_groups", "type": "Array", "description": "The groups this target belongs to.", "private": "", "guessedtype": "property"}, "region": {"type": "Object", "description": "A region object associated with this target, used for checking regions while dragging.", "guessedname": "region", "guessedtype": "property"}, "overTarget": {"type": "Boolean", "description": "This flag is tripped when a drag element is over this target.", "guessedname": "overTarget", "guessedtype": "property"}, "_valid": {"guessedname": "_valid", "type": "Boolean", "description": "Flag for determining if the target is valid in this operation.", "private": "", "guessedtype": "property"}, "shim": {"type": "{Object}", "description": "Node reference to the targets shim", "guessedname": "shim", "guessedtype": "property"}}, "guessedname": "NODE", "methods": {"_createEvents": {"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.", "private": "", "guessedname": "_createEvents", "guessedtype": "function"}, "_handleOverTarget": {"description": "This handles the over target call made from this object or from the DDM", "private": "", "guessedname": "_handleTargetOver", "guessedtype": "function"}, "_handleOverEvent": {"description": "Handles the mouseover DOM event on the Target Shim", "private": "", "guessedname": "_handleOverEvent", "guessedtype": "function"}, "sizeShim": {"description": "Positions and sizes the shim with the raw data from the node, this can be used to programatically adjust the Targets shim for Animation..", "guessedname": "sizeShim", "guessedtype": "function"}, "destructor": {"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners", "private": "", "guessedname": "destructor", "guessedtype": "function"}, "_handleOutEvent": {"description": "Handles the mouseout DOM event on the Target Shim", "private": "", "guessedname": "_handleOutEvent", "guessedtype": "function"}, "_createShim": {"description": "Creates the Target shim and adds it to the DDM's playground..", "private": "", "guessedname": "_createShim", "guessedtype": "function"}, "inGroup": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "Array", "name": "groups", "description": " The groups to check against"}], "description": "Check if this target is in one of the supplied groups.", "guessedname": "inGroup", "guessedtype": "function"}, "_activateShim": {"description": "Activates the shim and adds some interaction CSS classes", "private": "", "guessedname": "_activateShim", "guessedtype": "function"}, "_deactivateShim": {"description": "Removes classes from the target, resets some flags and sets the shims deactive position [-999, -999]", "private": "", "guessedname": "_deactivateShim", "guessedtype": "function"}, "initializer": {"description": "Private lifecycle method", "private": "", "guessedname": "initializer", "guessedtype": "function"}, "_handleOut": {"description": "Handles out of target calls/checks", "private": "", "guessedname": "_handleOut", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "drop.js", "guessedtype": "property", "shortname": "Drop", "events": {"paddingChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "paddingChange", "description": "Fires when the value for the configuration attribute 'padding' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "groupsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "groupsChange", "description": "Fires when the value for the configuration attribute 'groups' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drop:enter": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when a drag element enters this target.", "guessedname": "EV_DROP_ENTER", "guessedtype": "property"}, "bubblesChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "bubblesChange", "description": "Fires when the value for the configuration attribute 'bubbles' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drop:over": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when a drag element is over this target.", "guessedname": "EV_DROP_OVER", "guessedtype": "property"}, "nodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "nodeChange", "description": "Fires when the value for the configuration attribute 'node' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drop:hit": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when a draggable node is dropped on this Drop Target. (Fired from dd-ddm-drop)", "guessedname": "Drop", "guessedtype": "function"}, "lockChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "lockChange", "description": "Fires when the value for the configuration attribute 'lock' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drop:exit": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when a drag element exits this target.", "guessedname": "EV_DROP_EXIT", "guessedtype": "property"}}, "description": "This class provides the ability to create a Drop Target."}, "DataType.Number": {"name": "DataType.Number", "description": "DataType.Number provides a set of utility functions to operate against Number objects.", "namespace": "", "module": "datatype", "guessedname": "LANG", "static": "", "file": "datatype-number-format.js", "guessedtype": "property", "shortname": "DataType.Number", "methods": {"parse": {"return": {"type": "Number", "description": "A number, or null."}, "params": [{"type": "String | Number | Boolean", "name": "data", "description": " Data to convert. The following\nvalues return as null: null, undefined, NaN, \"\"."}], "description": "Converts data to type Number.", "guessedname": "parse", "guessedtype": "function"}, "format": {"return": {"type": "String", "description": "Formatted number for display. Note, the following values\nreturn as \"\": null, undefined, NaN, \"\"."}, "params": [{"type": "Number", "name": "data", "description": " Number."}, {"type": "Object} (Optional) Optional configuration values:\n
\n
prefix {String}\n
String prepended before each number, like a currency designator \"$\"
\n
decimalPlaces {Number}\n
Number of decimal places to round. Must be a number 0 to 20.
String appended after each number, like \" items\" (note the space)
\n
"}], "description": "Takes a Number and formats to string for display to user.", "guessedname": "format", "guessedtype": "function"}}}, "DataSourceArraySchema": {"name": "DataSourceArraySchema", "namespace": "", "module": "datasource", "guessedname": "DataSourceArraySchema", "methods": {"_beforeDefDataFn\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
data (Object)
Raw data.
\n
": {"protected": "", "description": "Parses raw data into a normalized response.", "guessedname": "_beforeDefDataFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}}, "extends": "Plugin.Base", "superclass": "Plugin.Base", "file": "datasource-arrayschema.js", "guessedtype": "function", "shortname": "DataSourceArraySchema", "properties": {"NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"schema\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"dataSourceArraySchema\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Adds schema-parsing to the DataSource Utility."}, "Profiler": {"name": "Profiler", "namespace": "", "module": "profiler", "guessedname": "Profiler", "methods": {"getFunctionReport": {"return": {"type": "Object", "description": "An object containing profile data for a given function."}, "description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).", "deprecated": "Use getReport() instead.", "static": "", "guessedname": "getFunctionReport", "guessedtype": "function"}, "pause": {"return": {"type": "Void", "description": ""}, "description": "Pauses profiling information for a given name.", "static": "", "guessedname": "pause", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the data point."}]}, "getReport": {"static": "", "return": {"type": "Object", "description": "An object containing profile data for a given function."}, "description": "Returns an object containing profiling data for a single function.\nThe object has an entry for min, max, avg, calls, and points).", "guessedname": "getReport", "guessedtype": "function"}, "start": {"return": {"type": "Void", "description": ""}, "description": "Start profiling information for a given name. The name cannot be the name\nof a registered function or object. This is used to start timing for a\nparticular block of code rather than instrumenting the entire function.", "static": "", "guessedname": "start", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the data point."}]}, "getFullReport": {"static": "", "return": {"type": "Object", "description": "An object containing all profile data."}, "description": "Returns an object containing profiling data for all of the functions \nthat were profiled. The object has an entry for each function and \nreturns all information (min, max, average, calls, etc.) for each\nfunction.", "guessedname": "getFullReport", "guessedtype": "function"}, "unregisterFunction": {"return": {"type": "Void", "description": ""}, "description": "Removes a constructor function from profiling. Reverses the registerConstructor() method.", "param": "{String} name The full name of the function including namespacing. This\nis the name of the function that is stored in the report.", "static": "", "guessedname": "unregisterConstructor", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The full name of the function including namespacing. This\nis the name of the function that is stored in the report."}]}, "clear": {"return": {"type": "Void", "description": ""}, "description": "Removes all report data from the profiler.", "static": "", "guessedname": "clear", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " (Optional) The name of the report to clear. If\nomitted, then all report data is cleared."}]}, "stop": {"return": {"type": "Void", "description": ""}, "description": "Stops profiling information for a given name.", "static": "", "guessedname": "stop", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the data point."}]}, "getCallCount": {"return": {"type": "int", "description": "The number of times the function was called."}, "description": "Returns the number of times that the given function has been called.", "static": "", "guessedname": "getCallCount", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the function whose data should be returned."}]}, "registerFunction": {"return": {"type": "Void", "description": ""}, "description": "Sets up a function for profiling. It essentially overwrites the function with one\nthat has instrumentation data. This method also creates an entry for the function\nin the profile report. The original function is stored on the container object.", "static": "", "guessedname": "registerFunction", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The full name of the function including namespacing. This\nis the name of the function that is stored in the report."}, {"type": "Object", "name": "owner", "description": " (Optional) The object that owns the function. If the function\nisn't global then this argument is required. This could be the namespace that\nthe function belongs to or the object on which it's\na method."}, {"type": "Boolean", "name": "registerPrototype", "description": " (Optional) Indicates that the prototype should\nalso be instrumented. Setting to true has the same effect as calling\nregisterConstructor()."}]}, "instrument": {"return": {"type": "Function", "description": "An instrumented version of the function."}, "description": "Instruments a method to have profiling calls.", "static": "", "guessedname": "instrument", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the report for the function."}, {"type": "Function", "name": "method", "description": " The function to instrument."}]}, "getOriginal": {"return": {"type": "Function|Object", "description": "The uninstrumented version of a function/object."}, "description": "Returns the uninstrumented version of a function/object.", "static": "", "guessedname": "getOriginal", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the function/object to retrieve."}]}, "getAverage": {"return": {"type": "float", "description": "The average time it takes the function to execute."}, "description": "Returns the average amount of time (in milliseconds) that the function\nwith the given name takes to execute.", "static": "", "guessedname": "getAverage", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the function whose data should be returned.\nIf an object type method, it should be 'constructor.prototype.methodName';\na normal object method would just be 'object.methodName'."}]}, "getMin": {"return": {"type": "float", "description": "The minimum time it takes the function to execute."}, "description": "Returns the minimum amount of time (in milliseconds) that the function\nwith the given name takes to execute.", "static": "", "guessedname": "getMin", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the function whose data should be returned.\nIf an object type method, it should be 'constructor.prototype.methodName';\na normal object method would just be 'object.methodName'."}]}, "unregisterObject": {"return": {"type": "Void", "description": ""}, "description": "Unregisters an object for profiling. It takes the object and looks for functions.\nWhen a function is found, unregisterMethod() is called on it. If set to recrusive\nmode, it will also unregister objects found inside of this object, \nusing the same methodology.", "static": "", "guessedname": "unregisterObject", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the object to unregister."}, {"type": "Boolean", "name": "recurse", "description": " (Optional) Determines if subobject methods should also be\nunregistered."}]}, "getMax": {"return": {"type": "float", "description": "The maximum time it takes the function to execute."}, "description": "Returns the maximum amount of time (in milliseconds) that the function\nwith the given name takes to execute.", "static": "", "guessedname": "getMax", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the function whose data should be returned.\nIf an object type method, it should be 'constructor.prototype.methodName';\na normal object method would just be 'object.methodName'."}]}, "registerConstructor": {"return": {"type": "Void", "description": ""}, "description": "Sets up a constructor for profiling, including all properties and methods on the prototype.", "static": "", "guessedname": "registerConstructor", "guessedtype": "function", "params": [{"type": "string", "name": "name", "description": " The fully-qualified name of the function including namespace information."}, {"type": "Object", "name": "owner", "description": " (Optional) The object that owns the function (namespace or containing object)."}]}, "registerObject": {"return": {"type": "Void", "description": ""}, "description": "Sets up an object for profiling. It takes the object and looks for functions.\nWhen a function is found, registerMethod() is called on it. If set to recrusive\nmode, it will also setup objects found inside of this object for profiling, \nusing the same methodology.", "static": "", "guessedname": "registerObject", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the object to profile (shows up in report)."}, {"type": "Object", "name": "owner", "description": " (Optional) The object represented by the name."}, {"type": "Boolean", "name": "recurse", "description": " (Optional) Determines if subobject methods are also profiled."}]}}, "static": "", "file": "Profiler.js", "guessedtype": "property", "shortname": "Profiler", "description": "Profiles functions in JavaScript."}, "Queue": {"name": "Queue", "namespace": "", "module": "yui", "methods": {"indexOf": {"return": {"type": "Number", "description": "the index of the item or -1 if not found"}, "params": [{"type": "MIXED", "name": "needle", "description": " the item to search for"}], "description": "Returns the current index in the queue of the specified item", "guessedname": "indexOf", "guessedtype": "function"}, "_init": {"protected": "", "description": "Initialize the queue", "guessedname": "_init", "guessedtype": "function"}, "remove": {"params": [{"type": "MIXED", "name": "item", "description": " an item in the queue"}], "description": "Removes the referenced item from the queue", "guessedname": "remove", "guessedtype": "function"}, "next": {"return": {"type": "MIXED", "description": "the next item in the queue"}, "description": "Get the next item in the queue.", "guessedname": "next", "guessedtype": "function"}, "add": {"params": [{"type": "MIXED", "name": "item*", "description": " 0..n items"}], "description": "Add 0..n items to the end of the queue", "guessedname": "add", "guessedtype": "function"}, "promote": {"params": [{"type": "MIXED", "name": "item", "description": " an item in the queue"}], "description": "Moves the referenced item to the head of the queue", "guessedname": "promote", "guessedtype": "function"}, "size": {"return": {"type": "Number", "description": ""}, "description": "Returns the current number of queued items", "guessedname": "size", "guessedtype": "function"}}, "param": "item* {MIXED} 0..n items to seed the queue", "file": "queue-base.js", "shortname": "Queue", "properties": {"_q": {"protected": "", "type": "{Array}", "description": "The collection of enqueued items", "guessedname": "_q", "guessedtype": "property"}}, "description": "A simple FIFO queue. Items are added to the Queue with add(1..n items) and\nremoved using next()."}, "DataSource.IO": {"name": "DataSource.IO", "configs": {"io": {"default": "Y.io", "type": "Y.io", "description": "Pointer to IO Utility.", "guessedname": "io", "guessedtype": "property"}}, "constructors": [{"description": "IO subclass for the DataSource Utility."}], "namespace": "", "module": "datasource", "events": {"ioChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "ioChange", "description": "Fires when the value for the configuration attribute 'io' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "DSIO", "methods": {"_defRequestFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
Array of queued request objects: {request:request, callback:callback}.
\n
", "default": "{interval:null, conn:null, requests:[]}", "private": "", "guessedname": "_queue", "guessedtype": "property", "type": "Object"}}, "description": "IO subclass for the DataSource Utility."}, "ImgLoadGroup": {"properties": {"_areFoldTriggersSet": {"guessedname": "_areFoldTriggersSet", "type": "Boolean", "description": "Boolean tracking whether the window scroll and window resize triggers have been set if this is a fold group.", "private": "", "guessedtype": "property"}, "_maxKnownHLimit": {"guessedname": "_maxKnownHLimit", "type": "Int", "description": "The maximum pixel height of the document that has been made visible.\nDuring fold checks, if the user scrolls up then there's no need to check for newly exposed images.", "private": "", "guessedtype": "property"}, "_imgObjs": {"guessedname": "_imgObjs", "type": "Object", "description": "Collection of images (Y.ImgLoadImgObj objects) registered with this group, keyed by DOM id.", "private": "", "guessedtype": "property"}, "_classImageEls": {"guessedname": "_classImageEls", "type": "Array", "description": "DOM elements having the class name that is associated with this group.\nElements are stored during the _foldCheck function and reused later during any subsequent _foldCheck calls - gives a slight performance improvement when the page fold is repeatedly checked.", "private": "", "guessedtype": "property"}, "_triggers": {"guessedname": "_triggers", "type": "Array", "description": "Collection of triggers for this group.\nKeeps track of each trigger's event handle, as returned from Y.on.", "private": "", "guessedtype": "property"}, "_className": {"guessedname": "_className", "type": "String", "description": "Keep the CSS class name in a member variable for ease and speed.", "private": "", "guessedtype": "property"}, "_timeout": {"guessedname": "_timeout", "type": "Object", "description": "Timeout object to keep a handle on the time limit.", "private": "", "guessedtype": "property"}}, "name": "ImgLoadGroup", "constructors": [{"description": "A group for images. A group can have one time limit and a series of triggers. Thus the images belonging to this group must share these constraints."}], "namespace": "", "module": "imageloader", "events": {"foldDistanceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "foldDistanceChange", "description": "Fires when the value for the configuration attribute 'foldDistance' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "timeLimitChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "timeLimitChange", "description": "Fires when the value for the configuration attribute 'timeLimit' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "classNameChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "classNameChange", "description": "Fires when the value for the configuration attribute 'className' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "nameChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "nameChange", "description": "Fires when the value for the configuration attribute 'name' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "ImgLoadGroup", "methods": {"addCustomTrigger": {"chainable": "", "params": [{"type": "String", "name": "name", "description": " The name of the event"}, {"type": "Object", "name": "obj", "description": " The object on which to attach the event. obj is optional - by default the event is attached to the Y instance"}], "description": "Adds a custom event trigger to the group.", "guessedname": "addCustomTrigger", "guessedtype": "function"}, "addTrigger": {"chainable": "", "params": [{"type": "Object", "name": "obj", "description": " The DOM object to attach the trigger event to"}, {"type": "String", "name": "type", "description": " The event type"}], "description": "Adds a trigger to the group. Arguments are passed to Y.on.", "guessedname": "addTrigger", "guessedtype": "function"}, "_setFoldTriggers": {"private": "", "description": "Sets the window scroll and window resize triggers for any group that is fold-conditional (i.e., has a fold distance set).", "guessedname": "_setFoldTriggers", "guessedtype": "function"}, "_init": {"private": "", "description": "Initialize all private members needed for the group.", "guessedname": "_init", "guessedtype": "function"}, "_clearTriggers": {"private": "", "description": "Clears the timeout and all triggers associated with the group.", "guessedname": "_clearTriggers", "guessedtype": "function"}, "_getFetchTimeout": {"guessedname": "_getFetchTimeout", "return": {"type": "Function", "description": "group's fetch method"}, "description": "Returns the group's fetch method, with the proper closure, for use with setTimeout.", "private": "", "guessedtype": "function"}, "_onloadTasks": {"private": "", "description": "Performs necessary setup at domready time.\nInitiates time limit for group; executes the fold check for the images.", "guessedname": "_onloadTasks", "guessedtype": "function"}, "registerImage": {"return": {"type": "Object", "description": "Y.ImgLoadImgObj that was registered"}, "params": [{"type": "Object", "name": "*", "description": " A configuration object literal with attribute name/value pairs (passed through to a Y.ImgLoadImgObj constructor)"}], "description": "Registers an image with the group.\nArguments are passed through to a Y.ImgLoadImgObj constructor; see that class' attribute documentation for detailed information. \"domId\" is a required attribute.", "guessedname": "registerImage", "guessedtype": "function"}, "_foldCheck": {"private": "", "description": "Checks the position of each image in the group. If any part of the image is within the specified distance (foldDistance) of the client viewport, the image is fetched immediately.", "guessedname": "_foldCheck", "guessedtype": "function"}, "fetch": {"description": "Displays the images in the group.\nThis method is called when a trigger fires or the time limit expires; it shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.", "guessedname": "fetch", "guessedtype": "function"}, "_fetchByClass": {"private": "", "description": "Finds all elements in the DOM with the class name specified in the group. Removes the class from the element in order to let the style definitions trigger the image fetching.", "guessedname": "_fetchByClass", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "imageloader.js", "guessedtype": "function", "shortname": "ImgLoadGroup", "configs": {"className": {"type": "String", "description": "Class name that will identify images belonging to the group. This class name will be removed from each element in order to fetch images.\nThis class should have, in its CSS style definition, \"background:none !important;\".", "guessedname": "className", "guessedtype": "property"}, "timeLimit": {"type": "Number", "description": "Time limit, in seconds, after which images are fetched regardless of trigger events.", "guessedname": "timeLimit", "guessedtype": "property"}, "foldDistance": {"type": "Number", "description": "Distance below the fold for which images are loaded. Images are not loaded until they are at most this distance away from (or above) the fold.\nThis check is performed at page load (domready) and after any window scroll or window resize event (until all images are loaded).", "guessedname": "foldDistance", "guessedtype": "property"}, "name": {"type": "String", "description": "Name for the group. Only used to identify the group in logging statements.", "guessedname": "name", "guessedtype": "property"}}, "description": "A group for images. A group can have one time limit and a series of triggers. Thus the images belonging to this group must share these constraints."}, "Test.Wait": {"name": "Test.Wait", "constructors": [{"params": [{"type": "Function", "name": "segment", "description": " A function to run when the wait is over."}, {"type": "int", "name": "delay", "description": " The number of milliseconds to wait before running the code."}], "description": "Represents a stoppage in test execution to wait for an amount of time before\ncontinuing."}], "namespace": "Test", "module": "test", "guessedname": "Wait", "file": "TestCase.js", "guessedtype": "function", "shortname": "Wait", "properties": {"delay": {"type": "int", "description": "The delay before running the segment of code.", "guessedname": "delay", "guessedtype": "property"}, "segment": {"type": "Function", "description": "The segment of code to run when the wait is over.", "guessedname": "segment", "guessedtype": "property"}}, "description": "Represents a stoppage in test execution to wait for an amount of time before\ncontinuing."}, "Do.Halt": {"name": "Do.Halt", "namespace": "", "module": "event-custom", "guessedname": "Halt", "file": "event-do.js", "guessedtype": "function", "shortname": "Do.Halt", "description": "Return a Halt object when you want to terminate the execution\nof all subsequent subscribers as well as the wrapped method\nif it has not exectued yet."}, "DataSourceCache": {"name": "DataSourceCache", "namespace": "", "module": "datasource", "guessedname": "DataSourceCache", "methods": {"_beforeDefRequestFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object.
\n
cfg (Object)
Configuration object.
\n
"}], "description": "First look for cached response, then send request to live data.", "guessedname": "_beforeDefRequestFn", "guessedtype": "function"}, "_beforeDefResponseFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
data (Object)
Raw data.
\n
response (Object)
Normalized response object with the following properties:\n
\n
cached (Object)
True when response is cached.
\n
results (Object)
Parsed results.
\n
meta (Object)
Parsed meta data.
\n
error (Object)
Error object.
\n
\n
\n
cfg (Object)
Configuration object.
\n
"}], "description": "Adds data to cache before returning data.", "guessedname": "_beforeDefResponseFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}}, "extends": "Cache", "superclass": "Cache", "file": "datasource-cache.js", "guessedtype": "function", "shortname": "DataSourceCache", "properties": {"NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"cache\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"dataSourceCache\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Adds cacheability to the DataSource Utility."}, "Assert.ShouldError": {"name": "Assert.ShouldError", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "ShouldError is subclass of Error that is thrown whenever\na test is expected to throw an error but doesn't."}], "namespace": "Assert", "module": "test", "guessedname": "ShouldError", "extends": "Assert.Error", "superclass": "Assert.Error", "file": "Assert.js", "guessedtype": "function", "shortname": "ShouldError", "properties": {"name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}}, "description": "ShouldError is subclass of Error that is thrown whenever\na test is expected to throw an error but doesn't."}, "Do.AlterReturn": {"name": "Do.AlterReturn", "namespace": "", "module": "event-custom", "guessedname": "AlterReturn", "file": "event-do.js", "guessedtype": "function", "shortname": "Do.AlterReturn", "description": "Return an AlterReturn object when you want to change the result returned\nfrom the core method to the caller"}, "Event": {"name": "Event", "namespace": "", "module": "event", "guessedname": "dom_wrappers", "methods": {"nativeRemove": {"description": "Basic remove listener", "private": "", "static": "", "guessedname": "nativeRemove", "guessedtype": "property", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to bind the handler to"}, {"type": "string", "name": "type", "description": " the type of event handler"}, {"type": "function", "name": "fn", "description": " the callback to invoke"}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "getListeners": {"return": {"type": "Y.Custom.Event", "description": "the custom event wrapper for the DOM event(s)"}, "description": "Returns all listeners attached to the given element via addListener.\nOptionally, you can specify a specific type of event to return.", "static": "", "guessedname": "getListeners", "guessedtype": "function", "params": [{"type": "HTMLElement|string", "name": "el", "description": " the element or element id to inspect"}, {"type": "string", "name": "type", "description": " optional type of listener to return. If\nleft out, all listeners will be returned"}]}, "getEvent": {"return": {"type": "Event", "description": "the event"}, "description": "Finds the event in the window object, the caller's arguments, or\nin the arguments of another method in the callstack. This is\nexecuted automatically for events registered through the event\nmanager, so the implementer should not normally need to execute\nthis function at all.", "static": "", "guessedname": "getEvent", "guessedtype": "function", "params": [{"type": "Event", "name": "e", "description": " the event parameter from the handler"}, {"type": "HTMLElement", "name": "el", "description": " the element the listener was attached to"}]}, "attach": {"return": {"type": "EventHandle", "description": "an object to that can be used to detach the listener"}, "description": "Adds an event listener", "static": "", "guessedname": "attach", "guessedtype": "function", "params": [{"type": "String", "name": "type", "description": " The type of event to append"}, {"type": "Function", "name": "fn", "description": " The method the event invokes"}, {"type": "String|HTMLElement|Array|NodeList", "name": "el", "description": " An id, an element \nreference, or a collection of ids and/or elements to assign the \nlistener to."}, {"type": "Object", "name": "context", "description": " optional context object"}, {"type": "Boolean|object", "name": "args", "description": " 0..n arguments to pass to the callback"}]}, "_unload": {"guessedname": "_unload", "static": "", "description": "Removes all listeners registered by pe.event. Called \nautomatically during the unload event.", "private": "", "guessedtype": "function"}, "purgeElement": {"static": "", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to purge"}, {"type": "boolean", "name": "recurse", "description": " recursively purge this element's children\nas well. Use with caution."}, {"type": "string", "name": "type", "description": " optional type of listener to purge. If\nleft out, all listeners will be removed"}], "description": "Removes all listeners attached to the given element via addListener.\nOptionally, the node's children can also be purged.\nOptionally, you can specify a specific type of event to remove.", "guessedname": "purgeElement", "guessedtype": "function"}, "generateId": {"return": {"type": "string", "description": "the resulting id of the element"}, "description": "Generates an unique ID for the element if it does not already \nhave one.", "static": "", "guessedname": "generateId", "guessedtype": "function", "params": [{"type": "", "name": "el", "description": " the element to create the id for"}]}, "_isValidCollection": {"return": {"type": "boolean", "description": "true if the object is array-like and populated"}, "description": "We want to be able to use getElementsByTagName as a collection\nto attach a group of events to. Unfortunately, different \nbrowsers return different types of collections. This function\ntests to determine if the object is array-like. It will also \nfail if the object is an array, but is empty.", "deprecated": "was not meant to be used directly", "private": "", "static": "", "guessedname": "_isValidCollection", "guessedtype": "property", "params": [{"type": "", "name": "o", "description": " the object to test"}]}, "onContentReady": {"deprecated": "Use Y.on(\"contentready\")", "static": "", "params": [{"type": "string", "name": "id", "description": " the id of the element to look for."}, {"type": "function", "name": "fn", "description": " what to execute when the element is ready."}, {"type": "object", "name": "p_obj", "description": " an optional object to be passed back as\na parameter to fn."}, {"type": "boolean|object", "name": "p_override", "description": " If set to true, fn will execute\nin the context of p_obj. If an object, fn will\nexectute in the context of that object"}], "description": "Works the same way as onAvailable, but additionally checks the\nstate of sibling elements to determine if the content of the\navailable element is safe to modify.\n
The callback is executed with a single parameter:\nthe custom object parameter, if provided.
"}, "startInterval": {"static": "", "private": "", "guessedname": "startInterval", "guessedtype": "function"}, "nativeAdd": {"description": "Adds a DOM event directly without the caching, cleanup, context adj, etc", "private": "", "static": "", "guessedname": "nativeAdd", "guessedtype": "property", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to bind the handler to"}, {"type": "string", "name": "type", "description": " the type of event handler"}, {"type": "function", "name": "fn", "description": " the callback to invoke"}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "_poll": {"guessedname": "_poll", "static": "", "description": "Polling function that runs before the onload event fires, \nattempting to attach to DOM Nodes as soon as they are \navailable", "private": "", "guessedtype": "function"}, "onAvailable": {"deprecated": "Use Y.on(\"available\")", "static": "", "params": [{"type": "string||string[]", "name": "id", "description": " the id of the element, or an array\nof ids to look for."}, {"type": "function", "name": "fn", "description": " what to execute when the element is found."}, {"type": "object", "name": "p_obj", "description": " an optional object to be passed back as\na parameter to fn."}, {"type": "boolean|object", "name": "p_override", "description": " If set to true, fn will execute\nin the context of p_obj, if set to an object it\nwill execute in the context of that object"}, {"type": "boolean", "name": "checkContent", "description": " check child node readiness (onContentReady)"}], "description": "Executes the supplied callback when the item with the supplied\nid is found. This is meant to be used to execute behavior as\nsoon as possible as the page loads. If you use this after the\ninitial page load it will poll for a fixed time for the element.\nThe number of times it will poll and the frequency are\nconfigurable. By default it will poll for 10 seconds.\n
The callback is executed with a single parameter:\nthe custom object parameter, if provided.
"}, "detach": {"return": {"type": "boolean", "description": "true if the unbind was successful, false otherwise."}, "description": "Removes an event listener. Supports the signature the event was bound\nwith, but the preferred way to remove listeners is using the handle\nthat is returned when using Y.on", "static": "", "guessedname": "detach", "guessedtype": "function", "params": [{"type": "String", "name": "type", "description": " the type of event to remove."}, {"type": "Function", "name": "fn", "description": " the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are \nremoved."}, {"type": "String|HTMLElement|Array|NodeList|EventHandle", "name": "el", "description": " An \nevent handle, an id, an element reference, or a collection \nof ids and/or elements to remove the listener from."}]}, "_load": {"guessedname": "_load", "static": "", "description": "hook up any deferred listeners", "private": "", "guessedtype": "function"}}, "static": "", "file": "event-dom.js", "guessedtype": "property", "shortname": "Event", "properties": {"DOMReady": {"type": "boolean", "static": "", "description": "True when the document is initially usable", "guessedname": "DOMReady", "guessedtype": "property"}, "_retryCount": {"guessedname": "_retryCount", "static": "", "description": "The number of times to poll after window.onload. This number is\nincreased if additional late-bound handlers are requested after\nthe page load.", "private": "", "guessedtype": "property"}, "POLL_RETRYS": {"description": "The number of times we should look for elements that are not\nin the DOM at the time the event is requested after the document\nhas been loaded. The default is 1000@amp;40 ms, so it will poll\nfor 40 seconds or until all outstanding handlers are bound\n(whichever comes first).", "static": "", "guessedname": "POLL_RETRYS", "guessedtype": "property", "type": "int", "final": ""}, "_dri": {"guessedname": "_dri", "static": "", "description": "document readystate poll handle", "private": "", "guessedtype": "property"}, "_wrappers": {"description": "Custom event wrappers for DOM events. Key is \n'event:' + Element uid stamp + event type", "private": "", "static": "", "guessedname": "_wrappers", "guessedtype": "property", "type": "Y.Event.Custom"}, "_loadComplete": {"description": "True after the onload event has fired", "private": "", "static": "", "guessedname": "_loadComplete", "guessedtype": "property", "type": "boolean"}, "POLL_INTERVAL": {"description": "The poll interval in milliseconds", "static": "", "guessedname": "POLL_INTERVAL", "guessedtype": "property", "type": "int", "final": ""}, "_interval": {"guessedname": "_interval", "static": "", "description": "poll handle", "private": "", "guessedtype": "property"}, "_el_events": {"guessedname": "_el_events", "static": "", "description": "Custom event wrapper map DOM events. Key is \nElement uid stamp. Each item is a hash of custom event\nwrappers as provided in the _wrappers collection. This\nprovides the infrastructure for getListeners.", "private": "", "guessedtype": "property"}, "lastError": {"type": "Error", "static": "", "description": "addListener/removeListener can throw errors in unexpected scenarios.\nThese errors are suppressed, the method returns false, and this property\nis set", "guessedname": "lastError", "guessedtype": "property"}, "_avail": {"guessedname": "_avail", "static": "", "description": "onAvailable listeners", "private": "", "guessedtype": "property"}}, "description": "The event utility provides functions to add and remove event listeners,\nevent cleansing. It also tries to automatically remove listeners it\nregisters during the unload event."}, "Plugin.NodeFX": {"name": "Plugin.NodeFX", "namespace": "", "module": "anim", "guessedname": "NodeFX", "extends": "Base", "superclass": "Base", "file": "anim-node-plugin.js", "guessedtype": "function", "shortname": "Plugin.NodeFX", "description": "Binds an Anim instance to a Node instance"}, "UA": {"name": "UA", "namespace": "", "module": "yui", "guessedname": "UA", "static": "", "file": "yui-ua.js", "guessedtype": "function", "shortname": "UA", "properties": {"secure": {"type": "boolean", "static": "", "description": "Set to true if the page appears to be in SSL", "guessedname": "secure", "guessedtype": "property"}, "opera": {"type": "float", "static": "", "description": "Opera version number or 0. Example: 9.2", "guessedname": "opera", "guessedtype": "property"}, "ie": {"type": "float", "static": "", "description": "Internet Explorer version number or 0. Example: 6", "guessedname": "ie", "guessedtype": "property"}, "air": {"type": "float", "description": "Adobe AIR version number or 0. Only populated if webkit is detected.\nExample: 1.0", "guessedname": "air", "guessedtype": "property"}, "mobile": {"type": "string", "static": "", "description": "The mobile property will be set to a string containing any relevant\nuser agent information when a modern mobile browser is detected.\nCurrently limited to Safari on the iPhone/iPod Touch, Nokia N-series\ndevices with the WebKit-based browser, and Opera Mini.", "guessedname": "mobile", "guessedtype": "property"}, "caja": {"type": "float", "description": "Google Caja version number or 0.", "guessedname": "caja", "guessedtype": "property"}, "os": {"type": "string", "static": "", "description": "The operating system. Currently only detecting windows or macintosh", "guessedname": "os", "guessedtype": "property"}, "webkit": {"type": "float", "static": "", "description": "AppleWebKit version. KHTML browsers that are not WebKit browsers \nwill evaluate to 1, other browsers 0. Example: 418.9\n
\nSafari 1.3.2 (312.6): 312.8.1 <-- Reports 312.8 -- currently the \nlatest available for Mac OSX 10.3.\nSafari 2.0.2: 416 <-- hasOwnProperty introduced\nSafari 2.0.4: 418 <-- preventDefault fixed\nSafari 2.0.4 (419.3): 418.9.1 <-- One version of Safari may run\ndifferent versions of webkit\nSafari 2.0.4 (419.3): 419 <-- Tiger installations that have been\nupdated, but not updated\nto the latest patch.\nWebkit 212 nightly: 522+ <-- Safari 3.0 precursor (with native SVG\nand many major issues fixed).\nSafari 3.0.4 (523.12) 523.12 <-- First Tiger release - automatic update\nfrom 2.x via the 10.4.11 OS patch\nWebkit nightly 1/2008:525+ <-- Supports DOMContentLoaded event.\nyahoo.com user agent hack removed.\n
\nhttp://en.wikipedia.org/wiki/Safari_(web_browser)#Version_history", "guessedname": "webkit", "guessedtype": "property"}, "gecko": {"type": "float", "static": "", "description": "Gecko engine revision number. Will evaluate to 1 if Gecko \nis detected but the revision could not be found. Other browsers\nwill be 0. Example: 1.8\n
", "guessedname": "gecko", "guessedtype": "property"}}, "description": "YUI user agent detection.\nDo not fork for a browser if it can be avoided. Use feature detection when\nyou can. Use the user agent as a last resort. UA stores a version\nnumber for the browser engine, 0 otherwise. This value may or may not map\nto the version number of the browser using the engine. The value is \npresented as a float so that it can easily be used for boolean evaluation \nas well as for looking for a particular range of versions. Because of this, \nsome of the granularity of the version info may be lost (e.g., Gecko 1.8.0.9 \nreports 1.8)."}, "DataSourceJSONSchema": {"name": "DataSourceJSONSchema", "namespace": "", "module": "datasource", "guessedname": "DataSourceJSONSchema", "methods": {"_beforeDefDataFn\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
data (Object)
Raw data.
\n
": {"protected": "", "description": "Parses raw data into a normalized response.", "guessedname": "_beforeDefDataFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}}, "extends": "Plugin.Base", "superclass": "Plugin.Base", "file": "datasource-jsonschema.js", "guessedtype": "function", "shortname": "DataSourceJSONSchema", "properties": {"NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"schema\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"dataSourceJSONSchema\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Adds schema-parsing to the DataSource Utility."}, "Test.TestNode": {"name": "Test.TestNode", "constructors": [{"params": [{"type": "Variant", "name": "testObject", "description": " A TestSuite, TestCase, or the name of a test function."}], "description": "A node in the test tree structure. May represent a TestSuite, TestCase, or\ntest function."}], "namespace": "Test", "module": "test", "methods": {"appendChild": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Variant", "name": "testObject", "description": " A TestSuite, TestCase, or the name of a test function."}], "description": "Appends a new test object (TestSuite, TestCase, or test function name) as a child\nof this node.", "guessedname": "appendChild", "guessedtype": "function"}}, "private": "", "file": "TestRunner.js", "shortname": "TestNode", "properties": {"testObject": {"type": "Variant", "description": "The TestSuite, TestCase, or test function represented by this node.", "guessedname": "testObject", "guessedtype": "property"}, "parent": {"type": "TestNode", "description": "Pointer to this node's parent.", "guessedname": "parent", "guessedtype": "property"}, "results": {"type": "object", "description": "Test results for this test object.", "guessedname": "results", "guessedtype": "property"}, "firstChild": {"type": "TestNode", "description": "Pointer to this node's first child.", "guessedname": "firstChild", "guessedtype": "property"}, "next": {"type": "TestNode", "description": "Pointer to this node's next sibling.", "guessedname": "next", "guessedtype": "property"}, "lastChild": {"type": "TestNode", "description": "Pointer to this node's last child.", "guessedname": "lastChild", "guessedtype": "property"}}, "description": "A node in the test tree structure. May represent a TestSuite, TestCase, or\ntest function."}, "DOM": {"name": "DOM", "description": "Provides DOM helper methods.", "namespace": "", "module": "dom", "guessedname": "NODE_TYPE", "file": "dom.js", "guessedtype": "property", "shortname": "DOM", "methods": {"_getRegExp": {"return": {"type": "RegExp", "description": "An instance of RegExp"}, "description": "Memoizes dynamic regular expressions to boost runtime performance.", "private": "", "params": [{"type": "String", "name": "str", "description": " The string to convert to a regular expression."}, {"type": "String", "name": "flags", "description": " optional An optinal string of flags."}], "guessedname": "_getRegExp", "guessedtype": "function"}, "replaceClass": {"params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "String", "name": "oldClassName", "description": " the class name to be replaced"}, {"type": "String", "name": "newClassName", "description": " the class name that will be replacing the old class name"}], "description": "Replace a class with another class for a given element.\nIf no oldClassName is present, the newClassName is simply added.", "guessedname": "replaceClass", "guessedtype": "function"}, "addHTML": {"params": [{"type": "HTMLElement", "name": "node", "description": " The node to insert into"}, {"type": "String", "name": "content", "description": " The content to be inserted"}, {"type": "String", "name": "where", "description": " Where to insert the content; default is after lastChild"}], "description": "Inserts content in a node at the given location", "guessedname": "addHTML", "guessedtype": "function"}, "getText": {"return": {"type": "String", "description": "The text content of the element (includes text of any descending elements)."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The html element."}], "description": "Returns the text content of the HTMLElement.", "guessedname": "getText", "guessedtype": "property"}, "setStyle": {"params": [{"type": "HTMLElement", "name": "An", "description": " HTMLElement to apply the style to."}, {"type": "String", "name": "att", "description": " The style property to set."}, {"type": "String|Number", "name": "val", "description": " The value."}], "description": "Sets a style property for a given element.", "guessedname": "setStyle", "guessedtype": "function"}, "getX": {"return": {"type": "Int", "description": "The X position of the element"}, "params": [{"type": "", "name": "element", "description": " The target element"}], "description": "Gets the current X position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).", "guessedname": "getX", "guessedtype": "function"}, "getY": {"return": {"type": "Int", "description": "The Y position of the element"}, "params": [{"type": "", "name": "element", "description": " The target element"}], "description": "Gets the current Y position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).", "guessedname": "getY", "guessedtype": "function"}, "_bruteContains": {"return": {"type": "Boolean", "description": "Whether or not the element is or contains the needle."}, "description": "Brute force version of contains.\nUsed for browsers without contains support for non-HTMLElement Nodes (textNodes, etc).", "private": "", "params": [{"type": "HTMLElement", "name": "element", "description": " The containing html element."}, {"type": "HTMLElement", "name": "needle", "description": " The html element that may be contained."}], "guessedname": "_bruteContains", "guessedtype": "function"}, "setX": {"params": [{"type": "", "name": "element", "description": " The target element"}, {"type": "Int", "name": "x", "description": " The X values for new position (coordinates are page-based)"}], "description": "Set the X position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setX", "guessedtype": "function"}, "create": {"params": [{"type": "String", "name": "html", "description": " The markup used to create the element"}, {"type": "HTMLDocument", "name": "doc", "description": " An optional document context"}], "description": "Creates a new dom node using the provided markup string.", "guessedname": "create", "guessedtype": "function"}, "contains": {"return": {"type": "Boolean", "description": "Whether or not the element is or contains the needle."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The containing html element."}, {"type": "HTMLElement", "name": "needle", "description": " The html element that may be contained."}], "description": "Determines whether or not one HTMLElement is or contains another HTMLElement.", "guessedname": "contains", "guessedtype": "function"}, "getComputedStyle": {"return": {"type": "String", "description": "The computed value of the style property."}, "params": [{"type": "HTMLElement", "name": "An", "description": " HTMLElement to get the style from."}, {"type": "String", "name": "att", "description": " The style property to get."}], "description": "Returns the computed style for the given node.", "guessedname": "getComputedStyle", "guessedtype": "function"}, "winHeight": {"return": {"type": "Number", "description": "The current height of the viewport."}, "description": "Returns the inner height of the viewport (exludes scrollbar).", "guessedname": "winHeight", "guessedtype": "function"}, "setStyles": {"params": [{"type": "HTMLElement", "name": "node", "description": " An HTMLElement to apply the styles to."}, {"type": "Object", "name": "hash", "description": " An object literal of property:value pairs."}], "description": "Sets multiple style properties.", "guessedname": "setStyles", "guessedtype": "function"}, "toggleClass": {"params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "String", "name": "className", "description": " the class name to be toggled"}], "description": "If the className exists on the node it is removed, if it doesn't exist it is added.", "guessedname": "toggleClass", "guessedtype": "function"}, "inDoc": {"return": {"type": "Boolean", "description": "Whether or not the element is attached to the document."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The containing html element."}, {"type": "HTMLElement", "name": "doc", "description": " optional The document to check."}], "description": "Determines whether or not the HTMLElement is part of the document.", "guessedname": "inDoc", "guessedtype": "function"}, "addClass": {"params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "String", "name": "className", "description": " the class name to add to the class attribute"}], "description": "Adds a class name to a given DOM element.", "guessedname": "addClass", "guessedtype": "function"}, "winWidth": {"return": {"type": "Number", "description": "The current width of the viewport."}, "description": "Returns the inner width of the viewport (exludes scrollbar).", "guessedname": "winWidth", "guessedtype": "function"}, "removeClass": {"params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "String", "name": "className", "description": " the class name to remove from the class attribute"}], "description": "Removes a class name from a given element.", "guessedname": "removeClass", "guessedtype": "function"}, "docScrollY": {"return": {"type": "Number", "description": "The current amount the screen is scrolled vertically."}, "description": "Amount page has been scroll vertically", "guessedname": "docScrollY", "guessedtype": "function"}, "docScrollX": {"return": {"type": "Number", "description": "The current amount the screen is scrolled horizontally."}, "description": "Amount page has been scroll horizontally", "guessedname": "docScrollX", "guessedtype": "function"}, "docHeight": {"return": {"type": "Number", "description": "The current height of the document."}, "description": "Document height", "guessedname": "docHeight", "guessedtype": "function"}, "getStyle": {"params": [{"type": "HTMLElement", "name": "An", "description": " HTMLElement to get the style from."}, {"type": "String", "name": "att", "description": " The style property to get."}], "description": "Returns the current style value for the given property.", "guessedname": "getStyle", "guessedtype": "function"}, "setXY": {"params": [{"type": "", "name": "element", "description": " The target element"}, {"type": "Array", "name": "xy", "description": " Contains X & Y values for new position (coordinates are page-based)"}, {"type": "Boolean", "name": "noRetry", "description": " By default we try and set the position a second time if the first fails"}], "description": "Set the position of an html element in page coordinates.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setXY", "guessedtype": "function"}, "_getWin": {"return": {"type": "Object", "description": "The window for the given element or the default window."}, "description": "returns the appropriate window.", "private": "", "params": [{"type": "HTMLElement", "name": "element", "description": " optional Target element."}], "guessedname": "_getWin", "guessedtype": "function"}, "setAttibute": {"params": [{"type": "String | HTMLElement", "name": "el", "description": " The target element for the attribute."}, {"type": "String", "name": "attr", "description": " The attribute to set."}, {"type": "String", "name": "val", "description": " The value of the attribute."}], "description": "Provides a normalized attribute interface.", "guessedname": "setAttribute", "guessedtype": "function"}, "byId": {"return": {"type": "HTMLElement | null", "description": "The HTMLElement with the id, or null if none found."}, "params": [{"type": "String", "name": "id", "description": " the id attribute"}, {"type": "Object", "name": "doc", "description": " optional The document to search. Defaults to current document"}], "description": "Returns the HTMLElement with the given ID (Wrapper for document.getElementById).", "guessedname": "byId", "guessedtype": "function"}, "setY": {"params": [{"type": "", "name": "element", "description": " The target element"}, {"type": "Int", "name": "y", "description": " The Y values for new position (coordinates are page-based)"}], "description": "Set the Y position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setY", "guessedtype": "function"}, "getXY": {"return": {"type": "Array", "description": "The XY position of the element\nTODO: test inDocument/display?"}, "params": [{"type": "", "name": "element", "description": " The target element"}], "description": "Gets the current position of an element based on page coordinates. \nElement must be part of the DOM tree to have page coordinates\n(display:none or elements not appended return false).", "guessedname": "getXY", "guessedtype": "function"}, "elementByAxis": {"return": {"type": "HTMLElement | null", "description": "The matching element or null if none found."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The html element."}, {"type": "String", "name": "axis", "description": " The axis to search (parentNode, nextSibling, previousSibling)."}, {"type": "Function", "name": "fn", "description": " optional An optional boolean test to apply."}, {"type": "Boolean", "name": "all", "description": " optional Whether all node types should be returned, or just element nodes.\nThe optional function is passed the current HTMLElement being tested as its only argument.\nIf no function is given, the first element is returned."}], "description": "Searches the element by the given axis for the first matching element.", "guessedname": "elementByAxis", "guessedtype": "function"}, "docWidth": {"return": {"type": "Number", "description": "The current width of the document."}, "description": "Document width", "guessedname": "docWidth", "guessedtype": "function"}, "setText": {"params": [{"type": "HTMLElement", "name": "element", "description": " The html element."}, {"type": "String", "name": "content", "description": " The content to add."}], "description": "Sets the text content of the HTMLElement.", "guessedname": "setText", "guessedtype": "property"}, "getAttibute": {"return": {"type": "String", "description": "The current value of the attribute."}, "params": [{"type": "String | HTMLElement", "name": "el", "description": " The target element for the attribute."}, {"type": "String", "name": "attr", "description": " The attribute to get."}], "description": "Provides a normalized attribute interface.", "guessedname": "getAttribute", "guessedtype": "function"}, "hasClass": {"return": {"type": "Boolean", "description": "Whether or not the element has the given class."}, "params": [{"type": "HTMLElement", "name": "element", "description": " The DOM element."}, {"type": "String", "name": "className", "description": " the class name to search for"}], "description": "Determines whether a DOM element has the given className.", "guessedname": "hasClass", "guessedtype": "function"}, "_getDoc": {"return": {"type": "Object", "description": "The document for the given element or the default document."}, "description": "returns the appropriate document.", "private": "", "params": [{"type": "HTMLElement", "name": "element", "description": " optional Target element."}], "guessedname": "_getDoc", "guessedtype": "function"}}}, "Cache": {"name": "Cache", "configs": {"max": {"default": "0", "type": "Number", "description": "Maximum number of entries the Cache can hold.\nSet to 0 to turn off caching.", "guessedname": "max", "guessedtype": "property"}, "entries": {"type": "Array", "description": "Cached entries.", "guessedname": "entries", "guessedtype": "property"}, "uniqueKeys": {"type": "Number", "description": "Validate uniqueness of stored keys. Default is false and\nis more performant.", "guessedname": "uniqueKeys", "guessedtype": "property"}, "size": {"type": "Number", "description": "Number of entries currently cached.", "guessedname": "size", "guessedtype": "property"}}, "constructors": [{"description": "Base class for the YUI Cache utility."}], "namespace": "", "module": "cache", "events": {"sizeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "sizeChange", "description": "Fires when the value for the configuration attribute 'size' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "retrieve": {"params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
entry (Object)
The retrieved entry.
\n
"}], "description": "Fired when an entry is retrieved from the cache."}, "entriesChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "entriesChange", "description": "Fires when the value for the configuration attribute 'entries' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "uniqueKeysChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "uniqueKeysChange", "description": "Fires when the value for the configuration attribute 'uniqueKeys' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "maxChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "maxChange", "description": "Fires when the value for the configuration attribute 'max' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "request": {"params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
request (Object)
The request object.
\n
"}], "description": "Fired when an entry is requested from the cache."}, "add": {"preventable": "_defAddFn", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
entry (Object)
The cached entry.
\n
"}], "description": "Fired when an entry is added.", "guessedname": "defaultFn", "guessedtype": "property"}, "flush": {"preventable": "_defFlushFn", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade object."}], "description": "Fired when the cache is flushed.", "guessedname": "defaultFn", "guessedtype": "property"}}, "guessedname": "Cache", "methods": {"retrieve": {"return": {"type": "Object", "description": "Cached entry object with the properties request, response, and payload, or null."}, "params": [{"type": "Object", "name": "request", "description": " Request object."}], "description": "Retrieves cached entry for given request, if available, and refreshes\nentry in the cache. Returns null if there is no cache match.", "guessedname": "retrieve", "guessedtype": "function"}, "add": {"params": [{"type": "Object", "name": "request", "description": " Request value."}, {"type": "Object", "name": "response", "description": " Response value."}, {"type": "Object", "name": "payload", "description": " (optional) Arbitrary data payload."}], "description": "Adds a new entry to the cache of the format\n{request:request, response:response, payload:payload}.\nIf cache is full, evicts the stalest entry before adding the new one.", "guessedname": "add", "guessedtype": "function"}, "destructor": {"description": "Internal destroy() handler.", "private": "", "guessedname": "destructor", "guessedtype": "function"}, "_defFlushFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade object."}], "description": "Flushes cache.", "guessedname": "_defFlushFn", "guessedtype": "function"}, "_isMatch": {"return": {"type": "Boolean", "description": "True if current request matches given cached request, false otherwise."}, "description": "Default overridable method compares current request with given cache entry.\nReturns true if current request matches the cached request, otherwise\nfalse. Implementers should override this method to customize the\ncache-matching algorithm.", "protected": "", "params": [{"type": "Object", "name": "request", "description": " Request object."}, {"type": "Object", "name": "entry", "description": " Cached entry."}], "guessedname": "_isMatch", "guessedtype": "function"}, "flush": {"description": "Flushes cache.", "guessedname": "flush", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}, "_defAddFn": {"protected": "", "params": [{"type": "Event.Facade", "name": "e", "description": " Event Facade with the following properties:\n
\n
entry (Object)
The cached entry.
\n
"}], "description": "Adds entry to cache.", "guessedname": "_defAddFn", "guessedtype": "function"}}, "extends": "Plugin.Base", "superclass": "Plugin.Base", "file": "cache.js", "guessedtype": "function", "shortname": "Cache", "properties": {"_entries": {"guessedname": "_entries", "type": "Object[]", "description": "Array of request/response objects indexed chronologically.", "private": "", "guessedtype": "property"}, "NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"cache\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"cache\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Base class for the YUI Cache utility."}, "ImgLoadImgObj": {"properties": {"_imgEl": {"guessedname": "_imgEl", "type": "Object", "description": "The Node object returned from Y.get, to avoid repeat calls to access the DOM.", "private": "", "guessedtype": "property"}, "_fetched": {"guessedname": "_fetched", "type": "Boolean", "description": "Whether this image has already been fetched.\nIn the case of fold-conditional groups, images won't be fetched twice.", "private": "", "guessedtype": "property"}, "_yPos": {"guessedname": "_yPos", "type": "Int", "description": "The vertical position returned from getY, to avoid repeat calls to access the DOM.\nThe Y position is checked only for images registered with fold-conditional groups. The position is checked first at page load (domready)\nand this caching enhancement assumes that the image's vertical position won't change after that first check.", "private": "", "guessedtype": "property"}}, "name": "ImgLoadImgObj", "constructors": [{"description": "Image objects to be registered with the groups"}], "namespace": "", "module": "imageloader", "events": {"isPngChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "isPngChange", "description": "Fires when the value for the configuration attribute 'isPng' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "heightChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "heightChange", "description": "Fires when the value for the configuration attribute 'height' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "sizingMethodChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "sizingMethodChange", "description": "Fires when the value for the configuration attribute 'sizingMethod' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "domIdChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "domIdChange", "description": "Fires when the value for the configuration attribute 'domId' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "setVisibleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "setVisibleChange", "description": "Fires when the value for the configuration attribute 'setVisible' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "enabledChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "enabledChange", "description": "Fires when the value for the configuration attribute 'enabled' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "bgUrlChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "bgUrlChange", "description": "Fires when the value for the configuration attribute 'bgUrl' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "srcUrlChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "srcUrlChange", "description": "Fires when the value for the configuration attribute 'srcUrl' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "widthChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "widthChange", "description": "Fires when the value for the configuration attribute 'width' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "ImgLoadImgObj", "methods": {"_getYPos": {"guessedname": "_getYPos", "returns": "{Object} The Y position of the image", "description": "Gets the Y position of the node in page coordinates.\nExpects that the page-coordinate position of the image won't change.", "private": "", "guessedtype": "function"}, "_getImgEl": {"guessedname": "_getImgEl", "returns": "{Object} DOM element of the image as a Y.Node object", "description": "Gets the object (as a Y.Node) of the DOM element indicated by \"domId\".", "private": "", "guessedtype": "function"}, "_init": {"private": "", "description": "Initialize all private members needed for the group.", "guessedname": "_init", "guessedtype": "function"}, "fetch": {"return": {"type": "Boolean", "description": "Whether the image has been fetched (either during this execution or previously)"}, "params": [{"type": "Int", "name": "withinY", "description": " The pixel distance from the top of the page, for which if the image lies within, it will be fetched. Undefined indicates that no check should be made, and the image should always be fetched"}], "description": "Displays the image; puts the URL into the DOM.\nThis method shouldn't be called externally, but is not private in the rare event that it needs to be called immediately.", "guessedname": "fetch", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "imageloader.js", "guessedtype": "function", "shortname": "ImgLoadImgObj", "configs": {"isPng": {"type": "Boolean", "description": "Whether the image is a PNG.\nPNG images get special treatment in that the URL is specified through AlphaImageLoader for IE, versions 6 and earlier.\nOnly used with background images.", "guessedname": "isPng", "guessedtype": "property"}, "srcUrl": {"type": "String", "description": "Source URL for the image.\nFor an image whose URL is specified by a \"src\" attribute in the DOM element.", "guessedname": "srcUrl", "guessedtype": "property"}, "enabled": {"type": "String", "description": "AlphaImageLoader enabled property to be set for the image.\nOnly set if isPng value for this image is set to true.\nDefaults to true.", "guessedname": "enabled", "guessedtype": "property"}, "domId": {"type": "String", "description": "HTML DOM id of the image element.", "guessedname": "domId", "guessedtype": "property"}, "height": {"type": "Int", "description": "Pixel height of the image. Will be set as a height attribute on the DOM element after the image is fetched.\nDefaults to the natural height of the image (no height attribute will be set).\nUsually only used with src images.", "guessedname": "height", "guessedtype": "property"}, "width": {"type": "Int", "description": "Pixel width of the image. Will be set as a width attribute on the DOM element after the image is fetched.\nDefaults to the natural width of the image (no width attribute will be set).\nUsually only used with src images.", "guessedname": "width", "guessedtype": "property"}, "sizingMethod": {"type": "String", "description": "AlphaImageLoader sizingMethod property to be set for the image.\nOnly set if isPng value for this image is set to true.\nDefaults to scale.", "guessedname": "sizingMethod", "guessedtype": "property"}, "bgUrl": {"type": "String", "description": "Background URL for the image.\nFor an image whose URL is specified by \"background-image\" in the element's style.", "guessedname": "bgUrl", "guessedtype": "property"}, "setVisible": {"type": "Boolean", "description": "Whether the image's style.visibility should be set to visible after the image is fetched.\nUsed when setting images as visibility:hidden prior to image fetching.", "guessedname": "setVisible", "guessedtype": "property"}}, "description": "Image objects to be registered with the groups"}, "plugin.NodeMenuNav": {"name": "plugin.NodeMenuNav", "configs": {"submenuHideDelay": {"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of a menu label heading in the \ndirection of a submenu.", "writeonce": "", "default": "250", "readonly": "", "guessedname": "submenuHideDelay", "guessedtype": "property", "type": "Number"}, "useARIA": {"description": "Boolean indicating if use of the WAI-ARIA Roles and States should be \nenabled for the menu.", "writeonce": "", "default": "true", "readonly": "", "guessedname": "useARIA", "guessedtype": "property", "type": "boolean"}, "autoSubmenuDisplay": {"description": "Boolean indicating if submenus are automatically made visible when the \nuser mouses over the menu's items.", "writeonce": "", "default": "true", "readonly": "", "guessedname": "autoSubmenuDisplay", "guessedtype": "property", "type": "boolean"}, "mouseOutHideDelay": {"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is hidden when the user mouses out of it.", "writeonce": "", "default": "750", "readonly": "", "guessedname": "mouseOutHideDelay", "guessedtype": "property", "type": "Number"}, "submenuShowDelay": {"description": "Number indicating the time (in milliseconds) that should expire before a \nsubmenu is made visible when the user mouses over the menu's label.", "writeonce": "", "default": "250", "readonly": "", "guessedname": "submenuShowDelay", "guessedtype": "property", "type": "Number"}}, "namespace": "plugin", "module": "node-menunav", "events": {"mouseOutHideDelayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "mouseOutHideDelayChange", "description": "Fires when the value for the configuration attribute 'mouseOutHideDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "autoSubmenuDisplayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "autoSubmenuDisplayChange", "description": "Fires when the value for the configuration attribute 'autoSubmenuDisplay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "submenuShowDelayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "submenuShowDelayChange", "description": "Fires when the value for the configuration attribute 'submenuShowDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "submenuHideDelayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "submenuHideDelayChange", "description": "Fires when the value for the configuration attribute 'submenuHideDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "useARIAChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "useARIAChange", "description": "Fires when the value for the configuration attribute 'useARIA' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "NodeMenuNav", "methods": {"_showMenu": {"protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}], "description": "Shows the specified menu.", "guessedname": "_showMenu", "guessedtype": "function"}, "_hideAndFocusLabel": {"protected": "", "description": "Hides all of the submenus of the root menu and focuses the \nlabel of the topmost submenu", "guessedname": "_hideAndFocusLabel", "guessedtype": "function"}, "_onMouseOut": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseout\" event handler for the menu.", "guessedname": "_onMouseOut", "guessedtype": "function"}, "_hideMenu": {"protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}, {"type": "Boolean", "name": "activateAndFocusLabel", "description": " Boolean indicating if the label \nfor the specified \nmenu should be focused and set as active."}], "description": "Hides the specified menu.", "guessedname": "_hideMenu", "guessedtype": "function"}, "_toggleSubmenuDisplay": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mousedown,\" \"keydown,\" and \"click\" event handler for the \nmenu used to toggle the display of a submenu.", "guessedname": "_toggleSubmenuDisplay", "guessedtype": "function"}, "_onHorizontalMenuKeyDown": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"keydown\" event handler for horizontal menus.", "guessedname": "_onHorizontalMenuKeyDown", "guessedtype": "function"}, "_onVerticalMenuKeyDown": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"keydown\" event handler for vertical menus.", "guessedname": "_onVerticalMenuKeyDown", "guessedtype": "function"}, "_onMouseOver": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseover\" event handler for the menu.", "guessedname": "_onMouseOver", "guessedtype": "function"}, "_focusItem": {"protected": "", "params": [{"type": "Node", "name": "item", "description": " Node instance representing a menuitem or menu label."}], "description": "Focuses the specified menuitem or menu label.", "guessedname": "_focusItem", "guessedtype": "function"}, "_cancelHideSubmenuTimer": {"protected": "", "description": "Cancels the timer used to hide a submenu.", "guessedname": "_cancelHideSubmenuTimer", "guessedtype": "function"}, "_onActiveDescendantChange": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the Attribute change event."}, {"type": "NodeMenuNav", "name": "menuNav", "description": " Object representing the NodeMenuNav instance."}], "description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.", "guessedname": "_onActiveDescendantChange", "guessedtype": "function"}, "_onMenuLabelMouseOver": {"protected": "", "params": [{"type": "Node", "name": "menuLabel", "description": " Node instance representing a menu label."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseover\" event handler for a menu label.", "guessedname": "_onMenuLabelMouseOver", "guessedtype": "function"}, "_onDocMouseDown": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mousedown\" event handler for the owner document of \nthe menu.", "guessedname": "_onDocMouseDown", "guessedtype": "function"}, "_onMenuLabelMouseOut": {"protected": "", "params": [{"type": "Node", "name": "menuLabel", "description": " Node instance representing a menu label."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseout\" event handler for a menu label.", "guessedname": "_onMenuLabelMouseOut", "guessedtype": "function"}, "_afterActiveDescendantChange": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the Attribute change event."}, {"type": "NodeMenuNav", "name": "menuNav", "description": " Object representing the NodeMenuNav instance."}], "description": "\"activeDescendantChange\" event handler for menu's \nFocus Manager.", "guessedname": "_afterActiveDescendantChange", "guessedtype": "function"}, "_onMenuItemMouseOver": {"protected": "", "params": [{"type": "Node", "name": "menuItem", "description": " Node instance representing a menuitem."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseover\" event handler for a menuitem.", "guessedname": "_onMenuItemMouseOver", "guessedtype": "function"}, "_cancelShowSubmenuTimer": {"protected": "", "description": "Cancels the timer used to show a submenu.", "guessedname": "_cancelShowSubmenuTimer", "guessedtype": "function"}, "_isRoot": {"return": {"type": "Boolean", "description": "Boolean indicating if the specified menu is the root \nmenu in the menu."}, "description": "Returns a boolean indicating if the specified menu is the \nroot menu in the menu.", "protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}], "guessedname": "_isRoot", "guessedtype": "function"}, "_getTopmostSubmenu": {"return": {"type": "Node", "description": "Node instance representing a menu."}, "description": "Returns the topmost submenu of a submenu hierarchy.", "protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}], "guessedname": "_getTopmostSubmenu", "guessedtype": "function"}, "_clearActiveItem": {"protected": "", "description": "Clears the menu's active descendent.", "guessedname": "_clearActiveItem", "guessedtype": "function"}, "_onMouseMove": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mousemove\" event handler for the menu.", "guessedname": "_onMouseMove", "guessedtype": "function"}, "_onMenuItemMouseOut": {"protected": "", "params": [{"type": "Node", "name": "menuItem", "description": " Node instance representing a menuitem."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseout\" event handler for a menuitem.", "guessedname": "_onMenuItemMouseOut", "guessedtype": "function"}, "_onDocFocus": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"focus\" event handler for the owner document of the MenuNav.", "guessedname": "_onDocFocus", "guessedtype": "function"}, "_onMenuMouseOver": {"protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseover\" event handler for a menu.", "guessedname": "_onMenuMouseOver", "guessedtype": "function"}, "_hideAllSubmenus": {"protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}], "description": "Hides all submenus of the specified menu.", "guessedname": "_hideAllSubmenus", "guessedtype": "function"}, "_setActiveItem": {"protected": "", "params": [{"type": "Node", "name": "item", "description": " Node instance representing a menuitem or menu label."}], "description": "Sets the specified menuitem or menu label as the menu's \nactive descendent.", "guessedname": "_setActiveItem", "guessedtype": "function"}, "_initFocusManager": {"protected": "", "description": "Initializes and updates the Focus Manager so that is is \nalways managing descendants of the active menu.", "guessedname": "_initFocusManager", "guessedtype": "function"}, "_onKeyPress": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"keypress\" event handler for the menu.", "guessedname": "_onKeyPress", "guessedtype": "function"}, "_onMenuMouseOut": {"protected": "", "params": [{"type": "Node", "name": "menu", "description": " Node instance representing a menu."}, {"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"mouseout\" event handler for a menu.", "guessedname": "_onMenuMouseOut", "guessedtype": "function"}, "_onKeyDown": {"protected": "", "params": [{"type": "Object", "name": "event", "description": " Object representing the DOM event."}], "description": "\"keydown\" event handler for the menu.", "guessedname": "_onKeyDown", "guessedtype": "function"}}, "file": "node-menunav.js", "guessedtype": "function", "shortname": "NodeMenuNav", "properties": {"_hideAllSubmenusTimer": {"description": "Timer used to hide a all submenus.", "default": "null", "protected": "", "guessedname": "_hideAllSubmenusTimer", "guessedtype": "property", "type": "Object"}, "_blockMouseEvent": {"description": "Boolean indicating whether or not to handle the \n\"mouseover\" event.", "default": "false", "protected": "", "guessedname": "_blockMouseEvent", "guessedtype": "property", "type": "Boolean"}, "_activeMenu": {"description": "Node instance representing the menu that is the parent of \nthe menu's active descendent.", "default": "null", "protected": "", "guessedname": "_activeMenu", "guessedtype": "property", "type": "Node"}, "NodeMenuNav.SHIM_TEMPLATE_TITLE": {"default": "\"Menu Stacking Shim\"", "type": "String", "description": "String representing the value for the title \nattribute for the shim used to prevent <select> elements \nfrom poking through menus in IE 6.", "guessedname": "SHIM_TEMPLATE_TITLE", "guessedtype": "property"}, "_hasFocus": {"description": "Boolean indicating if the menu has focus.", "default": "false", "protected": "", "guessedname": "_hasFocus", "guessedtype": "property", "type": "Boolean"}, "_currentMouseX": {"description": "Number representing the current x coordinate of the mouse \ninside the menu.", "default": "0", "protected": "", "guessedname": "_currentMouseX", "guessedtype": "property", "type": "Number"}, "_hideSubmenuTimer": {"description": "Timer used to hide a submenu.", "default": "null", "protected": "", "guessedname": "_hideSubmenuTimer", "guessedtype": "property", "type": "Object"}, "_firstItem": {"description": "Node instance representing the first item (menuitem or menu \nlabel) in the root menu of a menu.", "default": "null", "protected": "", "guessedname": "_firstItem", "guessedtype": "property", "type": "Node"}, "_showSubmenuTimer": {"description": "Timer used to show a submenu.", "default": "null", "protected": "", "guessedname": "_showSubmenuTimer", "guessedtype": "property", "type": "Object"}, "_movingToSubmenu": {"description": "Boolean indicating if the mouse is moving from a menu \nlabel to its corresponding submenu.", "default": "false", "protected": "", "guessedname": "_movingToSubmenu", "guessedtype": "property", "type": "Boolean"}, "NodeMenuNav.SHIM_TEMPLATE": {"default": ""<iframe frameborder="0" tabindex="-1" \nclass="yui-shim" title="Menu Stacking Shim" \nsrc="javascript:false;"></iframe>"", "type": "String", "description": "String representing the HTML used to create the \n<iframe> shim used to prevent \n<select> elements from poking through menus in IE 6."}, "_activeItem": {"description": "Node instance representing the menu's active descendent: \nthe menuitem or menu label the user is currently interacting with.", "default": "null", "protected": "", "guessedname": "_activeItem", "guessedtype": "property", "type": "Node"}, "_rootMenu": {"description": "Node instance representing the root menu in the menu.", "default": "null", "protected": "", "guessedname": "_rootMenu", "guessedtype": "property", "type": "Node"}}, "description": "The NodeMenuNav class is a plugin for a Node instance. The class is used via \nthe plug method of Node and \nshould not be instantiated directly."}, "DataSchema.Base": {"name": "DataSchema.Base", "namespace": "", "module": "dataschema", "guessedname": "SchemaBase", "methods": {"parse": {"return": {"type": "Object", "description": "Type-converted value."}, "params": [{"type": "Object", "name": "value", "description": " Original value."}, {"type": "Object", "name": "field", "description": " Field."}], "description": "Applies field parser, if defined", "guessedname": "parse", "guessedtype": "function"}, "apply": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Overridable method returns data as-is.", "static": "", "guessedname": "apply", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to apply."}, {"type": "Object", "name": "data", "description": " Data."}]}}, "static": "", "file": "dataschema-base.js", "guessedtype": "property", "shortname": "DataSchema.Base", "description": "Base class for the YUI DataSchema Utility."}, "Do.Method": {"name": "Do.Method", "constructors": [{"params": [{"type": "", "name": "obj", "description": " The object to operate on"}, {"type": "", "name": "sFn", "description": " The name of the method to displace"}], "description": "Wrapper for a displaced method with aop enabled"}], "namespace": "", "module": "event-custom", "guessedname": "Method", "methods": {"register": {"params": [{"type": "string", "name": "sid", "description": " the subscriber id"}, {"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "string", "name": "when", "description": " when to execute the function"}], "description": "Register a aop subscriber", "guessedname": "register", "guessedtype": "function"}, "exec": {"description": "Execute the wrapped method", "guessedname": "exec", "guessedtype": "function"}, "delete": {"params": [{"type": "string", "name": "sid", "description": " the subscriber id"}, {"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "string", "name": "when", "description": " when to execute the function"}], "description": "Unregister a aop subscriber", "guessedname": "_delete", "guessedtype": "function"}}, "file": "event-do.js", "guessedtype": "function", "shortname": "Do.Method", "description": "Wrapper for a displaced method with aop enabled"}, "Node": {"name": "Node", "for": "Node", "description": "The Node class provides a wrapper for manipulating DOM Nodes.\nNode properties can be accessed via the set/get methods.\nUse Y.get() to retrieve Node instances.\nNOTE: Node properties are accessed using\nthe set and get methods.", "constructors": [{"description": "The Node class provides a wrapper for manipulating DOM Nodes.\nNode properties can be accessed via the set/get methods.\nUse Y.get() to retrieve Node instances.\nNOTE: Node properties are accessed using\nthe set and get methods."}], "namespace": "", "module": "node", "file": "node.js", "shortname": "Node", "configs": {"viewportRegion": {"type": "Node", "description": "Returns a region object for the node's viewport", "guessedname": "viewportRegion", "guessedtype": "property"}, "winWidth": {"type": "{Int}", "description": "Returns the inner width of the viewport (exludes scrollbar)."}, "text": {"type": "String", "description": "Allows for getting and setting the text of an element.\nFormatting is preserved and special characters are treated literally.", "guessedname": "text", "guessedtype": "property"}, "region": {"type": "Node", "description": "Returns a region object for the node", "guessedname": "region", "guessedtype": "property"}, "docScrollY": {"type": "{Int}", "description": "Amount page has been scroll horizontally"}, "docScrollX": {"type": "{Int}", "description": "Amount page has been scroll vertically"}, "winHeight": {"type": "{Int}", "description": "Returns the inner height of the viewport (exludes scrollbar)."}, "docHeight": {"type": "{Int}", "description": "Document height"}, "children": {"readonly": "", "type": "NodeList", "description": "Returns a NodeList instance of all HTMLElement children."}}, "methods": {"size": {"deprecated": "Use NodeList", "return": {"type": "Int", "description": "The number of items in the Node."}, "description": "Returns the current number of items in the Node.", "guessedname": "size", "guessedtype": "function"}, "appendChild": {"return": {"type": "Node", "description": "The appended node"}, "params": [{"type": "HTMLElement | Node", "name": "node", "description": " Node to be appended"}], "description": "Passes through to DOM method."}, "all": {"return": {"type": "NodeList", "description": "A NodeList instance for the matching HTMLCollection/Array."}, "params": [{"type": "string", "name": "selector", "description": " The CSS selector to test against."}], "description": "Retrieves a nodeList based on the given CSS selector.", "guessedname": "all", "guessedtype": "function"}, "set": {"chainable": "", "params": [{"type": "String", "name": "attr", "description": " The attribute to be set."}, {"type": "any", "name": "val", "description": " The value to set the attribute to."}], "description": "Sets an attribute on the Node instance.", "guessedname": "set", "guessedtype": "function"}, "getAttrs": {"return": {"type": "Object", "description": "An object with attribute name/value pairs."}, "params": [{"type": "Array", "name": "attrs", "description": " an array of attributes to get values"}], "description": "Returns an object containing the values for the requested attributes.", "guessedname": "getAttrs", "guessedtype": "function"}, "replaceChild": {"return": {"type": "Node", "description": "The replaced node"}, "params": [{"type": "HTMLElement | Node", "name": "node", "description": " Node to be inserted"}, {"type": "HTMLElement | Node", "name": "refNode", "description": " Node to be replaced"}], "description": "Passes through to DOM method."}, "removeAttribute": {"chainable": "", "params": [{"type": "String", "name": "attribute", "description": " The attribute to be removed"}], "description": "Passes through to DOM method."}, "getAttribute": {"return": {"type": "string", "description": "The attribute value"}, "params": [{"type": "string", "name": "name", "description": " The attribute name"}], "description": "Allows getting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes."}, "replaceClass": {"chainable": "", "params": [{"type": "String", "name": "oldClassName", "description": " the class name to be replaced"}, {"type": "String", "name": "newClassName", "description": " the class name that will be replacing the old class name"}], "description": "Replace a class with another class for each node.\nIf no oldClassName is present, the newClassName is simply added."}, "focus": {"chainable": "", "description": "Passes through to DOM method."}, "cloneNode": {"return": {"type": "Node", "description": "The clone"}, "params": [{"type": "Boolean", "name": "deep", "description": " Whether or not to perform a deep clone, which includes\nsubtree and attributes"}], "description": "Passes through to DOM method."}, "one": {"return": {"type": "Node", "description": "A Node instance for the matching HTMLElement."}, "params": [{"type": "string", "name": "selector", "description": " The CSS selector to test against."}], "description": "Retrieves a Node instance of nodes based on the given CSS selector.", "guessedname": "one", "guessedtype": "function"}, "getX": {"return": {"type": "Int", "description": "The X position of the node"}, "description": "Gets the current position of the node in page coordinates."}, "getY": {"return": {"type": "Int", "description": "The Y position of the node"}, "description": "Gets the current position of the node in page coordinates."}, "hasClass": {"return": {"type": "Array", "description": "An array of booleans for each node bound to the NodeList."}, "params": [{"type": "String", "name": "className", "description": " the class name to search for"}], "description": "Determines whether each node has the given className."}, "query": {"return": {"type": "Node", "description": "A Node instance for the matching HTMLElement."}, "description": "Retrieves a Node instance of nodes based on the given CSS selector.", "deprecated": "Use one()", "params": [{"type": "string", "name": "selector", "description": " The CSS selector to test against."}], "guessedname": "query", "guessedtype": "function"}, "prepend": {"chainable": "", "params": [{"type": "String | Y.Node | HTMLElement", "name": "content", "description": " The content to insert"}], "description": "Inserts the content as the firstChild of the node.", "guessedname": "prepend", "guessedtype": "function"}, "queryAll": {"return": {"type": "NodeList", "description": "A NodeList instance for the matching HTMLCollection/Array."}, "description": "Retrieves a nodeList based on the given CSS selector.", "deprecated": "Use all()", "params": [{"type": "string", "name": "selector", "description": " The CSS selector to test against."}], "guessedname": "queryAll", "guessedtype": "function"}, "select": {"chainable": "", "description": "Passes through to DOM method."}, "previous": {"return": {"type": "Node", "description": "Node instance or null if not found"}, "params": [{"type": "String | Function", "name": "fn", "description": " A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument."}], "description": "Returns the previous matching sibling. \nReturns the nearest element node sibling if no method provided.", "guessedname": "previous", "guessedtype": "function"}, "setStyles": {"chainable": "", "params": [{"type": "Object", "name": "hash", "description": " An object literal of property:value pairs."}], "description": "Sets multiple style properties on the node."}, "insertBefore": {"return": {"type": "Node", "description": "The inserted node"}, "params": [{"type": "HTMLElement | Node", "name": "newNode", "description": " Node to be appended"}, {"type": "HTMLElement | Node", "name": "refNode", "description": " Node to be inserted before"}], "description": "Passes through to DOM method."}, "item": {"return": {"type": "Node", "description": "The Node instance at the given index."}, "description": "Retrieves the Node instance at the given index.", "deprecated": "Use NodeList", "params": [{"type": "Number", "name": "index", "description": " The index of the target Node."}], "guessedname": "item", "guessedtype": "function"}, "toggleClass": {"chainable": "", "params": [{"type": "String", "name": "className", "description": " the class name to be toggled"}], "description": "If the className exists on the node it is removed, if it doesn't exist it is added."}, "setX": {"chainable": "", "params": [{"type": "Int", "name": "x", "description": " X value for new position (coordinates are page-based)"}], "description": "Set the position of the node in page coordinates, regardless of how the node is positioned."}, "Y.one": {"static": "", "params": [{"type": "String | HTMLElement", "name": "node", "description": " a node or Selector"}, {"type": "Y.Node || HTMLElement", "name": "doc", "description": " an optional document to scan. Defaults to Y.config.doc."}], "description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.", "guessedname": "one", "guessedtype": "function"}, "contains": {"return": {"type": "Boolean", "description": "Whether or not this node is the needle its ancestor"}, "params": [{"type": "Node | HTMLElement", "name": "needle", "description": " The possible node or descendent"}], "description": "Determines whether the ndoe is an ancestor of another HTML element in the DOM hierarchy."}, "getComputedStyle": {"return": {"type": "String", "description": "The computed value of the style property for the element."}, "params": [{"type": "String", "name": "attr", "description": " The style attribute to retrieve."}], "description": "Returns the computed value for the given style property."}, "submit": {"chainable": "", "description": "Passes through to DOM method.\nOnly valid on FORM elements"}, "next": {"return": {"type": "Node", "description": "Node instance or null if not found"}, "params": [{"type": "String | Function", "name": "fn", "description": " A selector or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument."}], "description": "Returns the next matching sibling. \nReturns the nearest element node sibling if no method provided.", "guessedname": "next", "guessedtype": "function"}, "hasChildNodes": {"return": {"type": "Boolean", "description": "Whether or not the node has any childNodes"}, "description": "Passes through to DOM method."}, "append": {"chainable": "", "params": [{"type": "String | Y.Node | HTMLElement", "name": "content", "description": " The content to insert"}], "description": "Inserts the content as the lastChild of the node.", "guessedname": "append", "guessedtype": "function"}, "intersect": {"return": {"type": "Object", "description": "An object representing the intersection of the regions."}, "params": [{"type": "Node|Object", "name": "node2", "description": " The node or region to compare with."}, {"type": "Object", "name": "altRegion", "description": " An alternate region to use (rather than this node's)."}], "description": "Compares the intersection of the node with another node or region", "guessedname": "intersect", "guessedtype": "function"}, "blur": {"chainable": "", "description": "Passes through to DOM method."}, "test": {"return": {"type": "boolean", "description": "Whether or not the node matches the selector."}, "params": [{"type": "string", "name": "selector", "description": " The CSS selector to test against."}], "description": "Test if the supplied node matches the supplied selector.", "guessedname": "test", "guessedtype": "function"}, "ancestor": {"return": {"type": "Node", "description": "The matching Node instance or null if not found"}, "params": [{"type": "String | Function", "name": "fn", "description": " A selector string or boolean method for testing elements.\nIf a function is used, it receives the current node being tested as the only argument."}], "description": "Returns the nearest ancestor that passes the test applied by supplied boolean method.", "guessedname": "ancestor", "guessedtype": "function"}, "inDoc": {"return": {"type": "Boolean", "description": "Whether or not this node is appended to the document."}, "params": [{"type": "Node|HTMLElement", "name": "doc", "description": " optional An optional document to check against.\nDefaults to current document."}], "description": "Determines whether the node is appended to the document.", "guessedname": "inDoc", "guessedtype": "function"}, "addClass": {"chainable": "", "params": [{"type": "String", "name": "className", "description": " the class name to add to the node's class attribute"}], "description": "Adds a class name to each node."}, "getXY": {"return": {"type": "Array", "description": "The XY position of the node"}, "description": "Gets the current position of the node in page coordinates."}, "removeClass": {"chainable": "", "params": [{"type": "String", "name": "className", "description": " the class name to remove from the node's class attribute"}], "description": "Removes a class name from each node."}, "Y.get": {"description": "Returns a single Node instance bound to the node or the\nfirst element matching the given selector.", "deprecated": "Use Y.one", "static": "", "guessedname": "get", "guessedtype": "function", "params": [{"type": "String | HTMLElement", "name": "node", "description": " a node or Selector"}, {"type": "Y.Node || HTMLElement", "name": "doc", "description": " an optional document to scan. Defaults to Y.config.doc."}]}, "get": {"return": {"type": "any", "description": "The current value of the attribute"}, "params": [{"type": "String", "name": "attr", "description": " The attribute to be set"}], "description": "Returns an attribute value on the Node instance", "guessedname": "get", "guessedtype": "function"}, "setContent": {"chainable": "", "params": [{"type": "String | Y.Node | HTMLElement", "name": "content", "description": " The content to insert"}], "description": "Replaces the node's current content with the content.", "guessedname": "setContent", "guessedtype": "function"}, "getElementsByTagName": {"return": {"type": "NodeList", "description": "A NodeList representing the HTMLCollection"}, "params": [{"type": "String", "name": "tagName", "description": " The tagName to collect"}], "description": "Passes through to DOM method."}, "each": {"description": "Applies the given function to each Node in the NodeList.", "deprecated": "Use NodeList", "chainable": "", "params": [{"type": "Function", "name": "fn", "description": " The function to apply"}, {"type": "Object", "name": "context", "description": " optional An optional context to apply the function with\nDefault context is the NodeList instance"}], "guessedname": "each", "guessedtype": "function"}, "setAttrs": {"chainable": "", "params": [{"type": "Object", "name": "attrMap", "description": " an object of name/value pairs to set"}], "description": "Sets multiple attributes.", "guessedname": "setAttrs", "guessedtype": "function"}, "getStyle": {"return": {"type": "String", "description": "The current value of the style property for the element."}, "params": [{"type": "String", "name": "attr", "description": " The style attribute to retrieve."}], "description": "Returns the style's current value."}, "hasAttribute": {"return": {"type": "Boolean", "description": "Whether or not the attribute is present"}, "params": [{"type": "String", "name": "attribute", "description": " The attribute to test for"}], "description": "Passes through to DOM method."}, "simulate": {"return": {"type": "void", "description": ""}, "description": "Simulates an event on the node.", "static": "", "guessedname": "simulate", "guessedtype": "function", "params": [{"type": "String", "name": "type", "description": " The type of event to simulate (i.e., \"click\")."}, {"type": "Object", "name": "options", "description": " (Optional) Extra options to copy onto the event object."}]}, "setStyle": {"chainable": "", "params": [{"type": "String", "name": "attr", "description": " The style attribute to set."}, {"type": "String|Number", "name": "val", "description": " The value."}], "description": "Sets a style property of the node."}, "replace": {"chainable": "", "description": "Replace the node with the other node. This is a DOM update only\nand does not change the node bound to the Node instance.\nShortcut for myNode.get('parentNode').replaceChild(newNode, myNode);", "guessedname": "replace", "guessedtype": "function"}, "invoke": {"return": {"type": "", "description": "Whatever the underly method returns. \nDOM Nodes and Collections return values\nare converted to Node/NodeList instances."}, "params": [{"type": "String", "name": "method", "description": " The name of the method to invoke"}, {"type": "Any", "name": "a,", "description": " b, c, etc. Arguments to invoke the method with."}], "description": "Invokes a method on the Node instance", "guessedname": "invoke", "guessedtype": "function"}, "setY": {"chainable": "", "params": [{"type": "Int", "name": "y", "description": " Y value for new position (coordinates are page-based)"}], "description": "Set the position of the node in page coordinates, regardless of how the node is positioned."}, "reset": {"chainable": "", "description": "Passes through to DOM method.\nOnly valid on FORM elements"}, "insert": {"chainable": "", "params": [{"type": "String | Y.Node | HTMLElement", "name": "content", "description": " The content to insert"}, {"type": "Int | Y.Node | HTMLElement | String", "name": "where", "description": " The position to insert at."}], "description": "Inserts the content before the reference node.", "guessedname": "insert", "guessedtype": "function"}, "scrollIntoView": {"chainable": "", "description": "Passes through to DOM method."}, "setAttribute": {"chainable": "", "params": [{"type": "string", "name": "name", "description": " The attribute name"}, {"type": "string", "name": "value", "description": " The value to set"}], "description": "Allows setting attributes on DOM nodes, normalizing in some cases.\nThis passes through to the DOM node, allowing for custom attributes."}, "remove": {"chainable": "", "description": "Removes the node from its parent.\nShortcut for myNode.get('parentNode').removeChild(myNode);", "guessedname": "remove", "guessedtype": "function"}, "removeChild": {"return": {"type": "Node", "description": "The removed node"}, "params": [{"type": "HTMLElement | Node", "name": "node", "description": " Node to be removed"}], "description": "Passes through to DOM method."}, "delegate": {"return": {"type": "Event.Handle", "description": "the detach handle"}, "params": [{"type": "String", "name": "type", "description": " the event type to delegate"}, {"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "String", "name": "selector", "description": " a selector that must match the target of the event."}], "description": "Functionality to make the node a delegated event container", "guessedname": "delegate", "guessedtype": "function"}, "compareTo": {"return": {"type": "Boolean", "description": "True if the nodes match, false if they do not."}, "params": [{"type": "HTMLElement | Node", "name": "refNode", "description": " The reference node to compare to the node."}], "description": "Compares nodes to determine if they match.\nNode instances can be compared to each other and/or HTMLElements.", "guessedname": "compareTo", "guessedtype": "function"}, "Node.getDOMNode": {"return": {"type": "HTMLNode", "description": "The DOM node bound to the Node instance. If a DOM node is passed\nas the node argument, it is simply returned."}, "description": "Retrieves the DOM node bound to a Node instance", "static": "", "guessedname": "getDOMNode", "guessedtype": "function", "params": [{"type": "Y.Node || HTMLNode", "name": "node", "description": " The Node instance or an HTMLNode"}]}, "setXY": {"chainable": "", "params": [{"type": "Array", "name": "xy", "description": " Contains X & Y values for new position (coordinates are page-based)"}], "description": "Set the position of the node in page coordinates, regardless of how the node is positioned."}, "create": {"return": {"type": "Node", "description": "A Node instance bound to a DOM node or fragment"}, "description": "Creates a new dom node using the provided markup string.", "param": "{String} html The markup used to create the element", "static": "", "guessedname": "create", "guessedtype": "function", "params": [{"type": "String", "name": "html", "description": " The markup used to create the element"}, {"type": "HTMLDocument", "name": "doc", "description": " An optional document context"}]}, "inRegion": {"return": {"type": "Object", "description": "An object representing the intersection of the regions."}, "params": [{"type": "Node|Object", "name": "node2", "description": " The node or region to compare with."}, {"type": "Boolean", "name": "all", "description": " Whether or not all of the node must be in the region."}, {"type": "Object", "name": "altRegion", "description": " An alternate region to use (rather than this node's)."}], "description": "Determines whether or not the node is within the giving region.", "guessedname": "inRegion", "guessedtype": "function"}}}, "Test.Runner": {"name": "Test.Runner", "namespace": "Test", "module": "test", "events": {"testcasebegin": {"static": "", "description": "Fires when a test case is opened but before the first \ntest is executed.", "guessedname": "TEST_CASE_BEGIN_EVENT", "guessedtype": "property"}, "testcasecomplete": {"static": "", "description": "Fires when all tests in a test case have been executed.", "guessedname": "TEST_CASE_COMPLETE_EVENT", "guessedtype": "property"}, "begin": {"static": "", "description": "Fires when the run() method is called.", "guessedname": "BEGIN_EVENT", "guessedtype": "property"}, "ignore": {"static": "", "description": "Fires when a test has been ignored.", "guessedname": "TEST_IGNORE_EVENT", "guessedtype": "property"}, "testsuitebegin": {"static": "", "description": "Fires when a test suite is opened but before the first \ntest is executed.", "guessedname": "TEST_SUITE_BEGIN_EVENT", "guessedtype": "property"}, "testsuitecomplete": {"static": "", "description": "Fires when all test cases in a test suite have been\ncompleted.", "guessedname": "TEST_SUITE_COMPLETE_EVENT", "guessedtype": "property"}, "pass": {"static": "", "description": "Fires when a test has passed.", "guessedname": "TEST_PASS_EVENT", "guessedtype": "property"}, "fail": {"static": "", "description": "Fires when a test has failed.", "guessedname": "TEST_FAIL_EVENT", "guessedtype": "property"}, "complete": {"static": "", "description": "Fires when all test suites and test cases have been completed.", "guessedname": "COMPLETE_EVENT", "guessedtype": "property"}}, "methods": {"disableLogging": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Disable logging via Y.log(). Test output will not be visible unless\nTestRunner events are subscribed to.", "guessedname": "disableLogging", "guessedtype": "function"}, "_run": {"return": {"type": "Object", "description": "Results of the execution with properties passed, failed, and total."}, "description": "Runs a test case or test suite, returning the results.", "private": "", "static": "", "guessedname": "_run", "guessedtype": "function", "params": [{"type": "Y.Test.Case|Y.Test.Suite", "name": "testObject", "description": " The test case or test suite to run."}]}, "run": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Runs the test suite.", "guessedname": "run", "guessedtype": "function"}, "resume": {"return": {"type": "Void", "description": ""}, "description": "Resumes the TestRunner after wait() was called.", "static": "", "guessedname": "resume", "guessedtype": "function", "params": [{"type": "Function", "name": "segment", "description": " The function to run as the rest\nof the haulted test."}]}, "_logEvent": {"return": {"type": "Void", "description": ""}, "description": "Logs TestRunner events using Y.log().", "private": "", "static": "", "guessedname": "_logEvent", "guessedtype": "function", "params": [{"type": "Object", "name": "event", "description": " The event object for the event."}]}, "_addTestCaseToTestTree": {"return": {"type": "Void", "description": ""}, "description": "Adds a test case to the test tree as a child of the specified node.", "private": "", "static": "", "guessedname": "_addTestCaseToTestTree", "guessedtype": "function", "params": [{"type": "TestNode", "name": "parentNode", "description": " The node to add the test case to as a child."}, {"type": "Y.Test.Case", "name": "testCase", "description": " The test case to add."}]}, "clear": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Removes all test objects from the runner.", "guessedname": "clear", "guessedtype": "function"}, "enableLogging": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Enable logging via Y.log(). Test output is published and can be read via\nlogreader.", "guessedname": "enableLogging", "guessedtype": "function"}, "_buildTestTree": {"return": {"type": "Void", "description": ""}, "description": "Builds the test tree based on items in the master suite. The tree is a hierarchical\nrepresentation of the test suites, test cases, and test functions. The resulting tree\nis stored in _root and the pointer _cur is set to the root initially.", "private": "", "static": "", "guessedname": "_buildTestTree", "guessedtype": "function"}, "_addTestSuiteToTestTree": {"return": {"type": "Void", "description": ""}, "description": "Adds a test suite to the test tree as a child of the specified node.", "private": "", "static": "", "guessedname": "_addTestSuiteToTestTree", "guessedtype": "function", "params": [{"type": "TestNode", "name": "parentNode", "description": " The node to add the test suite to as a child."}, {"type": "Y.Test.Suite", "name": "testSuite", "description": " The test suite to add."}]}, "_handleTestObjectComplete": {"return": {"type": "Void", "description": ""}, "description": "Handles the completion of a test object's tests. Tallies test results \nfrom one level up to the next.", "private": "", "params": [{"type": "TestNode", "name": "node", "description": " The TestNode representing the test object."}], "guessedname": "_handleTestObjectComplete", "guessedtype": "function"}, "add": {"return": {"type": "Void", "description": ""}, "description": "Adds a test suite or test case to the list of test objects to run.", "static": "", "guessedname": "add", "guessedtype": "function", "params": [{"type": "", "name": "testObject", "description": " Either a TestCase or a TestSuite that should be run."}]}, "isWaiting": {"static": "", "return": {"type": "Boolean", "description": "True if the TestRunner is waiting, false if not."}, "description": "Indicates if the TestRunner is waiting for a test to resume", "guessedname": "isWaiting", "guessedtype": "function"}, "_next": {"return": {"type": "TestNode", "description": "The next node in the test tree or null if the end is reached."}, "description": "Retrieves the next node in the test tree.", "private": "", "static": "", "guessedname": "_next", "guessedtype": "function"}, "_handleError": {"return": {"type": "Void", "description": ""}, "description": "Handles an error as if it occurred within the currently executing\ntest. This is for mock methods that may be called asynchronously\nand therefore out of the scope of the TestRunner. Previously, this\nerror would bubble up to the browser. Now, this method is used\nto tell TestRunner about the error. This should never be called\nby anyplace other than the Mock object.", "private": "", "static": "", "guessedname": "_handleError", "guessedtype": "function", "params": [{"type": "Error", "name": "error", "description": " The error object."}]}, "_runTest": {"return": {"type": "Void", "description": ""}, "description": "Runs a single test based on the data provided in the node.", "private": "", "static": "", "guessedname": "_runTest", "guessedtype": "function", "params": [{"type": "TestNode", "name": "node", "description": " The TestNode representing the test to run."}], "name": "_runTest"}}, "static": "", "file": "TestRunner.js", "shortname": "Runner", "properties": {"_waiting": {"description": "Indicates if the TestRunner is waiting as a result of\nwait() being called.", "private": "", "static": "", "guessedname": "_waiting", "guessedtype": "property", "type": "Boolean"}, "_root": {"description": "Pointer to the root node in the test tree.", "private": "", "static": "", "guessedname": "_root", "guessedtype": "property", "type": "TestNode"}, "_cur": {"description": "Pointer to the current node in the test tree.", "private": "", "static": "", "guessedname": "_cur", "guessedtype": "property", "type": "TestNode"}, "masterSuite": {"type": "Y.Test.Suite", "static": "", "description": "Suite on which to attach all TestSuites and TestCases to be run.", "private": ""}, "_log": {"description": "Indicates if the TestRunner will log events or not.", "private": "", "static": "", "guessedname": "_log", "guessedtype": "property", "type": "Boolean"}}, "description": "Runs test suites and test cases, providing events to allowing for the\ninterpretation of test results."}, "Get": {"name": "Get", "namespace": "", "module": "yui", "guessedname": "Get", "methods": {"_purge": {"private": "", "description": "Removes the nodes for the specified queue", "guessedname": "_purge", "guessedtype": "function"}, "_finalize": {"description": "Called by the the helper for detecting script load in Safari", "private": "", "static": "", "guessedname": "_finalize", "guessedtype": "function", "params": [{"type": "string", "name": "id", "description": " the transaction id"}]}, "_autoPurge": {"private": "", "description": "Removes processed queues and corresponding nodes", "guessedname": "_autoPurge", "guessedtype": "function"}, "_finish": {"guessedname": "_finish", "params": [{"type": "string", "name": "id", "description": " the id of the request"}], "description": "The request is complete, so executing the requester's callback", "private": "", "guessedtype": "function"}, "_linkNode": {"return": {"type": "HTMLElement", "description": "the generated node"}, "description": "Generates a link node", "private": "", "params": [{"type": "string", "name": "url", "description": " the url for the css file"}, {"type": "Window", "name": "win", "description": " optional window to create the node in"}, {"type": "", "name": "attributes", "description": " optional attributes collection to apply to the new node"}], "guessedname": "_linkNode", "guessedtype": "function"}, "script": {"return": {"type": "tId: string", "description": "an object containing info about the transaction"}, "description": "Fetches and inserts one or more script nodes into the head\nof the current document or the document in a specified window.", "static": "", "guessedname": "script", "guessedtype": "function", "params": [{"type": "string|string[]", "name": "url", "description": " the url or urls to the script(s)"}, {"type": "object", "name": "opts", "description": " Options: \n
\n
onSuccess
\n
\ncallback to execute when the script(s) are finished loading\nThe callback receives an object back with the following\ndata:\n
\n
win
\n
the window the script(s) were inserted into
\n
data
\n
the data object passed in when the request was made
\n
nodes
\n
An array containing references to the nodes that were\ninserted
\n
purge
\n
A function that, when executed, will remove the nodes\nthat were inserted
\n
\n
\n
\n
onTimeout
\n
\ncallback to execute when a timeout occurs.\nThe callback receives an object back with the following\ndata:\n
\n
win
\n
the window the script(s) were inserted into
\n
data
\n
the data object passed in when the request was made
\n
nodes
\n
An array containing references to the nodes that were\ninserted
\n
purge
\n
A function that, when executed, will remove the nodes\nthat were inserted
\n
\n
\n
\n
onEnd
\n
a function that executes when the transaction finishes, regardless of the exit path
\n
onFailure
\n
\ncallback to execute when the script load operation fails\nThe callback receives an object back with the following\ndata:\n
\n
win
\n
the window the script(s) were inserted into
\n
data
\n
the data object passed in when the request was made
\n
nodes
\n
An array containing references to the nodes that were\ninserted successfully
\n
purge
\n
A function that, when executed, will remove any nodes\nthat were inserted
\n
\n
\n
\n
context
\n
the execution context for the callbacks
\n
win
\n
a window other than the one the utility occupies
\n
autopurge
\n
\nsetting to true will let the utilities cleanup routine purge \nthe script once loaded\n
\n
purgethreshold
\n
\nThe number of transaction before autopurge should be initiated\n
\n
data
\n
\ndata that is supplied to the callback when the script(s) are\nloaded.\n
\n
insertBefore
\n
node or node id that will become the new node's nextSibling
\n
\n
charset
\n
Node charset, default utf-8 (deprecated, use the attributes config)
\n
attributes
\n
An object literal containing additional attributes to add to the link tags
\n
timeout
\n
Number of milliseconds to wait before aborting and firing the timeout event
\n
\n Y.Get.script(\n [\"http://yui.yahooapis.com/2.5.2/build/yahoo/yahoo-min.js\",\n \"http://yui.yahooapis.com/2.5.2/build/event/event-min.js\"], {\n onSuccess: function(o) {\n this.log(\"won't cause error because Y is the context\");\n Y.log(o.data); // foo\n Y.log(o.nodes.length === 2) // true\n // o.purge(); // optionally remove the script nodes immediately\n },\n onFailure: function(o) {\n Y.log(\"transaction failed\");\n },\n onTimeout: function(o) {\n Y.log(\"transaction timed out\");\n },\n data: \"foo\",\n timeout: 10000, // 10 second timeout\n context: Y, // make the YUI instance\n // win: otherframe // target another window/frame\n autopurge: true // allow the utility to choose when to remove the nodes\n purgetheshold: 1 // purge previous transaction before next transaction\n });\n
"}]}, "_end": {"guessedname": "_end", "params": [{"type": "string", "name": "id", "description": " the id of the request"}], "description": "The transaction is finished", "private": "", "guessedtype": "function"}, "_returnData": {"private": "", "description": "Returns the data payload for callback functions", "guessedname": "_returnData", "guessedtype": "function"}, "queue": {"guessedname": "_queue", "params": [{"type": "string", "name": "type", "description": " the type of node to insert"}, {"type": "string", "name": "url", "description": " the url to load"}, {"type": "", "name": "opts", "description": " the hash of options for this request"}], "description": "Saves the state for the request and begins loading\nthe requested urls", "private": "", "guessedtype": "function"}, "_scriptNode": {"return": {"type": "HTMLElement", "description": "the generated node"}, "description": "Generates a script node", "private": "", "params": [{"type": "string", "name": "url", "description": " the url for the script file"}, {"type": "Window", "name": "win", "description": " optional window to create the node in"}, {"type": "", "name": "attributes", "description": " optional attributes collection to apply to the new node"}], "guessedname": "_scriptNode", "guessedtype": "function"}, "_node": {"return": {"type": "HTMLElement", "description": "the generated node"}, "description": "Generates an HTML element, this is not appended to a document", "private": "", "params": [{"type": "string", "name": "type", "description": " the type of element"}, {"type": "string", "name": "attr", "description": " the attributes"}, {"type": "Window", "name": "win", "description": " optional window to create the element in"}], "guessedname": "_node", "guessedtype": "function"}, "abort": {"static": "", "params": [{"type": "string|object", "name": "o", "description": " Either the tId or the object returned from\nscript() or css()"}], "description": "Abort a transaction", "guessedname": "abort", "guessedtype": "function"}, "_next": {"guessedname": "_next", "params": [{"type": "string", "name": "id", "description": " the id of the request"}, {"type": "string", "name": "loaded", "description": " the url that was just loaded, if any"}], "description": "Loads the next item for a given request", "private": "", "guessedtype": "function"}, "_timeout": {"guessedname": "_timeout", "params": [{"type": "string", "name": "id", "description": " the id of the request"}], "description": "Timeout detected", "private": "", "guessedtype": "function"}, "_track": {"guessedname": "_track", "params": [{"type": "string", "name": "type", "description": " the type of node to track"}, {"type": "HTMLElement", "name": "n", "description": " the node to track"}, {"type": "string", "name": "id", "description": " the id of the request"}, {"type": "string", "name": "url", "description": " the url that is being loaded"}, {"type": "Window", "name": "win", "description": " the targeted window"}, {"type": "", "name": "qlength", "description": " the number of remaining items in the queue,\nincluding this one"}, {"type": "Function", "name": "trackfn", "description": " function to execute when finished\nthe default is _next"}], "description": "Detects when a node has been loaded. In the case of\nscript nodes, this does not guarantee that contained\nscript is ready to use.", "private": "", "guessedtype": "function"}, "css": {"return": {"type": "tId: string", "description": "an object containing info about the transaction"}, "description": "Fetches and inserts one or more css link nodes into the \nhead of the current document or the document in a specified\nwindow.", "static": "", "guessedname": "css", "guessedtype": "function", "params": [{"type": "string", "name": "url", "description": " the url or urls to the css file(s)"}, {"type": "", "name": "opts", "description": " Options: \n
\n
onSuccess
\n
\ncallback to execute when the css file(s) are finished loading\nThe callback receives an object back with the following\ndata:\n
win
\n
the window the link nodes(s) were inserted into
\n
data
\n
the data object passed in when the request was made
\n
nodes
\n
An array containing references to the nodes that were\ninserted
\n
purge
\n
A function that, when executed, will remove the nodes\nthat were inserted
\n
\n
\n\n
context
\n
the execution context for the callbacks
\n
win
\n
a window other than the one the utility occupies
\n
data
\n
\ndata that is supplied to the callbacks when the nodes(s) are\nloaded.\n
\n
insertBefore
\n
node or node id that will become the new node's nextSibling
\n
charset
\n
Node charset, default utf-8 (deprecated, use the attributes config)
\n
attributes
\n
An object literal containing additional attributes to add to the link tags
\n Y.Get.css(\n [\"http://yui.yahooapis.com/2.3.1/build/menu/assets/skins/sam/menu.css\",\n \"http://yui.yahooapis.com/2.3.1/build/logger/assets/skins/sam/logger.css\"], {\n insertBefore: 'custom-styles' // nodes will be inserted before the specified node\n });\n
"}]}}, "static": "", "file": "get.js", "guessedtype": "function", "shortname": "Get", "properties": {"queues": {"private": "", "description": "hash of queues to manage multiple requests", "guessedname": "queues", "guessedtype": "property"}, "qidx": {"guessedname": "qidx", "type": "int", "description": "queue index used to generate transaction ids", "private": "", "guessedtype": "property"}, "PURGE_THRESH": {"description": "The number of request required before an automatic purge.\nCan be configured via the 'purgethreshold' config\nproperty PURGE_THRESH", "default": "20", "private": "", "static": "", "guessedname": "PURGE_THRESH", "guessedtype": "property", "type": "int"}, "purging": {"guessedname": "purging", "type": "boolean", "description": "interal property used to prevent multiple simultaneous purge \nprocesses", "private": "", "guessedtype": "property"}}, "description": "Fetches and inserts one or more script or link nodes into the document"}, "WidgetPositionExt": {"name": "WidgetPositionExt", "namespace": "", "module": "widget-position-ext", "events": {"alignChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "alignChange", "description": "Fires when the value for the configuration attribute 'align' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "centeredChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "centeredChange", "description": "Fires when the value for the configuration attribute 'centered' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"centered": {"default": "false", "type": "{boolean | node}", "description": "A convenience attribute, which can be used as a shortcut for the align attribute.\nIf set to true, the Widget is centered in the viewport. If set to a node reference or valid selector string,\nthe Widget will be centered within the node. If set the false, no center positioning is applied.", "guessedname": "centered", "guessedtype": "property"}, "align": {"default": "null", "type": "Object", "desciption": "The align attribute is used to align a reference point on the widget, with the refernce point on another node, or the viewport. \nThe object which align expects has the following properties:\n
\n
node
\n
\nThe node to which the Widget is to be aligned. If set to null, or not provided, the Widget is aligned to the viewport\n
\n
points
\n
\n
\nA two element array, defining the two points on the Widget and node/viewport which are to be aligned. The first element is the point on the Widget, and the second element is the point on the node/viewport.\nSupported alignment points are defined as static properties on WidgetPositionExt.\n
\n
\ne.g. [WidgetPositionExt.TR, WidgetPositionExt.TL] aligns the Top-Right corner of the Widget with the\nTop-Left corner of the node/viewport, and [WidgetPositionExt.CC, WidgetPositionExt.TC] aligns the Center of the \nWidget with the Top-Center edge of the node/viewport.\n
\n
\n
", "guessedname": "align", "guessedtype": "property"}}, "methods": {"_doAlign": {"guessedname": "_doAlign", "params": [{"type": "String", "name": "widgetPoint", "description": " Supported point constant (e.g. WidgetPositionExt.TL)"}, {"type": "Number", "name": "x", "description": " X page co-ordinate to align to"}, {"type": "Number", "name": "y", "description": " Y page co-ordinate to align to"}], "description": "Helper method, used to align the given point on the widget, with the XY page co-ordinates provided.", "private": "", "guessedtype": "function"}, "_syncUIPosExtras": {"protected": "", "description": "Synchronizes the UI to match the Widgets extended positioning state.\nThis method in invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.", "guessedname": "_syncUIPosExtras", "guessedtype": "function"}, "centered": {"params": [{"type": "Node | String", "name": "node", "description": " Optional. A node reference or selector string defining the node \ninside which the Widget is to be centered. If not passed in, the Widget will be centered in the \nviewport."}], "description": "Centers the container in the viewport, or if a node is passed in,\nthe node.", "guessedname": "centered", "guessedtype": "function"}, "align": {"params": [{"type": "Node | String | null", "name": "node", "description": " A reference (or selector string) for the Node which with the Widget is to be aligned.\nIf null is passed in, the Widget will be aligned with the viewport."}, {"type": "Array[2]", "name": "points", "description": " A two element array, specifying the points on the Widget and node/viewport which need to be aligned. \nThe first entry is the point on the Widget, and the second entry is the point on the node/viewport which need to align.\nValid point references are defined as static constants on the WidgetPositionExt class. \ne.g. [WidgetPositionExt.TL, WidgetPositionExt.TR] will align the top-left corner of the Widget with the top-right corner of the node/viewport."}], "description": "Aligns the Widget to the provided node (or viewport) using the provided\npoints. The method can be invoked directly, however it will result in \nthe align attribute being out of sync with current position of the of Widget.", "guessedname": "align", "guessedtype": "function"}, "_setAlignCenter": {"return": {"type": "Number", "description": "The attribute value being set."}, "description": "Default setter for center attribute changes. Sets up the appropriate value, and passes \nit through the to the align attribute.", "protected": "", "params": [{"type": "boolean | node", "name": "The", "description": " attribute value being set."}], "guessedname": "_setAlignCenter", "guessedtype": "function"}, "_bindUIStack": {"protected": "", "description": "Binds event listeners responsible for updating the UI state in response to \nWidget extended positioning related state changes.\n
\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_bindUIPosExtras", "guessedtype": "function"}, "_uiSetAlign": {"protected": "", "params": [{"type": "Node | null", "name": "The", "description": " node to align to, or null to indicate the viewport"}], "description": "Updates the UI to reflect the align value passed in (see the align attribute documentation, for the object stucture expected)", "guessedname": "_uiSetAlign", "guessedtype": "function"}, "_afterAlignChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the align attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterAlignChange", "guessedtype": "function"}}, "param": "{Object} User configuration object", "file": "Widget-PositionExt.js", "shortname": "WidgetPositionExt", "properties": {"WidgetPositionExt.CC": {"description": "Constant used to specify the center of widget/node/viewport for alignment", "value": "\"cc\"", "static": "", "guessedname": "CC", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.BC": {"description": "Constant used to specify the bottom edge, center point for alignment", "value": "\"bc\"", "static": "", "guessedname": "BC", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.TC": {"description": "Constant used to specify the top edge-center point for alignment", "value": "\"tc\"", "static": "", "guessedname": "TC", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.TL": {"description": "Constant used to specify the top-left corner for alignment", "value": "\"tl\"", "static": "", "guessedname": "TL", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.BL": {"description": "Constant used to specify the bottom-left corner for alignment", "value": "\"bl\"", "static": "", "guessedname": "BL", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.LC": {"description": "Constant used to specify the left edge, center point for alignment", "value": "\"lc\"", "static": "", "guessedname": "LC", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute \nconfiguration introduced by WidgetPositionExt.", "guessedname": "ATTRS", "guessedtype": "property"}, "WidgetPositionExt.BR": {"description": "Constant used to specify the bottom-right corner for alignment", "value": "\"br\"", "static": "", "guessedname": "BR", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.RC": {"description": "Constant used to specify the right edge, center point for alignment", "value": "\"rc\"", "static": "", "guessedname": "RC", "guessedtype": "property", "type": "String"}, "WidgetPositionExt.TR": {"description": "Constant used to specify the top-right corner for alignment", "value": "\"tr\"", "static": "", "guessedname": "TR", "guessedtype": "property", "type": "String"}}, "description": "Widget extension, which can be used to add extended XY positioning support to the base Widget class,\nthrough the Base.build method. This extension requires that \nthe WidgetPosition extension be added to the Widget (before WidgetPositionExt, if part of the same \nextension list passed to Base.build)."}, "JSON": {"methods": {"parse": {"return": {"type": "MIXED", "description": "the native JavaScript representation of the JSON string"}, "static": "", "params": [{"type": "string", "name": "s", "description": " JSON string data"}, {"type": "function", "name": "reviver", "description": " (optional) function(k,v) passed each key value\npair of object literals, allowing pruning or altering values"}], "description": "Parse a JSON string, returning the native JavaScript representation.", "throws": "SyntaxError"}, "stringify": {"return": {"type": "string", "description": "JSON string representation of the input"}, "description": "
Converts an arbitrary value to a JSON string representation.
\n
Objects with cyclical references will trigger an exception.
\n
If a whitelist is provided, only matching object keys will be\nincluded. Alternately, a replacer function may be passed as the\nsecond parameter. This function is executed on every value in the\ninput, and its return value will be used in place of the original value.\nThis is useful to serialize specialized objects or class instances.
\n
If a positive integer or non-empty string is passed as the third\nparameter, the output will be formatted with carriage returns and\nindentation for readability. If a String is passed (such as \"\\t\") it\nwill be used once for each indentation level. If a number is passed,\nthat number of spaces will be used.
", "static": "", "guessedname": "stringify", "guessedtype": "function", "params": [{"type": "MIXED", "name": "o", "description": " any arbitrary value to convert to JSON string"}, {"type": "Array|Function", "name": "w", "description": " (optional) whitelist of acceptable object\nkeys to include, or a replacer function to modify the\nraw value before serialization"}, {"type": "Number|String", "name": "ind", "description": " (optional) indentation character or depth of\nspaces to format the output."}]}, "escapeException": {"return": {"type": "String", "description": "the \\unnnn escapement of the character"}, "description": "Replaces specific unicode characters with their appropriate \\unnnn\nformat. Some browsers ignore certain characters during eval.", "private": "", "params": [{"type": "String", "name": "c", "description": " Unicode character"}], "guessedname": "_escapeException", "guessedtype": "function"}, "dateToString": {"return": {"type": "String", "description": "stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ"}, "description": "Serializes a Date instance as a UTC date string. Used internally by\nstringify. Override this method if you need Dates serialized in a\ndifferent format.", "static": "", "guessedname": "dateToString", "guessedtype": "function", "params": [{"type": "Date", "name": "d", "description": " The Date to serialize"}]}, "_revive": {"return": {"type": "MIXED", "description": "The results of the filtered data"}, "description": "Traverses nested objects, applying a reviver function to each (key,value)\nfrom the scope if the key:value's containing object. The value returned\nfrom the function will replace the original value in the key:value pair.\nIf the value returned is undefined, the key will be omitted from the\nreturned object.", "private": "", "params": [{"type": "MIXED", "name": "data", "description": " Any JavaScript data"}, {"type": "Function", "name": "reviver", "description": " filter or mutation function"}], "guessedname": "_revive", "guessedtype": "function"}}, "description": "
The JSON module adds support for serializing JavaScript objects into\nJSON strings and parsing JavaScript objects from strings in JSON format.
\n
The JSON namespace is added to your YUI instance including static methods\nY.JSON.parse(..) and Y.JSON.stringify(..).
\n
The functionality and method signatures follow the ECMAScript 5\nspecification. In browsers with native JSON support, the native\nimplementation is used.
\n
The json module is a rollup of json-parse and\njson-stringify.
\n
As their names suggest, json-parse adds support for parsing\nJSON data (Y.JSON.parse) and json-stringify for serializing\nJavaScript data into JSON strings (Y.JSON.stringify). You may choose to\ninclude either of the submodules individually if you don't need the\ncomplementary functionality, or include the rollup for both.
", "namespace": "", "module": "json", "static": "", "file": "json-parse.js", "shortname": "JSON", "properties": {"_BRACKETS": {"guessedname": "_BRACKETS", "type": "{RegExp}", "description": "Third step in the safety evaluation. Regex used to remove all open\nsquare brackets following a colon, comma, or at the beginning of the\nstring.", "private": "", "guessedtype": "property"}, "_UNICODE_EXCEPTIONS": {"guessedname": "_UNICODE_EXCEPTIONS", "type": "{RegExp}", "description": "Replace certain Unicode characters that JavaScript may handle incorrectly\nduring eval--either by deleting them or treating them as line\nendings--with escape sequences.\nIMPORTANT NOTE: This regex will be used to modify the input if a match is\nfound.", "private": "", "guessedtype": "property"}, "useNativeParse": {"description": "Leverage native JSON parse if the browser has a native implementation.\nIn general, this is a good idea. See the Known Issues section in the\nJSON user guide for caveats. The default value is true for browsers with\nnative JSON support.", "default": "true", "static": "", "guessedname": "useNativeParse", "guessedtype": "property", "type": "Boolean"}, "JSON.useNativeStringify": {"description": "Leverage native JSON stringify if the browser has a native\nimplementation. In general, this is a good idea. See the Known Issues\nsection in the JSON user guide for caveats. The default value is true\nfor browsers with native JSON support.", "default": "true", "static": "", "guessedname": "useNativeStringify", "guessedtype": "property", "type": "Boolean"}, "_UNSAFE": {"guessedname": "_UNSAFE", "type": "{RegExp}", "description": "Final step in the safety evaluation. Regex used to test the string left\nafter all previous replacements for invalid characters.", "private": "", "guessedtype": "property"}, "_ESCAPES": {"guessedname": "_ESCAPES", "type": "{RegExp}", "description": "First step in the safety evaluation. Regex used to replace all escape\nsequences (i.e. \"\\\\\", etc) with '@' characters (a non-JSON character).", "private": "", "guessedtype": "property"}, "_VALUES": {"guessedname": "_VALUES", "type": "{RegExp}", "description": "Second step in the safety evaluation. Regex used to replace all simple\nvalues with ']' characters.", "private": "", "guessedtype": "property"}, "Native": {"guessedname": "_JSON", "type": "{Object}", "description": "Alias to native browser implementation of the JSON object if available.", "private": "", "guessedtype": "property"}}, "name": "JSON"}, "Test.Manager": {"name": "Test.Manager", "namespace": "Test", "module": "test", "events": {"testmanagerbegin": {"static": "", "description": "Fires when the test manager starts running all test pages"}, "testmanagercomplete": {"static": "", "params": [{"type": " pages_passed: int, pages_failed: int, tests_passed: int\ntests_failed: int, passed: string[], failed: string[],\npage_results: {} ", "name": "obj", "description": ""}], "description": "Fires when the test manager finishes running all test pages. External\ntest runners should subscribe to this event in order to get the\naggregated test results."}, "testpagecomplete": {"static": "", "params": [{"type": "page: string, results: object", "name": "obj", "description": " the name of the\npage that was loaded, and the test suite results"}], "description": "Fires when a test page is complete"}, "testpagebegin": {"static": "", "params": [{"type": "string", "name": "curPage", "description": " the page being loaded"}], "description": "Fires when loading a test page"}}, "guessedname": "Manager", "methods": {"load": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Signals that a test page has been loaded. This should be called from\nwithin the test page itself to notify the TestManager that it is ready.", "guessedname": "load", "guessedtype": "function"}, "_run": {"return": {"type": "Void", "description": ""}, "description": "Loads the next test page into the iframe.", "private": "", "static": "", "guessedname": "_run", "guessedtype": "function"}, "stop": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Stops the execution of tests.", "guessedname": "stop", "guessedtype": "function"}, "setPages": {"return": {"type": "Void", "description": ""}, "description": "Sets the pages to be loaded.", "static": "", "guessedname": "setPages", "guessedtype": "function", "params": [{"type": "String[]", "name": "pages", "description": " An array of URLs to load."}]}, "start": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Begins the process of running the tests.", "guessedname": "start", "guessedtype": "function"}, "_processResults": {"return": {"type": "Void", "description": ""}, "description": "Processes the results of a test page run, outputting log messages\nfor failed tests.", "private": "", "static": "", "guessedname": "_processResults", "guessedtype": "function"}, "_handleTestRunnerComplete": {"return": {"type": "Void", "description": ""}, "description": "Handles TestRunner.COMPLETE_EVENT, storing the results and beginning\nthe loop again.", "private": "", "static": "", "guessedname": "_handleTestRunnerComplete", "guessedtype": "function", "params": [{"type": "Object", "name": "data", "description": " Data about the event."}]}}, "static": "", "file": "TestManager.js", "guessedtype": "property", "shortname": "Manager", "properties": {"_pages": {"description": "Array of pages to load.", "private": "", "static": "", "guessedname": "_pages", "guessedtype": "property", "type": "String[]"}, "TEST_MANAGER_COMPLETE_EVENT": {"description": "Constant for the testmanagercomplete custom event", "static": "", "guessedname": "TEST_MANAGER_COMPLETE_EVENT", "guessedtype": "property", "type": "string", "final": ""}, "_timeoutId": {"description": "The timeout ID for the next iteration through the tests.", "private": "", "static": "", "guessedname": "_timeoutId", "guessedtype": "property", "type": "int"}, "_logger": {"description": "The logger used to output results from the various tests.", "private": "", "static": "", "guessedname": "_logger", "guessedtype": "property", "type": "YAHOO.tool.TestLogger"}, "TEST_PAGE_BEGIN_EVENT": {"description": "Constant for the testpagebegin custom event", "static": "", "guessedname": "TEST_PAGE_BEGIN_EVENT", "guessedtype": "property", "type": "string", "final": ""}, "TEST_PAGE_COMPLETE_EVENT": {"description": "Constant for the testpagecomplete custom event", "static": "", "guessedname": "TEST_PAGE_COMPLETE_EVENT", "guessedtype": "property", "type": "string", "final": ""}, "_curPage": {"description": "The URL of the page currently being executed.", "private": "", "static": "", "guessedname": "_curPage", "guessedtype": "property", "type": "String"}, "_results": {"description": "Aggregated results", "private": "", "static": "", "guessedname": "_results", "guessedtype": "property", "type": "Object"}, "TEST_MANAGER_BEGIN_EVENT": {"description": "Constant for the testmanagerbegin custom event", "static": "", "guessedname": "TEST_MANAGER_BEGIN_EVENT", "guessedtype": "property", "type": "string", "final": ""}, "_frame": {"description": "The frame used to load and run tests.", "private": "", "static": "", "guessedname": "_frame", "guessedtype": "property", "type": "Window"}}, "description": "Runs pages containing test suite definitions."}, "Cookie": {"name": "Cookie", "namespace": "", "module": "cookie", "guessedname": "Cookie", "methods": {"setSub": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a sub cookie with a given name to a particular value.", "static": "", "guessedname": "setSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to set."}, {"type": "Variant", "name": "value", "description": " The value to set."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true/false)."}]}, "_parseCookieHash": {"return": {"type": "Object", "description": "An object containing entries for each cookie value."}, "description": "Parses a cookie hash string into an object.", "private": "", "static": "", "guessedname": "_parseCookieHash", "guessedtype": "function", "params": [{"type": "String", "name": "text", "description": " The cookie hash string to parse (format: n1=v1&n2=v2)."}]}, "set": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a cookie with a given name and value.", "static": "", "guessedname": "set", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "Variant", "name": "value", "description": " The value to set for the cookie."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nsecure (true/false), and raw (true/false). Setting raw to true indicates\nthat the cookie should not be URI encoded before being set."}]}, "setSubs": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a cookie with a given name to contain a hash of name-value pairs.", "static": "", "guessedname": "setSubs", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "Object", "name": "value", "description": " An object containing name-value pairs."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true/false)."}]}, "exists": {"return": {"type": "Boolean", "description": "True if the cookie exists, false if not."}, "description": "Determines if the cookie with the given name exists. This is useful for\nBoolean cookies (those that do not follow the name=value convention).", "static": "", "guessedname": "exists", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to check."}]}, "get": {"return": {"type": "Variant", "description": "If no converter is specified, returns a string or null if\nthe cookie doesn't exist. If the converter is specified, returns the value\nreturned from the converter or null if the cookie doesn't exist."}, "description": "Returns the cookie value for the given name.", "static": "", "guessedname": "get", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}, {"type": "Function|Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: raw (true/false) and converter (a function).\nThe converter function is run on the value before returning it. The\nfunction is not used if the cookie doesn't exist. The function can be\npassed instead of the options object for backwards compatibility. When\nraw is set to true, the cookie value is not URI decoded."}]}, "_parseCookieString": {"return": {"type": "Object", "description": "An object containing entries for each accessible cookie."}, "description": "Parses a cookie string into an object representing all accessible cookies.", "private": "", "static": "", "guessedname": "_parseCookieString", "guessedtype": "function", "params": [{"type": "String", "name": "text", "description": " The cookie string to parse."}, {"type": "Boolean", "name": "shouldDecode", "description": " (Optional) Indicates if the cookie values should be decoded or not. Default is true."}]}, "remove": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Removes a cookie from the machine by setting its expiration date to\nsometime in the past.", "static": "", "guessedname": "remove", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to remove."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), \nand secure (true/false). The expires option will be overwritten\nby the method."}]}, "removeSub": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Removes a sub cookie with a given name.", "static": "", "guessedname": "removeSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie in which the subcookie exists."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to remove."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nremoveIfEmpty (true/false), and secure (true/false). This must be the same\nsettings as the original subcookie."}]}, "_createCookieHashString": {"return": {"type": "String", "description": "A string suitable for use as a cookie value."}, "description": "Formats a cookie value for an object containing multiple values.", "private": "", "static": "", "guessedname": "_createCookieHashString", "guessedtype": "function", "params": [{"type": "Object", "name": "hash", "description": " An object of key-value pairs to create a string for."}]}, "getSubs": {"return": {"type": "Object", "description": "An object of name-value pairs if the cookie with the given name\nexists, null if it does not."}, "description": "Returns an object containing name-value pairs stored in the cookie with the given name.", "static": "", "guessedname": "getSubs", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}]}, "getSub": {"return": {"type": "Variant", "description": "If the cookie doesn't exist, null is returned. If the subcookie\ndoesn't exist, null if also returned. If no converter is specified and the\nsubcookie exists, a string is returned. If a converter is specified and the\nsubcookie exists, the value returned from the converter is returned."}, "description": "Returns the value of a subcookie.", "static": "", "guessedname": "getSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to retrieve."}, {"type": "Function", "name": "converter", "description": " (Optional) A function to run on the value before returning\nit. The function is not used if the cookie doesn't exist."}]}, "_createCookieString": {"return": {"type": "String", "description": "The formatted cookie string."}, "description": "Creates a cookie string that can be assigned into document.cookie.", "private": "", "static": "", "guessedname": "_createCookieString", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie."}, {"type": "String", "name": "value", "description": " The value of the cookie."}, {"type": "Boolean", "name": "encodeValue", "description": " True to encode the value, false to leave as-is."}, {"type": "Object", "name": "options", "description": " (Optional) Options for the cookie."}]}}, "static": "", "file": "Cookie.js", "guessedtype": "property", "shortname": "Cookie", "description": "Cookie utility."}, "DataType.Date": {"name": "DataType.Date", "namespace": "", "module": "datatype", "methods": {"parse": {"return": {"type": "Date", "description": "A Date, or null."}, "params": [{"type": "String | Number", "name": "data", "description": " Data to convert. Values supported by the Date constructor are supported."}], "description": "Converts data to type Date.", "guessedname": "parse", "guessedtype": "function"}, "xPad": {"guessedname": "xPad", "params": [{"type": "Number", "name": "x", "description": " \tThe number to be padded"}, {"type": "String", "name": "pad", "description": " The character to pad the number with"}, {"type": "Number", "name": "r", "description": " \t(optional) The base of the pad, eg, 10 implies to two digits, 100 implies to 3 digits."}], "description": "Pad a number with leading spaces, zeroes or something else", "private": "", "guessedtype": "function"}, "format": {"return": {"type": "String", "description": "Formatted date for display."}, "params": [{"type": "Date", "name": "oDate", "description": " Date."}, {"type": "Object} (Optional) Object literal of configuration values:\n
\nThis javascript implementation supports all the PHP specifiers and a few more. The full list is below.\n
\n
\nIf not specified, it defaults to the ISO8601 standard date format: %Y-%m-%d. This may be overridden by changing Y.config.dateFormat\n
\n
\n
%a
abbreviated weekday name according to the current locale
\n
%A
full weekday name according to the current locale
\n
%b
abbreviated month name according to the current locale
\n
%B
full month name according to the current locale
\n
%c
preferred date and time representation for the current locale
\n
%C
century number (the year divided by 100 and truncated to an integer, range 00 to 99)
\n
%d
day of the month as a decimal number (range 01 to 31)
\n
%D
same as %m/%d/%y
\n
%e
day of the month as a decimal number, a single digit is preceded by a space (range \" 1\" to \"31\")
\n
%F
same as %Y-%m-%d (ISO 8601 date format)
\n
%g
like %G, but without the century
\n
%G
The 4-digit year corresponding to the ISO week number
\n
%h
same as %b
\n
%H
hour as a decimal number using a 24-hour clock (range 00 to 23)
\n
%I
hour as a decimal number using a 12-hour clock (range 01 to 12)
\n
%j
day of the year as a decimal number (range 001 to 366)
\n
%k
hour as a decimal number using a 24-hour clock (range 0 to 23); single digits are preceded by a blank. (See also %H.)
\n
%l
hour as a decimal number using a 12-hour clock (range 1 to 12); single digits are preceded by a blank. (See also %I.)
\n
%m
month as a decimal number (range 01 to 12)
\n
%M
minute as a decimal number
\n
%n
newline character
\n
%p
either \"AM\" or \"PM\" according to the given time value, or the corresponding strings for the current locale
\n
%P
like %p, but lower case
\n
%r
time in a.m. and p.m. notation equal to %I:%M:%S %p
\n
%R
time in 24 hour notation equal to %H:%M
\n
%s
number of seconds since the Epoch, ie, since 1970-01-01 00:00:00 UTC
\n
%S
second as a decimal number
\n
%t
tab character
\n
%T
current time, equal to %H:%M:%S
\n
%u
weekday as a decimal number [1,7], with 1 representing Monday
\n
%U
week number of the current year as a decimal number, starting with the\nfirst Sunday as the first day of the first week
\n
%V
The ISO 8601:1988 week number of the current year as a decimal number,\nrange 01 to 53, where week 1 is the first week that has at least 4 days\nin the current year, and with Monday as the first day of the week.
\n
%w
day of the week as a decimal, Sunday being 0
\n
%W
week number of the current year as a decimal number, starting with the\nfirst Monday as the first day of the first week
\n
%x
preferred date representation for the current locale without the time
\n
%X
preferred time representation for the current locale without the date
\n
%y
year as a decimal number without a century (range 00 to 99)
\nThe locale to use when displaying days of week, months of the year, and other locale specific\nstrings. If not specified, this defaults to \"en\" (though this may be overridden by changing Y.config.locale).\nThe following locales are built in:\n
\n
en
\n
English
\n
en-US
\n
US English
\n
en-GB
\n
British English
\n
en-AU
\n
Australian English (identical to British English)
\n
\nMore locales may be added by subclassing of Y.DataType.Date.Locale[\"en\"].\nSee Y.DataType.Date.Locale for more information.\n
\n
"}], "description": "Takes a native JavaScript Date and formats it as a string for display to user.", "guessedname": "format", "guessedtype": "function"}}, "static": "", "file": "datatype-date-format.js", "shortname": "DataType.Date", "description": "DataType.Date provides a set of utility functions to operate against Date objects."}, "DataSchema.Array": {"name": "DataSchema.Array", "namespace": "", "module": "dataschema", "guessedname": "LANG", "methods": {"apply": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Applies a given schema to given Array data.", "static": "", "guessedname": "apply", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to apply."}, {"type": "Object", "name": "data", "description": " Array data."}]}, "_parseResults": {"return": {"type": "Object", "description": "Parsed data object."}, "description": "Schema-parsed list of results from full data", "protected": "", "static": "", "guessedname": "_parseResults", "guessedtype": "function", "params": [{"type": "Array", "name": "fields", "description": " Schema to parse against."}, {"type": "Array", "name": "array_in", "description": " Array to parse."}, {"type": "Object", "name": "data_out", "description": " In-progress parsed data to update."}]}}, "static": "", "superclass": "DataSchema.Base", "file": "dataschema-array.js", "guessedtype": "property", "extends": "DataSchema.Base", "shortname": "DataSchema.Array", "description": "Array subclass for the DataSchema Utility."}, "Lang": {"name": "Lang", "namespace": "", "module": "yui", "guessedname": "Lang", "methods": {"isArray": {"return": {"type": "boolean", "description": "true if o is an array"}, "description": "Determines whether or not the provided item is an array.\nReturns false for array-like collections such as the\nfunction arguments collection or HTMLElement collection\nwill return false. You can use @see Array.test if you \nwant to", "static": "", "guessedname": "isArray", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "trim": {"return": {"type": "string", "description": "the trimmed string"}, "description": "Returns a string without any leading or trailing whitespace. If \nthe input is not a string, the input will be returned untouched.", "static": "", "guessedname": "trim", "guessedtype": "function", "params": [{"type": "string", "name": "s", "description": " the string to trim"}]}, "isDate": {"return": {"type": "boolean", "description": "true if o is a date"}, "description": "Determines whether or not the supplied item is a date instance", "static": "", "guessedname": "isDate", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "isString": {"return": {"type": "boolean", "description": "true if o is a string"}, "description": "Determines whether or not the provided item is a string", "static": "", "guessedname": "isString", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "isBoolean": {"return": {"type": "boolean", "description": "true if o is a boolean"}, "description": "Determines whether or not the provided item is a boolean", "static": "", "guessedname": "isBoolean", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "isNull": {"return": {"type": "boolean", "description": "true if o is null"}, "description": "Determines whether or not the provided item is null", "static": "", "guessedname": "isNull", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "isValue": {"return": {"type": "boolean", "description": "true if it is not null/undefined/NaN || false"}, "description": "A convenience method for detecting a legitimate non-null value.\nReturns false for null/undefined/NaN, true for other values, \nincluding 0/false/''", "static": "", "guessedname": "isValue", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The item to test"}]}, "isFunction": {"return": {"type": "boolean", "description": "true if o is a function"}, "description": "Determines whether or not the provided item is a function\nNote: Internet Explorer thinks certain functions are objects:\nvar obj = document.createElement(\"object\");\nY.Lang.isFunction(obj.getAttribute) // reports false in IE\nvar input = document.createElement(\"input\"); // append to body\nY.Lang.isFunction(input.focus) // reports false in IE\nYou will have to implement additional tests if these functions\nmatter to you.", "static": "", "guessedname": "isFunction", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "isNumber": {"return": {"type": "boolean", "description": "true if o is a number"}, "description": "Determines whether or not the provided item is a legal number", "static": "", "guessedname": "isNumber", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}, "type": {"return": {"type": "string", "description": "the detected type"}, "params": [{"type": "", "name": "o", "description": " the item to test"}], "description": "Returns a string representing the type of the item passed in.", "guessedname": "type", "guessedtype": "function"}, "isObject": {"return": {"type": "boolean", "description": "true if o is an object"}, "description": "Determines whether or not the provided item is of type object\nor function", "static": "", "guessedname": "isObject", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}, {"type": "boolean", "name": "failfn", "description": " fail if the input is a function"}]}, "isUndefined": {"return": {"type": "boolean", "description": "true if o is undefined"}, "description": "Determines whether or not the provided item is undefined", "static": "", "guessedname": "isUndefined", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " The object to test"}]}}, "static": "", "file": "yui-lang.js", "guessedtype": "property", "shortname": "Lang", "description": "Provides the language utilites and extensions used by the library"}, "DD.Drag": {"name": "DD.Drag", "configs": {"node": {"type": "Node", "description": "Y.Node instanace to use as the element to initiate a drag operation", "guessedname": "node", "guessedtype": "property"}, "activeHandle": {"type": "Node", "description": "This config option is set by Drag to inform you of which handle fired the drag event (in the case that there are several handles): default false.", "guessedname": "activeHandle", "guessedtype": "property"}, "dragNode": {"type": "Node", "description": "Y.Node instanace to use as the draggable element, defaults to node", "guessedname": "dragNode", "guessedtype": "property"}, "move": {"type": "Boolean", "description": "If this is false, the drag element will not move with the cursor: default true. Can be used to \"resize\" the element.", "guessedname": "move", "guessedtype": "property"}, "target": {"type": "Boolean", "description": "This attribute only works if the dd-drop module has been loaded. It will make this node a drop target as well as draggable.", "guessedname": "target", "guessedtype": "property"}, "lock": {"type": "Boolean", "description": "Set to lock this drag element so that it can't be dragged: default false.", "guessedname": "lock", "guessedtype": "property"}, "offsetNode": {"type": "Boolean", "description": "Offset the drag element by the difference in cursor position: default true", "guessedname": "offsetNode", "guessedtype": "property"}, "handles": {"type": "Array", "description": "Array of valid handles to add. Adding something here will set all handles, even if previously added with addHandle", "guessedname": "handles", "guessedtype": "property"}, "clickPixelThresh": {"type": "Number", "description": "The number of pixels to move to start a drag operation, default is 3.", "guessedname": "clickPixelThresh", "guessedtype": "property"}, "groups": {"type": "Array", "description": "Array of groups to add this drag into.", "guessedname": "groups", "guessedtype": "property"}, "useShim": {"type": "Boolean", "description": "Use the protective shim on all drag operations: default true. Only works with dd-ddm, not dd-ddm-base.", "guessedname": "useShim", "guessedtype": "property"}, "dragMode": {"type": "String", "description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of this Drag instance.", "guessedname": "dragMode", "guessedtype": "property"}, "bubbles": {"type": "Object", "description": "Controls the default bubble parent for this Drag instance. Default: Y.DD.DDM. Set to false to disable bubbling.", "guessedname": "bubbles", "guessedtype": "property"}, "dragging": {"type": "Boolean", "description": "This attribute is not meant to be used by the implementor, it is meant to be used as an Event tracker so you can listen for it to change.", "guessedname": "dragging", "guessedtype": "property"}, "data": {"type": "Mixed", "description": "A payload holder to store arbitrary data about this drag object, can be used to store any value.", "guessedname": "data", "guessedtype": "property"}, "primaryButtonOnly": {"type": "Boolean", "description": "By default a drag operation will only begin if the mousedown occurred with the primary mouse button. Setting this to false will allow for all mousedown events to trigger a drag.", "guessedname": "primaryButtonOnly", "guessedtype": "property"}, "clickTimeThresh": {"type": "Number", "description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.", "guessedname": "clickTimeThresh", "guessedtype": "property"}}, "constructors": [{"description": "This class provides the ability to drag a Node."}], "namespace": "DD", "module": "dd", "properties": {"_groups": {"guessedname": "_groups", "type": "{Array}", "description": "Storage Array for the groups this drag belongs to.", "private": "", "guessedtype": "property"}, "_handles": {"guessedname": "_handles", "type": "{Object}", "description": "A private hash of the valid drag handles", "private": "", "guessedtype": "property"}, "_invalids": {"guessedname": "_invalids", "type": "{Object}", "description": "A private hash of the invalid selector strings", "private": "", "guessedtype": "property"}, "_clickTimeout": {"guessedname": "_clickTimeout", "type": "{Boolean}", "description": "Holder for the setTimeout call", "private": "", "guessedtype": "property"}, "_ev_md": {"guessedname": "_ev_md", "type": "{Event.Facade}", "description": "A private reference to the mousedown DOM event", "private": "", "guessedtype": "property"}, "target": {"type": "{Object}", "description": "This will be a reference to the Drop instance associated with this drag if the target: true config attribute is set..", "guessedname": "target", "guessedtype": "property"}, "mouseXY": {"type": "{Array}", "description": "The XY coords of the mousemove", "guessedname": "mouseXY", "guessedtype": "property"}, "_startTime": {"guessedname": "_startTime", "type": "Date", "description": "The getTime of the mousedown event. Not used, just here in case someone wants/needs to use it.", "private": "", "guessedtype": "property"}, "_endTime": {"guessedname": "_endTime", "type": "Date", "description": "The getTime of the mouseup event. Not used, just here in case someone wants/needs to use it.", "private": "", "guessedtype": "property"}, "region": {"type": "Object", "description": "A region object associated with this drag, used for checking regions while dragging.", "guessedname": "region", "guessedtype": "property"}, "_dragThreshMet": {"guessedname": "_dragThreshMet", "type": "{Boolean}", "description": "Private flag to see if the drag threshhold was met", "private": "", "guessedtype": "property"}, "actXY": {"type": "{Array}", "description": "The xy that the node will be set to. Changing this will alter the position as it's dragged.", "guessedname": "actXY", "guessedtype": "property"}, "startXY": {"type": "{Array}", "description": "The initial mouse position", "guessedname": "startXY", "guessedtype": "property"}, "nodeXY": {"type": "{Array}", "description": "The initial element position", "guessedname": "nodeXY", "guessedtype": "property"}, "deltaXY": {"type": "{Array}", "description": "The offset of the mouse position to the element's position", "guessedname": "deltaXY", "guessedtype": "property"}, "_invalidsDefault": {"guessedname": "_invalidsDefault", "type": "{Object}", "description": "A private hash of the default invalid selector strings: {'textarea': true, 'input': true, 'a': true, 'button': true, 'select': true}", "private": "", "guessedtype": "property"}, "lastXY": {"type": "{Array}", "description": "The position of the element as it's moving (for offset calculations)", "guessedname": "lastXY", "guessedtype": "property"}, "_fromTimeout": {"guessedname": "_fromTimeout", "type": "{Boolean}", "description": "Flag to determine if the drag operation came from a timeout", "private": "", "guessedtype": "property"}, "_ieSelectBack": {"private": "", "description": "We will hold a copy of the current \"onselectstart\" method on this property, and reset it after we are done using it.", "guessedname": "_ieSelectBack", "guessedtype": "property"}, "realXY": {"type": "{Array}", "description": "The real xy position of the node.", "guessedname": "realXY", "guessedtype": "property"}}, "guessedname": "DDM", "methods": {"addToGroup": {"return": {"type": "Self", "description": ""}, "description": "Add this Drag instance to a group, this should be used for on-the-fly group additions.", "chainable": "", "params": [{"type": "String", "name": "g", "description": " The group to add this Drag Instance to."}], "guessedname": "addToGroup", "guessedtype": "function"}, "_setStartPosition": {"guessedname": "_setStartPosition", "params": [{"type": "Array", "name": "xy", "description": " The XY coords to set the position to."}], "description": "Sets the current position of the Element and calculates the offset", "private": "", "guessedtype": "function"}, "_fixDragStart": {"description": "The function we use as the ondragstart handler when we start a drag in Internet Explorer. This keeps IE from blowing up on images as drag handles.", "private": "", "guessedname": "_fixDragStart", "guessedtype": "function"}, "_defDragFn": {"guessedname": "_defDragFn", "params": [{"type": "Event.Facade", "name": "ev", "description": " The drag:drag event"}], "description": "Default function for drag:drag. Fired from _moveNode.", "private": "", "guessedtype": "function"}, "stopDrag": {"chainable": "", "return": {"type": "Self", "description": ""}, "description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.", "guessedname": "stopDrag", "guessedtype": "function"}, "_move": {"guessedname": "_move", "params": [{"type": "Event.Facade", "name": "ev", "description": " The mousemove DOM event"}], "description": "Fired from DragDropMgr (DDM) on mousemove.", "private": "", "guessedtype": "function"}, "validClick": {"return": {"type": "Boolean", "description": ""}, "params": [], "description": "Method first checks to see if we have handles, if so it validates the click against the handle. Then if it finds a valid handle, it checks it against the invalid handles list. Returns true if a good handle was used, false otherwise.", "guessedname": "validClick", "guessedtype": "function"}, "removeInvalid": {"return": {"type": "Self", "description": ""}, "description": "Remove an invalid handle added by addInvalid", "chainable": "", "params": [{"type": "String", "name": "str", "description": " The invalid handle to remove from the internal list."}], "guessedname": "removeInvalid", "guessedtype": "function"}, "addHandle": {"return": {"type": "Self", "description": ""}, "description": "Add a handle to a drag element. Drag only initiates when a mousedown happens on this element.", "chainable": "", "params": [{"type": "String", "name": "str", "description": " The selector to test for a valid handle. Must be a child of the element."}], "guessedname": "addHandle", "guessedtype": "function"}, "initializer": {"description": "Internal init handler", "private": "", "guessedname": "initializer", "guessedtype": "function"}, "removeHandle": {"return": {"type": "Self", "description": ""}, "description": "Remove a Selector added by addHandle", "chainable": "", "params": [{"type": "String", "name": "str", "description": " The selector for the handle to be removed."}], "guessedname": "removeHandle", "guessedtype": "function"}, "_handleMouseDownEvent": {"guessedname": "_handleMouseDownEvent", "params": [], "description": "Handler for the mousedown DOM event", "private": "", "guessedtype": "function"}, "end": {"chainable": "", "return": {"type": "Self", "description": ""}, "description": "Ends the drag operation", "guessedname": "end", "guessedtype": "function"}, "_moveNode": {"description": "This method performs the actual element move.", "private": "", "guessedname": "_moveNode", "guessedtype": "function"}, "destructor": {"description": "Lifecycle destructor, unreg the drag from the DDM and remove listeners", "private": "", "guessedname": "destructor", "guessedtype": "function"}, "start": {"chainable": "", "return": {"type": "Self", "description": ""}, "description": "Starts the drag operation", "guessedname": "start", "guessedtype": "function"}, "_ieSelectFix": {"description": "The function we use as the onselectstart handler when we start a drag in Internet Explorer", "private": "", "guessedname": "_ieSelectFix", "guessedtype": "function"}, "_defAlignFn": {"guessedname": "_defAlignFn", "params": [{"type": "Event.Facade", "name": "e", "description": " The drag:align event."}], "description": "Calculates the offsets and set's the XY that the element will move to.", "private": "", "guessedtype": "function"}, "_createEvents": {"description": "This method creates all the events for this Event Target and publishes them so we get Event Bubbling.", "private": "", "guessedname": "_createEvents", "guessedtype": "function"}, "_timeoutCheck": {"description": "The method passed to setTimeout to determine if the clickTimeThreshold was met.", "private": "", "guessedname": "_timeoutCheck", "guessedtype": "function"}, "removeFromGroup": {"return": {"type": "Self", "description": ""}, "description": "Remove this Drag instance from a group, this should be used for on-the-fly group removals.", "chainable": "", "params": [{"type": "String", "name": "g", "description": " The group to remove this Drag Instance from."}], "guessedname": "removeFromGroup", "guessedtype": "function"}, "_fixIEMouseUp": {"description": "This method copies the _ieSelectFix property back to the onselectstart listner on the document.", "private": "", "guessedname": "_fixIEMouseUp", "guessedtype": "function"}, "_alignNode": {"guessedname": "_alignNode", "params": [{"type": "Array", "name": "eXY", "description": " The XY to move the element to, usually comes from the mousemove DOM event."}], "description": "This method performs the alignment before the element move.", "private": "", "guessedtype": "function"}, "_prevEndFn": {"description": "Handler for preventing the drag:end event. It will reset the node back to it's start position", "private": "", "guessedname": "_prevEndFn", "guessedtype": "function"}, "_prep": {"description": "Attach event listners and add classname", "private": "", "guessedname": "_prep", "guessedtype": "function"}, "addInvalid": {"return": {"type": "Self", "description": ""}, "description": "Add a selector string to test the handle against. If the test passes the drag operation will not continue.", "chainable": "", "params": [{"type": "String", "name": "str", "description": " The selector to test against to determine if this is an invalid drag handle."}], "guessedname": "addInvalid", "guessedtype": "function"}, "_defMouseDownFn": {"guessedname": "_defMouseDownFn", "params": [], "description": "Handler for the mousedown DOM event", "private": "", "guessedtype": "function"}, "_handleMouseUp": {"guessedname": "_handleMouseUp", "params": [], "description": "Handler for the mouseup DOM event", "private": "", "guessedtype": "function"}, "_align": {"guessedname": "_align", "params": [{"type": "Array", "name": "xy", "description": " The xy coords to align with."}], "description": "Calculates the offsets and set's the XY that the element will move to.", "private": "", "guessedtype": "function"}, "_handleTarget": {"return": {"type": "Boolean/Object", "description": ""}, "description": "Attribute handler for the target config attribute.", "private": "", "params": [], "guessedname": "_handleTarget", "guessedtype": "function"}, "_unprep": {"description": "Detach event listeners and remove classname", "private": "", "guessedname": "_unprep", "guessedtype": "function"}, "_fixIEMouseDown": {"description": "This method copies the onselectstart listner on the document to the _ieSelectFix property", "private": "", "guessedname": "_fixIEMouseDown", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "drag.js", "guessedtype": "property", "shortname": "Drag", "events": {"clickPixelThreshChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "clickPixelThreshChange", "description": "Fires when the value for the configuration attribute 'clickPixelThresh' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "groupsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "groupsChange", "description": "Fires when the value for the configuration attribute 'groups' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:afterMouseDown": {"description": "Fires after the mousedown event has been cleared.", "params": [{"type": "Event.Facade", "name": "ev", "description": " The mousedown event."}], "guessedname": "EV_AFTER_MOUSE_DOWN", "guessedtype": "property", "bubbles": "DDM", "type": "{Event.Custom}"}, "bubblesChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "bubblesChange", "description": "Fires when the value for the configuration attribute 'bubbles' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "offsetNodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "offsetNodeChange", "description": "Fires when the value for the configuration attribute 'offsetNode' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "draggingChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "draggingChange", "description": "Fires when the value for the configuration attribute 'dragging' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "handlesChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "handlesChange", "description": "Fires when the value for the configuration attribute 'handles' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "dataChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "dataChange", "description": "Fires when the value for the configuration attribute 'data' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:removeInvalid": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires after an invalid selector is removed.", "guessedname": "EV_REMOVE_INVALID", "guessedtype": "property"}, "dragModeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "dragModeChange", "description": "Fires when the value for the configuration attribute 'dragMode' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "primaryButtonOnlyChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "primaryButtonOnlyChange", "description": "Fires when the value for the configuration attribute 'primaryButtonOnly' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:mouseDown": {"description": "Handles the mousedown DOM event, checks to see if you have a valid handle then starts the drag timers.", "params": [{"type": "Event.Facade", "name": "ev", "description": " The mousedown event."}], "guessedname": "EV_MOUSE_DOWN", "guessedtype": "property", "preventable": "_defMouseDownFn", "bubbles": "DDM", "type": "{Event.Custom}"}, "drag:align": {"description": "Fires when this node is aligned.", "guessedname": "EV_ALIGN", "guessedtype": "property", "preventable": "_defAlignFn", "bubbles": "DDM", "type": "{Event.Custom}"}, "drag:addHandle": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires after a handle is added.", "guessedname": "EV_ADD_HANDLE", "guessedtype": "property"}, "drag:removeHandle": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires after a handle is removed.", "guessedname": "EV_REMOVE_HANDLE", "guessedtype": "property"}, "activeHandleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "activeHandleChange", "description": "Fires when the value for the configuration attribute 'activeHandle' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:start": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires at the start of a drag operation.", "guessedname": "EV_START", "guessedtype": "property"}, "useShimChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "useShimChange", "description": "Fires when the value for the configuration attribute 'useShim' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "clickTimeThreshChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "clickTimeThreshChange", "description": "Fires when the value for the configuration attribute 'clickTimeThresh' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "lockChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "lockChange", "description": "Fires when the value for the configuration attribute 'lock' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "targetChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "targetChange", "description": "Fires when the value for the configuration attribute 'target' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:enter": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when this node enters a Drop Target. (Fired from dd-drop)"}, "drag:addInvalid": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires after an invalid selector is added.", "guessedname": "EV_ADD_INVALID", "guessedtype": "property"}, "drag:drag": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires every mousemove during a drag operation.", "guessedname": "EV_DRAG", "guessedtype": "property"}, "nodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "nodeChange", "description": "Fires when the value for the configuration attribute 'node' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "dragNodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "dragNodeChange", "description": "Fires when the value for the configuration attribute 'dragNode' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:drophit": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when this node is dropped on a valid Drop Target. (Fired from dd-ddm-drop)"}, "drag:dropmiss": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when this node is dropped on an invalid Drop Target. (Fired from dd-ddm-drop)", "guessedname": "Drag", "guessedtype": "function"}, "drag:over": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when this node is over a Drop Target. (Fired from dd-drop)"}, "drag:exit": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires when this node exits a Drop Target. (Fired from dd-drop)"}, "moveChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "moveChange", "description": "Fires when the value for the configuration attribute 'move' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "drag:end": {"bubbles": "DDM", "type": "{Event.Custom}", "description": "Fires at the end of a drag operation.", "guessedname": "EV_END", "guessedtype": "property"}}, "description": "This class provides the ability to drag a Node."}, "DataSchema.JSON": {"name": "DataSchema.JSON", "namespace": "", "module": "dataschema", "guessedname": "LANG", "methods": {"DataSchema.JSON.getPath": {"return": {"type": "String[]", "description": "Walkable path to data value."}, "description": "Utility function converts JSON locator strings into walkable paths", "static": "", "guessedname": "getPath", "guessedtype": "function", "params": [{"type": "String", "name": "locator", "description": " JSON value locator."}]}, "DataSchema.JSON.getLocationValue": {"return": {"type": "Object", "description": "Data value at location."}, "description": "Utility function to walk a path and return the value located there.", "static": "", "guessedname": "getLocationValue", "guessedtype": "function", "params": [{"type": "String[]", "name": "path", "description": " Locator path."}, {"type": "String", "name": "data", "description": " Data to traverse."}]}, "_parseMeta": {"return": {"type": "Object", "description": "Schema-parsed meta data."}, "description": "Parses results data according to schema", "protected": "", "static": "", "guessedname": "_parseMeta", "guessedtype": "function", "params": [{"type": "Object", "name": "metaFields", "description": " Metafields definitions."}, {"type": "Object", "name": "json_in", "description": " JSON to parse."}, {"type": "Object", "name": "data_out", "description": " In-progress parsed data to update."}]}, "_getFieldValues": {"return": {"type": "Object", "description": "Parsed data object."}, "description": "Get field data values out of list of full results", "protected": "", "static": "", "guessedname": "_getFieldValues", "guessedtype": "function", "params": [{"type": "Array", "name": "fields", "description": " Fields to find."}, {"type": "Array", "name": "array_in", "description": " Results to parse."}, {"type": "Object", "name": "data_out", "description": " In-progress parsed data to update."}]}, "_parseResults": {"return": {"type": "Object", "description": "Parsed data object."}, "description": "Schema-parsed list of results from full data", "protected": "", "static": "", "guessedname": "_parseResults", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to parse against."}, {"type": "Object", "name": "json_in", "description": " JSON to parse."}, {"type": "Object", "name": "data_out", "description": " In-progress parsed data to update."}]}, "apply": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Applies a given schema to given JSON data.", "static": "", "guessedname": "apply", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to apply."}, {"type": "Object", "name": "data", "description": " JSON data."}]}}, "static": "", "superclass": "DataSchema.Base", "file": "dataschema-json.js", "guessedtype": "property", "extends": "DataSchema.Base", "shortname": "DataSchema.JSON", "description": "JSON subclass for the DataSchema Utility."}, "AsyncQueue": {"name": "AsyncQueue", "constructors": [{"params": [{"type": "Function|Object", "name": "callback*", "description": " 0..n callbacks to seed the queue"}], "description": "
A specialized queue class that supports scheduling callbacks to execute\nsequentially, iteratively, even asynchronously.
\n
Callbacks can be function refs or objects with the following keys. Only\nthe fn key is required.
\n
\n
fn -- The callback function
\n
context -- The execution context for the callbackFn.
\n
args -- Arguments to pass to callbackFn.
\n
timeout -- Millisecond delay before executing callbackFn.\n(Applies to each iterative execution of callback)
\n
iterations -- Number of times to repeat the callback.\n
until -- Repeat the callback until this function returns\ntrue. This setting trumps iterations.
\n
autoContinue -- Set to false to prevent the AsyncQueue from\nexecuting the next callback in the Queue after\nthe callback completes.
\n
id -- Name that can be used to get, promote, get the\nindexOf, or delete this callback.
\n
"}], "namespace": "", "module": "async-queue", "events": {"complete": {"description": "Event fired after the last queued callback is executed."}}, "guessedname": "AsyncQueue", "methods": {"_initEvents": {"protected": "", "description": "Initializes the instance events.", "guessedname": "_initEvents", "guessedtype": "function"}, "_defRemoveFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the custom event"}], "description": "
Default functionality for the "remove" event. Removes the\ncallback from the queue.
\n
The event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.
", "guessedname": "_defRemoveFn", "guessedtype": "function"}, "pause": {"chainable": "", "return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Pause the execution of the queue after the execution of the current\ncallback completes. If called from code outside of a queued callback,\nclears the timeout for the pending callback. Paused queue can be\nrestarted with q.run()", "guessedname": "pause", "guessedtype": "function"}, "run": {"chainable": "", "return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Sets the queue in motion. All queued callbacks will be executed in\norder unless pause() or stop() is called or if one of the callbacks is\nconfigured with autoContinue: false.", "guessedname": "run", "guessedtype": "function"}, "_schedule": {"return": {"type": "Boolean", "description": "whether the run loop should continue"}, "description": "Schedules the execution of asynchronous callbacks.", "protected": "", "params": [{"type": "Object", "name": "callback", "description": " the callback object to execute"}], "guessedname": "_schedule", "guessedtype": "function"}, "_defShiftFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The event object"}], "description": "Default functionality for the "shift" event. Shifts the\ncallback stored in the event object's callback property from\nthe queue if it is the first item.", "guessedname": "_defShiftFn", "guessedtype": "function"}, "_execute": {"return": {"type": "Boolean", "description": "whether the run loop should continue"}, "description": "Handles the execution of callbacks. Returns a boolean indicating\nwhether it is appropriate to continue running.", "protected": "", "params": [{"type": "Object", "name": "callback", "description": " the callback object to execute"}], "guessedname": "_execute", "guessedtype": "function"}, "stop": {"chainable": "", "return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Stop and clear the queue after the current execution of the\ncurrent callback completes.", "guessedname": "stop", "guessedtype": "function"}, "_init": {"protected": "", "description": "Initializes the AsyncQueue instance properties and events.", "guessedname": "_init", "guessedtype": "function"}, "remove": {"return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Removes the callback from the queue. If the queue is active, the\nremoval is scheduled to occur after the current callback has completed.", "chainable": "", "params": [{"type": "String|Object", "name": "callback", "description": " the callback object or a callback's id"}], "guessedname": "remove", "guessedtype": "function"}, "next": {"return": {"type": "Function", "description": "the callback to execute"}, "description": "Returns the next callback needing execution. If a callback is\nconfigured to repeat via iterations or until, it will be returned until\nthe completion criteria is met.\nWhen the queue is empty, null is returned.", "guessedname": "next", "guessedtype": "function"}, "indexOf": {"return": {"type": "Number", "description": "index of the callback or -1 if not found"}, "params": [{"type": "String|Function", "name": "callback", "description": " the callback or its specified id"}], "description": "Returns the current index of a callback. Pass in either the id or\ncallback function from getCallback.", "guessedname": "indexOf", "guessedtype": "function"}, "add": {"return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Add any number of callbacks to the end of the queue. Callbacks may be\nprovided as functions or objects.", "chainable": "", "params": [{"type": "Function|Object", "name": "callback*", "description": " 0..n callbacks"}], "guessedname": "add", "guessedtype": "function"}, "_defExecFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the event object"}], "description": "Default functionality for the "execute" event. Executes the\ncallback function", "guessedname": "_defExecFn", "guessedtype": "function"}, "getCallback": {"return": {"type": "Object", "description": "the callback object"}, "params": [{"type": "String", "name": "id", "description": " the id assigned to the callback"}], "description": "Retrieve a callback by its id. Useful to modify the configuration\nwhile the queue is running.", "guessedname": "getCallback", "guessedtype": "function"}, "_defPromoteFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the custom event"}], "description": "
Default functionality for the "promote" event. Promotes the\nnamed callback to the head of the queue.
\n
The event object will contain a property "callback", which\nholds the id of a callback or the callback object itself.
", "guessedname": "_defPromoteFn", "guessedtype": "function"}, "_prepare": {"return": {"type": "Function", "description": "a decorated function wrapper to execute the callback"}, "description": "Creates a wrapper function to execute the callback using the aggregated \nconfiguration generated by combining the static AsyncQueue.defaults, the\ninstance defaults, and the specified callback settings.\nThe wrapper function is decorated with the callback configuration as\nproperties for runtime modification.", "protected": "", "params": [{"type": "Object|Function", "name": "callback", "description": " the raw callback"}], "guessedname": "_prepare", "guessedtype": "function"}, "promote": {"return": {"type": "AsyncQueue", "description": "the AsyncQueue instance"}, "description": "Promotes the named callback to the top of the queue. If a callback is\ncurrently executing or looping (via until or iterations), the promotion\nis scheduled to occur after the current callback has completed.", "chainable": "", "params": [{"type": "String|Object", "name": "callback", "description": " the callback object or a callback's id"}], "guessedname": "promote", "guessedtype": "function"}, "_defAddFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the event object"}], "description": "Default functionality for the "add" event. Adds the callbacks\nin the event facade to the queue. Callbacks successfully added to the\nqueue are present in the event's added property in the\nafter phase.", "guessedname": "_defAddFn", "guessedtype": "function"}, "isRunning": {"return": {"type": "Boolean", "description": "true if queue is waiting for a \nfrom any initiated transactions"}, "description": "Determines if the queue is waiting for a callback to complete execution.", "guessedname": "isRunning", "guessedtype": "function"}, "size": {"return": {"type": "Number", "description": ""}, "description": "Returns the number of callbacks in the queue.", "guessedname": "size", "guessedtype": "function"}}, "extends": "EventTarget", "superclass": "EventTarget", "file": "async-queue.js", "guessedtype": "function", "shortname": "AsyncQueue", "properties": {"AsyncQueue.defaults": {"type": "{Object}", "static": "", "description": "
Static default values used to populate callback configuration properties.\nPreconfigured defaults include:
\n
\n
autoContinue: true
\n
iterations: 1
\n
timeout: 10 (10ms between callbacks)
\n
until: (function to run until iterations <= 0)
\n
", "guessedname": "defaults", "guessedtype": "property"}, "_running": {"protected": "", "type": "{Boolean|Object} true for synchronous callback execution, the\nreturn handle from Y.later for async callbacks.\nOtherwise false.", "description": "Used to indicate the queue is currently executing a callback.", "guessedname": "_running", "guessedtype": "property"}, "defaults": {"type": "{Object}", "description": "Callback defaults for this instance. Static defaults that are not\noverridden are also included.", "guessedname": "defaults", "guessedtype": "property"}}, "description": "
A specialized queue class that supports scheduling callbacks to execute\nsequentially, iteratively, even asynchronously.
\n
Callbacks can be function refs or objects with the following keys. Only\nthe fn key is required.
\n
\n
fn -- The callback function
\n
context -- The execution context for the callbackFn.
\n
args -- Arguments to pass to callbackFn.
\n
timeout -- Millisecond delay before executing callbackFn.\n(Applies to each iterative execution of callback)
\n
iterations -- Number of times to repeat the callback.\n
until -- Repeat the callback until this function returns\ntrue. This setting trumps iterations.
\n
autoContinue -- Set to false to prevent the AsyncQueue from\nexecuting the next callback in the Queue after\nthe callback completes.
\n
id -- Name that can be used to get, promote, get the\nindexOf, or delete this callback.
\n
"}, "Easing": {"name": "Easing", "namespace": "", "module": "anim", "guessedname": "Easing", "methods": {"easeIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and accelerates towards end. (quadratic)", "guessedname": "easeIn", "guessedtype": "function"}, "easeInStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and accelerates towards end. (quartic)", "guessedname": "easeInStrong", "guessedtype": "function"}, "bounceBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounces off start and end.", "guessedname": "bounceBoth", "guessedtype": "function"}, "backOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Overshoots end, then reverses and comes back to end.", "guessedname": "backOut", "guessedtype": "function"}, "elasticBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap both elastic effect.", "guessedname": "elasticBoth", "guessedtype": "function"}, "elasticOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap out elastic effect.", "guessedname": "elasticOut", "guessedtype": "function"}, "bounceOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounces off end.", "guessedname": "bounceOut", "guessedtype": "function"}, "backBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Backtracks slightly, then reverses direction, overshoots end, \nthen reverses and comes back to end.", "guessedname": "backBoth", "guessedtype": "function"}, "easeBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and decelerates towards end. (quadratic)", "guessedname": "easeBoth", "guessedtype": "function"}, "bounceIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounce off of start.", "guessedname": "bounceIn", "guessedtype": "function"}, "easeOutStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins quickly and decelerates towards end. (quartic)", "guessedname": "easeOutStrong", "guessedtype": "function"}, "easeNone": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Uniform speed between points.", "guessedname": "easeNone", "guessedtype": "function"}, "elasticIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap in elastic effect.", "guessedname": "elasticIn", "guessedtype": "function"}, "easeBothStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and decelerates towards end. (quartic)", "guessedname": "easeBothStrong", "guessedtype": "function"}, "easeOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins quickly and decelerates towards end. (quadratic)", "guessedname": "easeOut", "guessedtype": "function"}, "backIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Backtracks slightly, then reverses direction and moves to end.", "guessedname": "backIn", "guessedtype": "function"}}, "file": "anim-easing.js", "guessedtype": "property", "shortname": "Easing", "description": "The easing module provides methods for customizing\nhow an animation behaves during each run."}, "Plugin.Drag": {"name": "Plugin.Drag", "constructors": [{"description": "This is a simple Drag plugin that can be attached to a Node via the plug method."}], "namespace": "Plugin", "module": "dd", "guessedname": "Drag", "extends": "DD.Drag", "superclass": "DD.Drag", "file": "dd-plugin.js", "guessedtype": "function", "shortname": "Drag", "properties": {"NS": {"type": "{String}", "description": "The Drag instance will be placed on the Node instance under the dd namespace. It can be accessed via Node.dd;", "guessedname": "NS", "guessedtype": "property"}, "NAME": {"type": "{String}", "description": "dd-plugin", "guessedname": "NAME", "guessedtype": "property"}}, "description": "This is a simple Drag plugin that can be attached to a Node via the plug method."}, "History": {"name": "History", "constructors": [{"description": "This class represents an instance of the browser history utility."}], "namespace": "", "module": "history", "methods": {"getBookmarkedState": {"return": {"type": "string", "description": "The bookmarked state of the specified module."}, "description": "Returns the state of a module according to the URL fragment\nidentifier. This method is useful to initialize your modules\nif your application was bookmarked from a particular state.", "params": [{"type": "string", "name": "moduleId", "description": " Non-empty string representing your module."}], "guessedname": "getBookmarkedState", "guessedtype": "function", "public": ""}, "_updateIFrame": {"return": {"type": "boolean", "description": "true if successful. false otherwise."}, "description": "Update the IFrame with our new state.", "private": ""}, "_handleFQStateChange": {"params": [{"type": "string", "name": "fqstate", "description": " fully qualified state"}], "description": "Sets the new currentState attribute of all modules depending on the new fully\nqualified state. Also notifies the modules which current state has changed.", "private": ""}, "getCurrentState": {"return": {"type": "string", "description": "The current state of the specified module."}, "description": "Returns the current state of the specified module.", "params": [{"type": "string", "name": "moduleId", "description": " Non-empty string representing your module."}], "guessedname": "getCurrentState", "guessedtype": "function", "public": ""}, "navigate": {"return": {"type": "boolean", "description": "Indicates whether the new state was successfully added to the history."}, "description": "Stores a new entry in the browser history by changing the state of a registered module.", "params": [{"type": "string", "name": "module", "description": " Non-empty string representing your module."}, {"type": "string", "name": "state", "description": " String representing the new state of the specified module."}], "guessedname": "navigate", "guessedtype": "function", "public": ""}, "_initialize": {"description": "Finish up the initialization of the browser utility library.", "private": ""}, "register": {"return": {"type": "History.Module", "description": "The newly registered module"}, "params": [{"type": "string", "name": "moduleId", "description": " Non-empty string uniquely identifying the\nmodule you wish to register."}, {"type": "string", "name": "initialState", "description": " The initial state of the specified\nmodule corresponding to its earliest history entry."}], "description": "Registers a new module.", "guessedname": "register", "guessedtype": "function"}, "_checkIframeLoaded": {"description": "Periodically checks whether our internal IFrame is ready to be used", "private": ""}, "initialize": {"public": "", "params": [{"type": "string|HTML Element", "name": "stateField", "description": " used\nto store application states. Must be in the static markup."}, {"type": "string|HTML Element", "name": "historyIFrame", "description": " IFrame used to store\nthe history (only required for IE6/7)"}], "description": "Initializes the Browser History Manager. Call this method\nfrom a script block located right after the opening body tag.", "guessedname": "initialize", "guessedtype": "function"}, "_storeStates": {"description": "Stores the initial state and current state for all registered modules\nin the (hidden) form field specified during initialization.", "private": ""}, "getQueryStringParameter": {"return": {"type": "string", "description": "The value of the specified parameter, or null."}, "description": "Returns the value of the specified query string parameter.\nThis method is not used internally by the Browser History Manager.\nHowever, it is provided here as a helper since many applications\nusing the Browser History Manager will want to read the value of\nurl parameters to initialize themselves.", "params": [{"type": "string", "name": "paramName", "description": " Name of the parameter we want to look up."}, {"type": "string", "name": "queryString", "description": " Optional URL to look at. If not specified,\nthis method uses the URL in the address bar."}], "guessedname": "getQueryStringParameter", "guessedtype": "function", "public": ""}, "_getHash": {"return": {"type": "string", "description": "The hash portion of the document's location"}, "description": "Returns the portion of the hash after the '#' symbol.", "private": ""}, "multiNavigate": {"return": {"type": "boolean", "description": "Indicates whether the new state was successfully added to the history."}, "description": "Stores a new entry in the browser history by changing the state\nof several registered modules in one atomic operation.", "params": [{"type": "object", "name": "states", "description": " Associative array of module-state pairs to set simultaneously."}], "guessedname": "multiNavigate", "guessedtype": "function", "public": ""}}, "file": "history.js", "shortname": "History", "events": {"history:moduleStateChange": {"type": "Event.Custom", "description": "Fires when the state of a history module object has changed", "guessedname": "EV_HISTORY_MODULE_STATE_CHANGE", "guessedtype": "property"}, "history:ready": {"type": "Event.Custom", "description": "Fires when the browser history utility is ready", "guessedname": "EV_HISTORY_READY", "guessedtype": "property"}, "history:globalStateChange": {"type": "Event.Custom", "description": "Fires when the global state of the page has changed (that is,\nwhen the state of at least one browser history module has changed)", "guessedname": "EV_HISTORY_GLOBAL_STATE_CHANGE", "guessedtype": "property"}}, "description": "This class represents an instance of the browser history utility."}, "Plugin.DDNodeScroll": {"name": "Plugin.DDNodeScroll", "constructors": [{"description": "Extends the Scroll class to make a parent node scroll while dragging."}], "namespace": "Plugin", "module": "dd", "events": {"nodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "nodeChange", "description": "Fires when the value for the configuration attribute 'node' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "NS", "extends": "DD.Scroll", "superclass": "DD.Scroll", "file": "scroll.js", "guessedtype": "function", "shortname": "DDNodeScroll", "configs": {"node": {"type": "Node", "description": "The node we want to scroll. Used to set the internal parentScroll attribute.", "guessedname": "node", "guessedtype": "property"}}, "description": "Extends the Scroll class to make a parent node scroll while dragging."}, "Attribute": {"name": "Attribute", "description": "
\nAttribute provides configurable attribute support along with attribute change events. It is designed to be \naugmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state, \nalong with attribute change events.\n
\n
For example, attributes added to the host can be configured:
\n
\n
As read only.
\n
As write once.
\n
With a setter function, which can be used to manipulate\nvalues passed to Attribute's set method, before they are stored.
\n
With a getter function, which can be used to manipulate stored values,\nbefore they are returned by Attribute's get method.
\n
With a validator function, to validate values before they are stored.
\n
\n
See the addAttr method, for the complete set of configuration\noptions available for attributes
.\n
NOTE: Most implementations will be better off extending the Base class, \ninstead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration \nof attributes for derived classes, accounting for values passed into the constructor.
", "namespace": "", "module": "attribute", "uses": ["EventTarget"], "file": "Attribute.js", "shortname": "Attribute", "properties": {"Attribute._ATTR_CFG": {"description": "The list of properties which can be configured for \neach attribute (e.g. setter, getter, writeOnce etc.).\nThis property is used internally as a whitelist for faster\nY.mix operations.", "protected": "", "static": "", "guessedname": "_ATTR_CFG", "guessedtype": "property", "type": "Array"}, "Attribute.INVALID_VALUE": {"description": "
The value to return from an attribute setter in order to prevent the set from going through.
\n
You can return this value from your setter if you wish to combine validator and setter \nfunctionality into a single setter function, which either returns the massaged value to be stored or \nAttribute.INVALID_VALUE to prevent invalid values from being stored.
", "static": "", "guessedname": "INVALID_VALUE", "guessedtype": "property", "type": "Object", "final": ""}}, "methods": {"_setAttrVal": {"return": {"type": "booolean", "description": "true if the new attribute value was stored, false if not."}, "description": "Updates the stored value of the attribute in the privately held State object,\nif validation and setter passes.", "private": "", "params": [{"type": "String", "name": "attrName", "description": " The attribute name."}, {"type": "String", "name": "subAttrName", "description": " The sub-attribute name, if setting a sub-attribute property (\"x.y.z\")."}, {"type": "Any", "name": "prevVal", "description": " The currently stored value of the attribute."}, {"type": "Any", "name": "newVal", "description": " The value which is going to be stored."}], "guessedname": "_setAttrVal", "guessedtype": "function"}, "set": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Sets the value of an attribute.", "chainable": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute. If the \ncurrent value of the attribute is an Object, dot notation can be used\nto set the value of a property within the object (e.g. set(\"x.y.z\", 5))."}, {"type": "Any", "name": "value", "description": " The value to set the attribute to."}, {"type": "Object", "name": "opts", "description": " (Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event. This \ncan be used as a flexible way to identify the source of a call to set, allowing \nthe developer to distinguish between set called internally by the host, vs. \nset called externally by the application developer."}], "guessedname": "set", "guessedtype": "function"}, "getAttrs": {"return": {"type": "Object", "description": "An object with attribute name/value pairs."}, "params": [{"type": "Array | boolean", "name": "attrs", "description": " Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned."}], "description": "Gets multiple attribute values.", "guessedname": "getAttrs", "guessedtype": "function"}, "_fireAttrChange": {"guessedname": "_fireAttrChange", "params": [{"type": "String", "name": "attrName", "description": " The name of the attribute"}, {"type": "String", "name": "subAttrName", "description": " The full path of the property being changed, \nif this is a sub-attribute value being change. Otherwise null."}, {"type": "Any", "name": "currVal", "description": " The current value of the attribute"}, {"type": "Any", "name": "newVal", "description": " The new value of the attribute"}, {"type": "Object", "name": "opts", "description": " Any additional event data to mix into the attribute change event's event facade."}], "description": "Utility method to help setup the event payload and fire the attribute change event.", "private": "", "guessedtype": "function"}, "modifyAttr": {"params": [{"type": "String", "name": "name", "description": " The name of the attribute whose configuration is to be updated."}, {"type": "Object", "name": "config", "description": " An object with configuration property/value pairs, specifying the configuration properties to modify."}], "description": "Updates the configuration of an attribute which has already been added.\n
\nThe properties which can be modified through this interface are limited\nto the following subset of attributes, which can be safely modified\nafter a value has already been set on the attribute: readOnly, writeOnce, \nbroadcast and getter.\n
", "guessedname": "modifyAttr", "guessedtype": "function"}, "_protectAttrs": {"return": {"type": "Object", "description": "A protected version of the attrs argument."}, "description": "Utility method to protect an attribute configuration\nhash, by merging the entire object and the individual \nattr config objects.", "protected": "", "params": [{"type": "Object", "name": "attrs", "description": " A hash of attribute to configuration object pairs."}], "guessedname": "_protectAttrs", "guessedtype": "function"}, "_setAttr": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Provides the common implementation for the public set and protected _set methods.\nSee set for argument details.", "chainable": "", "protected": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute."}, {"type": "Any", "name": "value", "description": " The value to set the attribute to."}, {"type": "Object", "name": "opts", "description": " (Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event."}, {"type": "boolean", "name": "force", "description": " If true, allows the caller to set values for \nreadOnly or writeOnce attributes which have already been set."}], "guessedname": "_setAttr", "guessedtype": "function"}, "_normAttrVals": {"return": {"type": "Object", "description": "An object literal with 2 properties - \"simple\" and \"complex\",\ncontaining simple and complex attribute values respectively keyed \nby the top level attribute name, or null, if valueHash is falsey."}, "description": "Utility method to split out simple attribute name/value pairs (\"x\") \nfrom complex attribute name/value pairs (\"x.y.z\"), so that complex\nattributes can be keyed by the top level attribute name.", "private": "", "params": [{"type": "Object", "name": "valueHash", "description": " An object with attribute name/value pairs"}], "param": "{Object} valueHash An object with attribute name/value pairs", "guessedname": "_normAttrVals", "guessedtype": "function"}, "_defAttrChangeFn": {"guessedname": "_defAttrChangeFn", "params": [{"type": "EventFacade", "name": "e", "description": " The event object for attribute change events."}], "description": "Default function for attribute change events.", "private": "", "guessedtype": "function"}, "_addLazyAttr": {"guessedname": "_addLazyAttr", "params": [{"type": "Object", "name": "name", "description": " The name of the attribute"}], "description": "Finishes initializing an attribute which has been lazily added.", "private": "", "guessedtype": "function"}, "_getAttrInitVal": {"return": {"type": "Any", "description": "The initial value of the attribute."}, "description": "Returns the initial value of the given attribute from\neither the default configuration provided, or the \nover-ridden value if it exists in the set of initValues \nprovided and the attribute is not read-only.", "private": "", "params": [{"type": "String", "name": "attr", "description": " The name of the attribute"}, {"type": "Object", "name": "cfg", "description": " The attribute configuration object"}, {"type": "Object", "name": "initValues", "description": " The object with simple and complex attribute name/value pairs returned from _normAttrVals"}], "param": "{String} attr The name of the attribute", "guessedname": "_getAttrInitVal", "guessedtype": "function"}, "_getAttr": {"return": {"type": "Any", "description": "The value of the attribute."}, "description": "Provides the common implementation for the public get method,\nallowing Attribute hosts to over-ride either method.\nSee get for argument details.", "chainable": "", "protected": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute."}], "guessedname": "_getAttr", "guessedtype": "function"}, "_getAttrs": {"return": {"type": "Object", "description": "An object with attribute name/value pairs."}, "description": "Implementation behind the public getAttrs method, to get multiple attribute values.", "protected": "", "params": [{"type": "Array | boolean", "name": "attrs", "description": " Optional. An array of attribute names. If omitted, all attribute values are\nreturned. If set to true, all attributes modified from their initial values are returned."}], "guessedname": "_getAttrs", "guessedtype": "function"}, "removeAttr": {"params": [{"type": "String", "name": "name", "description": " The name of the attribute to be removed."}], "description": "Removes an attribute from the host object", "guessedname": "removeAttr", "guessedtype": "function"}, "get": {"return": {"type": "Any", "description": "The value of the attribute"}, "params": [{"type": "String", "name": "name", "description": " The name of the attribute. If the value of the attribute is an Object, \ndot notation can be used to obtain the value of a property of the object (e.g. get(\"x.y.z\"))"}], "description": "Returns the current value of the attribute. If the attribute\nhas been configured with a 'getter' function, this method will delegate\nto the 'getter' to obtain the value of the attribute.", "guessedname": "get", "guessedtype": "function"}, "_setStateVal": {"guessedname": "_setStateVal", "params": [{"type": "String", "name": "name", "description": " The name of the attribute"}, {"type": "Any", "name": "value", "description": " The value of the attribute"}], "description": "Sets the stored value for the attribute, in either the \ninternal state object, or the state proxy if it exits", "private": "", "guessedtype": "function"}, "addAttrs": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Configures a group of attributes, and sets initial values.\n
\nNOTE: This method does not isolate the configuration object by merging/cloning. \nThe caller is responsible for merging/cloning the configuration object if required.\n
", "chainable": "", "params": [{"type": "Object", "name": "cfgs", "description": " An object with attribute name/configuration pairs."}, {"type": "Object", "name": "values", "description": " An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only."}, {"type": "boolean", "name": "lazy", "description": " Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee addAttr."}], "guessedname": "addAttrs", "guessedtype": "function"}, "_getStateVal": {"return": {"type": "Any", "description": "The stored value of the attribute"}, "description": "Gets the stored value for the attribute, from either the \ninternal state object, or the state proxy if it exits", "private": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute"}], "guessedname": "_getStateVal", "guessedtype": "function"}, "_setAttrs": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Implementation behind the public setAttrs method, to set multiple attribute values.", "chainable": "", "protected": "", "params": [{"type": "Object", "name": "attrs", "description": " An object with attributes name/value pairs."}], "guessedname": "_setAttrs", "guessedtype": "function"}, "reset": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Resets the attribute (or all attributes) to its initial value, as long as\nthe attribute is not readOnly, or writeOnce.", "chainable": "", "params": [{"type": "String", "name": "name", "description": " Optional. The name of the attribute to reset. If omitted, all attributes are reset."}], "guessedname": "reset", "guessedtype": "function"}, "addAttr": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "
\nAdds an attribute with the provided configuration to the host object.\n
\n
\nThe config argument object supports the following properties:\n
\n
\n
value <Any>
\n
The initial value to set on the attribute
\n
valueFn <Function>
\n
A function, which will return the initial value to set on the attribute. This is useful\nfor cases where the attribute configuration is defined statically, but needs to \nreference the host instance (\"this\") to obtain an initial value.\nIf defined, this precedence over the value property.
\n
readOnly <boolean>
\n
Whether or not the attribute is read only. Attributes having readOnly set to true\ncannot be modified by invoking the set method.
\n
writeOnce <boolean>
\n
Whether or not the attribute is \"write once\". Attributes having writeOnce set to true, \ncan only have their values set once, be it through the default configuration, \nconstructor configuration arguments, or by invoking set.
\n
setter <Function>
\n
The setter function used to massage or normalize the value passed to the set method for the attribute. \nThe value returned by the setter will be the final stored value. Returning\nAttribute.INVALID_VALUE, from the setter will prevent\nthe value from being stored.
\n
getter <Function>
\n
The getter function used to massage or normalize the value returned by the get method for the attribute.\nThe value returned by the getter function is the value which will be returned to the user when they \ninvoke get.
\n
validator <Function>
\n
The validator function invoked prior to setting the stored value. Returning\nfalse from the validator function will prevent the value from being stored.
\n
broadcast <int>
\n
If and how attribute change events for this attribute should be broadcast. See CustomEvent's broadcast property for \nvalid values. By default attribute change events are not broadcast.
\n
lazyAdd <boolean>
\n
Whether or not to delay initialization of the attribute until the first call to get/set it. \nThis flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through \nthe addAttrs method.
\n
\n
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with\nthe context (\"this\") set to the host object.
\n
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
", "chainable": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute."}, {"type": "Object", "name": "config", "description": " An object with attribute configuration property/value pairs, specifying the configuration for the attribute.\n
\nNOTE: The configuration object is modified when adding an attribute, so if you need \nto protect the original values, you will need to merge the object.\n
"}, {"type": "boolean", "name": "lazy", "description": " (optional) Whether or not to add this attribute lazily (on the first call to get/set)."}], "guessedname": "addAttr", "guessedtype": "function"}, "attrAdded": {"return": {"type": "boolean", "description": "true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes."}, "params": [{"type": "String", "name": "name", "description": " The name of the attribute to check."}], "description": "Checks if the given attribute has been added to the host", "guessedname": "attrAdded", "guessedtype": "function"}, "_isLazyAttr": {"return": {"type": "boolean", "description": "true if it's a lazily added attribute, false otherwise."}, "description": "Checks whether or not the attribute is one which has been\nadded lazily and still requires initialization.", "private": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute"}], "guessedname": "_isLazyAttr", "guessedtype": "function"}, "_addAttrs": {"guessedname": "_addAttrs", "params": [{"type": "Object", "name": "cfgs", "description": " An object with attribute name/configuration pairs."}, {"type": "Object", "name": "values", "description": " An object with attribute name/value pairs, defining the initial values to apply.\nValues defined in the cfgs argument will be over-written by values in this argument unless defined as read only."}, {"type": "boolean", "name": "lazy", "description": " Whether or not to delay the intialization of these attributes until the first call to get/set.\nIndividual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration.\nSee addAttr."}], "description": "Implementation behind the public addAttrs method. \nThis method is invoked directly by get if it encounters a scenario \nin which an attribute's valueFn attempts to obtain the \nvalue an attribute in the same group of attributes, which has not yet \nbeen added (on demand initialization).", "private": "", "guessedtype": "function"}, "setAttrs": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Sets multiple attribute values.", "chainable": "", "params": [{"type": "Object", "name": "attrs", "description": " An object with attributes name/value pairs."}], "guessedname": "setAttrs", "guessedtype": "function"}, "_set": {"return": {"type": "Object", "description": "A reference to the host object."}, "description": "Allows setting of readOnly/writeOnce attributes. See set for argument details.", "chainable": "", "protected": "", "params": [{"type": "String", "name": "name", "description": " The name of the attribute."}, {"type": "Any", "name": "val", "description": " The value to set the attribute to."}, {"type": "Object", "name": "opts", "description": " (Optional) Optional event data to be mixed into\nthe event facade passed to subscribers of the attribute's change event."}], "guessedname": "_set", "guessedtype": "function"}}}, "StyleSheet": {"name": "StyleSheet", "constructors": [{"params": [{"type": "String|HTMLElement|Node", "name": "seed", "description": " a style or link node, its id, or a\nname or guid of a StyleSheet, or a string of css text"}, {"type": "String", "name": "name", "description": " (optional) name to register instance for future static\naccess"}], "description": "Create an instance of StyleSheet to encapsulate a css stylesheet.\nThe constructor can be called using function or constructor syntax.\n
var sheet = Y.StyleSheet(..);
\nor\n
var sheet = new Y.StyleSheet(..);
\nThe first parameter passed can be any of the following things:\n
\n
The desired string name to register a new empty sheet
\n
The string name of an existing StyleSheet instance
\n
The unique guid generated for an existing StyleSheet instance
\n
The id of an existing <link> or <style> node
\n
The node reference for an existing <link> or <style> node
\n
The Y.Node instance wrapping an existing <link> or <style> node
\n
A chunk of css text to create a new stylesheet from
\n
\n
If a string is passed, StyleSheet will first look in its static name\nregistry for an existing sheet, then in the DOM for an element with that id.\nIf neither are found and the string contains the { character, it will be\nused as a the initial cssText for a new StyleSheet. Otherwise, a new empty\nStyleSheet is created, assigned the string value as a name, and registered\nstatically by that name.
\n
The optional second parameter is a string name to register the sheet as.\nThis param is largely useful when providing a node id/ref or chunk of css\ntext to create a populated instance.
"}], "namespace": "", "module": "stylesheet", "methods": {"enable": {"chainable": "", "return": {"type": "StyleSheet", "description": ""}, "description": "Enable all the rules in the sheet", "guessedname": "enable", "guessedtype": "function"}, "StyleSheet.isValidSelector": {"return": {"type": "Boolean", "description": ""}, "description": "
Determines if a selector string is safe to use. Used internally\nin set to prevent IE from locking up when attempting to add a rule for a\n"bad selector".
\n
Bad selectors are considered to be any string containing unescaped\n`~!@$%^&()+=|{}[];'\"?< or space. Also forbidden are . or # followed by\nanything other than an alphanumeric. Additionally -abc or .-abc or\n#_abc or '# ' all fail. There are likely more failure cases, so\nplease file a bug if you encounter one.
", "static": "", "guessedname": "isValidSelector", "guessedtype": "function", "params": [{"type": "String", "name": "sel", "description": " the selector string"}]}, "getCssText": {"return": {"type": "String", "description": ""}, "params": [{"type": "String", "name": "sel", "description": " Selector string"}], "description": "Get the current cssText for a rule or the entire sheet. If the\nselector param is supplied, only the cssText for that rule will be\nreturned, if found. If the selector string targets multiple\nselectors separated by commas, the cssText of the first rule only\nwill be returned. If no selector string, the stylesheet's full\ncssText will be returned.", "guessedname": "getCssText", "guessedtype": "function"}, "isEnabled": {"return": {"type": "Boolean", "description": ""}, "description": "Returns false if the StyleSheet is disabled. Otherwise true.", "guessedname": "isEnabled", "guessedtype": "function"}, "disable": {"chainable": "", "return": {"type": "StyleSheet", "description": ""}, "description": "Disable all the rules in the sheet. Rules may be changed while the\nStyleSheet is disabled.", "guessedname": "disable", "guessedtype": "function"}, "set": {"return": {"type": "StyleSheet", "description": ""}, "description": "
Set style properties for a provided selector string.\nIf the selector includes commas, it will be split into individual\nselectors and applied accordingly. If the selector string does not\nhave a corresponding rule in the sheet, it will be added.
\n
The object properties in the second parameter must be the JavaScript\nnames of style properties. E.g. fontSize rather than font-size.
\n
The float style property will be set by any of "float",\n"styleFloat", or "cssFloat".
", "chainable": "", "params": [{"type": "String", "name": "sel", "description": " the selector string to apply the changes to"}, {"type": "Object", "name": "css", "description": " Object literal of style properties and new values"}], "guessedname": "set", "guessedtype": "function"}, "getId": {"return": {"type": "Number", "description": "the static id"}, "description": "Get the unique stamp for this StyleSheet instance", "guessedname": "getId", "guessedtype": "function"}, "StyleSheet.register": {"return": {"type": "Boolean", "description": "false if no name or sheet is not a StyleSheet\ninstance. true otherwise."}, "description": "Registers a StyleSheet instance in the static registry by the given name", "static": "", "guessedname": "register", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " the name to assign the StyleSheet in the registry"}, {"type": "StyleSheet", "name": "sheet", "description": " The StyleSheet instance"}]}, "unset": {"return": {"type": "StyleSheet", "description": ""}, "description": "
Unset style properties for a provided selector string, removing\ntheir effect from the style cascade.
\n
If the selector includes commas, it will be split into individual\nselectors and applied accordingly. If there are no properties\nremaining in the rule after unsetting, the rule is removed.
\n
The style property or properties in the second parameter must be the\nJavaScript style property names. E.g. fontSize rather than font-size.
\n
The float style property will be unset by any of "float",\n"styleFloat", or "cssFloat".
", "chainable": "", "params": [{"type": "String", "name": "sel", "description": " the selector string to apply the changes to"}, {"type": "String|Array", "name": "css", "description": " style property name or Array of names"}], "guessedname": "unset", "guessedtype": "function"}, "StyleSheet.toCssText": {"return": {"type": "String", "description": "the resulting cssText string"}, "description": "
Converts an object literal of style properties and values into a string\nof css text. This can then be assigned to el.style.cssText.
\n
The optional second parameter is a cssText string representing the\nstarting state of the style prior to alterations. This is most often\nextracted from the eventual target's current el.style.cssText.
", "static": "", "guessedname": "toCssText", "guessedtype": "property", "params": [{"type": "Object", "name": "css", "description": " object literal of style properties and values"}, {"type": "String", "name": "cssText", "description": " (optional) starting cssText value"}]}}, "file": "stylesheet.js", "shortname": "StyleSheet", "description": "Create an instance of StyleSheet to encapsulate a css stylesheet.\nThe constructor can be called using function or constructor syntax.\n
var sheet = Y.StyleSheet(..);
\nor\n
var sheet = new Y.StyleSheet(..);
\nThe first parameter passed can be any of the following things:\n
\n
The desired string name to register a new empty sheet
\n
The string name of an existing StyleSheet instance
\n
The unique guid generated for an existing StyleSheet instance
\n
The id of an existing <link> or <style> node
\n
The node reference for an existing <link> or <style> node
\n
The Y.Node instance wrapping an existing <link> or <style> node
\n
A chunk of css text to create a new stylesheet from
\n
\n
If a string is passed, StyleSheet will first look in its static name\nregistry for an existing sheet, then in the DOM for an element with that id.\nIf neither are found and the string contains the { character, it will be\nused as a the initial cssText for a new StyleSheet. Otherwise, a new empty\nStyleSheet is created, assigned the string value as a name, and registered\nstatically by that name.
\n
The optional second parameter is a string name to register the sheet as.\nThis param is largely useful when providing a node id/ref or chunk of css\ntext to create a populated instance.
"}, "YUI~oop": {"name": "YUI~oop", "namespace": "", "module": "oop", "methods": {"augment": {"return": {"type": "object", "description": "the augmented object"}, "description": "Applies prototype properties from the supplier to the receiver.\nThe receiver can be a constructor or an instance.", "params": [{"type": "Function", "name": "r", "description": " the object to receive the augmentation"}, {"type": "Function", "name": "s", "description": " the object that supplies the properties to augment"}, {"type": "boolean", "name": "ov", "description": " if true, properties already on the receiver\nwill be overwritten if found on the supplier."}, {"type": "string[]", "name": "wl", "description": " a whitelist. If supplied, only properties in \nthis list will be applied to the receiver."}, {"type": "Array | Any", "name": "args", "description": " arg or arguments to apply to the supplier\nconstructor when initializing."}], "guessedname": "augment", "guessedtype": "function", "todo": "constructor optional?"}, "extend": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "Function", "name": "r", "description": " the object to modify"}, {"type": "Function", "name": "s", "description": " the object to inherit"}, {"type": "Object", "name": "px", "description": " prototype properties to add/override"}, {"type": "Object", "name": "sx", "description": " static properties to add/override"}], "description": "Utility to set up the prototype, constructor and superclass properties to\nsupport an inheritance strategy that can chain constructors and methods.\nStatic members will not be inherited.", "guessedname": "extend", "guessedtype": "function"}, "bind": {"return": {"type": "function", "description": "the wrapped function"}, "params": [{"type": "Function|String", "name": "f", "description": " the function to bind, or a function name\nto execute on the context object"}, {"type": "", "name": "c", "description": " the execution context"}, {"type": "", "name": "args*", "description": " 0..n arguments to include before the arguments the \nfunction is executed with."}], "description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the beginning of the arguments collection the \nsupplied to the function.", "guessedname": "bind", "guessedtype": "function"}, "clone": {"return": {"type": "Array|Object", "description": "the cloned object"}, "description": "Deep obj/array copy. Functions are cloned with Y.bind.\nArray-like objects are treated as arrays.\nPrimitives are returned untouched. Optionally, a\nfunction can be provided to handle other data types,\nfilter keys, validate values, etc.", "params": [{"type": "", "name": "o", "description": " what to clone"}, {"type": "boolean", "name": "safe", "description": " if true, objects will not have prototype\nitems from the source. If false, they will. In this case, the\noriginal is initially protected, but the clone is not completely immune\nfrom changes to the source object prototype. Also, cloned prototype\nitems that are deleted from the clone will result in the value\nof the source prototype being exposed. If operating on a non-safe\nclone, items should be nulled out rather than deleted."}, {"type": "", "name": "f", "description": " optional function to apply to each item in a collection;\nit will be executed prior to applying the value to\nthe new object. Return false to prevent the copy."}, {"type": "", "name": "c", "description": " optional execution context for f"}, {"type": "", "name": "owner", "description": " Owner object passed when clone is iterating an\nobject. Used to set up context for cloned functions."}], "guessedname": "clone", "guessedtype": "function", "todo": "review"}, "rbind": {"return": {"type": "function", "description": "the wrapped function"}, "params": [{"type": "Function|String", "name": "f", "description": " the function to bind, or a function name\nto execute on the context object"}, {"type": "", "name": "c", "description": " the execution context"}, {"type": "", "name": "args*", "description": " 0..n arguments to append to the end of arguments collection\nsupplied to the function"}], "description": "Returns a function that will execute the supplied function in the\nsupplied object's context, optionally adding any additional\nsupplied parameters to the end of the arguments the function\nis executed with.", "guessedname": "rbind", "guessedtype": "function"}, "each": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "", "name": "o", "description": " the object to iterate"}, {"type": "", "name": "f", "description": " the function to execute. This function\nreceives the value, key, and object as parameters"}, {"type": "", "name": "proto", "description": " if true, prototype properties are\niterated on objects"}], "description": "Executes the supplied function for each item in\na collection. Supports arrays, objects, and\nY.NodeLists", "guessedname": "each", "guessedtype": "function"}, "aggregate": {"return": {"type": "object", "description": "the extended object"}, "params": [{"type": "Function", "name": "r", "description": " the object to receive the augmentation"}, {"type": "Function", "name": "s", "description": " the object that supplies the properties to augment"}, {"type": "boolean", "name": "ov", "description": " if true, properties already on the receiver\nwill be overwritten if found on the supplier."}, {"type": "string[]", "name": "wl", "description": " a whitelist. If supplied, only properties in \nthis list will be applied to the receiver."}], "description": "Applies object properties from the supplier to the receiver. If\nthe target has the property, and the property is an object, the target\nobject will be augmented with the supplier's value. If the property\nis an array, the suppliers value will be appended to the target.", "guessedname": "aggregate", "guessedtype": "function"}}, "file": "oop.js", "shortname": "YUI~oop", "description": "The following methods are added to the YUI instance"}, "Assert.Error": {"name": "Assert.Error", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "Error is thrown whenever an assertion fails. It provides methods\nto more easily get at error information and also provides a base class\nfrom which more specific assertion errors can be derived."}], "namespace": "Assert", "module": "test", "guessedname": "Error", "methods": {"valueOf": {"return": {"type": "String", "description": "A primitive value version of the error."}, "description": "Returns a primitive value version of the error. Same as toString().", "guessedname": "valueOf", "guessedtype": "function"}, "getMessage": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. This should\nbe overridden by all subclasses to provide specific information.", "guessedname": "getMessage", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "A string representation of the error."}, "description": "Returns a string representation of the error.", "guessedname": "toString", "guessedtype": "function"}}, "file": "Assert.js", "guessedtype": "function", "shortname": "Error", "properties": {"name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}}, "description": "Error is thrown whenever an assertion fails. It provides methods\nto more easily get at error information and also provides a base class\nfrom which more specific assertion errors can be derived."}, "DD.Scroll": {"properties": {"_scrollTimer": {"guessedname": "_scrollTimer", "type": "{Y.later}", "description": "Holder for the Timer object returned from Y.later.", "private": "", "guessedtype": "property"}, "_dimCache": {"guessedname": "_dimCache", "type": "Object", "description": "Cache of the dragNode dims.", "private": "", "guessedtype": "property"}, "_vpRegionCache": {"guessedname": "_vpRegionCache", "type": "Object", "description": "Cache of the Viewport dims.", "private": "", "guessedtype": "property"}, "_scrolling": {"guessedname": "_scrolling", "type": "Boolean", "description": "Tells if we are actively scrolling or not.", "private": "", "guessedtype": "property"}}, "name": "DD.Scroll", "constructors": [{"description": "This class is the base scroller class used to create the Plugin.DDNodeScroll and Plugin.DDWinScroll.\nThis class should not be called on it's own, it's designed to be a plugin."}], "namespace": "DD", "module": "dd", "events": {"hostChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "hostChange", "description": "Fires when the value for the configuration attribute 'host' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "windowScrollChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "windowScrollChange", "description": "Fires when the value for the configuration attribute 'windowScroll' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "verticalChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "verticalChange", "description": "Fires when the value for the configuration attribute 'vertical' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "bufferChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "bufferChange", "description": "Fires when the value for the configuration attribute 'buffer' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "horizontalChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "horizontalChange", "description": "Fires when the value for the configuration attribute 'horizontal' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "parentScrollChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "parentScrollChange", "description": "Fires when the value for the configuration attribute 'parentScroll' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "scrollDelayChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "scrollDelayChange", "description": "Fires when the value for the configuration attribute 'scrollDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "S", "methods": {"_cancelScroll": {"description": "Cancel a currently running scroll timer.", "private": "", "guessedname": "_cancelScroll", "guessedtype": "function"}, "end": {"description": "Called from the drag:end event", "guessedname": "end", "guessedtype": "function"}, "start": {"description": "Called from the drag:start event", "guessedname": "start", "guessedtype": "function"}, "align": {"description": "Called from the drag:align event to determine if we need to scroll.", "guessedname": "align", "guessedtype": "function"}, "_checkWinScroll": {"guessedname": "_checkWinScroll", "params": [{"type": "Boolean", "name": "move", "description": " Should we move the window. From Y.later"}], "description": "Check to see if we need to fire the scroll timer. If scroll timer is running this will scroll the window.", "private": "", "guessedtype": "function"}, "_setDimCache": {"description": "Set the cache of the dragNode dims.", "private": "", "guessedname": "_setDimCache", "guessedtype": "function"}, "toString": {"return": {"type": "", "description": "String name for the object"}, "description": "General toString method for logging", "guessedname": "toString", "guessedtype": "function"}, "_initScroll": {"description": "Cancel a previous scroll timer and init a new one.", "private": "", "guessedname": "_initScroll", "guessedtype": "function"}, "_getVPRegion": {"description": "Sets the _vpRegionCache property with an Object containing the dims from the viewport.", "private": "", "guessedname": "_getVPRegion", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "scroll.js", "guessedtype": "function", "shortname": "Scroll", "configs": {"vertical": {"type": "Boolean", "description": "Allow vertical scrolling, default: true.", "guessedname": "vertical", "guessedtype": "property"}, "scrollDelay": {"type": "Number", "description": "The number of milliseconds delay to pass to the auto scroller. Default: 235", "guessedname": "scrollDelay", "guessedtype": "property"}, "buffer": {"type": "Number", "description": "The number of pixels from the edge of the screen to turn on scrolling. Default: 30", "guessedname": "buffer", "guessedtype": "property"}, "windowScroll": {"type": "Boolean", "description": "Turn on window scroll support, default: false", "guessedname": "windowScroll", "guessedtype": "property"}, "host": {"type": "Object", "description": "The host we are plugged into.", "guessedname": "host", "guessedtype": "property"}, "parentScroll": {"type": "Node", "description": "Internal config option to hold the node that we are scrolling. Should not be set by the developer.", "guessedname": "parentScroll", "guessedtype": "property"}, "horizontal": {"type": "Boolean", "description": "Allow horizontal scrolling, default: true.", "guessedname": "horizontal", "guessedtype": "property"}}, "description": "This class is the base scroller class used to create the Plugin.DDNodeScroll and Plugin.DDWinScroll.\nThis class should not be called on it's own, it's designed to be a plugin."}, "Overlay": {"name": "Overlay", "constructors": [{"params": [{"type": "Object", "name": "object", "description": " The user configuration for the instance."}], "description": "A basic Overlay Widget, which can be positioned based on Page XY co-ordinates and is stackable (z-index support).\nIt also provides alignment and centering support and uses a standard module format for it's content, with header,\nbody and footer section support."}], "namespace": "", "module": "overlay", "guessedname": "Overlay", "uses": ["WidgetPosition", "WidgetStack", "WidgetPositionExt", "WidgetStdMod"], "superclass": "Widget", "file": "Overlay.js", "guessedtype": "property", "extends": "Widget", "shortname": "Overlay", "description": "A basic Overlay Widget, which can be positioned based on Page XY co-ordinates and is stackable (z-index support).\nIt also provides alignment and centering support and uses a standard module format for it's content, with header,\nbody and footer section support."}, "Test.DateAssert": {"name": "Test.DateAssert", "namespace": "Test", "module": "test", "guessedname": "DateAssert", "methods": {"datesAreEqual": {"static": "", "params": [{"type": "Date", "name": "expected", "description": " The expected date."}, {"type": "Date", "name": "actual", "description": " The actual date to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a date's month, day, and year are equal to another date's.", "guessedname": "datesAreEqual", "guessedtype": "function"}, "timesAreEqual": {"static": "", "params": [{"type": "Date", "name": "expected", "description": " The expected date."}, {"type": "Date", "name": "actual", "description": " The actual date to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a date's hour, minutes, and seconds are equal to another date's.", "guessedname": "timesAreEqual", "guessedtype": "function"}}, "static": "", "file": "DateAssert.js", "guessedtype": "property", "shortname": "DateAssert", "description": "The DateAssert object provides functions to test JavaScript Date objects\nfor a variety of cases."}, "Subscriber": {"name": "Subscriber", "constructors": [{"params": [{"type": "Function", "name": "fn", "description": " The wrapped function to execute"}, {"type": "Object", "name": "context", "description": " The value of the keyword 'this' in the listener"}, {"type": "Array", "name": "args*", "description": " 0..n additional arguments to supply the listener"}], "description": "Stores the subscriber information to be used when the event fires."}], "namespace": "", "module": "event-custom", "guessedname": "Subscriber", "methods": {"contains": {"return": {"type": "boolean", "description": "true if the supplied arguments match this \nsubscriber's signature."}, "params": [{"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "Object", "name": "context", "description": " optional 'this' keyword for the listener"}], "description": "Returns true if the fn and obj match this objects properties.\nUsed by the unsubscribe method to match the right subscriber.", "guessedname": "contains", "guessedtype": "function"}, "notify": {"params": [{"type": "Array", "name": "args", "description": " Arguments array for the subscriber"}, {"type": "CustomEvent", "name": "ce", "description": " The custom event that sent the notification"}], "description": "Executes the subscriber.", "guessedname": "notify", "guessedtype": "function"}}, "file": "event-custom.js", "guessedtype": "function", "shortname": "Subscriber", "properties": {"events": {"type": "{EventTarget}", "description": "Custom events for a given fire transaction.", "guessedname": "events", "guessedtype": "property"}, "args": {"type": "Array", "description": "Additional arguments to propagate to the subscriber", "guessedname": "args", "guessedtype": "property"}, "context": {"type": "Object", "description": "Optional 'this' keyword for the listener", "guessedname": "context", "guessedtype": "property"}, "fn": {"type": "Function", "description": "The callback that will be execute when the event fires\nThis is wrapped by Y.rbind if obj was supplied.", "guessedname": "fn", "guessedtype": "property"}, "id": {"type": "String", "description": "Unique subscriber id", "guessedname": "id", "guessedtype": "property"}}, "description": "Stores the subscriber information to be used when the event fires."}, "Test.ArrayAssert": {"name": "Test.ArrayAssert", "namespace": "Test", "module": "test", "guessedname": "ArrayAssert", "methods": {"containsMatch": {"static": "", "params": [{"type": "Function", "name": "matcher", "description": " A function that returns true if the items matches or false if not."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value matching some condition is present in an array. This uses\na function to determine a match.", "guessedname": "containsMatch", "guessedtype": "function"}, "doesNotContain": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value that is expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not present in an array. This uses the triple equals \nAsserts that a value is not present in an array. This uses the triple equals \nsign so no type cohersion may occur.", "guessedname": "doesNotContain", "guessedtype": "function"}, "indexOf": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value to look for."}, {"type": "Array", "name": "haystack", "description": " The array to search in."}, {"type": "int", "name": "index", "description": " The index at which the value should exist."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the given value is contained in an array at the specified index.\nThis uses the triple equals sign so no type cohersion will occur.", "guessedname": "indexOf", "guessedtype": "function"}, "itemsAreSame": {"static": "", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the values in an array are the same, and in the same position,\nas values in another array. This uses the triple equals sign\nso no type cohersion will occur. Note that the array objects themselves\nneed not be the same for this test to pass.", "guessedname": "itemsAreSame", "guessedtype": "function"}, "contains": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value that is expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is present in an array. This uses the triple equals \nsign so no type cohersion may occur.", "guessedname": "contains", "guessedtype": "function"}, "containsItems": {"static": "", "params": [{"type": "Object[]", "name": "needles", "description": " An array of values that are expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values to check."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a set of values are present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nbe found.", "guessedname": "containsItems", "guessedtype": "function"}, "doesNotContainItems": {"static": "", "params": [{"type": "Object[]", "name": "needles", "description": " An array of values that are not expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values to check."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a set of values are not present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nnot be found.", "guessedname": "doesNotContainItems", "guessedtype": "function"}, "itemsAreEquivalent": {"return": {"type": "Void", "description": ""}, "description": "Asserts that the values in an array are equivalent, and in the same position,\nas values in another array. This uses a function to determine if the values\nare equivalent. Note that the array objects themselves\nneed not be the same for this test to pass.", "static": "", "guessedname": "itemsAreEquivalent", "guessedtype": "function", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "Function", "name": "comparator", "description": " A function that returns true if the values are equivalent\nor false if not."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}]}, "itemsAreEqual": {"static": "", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the values in an array are equal, and in the same position,\nas values in another array. This uses the double equals sign\nso type cohersion may occur. Note that the array objects themselves\nneed not be the same for this test to pass.", "guessedname": "itemsAreEqual", "guessedtype": "function"}, "isEmpty": {"static": "", "params": [{"type": "Array", "name": "actual", "description": " The array to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an array is empty.", "guessedname": "isEmpty", "guessedtype": "function"}, "lastIndexOf": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value to look for."}, {"type": "Array", "name": "haystack", "description": " The array to search in."}, {"type": "int", "name": "index", "description": " The index at which the value should exist."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the given value is contained in an array at the specified index,\nstarting from the back of the array.\nThis uses the triple equals sign so no type cohersion will occur.", "guessedname": "lastIndexOf", "guessedtype": "function"}, "isNotEmpty": {"static": "", "params": [{"type": "Array", "name": "actual", "description": " The array to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an array is not empty.", "guessedname": "isNotEmpty", "guessedtype": "function"}, "doesNotContainMatch": {"static": "", "params": [{"type": "Function", "name": "matcher", "description": " A function that returns true if the items matches or false if not."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that no values matching a condition are present in an array. This uses\na function to determine a match.", "guessedname": "doesNotContainMatch", "guessedtype": "function"}}, "static": "", "file": "ArrayAssert.js", "guessedtype": "property", "shortname": "ArrayAssert", "description": "The ArrayAssert object provides functions to test JavaScript array objects\nfor a variety of cases."}, "YUI~substitute": {"name": "YUI~substitute", "namespace": "", "module": "substitute", "methods": {"substitute": {"return": {"type": "string", "description": "the substituted string"}, "params": [{"type": "string", "name": "s", "description": " The string that will be modified."}, {"type": "", "name": "o", "description": " An object containing the replacement values"}, {"type": "function", "name": "f", "description": " An optional function that can be used to\nprocess each match. It receives the key,\nvalue, and any extra metadata included with\nthe key inside of the braces."}], "description": "Does variable substitution on a string. It scans through the string \nlooking for expressions enclosed in { } braces. If an expression \nis found, it is used a key on the object. If there is a space in\nthe key, the first word is used for the key and the rest is provided\nto an optional function to be used to programatically determine the\nvalue (the extra information might be used for this decision). If \nthe value for the key in the object, or what is returned from the\nfunction has a string value, number value, or object value, it is \nsubstituted for the bracket expression and it repeats. If this\nvalue is an object, it uses the Object's toString() if this has\nbeen overridden, otherwise it does a shallow dump of the key/value\npairs if Y.dump is available (if dump isn't available, toString()\nis used).\nThis method is included in the 'substitute' module. It is not included\nin the YUI module.", "guessedname": "substitute", "guessedtype": "function"}}, "file": "substitute.js", "shortname": "YUI~substitute", "description": "The following methods are added to the YUI instance"}, "io": {"name": "io", "namespace": "", "module": "io", "properties": {"_headers": {"description": "Object of default HTTP headers to be initialized and sent\nfor all transactions.", "private": "", "static": "", "guessedname": "_headers", "guessedtype": "property", "type": "object"}, "_qState": {"description": "Property to determine whether the queue is set to\n1 (active) or 0 (inactive). When inactive, transactions\nwill be stored in the queue until the queue is set to active.", "private": "", "static": "", "guessedname": "_qState", "guessedtype": "property", "type": "int"}, "_rS": {"description": "Map of transaction state used when XDomainRequest is the\nXDR transport.", "private": "", "static": "", "guessedname": "_rS", "guessedtype": "property", "type": "object"}, "_transport": {"description": "Map of io transports.", "private": "", "static": "", "guessedname": "_transport", "guessedtype": "property", "type": "object"}, "_timeout": {"description": "Object that stores timeout values for any transaction with\na defined \"timeout\" configuration property.", "private": "", "static": "", "guessedname": "_timeout", "guessedtype": "property", "type": "object"}, "transactionId": {"description": "A transaction counter that increments for each transaction.", "private": "", "static": "", "guessedname": "transactionId", "guessedtype": "property", "type": "int"}, "_fn": {"description": "Object that stores callback handlers for cross-domain requests\nwhen using Flash as the transport.", "private": "", "static": "", "guessedname": "_fn", "guessedtype": "property", "type": "object"}, "_e": {"static": "", "type": "Object", "description": "Reference to \"io:complete\" event handler.", "private": ""}, "_yQ": {"description": "Array of transactions queued for processing", "private": "", "static": "", "guessedname": "_q", "guessedtype": "property", "type": "Object"}}, "methods": {"_concat": {"return": {"type": "", "description": "int"}, "static": "", "params": [{"type": "string", "name": "s", "description": " - URI or root data."}, {"type": "string", "name": "d", "description": " - data to be concatenated onto URI."}], "description": "Method that concatenates string data for HTTP GET transactions.", "private": ""}, "_stop": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method for setting queue processing to inactive.\nTransaction requests to YUI.io.queue() will be stored in the queue, but\nnot processed until the queue is reset to \"active\".", "private": ""}, "_ioEnd": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - transaction object."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Fires event \"io:end\" and creates, fires a\ntransaction-specific \"end\" event, if config.on.end is\ndefined.", "private": ""}, "_handle": {"return": {"type": "void", "description": ""}, "static": "", "params": [{"type": "o", "name": "o", "description": " The transaction object"}, {"type": "object", "name": "c", "description": " Configuration object for the transaction."}], "description": "Bound to the iframe's Load event and processes\nthe response data.", "private": ""}, "header": {"return": {"type": "", "description": "int"}, "description": "Method that stores default client headers for all transactions.\nIf a label is passed with no value argument, the header will be deleted.\nThis is the interface for _setHeader().", "static": "", "guessedname": "header", "guessedtype": "property", "params": [{"type": "string", "name": "l", "description": " - HTTP header"}, {"type": "string", "name": "v", "description": " - HTTP header value"}], "public": ""}, "_startTimeout": {"return": {"type": "", "description": "void"}, "description": "Starts timeout count if the configuration object\nhas a defined timeout property.", "param": "{object} o Transaction object generated by _create().", "static": "", "private": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "object", "name": "c", "description": " - Configuration object passed to YUI.io()."}]}, "_ioFailure": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - transaction object."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Fires event \"io:failure\" and creates, fires a\ntransaction-specific \"failure\" event, if config.on.failure is\ndefined.", "private": ""}, "io": {"return": {"type": "", "description": "object"}, "description": "Method for requesting a transaction. This\nis the interface for _io().", "static": "", "guessedname": "io", "guessedtype": "property", "params": [{"type": "string", "name": "uri", "description": " - qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "public": ""}, "_isInProgress.": {"static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create() in io-base."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Method for determining if an XDR transaction has completed\nand all data are received.", "private": ""}, "_size": {"static": "", "return": {"type": "", "description": "int"}, "description": "Method to query the current size of the queue.", "private": ""}, "_data": {"return": {"type": "", "description": "object"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create() in io-base."}, {"type": "boolean", "name": "isFlash", "description": " - True if Flash was used as the transport."}, {"type": "boolean", "name": "isXML", "description": " - True if the response data are XML."}], "description": "Creates a response object for XDR transactions, for success\nand failure cases.", "private": ""}, "_ioSuccess": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - transaction object."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Fires event \"io:success\" and creates, fires a\ntransaction-specific \"success\" event, if config.on.success is\ndefined.", "private": ""}, "size": {"return": {"type": "", "description": "number"}, "description": "Method to query the current size of the queue, or to\nset a maximum queue size. This is the interface for _size().", "static": "", "guessedname": "size", "guessedtype": "property", "params": [{"type": "number", "name": "i", "description": " - Specified maximum size of queue."}], "public": ""}, "_remove": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method for removing a specific, pending transaction from\nthe queue.", "private": ""}, "_readyState": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "object", "name": "c", "description": " - Configuration object passed to YUI.io()."}], "description": "Event handler bound to onreadystatechange.", "private": ""}, "start": {"return": {"type": "", "description": "void"}, "description": "Method for setting the queue to active. If there are\ntransactions pending in the queue, they will be processed from the\nqueue in FIFO order. This is the interface for _start().", "static": "", "guessedname": "start", "guessedtype": "property", "public": ""}, "_clearTimeout": {"return": {"type": "", "description": "void"}, "description": "Clears the timeout interval started by _startTimeout().", "param": "{number} id - Transaction ID.", "static": "", "private": "", "params": [{"type": "number", "name": "id", "description": " - Transaction id."}]}, "_subscribe": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "string", "name": "e", "description": " - event to be published"}, {"type": "object", "name": "c", "description": " - configuration data subset for event subscription."}], "description": "Method for creating and subscribing transaction events.", "private": ""}, "transport": {"return": {"type": "", "description": "void"}, "description": "Method to initialize the desired transport.", "static": "", "guessedname": "transport", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " - object of transport configurations."}], "public": ""}, "_serialize": {"return": {"type": "", "description": "string"}, "description": "Method to enumerate through an HTML form's elements collection\nand return a string comprised of key-value pairs.", "private": "", "static": "", "guessedname": "_serialize", "guessedtype": "function", "params": [{"type": "object", "name": "c", "description": " - YUI form node or HTML form id."}, {"type": "string", "name": "s", "description": " - Transaction data defined in the configuration."}]}, "_create": {"return": {"type": "", "description": "object"}, "description": "Method that creates a unique transaction object for each\nrequest.", "param": "{object} o Transaction object generated by _create().", "static": "", "private": "", "params": [{"type": "number", "name": "c", "description": " - configuration object subset to determine if\nthe transaction is an XDR or file upload,\nrequiring an alternate transport."}, {"type": "number", "name": "i", "description": " - transaction id"}]}, "_upload": {"return": {"type": "void", "description": ""}, "description": "Uploads HTML form data, inclusive of files/attachments,\nusing the iframe created in _create to facilitate the transaction.", "private": "", "static": "", "guessedname": "_upload", "guessedtype": "function", "params": [{"type": "o", "name": "o", "description": " The transaction object"}, {"type": "object", "name": "uri", "description": " Qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " Configuration object for the transaction."}]}, "_resend": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "string", "name": "uri", "description": " - qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Resends an XDR transaction, using the Flash tranport,\nif the native transport fails.", "private": ""}, "xdrResponse": {"return": {"type": "", "description": "object"}, "description": "Response controller for cross-domain requests when using the\nFlash transport or IE8's XDomainRequest object.", "private": "", "static": "", "guessedname": "xdrResponse", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create() in io-base."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}, {"type": "string", "name": "e", "description": " - Event name"}]}, "_destroy": {"return": {"type": "void", "description": ""}, "static": "", "params": [{"type": "o", "name": "o", "description": " The transaction object"}, {"type": "object", "name": "uri", "description": " Qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " Configuration object for the transaction."}], "description": "", "private": ""}, "stop": {"return": {"type": "", "description": "void"}, "description": "Method for setting queue processing to inactive.\nTransaction requests to YUI.io.queue() will be stored in the queue, but\nnot processed until the queue is restarted. This is the\ninterface for _stop().", "static": "", "guessedname": "stop", "guessedtype": "property", "public": ""}, "_shift": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method Process the first transaction from the\nqueue in FIFO order.", "private": ""}, "_setHeader": {"return": {"type": "", "description": "int"}, "static": "", "params": [{"type": "string", "name": "l", "description": " - HTTP header"}, {"type": "string", "name": "v", "description": " - HTTP header value"}], "description": "Method that stores default client headers for all transactions.\nIf a label is passed with no value argument, the header will be deleted.", "private": ""}, "_swf": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "string", "name": "uri", "description": " - location of io.swf."}, {"type": "string", "name": "yid", "description": " - YUI instance id."}], "description": "Method that creates the Flash transport swf.", "private": ""}, "_xdr": {"return": {"type": "", "description": "void"}, "description": "Sets event handlers for XDomainRequest transactions.", "param": "{string} uri - qualified path to transaction resource.", "static": "", "private": "", "guessedname": "xdr", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create() in io-base."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}]}, "_ioComplete": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - transaction object."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Fires event \"io:complete\" and creates, fires a\ntransaction-specific \"complete\" event, if config.on.complete is\ndefined.", "private": ""}, "appendData": {"return": {"type": "array", "description": "e Array of created fields."}, "static": "", "params": [{"type": "object", "name": "f", "description": " HTML form object."}, {"type": "string", "name": "s", "description": " The key-value POST data."}], "description": "Parses the POST data object and creates hidden form elements\nfor each key-value, and appends them to the HTML form object.", "private": ""}, "promote": {"return": {"type": "", "description": "void"}, "description": "Method for promoting a transaction to the top of the queue.\nThis is the interface for _unshift().", "static": "", "guessedname": "promote", "guessedtype": "property", "params": [{"type": "Object", "name": "o", "description": " - Reference to queued transaction."}], "public": ""}, "_setAttrs": {"return": {"type": "void", "description": ""}, "static": "", "params": [{"type": "object", "name": "f", "description": " HTML form object."}, {"type": "object", "name": "id", "description": " The Transaction ID."}, {"type": "object", "name": "uri", "description": " Qualified path to transaction resource."}], "description": "Sets the appropriate attributes and values to the HTML\nform, in preparation of a file upload transaction.", "private": ""}, "_setHeaders": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - XHR instance for the specific transaction."}, {"type": "object", "name": "h", "description": " - HTTP headers for the specific transaction, as defined\nin the configuration object passed to YUI.io()."}], "description": "Method that sets all HTTP headers to be sent in a transaction.", "private": ""}, "_xhr": {"static": "", "return": {"type": "", "description": "object"}, "description": "Method that creates the XMLHttpRequest transport", "private": ""}, "_queue": {"static": "", "return": {"type": "", "description": "Object"}, "description": "Method for requesting a transaction, and queueing the\nrequest before it is sent to the resource.", "private": ""}, "f": {"return": {"type": "void", "description": ""}, "static": "", "params": [{"type": "object", "name": "f", "description": " HTML form object."}, {"type": "object", "name": "o", "description": " HTML form fields created from configuration.data."}], "description": "Removes the custom fields created to pass additional POST\ndata, along with the HTML form fields.", "private": ""}, "_abort": {"static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create() in io-base."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Method for intiating an XDR transaction abort.", "private": ""}, "remove": {"return": {"type": "", "description": "void"}, "description": "Method for removing a specific, pending transaction from\nthe queue. This is the interface for _remove().", "static": "", "guessedname": "remove", "guessedtype": "property", "params": [{"type": "Object", "name": "o", "description": " - Reference to queued transaction."}], "public": ""}, "_io": {"return": {"type": "", "description": "object"}, "static": "", "params": [{"type": "string", "name": "uri", "description": " - qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}, {"type": "number", "name": "i", "description": " - transaction id, if already set by queue."}], "description": "Method for requesting a transaction. _io() is implemented as\nyui.io(). Each transaction may include a configuration object. Its\nproperties are:\nmethod: HTTP method verb (e.g., GET or POST). If this property is not\nnot defined, the default value will be GET.\ndata: This is the name-value string that will be sent as the transaction\ndata. If the request is HTTP GET, the data become part of\nquerystring. If HTTP POST, the data are sent in the message body.\nxdr: Defines the transport to be used for cross-domain requests. By\nsetting this property, the transaction will use the specified\ntransport instead of XMLHttpRequest. Currently, the only alternate\ntransport supported is Flash (e.g., { xdr: 'flash' }).\nform: This is a defined object used to process HTML form as data. The\nproperties are:\n{\nid: object, //HTML form object or id of HTML form\nuseDisabled: boolean, //Allow disabled HTML form field values\nto be sent as part of the data.\n}\non: This is a defined object used to create and handle specific\nevents during a transaction lifecycle. These events will fire in\naddition to the global io events. The events are:\nstart - This event is fired when a request is sent to a resource.\ncomplete - This event fires when the transaction is complete.\nsuccess - This event fires when the response status resolves to\nHTTP 2xx.\nfailure - This event fires when the response status resolves to\nHTTP 4xx, 5xx; and, for all transaction exceptions,\nincluding aborted transactions and transaction timeouts.\nend - This even is fired at the conclusion of the transaction\nlifecycle, after a success or failure resolution.\nThe properties are:\n{\nstart: function(id, args){},\ncomplete: function(id, responseobject, args){},\nsuccess: function(id, responseobject, args){},\nfailure: function(id, responseobject, args){},\nend: function(id, args){}\n}\nEach property can reference a function or be written as an\ninline function.\ncontext: Object reference for an event handler when it is implemented\nas a method of a base object. Defining \"context\" will preserve\nthe proper reference of \"this\" used in the event handler.\nheaders: This is a defined object of client headers, as many as.\ndesired for the transaction. These headers are sentThe object\npattern is:\n{\nheader: value\n}\ntimeout: This value, defined as milliseconds, is a time threshold for the\ntransaction. When this threshold is reached, and the transaction's\nComplete event has not yet fired, the transaction will be aborted.\narguments: Object, array, string, or number passed to all registered\nevent handlers. This value is available as the second\nargument in the \"start\" and \"abort\" event handlers; and, it is\nthe third argument in the \"complete\", \"success\", and \"failure\"\nevent handlers.", "private": ""}, "_ioStart": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "number", "name": "id", "description": " - transaction id"}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Fires event \"io:start\" and creates, fires a\ntransaction-specific start event, if config.on.start is\ndefined.", "private": ""}, "_resetAttrs": {"return": {"type": "void", "description": ""}, "static": "", "params": [{"type": "object", "name": "f", "description": " HTML form object."}, {"type": "object", "name": "a", "description": " Object of original attributes."}], "description": "Sets the appropriate attributes and values to the HTML\nform, in preparation of a file upload transaction.", "private": ""}, "_unshift": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method for promoting a transaction to the top of the queue.", "private": ""}, "_handleResponse": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "object", "name": "c", "description": " - Configuration object passed to io()."}], "description": "Method that determines if a transaction response qualifies\nas success or failure, based on the response HTTP status code, and\nfires the appropriate success or failure events.", "private": ""}, "_ioCancel": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "string", "name": "s", "description": " - Identifies timed out or aborted transaction."}], "description": "Terminates a transaction due to an explicit abort or\ntimeout.", "private": ""}, "_id": {"static": "", "return": {"type": "", "description": "int"}, "description": "Method that increments _transactionId for each transaction.", "private": ""}, "xdrReady": {"return": {"type": "", "description": "void"}, "description": "Fires event \"io:xdrReady\"", "private": "", "static": "", "guessedname": "xdrReady", "guessedtype": "function", "params": [{"type": "number", "name": "id", "description": " - transaction id"}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}]}}, "file": "io-base.js", "shortname": "io", "events": {"io:end": {"type": "Event Custom", "description": "This event signifies the end of the transaction lifecycle. The\ntransaction transport is destroyed.", "guessedname": "E_END", "guessedtype": "property"}, "io:start": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is initiated.", "guessedname": "E_START", "guessedtype": "property"}, "io:complete": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is complete.\nResponse status and data are accessible, if available.", "guessedname": "E_COMPLETE", "guessedtype": "property"}, "io:failure": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is complete, and\nthe HTTP status resolves to HTTP4xx, 5xx and above.", "guessedname": "E_FAILURE", "guessedtype": "property"}, "io:success": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is complete, and\nthe HTTP status resolves to HTTP2xx.", "guessedname": "E_SUCCESS", "guessedtype": "property"}, "io:xdrReady": {"type": "Event Custom", "description": "This event is fired by YUI.io when the specified transport is\nready for use.", "guessedname": "E_XDR_READY", "guessedtype": "property"}}, "description": "The io class is a utility that brokers HTTP requests through a simplified\ninterface. Specifically, it allows JavaScript to make HTTP requests to\na resource without a page reload. The underlying transport for making\nsame-domain requests is the XMLHttpRequest object. YUI.io can also use\nFlash, if specified as a transport, for cross-domain requests."}, "Test.Suite": {"name": "Test.Suite", "constructors": [{"params": [{"type": "String||Object", "name": "data", "description": " The name of the test suite or an object containing\na name property as well as setUp and tearDown methods."}], "description": "A test suite that can contain a collection of TestCase and TestSuite objects."}], "namespace": "Test", "module": "test", "guessedname": "Suite", "methods": {"XML": {"return": {"type": "String", "description": "An XML-formatted string of results."}, "description": "Returns test results formatted as an XML string.", "param": "{Object} result The results object created by TestRunner.", "static": "", "guessedname": "XML", "guessedtype": "function", "params": [{"type": "Object", "name": "result", "description": " The results object created by TestRunner."}]}, "tearDown": {"return": {"type": "Void", "description": ""}, "description": "Function to run after each test is executed.", "guessedname": "tearDown", "guessedtype": "function"}, "setUp": {"return": {"type": "Void", "description": ""}, "description": "Function to run before each test is executed.", "guessedname": "setUp", "guessedtype": "function"}, "JSON": {"return": {"type": "String", "description": "A JSON-formatted string of results."}, "description": "Returns test results formatted as a JSON string. Requires JSON utility.", "static": "", "guessedname": "JSON", "guessedtype": "function", "params": [{"type": "Object", "name": "result", "description": " The results object created by TestRunner."}]}, "add": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Y.Test.Suite||Y.Test.Case", "name": "testObject", "description": " The test suite or test case to add."}], "description": "Adds a test suite or test case to the test suite.", "guessedname": "add", "guessedtype": "function"}, "JUnitXML": {"return": {"type": "String", "description": "An XML-formatted string of results."}, "description": "Returns test results formatted in JUnit XML format.", "static": "", "guessedname": "JUnitXML", "guessedtype": "function", "params": [{"type": "Object", "name": "result", "description": " The results object created by TestRunner."}]}}, "file": "TestSuite.js", "guessedtype": "function", "shortname": "Suite", "properties": {"items": {"private": "", "description": "Array of test suites and", "guessedname": "items", "guessedtype": "property"}, "name": {"type": "String", "description": "The name of the test suite.", "guessedname": "name", "guessedtype": "property"}}, "description": "A test suite that can contain a collection of TestCase and TestSuite objects."}, "Assert.UnexpectedError": {"name": "Assert.UnexpectedError", "constructors": [{"params": [{"type": "Error", "name": "cause", "description": " The unexpected error that caused this error to be \nthrown."}], "description": "UnexpectedError is subclass of Error that is thrown whenever\nan error occurs within the course of a test and the test was not expected\nto throw an error."}], "namespace": "Assert", "module": "test", "guessedname": "UnexpectedError", "extends": "Assert.Error", "superclass": "Assert.Error", "file": "Assert.js", "guessedtype": "function", "shortname": "UnexpectedError", "properties": {"cause": {"type": "Error", "description": "The unexpected error that occurred.", "guessedname": "cause", "guessedtype": "property"}, "name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}, "stack": {"type": "String", "description": "Stack information for the error (if provided).", "guessedname": "stack", "guessedtype": "property"}}, "description": "UnexpectedError is subclass of Error that is thrown whenever\nan error occurs within the course of a test and the test was not expected\nto throw an error."}, "Do": {"name": "Do", "namespace": "", "module": "event-custom", "guessedname": "BEFORE", "methods": {"_inject": {"return": {"type": "string", "description": "handle for the subscription"}, "description": "Execute the supplied method after the specified function", "private": "", "static": "", "guessedname": "_inject", "guessedtype": "function", "params": [{"type": "string", "name": "when", "description": " before or after"}, {"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "", "name": "obj", "description": " the object hosting the method to displace"}, {"type": "string", "name": "sFn", "description": " the name of the method to displace"}, {"type": "", "name": "c", "description": " The execution context for fn"}]}, "detach": {"params": [{"type": "string", "name": "handle", "description": " the subscription handle"}], "description": "Detach a before or after subscription", "guessedname": "detach", "guessedtype": "function"}, "after": {"return": {"type": "string", "description": "handle for the subscription"}, "description": "Execute the supplied method after the specified function", "static": "", "guessedname": "after", "guessedtype": "function", "params": [{"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "", "name": "obj", "description": " the object hosting the method to displace"}, {"type": "string", "name": "sFn", "description": " the name of the method to displace"}, {"type": "", "name": "c", "description": " The execution context for fn"}]}, "before": {"return": {"type": "string", "description": "handle for the subscription"}, "description": "Execute the supplied method before the specified function", "static": "", "guessedname": "before", "guessedtype": "function", "params": [{"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "", "name": "obj", "description": " the object hosting the method to displace"}, {"type": "string", "name": "sFn", "description": " the name of the method to displace"}, {"type": "", "name": "c", "description": " The execution context for fn"}]}}, "static": "", "file": "event-do.js", "guessedtype": "property", "shortname": "Do", "properties": {"objs": {"static": "", "description": "Cache of objects touched by the utility", "guessedname": "objs", "guessedtype": "property"}}, "description": "Allows for the insertion of methods that are executed before or after\na specified method"}, "Anim": {"name": "Anim", "for": "Anim", "configs": {"node": {"type": "Node", "description": "The object to be animated.", "guessedname": "node", "guessedtype": "property"}, "paused": {"description": "Whether or not the animation is currently paused.", "default": "false", "readonly": "", "guessedname": "paused", "guessedtype": "property", "type": "Boolean"}, "direction": {"default": "\"normal\"", "type": "String", "description": "How iterations of the animation should behave. \nPossible values are \"normal\" and \"alternate\".\nNormal will repeat the animation, alternate will reverse on every other pass.", "guessedname": "direction", "guessedtype": "property"}, "from": {"type": "Object", "description": "The starting values for the animated properties. \nFields may be strings, numbers, or functions.\nIf a function is used, the return value becomes the from value.\nIf no from value is specified, the DEFAULT_GETTER will be used.", "guessedname": "from", "guessedtype": "property"}, "iterations": {"default": "1", "type": "Int", "description": "The number of times the animation should run", "guessedname": "iterations", "guessedtype": "property"}, "iterationCount": {"description": "The number of iterations that have occurred.\nResets when an animation ends (reaches iteration count or stop() called).", "default": "0", "readonly": "", "guessedname": "iterationCount", "guessedtype": "property", "type": "Int"}, "elapsedTime": {"description": "Current time the animation has been running.", "default": "0", "readonly": "", "guessedname": "elapsedTime", "guessedtype": "property", "type": "Int"}, "to": {"type": "Object", "description": "The ending values for the animated properties. \nFields may be strings, numbers, or functions.", "guessedname": "to", "guessedtype": "property"}, "running": {"description": "Whether or not the animation is currently running.", "default": "false", "readonly": "", "guessedname": "running", "guessedtype": "property", "type": "Boolean"}, "startTime": {"description": "Date stamp for the first frame of the animation.", "default": "0", "readonly": "", "guessedname": "startTime", "guessedtype": "property", "type": "Int"}, "duration": {"type": "NUM", "description": "The length of the animation. Defaults to \"1\" (second).", "guessedname": "duration", "guessedtype": "property"}, "easing": {"type": "Function", "description": "The method that will provide values to the attribute(s) during the animation. \nDefaults to \"Easing.easeNone\".", "guessedname": "easing", "guessedtype": "property"}, "reverse": {"default": "false", "type": "Boolean", "description": "If true, animation begins from last frame", "guessedname": "reverse", "guessedtype": "property"}}, "description": "A class for constructing animation instances.", "constructors": [{"description": "A class for constructing animation instances."}], "namespace": "", "module": "anim", "properties": {"behaviors": {"static": "", "description": "Bucket for custom getters and setters", "guessedname": "behaviors", "guessedtype": "property"}, "DEFAULT_GETTER": {"static": "", "description": "The default getter to use when getting object properties.", "guessedname": "DEFAULT_GETTER", "guessedtype": "function"}, "DEFAULT_UNIT": {"static": "", "description": "The default unit to use with properties that pass the RE_DEFAULT_UNIT test.", "guessedname": "DEFAULT_UNIT", "guessedtype": "property"}, "RE_DEFAULT_UNIT": {"static": "", "description": "Regex of properties that should use the default unit.", "guessedname": "RE_DEFAULT_UNIT", "guessedtype": "property"}, "DEFAULT_SETTER": {"static": "", "description": "The default setter to use when setting object properties.", "guessedname": "DEFAULT_SETTER", "guessedtype": "function"}}, "guessedname": "RUNNING", "extends": "Base", "superclass": "Base", "file": "anim.js", "guessedtype": "property", "shortname": "Anim", "events": {"iterationCountChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "iterationCountChange", "description": "Fires when the value for the configuration attribute 'iterationCount' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "reverseChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "reverseChange", "description": "Fires when the value for the configuration attribute 'reverse' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "end": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The end event."}], "description": "fires after the animation completes.", "guessedname": "END", "guessedtype": "property"}, "durationChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "durationChange", "description": "Fires when the value for the configuration attribute 'duration' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "resume": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The pause event."}], "description": "fires when an animation is resumed (run from pause)."}, "iteration": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The iteration event."}], "description": "fires when an animation begins an iteration."}, "toChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "toChange", "description": "Fires when the value for the configuration attribute 'to' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "iterationsChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "iterationsChange", "description": "Fires when the value for the configuration attribute 'iterations' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "nodeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "nodeChange", "description": "Fires when the value for the configuration attribute 'node' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "tween": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The tween event."}], "description": "fires every frame of the animation.", "guessedname": "TWEEN", "guessedtype": "property"}, "start": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The start event."}], "description": "fires when an animation begins.", "guessedname": "START", "guessedtype": "property"}, "fromChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "fromChange", "description": "Fires when the value for the configuration attribute 'from' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "pause": {"type": "Event.Custom", "params": [{"type": "Event", "name": "ev", "description": " The pause event."}], "description": "fires when an animation is paused."}, "runningChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "runningChange", "description": "Fires when the value for the configuration attribute 'running' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "pausedChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "pausedChange", "description": "Fires when the value for the configuration attribute 'paused' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "startTimeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "startTimeChange", "description": "Fires when the value for the configuration attribute 'startTime' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "directionChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "directionChange", "description": "Fires when the value for the configuration attribute 'direction' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "elapsedTimeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "elapsedTimeChange", "description": "Fires when the value for the configuration attribute 'elapsedTime' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "easingChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "easingChange", "description": "Fires when the value for the configuration attribute 'easing' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "methods": {"getBezier": {"return": {"type": "Array", "description": "An array containing int x and y member data"}, "description": "Get the current position of the animated element based on t.\nEach point is an array of \"x\" and \"y\" values (0 = x, 1 = y)\nAt least 2 points are required (start and end).\nFirst point is start. Last point is end.\nAdditional control points are optional.", "static": "", "guessedname": "getBezier", "guessedtype": "function", "params": [{"type": "Array", "name": "points", "description": " An array containing Bezier points"}, {"type": "Number", "name": "t", "description": " A number between 0 and 1 which is the basis for determining current position"}]}, "stop": {"chainable": "", "static": "", "description": "Stops all animation instances.", "guessedname": "stop", "guessedtype": "function"}, "pause": {"chainable": "", "static": "", "description": "Pauses all animation instances.", "guessedname": "pause", "guessedtype": "function"}, "run": {"chainable": "", "static": "", "description": "Runs all animation instances.", "guessedname": "run", "guessedtype": "function"}, "_runFrame": {"guessedname": "_runFrame", "static": "", "description": "Called per Interval to handle each animation frame.", "private": "", "guessedtype": "function"}}}, "Plugin.DDProxy": {"name": "Plugin.DDProxy", "configs": {"positionProxy": {"type": "Boolean", "description": "Make the Proxy node appear in the same place as the original node. Default: true", "guessedname": "positionProxy", "guessedtype": "property"}, "hideOnEnd": {"type": "Boolean", "description": "Hide the drag node at the end of the drag. Default: true", "guessedname": "hideOnEnd", "guessedtype": "property"}, "resizeFrame": {"type": "Boolean", "description": "Make the Proxy node assume the size of the original node. Default: true", "guessedname": "resizeFrame", "guessedtype": "property"}, "borderStyle": {"type": "Boolean", "description": "The default border style for the border of the proxy. Default: 1px solid #808080", "guessedname": "borderStyle", "guessedtype": "property"}, "moveOnEnd": {"type": "Boolean", "description": "Move the original node at the end of the drag. Default: true", "guessedname": "moveOnEnd", "guessedtype": "property"}}, "constructors": [{"description": "This plugin for dd-drag is for creating a proxy drag node, instead of dragging the original node."}], "namespace": "Plugin", "module": "dd", "events": {"moveOnEndChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "moveOnEndChange", "description": "Fires when the value for the configuration attribute 'moveOnEnd' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "hideOnEndChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "hideOnEndChange", "description": "Fires when the value for the configuration attribute 'hideOnEnd' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "positionProxyChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "positionProxyChange", "description": "Fires when the value for the configuration attribute 'positionProxy' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "borderStyleChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "borderStyleChange", "description": "Fires when the value for the configuration attribute 'borderStyle' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "resizeFrameChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "resizeFrameChange", "description": "Fires when the value for the configuration attribute 'resizeFrame' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "DDM", "methods": {"_init": {"description": "Handler for the proxy config attribute", "private": "", "guessedname": "_init", "guessedtype": "function"}}, "extends": "Base", "superclass": "Base", "file": "proxy.js", "guessedtype": "property", "shortname": "DDProxy", "properties": {"proxy": {"type": "{String}", "description": "The Proxy instance will be placed on the Drag instance under the proxy namespace.", "guessedname": "NS", "guessedtype": "property"}, "_hands": {"private": "", "description": "Holds the event handles for setting the proxy", "guessedname": "_hands", "guessedtype": "property"}}, "description": "This plugin for dd-drag is for creating a proxy drag node, instead of dragging the original node."}, "DD.DDM": {"methods": {"_calcTickArray": {"return": {"type": "", "description": "The tick position"}, "description": "This method is used with the tickXArray and tickYArray config options", "private": "", "params": [{"type": "Number", "name": "pos", "description": " The current X or Y position"}, {"type": "Number", "name": "ticks", "description": " The array containing our custom tick positions."}, {"type": "Number", "name": "off1", "description": " The min offset that we can't pass (region)"}, {"type": "Number", "name": "off2", "description": " The max offset that we can't pass (region)"}], "guessedname": "_calcTickArray", "guessedtype": "function"}, "cssSizestoObject": {"return": {"type": "Object", "description": "The gutter Object Literal."}, "description": "//TODO Private, rename??...", "private": "", "params": [{"type": "String", "name": "gutter", "description": " CSS style string for gutter: '5 0' (sets top and bottom to 5px, left and right to 0px), '1 2 3 4' (top 1px, right 2px, bottom 3px, left 4px)"}], "guessedname": "cssSizestoObject", "guessedtype": "function"}, "_move": {"guessedname": "_move", "params": [{"type": "Event.Facade", "name": "ev", "description": " The Dom mousemove Event"}], "description": "Internal listener for the mousemove DOM event to pass to the Drag's move method.", "private": "", "guessedtype": "function"}, "_unregTarget": {"guessedname": "_unregTarget", "params": [{"type": "Object", "name": "drop", "description": " The Target to remove from the targets collection"}], "description": "Remove the passed in Target from the targets collection", "private": "", "guessedtype": "function"}, "_deactivateTargets": {"description": "This method fires the drop:hit, drag:drophit, drag:dropmiss methods and deactivates the shims..", "private": "", "guessedname": "_deactivateTargets", "guessedtype": "function"}, "stopDrag": {"chainable": "", "return": {"type": "Self", "description": ""}, "description": "Method will forcefully stop a drag operation. For example calling this from inside an ESC keypress handler will stop this drag.", "guessedname": "stopDrag", "guessedtype": "function"}, "getDrop": {"return": {"type": "Object", "description": ""}, "params": [{"type": "String/Object", "name": "node", "description": " The Node instance or Selector string to check for a valid Drop Object"}], "description": "Get a valid Drop instance back from a Node or a selector string, false otherwise", "guessedname": "getDrop", "guessedtype": "function"}, "_start": {"description": "Internal method used by Drag to signal the start of a drag operation", "private": "", "guessedname": "_start", "guessedtype": "function"}, "_dropMove": {"description": "This method is called when the move method is called on the Drag Object.", "private": "", "guessedname": "_dropMove", "guessedtype": "function"}, "_unregDrag": {"guessedname": "_unregDrag", "params": [{"type": "Drag", "name": "d", "description": " The drag object."}], "description": "Remove this drag object from the DDM._drags array.", "private": "", "guessedtype": "function"}, "clearCache": {"description": "Clears the cache data used for this interaction.", "guessedname": "clearCache", "guessedtype": "function"}, "_hasActiveShim": {"guessedname": "_hasActiveShim", "return": {"type": "Boolean", "description": ""}, "description": "This method checks the _activeShims Object to see if there is a shim active.", "private": "", "guessedtype": "function"}, "_startDrag": {"guessedname": "_startDrag", "params": [{"type": "Number", "name": "x", "description": " The x position of the drag element"}, {"type": "Number", "name": "y", "description": " The y position of the drag element"}, {"type": "Number", "name": "w", "description": " The width of the drag element"}, {"type": "Number", "name": "h", "description": " The height of the drag element"}], "description": "Factory method to be overwritten by other DDM's", "private": "", "guessedtype": "function"}, "_createFrame": {"guessedname": "_createFrame", "description": "Create the proxy element if it doesn't already exist and set the DD.DDM._proxy value", "private": "", "guessedtype": "function"}, "_addActiveShim": {"guessedname": "_addActiveShim", "params": [{"type": "Object", "name": "d", "description": " The Drop instance to add to the list."}], "description": "Adds a Drop Target to the list of active shims", "private": "", "guessedtype": "function"}, "_end": {"description": "Internal method used by Drag to signal the end of a drag operation", "private": "", "guessedname": "_end", "guessedtype": "function"}, "getBestMatch": {"return": {"type": "Object or Array", "description": ""}, "params": [{"type": "Array", "name": "drops", "description": " An Array of drops to scan for the best match."}, {"type": "Boolean", "name": "all", "description": " If present, it returns an Array. First item is best match, second is an Array of the other items in the original Array."}], "description": "This method will gather the area for all potential targets and see which has the hightest covered area and return it.", "guessedname": "getBestMatch", "guessedtype": "function"}, "_removeActiveShim": {"guessedname": "_removeActiveShim", "params": [{"type": "Object", "name": "d", "description": " The Drop instance to remove from the list."}], "description": "Removes a Drop Target to the list of active shims", "private": "", "guessedtype": "function"}, "isOverTarget": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "Object", "name": "drop", "description": " The drop to check against"}], "description": "Check to see if the Drag element is over the target, method varies on current mode", "guessedname": "isOverTarget", "guessedtype": "function"}, "_createPG": {"description": "Creates the shim and adds it's listeners to it.", "private": "", "guessedname": "_createPG", "guessedtype": "function"}, "_activateTargets": {"description": "Clear the cache and activate the shims of all the targets", "private": "", "guessedname": "_activateTargets", "guessedtype": "function"}, "_addValid": {"return": {"type": "Self", "description": ""}, "description": "Add a Drop Target to the list of Valid Targets. This list get's regenerated on each new drag operation.", "chainable": "", "private": "", "params": [{"type": "Object", "name": "drop", "description": ""}], "guessedname": "_addValid", "guessedtype": "function"}, "syncActiveShims": {"params": [{"type": "Boolean", "name": "force", "description": " Resize/sync all Targets."}], "description": "This method will sync the position of the shims on the Drop Targets that are currently active.", "guessedname": "syncActiveShims", "guessedtype": "function"}, "_removeValid": {"return": {"type": "Self", "description": ""}, "description": "Removes a Drop Target from the list of Valid Targets. This list get's regenerated on each new drag operation.", "chainable": "", "private": "", "params": [{"type": "Object", "name": "drop", "description": ""}], "guessedname": "_removeValid", "guessedtype": "function"}, "_regTarget": {"guessedname": "_regTarget", "params": [{"type": "Object", "name": "t", "description": " The Target to add to the targets collection"}], "description": "Add the passed in Target to the targets collection", "private": "", "guessedtype": "function"}, "_endDrag": {"description": "Factory method to be overwritten by other DDM's", "private": "", "guessedname": "_endDrag", "guessedtype": "function"}, "_setupListeners": {"description": "Add the document listeners.", "private": "", "guessedname": "_setupListeners", "guessedtype": "function"}, "_pg_deactivate": {"description": "Deactivates the shim", "private": "", "guessedname": "_pg_deactivate", "guessedtype": "function"}, "_pg_activate": {"description": "Activates the shim", "private": "", "guessedname": "_pg_activate", "guessedtype": "function"}, "_lookup": {"guessedname": "_lookup", "return": {"type": "Array", "description": "The valid Drop Targets that are in the viewport."}, "description": "Filters the list of Drops down to those in the viewport.", "private": "", "guessedtype": "function"}, "_calcTicks": {"return": {"type": "Number", "description": "The new position based on the tick calculation"}, "description": "Helper method to calculate the tick offsets for a given position", "private": "", "params": [{"type": "Number", "name": "pos", "description": " The current X or Y position"}, {"type": "Number", "name": "start", "description": " The start X or Y position"}, {"type": "Number", "name": "tick", "description": " The X or Y tick increment"}, {"type": "Number", "name": "off1", "description": " The min offset that we can't pass (region)"}, {"type": "Number", "name": "off2", "description": " The max offset that we can't pass (region)"}], "guessedname": "_calcTicks", "guessedtype": "function"}, "_setFrame": {"guessedname": "_setFrame", "description": "If resizeProxy is set to true (default) it will resize the proxy element to match the size of the Drag Element.\nIf positionProxy is set to true (default) it will position the proxy element in the same location as the Drag Element.", "private": "", "guessedtype": "function"}, "getDrag": {"return": {"type": "Object", "description": ""}, "params": [{"type": "String/Object", "name": "node", "description": " The Node instance or Selector string to check for a valid Drag Object"}], "description": "Get a valid Drag instance back from a Node or a selector string, false otherwise", "guessedname": "getDrag", "guessedtype": "function"}, "_regDrag": {"guessedname": "_regDrag", "params": [{"type": "Drag", "name": "d", "description": " The Drag object"}], "description": "Adds a reference to the drag object to the DDM._drags array, called in the constructor of Drag.", "private": "", "guessedtype": "function"}, "_pg_size": {"description": "Sizes the shim on: activatation, window:scroll, window:resize", "private": "", "guessedname": "_pg_size", "guessedtype": "function"}, "_handleTargetOver": {"description": "This method execs _handleTargetOver on all valid Drop Targets", "private": "", "guessedname": "_handleTargetOver", "guessedtype": "function"}, "_setDragMode": {"return": {"type": "", "description": "Number The Mode to be set"}, "description": "Handler for dragMode attribute setter.", "private": "", "params": [{"type": "", "name": "String/Number", "description": " The Number value or the String for the DragMode to default all future drag instances to."}], "guessedname": "_setDragMode", "guessedtype": "function"}}, "configs": {"dragCursor": {"type": "String", "description": "The cursor to apply when dragging, if shimmed the shim will get the cursor.", "guessedname": "dragCursor", "guessedtype": "property"}, "dragMode": {"type": "String", "description": "This attribute only works if the dd-drop module is active. It will set the dragMode (point, intersect, strict) of all future Drag instances.", "guessedname": "dragMode", "guessedtype": "property"}, "clickPixelThresh": {"type": "Number", "description": "The number of pixels to move to start a drag operation, default is 3.", "guessedname": "clickPixelThresh", "guessedtype": "property"}, "clickTimeThresh": {"type": "Number", "description": "The number of milliseconds a mousedown has to pass to start a drag operation, default is 1000.", "guessedname": "clickTimeThresh", "guessedtype": "property"}}, "description": "Provides the base Drag Drop Manger required for making a Node draggable.", "constructors": [{"description": "Provides the base Drag Drop Manger required for making a Node draggable."}], "namespace": "DD", "module": "dd", "events": {"clickPixelThreshChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "clickPixelThreshChange", "description": "Fires when the value for the configuration attribute 'clickPixelThresh' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "dragCursorChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "dragCursorChange", "description": "Fires when the value for the configuration attribute 'dragCursor' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "ddm:start": {"type": "{Event.Custom}", "description": "Fires from the DDM before all drag events fire."}, "ddm:end": {"type": "{Event.Custom}", "description": "Fires from the DDM after the DDM finishes, before the drag end events."}, "clickTimeThreshChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "clickTimeThreshChange", "description": "Fires when the value for the configuration attribute 'clickTimeThresh' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "dragModeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "dragModeChange", "description": "Fires when the value for the configuration attribute 'dragMode' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "guessedname": "DDMBase", "extends": "Base", "superclass": "Base", "file": "ddm-base.js", "guessedtype": "function", "shortname": "DDM", "properties": {"_active": {"type": "{Boolean}", "description": "flag set when we activate our first drag, so DDM can start listening for events.", "guessedname": "_active", "guessedtype": "property"}, "_noShim": {"guessedname": "_noShim", "type": "{Boolean}", "description": "This flag turns off the use of the mouseover/mouseout shim. It should not be used unless you know what you are doing.", "private": "", "guessedtype": "property"}, "_pg": {"guessedname": "_pg", "type": "{Node}", "description": "The shim placed over the screen to track the mousemove event.", "private": "", "guessedtype": "property"}, "useHash": {"type": "{Boolean}", "description": "Should we only check targets that are in the viewport on drags (for performance), default: true", "guessedname": "useHash", "guessedtype": "property"}, "activeDrag": {"type": "{Drag}", "description": "A reference to the currently active draggable object.", "guessedname": "activeDrag", "guessedtype": "property"}, "POINT": {"guessedname": "POINT", "type": "Number", "description": "In point mode, a Drop is targeted by the cursor being over the Target", "private": "", "guessedtype": "property"}, "_activeShims": {"guessedname": "_activeShims", "type": "{Array}", "description": "Placeholder for all active shims on the page", "private": "", "guessedtype": "property"}, "otherDrops": {"type": "{Object}", "description": "An object literal of Other Drop Targets that we encountered during this interaction (in the case of overlapping Drop Targets)", "guessedname": "otherDrops", "guessedtype": "property"}, "validDrops": {"type": "{Array}", "description": "An array of the valid Drop Targets for this interaction."}, "CSS_PREFIX": {"type": "{String}", "description": "The PREFIX to attach to all DD CSS class names", "guessedname": "CSS_PREFIX", "guessedtype": "property"}, "STRICT": {"guessedname": "STRICT", "type": "Number", "description": "In strict mode, a Drop is targeted by the \"entire\" drag node being over the Target", "private": "", "guessedtype": "property"}, "mode": {"guessedname": "mode", "type": "Number", "description": "The mode that the drag operations will run in 0 for Point, 1 for Intersect, 2 for Strict", "private": "", "guessedtype": "property"}, "INTERSECT": {"guessedname": "INTERSECT", "type": "Number", "description": "In intersect mode, a Drop is targeted by \"part\" of the drag node being over the Target", "private": "", "guessedtype": "property"}, "_debugShim": {"guessedname": "_debugShim", "type": "{Boolean}", "description": "Set this to true to set the shims opacity to .5 for debugging it, default: false.", "private": "", "guessedtype": "property"}, "targets": {"type": "{Array}", "description": "All of the Targets", "guessedname": "targets", "guessedtype": "property"}, "_drags": {"guessedname": "_drags", "type": "{Array}", "description": "Holder for all registered drag elements.", "private": "", "guessedtype": "property"}, "activeDrop": {"type": "{Object}", "description": "A reference to the active Drop Target", "guessedname": "activeDrop", "guessedtype": "property"}}, "name": "DD.DDM"}, "WidgetStack": {"name": "WidgetStack", "namespace": "", "module": "widget-stack", "events": {"shimChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "shimChange", "description": "Fires when the value for the configuration attribute 'shim' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "zIndexChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "zIndexChange", "description": "Fires when the value for the configuration attribute 'zIndex' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"zIndex": {"default": "0", "type": "number", "description": "The z-index to apply to the Widgets boundingBox. Non-numerical values for \nzIndex will be converted to 0", "guessedname": "zIndex", "guessedtype": "property"}, "shim": {"default": "false, for all browsers other than IE6, for which a shim is enabled by default.", "type": "boolean", "description": "Boolean flag to indicate whether or not a shim should be added to the Widgets\nboundingBox, to protect it from select box bleedthrough.", "guessedname": "shim", "guessedtype": "property"}}, "methods": {"sizeShim": {"description": "For IE6, synchronizes the size and position of iframe shim to that of \nWidget bounding box which it is protecting. For all other browsers,\nthis method does not do anything.", "guessedname": "sizeShim", "guessedtype": "function"}, "_renderShim": {"private": "", "description": "Creates the shim element and adds it to the DOM", "guessedname": "_renderShim", "guessedtype": "function"}, "_detachStackHandles": {"guessedname": "_detachStackHandles", "params": [{"type": "", "name": "String", "description": " handleKey The key defining the group of handles which should be detached"}], "description": "Detaches any handles stored for the provided key", "private": "", "guessedtype": "function"}, "_uiSetZIndex": {"protected": "", "params": [{"type": "number", "name": "zIndex", "description": " The zindex to be reflected in the UI"}], "description": "Updates the UI to reflect the zIndex value passed in.", "guessedname": "_uiSetZIndex", "guessedtype": "function"}, "_syncUIStack": {"protected": "", "description": "Synchronizes the UI to match the Widgets stack state. This method in \ninvoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.", "guessedname": "_syncUIStack", "guessedtype": "function"}, "_setZIndex": {"return": {"type": "Number", "description": "Normalized zIndex"}, "description": "Default setter for zIndex attribute changes. Normalizes zIndex values to \nnumbers, converting non-numerical values to 0.", "protected": "", "params": [{"type": "String | Number", "name": "zIndex", "description": ""}], "guessedname": "_setZIndex", "guessedtype": "function"}, "_destroyShim": {"private": "", "description": "Removes the shim from the DOM, and detaches any related event\nlisteners.", "guessedname": "_destroyShim", "guessedtype": "function"}, "_uiSetShim": {"protected": "", "params": [{"type": "boolean", "name": "enable", "description": " If true, creates/renders the shim, if false, removes it."}], "description": "Updates the UI to enable/disable the shim. If the widget is not currently visible,\ncreation of the shim is deferred until it is made visible, for performance reasons.", "guessedname": "_uiSetShim", "guessedtype": "function"}, "_getShimTemplate": {"guessedname": "_getShimTemplate", "return": {"type": "Node", "description": "node A new shim Node instance."}, "description": "Creates a cloned shim node, using the SHIM_TEMPLATE html template, for use on a new instance.", "private": "", "guessedtype": "function"}, "_renderUIStack": {"protected": "", "description": "Creates/Initializes the DOM to support stackability.\n
\nThis method in invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_renderUIStack", "guessedtype": "function"}, "_renderShimDeferred": {"private": "", "description": "Sets up change handlers for the visible attribute, to defer shim creation/rendering \nuntil the Widget is made visible.", "guessedname": "_renderShimDeferred", "guessedtype": "function"}, "_afterZIndexChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the zIndex attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterZIndexChange", "guessedtype": "function"}, "_afterShimChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the shim attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterShimChange", "guessedtype": "function"}, "_bindUIStack": {"protected": "", "description": "Binds event listeners responsible for updating the UI state in response to \nWidget stack related state changes.\n
\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_bindUIStack", "guessedtype": "function"}, "_addShimResizeHandlers": {"private": "", "description": "Sets up event listeners to resize the shim when the size of the Widget changes.\n
\nNOTE: This method is only used for IE6 currently, since IE6 doesn't support a way to\nresize the shim purely through CSS, when the Widget does not have an explicit width/height \nset.\n
", "guessedname": "_addShimResizeHandlers", "guessedtype": "function"}}, "param": "{Object} User configuration object", "file": "Widget-Stack.js", "shortname": "WidgetStack", "properties": {"WidgetStack.SHIM_TEMPLATE": {"type": "String", "static": "", "description": "Default markup template used to generate the shim element.", "guessedname": "SHIM_TEMPLATE", "guessedtype": "property"}, "WidgetStack.STACKED_CLASS_NAME": {"description": "Default class used to mark the boundingBox of a stacked widget.", "default": "\"yui-widget-stacked\"", "static": "", "guessedname": "STACKED_CLASS_NAME", "guessedtype": "property", "type": "String"}, "WidgetStack.SHIM_CLASS_NAME": {"description": "Default class used to mark the shim element", "default": "\"yui-widget-shim\"", "static": "", "guessedname": "SHIM_CLASS_NAME", "guessedtype": "property", "type": "String"}, "WidgetStack.HTML_PARSER": {"type": "Object", "static": "", "description": "The HTML parsing rules for the WidgetStack class.", "guessedname": "HTML_PARSER", "guessedtype": "property"}, "WidgetStack.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute \nconfiguration introduced by WidgetStack.", "guessedname": "ATTRS", "guessedtype": "property"}}, "description": "Widget extension, which can be used to add stackable (z-index) support to the \nbase Widget class along with a shimming solution, through the \nBase.build method."}, "Test.Case": {"name": "Test.Case", "constructors": [{"params": [{"type": "", "name": "template", "description": " An object containing any number of test methods, other methods,\nan optional name, and anything else the test case needs."}], "description": "Test case containing various tests to run."}], "namespace": "Test", "module": "test", "guessedname": "Case", "methods": {"tearDown": {"return": {"type": "Void", "description": ""}, "description": "Function to run after each test is executed.", "guessedname": "tearDown", "guessedtype": "function"}, "setUp": {"return": {"type": "Void", "description": ""}, "description": "Function to run before each test is executed.", "guessedname": "setUp", "guessedtype": "function"}, "wait": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Function", "name": "segment", "description": " (Optional) The function to run after the delay.\nIf omitted, the TestRunner will wait until resume() is called."}, {"type": "int", "name": "delay", "description": " (Optional) The number of milliseconds to wait before running\nthe function. If omitted, defaults to zero."}], "description": "Causes the test case to wait a specified amount of time and then\ncontinue executing the given code.", "guessedname": "wait", "guessedtype": "function"}, "resume": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Function", "name": "segment", "description": " (Optional) The function to run.\nIf omitted, the test automatically passes."}], "description": "Resumes a paused test and runs the given function.", "guessedname": "resume", "guessedtype": "function"}}, "file": "TestCase.js", "guessedtype": "function", "shortname": "Case", "properties": {"_should": {"description": "Special rules for the test case. Possible subobjects\nare fail, for tests that should fail, and error, for\ntests that should throw an error.", "guessedname": "_should", "guessedtype": "property"}, "name": {"description": "Name for the test case.", "guessedname": "name", "guessedtype": "property"}}, "description": "Test case containing various tests to run."}, "Assert": {"name": "Assert", "namespace": "", "module": "test", "guessedname": "Assert", "methods": {"isTrue": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is true. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isTrue", "guessedtype": "function"}, "isFalse": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is false. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isFalse", "guessedtype": "function"}, "isNotNull": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not null. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNotNull", "guessedtype": "function"}, "fail": {"static": "", "params": [{"type": "String", "name": "message", "description": " (Optional) The message to display with the failure."}], "description": "Forces an assertion error to occur.", "guessedname": "fail", "guessedtype": "function"}, "isFunction": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a function.", "guessedname": "isFunction", "guessedtype": "function"}, "isNaN": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not a number.", "guessedname": "isNaN", "guessedtype": "function"}, "isBoolean": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a Boolean.", "guessedname": "isBoolean", "guessedtype": "function"}, "areNotSame": {"static": "", "params": [{"type": "Object", "name": "unexpected", "description": " The unexpected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not the same as another. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "areNotSame", "guessedtype": "function"}, "isNotNaN": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not the special NaN value.", "guessedname": "isNotNaN", "guessedtype": "function"}, "areNotEqual": {"static": "", "params": [{"type": "Object", "name": "unexpected", "description": " The unexpected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not equal to another. This uses the double equals sign\nso type cohersion may occur.", "guessedname": "areNotEqual", "guessedtype": "function"}, "areSame": {"static": "", "params": [{"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is the same as another. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "areSame", "guessedtype": "function"}, "_getCount": {"protected": "", "static": "", "description": "Returns the number of assertions that have been performed.", "guessedname": "_getCount", "guessedtype": "function"}, "isUndefined": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is undefined. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isUndefined", "guessedtype": "function"}, "isArray": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an array.", "guessedname": "isArray", "guessedtype": "function"}, "Y.assert": {"static": "", "params": [{"type": "Boolean", "name": "condition", "description": " The condition to test."}, {"type": "String", "name": "message", "description": " The message to display if the assertion fails."}], "description": "Asserts that a given condition is true. If not, then a Y.Assert.Error object is thrown\nand the test fails.", "guessedname": "assert", "guessedtype": "function"}, "isTypeOf": {"static": "", "params": [{"type": "String", "name": "expectedType", "description": " The expected type of the variable."}, {"type": "Object", "name": "actualValue", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is of a particular type.", "guessedname": "isTypeOf", "guessedtype": "function"}, "_formatMessage": {"return": {"type": "String", "description": "The final error message, containing either or both."}, "description": "Formats a message so that it can contain the original assertion message\nin addition to the custom message.", "protected": "", "static": "", "guessedname": "_formatMessage", "guessedtype": "function", "params": [{"type": "String", "name": "customMessage", "description": " The message passed in by the developer."}, {"type": "String", "name": "defaultMessage", "description": " The message created by the error by default."}]}, "_increment": {"protected": "", "static": "", "description": "Increments the number of assertions that have been performed.", "guessedname": "_increment", "guessedtype": "function"}, "areEqual": {"static": "", "params": [{"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is equal to another. This uses the double equals sign\nso type cohersion may occur.", "guessedname": "areEqual", "guessedtype": "function"}, "isNumber": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a number.", "guessedname": "isNumber", "guessedtype": "function"}, "isObject": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an object.", "guessedname": "isObject", "guessedtype": "function"}, "isString": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a string.", "guessedname": "isString", "guessedtype": "function"}, "isNotUndefined": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not undefined. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNotUndefined", "guessedtype": "function"}, "isNull": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is null. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNull", "guessedtype": "function"}, "_reset": {"protected": "", "static": "", "description": "Resets the number of assertions that have been performed to 0.", "guessedname": "_reset", "guessedtype": "function"}, "isInstanceOf": {"static": "", "params": [{"type": "Function", "name": "expected", "description": " The function that the object should be an instance of."}, {"type": "Object", "name": "actual", "description": " The object to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an instance of a particular object. This may return\nincorrect results when comparing objects from one frame to constructors in\nanother frame. For best results, don't use in a cross-frame manner.", "guessedname": "isInstanceOf", "guessedtype": "function"}, "Y.fail": {"static": "", "params": [{"type": "String", "name": "message", "description": " (Optional) The message to display with the failure."}], "description": "Forces an assertion error to occur. Shortcut for Y.Assert.fail().", "guessedname": "fail", "guessedtype": "property"}}, "static": "", "file": "Assert.js", "guessedtype": "property", "shortname": "Assert", "properties": {"_asserts": {"guessedname": "_asserts", "type": "int", "description": "The number of assertions performed.", "private": "", "guessedtype": "property"}}, "description": "The Assert object provides functions to test JavaScript values against\nknown and expected results. Whenever a comparison (assertion) fails,\nan error is thrown."}, "Slider": {"name": "Slider", "constructors": [{"params": [{"type": "Object", "name": "config", "description": " Configuration object"}], "description": "Create a slider to represent an integer value between a given minimum and\nmaximum. Sliders may be aligned vertically or horizontally, based on the\naxis configuration."}], "namespace": "", "module": "slider", "events": {"axisChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "axisChange", "description": "Fires when the value for the configuration attribute 'axis' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "railEnabledChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "railEnabledChange", "description": "Fires when the value for the configuration attribute 'railEnabled' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "minGutterChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "minGutterChange", "description": "Fires when the value for the configuration attribute 'minGutter' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "slideEnd": {"params": [{"type": "Event.Facade", "name": "event", "description": " An Event Facade object with the following attribute specific properties added:\n
\n
ddEvent
\n
drag:end event from the managed DD.Drag instance
\n
"}], "description": "Signals the end of a thumb drag operation. Payload includes\nthe DD.Drag instance's drag:end event under key ddEvent."}, "maxGutterChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "maxGutterChange", "description": "Fires when the value for the configuration attribute 'maxGutter' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "railChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "railChange", "description": "Fires when the value for the configuration attribute 'rail' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "thumbImageChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "thumbImageChange", "description": "Fires when the value for the configuration attribute 'thumbImage' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "minChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "minChange", "description": "Fires when the value for the configuration attribute 'min' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "positionThumb": {"preventable": "_defPositionThumbFn", "params": [{"type": "Event.Facade", "name": "event", "description": " An Event Facade object with the following attribute specific properties added:\n
\n
changeEv
\n
valueChange event fired in response to the change in the value attribute
\n
"}], "description": "Signals a request to reposition the thumb in response to API methods.\nTriggers the thumb placement logic in _defPositionThumbFn.", "guessedname": "defaultFn", "guessedtype": "property"}, "slideStart": {"params": [{"type": "Event.Facade", "name": "event", "description": " An Event Facade object with the following attribute specific properties added:\n
\n
ddEvent
\n
drag:start event from the managed DD.Drag instance
\n
"}], "description": "Signals the beginning of a thumb drag operation. Payload includes\nthe DD.Drag instance's drag:start event under key ddEvent."}, "valueChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "valueChange", "description": "Fires when the value for the configuration attribute 'value' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "thumbChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "thumbChange", "description": "Fires when the value for the configuration attribute 'thumb' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "sync": {"preventable": "_defSyncFn", "params": [{"type": "Event.Facade", "name": "event", "description": " Event Facade object"}], "description": "Communicates a request to synchronize the Slider UI with the\nattribute state. Links the sync request with the default sync\nlogic in _defSyncFn.", "guessedname": "defaultFn", "guessedtype": "property"}, "maxChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "maxChange", "description": "Fires when the value for the configuration attribute 'max' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "railSizeChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "railSizeChange", "description": "Fires when the value for the configuration attribute 'railSize' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "thumbDrag": {"preventable": "_defThumbDragFn", "params": [{"type": "Event.Facade", "name": "event", "description": " An Event Facade object with the following attribute specific properties added:\n
\n
ddEvent
\n
drag:drag event from the managed DD.Drag instance
\n
"}], "description": "Bridges user interaction with the thumb to the value attribute.", "guessedname": "defaultFn", "guessedtype": "property"}}, "configs": {"thumb": {"default": "null", "type": "Node", "description": "
The Node representing the Slider's thumb, usually visualized as a\npointer using a contained image Node (see thumbImage). The current\nvalue of the Slider is calculated from the centerpoint of this\nNode in relation to the rail Node. If provided, the thumbImage\nNode is contained within this Node.
\n
If no thumbImage is provided and the Node passed as the thumb is\nan img element, the assigned Node will be allocated to\nthe thumbImage and the thumb container defaulted.
", "guessedname": "thumb", "guessedtype": "property"}, "maxGutter": {"default": "0", "type": "Number", "description": "Like CSS padding, the distance in pixels from the inner bottom or\nright edge of the rail node within which the thumb can travel.\nNegative values allow the edge of the thumb to escape the rail node\nboundaries.", "guessedname": "maxGutter", "guessedtype": "property"}, "min": {"default": "0", "type": "Number", "description": "Value associated with the left or top most position of the thumb on\nthe rail.", "guessedname": "min", "guessedtype": "property"}, "railEnabled": {"default": "true", "type": "Boolean", "description": "Boolean indicating whether clicking and dragging on the rail will\ntrigger thumb movement.", "guessedname": "railEnabled", "guessedtype": "property"}, "max": {"default": "100", "type": "Number", "description": "Value associated with the right or bottom most position of the thumb\non the rail.", "guessedname": "max", "guessedtype": "property"}, "railSize": {"default": "'0'", "type": "String", "description": "
The width or height of the rail element representing the physical\nspace along which the thumb can move. CSS size values (e.g. '30em')\naccepted but converted to pixels during render.
\n
Alternately, but not recommended, this attribute can be left\nunassigned in favor of specifying height or width.
", "guessedname": "railSize", "guessedtype": "property"}, "rail": {"default": "null", "type": "Node", "description": "The Node representing the Slider's rail, usually visualized as a\nbar of some sort using a background image, along which the thumb\nmoves. This Node contains the thumb Node.", "guessedname": "rail", "guessedtype": "property"}, "value": {"default": "0", "type": "Number", "description": "The current value of the Slider. This value is interpretted into a\nposition for the thumb along the Slider's rail.", "guessedname": "value", "guessedtype": "property"}, "minGutter": {"default": "0", "type": "Number", "description": "Like CSS padding, the distance in pixels from the inner top or left\nedge of the rail node within which the thumb can travel. Negative\nvalues allow the edge of the thumb to escape the rail node\nboundaries.", "guessedname": "minGutter", "guessedtype": "property"}, "thumbImage": {"default": "null", "type": "Node|String", "description": "
The Node representing the image element to use for the Slider's\nthumb.
\n
Alternately, an image URL can be passed and an img\nNode will be generated accordingly.
\n
If no thumbImage is provided and the Node passed as the thumb is\nan img element, the assigned Node will be allocated to\nthe thumbImage and the thumb container defaulted.
\n
If thumbImage is provided but its URL resolves to a 404, a default\nstyle will be applied to maintain basic functionality.
", "guessedname": "thumbImage", "guessedtype": "property"}, "axis": {"description": "Axis upon which the Slider's thumb moves. "x" for\nhorizontal, "y" for vertical.", "writeonce": "", "default": ""x"", "guessedname": "axis", "guessedtype": "property", "type": "String"}}, "methods": {"_setThumbFn": {"return": {"type": "Node", "description": "The Node if found. Otherwise null."}, "description": "Setter applied to the input when updating the thumb attribute. Input can\nbe a Node, raw HTMLElement, or a selector string to locate it.", "protected": "", "params": [{"type": "Node|String|HTMLElement", "name": "v", "description": " The thumb element Node or selector"}], "guessedname": "_setThumbFn", "guessedtype": "function"}, "_resetDDCacheRegion": {"protected": "", "description": "Resets the cached region inside the DD constrain instance to support\nrepositioning the Slider after instantiation.", "guessedname": "_resetDDCacheRegion", "guessedtype": "function"}, "_defSyncFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Internal sync event"}], "description": "The default synchronization behavior, updating the Slider's DOM state to\nmatch the current attribute values.", "guessedname": "_defSyncFn", "guessedtype": "function"}, "_afterRailSizeChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " railSizeChange custom event"}], "description": "Updates the Slider UI in response to change in the railSize attribute.", "guessedname": "_afterRailSizeChange", "guessedtype": "function"}, "_defPositionThumbFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the positionThumb custom event"}], "description": "Calls _uiPositionThumb with the value of the custom event's\n"offset" property.", "guessedname": "_defPositionThumbFn", "guessedtype": "function"}, "_isImageLoading": {"return": {"type": "", "description": "Boolean"}, "description": "Used to determine if there is a current or pending request for the\nthumbImage resource.", "protected": "", "params": [{"type": "Node", "name": "img", "description": " img Node"}], "guessedname": "_isImageLoading", "guessedtype": "function"}, "initializer": {"protected": "", "description": "Construction logic executed durint Slider instantiation. Subscribes to\nafter events for min, max, and railSize. Publishes custom events\nincluding slideStart and slideEnd.", "guessedname": "initializer", "guessedtype": "function"}, "_uiSetRailSize": {"protected": "", "description": "Stores the rail Node's pixel height or width, depending on the Slider's\naxis, for use in calculating thumb position from the value.", "guessedname": "_uiSetRailSize", "guessedtype": "function"}, "_setFactor": {"protected": "", "description": "Calculates the multiplier used to translate the value into a thumb\nposition.", "guessedname": "_setFactor", "guessedtype": "function"}, "_setRailOffsetXY": {"protected": "", "description": "Store the current XY position of the rail Node on the page. For use in\ncalculating thumb position from value.", "guessedname": "_setRailOffsetXY", "guessedtype": "function"}, "_afterValueChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " valueChange custom event"}], "description": "Fires the internal positionThumb event in response to a change in the\nvalue attribute.", "guessedname": "_afterValueChange", "guessedtype": "function"}, "_setDDGutter": {"protected": "", "description": "Passes the gutter attribute value to the DDConstrain gutter attribute.", "guessedname": "_setDDGutter", "guessedtype": "function"}, "_setThumbImageFn": {"return": {"type": "Node", "description": "The Node if found or created. Otherwise null."}, "description": "Setter applied to the input when updating the thumbImage attribute.\nInput can be a Node, raw HTMLElement, selector string to locate it, or\nthe URL for an image resource.\nString input will be treated as a selector. If no element is found using\nthe selector, an img Node will be created with the string\nused as the src attribute.", "protected": "", "params": [{"type": "Node|String|HTMLElement", "name": "v", "description": " The thumbImage element Node, selector,\nor image URL"}], "guessedname": "_setThumbImageFn", "guessedtype": "function"}, "_uiPositionThumb": {"protected": "", "params": [{"type": "Number", "name": "xy", "description": " the desired left or top pixel position of the thumb\nin relation to the rail Node."}], "description": "Places the thumb at a particular X or Y location based on the configured\naxis.", "guessedname": "_uiPositionThumb", "guessedtype": "function"}, "_validateNewValue": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the value attribute.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the value attribute"}], "guessedname": "_validateNewValue", "guessedtype": "function"}, "_setAxisFn": {"return": {"type": "String", "description": "lowercased first character of the input string"}, "description": "Setter applied to the input when updating the axis attribute.", "protected": "", "params": [{"type": "String", "name": "v", "description": " proposed value for the axis attribute"}], "guessedname": "_setAxisFn", "guessedtype": "function"}, "_setThumbOffset": {"protected": "", "description": "Establishes the point in the thumb that should align to the rail\nposition representing the calculated value.", "guessedname": "_setThumbOffset", "guessedtype": "function"}, "_validateNewThumbImage": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the thumbImage attribute. Rejects all values after\nthe Slider has been rendered.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the thumbImage attribute"}], "guessedname": "_validateNewThumbImage", "guessedtype": "function"}, "_afterMaxChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " maxChange custom event"}], "description": "Updates the Slider UI in response to change in the max attribute.", "guessedname": "_afterMaxChange", "guessedtype": "function"}, "_validateNewThumb": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the thumb attribute. Rejects all values after the\nSlider has been rendered.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the thumb attribute"}], "guessedname": "_validateNewThumb", "guessedtype": "function"}, "bindUI": {"protected": "", "description": "Creates the Y.DD instance used to handle the thumb movement and binds\nSlider interaction to the configured value model.", "guessedname": "bindUI", "guessedtype": "function"}, "_initThumbImage": {"protected": "", "description": "Ensures the thumbImage is a child of the thumb element.", "guessedname": "_initThumbImage", "guessedtype": "function"}, "_bindThumbDD": {"protected": "", "description": "Creates the Y.DD instance used to handle the thumb interaction.", "guessedname": "_bindThumbDD", "guessedtype": "function"}, "_stallDisabledChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Change event for the disabled attribute"}], "description": "Method subscribed to the disabledChange event when thumbImage is being\nloaded. Prevents manually enabling the Slider until the thumbImage\nresource is resolved. Intended value is stored during load and set upon\ncompletion.", "guessedname": "_stallDisabledChange", "guessedtype": "function"}, "_defThumbDragFn": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the internal thumbDrag event"}], "description": "The default value update behavior in response to Slider thumb\ninteraction. Calculates the value using stored offsets, the _factor\nmultiplier and the min value.", "guessedname": "_defThumbDragFn", "guessedtype": "function"}, "_initRailDD": {"protected": "", "description": "Subscribes to the rail Node's mousedown event to actuate the thumb when\nbackgroundEnabled is true.", "guessedname": "_initRailDD", "guessedtype": "function"}, "setValue": {"params": [{"type": "Number", "name": "val", "description": " the new value"}], "description": "Convenience method for updating the current value of the Slider.\nEquivalent to slider.set("value",val).", "guessedname": "setValue", "guessedtype": "function"}, "_imageLoaded": {"protected": "", "params": [{"type": "Node", "name": "img", "description": " The thumbImage Node"}, {"type": "Event", "name": "e", "description": " load or error event fired by the thumbImage"}], "description": "Event handler assigned to the thumbImage's load and error event if it\nwas not loaded prior to instantiation. Restores the disabled value.", "guessedname": "_imageLoaded", "guessedtype": "function"}, "_validateNewMax": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the max attribute.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the max attribute"}], "guessedname": "_validateNewMax", "guessedtype": "function"}, "_refresh": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " An attribute change event"}], "description": "Common handler to call syncUI in response to change events that occurred\nafter the Slider is rendered.", "guessedname": "_refresh", "guessedtype": "function"}, "_uiSetThumbSize": {"protected": "", "description": "Captures the thumb's pixel height or width (depending on the Slider's\naxis) for use in positioning calculations.", "guessedname": "_uiSetThumbSize", "guessedtype": "function"}, "_onDDEndDrag": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the DD instance's drag:end custom event"}], "description": "Fires the slideEnd event.", "guessedname": "_onDDEndDrag", "guessedtype": "function"}, "_validateNewRail": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the rail attribute. Rejects all values after the\nSlider has been rendered.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the rail attribute"}], "guessedname": "_validateNewRail", "guessedtype": "function"}, "_handleRailMouseDown": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " Mousedown event facade"}], "description": "If the Slider is not disabled and railEnabled is true, moves the thumb\nto the mousedown position and hands control over to DD.", "guessedname": "_handleRailMouseDown", "guessedtype": "function"}, "_isImageLoaded": {"return": {"type": "", "description": "Boolean"}, "description": "Used to determine if the image resource loaded successfully or there was\nan error.\nNOTES:\n
\n
img load error fired xbrowser for image resources not yet resolved
\n
img.complete reports false in IE for images not yet loaded as well as images that failed to load
\n
img.complete true && img.naturalWidth == 0 in FF and Safari indicate image failed to load
\n
img.complete && img.width == 0 in Opera indicates image failed to load
\n
", "protected": "", "params": [{"type": "Node", "name": "img", "description": " img Node"}], "guessedname": "_isImageLoaded", "guessedtype": "function"}, "_afterThumbChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " thumbChange custom event"}], "description": "Replaces the thumb Node in response to a change in the thumb attribute.\nThis only has effect after the Slider is rendered.", "guessedname": "_afterThumbChange", "guessedtype": "function"}, "_convertValueToOffset": {"protected": "", "params": [{"type": "Number", "name": "v", "description": " value between the Slider's min and max"}], "description": "Converts a value to a pixel offset for the thumb position on the rail.", "guessedname": "_convertValueToOffset", "guessedtype": "function"}, "_afterMinChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " minChange custom event"}], "description": "Updates the Slider UI in response to change in the min attribute.", "guessedname": "_afterMinChange", "guessedtype": "function"}, "_convertOffsetToValue": {"protected": "", "params": [{"type": "Number", "name": "v", "description": " pixel offset of the thumb on the rail"}], "description": "Converts a pixel offset of the thumb on the rail to a value.", "guessedname": "_convertOffsetToValue", "guessedtype": "function"}, "_scheduleSync": {"protected": "", "description": "Binds to the load and error event on the thumbImage to sync the DOM\nstate with the attribute settings when the image resource is resolved.\nThe Slider is disabled while it waits.", "guessedname": "_scheduleSync", "guessedtype": "function"}, "_initThumb": {"protected": "", "description": "
Creates the thumb element (not image) if not provided and not\ndiscovered via HTML_PARSER. If the thumb is an img element\nbut no thumbImage configured or discovered, reassigns the thumb element\nto the thumbImage and defaults the thumb element as a div.
\n
Makes sure the thumb is a child of the rail element and calls\n_initThumbImage if thumbImage is provided.
", "guessedname": "_initThumb", "guessedtype": "function"}, "_validateNewRailSize": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the railSize attribute. Only strings of css size\nvalues (e.g. '200px') are allowed.", "protected": "", "params": [{"type": "String", "name": "v", "description": " proposed value for the railSize attribute"}], "guessedname": "_validateNewRailSize", "guessedtype": "function"}, "_onDDStartDrag": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the DD instance's drag:start custom event"}], "description": "Caches the current page position of the rail element and fires the\nslideStart event in response to the DD's drag:start.", "guessedname": "_onDDStartDrag", "guessedtype": "function"}, "syncUI": {"description": "Synchronizes the DOM state with the attribute settings (most notably\nrailSize and value). If thumbImage is provided and is still loading,\nsync is delayed until it is complete, since the image's dimensions are\ntaken into consideration for calculations.", "guessedname": "syncUI", "guessedtype": "function"}, "_validateNewAxis": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to new values for the axis attribute. Only\n"x" and "y" are permitted.", "protected": "", "params": [{"type": "String", "name": "v", "description": " proposed value for the axis attribute"}], "guessedname": "_validateNewAxis", "guessedtype": "function"}, "_afterDisabledChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " disabledChange custom event"}], "description": "Locks or unlocks the DD instance in response to a change in the disabled\nattribute.", "guessedname": "_afterDisabledChange", "guessedtype": "function"}, "getValue": {"return": {"type": "Number", "description": "the value"}, "description": "Convenience method for accessing the current value of the Slider.\nEquivalent to slider.get("value").", "guessedname": "getValue", "guessedtype": "function"}, "_initRail": {"protected": "", "description": "Creates the rail element if not provided and not discovered via\nHTML_PARSER.", "guessedname": "_initRail", "guessedtype": "function"}, "_ready": {"protected": "", "params": [{"type": "Node", "name": "img", "description": " the thumbImage Node"}, {"type": "Boolean", "name": "error", "description": " Indicates an error while loading the thumbImage"}], "description": "Applies a class to the content box if the thumbImage failed to resolve,\nthe fires the internal sync event triggering a sync between UI and\nstate.", "guessedname": "_ready", "guessedtype": "function"}, "_setRailFn": {"return": {"type": "Node", "description": "The Node if found. Otherwise null."}, "description": "Setter applied to the input when updating the rail attribute. Input can\nbe a Node, raw HTMLElement, or a selector string to locate it.", "protected": "", "params": [{"type": "Node|String|HTMLElement", "name": "v", "description": " The rail element Node or selector"}], "guessedname": "_setRailFn", "guessedtype": "function"}, "_validateNewMin": {"return": {"type": "", "description": "Boolean"}, "description": "Validator applied to the min attribute.", "protected": "", "params": [{"type": "MIXED", "name": "v", "description": " proposed value for the min attribute"}], "guessedname": "_validateNewMin", "guessedtype": "function"}, "_isDisplayNone": {"return": {"type": "Boolean", "description": "true if the node is styled with display: none"}, "description": "Helper function to search up the ancestor axis looking for a node with\nstyle display: none. This is passed as a function to node.ancestor(..)\nto test if a given node is in the displayed DOM and can get accurate\npositioning information.", "protected": "", "params": [{"type": "Node", "name": "el", "description": " ancestor node as the function walks up the parent axis"}], "guessedname": "_isDisplayNone", "guessedtype": "function"}, "_afterThumbImageChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " thumbImageChange custom event"}], "description": "Sets or replaces the thumb's contained img Node with the\nnew Node in response to a change in the thumbImage attribute. This only\nhas effect after the Slider is rendered.", "guessedname": "_afterThumbImageChange", "guessedtype": "function"}, "renderUI": {"protected": "", "description": "Create the DOM structure for the Slider.", "guessedname": "renderUI", "guessedtype": "function"}, "_onDDDrag": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the DD instance's drag:drag custom event"}], "description": "Fires the thumbDrag event to queue Slider value update.", "guessedname": "_onDDDrag", "guessedtype": "function"}}, "extends": "Widget", "superclass": "Widget", "file": "slider.js", "shortname": "Slider", "properties": {"Slider.ATTRS": {"description": "Static property used to define the default attribute configuration of\nthe Widget.", "protected": "", "static": "", "guessedname": "ATTRS", "guessedtype": "property", "type": "Object"}, "_thumbSize": {"protected": "", "type": "Number", "description": "Pixel dimension of the thumb Node's width for X axis Sliders or height\nfor Y axis Sliders. Used with _factor to calculate positional\ncoordinates for the thumb.", "guessedname": "_thumbSize", "guessedtype": "property"}, "_key": {"protected": "", "type": "Object", "description": "Collection of object property names from the appropriate hash set in\nSlider._AXIS_KEYS.", "guessedname": "_key", "guessedtype": "property"}, "_factor": {"protected": "", "type": "Number", "description": "Factor used to translate positional coordinates (e.g. left or top) to\nthe Slider's value.", "guessedname": "_factor", "guessedtype": "property"}, "Slider._AXIS_KEYS": {"description": "Object property names used for respective X and Y axis Sliders (e.g.\n"left" vs. "top" for placing the thumb according to\nits representative value).", "protected": "", "static": "", "guessedname": "_AXIS_KEYS", "guessedtype": "property", "type": "Object"}, "Slider.NAME": {"type": "String", "static": "", "description": "The identity of the widget.", "guessedname": "NAME", "guessedtype": "property"}, "_disabled": {"protected": "", "type": "Boolean", "description": "Deferred value for the disabled attribute when stalled (see _stall\nproperty).", "guessedname": "_disabled", "guessedtype": "property"}, "Slider.HTML_PARSER": {"description": "Static Object hash used to capture existing markup for progressive\nenhancement. Keys correspond to config attribute names and values\nare selectors used to inspect the contentBox for an existing node\nstructure.", "protected": "", "static": "", "guessedname": "HTML_PARSER", "guessedtype": "property", "type": "Object"}, "_railSize": {"protected": "", "type": "Number", "description": "Pixel dimension of the rail Node's width for X axis Sliders or height\nfor Y axis Sliders. Used with _factor to calculate positional\ncoordinates for the thumb.", "guessedname": "_railSize", "guessedtype": "property"}, "_thumbOffset": {"protected": "", "type": "Number", "description": "Pixel offset of the point in the thumb element from its top/left edge\nto where the value calculation should take place. By default, this is\ncalculated to half the width of the thumb, causing the value to be\nmarked from the center of the thumb.", "guessedname": "_thumbOffset", "guessedtype": "property"}, "_stall": {"protected": "", "type": "Object", "description": "Object returned from temporary subscription to disabledChange event to\ndefer setting the disabled state while Slider is loading the thumb\nimage.", "guessedname": "_stall", "guessedtype": "property"}}, "description": "Create a slider to represent an integer value between a given minimum and\nmaximum. Sliders may be aligned vertically or horizontally, based on the\naxis configuration."}, "Assert.UnexpectedValue": {"name": "Assert.UnexpectedValue", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}, {"type": "Object", "name": "unexpected", "description": " The unexpected value."}], "description": "UnexpectedValue is subclass of Error that is thrown whenever\na value was unexpected in its scope. This typically means that a test\nwas performed to determine that a value was *not* equal to a certain\nvalue."}], "namespace": "Assert", "module": "test", "guessedname": "UnexpectedValue", "methods": {"getMessage": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. The message\ncontains information about the unexpected value that was encountered.", "guessedname": "getMessage", "guessedtype": "function"}}, "extends": "Assert.Error", "superclass": "Assert.Error", "file": "Assert.js", "guessedtype": "function", "shortname": "UnexpectedValue", "properties": {"unexpected": {"type": "Object", "description": "The unexpected value.", "guessedname": "unexpected", "guessedtype": "property"}, "name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}}, "description": "UnexpectedValue is subclass of Error that is thrown whenever\na value was unexpected in its scope. This typically means that a test\nwas performed to determine that a value was *not* equal to a certain\nvalue."}, "config": {"name": "config", "namespace": "", "module": "yui", "static": "", "file": "yui.js", "shortname": "config", "properties": {"comboBase": {"type": "string", "description": "The YUI combo service base dir. Ex: http://yui.yahooapis.com/combo?\nFor dynamic loading."}, "cssAttributes": {"type": "string", "description": "Object literal containing attributes to add to dynamically loaded link nodes."}, "force": {"type": "string[]", "description": "A list of modules that should always be loaded when required, even if already \npresent on the page."}, "locale": {"guessedname": "locale", "type": "string", "description": "The default locale", "value": "\"en\"", "guessedtype": "property"}, "win": {"default": "the window hosting YUI", "type": "Window", "description": "The window/frame that this instance should operate in."}, "logExclude": {"type": "object", "description": "A hash of log sources that should be not be logged. If specified, all sources are logged if not on this list."}, "onCSS": {"type": "function", "description": "Callback for the 'CSSComplete' event. When dynamically loading YUI \ncomponents with CSS, this property fires when the CSS is finished\nloading but script loading is still ongoing. This provides an\nopportunity to enhance the presentation of a loading page a little\nbit before the entire loading process is done."}, "filters": {"type": "object", "description": "Hash of per-component filter specification. If specified for a given component, \nthis overrides the filter config\nFor dynamic loading."}, "pollInterval": {"default": "20", "type": "int", "description": "The default interval when polling in milliseconds."}, "ignore": {"type": "string[]", "description": "A list of modules that should never be dynamically loaded"}, "dateFormat": {"guessedname": "dateFormat", "type": "string", "description": "The default date format", "value": "\"%Y-%m-%d\"", "guessedtype": "property"}, "charset": {"deprecated": "use jsAttributes cssAttributes", "type": "string", "description": "charset for dynamic nodes"}, "logInclude": {"type": "object", "description": "A hash of log sources that should be logged. If specified, only log messages from these sources will be logged."}, "windowResizeDelay": {"default": "40", "type": "int", "description": "The default interval when polling in milliseconds."}, "combine": {"default": "true if 'base' is not supplied, false if it is.", "type": "boolean", "description": "Use the YUI combo service to reduce the number of http connections \nrequired to load your dependencies.\nFor dynamic loading."}, "loaderPath": {"default": "loader/loader-min.js", "description": "The loader 'path' attribute to the loader itself. This is combined\nwith the 'base' attribute to dynamically load the loader component\nwhen boostrapping with the get utility alone."}, "purgethreshold": {"default": "20", "type": "int", "description": "The number of dynamic nodes to insert by default before\nautomatically removing them. This applies to script nodes\nbecause remove the node will not make the evaluated script\nunavailable. Dynamic CSS is not auto purged, because removing\na linked style sheet will also remove the style definitions."}, "core": {"type": "string[]", "description": "A list of modules that defines the YUI core (overrides the default)."}, "timeout": {"type": "int", "description": "Number of milliseconds before a timeout occurs when dynamically \nloading nodes. If not set, there is no timeout."}, "insertBefore": {"type": "string", "description": "Node or id for a node that should be used as the insertion point for new nodes\nFor dynamic loading."}, "useBrowserConsole": {"default": "true", "type": "boolean", "description": "Log to the browser console if debug is on and the browser has a\nsupported console."}, "jsAttributes": {"type": "string", "description": "Object literal containing attributes to add to dynamically loaded script nodes."}, "base": {"type": "string", "description": "Base directory for dynamic loading"}, "injected": {"type": "object", "description": "Set to true if the yui seed file was dynamically loaded in \norder to bootstrap components relying on the window load event \nand the 'domready' custom event."}, "doc": {"default": "the document hosting YUI", "type": "Document", "description": "The document associated with the 'win' configuration."}, "bootstrap": {"default": "true", "type": "boolean", "description": "Allows the YUI seed file to fetch the loader component and library\nmetadata to dynamically load additional dependencies."}, "modules": {"type": "function", "description": "A list of module definitions to add to the list of YUI components. \nThese components can then be dynamically loaded side by side with\nYUI via the use() method.See Loader.addModule for the supported\nmodule metadata."}, "fetchCSS": {"default": "true", "description": "Specifies whether or not YUI().use(...) will attempt to load CSS\nresources at all. Any truthy value will cause CSS dependencies\nto load when fetching script. The special value 'force' will \ncause CSS dependencies to be loaded even if no script is needed."}, "filter": {"type": "string|object", "description": "A filter to apply to result urls. This filter will modify the default\npath for all modules. The default path for the YUI library is the\nminified version of the files (e.g., event-min.js). The filter property\ncan be a predefined filter or a custom filter. The valid predefined \nfilters are:\n
\n
DEBUG
\n
Selects the debug versions of the library (e.g., event-debug.js).\nThis option will automatically include the Logger widget
\n
RAW
\n
Selects the non-minified version of the library (e.g., event.js).
\n
\nYou can also define a custom filter, which must be an object literal \ncontaining a search expression and a replace string:\n
\nFor dynamic loading."}, "secureBase": {"type": "string", "description": "The secure base dir (not implemented)\nFor dynamic loading."}, "root": {"type": "string", "description": "The root path to prepend to module names for the combo service. Ex: 3.0.0b1/build/\nFor dynamic loading."}, "throwFail": {"default": "true", "type": "boolean", "description": "If throwFail is set, Y.fail will generate or re-throw a JS Error. Otherwise the failure is logged."}}, "description": "The config object contains all of the configuration options for\nthe YUI instance. This object is supplied by the implementer \nwhen instantiating a YUI instance. Some properties have default\nvalues if they are not supplied by the implementer."}, "Assert.ShouldFail": {"name": "Assert.ShouldFail", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "ShouldFail is subclass of Error that is thrown whenever\na test was expected to fail but did not."}], "namespace": "Assert", "module": "test", "guessedname": "ShouldFail", "extends": "Assert.Error", "superclass": "Assert.Error", "file": "Assert.js", "guessedtype": "function", "shortname": "ShouldFail", "properties": {"name": {"type": "String", "description": "The name of the error that occurred.", "guessedname": "name", "guessedtype": "property"}}, "description": "ShouldFail is subclass of Error that is thrown whenever\na test was expected to fail but did not."}, "DataSchema.Text": {"name": "DataSchema.Text", "namespace": "", "module": "dataschema", "guessedname": "LANG", "methods": {"apply": {"return": {"type": "Object", "description": "Schema-parsed data."}, "description": "Applies a given schema to given delimited text data.", "static": "", "guessedname": "apply", "guessedtype": "function", "params": [{"type": "Object", "name": "schema", "description": " Schema to apply."}, {"type": "Object", "name": "data", "description": " Text data."}]}, "_parseResults": {"return": {"type": "Object", "description": "Parsed data object."}, "description": "Schema-parsed list of results from full data", "protected": "", "static": "", "guessedname": "_parseResults", "guessedtype": "function", "params": [{"type": "Array", "name": "schema", "description": " Schema to parse against."}, {"type": "String", "name": "text_in", "description": " Text to parse."}, {"type": "Object", "name": "data_out", "description": " In-progress parsed data to update."}]}}, "static": "", "superclass": "DataSchema.Base", "file": "dataschema-text.js", "guessedtype": "property", "extends": "DataSchema.Base", "shortname": "DataSchema.Text", "description": "Text subclass for the DataSchema Utility."}, "EventTarget": {"name": "EventTarget", "description": "EventTarget provides the implementation for any object to\npublish, subscribe and fire to custom events, and also\nalows other EventTargets to target the object with events\nsourced from the other object.\nEventTarget is designed to be used with Y.augment to wrap \nEventCustom in an interface that allows events to be listened to \nand fired by name. This makes it possible for implementing code to\nsubscribe to an event that either has not been created yet, or will\nnot be created at all.", "namespace": "", "module": "event-custom", "guessedname": "L", "param": "opts a configuration object", "file": "event-target.js", "guessedtype": "property", "shortname": "EventTarget", "config": "emitFacade {boolean} if true, all events will emit event \nfacade payloads by default (default false)", "methods": {"on": {"return": {"type": "", "description": "the event target or a detach handle per 'chain' config"}, "params": [{"type": "string", "name": "type", "description": " The type of the event"}, {"type": "Function", "name": "fn", "description": " The callback"}], "description": "Subscribe to a custom event hosted by this object", "guessedname": "on", "guessedtype": "function"}, "addTarget": {"params": [{"type": "EventTarget", "name": "o", "description": " the target to add"}], "description": "Registers another EventTarget as a bubble target. Bubble order\nis determined by the order registered. Multiple targets can\nbe specified.", "guessedname": "addTarget", "guessedtype": "function"}, "getEvent": {"return": {"type": "Event.Custom", "description": "the custom event or null"}, "params": [{"type": "string", "name": "type", "description": " the type, or name of the event"}, {"type": "string", "name": "prefixed", "description": " if true, the type is prefixed already"}], "description": "Returns the custom event of the provided type has been created, a\nfalsy value otherwise", "guessedname": "getEvent", "guessedtype": "function"}, "_getType": {"private": "", "description": "If the instance has a prefix attribute and the\nevent type is not prefixed, the instance prefix is\napplied to the supplied type.", "guessedname": "_getType", "guessedtype": "function"}, "removeTarget": {"params": [{"type": "EventTarget", "name": "o", "description": " the target to remove"}], "description": "Removes a bubble target", "guessedname": "removeTarget", "guessedtype": "function"}, "fire": {"return": {"type": "Event.Target", "description": "the event host"}, "params": [{"type": "String|Object", "name": "type", "description": " The type of the event, or an object that contains\na 'type' property."}, {"type": "Object*", "name": "arguments", "description": " an arbitrary set of parameters to pass to \nthe handler. If the first of these is an object literal and the event is\nconfigured to emit an event facade, the event facade will replace that\nparameter after the properties the object literal contains are copied to\nthe event facade."}], "description": "Fire a custom event by name. The callback functions will be executed\nfrom the context specified when the event was created, and with the \nfollowing parameters.\nIf the custom event object hasn't been created, then the event hasn't \nbeen published and it has no subscribers. For performance sake, we \nimmediate exit in this case. This means the event won't bubble, so \nif the intention is that a bubble target be notified, the event must \nbe published on this object first.\nThe first argument is the event type, and any additional arguments are\npassed to the listeners as parameters. If the first of these is an\nobject literal, and the event is configured to emit an event facade,\nthat object is mixed into the event facade and the facade is provided \nin place of the original object.", "guessedname": "fire", "guessedtype": "function"}, "unsubscribeAll": {"deprecated": "use detachAll", "params": [{"type": "string", "name": "type", "description": " The type, or name of the event"}], "description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.", "guessedname": "unsubscribeAll", "guessedtype": "function"}, "after": {"return": {"type": "", "description": "the event target or a detach handle per 'chain' config"}, "params": [{"type": "string", "name": "type", "description": " The type of the event"}, {"type": "Function", "name": "fn", "description": " The callback"}], "description": "Subscribe to a custom event hosted by this object. The\nsupplied callback will execute after any listeners add\nvia the subscribe method, and after the default function,\nif configured for the event, has executed.", "guessedname": "after", "guessedtype": "function"}, "publish": {"return": {"type": "Event.Custom", "description": "the custom event"}, "params": [{"type": "string", "name": "type", "description": " the type, or name of the event"}, {"type": "object", "name": "opts", "description": " optional config params. Valid properties are:\n
\n
\n'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)\n
\n
\n'bubbles': whether or not this event bubbles (true)\n
\n
\n'context': the default execution context for the listeners (this)\n
\n
\n'defaultFn': the default function to execute when this event fires if preventDefault was not called\n
\n
\n'emitFacade': whether or not this event emits a facade (false)\n
\n
\n'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click' \n
\n
\n'fireOnce': if an event is configured to fire once, new subscribers after\nthe fire will be notified immediately.\n
\n
\n'preventable': whether or not preventDefault() has an effect (true)\n
\n
\n'preventedFn': a function that is executed when preventDefault is called\n
\n
\n'queuable': whether or not this event can be queued during bubbling (false)\n
\n
\n'silent': if silent is true, debug messages are not provided for this event.\n
\n
\n'stoppedFn': a function that is executed when stopPropagation is called\n
\n
\n'type': the event type (valid option if not provided as the first parameter to publish)\n
\n
"}], "description": "Creates a new custom event of the specified type. If a custom event\nby that name already exists, it will not be re-created. In either\ncase the custom event is returned.", "guessedname": "publish", "guessedtype": "function"}, "detachAll": {"params": [{"type": "string", "name": "type", "description": " The type, or name of the event"}], "description": "Removes all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.", "guessedname": "detachAll", "guessedtype": "function"}, "subscribe": {"deprecated": "use on", "description": "subscribe to an event", "guessedname": "subscribe", "guessedtype": "function"}, "unsubscribe": {"deprecated": "use detach", "description": "detach a listener", "guessedname": "unsubscribe", "guessedtype": "function"}, "detach": {"return": {"type": "EventTarget", "description": "the host"}, "params": [{"type": "string|Object", "name": "type", "description": " Either the handle to the subscriber or the \ntype of event. If the type\nis not specified, it will attempt to remove\nthe listener from all hosted events."}, {"type": "Function", "name": "fn", "description": " The subscribed function to unsubscribe, if not\nsupplied, all subscribers will be removed."}, {"type": "Object", "name": "context", "description": " The custom object passed to subscribe. This is\noptional, but if supplied will be used to\ndisambiguate multiple listeners that are the same\n(e.g., you subscribe many object using a function\nthat lives on the prototype)"}], "description": "Detach one or more listeners the from the specified event", "guessedname": "detach", "guessedtype": "function"}, "bubble": {"return": {"type": "boolean", "description": "the aggregated return value from Event.Custom.fire"}, "params": [{"type": "Event.Custom", "name": "evt", "description": " the custom event to propagate"}], "description": "Propagate an event. Requires the event-custom-complex module.", "guessedname": "bubble", "guessedtype": "function"}, "_parseType": {"private": "", "description": "Returns an array with the detach key (if provided),\nand the prefixed event name from _getType\nY.on('detachcategory, menu:click', fn)", "guessedname": "_parseType", "guessedtype": "function"}, "before": {"deprecated": "use the on method", "return": {"type": "", "description": "detach handle"}, "description": "Executes the callback before a DOM event, custom event\nor method. If the first argument is a function, it\nis assumed the target is a method. For DOM and custom\nevents, this is an alias for Y.on.\nFor DOM and custom events:\ntype, callback, context, 0-n arguments\nFor methods:\ncallback, object (method host), methodName, context, 0-n arguments", "guessedname": "before", "guessedtype": "function"}}}, "DataType.XML": {"name": "DataType.XML", "description": "DataType.XML provides a set of utility functions to operate against XML documents.", "namespace": "", "module": "datatype", "guessedname": "LANG", "static": "", "file": "datatype-xml-format.js", "guessedtype": "property", "shortname": "DataType.XML", "methods": {"parse": {"return": {"type": "XMLDoc", "description": "XML Document."}, "params": [{"type": "String", "name": "data", "description": " Data to convert."}], "description": "Converts data to type XMLDocument.", "guessedname": "parse", "guessedtype": "function"}, "format": {"return": {"type": "String", "description": "String."}, "params": [{"type": "XMLDoc", "name": "data", "description": " Data to convert."}], "description": "Converts data to type XMLDocument.", "guessedname": "format", "guessedtype": "function"}}}, "Test.Reporter": {"name": "Test.Reporter", "constructors": [{"params": [{"type": "String", "name": "url", "description": " The URL to submit the results to."}, {"type": "Function", "name": "format", "description": " (Optiona) A function that outputs the results in a specific format.\nDefault is Y.Test.Format.XML."}], "description": "An object capable of sending test results to a server."}], "namespace": "Test", "module": "test", "guessedname": "Reporter", "methods": {"report": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Object", "name": "results", "description": " The results object created by TestRunner."}], "description": "Sends the report to the server.", "guessedname": "report", "guessedtype": "function"}, "destroy": {"return": {"type": "Void", "description": ""}, "description": "Cleans up the memory associated with the TestReporter, removing DOM elements\nthat were created.", "guessedname": "destroy", "guessedtype": "function"}, "addField": {"return": {"type": "Void", "description": ""}, "params": [{"type": "String", "name": "name", "description": " The name of the field."}, {"type": "Variant", "name": "value", "description": " The value of the field."}], "description": "Adds a field to the form that submits the results.", "guessedname": "addField", "guessedtype": "function"}}, "file": "TestReporter.js", "guessedtype": "function", "shortname": "Reporter", "properties": {"url": {"type": "String", "description": "The URL to submit the data to.", "guessedname": "url", "guessedtype": "property"}, "_form": {"guessedname": "_form", "type": "HTMLFormElement", "description": "The form element used to submit the results.", "private": "", "guessedtype": "property"}, "_fields": {"guessedname": "_fields", "type": "Object", "description": "Extra fields to submit with the request.", "private": "", "guessedtype": "property"}, "_iframe": {"guessedname": "_iframe", "type": "HTMLIFrameElement", "description": "Iframe used as a target for form submission.", "private": "", "guessedtype": "property"}, "format": {"type": "Function", "description": "The formatting function to call when submitting the data.", "guessedname": "format", "guessedtype": "property"}}, "description": "An object capable of sending test results to a server."}, "WidgetStdMod": {"name": "WidgetStdMod", "namespace": "", "module": "widget-stdmod", "events": {"headerContentChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "headerContentChange", "description": "Fires when the value for the configuration attribute 'headerContent' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "bodyContentChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "bodyContentChange", "description": "Fires when the value for the configuration attribute 'bodyContent' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "fillHeightChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "fillHeightChange", "description": "Fires when the value for the configuration attribute 'fillHeight' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "footerContentChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "footerContentChange", "description": "Fires when the value for the configuration attribute 'footerContent' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"bodyContent": {"default": "undefined", "type": "{String | Node}", "description": "The content to be added to the body section. This will replace any existing content\nin the body. If you want to append, or insert new content, use the setStdModContent method.", "guessedname": "bodyContent", "guessedtype": "property"}, "footerContent": {"default": "undefined", "type": "{String | Node}", "description": "The content to be added to the footer section. This will replace any existing content\nin the footer. If you want to append, or insert new content, use the setStdModContent method.", "guessedname": "footerContent", "guessedtype": "property"}, "fillHeight": {"default": "WidgetStdMod.BODY", "type": "{String}", "description": "The section (WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER) which should be resized to fill the height of the standard module, when a \nheight is set on the Widget. If a height is not set on the widget, then all sections are sized based on \ntheir content.", "guessedname": "fillHeight", "guessedtype": "property"}, "headerContent": {"default": "undefined", "type": "{String | Node}", "description": "The content to be added to the header section. This will replace any existing content\nin the header. If you want to append, or insert new content, use the setStdModContent method.", "guessedname": "headerContent", "guessedtype": "property"}}, "methods": {"_addNodeRef": {"guessedname": "_addNodeRef", "params": [{"type": "Node", "name": "node", "description": " The section Node to be updated."}, {"type": "Node|NodeList", "name": "children", "description": " The new content Node, or NodeList to be added to section Node provided."}, {"type": "String", "name": "where", "description": " Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the Node."}], "description": "Helper method to add nodes, to another node.\nThe child node(s) are added either before, after or replaces the existing node content \nbased on the value of the where argument.", "private": "", "guessedtype": "function"}, "_afterHeaderChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the headerContent attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterHeaderChange", "guessedtype": "function"}, "_findStdModSection": {"return": {"type": "Node", "description": "The rendered node for the given section, or null if not found."}, "description": "Helper method to query the rendered contents of the contentBox to find the\nnode for the given section if it exists.", "private": "", "params": [{"type": "String", "name": "section", "description": " The section for which the render Node is to be found. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}], "guessedname": "_findStdModSection", "guessedtype": "function"}, "_afterFooterChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the footerContent attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterFooterChange", "guessedtype": "function"}, "_syncUIStdMod": {"protected": "", "description": "Synchronizes the UI to match the Widgets standard module state.\n
\nThis method is invoked after syncUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_syncUIStdMod", "guessedtype": "function"}, "_uiSetStdMod": {"protected": "", "params": [{"type": "String", "name": "section", "description": " The section to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}, {"type": "String | Node", "name": "content", "description": " The new content (either as an HTML string, or Node reference) to add to the section"}, {"type": "String", "name": "where", "description": " Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the section."}], "description": "Updates the rendered UI, adding the provided content (either an HTML string, or node reference),\nto the specified section. The content is either added before, after or replaces existing content\nin the section, based on the value of the where argument.", "guessedname": "_uiSetStdMod", "guessedtype": "function"}, "setStdModContent": {"params": [{"type": "String", "name": "section", "description": " The standard module section whose content is to be updated. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}, {"type": "String | Node", "name": "content", "description": " The content to be added, either an HTML string or a Node reference."}, {"type": "String", "name": "where", "description": " Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace existing content in the section."}], "description": "Updates the body section of the standard module with the content provided (either an HTML string, or node reference).\n
\nThis method can be used instead of the corresponding section content attribute if you'd like to retain the current content of the section,\nand insert content before or after it, by specifying the where argument.\n
", "guessedname": "setStdModContent", "guessedtype": "function"}, "_insertStdModSection": {"guessedname": "_insertStdModSection", "params": [{"type": "Node", "name": "contentBox", "description": " A reference to the Widgets content box."}, {"type": "String", "name": "section", "description": " The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}, {"type": "Node", "name": "sectionNode", "description": " The Node for the section."}], "description": "Helper method to insert the Node for the given section into the correct location in the contentBox.", "private": "", "guessedtype": "function"}, "_getPreciseHeight": {"return": {"type": "Number", "description": "The height of the Node including borders and padding, possibly a float."}, "description": "Helper method to obtain the precise height of the node provided, including padding and border.\nThe height could be a sub-pixel value for certain browsers, such as Firefox 3.", "private": "", "params": [{"type": "Node", "name": "node", "description": " The node for which the precise height is required."}], "guessedname": "_getPreciseHeight", "guessedtype": "function"}, "fillHeight": {"params": [{"type": "Node", "name": "node", "description": " The node which should be resized to fill out the height\nof the Widget bounding box. Should be a standard module section node which belongs\nto the widget."}], "description": "Sets the height on the provided header, body or footer element to \nfill out the height of the Widget. It determines the height of the \nwidgets bounding box, based on it's configured height value, and \nsets the height of the provided section to fill out any \nspace remaining after the other standard module section heights \nhave been accounted for.\n
NOTE: This method is not designed to work if an explicit \nheight has not been set on the Widget, since for an \"auto\" height Widget, \nthe heights of the header/body/footer will drive the height of the Widget.
", "guessedname": "fillHeight", "guessedtype": "function"}, "_getStdModTemplate": {"return": {"type": "Node", "description": "The new Node instance for the section"}, "description": "Gets a new Node reference for the given standard module section, by cloning\nthe stored template node.", "protected": "", "params": [{"type": "String", "name": "section", "description": " The section to create a new node for. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}], "guessedname": "_getStdModTemplate", "guessedtype": "function"}, "getStdModNode": {"return": {"type": "Node", "description": "The node reference for the section, or null if not set."}, "params": [{"type": "String", "name": "section", "description": " The section whose node reference is required. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}], "description": "Returns the node reference for the given section. Note: The DOM is not queried for the node reference. The reference\nstored by the widget instance is returned if set.", "guessedname": "getStdModNode", "guessedtype": "function"}, "_addNodeHTML": {"guessedname": "_addNodeHTML", "params": [{"type": "Node", "name": "node", "description": " The section Node to be updated."}, {"type": "String", "name": "html", "description": " The new content HTML string to be added to the section Node."}, {"type": "String", "name": "where", "description": " Optional. Either WidgetStdMod.AFTER, WidgetStdMod.BEFORE or WidgetStdMod.REPLACE.\nIf not provided, the content will replace Nodes existing content."}], "description": "Helper method to add the given HTML string to the node reference provided.\nThe HTML is added either before, after or replaces the existing node content \nbased on the value of the where argument.", "private": "", "guessedtype": "function"}, "_parseStdModHTML": {"return": {"type": "String", "description": "Inner HTML string with the contents of the section"}, "description": "Utility method, used by WidgetStdMods HTML_PARSER implementation\nto extract data for each section from markup.", "private": "", "params": [{"type": "String", "name": "section", "description": ""}], "guessedname": "_parseStdModHTML", "guessedtype": "function"}, "_renderStdMod": {"return": {"type": "Node", "description": "A reference to the added section node"}, "description": "Creates the DOM node for the given section, and inserts it into the correct location in the contentBox.", "protected": "", "params": [{"type": "String", "name": "section", "description": " The section to create/render. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}], "guessedname": "_renderStdMod", "guessedtype": "function"}, "_bindUIStdMod": {"protected": "", "description": "Binds event listeners responsible for updating the UI state in response to \nWidget standard module related state changes.\n
\nThis method is invoked after bindUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_bindUIStdMod", "guessedtype": "function"}, "_fillHeight": {"private": "", "description": "Updates the rendered UI, to resize the current section specified by the fillHeight attribute, so\nthat the standard module fills out the Widget height. If a height has not been set on Widget,\nthe section is not resized (height is set to \"auto\").", "guessedname": "_fillHeight", "guessedtype": "function"}, "_renderUIStdMod": {"protected": "", "description": "Creates/Initializes the DOM for standard module support.\n
\nThis method is invoked after renderUI is invoked for the Widget class\nusing YUI's aop infrastructure.\n
", "guessedname": "_renderUIStdMod", "guessedtype": "function"}, "_uiSetFillHeight": {"protected": "", "params": [{"type": "String", "name": "fillSection", "description": " A valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER"}], "description": "Updates the rendered UI, to resize the provided section so that the standard module fills out \nthe specified widget height. Note: This method does not check whether or not a height is set \non the Widget.", "guessedname": "_uiSetFillHeight", "guessedtype": "function"}, "_validateFillHeight": {"return": {"type": "", "description": "true if valid, false if not"}, "description": "Default validator for the fillHeight attribute. Verifies that the \nvalue set is a valid section specifier - one of WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER,\nor a falsey value if fillHeight is to be disabled.", "protected": "", "params": [{"type": "String", "name": "val", "description": " The section which should be setup to fill height, or false/null to disable fillHeight"}], "guessedname": "_validateFillHeight", "guessedtype": "function"}, "_afterBodyChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the bodyContent attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterBodyChange", "guessedtype": "function"}, "_afterFillHeightChange": {"protected": "", "params": [{"type": "EventFacade", "name": "e", "description": " The event facade for the attribute change"}], "description": "Default attribute change listener for the fillHeight attribute, responsible\nfor updating the UI, in response to attribute changes.", "guessedname": "_afterFillHeightChange", "guessedtype": "function"}, "_getStdModContent": {"return": {"type": "Node", "description": "The child node collection of the standard module section."}, "description": "Retrieves the child nodes (content) of a standard module section", "private": "", "params": [{"type": "String", "name": "section", "description": " The standard module section whose child nodes are to be retrieved. Either WidgetStdMod.HEADER, WidgetStdMod.BODY or WidgetStdMod.FOOTER."}], "guessedname": "_getStdModContent", "guessedtype": "function"}}, "param": "{Object} The user configuration object", "file": "Widget-StdMod.js", "shortname": "WidgetStdMod", "properties": {"WidgetStdMod.HEADER": {"type": "String", "static": "", "description": "Constant used to refer the the standard module header, in methods which expect a section specifier", "guessedname": "HEADER", "guessedtype": "property"}, "WidgetStdMod.REPLACE": {"type": "String", "static": "", "description": "Constant used to specify insertion position, when adding content to sections of the standard module in\nmethods which expect a \"where\" argument.\n
\nReplaces the sections existing content, with new content.\n
", "guessedname": "REPLACE", "guessedtype": "property"}, "WidgetStdMod.ATTRS": {"type": "Object", "static": "", "description": "Static property used to define the default attribute \nconfiguration introduced by WidgetStdMod.", "guessedname": "ATTRS", "guessedtype": "property"}, "WidgetStdMod.BEFORE": {"type": "String", "static": "", "description": "Constant used to specify insertion position, when adding content to sections of the standard module in\nmethods which expect a \"where\" argument.\n
\nInserts new content before the sections existing content.\n
", "guessedname": "BEFORE", "guessedtype": "property"}, "WidgetStdMod.HTML_PARSER": {"type": "Object", "static": "", "description": "The HTML parsing rules for the WidgetStdMod class.", "guessedname": "HTML_PARSER", "guessedtype": "property"}, "WidgetStdMod.SECTION_CLASS_NAMES": {"type": "Object", "static": "", "description": "Static hash of default class names used for the header,\nbody and footer sections of the standard module, keyed by\nthe section identifier (WidgetStdMod.STD_HEADER, WidgetStdMod.STD_BODY, WidgetStdMod.STD_FOOTER)", "guessedname": "SECTION_CLASS_NAMES", "guessedtype": "property"}, "WidgetStdMod.FOOTER": {"type": "String", "static": "", "description": "Constant used to refer the the standard module footer, in methods which expect a section specifier", "guessedname": "FOOTER", "guessedtype": "property"}, "WidgetStdMod.TEMPLATES": {"type": "Object", "static": "", "description": "The template HTML strings for each of the standard module sections. Section entries are keyed by the section constants,\nWidgetStdMod.HEADER, WidgetStdMod.BODY, WidgetStdMod.FOOTER, and contain the HTML to be added for each section.\ne.g.\n
", "guessedname": "TEMPLATES", "guessedtype": "property"}, "WidgetStdMod.BODY": {"type": "String", "static": "", "description": "Constant used to refer the the standard module body, in methods which expect a section specifier", "guessedname": "BODY", "guessedtype": "property"}, "WidgetStdMod.AFTER": {"type": "String", "static": "", "description": "Constant used to specify insertion position, when adding content to sections of the standard module in \nmethods which expect a \"where\" argument.\n
\nInserts new content before the sections existing content.\n
", "guessedname": "AFTER", "guessedtype": "property"}}, "description": "Widget extension, which can be used to add Standard Module support to the \nbase Widget class, through the Base.build \nmethod.\n
\nThe extension adds header, body and footer sections to the Widget's content box and \nprovides the corresponding methods and attributes to modify the contents of these sections.\n
"}, "Array": {"name": "Array", "namespace": "", "module": "yui", "methods": {"hash": {"return": {"type": "object", "description": "the hash"}, "description": "Returns an object using the first array as keys, and\nthe second as values. If the second array is not\nprovided the value is set to true for each.", "static": "", "guessedname": "hash", "guessedtype": "function", "params": [{"type": "Array", "name": "k", "description": " keyset"}, {"type": "Array", "name": "v", "description": " optional valueset"}]}, "indexOf": {"return": {"type": "int", "description": "the index of the item that contains the value or -1"}, "description": "Returns the index of the first item in the array\nthat contains the specified value, -1 if the\nvalue isn't found.", "static": "", "guessedname": "indexOf", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to search"}, {"type": "", "name": "val", "description": " the value to search for"}]}, "some": {"return": {"type": "boolean", "description": "true if the function returns true on\nany of the items in the array"}, "description": "Executes the supplied function on each item in the array.\nReturning true from the processing function will stop the \nprocessing of the remaining\nitems.", "static": "", "guessedname": "some", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item. The function \nreceives three arguments: the value, the index, the full array."}, {"type": "", "name": "o", "description": " Optional context object"}]}, "()": {"return": {"type": "Array", "description": "the resulting array"}, "description": "Y.Array(o) returns an array:\n- Arrays are return unmodified unless the start position is specified.\n- \"Array-like\" collections (@see Array.test) are converted to arrays\n- For everything else, a new array is created with the input as the sole item\n- The start position is used if the input is or is like an array to return\na subset of the collection.", "static": "", "guessedname": "YArray", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " the item to arrayify"}, {"type": "int", "name": "i", "description": " if an array or array-like, this is the start index"}, {"type": "boolean", "name": "al", "description": " if true, it forces the array-like fork. This\ncan be used to avoid multiple array.test calls."}], "todo": "this will not automatically convert elements that are also collections\nsuch as forms and selects. Passing true as the third param will\nforce a conversion."}, "each": {"return": {"type": "YUI", "description": "the YUI instance"}, "description": "Executes the supplied function on each item in the array.", "static": "", "guessedname": "each", "guessedtype": "property", "params": [{"type": "Array", "name": "a", "description": " the array to iterate"}, {"type": "Function", "name": "f", "description": " the function to execute on each item. The \nfunction receives three arguments: the value, the index, the full array."}, {"type": "", "name": "o", "description": " Optional context object"}]}, "test": {"return": {"type": "int", "description": "a number indicating the results:\n0: Not an array or an array-like collection\n1: A real array. \n2: array-like collection."}, "description": "Evaluates the input to determine if it is an array, array-like, or \nsomething else. This is used to handle the arguments collection \navailable within functions, and HTMLElement collections", "static": "", "guessedname": "test", "guessedtype": "function", "todo": "current implementation (intenionally) will not implicitly \nhandle html elements that are array-like (forms, selects, etc)."}, "numericSort": {"description": "Numeric sort convenience function.\nY.ArrayAssert.itemsAreEqual([1, 2, 3], [3, 1, 2].sort(Y.Array.numericSort));", "guessedname": "numericSort", "guessedtype": "function"}}, "file": "yui-array.js", "shortname": "Array", "description": "Adds the following array utilities to the YUI instance. Additional\narray helpers can be found in the collection component."}, "EventHandle": {"name": "EventHandle", "constructors": [{"params": [{"type": "CustomEvent", "name": "evt", "description": " the custom event"}, {"type": "Subscriber", "name": "sub", "description": " the subscriber"}], "description": "Return value from all subscribe operations"}], "namespace": "", "module": "event-custom", "methods": {"detach": {"description": "Detaches this subscriber", "guessedname": "detach", "guessedtype": "function"}}, "file": "event-custom.js", "shortname": "EventHandle", "properties": {"evt": {"type": "CustomEvent", "description": "The custom event", "guessedname": "evt", "guessedtype": "property"}, "sub": {"type": "Subscriber", "description": "The subscriber object", "guessedname": "sub", "guessedtype": "property"}}, "description": "Return value from all subscribe operations"}, "Do.Error": {"name": "Do.Error", "deprecated": "use Y.Do.Halt or Y.Do.Prevent", "namespace": "", "module": "event-custom", "guessedname": "Error", "file": "event-do.js", "guessedtype": "property", "shortname": "Do.Error", "description": "Return an Error object when you want to terminate the execution\nof all subsequent method calls."}, "Plugin.ConsoleFilters": {"name": "Plugin.ConsoleFilters", "namespace": "Plugin", "module": "console-filters", "events": {"defaultVisibilityChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "defaultVisibilityChange", "description": "Fires when the value for the configuration attribute 'defaultVisibility' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "sourceChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "sourceChange", "description": "Fires when the value for the configuration attribute 'source' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "cacheLimitChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "cacheLimitChange", "description": "Fires when the value for the configuration attribute 'cacheLimit' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}, "categoryChange": {"params": [{"type": "Event.Facade", "name": "event", "description": "An Event Facade object with the following attribute specific properties added:\t
\t\t
prevVal
\t\t
The value of the attribute, prior to it being set
\t\t
newVal
\t\t
The value the attribute is to be set to
\t\t
attrName
\t\t
The name of the attribute being set
\t\t
subAttrName
\t\t
If setting a property within the attribute's value, the name of the sub-attribute property being set
\t
"}], "name": "categoryChange", "description": "Fires when the value for the configuration attribute 'category' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed."}}, "configs": {"category": {"type": "Object", "description": "
Map of entry categories to their visibility status. Update a\nparticular category's visibility by setting the subattribute to true\n(visible) or false (hidden).
\n
For example, yconsole.filter.set('category.info', false) to hide\nlog entries with the category/logLevel of 'info'.
\n
Similarly, yconsole.filter.get('category.warn') will return a\nboolean indicating whether that category is currently being included\nin the UI.
\n
Unlike the YUI instance configuration's logInclude and logExclude\nproperties, filtered entries are only hidden from the UI, but\ncan be made visible again.
Map of entry sources to their visibility status. Update a\nparticular sources's visibility by setting the subattribute to true\n(visible) or false (hidden).
\n
For example, yconsole.filter.set('sources.slider', false) to hide\nlog entries originating from Y.Slider.
", "guessedname": "source", "guessedtype": "property"}, "defaultVisibility": {"default": "true", "type": "{Boolean}", "description": "Default visibility applied to new categories and sources.", "guessedname": "defaultVisibility", "guessedtype": "property"}, "cacheLimit": {"default": "Number.POSITIVE_INFINITY", "type": "{Number}", "description": "Maximum number of entries to store in the message cache. Use this to\nlimit the memory footprint in environments with heavy log usage.\nBy default, there is no limit (Number.POSITIVE_INFINITY).", "guessedname": "cacheLimit", "guessedtype": "property"}}, "methods": {"_createCheckbox": {"protected": "", "params": [{"type": "Node", "name": "container", "description": " the parentNode of the new checkbox and label"}, {"type": "String", "name": "name", "description": " the identifier of the filter"}], "description": "Creates a checkbox and label from the ConsoleFilters.FILTER_TEMPLATE for\nthe provided type and name. The checkbox and label are appended to the\ncontainer node passes as the first arg.", "guessedname": "_createCheckbox", "guessedtype": "function"}, "initializer": {"protected": "", "description": "Initialize entries collection and attach listeners to host events and\nmethods.", "guessedname": "initializer", "guessedtype": "function"}, "_onCategoryCheckboxClick": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the DOM event"}], "description": "Passes checkbox clicks on to the category attribute.", "guessedname": "_onCategoryCheckboxClick", "guessedtype": "function"}, "_uiSetCheckbox": {"protected": "", "params": [{"type": "String", "name": "type", "description": " 'category' or 'source'"}, {"type": "String", "name": "item", "description": " the name of the filter (e.g. 'info', 'event')"}, {"type": "Boolean", "name": "checked", "description": " value to set the checkbox's checked property"}], "description": "Updates the checked property of a filter checkbox of the specified type.\nIf no checkbox is found for the input params, one is created.", "guessedname": "_uiSetCheckbox", "guessedtype": "function"}, "_onEntry": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the custom event object"}], "description": "Ensures a filter is set up for any new categories or sources and\ncollects the messages in _entries. If the message is stamped with a\ncategory or source that is currently being filtered out, the message\nwill not pass to the Console's print buffer.", "guessedname": "_onEntry", "guessedtype": "function"}, "refreshConsole": {"description": "Repopulates the Console with entries appropriate to the current filter\nsettings.", "guessedname": "refreshConsole", "guessedtype": "function"}, "destructor": {"protected": "", "description": "Removes the plugin UI and unwires events.", "guessedname": "destructor", "guessedtype": "function"}, "_afterCategoryChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the attribute change event object"}], "description": "Triggers the Console to update if a known category filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.", "guessedname": "_afterCategoryChange", "guessedtype": "function"}, "showSource": {"params": [{"type": "String", "name": "src*", "description": " 1..n sources to allow to display in the UI"}], "description": "Shows any number of sources in the UI. Convenience method for\nmyConsole.filter.set('source.foo', true); set('source.bar', true);\nand so on.", "guessedname": "showSource", "guessedtype": "function"}, "bindUI": {"protected": "", "description": "Binds to checkbox click events and internal attribute change events to\nmaintain the UI state.", "guessedname": "bindUI", "guessedtype": "function"}, "showCategory": {"params": [{"type": "String", "name": "cat*", "description": " 1..n categories to allow to display in the UI"}], "description": "Shows any number of categories in the UI. Convenience method for\nmyConsole.filter.set('category.foo', true); set('category.bar', true);\nand so on.", "guessedname": "showCategory", "guessedtype": "function"}, "_validateCategory": {"return": {"type": "", "description": "Boolean"}, "description": "Validates category updates are objects and the subattribute is not too\ndeep.", "protected": "", "params": [{"type": "String", "name": "cat", "description": " the new category:visibility map"}, {"type": "String", "name": "v", "description": " the subattribute path updated"}], "guessedname": "_validateCategory", "guessedtype": "function"}, "_onSourceCheckboxClick": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the DOM event"}], "description": "Passes checkbox clicks on to the source attribute.", "guessedname": "_onSourceCheckboxClick", "guessedtype": "function"}, "_validateSource": {"return": {"type": "", "description": "Boolean"}, "description": "Validates source updates are objects and the subattribute is not too\ndeep.", "protected": "", "params": [{"type": "String", "name": "cat", "description": " the new source:visibility map"}, {"type": "String", "name": "v", "description": " the subattribute path updated"}], "guessedname": "_validateSource", "guessedtype": "function"}, "hideCategory": {"params": [{"type": "String", "name": "cat*", "description": " 1..n categories to filter out of the UI"}], "description": "Hides any number of categories from the UI. Convenience method for\nmyConsole.filter.set('category.foo', false); set('category.bar', false);\nand so on.", "guessedname": "hideCategory", "guessedtype": "function"}, "syncUI": {"description": "Updates the UI to be in accordance with the current state of the plugin.", "guessedname": "syncUI", "guessedtype": "function"}, "_afterClearConsole": {"protected": "", "description": "Flushes the cached entries after a call to the Console's clearConsole().", "guessedname": "_afterClearConsole", "guessedtype": "function"}, "_afterCacheLimitChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the attribute change event object"}], "description": "Trims the cache of entries to the appropriate new length.", "guessedname": "_afterCacheLimitChange", "guessedtype": "function"}, "_afterSourceChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the attribute change event object"}], "description": "Triggers the Console to update if a known source filter\nchanges value (e.g. visible => hidden). Updates the appropriate\ncheckbox's checked state if necessary.", "guessedname": "_afterSourceChange", "guessedtype": "function"}, "_filterBuffer": {"protected": "", "description": "Flushes the Console's print buffer of any entries that have a category\nor source that is currently being excluded.", "guessedname": "_filterBuffer", "guessedtype": "function"}, "hideSource": {"params": [{"type": "String", "name": "src*", "description": " 1..n sources to filter out of the UI"}], "description": "Hides any number of sources from the UI. Convenience method for\nmyConsole.filter.set('source.foo', false); set('source.bar', false);\nand so on.", "guessedname": "hideSource", "guessedtype": "function"}, "renderUI": {"protected": "", "description": "Adds the category and source filter sections to the Console footer.", "guessedname": "renderUI", "guessedtype": "function"}}, "file": "console-filters.js", "shortname": "ConsoleFilters", "properties": {"ConsoleFilters.NAME": {"description": "Plugin name.", "default": "'consoleFilters'", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String"}, "ConsoleFilters.CHROME_CLASSES": {"description": "Classnames used by the templates when creating nodes.", "protected": "", "static": "", "guessedname": "CHROME_CLASSES", "guessedtype": "property", "type": "Object"}, "ConsoleFilters.SOURCES_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to create the container for the source filters.", "guessedname": "SOURCES_TEMPLATE", "guessedtype": "property"}, "_entries": {"protected": "", "type": "Array", "description": "Collection of all log messages passed through since the plugin's\ninstantiation. This holds all messages regardless of filter status.\nUsed as a single source of truth for repopulating the Console body when\nfilters are changed.", "guessedname": "_entries", "guessedtype": "property"}, "ConsoleFilters.FILTER_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to create the category and source filter checkboxes.", "guessedname": "FILTER_TEMPLATE", "guessedtype": "property"}, "_categories": {"protected": "", "type": "Node", "description": "The container node created to house the category filters.", "guessedname": "_categories", "guessedtype": "property"}, "ConsoleFilters.CATEGORIES_TEMPLATE": {"type": "String", "static": "", "description": "Markup template used to create the container for the category filters.", "guessedname": "CATEGORIES_TEMPLATE", "guessedtype": "property"}, "ConsoleFilters.NS": {"description": "The namespace hung off the host object that this plugin will inhabit.", "default": "'filter'", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String"}, "_sources": {"protected": "", "type": "Node", "description": "The container node created to house the source filters.", "guessedname": "_sources", "guessedtype": "property"}}, "description": "
Provides Plugin.ConsoleFilters plugin class.
\n
This plugin adds the ability to control which Console entries display by filtering on category and source. Two groups of checkboxes are added to the Console footer, one for categories and the other for sources. Only those messages that match a checked category or source are displayed.
"}, "Test.Format.Mock": {"name": "Test.Format.Mock", "constructors": [{"params": [{"type": "Object", "name": "template", "description": " (Optional) An object whose methods\nshould be stubbed out on the mock object."}], "description": "Creates a new mock object."}], "namespace": "Test.Format", "module": "test", "guessedname": "Mock", "methods": {"verify": {"return": {"type": "void", "description": ""}, "description": "Verifies that all expectations of a mock object have been met and\nthrows an assertion error if not.", "static": "", "guessedname": "verify", "guessedtype": "function", "params": [{"type": "Object", "name": "mock", "description": " The object to verify.."}]}, "expect": {"return": {"type": "void", "description": ""}, "description": "Assigns an expectation to a mock object. This is used to create\nmethods and properties on the mock object that are monitored for\ncalls and changes, respectively.", "static": "", "guessedname": "expect", "guessedtype": "function", "params": [{"type": "Object", "name": "mock", "description": " The object to add the expectation to."}, {"type": "Object", "name": "expectation", "description": " An object defining the expectation. For\na method, the keys \"method\" and \"args\" are required with\nan optional \"returns\" key available. For properties, the keys\n\"property\" and \"value\" are required."}]}}, "file": "Mock.js", "guessedtype": "function", "shortname": "Mock", "description": "Creates a new mock object."}, "DataType.Date.Locale": {"name": "DataType.Date.Locale", "namespace": "", "module": "datatype", "guessedname": "YDateEn", "static": "", "file": "datatype-date-locale.js", "guessedtype": "property", "shortname": "DataType.Date.Locale", "requires": "oop", "description": "The Date.Locale class is a container for all localised date strings\nused by Y.DataType.Date. It is used internally, but may be extended\nto provide new date localisations.\nTo create your own Locale, follow these steps:\n\n
Find an existing locale that matches closely with your needs
\n
Use this as your base class. Use Y.DataType.Date.Locale[\"en\"] if nothing\nmatches.
\n
Create your own class as an extension of the base class using\nY.merge, and add your own localisations where needed.
\n\nSee the Y.DataType.Date.Locale[\"en-US\"] and Y.DataType.Date.Locale[\"en-GB\"]\nclasses which extend Y.DataType.Date.Locale[\"en\"].\nFor example, to implement locales for French french and Canadian french,\nwe would do the following:\n\n
For French french, we have no existing similar locale, so use\nY.DataType.Date.Locale[\"en\"] as the base, and extend it:\n
"}, "EventFacade": {"file": "event-facade.js", "description": "Wraps and protects a custom event for use when emitFacade is set to true.\nRequires the event-custom-complex module", "namespace": "", "module": "event-custom", "methods": {"stopImmediatePropagation": {"description": "Stops the propagation to the next bubble target and\nprevents any additional listeners from being exectued\non the current target.", "guessedname": "stopImmediatePropagation", "guessedtype": "function"}, "stopPropagation": {"description": "Stops the propagation to the next bubble target", "guessedname": "stopPropagation", "guessedtype": "function"}, "preventDefault": {"description": "Prevents the event's default behavior", "guessedname": "preventDefault", "guessedtype": "function"}, "halt": {"params": [{"type": "boolean", "name": "immediate", "description": " if true additional listeners\non the current target will not be executed"}], "description": "Stops the event propagation and prevents the default\nevent behavior.", "guessedname": "halt", "guessedtype": "function"}}, "param": "e {Event} the custom event", "guessedname": "EventFacade", "guessedtype": "function", "shortname": "EventFacade", "properties": {"relatedTarget": {"type": "Node", "propery": "relatedTarget", "description": "Node reference to the relatedTarget", "guessedname": "relatedTarget", "guessedtype": "property"}, "type": {"type": "string", "description": "The event type", "guessedname": "type", "guessedtype": "property"}, "details": {"type": "Array", "description": "The arguments passed to fire", "guessedname": "details", "guessedtype": "property"}, "currentTarget": {"type": "Node", "propery": "currentTarget", "description": "Node reference for the element that the listener was attached to.", "guessedname": "currentTarget", "guessedtype": "property"}, "target": {"type": "Node", "propery": "target", "description": "Node reference for the targeted eventtarget", "guessedname": "target", "guessedtype": "property"}}, "name": "EventFacade"}, "DataSourceTextSchema": {"name": "DataSourceTextSchema", "namespace": "", "module": "datasource", "guessedname": "DataSourceTextSchema", "methods": {"_beforeDefDataFn\n
\n
tId (Number)
Unique transaction ID.
\n
request (Object)
The request.
\n
callback (Object)
The callback object with the following properties:\n
\n
success (Function)
Success handler.
\n
failure (Function)
Failure handler.
\n
\n
\n
data (Object)
Raw data.
\n
": {"protected": "", "description": "Parses raw data into a normalized response.", "guessedname": "_beforeDefDataFn", "guessedtype": "function"}, "initializer": {"guessedname": "initializer", "params": [{"type": "Object", "name": "config", "description": " Config object."}], "description": "Internal init() handler.", "private": "", "guessedtype": "function"}}, "extends": "Plugin.Base", "superclass": "Plugin.Base", "file": "datasource-textschema.js", "guessedtype": "function", "shortname": "DataSourceTextSchema", "properties": {"NS": {"description": "The namespace for the plugin. This will be the property on the host which\nreferences the plugin instance.", "value": "\"schema\"", "static": "", "guessedname": "NS", "guessedtype": "property", "type": "String", "final": ""}, "NAME": {"description": "Class name.", "value": "\"dataSourceTextSchema\"", "static": "", "guessedname": "NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Adds schema-parsing to the DataSource Utility."}}, "version": "3.0.0", "namespaces": ["Plugin", "DD", "plugin", "Assert", "Test", "Test.Format"]}
\ No newline at end of file