raw.json revision 62e7a7d39cc0c6d25fec20964c26bc35b9fa116a
{"classmap": {"NodeList": {"name": "NodeList", "namespace": "", "module": "node", "guessedname": "NodeList", "methods": {"getXY": {"return": {"type": "Array", "description": "The XY position of the node"}, "description": "Gets the current position of the node in page coordinates. \nNodes must be part of the DOM tree to have page coordinates\n(display:none or nodes not appended return false)."}, "toggleClass": {"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."}, "set": {"see": "Node", "params": [{"type": "String", "name": "prop", "description": " Property to set"}, {"type": "any", "name": "val", "description": " Value to apply to the given property"}], "description": "Set the value of the property\/attribute on all HTMLElements bound to this NodeList.\nOnly strings\/numbers\/booleans are passed through unless a SETTER exists.", "guessedname": "set", "guessedtype": "function"}, "get": {"return": {"type": "Array", "description": "Array containing the current values mapped to the Node indexes"}, "description": "Get the value of the property\/attribute for each of the HTMLElements bound to this NodeList.\nOnly strings\/numbers\/booleans are passed through unless a GETTER exists.", "see": "Node", "params": [{"type": "String", "name": "prop", "description": " Property to get"}], "guessedname": "get", "guessedtype": "function"}, "removeClass": {"params": [{"type": "String", "name": "className", "description": " the class name to remove from the class attribute"}], "description": "Removes a class name from a given element or collection of elements."}, "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"}], "description": "Replace a class with another class for a given element or collection of elements.\nIf no oldClassName is present, the newClassName is simply added."}, "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"}, "getX": {"return": {"type": "Int", "description": "The X position of the node"}, "description": "Gets the current position of the node in page coordinates. \nNodes must be part of the DOM tree to have page coordinates\n(display:none or nodes not appended return false)."}, "setXY": {"params": [{"type": "Array", "name": "xy", "description": " Contains X & Y values for new position (coordinates are page-based)"}], "description": "Set the position of a node in page coordinates, regardless of how the node is positioned.\nThe node must be part of the DOM tree to have page coordinates (display:none or elements not appended return false)."}, "each": {"return": {"type": "NodeList", "description": "NodeList containing the updated collection"}, "description": "Applies the given function to each Node in the NodeList.", "see": "Y.each", "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"}, "hasClass": {"return": {"type": "Boolean", "description": "A boolean value or array of boolean values"}, "params": [{"type": "String", "name": "className", "description": " the class name to search for"}], "description": "Determines whether an HTMLElement has the given className."}, "addClass": {"params": [{"type": "String", "name": "className", "description": " the class name to add to the class attribute"}], "description": "Adds a class name to a given element or collection of elements."}, "setX": {"params": [{"type": "Int", "name": "x", "description": " X value for new position (coordinates are page-based)"}], "description": "Set the position of a node in page coordinates, regardless of how the node is positioned.\nThe node must be part of the DOM tree to have page coordinates (display:none or elements not appended return false)."}, "setY": {"params": [{"type": "Int", "name": "y", "description": " Y value for new position (coordinates are page-based)"}], "description": "Set the position of a node in page coordinates, regardless of how the node is positioned.\nThe node must be part of the DOM tree to have page coordinates (display:none or elements not appended return false)."}, "getY": {"return": {"type": "Int", "description": "The Y position of the node"}, "description": "Gets the current position of the node in page coordinates. \nNodes must be part of the DOM tree to have page coordinates\n(display:none or nodes not appended return false)."}, "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"}}, "file": "node.js", "guessedtype": "function", "shortname": "NodeList", "description": "A wrapper for manipulating multiple DOM elements"}, "UA": {"name": "UA", "namespace": "", "module": "yui", "guessedname": "UA", "file": "yui-ua.js", "guessedtype": "function", "shortname": "UA", "properties": {"opera": {"type": "float", "description": "Opera version number or 0. Example: 9.2", "guessedname": "opera", "guessedtype": "property"}, "gecko": {"type": "float", "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<pre>\nFirefox 1.0.0.4: 1.7.8 <-- Reports 1.7\nFirefox 1.5.0.9: 1.8.0.9 <-- Reports 1.8\nFirefox 2.0.0.3: 1.8.1.3 <-- Reports 1.8\nFirefox 3 alpha: 1.9a4 <-- Reports 1.9\n<\/pre>", "guessedname": "gecko", "guessedtype": "property"}, "ie": {"type": "float", "description": "Internet Explorer version number or 0. Example: 6", "guessedname": "ie", "guessedtype": "property"}, "webkit": {"type": "float", "description": "AppleWebKit version. KHTML browsers that are not WebKit browsers \nwill evaluate to 1, other browsers 0. Example: 418.9.1\n<pre>\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\n<\/pre>\nhttp:\/\/developer.apple.com\/internet\/safari\/uamatrix.html", "guessedname": "webkit", "guessedtype": "property"}, "mobile": {"type": "string", "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"}}, "description": "Browser\/platform detection"}, "YUI": {"global": "", "methods": {"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"}, "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"}, "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.", "param": "o {Object} The object to dump", "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. Trying to account for it is hanging FireFox.\nCould be a FireBug interaction."}, "mix": {"return": {"type": "", "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.", "static": "", "guessedname": "mix", "guessedtype": "function", "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"}], "todo": "add constants for the modes"}, "applyTo": {"return": {"type": "", "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"}, "_init": {"guessedname": "_init", "params": [{"type": "", "name": "o", "description": " config options"}], "description": "Initialize this YUI instance", "private": "", "guessedtype": "function"}, "_setup": {"private": "", "description": "Finishes the instance setup. Attaches whatever modules were defined\nwhen the yui modules was registered.", "guessedname": "_setup", "guessedtype": "function"}, "merge": {"return": {"type": "", "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"}, "add": {"return": {"type": "YUI", "description": "the YUI instance\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"}, "params": [{"type": "string", "name": "name", "description": " module name"}, {"type": "string", "name": "namespace", "description": " name space for the module"}, {"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"}], "description": "Register a module", "guessedname": "add", "guessedtype": "function"}, "fail": {"return": {"type": "YUI", "description": "this YUI instance"}, "params": [{"type": "string", "name": "msg", "description": " the failure 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": "fail", "guessedtype": "function"}, "namespace": {"return": {"type": "Object", "description": "A reference to the last namespace object created"}, "description": "Returns the namespace specified and creates it if it doesn't exist\n<pre>\nYUI.namespace(\"property.package\");\nYUI.namespace(\"YUI.property.package\");\n<\/pre>\nEither of the above would create YUI.property, then\nYUI.property.package\nBe careful when naming packages. Reserved words may work in some browsers\nand not others. For instance, the following will fail in Safari:\n<pre>\nYUI.namespace(\"really.long.nested.namespace\");\n<\/pre>\nThis fails because \"long\" is a future reserved word in ECMAScript", "static": "", "guessedname": "namespace", "guessedtype": "function", "params": [{"type": "String*", "name": "arguments", "description": " 1-n namespaces to create"}]}, "substitute": {"return": {"type": "String", "description": "the substituted string"}, "params": [{"type": "String", "name": "s", "description": " The string that will be modified."}, {"type": "Object", "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 'i18n' module. It is not included\nin the YUI module.", "guessedname": "substitute", "guessedtype": "function"}, "stamp": {"return": {"type": "string", "description": "The object's guid"}, "params": [{"type": "", "name": "o", "description": " The object to stamp"}], "description": "Stamps an object with a guid. If the object already\nhas one, a new one is not created", "guessedname": "stamp", "guessedtype": "function"}}, "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.", "constructors": [{"params": [{"type": "", "name": "o", "description": " Optional configuration object. Options:\n<dl>\n<dt>debug<\/dt>\n<dd>Turn debug statements on or off<\/dd>\n<dt>useConsole<\/dt>\n<dd>Log to the browser console if debug is on and the console is available<\/dd>\n<dt>logInclude<\/dt>\n<dd>A list of log sources that should be logged. If specified, only log messages from these sources will be logged.<\/dd>\n<dt>logExclude<\/dt>\n<dd>A list of log sources that should be not be logged. If specified, all sources are logged if not on this list.<\/dd>\n<dt>throwFail<\/dt>\n<dd>If throwFail is set, Y.fail will generate or re-throw a JS error. Otherwise the failure is logged.\n<dt>win<\/dt>\n<dd>The target window\/frame<\/dd>\n<dt>core<\/dt>\n<dd>A list of modules that defines the YUI core (overrides the default)<\/dd>\n<dt>-----<\/dt><dd>-------------------------------------------------------------------<\/dd>\n<dt>For event and get:<\/dt>\n<dd>-------------------------------------------------------------------<\/dd>\n<dt>pollInterval<\/dt>\n<dd>The default poll interval<\/dd>\n<dt>-----<\/dt><dd>-------------------------------------------------------------------<\/dd>\n<dt>For loader<\/dt>\n<dd>-------------------------------------------------------------------<\/dd>\n<dt>base<\/dt>\n<dd>The base dir<\/dd>\n<dt>secureBase<\/dt>\n<dd>The secure base dir (not implemented)<\/dd>\n<dt>comboBase<\/dt>\n<dd>The YUI combo service base dir. Ex: http:\/\/yui.yahooapis.com\/combo?<\/dd>\n<dt>root<\/dt>\n<dd>The root path to prepend to module names for the combo service. Ex: 2.5.2\/build\/<\/dd>\n<dt>filter<\/dt>\n<dd>\nA 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<dl>\n<dt>DEBUG<\/dt>\n<dd>Selects the debug versions of the library (e.g., event-debug.js).\nThis option will automatically include the logger widget<\/dd>\n<dt>RAW<\/dt>\n<dd>Selects the non-minified version of the library (e.g., event.js).<\/dd>\n<\/dl>\nYou can also define a custom filter, which must be an object literal \ncontaining a search expression and a replace string:\n<pre>\nmyFilter: &#123; \n'searchExp': \"-min\\\\.js\", \n'replaceStr': \"-debug.js\"\n&#125;\n<\/pre>\n<\/dd>\n<dt>combine<\/dt>\n<dd>Use the YUI combo service to reduce the number of http connections required to load your dependencies<\/dd>\n<dt>ignore<\/dt>\n<dd>A list of modules that should never be dynamically loaded<\/dd>\n<dt>force<\/dt>\n<dd>A list of modules that should always be loaded when required, even if already present on the page<\/dd>\n<dt>insertBefore<\/dt>\n<dd>Node or id for a node that should be used as the insertion point for new nodes<\/dd>\n<dt>charset<\/dt>\n<dd>charset for dynamic nodes<\/dd>\n<dt>timeout<\/dt>\n<dd>number of milliseconds before a timeout occurs when dynamically loading nodes. in not set, there is no timeout<\/dd>\n<dt>context<\/dt>\n<dd>execution context for all callbacks<\/dd>\n<dt>onSuccess<\/dt>\n<dd>callback to subscribe to the 'success' event<\/dd>\n<dt>onFailure<\/dt>\n<dd>callback to subscribe to the 'failure' event<\/dd>\n<dt>onTimeout<\/dt>\n<dd>callback to subscribe to the 'timeout' event<\/dd>\n<dt>-----<\/dt><dd>-------------------------------------------------------------------<\/dd>\n<\/dl>"}], "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", "uses": ["Event.Target"], "file": "yui.js", "shortname": "YUI", "properties": {"_iefix": {"description": "IE will not enumerate native functions in a derived object even if the\nfunction was overridden. This is a workaround for specific functions \nwe care about on the Object prototype.", "param": "{Function} r the object to receive the augmentation", "static": "", "private": "", "guessedname": "_iefix", "guessedtype": "property"}}, "name": "YUI"}, "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"}, "_q": {"description": "Array of transactions queued for processing", "private": "", "static": "", "guessedname": "_q", "guessedtype": "property", "type": "array"}, "_qMaxSize": {"description": "Queue property to set a maximum queue storage size. When\nthis property is set, the queue will not store any more transactions\nuntil the queue size os reduced below this threshold. There is no\nmaximum queue size until it is explicitly set.", "private": "", "static": "", "guessedname": "_qMaxSize", "guessedtype": "property", "type": "int"}, "_xdr": {"description": "Map of transports created for cross-domain requests.", "private": "", "static": "", "guessedname": "_xdr", "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,", "private": "", "static": "", "guessedname": "_fn", "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": ""}, "_create": {"return": {"type": "", "description": "object"}, "static": "", "params": [{"type": "number", "name": "s", "description": " - URI or root data."}, {"type": "number", "name": "c", "description": " - configuration object"}], "description": "Method that creates a unique transaction object for each\nrequest..", "private": ""}, "purge": {"return": {"type": "", "description": "void"}, "description": "Method for removing a specific, pending transaction from\nthe queue. This is the interface for _purge().", "static": "", "guessedname": "purge", "guessedtype": "property", "params": [{"type": "number", "name": "i", "description": " - ID of queued transaction."}], "public": ""}, "_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": ""}, "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"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "object", "name": "c", "description": " - Configuration object passed to YUI.io()."}], "description": "Starts timeout count if config,timeout is defined.", "private": ""}, "_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": ""}, "_size": {"static": "", "return": {"type": "", "description": "int"}, "description": "Method to query the current size of the queue, or to\nset a maximum queue size.", "private": ""}, "_start": {"static": "", "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.", "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": ""}, "queue": {"return": {"type": "", "description": "int"}, "description": "Method for requesting a transaction, and queueing the\nrequest before it is sent to the resource. This is the\ninterface for _queue().", "static": "", "guessedname": "queue", "guessedtype": "property", "params": [{"type": "string", "name": "uri", "description": " - qualified path to transaction resource."}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "public": ""}, "_async": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - Transaction object generated by _create()."}, {"type": "string", "name": "d", "description": " - Transaction data."}, {"type": "object", "name": "c", "description": " - Configuration object passed to YUI.io()."}], "description": "Method that sends the transaction request.", "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"}, "static": "", "params": [{"type": "number", "name": "id", "description": " - Transaction id."}], "description": "Clears the timeout interval started by _startTimeout().", "private": ""}, "transport": {"return": {"type": "", "description": "boolean"}, "description": "Method for specifying and initializing a transport\nto facilitate cross-domain HTTP requests. This is the\ninterface for _initTransport", "static": "", "guessedname": "transport", "guessedtype": "property", "params": [{"type": "object", "name": "t", "description": " - configuration object for the transport."}], "public": ""}, "_serialize": {"return": {"type": "", "description": "string"}, "static": "", "params": [{"type": "object", "name": "c", "description": " - Configuration object specific to form operations.."}], "description": "Method to enumerate through an HTML form's elements collection\nand return a string comprised of key-value pairs.", "private": ""}, "_tPubSub": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "string", "name": "e", "description": " - event to be published"}, {"type": "object", "name": "c", "description": " - configuration object for the transaction."}], "description": "Method for creating and subscribing transaction events.", "private": ""}, "_purge": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method for removing a specific, pending transaction from\nthe queue.", "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 set to \"active\". This is the\ninterface for _stop().", "static": "", "guessedname": "stop", "guessedtype": "property", "public": ""}, "_shift": {"static": "", "return": {"type": "", "description": "void"}, "description": "Method for removing a transaction from the top of the\nqueue, and sending the transaction to _io().", "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": " - string representation of YUI instance."}], "description": "Method that creates the Flash transport swf.", "private": ""}, "_ioComplete": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "id", "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": ""}, "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": "number", "name": "i", "description": " - ID of queued transaction."}], "public": ""}, "_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": "int"}, "description": "Method for requesting a transaction, and queueing the\nrequest before it is sent to the resource.", "private": ""}, "_initTransport": {"return": {"type": "", "description": "void"}, "static": "", "params": [{"type": "object", "name": "o", "description": " - object of transport configurations."}], "description": "Method to initialize the desired transport medium.", "private": ""}, "_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."}], "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 beyond.\nabort - This even is fired when a transaction abort is fire by\ntimeout, or when it is manually aborted.\nThe properties are:\n{\nstart: function(id, args){},\ncomplete: function(id, responseobject, args){},\nsuccess: function(id, responseobject, args){},\nfailure: function(id, responseobject, args){},\nabort: 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": ""}, "_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 YUI.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": ""}, "_id": {"static": "", "return": {"type": "", "description": "int"}, "description": "Method that increments _transactionId for each transaction.", "private": ""}, "_ioAbort": {"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": "Fires event \"io:abort\" and creates, fires a\ntransaction-specific \"abort\" event, if config.on.abort is\ndefined.", "private": ""}}, "file": "io.js", "shortname": "io", "events": {"io:abort": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is aborted\nexplicitly or by a defined config.timeout.", "guessedname": "E_ABORT", "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 and\nall response data are available.", "guessedname": "E_COMPLETE", "guessedtype": "property"}, "io:xdrReady": {"type": "Event Custom", "description": "This event is fired by YUI.io when a transaction is initiated..", "guessedname": "E_XDR_READY", "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: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"}}, "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."}, "Easing": {"name": "Easing", "namespace": "", "module": "anim-easing", "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"}, "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"}]}, "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.js", "guessedtype": "property", "shortname": "Easing", "properties": {"curve": {"description": "Usage:\n<pre>\nvar anim = new Y.Anim({\nnode: '#foo',\nto: {\ncurve: [ [0, 100], [500, 200], [800, 300] ]\n}\n});\nanim.run(); \n<\/pre>", "guessedname": "curve", "guessedtype": "property"}}, "description": "Singleton that determines how an animation proceeds from start to end."}, "Node": {"properties": {"text": {"type": "String", "description": "Normalizes nodeInnerText and textContent."}}, "name": "Node", "namespace": "", "module": "node", "events": {"tHeadChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "tHeadChange", "description": "Fires when the value for the configuration attribute 'tHead' changes."}, "beforeChildrenChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeChildrenChange", "description": "Fires before the value for the configuration attribute 'children' changes. Return false to cancel the attribute change."}, "cellsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "cellsChange", "description": "Fires when the value for the configuration attribute 'cells' changes."}, "beforeDocumentElementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDocumentElementChange", "description": "Fires before the value for the configuration attribute 'documentElement' changes. Return false to cancel the attribute change."}, "offsetParentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "offsetParentChange", "description": "Fires when the value for the configuration attribute 'offsetParent' changes."}, "beforeLastChildChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeLastChildChange", "description": "Fires before the value for the configuration attribute 'lastChild' changes. Return false to cancel the attribute change."}, "beforeBodyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeBodyChange", "description": "Fires before the value for the configuration attribute 'body' changes. Return false to cancel the attribute change."}, "beforeRowsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeRowsChange", "description": "Fires before the value for the configuration attribute 'rows' changes. Return false to cancel the attribute change."}, "beforeTFootChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeTFootChange", "description": "Fires before the value for the configuration attribute 'tFoot' changes. Return false to cancel the attribute change."}, "documentElementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "documentElementChange", "description": "Fires when the value for the configuration attribute 'documentElement' changes."}, "ownerDocumentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "ownerDocumentChange", "description": "Fires when the value for the configuration attribute 'ownerDocument' changes."}, "parentNodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "parentNodeChange", "description": "Fires when the value for the configuration attribute 'parentNode' changes."}, "childrenChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "childrenChange", "description": "Fires when the value for the configuration attribute 'children' changes."}, "beforeTBodiesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeTBodiesChange", "description": "Fires before the value for the configuration attribute 'tBodies' changes. Return false to cancel the attribute change."}, "firstChildChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "firstChildChange", "description": "Fires when the value for the configuration attribute 'firstChild' changes."}, "beforeChildNodesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeChildNodesChange", "description": "Fires before the value for the configuration attribute 'childNodes' changes. Return false to cancel the attribute change."}, "beforeOffsetParentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeOffsetParentChange", "description": "Fires before the value for the configuration attribute 'offsetParent' changes. Return false to cancel the attribute change."}, "beforeFirstChildChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeFirstChildChange", "description": "Fires before the value for the configuration attribute 'firstChild' changes. Return false to cancel the attribute change."}, "tFootChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "tFootChange", "description": "Fires when the value for the configuration attribute 'tFoot' changes."}, "beforeOwnerDocumentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeOwnerDocumentChange", "description": "Fires before the value for the configuration attribute 'ownerDocument' changes. Return false to cancel the attribute change."}, "beforeElementsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeElementsChange", "description": "Fires before the value for the configuration attribute 'elements' changes. Return false to cancel the attribute change."}, "bodyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "bodyChange", "description": "Fires when the value for the configuration attribute 'body' changes."}, "previousSiblingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "previousSiblingChange", "description": "Fires when the value for the configuration attribute 'previousSibling' changes."}, "beforeParentNodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeParentNodeChange", "description": "Fires before the value for the configuration attribute 'parentNode' changes. Return false to cancel the attribute change."}, "childNodesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "childNodesChange", "description": "Fires when the value for the configuration attribute 'childNodes' changes."}, "beforePreviousSiblingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforePreviousSiblingChange", "description": "Fires before the value for the configuration attribute 'previousSibling' changes. Return false to cancel the attribute change."}, "lastChildChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "lastChildChange", "description": "Fires when the value for the configuration attribute 'lastChild' changes."}, "beforeTHeadChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeTHeadChange", "description": "Fires before the value for the configuration attribute 'tHead' changes. Return false to cancel the attribute change."}, "elementsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "elementsChange", "description": "Fires when the value for the configuration attribute 'elements' changes."}, "rowsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "rowsChange", "description": "Fires when the value for the configuration attribute 'rows' changes."}, "tBodiesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "tBodiesChange", "description": "Fires when the value for the configuration attribute 'tBodies' changes."}, "beforeCellsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeCellsChange", "description": "Fires before the value for the configuration attribute 'cells' changes. Return false to cancel the attribute change."}}, "guessedname": "BASE_NODE", "methods": {"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.", "guessedname": "appendChild", "guessedtype": "property"}, "all": {"return": {"type": "NodeList", "description": "A wrapper instance for the supplied nodes."}, "description": "Retrieves a NodeList instance for the given object\/string.", "static": "", "guessedname": "all", "guessedtype": "function", "params": [{"type": "HTMLCollection|Array|String", "name": "node", "description": " The object to wrap."}, {"type": "document|Node", "name": "doc", "description": " optional The document containing the node. Defaults to current document."}]}, "set": {"params": [{"type": "String", "name": "prop", "description": " Property to set"}, {"type": "any", "name": "val", "description": " Value to apply to the given property"}], "description": "Set the value of the property\/attribute on the HTMLElement bound to this Node.\nOnly strings\/numbers\/booleans are passed through unless a SETTER exists.", "guessedname": "set", "guessedtype": "function"}, "getAttribute": {"return": {"type": "String", "description": "The current value of the attribute"}, "params": [{"type": "String", "name": "attribute", "description": " The attribute to retrieve"}], "description": "Passes through to DOM method.", "guessedname": "getAttribute", "guessedtype": "property"}, "focus": {"description": "Passes through to DOM method.", "guessedname": "focus", "guessedtype": "property"}, "cloneNode": {"return": {"type": "Node", "description": "The clone"}, "params": [{"type": "HTMLElement | Node", "name": "node", "description": " Node to be cloned"}], "description": "Passes through to DOM method.", "guessedname": "cloneNode", "guessedtype": "property"}, "setStyle": {"params": [{"type": "String", "name": "attr", "description": " The style attribute to set."}, {"type": "String|Number", "name": "val", "description": " The value."}], "description": "Applies a CSS style to a given node.", "guessedname": "setStyle", "guessedtype": "function"}, "nodeInOut": {"description": "Wraps the input and outputs of a node instance", "guessedname": "nodeInOut", "guessedtype": "function"}, "query": {"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 single node based on the given CSS selector.", "guessedname": "query", "guessedtype": "function"}, "next": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "Function", "name": "fn", "description": " A boolean function used to test siblings\nthat receives the sibling node being tested as its only argument."}, {"type": "Boolean", "name": "all", "description": " optional Whether all node types should be returned, or just element nodes."}], "description": "Returns the next sibling that passes the boolean method. \nReturns the nearest HTMLElement sibling if no method provided.", "guessedname": "next", "guessedtype": "function"}, "queryAll": {"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": "queryAll", "guessedtype": "function"}, "previous": {"return": {"type": "Node", "description": "Node instance or null if not found"}, "params": [{"type": "Function", "name": "fn", "description": " A boolean function used to test siblings\nthat receives the sibling node being tested as its only argument."}, {"type": "Boolean", "name": "all", "description": " optional Whether all node types should be returned, or just element nodes."}], "description": "Returns the previous sibling that is an HTMLElement. \nReturns the nearest HTMLElement sibling if no method provided.", "guessedname": "previous", "guessedtype": "function"}, "create": {"return": {"type": "Node", "description": "A new Node instance"}, "description": "Creates a Node instance from HTML string", "param": "{String | Array} html HTML string", "params": [{"type": "String|Array", "name": "html", "description": " The string of html to create"}], "guessedname": "create", "guessedtype": "function"}, "contains": {"return": {"type": "Boolean", "description": "Whether or not this node is an ancestor of needle"}, "params": [{"type": "String | HTMLElement", "name": "needle", "description": " The possible descendent"}], "description": "Determines whether an HTMLElement is an ancestor of another HTML element in the DOM hierarchy.", "guessedname": "contains", "guessedtype": "function"}, "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": "Retrieves the computed value for the given style attribute.", "guessedname": "getComputedStyle", "guessedtype": "function"}, "submit": {"description": "Passes through to DOM method.\nOnly valid on FORM elements", "guessedname": "submit", "guessedtype": "property"}, "setStyles": {"params": [{"type": "Object", "name": "hash", "description": " An object literal of property:value pairs."}], "description": "Sets multiple style properties.", "guessedname": "setStyles", "guessedtype": "function"}, "attach": {"params": [{"type": "String", "name": "type", "description": " The type of DOM Event to listen for"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}, {"type": "Object", "name": "arg", "description": " An argument object to pass to the handler"}], "description": "Attaches a DOM event handler.", "guessedname": "attach", "guessedtype": "function"}, "getById": {"static": "", "params": [{"type": "String", "name": "id", "description": " The ID to retrieve"}, {"type": "Node|HTMLElement", "name": "doc", "description": " optional An optional document to search. \nDefaults to current document."}], "description": "Returns a node instance wrapping the DOM element with the given ID.", "guessedname": "getById", "guessedtype": "function"}, "hasChildNodes": {"return": {"type": "Boolean", "description": "Whether or not the node has any childNodes"}, "description": "Passes through to DOM method.", "guessedname": "hasChildNodes", "guessedtype": "property"}, "blur": {"description": "Passes through to DOM method.", "guessedname": "blur", "guessedtype": "property"}, "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"}, "inDoc": {"return": {"type": "Boolean", "description": "Whether or not this node is attached to the document."}, "params": [{"type": "Node|HTMLElement", "name": "doc", "description": " optional An optional document to check against.\nDefaults to current document."}], "description": "Determines whether an HTMLElement is attached to a document.", "guessedname": "inDoc", "guessedtype": "function"}, "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.", "guessedname": "insertBefore", "guessedtype": "property"}, "get": {"return": {"type": "any", "description": "Current value of the property"}, "description": "Get the value of the property\/attribute on the HTMLElement bound to this Node.\nOnly strings\/numbers\/booleans are passed through unless a GETTER exists.", "param": "{document|HTMLElement|HTMLCollection|Array|String} node The object to wrap.", "params": [{"type": "String", "name": "prop", "description": " Property to get"}], "guessedname": "get", "guessedtype": "function", "static": ""}, "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.", "guessedname": "getElementsByTagName", "guessedtype": "property"}, "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": "Retrieves a style attribute from the given node.", "guessedname": "getStyle", "guessedtype": "function"}, "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.", "guessedname": "hasAttribute", "guessedtype": "property"}, "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.", "guessedname": "replaceChild", "guessedtype": "property"}, "detach": {"params": [{"type": "String", "name": "type", "description": " The type of DOM Event"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}], "description": "Detaches a DOM event handler.", "guessedname": "detach", "guessedtype": "function"}, "reset": {"description": "Passes through to DOM method.\nOnly valid on FORM elements", "guessedname": "reset", "guessedtype": "property"}, "on": {"see": "attach", "params": [{"type": "String", "name": "type", "description": " The type of DOM Event to listen for"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}, {"type": "Object", "name": "arg", "description": " An argument object to pass to the handler"}], "description": "Alias for attach.", "guessedname": "on", "guessedtype": "function"}, "scrollIntoView": {"description": "Passes through to DOM method.", "guessedname": "scrollIntoView", "guessedtype": "property"}, "setAttribute": {"params": [{"type": "String", "name": "attribute", "description": " The attribute to set"}, {"type": "String", "name": "The", "description": " value to apply to the attribute"}], "description": "Passes through to DOM method.", "guessedname": "setAttribute", "guessedtype": "property"}, "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.", "guessedname": "removeChild", "guessedtype": "property"}, "compareTo": {"return": {"type": "Boolean", "description": "True if the nodes match, false if they do not."}, "params": [{"type": "String | 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\/selectors.", "guessedname": "compareTo", "guessedtype": "function"}}, "file": "node.js", "guessedtype": "property", "shortname": "Node", "configs": {"body": {"type": "Node", "description": "Returns a Node instance."}, "childNodes": {"type": "NodeList", "description": "Returns a NodeList instance."}, "offsetParent": {"type": "Node", "description": "Returns a Node instance."}, "documentElement": {"type": "Node", "description": "Returns a Node instance."}, "tFoot": {"type": "Node", "description": "Returns a Node instance."}, "cells": {"type": "NodeList", "description": "Returns a NodeList instance."}, "ownerDocument": {"type": "Doc", "description": "Returns a Node instance."}, "firstChild": {"type": "Node", "description": "Returns a Node instance."}, "elements": {"type": "NodeList", "description": "Returns a NodeList instance."}, "parentNode": {"type": "Node", "description": "Returns a Node instance."}, "tBodies": {"type": "NodeList", "description": "Returns a NodeList instance."}, "rows": {"type": "NodeList", "description": "Returns a NodeList instance."}, "lastChild": {"type": "Node", "description": "Returns a Node instance."}, "previousSibling": {"type": "Node", "description": "Returns a Node instance."}, "children": {"type": "NodeList", "description": "Returns a NodeList instance."}, "tHead": {"type": "Node", "description": "Returns a Node instance."}}, "description": "A wrapper for DOM Nodes.\nNode properties can be accessed via the set\/get methods.\nWith the exception of the noted properties,\nonly strings, numbers, and booleans are passed through. \nUse Y.get() or Y.Node.get() to retrieve Node instances."}, "Do": {"name": "Do", "namespace": "", "module": "event", "guessedname": "Do", "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": "sid", "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", "namespace": "", "module": "anim", "guessedname": "RUNNING", "file": "anim.js", "guessedtype": "property", "shortname": "Anim", "description": "Handles animation _queueing and threading."}, "Get": {"name": "Get", "namespace": "", "module": "loader", "guessedname": "Get", "methods": {"_purge": {"private": "", "description": "Removes the nodes for the specified queue", "guessedname": "_purge", "guessedtype": "function"}, "_finalize": {"guessedname": "_finalize", "params": [{"type": "string", "name": "id", "description": " the transaction id"}], "description": "Called by the the helper for detecting script load in Safari", "private": "", "guessedtype": "function"}, "_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"}], "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<dl>\n<dt>onSuccess<\/dt>\n<dd>\ncallback to execute when the script(s) are finished loading\nThe callback receives an object back with the following\ndata:\n<dl>\n<dt>win<\/dt>\n<dd>the window the script(s) were inserted into<\/dd>\n<dt>data<\/dt>\n<dd>the data object passed in when the request was made<\/dd>\n<dt>nodes<\/dt>\n<dd>An array containing references to the nodes that were\ninserted<\/dd>\n<dt>purge<\/dt>\n<dd>A function that, when executed, will remove the nodes\nthat were inserted<\/dd>\n<dt>\n<\/dl>\n<\/dd>\n<dt>onTimeout<\/dt>\n<dd>\ncallback to execute when a timeout occurs.\nThe callback receives an object back with the following\ndata:\n<dl>\n<dt>win<\/dt>\n<dd>the window the script(s) were inserted into<\/dd>\n<dt>data<\/dt>\n<dd>the data object passed in when the request was made<\/dd>\n<dt>nodes<\/dt>\n<dd>An array containing references to the nodes that were\ninserted<\/dd>\n<dt>purge<\/dt>\n<dd>A function that, when executed, will remove the nodes\nthat were inserted<\/dd>\n<dt>\n<\/dl>\n<\/dd>\n<dt>onFailure<\/dt>\n<dd>\ncallback to execute when the script load operation fails\nThe callback receives an object back with the following\ndata:\n<dl>\n<dt>win<\/dt>\n<dd>the window the script(s) were inserted into<\/dd>\n<dt>data<\/dt>\n<dd>the data object passed in when the request was made<\/dd>\n<dt>nodes<\/dt>\n<dd>An array containing references to the nodes that were\ninserted successfully<\/dd>\n<dt>purge<\/dt>\n<dd>A function that, when executed, will remove any nodes\nthat were inserted<\/dd>\n<dt>\n<\/dl>\n<\/dd>\n<dt>context<\/dt>\n<dd>the execution context for the callbacks<\/dd>\n<dt>win<\/dt>\n<dd>a window other than the one the utility occupies<\/dd>\n<dt>autopurge<\/dt>\n<dd>\nsetting to true will let the utilities cleanup routine purge \nthe script once loaded\n<\/dd>\n<dt>data<\/dt>\n<dd>\ndata that is supplied to the callback when the script(s) are\nloaded.\n<\/dd>\n<dt>insertBefore<\/dt>\n<dd>node or node id that will become the new node's nextSibling<\/dd>\n<\/dl>\n<dt>charset<\/dt>\n<dd>Node charset, default utf-8<\/dd>\n<dt>timeout<\/dt>\n<dd>Number of milliseconds to wait before aborting and firing the timeout event<\/dd>\n<pre>\n&nbsp;&nbsp;Y.Get.script(\n&nbsp;&nbsp;[\"http:\/\/yui.yahooapis.com\/2.3.1\/build\/dragdrop\/dragdrop-min.js\",\n&nbsp;&nbsp;&nbsp;\"http:\/\/yui.yahooapis.com\/2.3.1\/build\/animation\/animation-min.js\"], &#123;\n&nbsp;&nbsp;&nbsp;&nbsp;onSuccess: function(o) &#123;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;console.log(o.data); \/\/ foo\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new Y.DDProxy(\"dd1\"); \/\/ also new o.reference(\"dd1\"); would work\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.log(\"won't cause error because Y is the context\");\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.log(o.nodes.length === 2) \/\/ true\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/\/ o.purge(); \/\/ optionally remove the script nodes immediately\n&nbsp;&nbsp;&nbsp;&nbsp;&#125;,\n&nbsp;&nbsp;&nbsp;&nbsp;onFailure: function(o) &#123;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;console.log(\"transaction failed\");\n&nbsp;&nbsp;&nbsp;&nbsp;&#125;,\n&nbsp;&nbsp;&nbsp;&nbsp;data: \"foo\",\n&nbsp;&nbsp;&nbsp;&nbsp;context: Y,\n&nbsp;&nbsp;&nbsp;&nbsp;\/\/ win: otherframe \/\/ target another window\/frame\n&nbsp;&nbsp;&nbsp;&nbsp;autopurge: true \/\/ allow the utility to choose when to remove the nodes\n&nbsp;&nbsp;&#125;);\n<\/pre>"}]}, "_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"}], "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": {"params": [{"type": "string|object", "name": "either", "description": " 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<dl>\n<dt>onSuccess<\/dt>\n<dd>\ncallback to execute when the css file(s) are finished loading\nThe callback receives an object back with the following\ndata:\n<dl>win<\/dl>\n<dd>the window the link nodes(s) were inserted into<\/dd>\n<dt>data<\/dt>\n<dd>the data object passed in when the request was made<\/dd>\n<dt>nodes<\/dt>\n<dd>An array containing references to the nodes that were\ninserted<\/dd>\n<dt>purge<\/dt>\n<dd>A function that, when executed, will remove the nodes\nthat were inserted<\/dd>\n<dt>\n<\/dl>\n<\/dd>\n<dt>context<\/dt>\n<dd>the execution context for the callbacks<\/dd>\n<dt>win<\/dt>\n<dd>a window other than the one the utility occupies<\/dd>\n<dt>data<\/dt>\n<dd>\ndata that is supplied to the callbacks when the nodes(s) are\nloaded.\n<\/dd>\n<dt>insertBefore<\/dt>\n<dd>node or node id that will become the new node's nextSibling<\/dd>\n<dt>charset<\/dt>\n<dd>Node charset, default utf-8<\/dd>\n<\/dl>\n<pre>\nY.Get.css(\"http:\/\/yui.yahooapis.com\/2.3.1\/build\/menu\/assets\/skins\/sam\/menu.css\");\n<\/pre>\n<pre>\nY.Get.css([\"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<\/pre>"}]}}, "static": "", "file": "get.js", "guessedtype": "function", "shortname": "Get", "properties": {"queues": {"private": "", "description": "hash of queues to manage multiple requests", "guessedname": "queues", "guessedtype": "property"}, "nidx": {"guessedname": "nidx", "type": "int", "description": "node index used to generate unique node ids", "private": "", "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.\nproperty PURGE_THRESH", "default": "20", "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"}, "Object": {"name": "Object", "namespace": "", "module": "yui", "methods": {"keys": {"return": {"type": "string[]", "description": "the keys"}, "params": [{"type": "", "name": "o", "description": " an object"}], "description": "Returns an array containing the object's keys", "guessedname": "keys", "guessedtype": "function"}, "each": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "", "name": "o", "description": " the object to iterate"}, {"type": "function", "name": "f", "description": " the function to execute"}, {"type": "", "name": "c", "description": " the execution context"}, {"type": "boolean", "name": "proto", "description": " include proto"}], "description": "Executes a function on each item. The function\nreceives the value, the key, and the object\nas paramters (in that order).", "guessedname": "each", "guessedtype": "function"}, "Object": {"return": {"type": "", "description": "the new object"}, "params": [{"type": "", "name": "The", "description": " supplier object"}], "description": "Returns a new object based upon the supplied object. By\ndefault the new object's prototype will have all members\non the object.tructor prototype.", "guessedname": "Object", "guessedtype": "function"}, "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.", "parma": "p {string} the property to look for", "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "guessedname": "owns", "guessedtype": "function", "todo": "Remove in PR2"}}, "file": "yui-object.js", "shortname": "Object", "description": "Object utils"}, "JSON": {"name": "JSON", "namespace": "", "module": "json", "guessedname": "JSON", "methods": {"parse": {"return": {"type": "MIXED", "description": "the native JavaScript representation of the JSON string"}, "description": "Parse a JSON string, returning the native JavaScript representation.", "throws": "SyntaxError", "static": "", "guessedname": "parse", "guessedtype": "function", "params": [{"type": "string", "name": "s", "description": " JSON string data"}, {"type": "function", "name": "reviver", "description": " (optional) function(k,v) passed each key value pair of object literals, allowing pruning or altering values"}], "public": ""}, "stringify": {"return": {"type": "string", "description": "JSON string representation of the input"}, "description": "Converts an arbitrary value to a JSON string representation.\nCyclical object or array references are replaced with null.\nIf a whitelist is provided, only matching object keys will be included.\nIf a depth limit is provided, objects and arrays at that depth will\nbe stringified as empty.", "static": "", "guessedname": "stringify", "guessedtype": "function", "params": [{"type": "MIXED", "name": "o", "description": " any arbitrary object to convert to JSON string"}, {"type": "Array", "name": "w", "description": " (optional) whitelist of acceptable object keys to include"}, {"type": "number", "name": "d", "description": " (optional) depth limit to recurse objects\/arrays (practical minimum 1)"}], "public": ""}, "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": "", "static": "", "guessedname": "_revive", "guessedtype": "function", "params": [{"type": "MIXED", "name": "data", "description": " Any JavaScript data"}, {"type": "Function", "name": "reviver", "description": " filter or mutation function"}]}}, "static": "", "file": "Stringify.js", "guessedtype": "property", "shortname": "JSON", "properties": {"_INVALID": {"description": "Final step in the validation. Regex used to test the string left after\nall previous replacements for invalid characters.", "private": "", "static": "", "guessedname": "_INVALID", "guessedtype": "property", "type": "{RegExp}"}, "_BRACKETS": {"description": "Third step in the validation. Regex used to remove all open square\nbrackets following a colon, comma, or at the beginning of the string.", "private": "", "static": "", "guessedname": "_BRACKETS", "guessedtype": "property", "type": "{RegExp}"}, "_SPECIAL_CHARS": {"description": "Regex used to replace special characters in strings for JSON\nstringification.", "private": "", "static": "", "guessedname": "_SPECIAL_CHARS", "guessedtype": "property", "type": "{RegExp}"}, "_CHARS": {"description": "Character substitution map for common escapes and special characters.", "private": "", "static": "", "guessedname": "_CHARS", "guessedtype": "property", "type": "{Object}"}, "_ESCAPES": {"description": "First step in the validation. Regex used to replace all escape\nsequences (i.e. \"\\\\\", etc) with '@' characters (a non-JSON character).", "private": "", "static": "", "guessedname": "_ESCAPES", "guessedtype": "property", "type": "{RegExp}"}, "_VALUES": {"description": "Second step in the validation. Regex used to replace all simple\nvalues with ']' characters.", "private": "", "static": "", "guessedname": "_VALUES", "guessedtype": "property", "type": "{RegExp}"}}, "description": "Provides Y.JSON.parse method to take JSON strings and return native\nJavaScript objects."}, "Base": {"name": "Base", "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": "intialized", "guessedtype": "property", "type": "boolean"}}, "constructors": [{"params": [{"type": "Object", "name": "config", "description": " Object literal of configuration property name\/value pairs"}], "description": "Provides a base class for managed attribute based\nobjects, which automates chaining of init and destroy\nlifecycle methods and automatic instantiation of\nregistered Attributes, through the static ATTRS property"}], "namespace": "", "module": "base", "events": {"initializedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "initializedChange", "description": "Fires when the value for the configuration attribute 'initialized' changes."}, "beforeInitializedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeInitializedChange", "description": "Fires before the value for the configuration attribute 'initialized' changes. Return false to cancel the attribute change."}, "init": {"params": [{"type": "EventFacade", "name": "e", "description": " Event object"}, {"type": "", "name": "config", "description": " Object literal of configuration name\/value pairs"}], "description": "<p>\nInit event, fired prior to initialization. Invoking\nthe preventDefault method on the EventFacade provided \nto subscribers will prevent initialization from occuring.\n<\/p>\n<p>\nSubscribers to the after momemt of this event, will be notified\nafter initialization of the object is complete (and therefore\ncannot prevent initialization).\n<\/p>"}, "beforeDestroyedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDestroyedChange", "description": "Fires before the value for the configuration attribute 'destroyed' changes. Return false to cancel the attribute change."}, "destroy": {"params": [{"type": "EventFacade", "name": "e", "description": " Event object"}], "description": "<p>\nDestroy event, fired prior to destruction. Invoking\nthe preventDefault method on the EventFacade provided \nto subscribers will prevent destruction from proceeding.\n<\/p>\n<p>\nSubscribers to the after momemt of this event, will be notified\nafter destruction is complete (and as a result cannot prevent\ndestruction).\n<\/p>"}, "destroyedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "destroyedChange", "description": "Fires when the value for the configuration attribute 'destroyed' changes."}}, "guessedname": "Base", "methods": {"_prefixEvtType": {"guessedname": "_prefixEvtType", "params": [{"type": "String", "name": "type", "description": " The event name"}], "description": "Utility method to prefix the event name with the\nname property of the instance, if absent", "private": "", "guessedtype": "function"}, "toString": {"description": "Default toString implementation", "guessedname": "toString", "guessedtype": "function"}, "_defInitFn": {"protected": "", "description": "Default init event handler", "guessedname": "_defInitFn", "guessedtype": "function"}, "subscribe": {"return": {"type": "Event.Handle", "description": "unsubscribe handle"}, "params": [{"type": "String", "name": "type", "description": " The type of event to subscribe to. If \nthe type string does not contain a prefix (\"prefix:eventType\"), \nthe name property of the instance will be used as the default prefix."}, {"type": "Function", "name": "fn", "description": " The callback, invoked when the event is fired."}, {"type": "Object", "name": "context", "description": " The execution context"}, {"type": "Object*", "name": "args*", "description": " 1..n params to supply to the callback"}], "description": "<p>\nSubscribe to a custom event hosted by this object.\n<\/p>\n<p>\nOverrides Event.Target's subscribe method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "guessedname": "subscribe", "guessedtype": "function"}, "fire": {"return": {"type": "boolean", "description": "the return value from Event.Target.fire"}, "params": [{"type": "String|Object", "name": "type", "description": " The type of the event, or an object that contains\na 'type' property. If the type does not contain a prefix (\"prefix:eventType\"),\nthe name property of the instance will be used as the default prefix."}, {"type": "Object*", "name": "arguments", "description": " an arbitrary set of parameters to pass to \nthe handler."}], "description": "<p>\nFire 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.\n<\/p>\n<p>\nOverrides Event.Target's fire method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "guessedname": "fire", "guessedtype": "function"}, "create": {"static": "", "params": [{"type": "Function", "name": "main", "description": ""}, {"type": "Array", "name": "extensions", "description": ""}, {"type": "Any*", "name": "args", "description": ""}], "guessedname": "create", "guessedtype": "function"}, "after": {"params": [{"type": "String", "name": "type", "description": " The type of event to subscribe to. If \nthe type string does not contain a prefix (\"prefix:eventType\"), \nthe name property of the instance will be used as the default prefix."}, {"type": "Function", "name": "fn", "description": " The callback"}, {"type": "Object", "name": "context", "description": " The execution context"}, {"type": "Object*", "name": "args*", "description": " 1..n params to supply to the callback"}], "description": "<p>\nSubscribe to a custom event hosted by this object. The\nsupplied callback will execute <em>after<\/em> any listeners added\nvia the subscribe method, and after the default function,\nif configured for the event, has executed.\n<\/p>\n<p>\nOverrides Event.Target's after method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "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. If the type does not \ncontain a prefix (\"prefix:eventType\"), the name property of the instance will \nbe used as the default prefix."}, {"type": "Object", "name": "opts", "description": " Optional config params (see Event.Target publish for details)"}], "description": "<p>\nCreates 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. \n<\/p>\n<p>\nOverrides Event.Target's publish method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "guessedname": "publish", "guessedtype": "function"}, "_destroyHierarchy": {"private": "", "description": "Destroys the class hierarchy rooted at this base class by invoking\nthe descructor method on the prototype of each class in the hierarchy.", "guessedname": "_destroyHierarchy", "guessedtype": "function"}, "init": {"final": "", "params": [{"type": "Object", "name": "config", "description": " Object literal of configuration property name\/value pairs"}], "description": "Init lifecycle method, invoked during construction.\nFires the init event prior to invoking initializers on\nthe class hierarchy.", "guessedname": "init", "guessedtype": "function"}, "_defDestroyFn": {"protected": "", "description": "Default destroy event handler", "guessedname": "_defDestroyFn", "guessedtype": "function"}, "_getClasses": {"protected": "", "return": {"type": "Array", "description": "array of classes"}, "description": "Returns the top down class heirarchy for this object,\nwith Base being the first class in the array", "guessedname": "_getClasses", "guessedtype": "function"}, "build": {"static": "", "params": [{"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": ""}], "description": "<p>\nBuilds a constructor function (class) from the\nmain function, and array of extension functions\nprovided.\n<\/p>\n<p>\nThe cfg object literal supports the following properties\n<\/p>\n<dl>\n<dt>dynamic {boolean}<\/dt>\n<dd>\n<p>If true, a completely new class\nis created which extends the main class, and acts as the \nhost on which the extension classes are augmented.<\/p>\n<p>If false, the extensions classes are augmented directly to\nthe main class, modifying the main class.<\/p>\n<\/dd>\n<dt>aggregates {String[]}<\/dt>\n<dd>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 - \"ATTRS\" and \"PLUGINS\", as defined by \nBase.build.AGGREGATES<\/dd>\n<\/dl>", "guessedname": "build", "guessedtype": "function"}, "unsubscribe": {"return": {"type": "boolean", "description": "true if the subscriber was found and detached."}, "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. If \nthe type string does not contain a prefix \n(\"prefix:eventType\"), the name property of the \ninstance will be used as the default prefix."}, {"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": "<p>\nUnsubscribes one or more listeners the from the specified event.\n<\/p>\n<p>\nOverrides Event.Target's unsubscribe method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "guessedname": "unsubscribe", "guessedtype": "function"}, "destroy": {"description": "<p>\nDestroy lifecycle method. Fires the destroy\nevent, prior to invoking destructors for the\nclass heirarchy.\n<\/p>\n<p>\nSubscribers to the destroy\nevent can preventDefault to prevent destruction\nfrom proceeding.\n<\/p>", "final": "", "guessedname": "destroy", "guessedtype": "function"}, "_initHierarchy": {"guessedname": "_initHierarchy", "params": [{"type": "Object", "name": "userConf", "description": " Config hash containing attribute name\/value pairs"}], "description": "Initializes the class hierarchy rooted at this base class,\nwhich includes initializing attributes for each class defined \nin the class's static ATTRS property and invoking the initializer \nmethod on the prototype of each class in the hierarchy.", "private": "", "guessedtype": "function"}, "unsubscribeAll": {"params": [{"type": "String", "name": "type", "description": " The type, or name of the event. If \nthe type string does not contain a prefix (\"prefix:eventType\"), \nthe name property of the instance will be used as the default prefix."}], "description": "<p>\nRemoves all listeners from the specified event. If the event type\nis not specified, all listeners from all hosted custom events will\nbe removed.\n<\/p>\n<p>\nOverrides Event.Target's unsubscribeAll method, to add the name prefix \nof the instance to the event type, if absent.\n<\/p>", "guessedname": "unsubscribeAll", "guessedtype": "function"}}, "uses": ["Attribute"], "file": "Base.js", "guessedtype": "function", "shortname": "Base", "properties": {"NAME": {"type": "String", "static": "", "description": "Name string to be used to identify instances of \nthis class, for example in prefixing events.\nClasses extending Base, should define their own\nstatic NAME property.", "guessedname": "NAME", "guessedtype": "property"}, "name": {"type": "String", "description": "The name string to be used to identify \nthis instance of object.", "guessedname": "name", "guessedtype": "property"}, "ATTRS": {"type": "Object", "static": "", "description": "Object literal defining the set of attributes which\nwill be available for instances of this class, and \nhow they are configured. See Attributes addAtt method\nfor a description of configuration options available \nfor each attribute.", "guessedname": "ATTRS", "guessedtype": "property"}}, "description": "Provides a base class for managed attribute based\nobjects, which automates chaining of init and destroy\nlifecycle methods and automatic instantiation of\nregistered Attributes, through the static ATTRS property"}, "Event.Target": {"name": "Event.Target", "namespace": "", "module": "event", "guessedname": "EventTarget", "methods": {"on": {"return": {"type": "Event.Handle", "description": "a handle object for \nunsubscribing to this event."}, "params": [{"type": "string", "name": "type", "description": " the event type"}, {"type": "Function", "name": "f", "description": " the function to execute"}, {"type": "", "name": "o", "description": " the Event.Target or element to attach to"}, {"type": "", "name": "context", "description": " Optional execution context"}, {"type": "", "name": "args*", "description": " 0..n additional arguments to append\nto the signature provided when the event fires."}], "description": "Attach an event listener, either to a DOM object\nor to an Event.Target.", "guessedname": "on", "guessedtype": "function"}, "detach": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "", "name": "type", "description": " the type of event, or a Event.Handle to\nfor the subscription. If the Event.Handle is passed\nin, the other parameters are not used."}, {"type": "Function", "name": "f", "description": " the subscribed function"}, {"type": "", "name": "o", "description": " the object or element the listener is subscribed\nto."}], "description": "Detach an event listener (either a custom event or a\nDOM event", "guessedname": "detach", "guessedtype": "function"}, "getEvent": {"return": {"type": "Event.Target", "description": "the custom event or a falsy value"}, "params": [{"type": "string", "name": "type", "description": " the type, or name of the event"}], "description": "Returns the custom event of the provided type has been created, a\nfalsy value otherwise", "guessedname": "getEvent", "guessedtype": "function"}, "removeTarget": {"params": [{"type": "Event.Target", "name": "o", "description": " the target to remove"}], "description": "Removes a bubble target", "guessedname": "removeTarget", "guessedtype": "function"}, "fire": {"return": {"type": "boolean", "description": "the return value from Event.Custom.fire"}, "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."}], "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.", "guessedname": "fire", "guessedtype": "function"}, "unsubscribeAll": {"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": "unsubscribe handle", "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.", "params": [{"type": "string", "name": "type", "description": " The type of the event"}, {"type": "Function", "name": "fn", "description": " The callback"}, {"type": "", "name": "context", "description": " The execution context"}, {"type": "", "name": "args*", "description": " 1..n params to supply to the callback"}], "guessedname": "after", "guessedtype": "function", "todo": "add event\nFor DOM and custom events:\ntype, callback, context, 1-n arguments\nFor methods:\ncallback, object (method host), methodName, context, 1-n arguments"}, "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<ul>\n<li>\n'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)\n<\/li>\n<li>\n'bubbles': whether or not this event bubbles (true)\n<\/li>\n<li>\n'context': the default execution context for the listeners (this)\n<\/li>\n<li>\n'defaultFn': the default function to execute when this event fires if preventDefault was not called\n<\/li>\n<li>\n'emitFacade': whether or not this event emits a facade (false)\n<\/li>\n<li>\n'fireOnce': if an event is configured to fire once, new subscribers after\nthe fire will be notified immediately.\n<\/li>\n<li>\n'preventable': whether or not preventDefault() has an effect (true)\n<\/li>\n<li>\n'preventedFn': a function that is executed when preventDefault is called\n<\/li>\n<li>\n'queuable': whether or not this event can be queued during bubbling (false)\n<\/li>\n<li>\n'silent': if silent is true, debug messages are not provided for this event.\n<\/li>\n<li>\n'stoppedFn': a function that is executed when stopPropagation is called\n<\/li>\n<li>\n'type': the event type (valid option if not provided as the first parameter to publish)\n<\/li>\n<\/ul>"}], "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"}, "subscribe": {"params": [{"type": "string", "name": "type", "description": " The type of the event"}, {"type": "Function", "name": "fn", "description": " The callback"}, {"type": "", "name": "context", "description": " The execution context"}, {"type": "", "name": "args*", "description": " 1..n params to supply to the callback"}], "description": "Subscribe to a custom event hosted by this object", "guessedname": "subscribe", "guessedtype": "function"}, "unsubscribe": {"return": {"type": "boolean", "description": "true if the subscriber was found and detached."}, "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": "Unsubscribes one or more listeners the from the specified event", "guessedname": "unsubscribe", "guessedtype": "function"}, "ready": {"return": {"type": "YUI", "description": "the YUI instance"}, "params": [{"type": "Function", "name": "f", "description": " the function to execute"}, {"type": "", "name": "c", "description": " Optional execution context"}, {"type": "", "name": "args*", "description": " 0..n Additional arguments to append \nto the signature provided when the event fires."}], "description": "Subscribes to the yui:load event, which fires when a Y.use operation\nis complete."}, "addTarget": {"params": [{"type": "Event.Target", "name": "o", "description": " the target to add"}], "description": "Registers another Event.Target as a bubble target. Bubble order\nis determined by the order registered. Multiple targets can\nbe specified.", "guessedname": "addTarget", "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", "guessedname": "bubble", "guessedtype": "function"}, "before": {"return": {"type": "", "description": "unsubscribe 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.\nFor DOM and custom events:\ntype, callback, context, 1-n arguments\nFor methods:\ncallback, object (method host), methodName, context, 1-n arguments", "guessedname": "before", "guessedtype": "function"}}, "file": "event-target.js", "guessedtype": "function", "shortname": "Event.Target", "description": "Event.Target is designed to be used with Y.augment to wrap \nEvent.Custom in an interface that allows events to be subscribed 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."}, "Lang": {"name": "Lang", "namespace": "", "module": "yui", "guessedname": "Lang", "methods": {"isArray": {"return": {"type": "", "description": "Boolean"}, "description": "Determines whether or not the provided object is an array.\nTesting typeof\/instanceof\/constructor of arrays across frame \nboundaries isn't possible in Safari unless you have a reference\nto the other frame to test against its Array prototype. To\nhandle this case, we test well-known array properties instead.\nproperties.", "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "guessedname": "isArray", "guessedtype": "function", "todo": "can we kill this cross frame hack?"}, "trim": {"return": {"type": "string", "description": "the trimmed string"}, "params": [{"type": "string", "name": "s", "description": " the string to trim"}], "description": "Returns a string without any leading or trailing whitespace. If \nthe input is not a string, the input will be returned untouched.", "guessedname": "trim", "guessedtype": "function"}, "isDate": {"return": {"type": "boolean", "description": "true if it is a date"}, "description": "Determines whether or not the supplied object is a date instance", "guessedname": "isDate", "guessedtype": "function"}, "isString": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is a string", "guessedname": "isString", "guessedtype": "function"}, "isBoolean": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is a boolean", "guessedname": "isBoolean", "guessedtype": "function"}, "later": {"return": {"type": "", "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"}, "isNull": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is null", "guessedname": "isNull", "guessedtype": "function"}, "isValue": {"return": {"type": "boolean", "description": "true if it is not null\/undefined\/NaN || false"}, "params": [{"type": "any", "name": "o", "description": " the item to test"}], "description": "A convenience method for detecting a legitimate non-null value.\nReturns false for null\/undefined\/NaN, true for other values, \nincluding 0\/false\/''", "guessedname": "isValue", "guessedtype": "function"}, "log": {"return": {"type": "YUI", "description": "YUI instance"}, "description": "If the 'debug' config is true, a 'yui:log' event will be\ndispatched, which the logger widget and anything else\ncan consume. If the 'useConsole' config is true, it will\nwrite to the browser console if available.", "static": "", "guessedname": "log", "guessedtype": "function", "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)"}]}, "isFunction": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is a function", "guessedname": "isFunction", "guessedtype": "function"}, "isNumber": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is a legal number", "guessedname": "isNumber", "guessedtype": "function"}, "isObject": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}, {"type": "boolean", "name": "failfn", "description": " fail if the input is a function"}], "description": "Determines whether or not the provided object is of type object\nor function", "guessedname": "isObject", "guessedtype": "function"}, "isUndefined": {"return": {"type": "", "description": "Boolean"}, "params": [{"type": "any", "name": "o", "description": " The object being testing"}], "description": "Determines whether or not the provided object is undefined", "guessedname": "isUndefined", "guessedtype": "function"}}, "file": "yui-lang.js", "guessedtype": "property", "shortname": "Lang", "description": "Provides the language utilites and extensions used by the library"}, "DragPlugin": {"name": "DragPlugin", "constructors": [{"description": "This is a simple Drag plugin that can be attached to a Node via the plug method."}], "namespace": "", "module": "dd-plugin", "guessedname": "Plugin", "extends": "Drag", "superclass": "Drag", "file": "dd-plugin.js", "guessedtype": "property", "shortname": "DragPlugin", "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."}, "Do.AlterArgs": {"name": "Do.AlterArgs", "namespace": "", "module": "event", "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."}, "Event.Handle": {"name": "Event.Handle", "constructors": [{"params": [{"type": "Event.Custom", "name": "evt", "description": " the custom event"}, {"type": "Event.Subscriber", "name": "sub", "description": " the subscriber"}], "description": "Return value from all subscribe operations"}], "namespace": "", "module": "event", "guessedname": "EventHandle", "methods": {"detach": {"description": "Detaches this subscriber", "guessedname": "detach", "guessedtype": "function"}}, "file": "event-custom.js", "guessedtype": "function", "shortname": "Event.Handle", "properties": {"evt": {"type": "Event.Custom", "description": "The custom event", "guessedname": "evt", "guessedtype": "property"}, "sub": {"type": "Event.Subscriber", "description": "The subscriber object", "guessedname": "sub", "guessedtype": "property"}}, "description": "Return value from all subscribe operations"}, "Event.Facade": {"file": "event-facade.js", "description": "Wraps a DOM event, properties requiring browser abstraction are\nfixed here. Provids a security layer when required.", "namespace": "", "module": "event", "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": "ev {Event} the DOM event", "guessedname": "Facade", "guessedtype": "function", "shortname": "Event.Facade", "properties": {"pageX": {"type": "int", "description": "The X location of the event on the page (including scroll)", "guessedname": "pageX", "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"}, "time": {"type": "Date", "description": "Timestamp for the event", "guessedname": "time", "guessedtype": "property"}, "currentTarget": {"type": "Node", "propery": "currentTarget", "description": "Node reference for the element that the listener was attached to.", "guessedname": "currentTarget", "guessedtype": "property"}, "details": {"type": "Array", "description": "The event details. Currently supported for Custom\nEvents only, where it contains the arguments that\nwere passed to fire().", "guessedname": "details", "guessedtype": "property"}, "which": {"type": "int", "description": "The button that was pushed. Same as button.", "guessedname": "which", "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": "c", "guessedtype": "property"}, "target": {"type": "Node", "propery": "target", "description": "Node reference for the targeted element", "guessedname": "target", "guessedtype": "property"}}, "name": "Event.Facade"}, "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", "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"}}, "file": "event-do.js", "guessedtype": "function", "shortname": "Do.Method", "description": "Wrapper for a displaced method with aop enabled"}, "Event.Custom": {"name": "Event.Custom", "constructors": [{"params": [{"type": "String", "name": "type", "description": " The type of event, which is passed to the callback\nwhen the event fires"}, {"type": "Object", "name": "context", "description": " The context the event will fire from. \"this\" will\nrefer to this object in the callback. Default value: \nthe window object. The listener can override this."}, {"type": "boolean", "name": "silent", "description": " pass true to prevent the event from writing to\nthe debug system"}], "description": "The Event.Custom class lets you define events for your application\nthat can be subscribed to by one or more independent component."}], "namespace": "", "module": "event", "events": {"subscribeEvent": {"type": "Y.Event.Custom", "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}, {"type": "Object", "name": "obj", "description": " An object to be passed along when the event \nfires"}, {"type": "boolean|Object", "name": "override", "description": " If true, the obj passed in becomes \nthe execution context of the listener.\nif an object, that object becomes the\nthe execution context."}], "description": "Custom events provide a custom event that fires whenever there is\na new subscriber to the event. This provides an opportunity to\nhandle the case where there is a non-repeating event that has\nalready fired has a new subscriber.", "guessedname": "subscribeEvent", "guessedtype": "property"}}, "guessedname": "CustomEvent", "methods": {"after": {"return": {"type": "Event.Handle", "description": "unsubscribe handle"}, "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}, {"type": "Object", "name": "obj", "description": " An object to be passed along when the event fires"}, {"type": "", "name": "args*", "description": " 1..n params to provide to the listener"}], "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"}, "_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<ul>\n<li>The type of event<\/li>\n<li>All of the arguments fire() was executed with as an array<\/li>\n<li>The custom object (if any) that was passed into the subscribe() \nmethod<\/li>\n<\/ul>", "guessedname": "fire", "guessedtype": "function"}, "unsubscribeAll": {"return": {"type": "int", "description": "The number of listeners unsubscribed"}, "description": "Removes all listeners", "guessedname": "unsubscribeAll", "guessedtype": "function"}, "_notify": {"guessedname": "_notify", "params": [{"type": "Event.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"}, "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"}, "preventDefault": {"description": "Prevents the execution of this event's defaultFn", "guessedname": "preventDefault", "guessedtype": "function"}, "subscribe": {"return": {"type": "Event.Handle", "description": "unsubscribe handle"}, "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}, {"type": "Object", "name": "obj", "description": " An object to be passed along when the event fires"}, {"type": "", "name": "args*", "description": " 1..n params to provide to the listener"}], "description": "Listen for this event", "guessedname": "subscribe", "guessedtype": "function"}, "unsubscribe": {"return": {"type": "boolean", "description": "True if the subscriber was found and detached."}, "params": [{"type": "Function", "name": "fn", "description": " The subscribed function to remove, if not supplied\nall will be removed"}, {"type": "Object", "name": "obj", "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": "Unsubscribes subscribers.", "guessedname": "unsubscribe", "guessedtype": "function"}, "stopImmediatePropagation": {"description": "Stops propagation to bubble targets, and prevents any remaining\nsubscribers on the current target from executing.", "guessedname": "stopImmediatePropagation", "guessedtype": "function"}, "toString": {"guessedname": "toString", "guessedtype": "function"}, "stopPropagation": {"description": "Stop propagation to bubble targets", "guessedname": "stopPropagation", "guessedtype": "function"}}, "file": "event-custom.js", "guessedtype": "function", "shortname": "Event.Custom", "properties": {"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.", "guessedname": "defaultFn", "guessedtype": "property"}, "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.", "guessedname": "fireOnce", "guessedtype": "property"}, "prevented": {"type": "int", "description": "Flag for preventDefault that is modified during fire().\nif it is not 0, the default behavior for this event", "guessedname": "prevented", "guessedtype": "property"}, "preventedFn": {"type": "Function", "description": "The function to execute if a subscriber calls\npreventDefault", "guessedname": "preventedFn", "guessedtype": "property"}, "subscribers": {"type": "Event.Subscriber{}", "description": "The subscribers to this event", "guessedname": "subscribers", "guessedtype": "property"}, "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.", "guessedname": "broadcast", "guessedtype": "property"}, "host": {"type": "Event.Target", "description": "Specifies the host for this custom event. This is used\nto enable event bubbling", "guessedname": "host", "guessedtype": "property"}, "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.", "guessedname": "stopped", "guessedtype": "property"}, "context": {"type": "object", "description": "The context the the event will fire from by default. Defaults to the YUI\ninstance.", "guessedname": "context", "guessedtype": "property"}, "preventable": {"default": "true", "type": "boolean", "description": "Specifies whether or not this event's default function\ncan be canceled 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", "guessedname": "stoppedFn", "guessedtype": "property"}, "fired": {"default": "false;", "type": "boolean", "description": "This event has fired if true", "guessedname": "fired", "guessedtype": "property"}, "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": "Event.Subscriber{}", "description": "'After' subscribers", "guessedname": "afters", "guessedtype": "property"}}, "description": "The Event.Custom class lets you define events for your application\nthat can be subscribed to by one or more independent component."}, "Queue": {"name": "Queue", "constructors": [{"params": [{"type": "Function|Object", "name": "callback*", "description": " Any number of callbacks to initialize the queue"}], "description": "Mechanism to execute a series of callbacks in a non-blocking queue. Each\ncallback is executed via setTimout unless configured with a negative\ntimeout, in which case it is run in blocking mode in the same execution\nthread as the previous callback. Callbacks can be function references or\nobject literals with the following keys:\n<ul>\n<li><code>fn<\/code> - {Function} REQUIRED the callback function.<\/li>\n<li><code>timeout<\/code> - {number} millisecond delay to wait after previous callback completion before executing this callback. Negative values cause immediate blocking execution. Default 0.<\/li>\n<li><code>until<\/code> - {Function} boolean function executed before each iteration. Return true to indicate callback completion.<\/li>\n<li><code>iterations<\/code> - {Number} number of times to execute the callback before proceeding to the next callback in the chain. Incompatible with <code>until<\/code>.<\/li>\n<\/ul>"}], "namespace": "", "module": "queue", "events": {"end": {"description": "Event fired when the callback queue is emptied via execution\n(not via a call to chain.stop())."}}, "guessedname": "Queue", "methods": {"pause": {"return": {"type": "Queue", "description": "the Queue instance"}, "description": "Pause the execution of the Queue after the current execution of the\ncurrent callback completes. If called interstitially, clears the\ntimeout for the pending callback. Paused Queue can be restarted with\nchain.run()", "guessedname": "pause", "guessedtype": "function"}, "run": {"return": {"type": "Queue", "description": "the Queue instance"}, "description": "Execute the queue callbacks (also resumes paused Queue).", "guessedname": "run", "guessedtype": "function"}, "stop": {"return": {"type": "Queue", "description": "the Queue instance"}, "description": "Stop and clear the Queue's queue after the current execution of the\ncurrent callback completes.", "guessedname": "stop", "guessedtype": "function"}, "add": {"return": {"type": "Queue", "description": "the Queue instance"}, "params": [{"type": "Function|Object", "name": "c", "description": " * Any number of callbacks"}], "description": "Add any number of callbacks to the end of the queue", "guessedname": "add", "guessedtype": "function"}, "_shift": {"private": "", "description": "Shifts the first callback off the Queue", "guessedname": "_shift", "guessedtype": "function"}, "_exec": {"guessedname": "_exec", "params": [{"type": "Function", "name": "fn", "description": " the function to execute"}, {"type": "Object|Function", "name": "c", "description": " the callback as defined during add(c)"}], "description": "Executes the callback function", "private": "", "guessedtype": "function"}}, "file": "Queue.js", "guessedtype": "function", "shortname": "Queue", "properties": {"q": {"guessedname": "q", "type": "{Array}", "description": "The callback queue", "private": "", "guessedtype": "property"}, "id": {"guessedname": "id", "type": "{number}", "description": "Timeout id used to pause or stop execution and indicate the execution\nstate of the Queue. 0 indicates paused or stopped, negatives indicate\nblocking execution, and positives indicate non-blocking execution.", "private": "", "guessedtype": "property"}}, "description": "Mechanism to execute a series of callbacks in a non-blocking queue. Each\ncallback is executed via setTimout unless configured with a negative\ntimeout, in which case it is run in blocking mode in the same execution\nthread as the previous callback. Callbacks can be function references or\nobject literals with the following keys:\n<ul>\n<li><code>fn<\/code> - {Function} REQUIRED the callback function.<\/li>\n<li><code>timeout<\/code> - {number} millisecond delay to wait after previous callback completion before executing this callback. Negative values cause immediate blocking execution. Default 0.<\/li>\n<li><code>until<\/code> - {Function} boolean function executed before each iteration. Return true to indicate callback completion.<\/li>\n<li><code>iterations<\/code> - {Number} number of times to execute the callback before proceeding to the next callback in the chain. Incompatible with <code>until<\/code>.<\/li>\n<\/ul>"}, "Do.Error": {"name": "Do.Error", "namespace": "", "module": "event", "guessedname": "Error", "file": "event-do.js", "guessedtype": "function", "shortname": "Do.Error", "description": "Return an Error object when you want to terminate the execution\nof all subsequent method calls"}, "Y.Anim": {"name": "Y.Anim", "configs": {"node": {"type": "Node", "description": "The object to be animated.", "guessedname": "node", "guessedtype": "property"}, "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"}, "reversed": {"default": "false", "type": "Boolean", "description": "Whether or not the animation is currently reversed.\nOnly applies when iterations is greater than 1 and direction is \"alternate\"", "guessedname": "reversed", "guessedtype": "property"}, "iterationCount": {"default": "0", "type": "Int", "description": "The number of iterations that have occurred.\nResets when an animation ends (reaches iteration count or stop() called).", "guessedname": "iterationCount", "guessedtype": "property"}, "elapsedTime": {"default": "0", "type": "Int", "description": "Current time the animation has been running.", "guessedname": "elapsedTime", "guessedtype": "property"}, "to": {"type": "Object", "description": "The ending values for the animated properties. \nFields may be strings, numbers, or functions.", "guessedname": "to", "guessedtype": "property"}, "running": {"default": "false", "type": "Boolean", "description": "Whether or not the animation is currently running.", "guessedname": "running", "guessedtype": "property"}, "startTime": {"default": "0", "type": "Int", "description": "Date stamp for the first frame of the animation.", "guessedname": "startTime", "guessedtype": "property"}, "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"}}, "namespace": "", "module": "anim", "events": {"beforeToChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeToChange", "description": "Fires before the value for the configuration attribute 'to' changes. Return false to cancel the attribute change."}, "beforeIterationCountChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeIterationCountChange", "description": "Fires before the value for the configuration attribute 'iterationCount' changes. Return false to cancel the attribute change."}, "fromChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "fromChange", "description": "Fires when the value for the configuration attribute 'from' changes."}, "beforeEasingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeEasingChange", "description": "Fires before the value for the configuration attribute 'easing' changes. Return false to cancel the attribute change."}, "beforeRunningChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeRunningChange", "description": "Fires before the value for the configuration attribute 'running' changes. Return false to cancel the attribute change."}, "easingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "easingChange", "description": "Fires when the value for the configuration attribute 'easing' changes."}, "beforeElapsedTimeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeElapsedTimeChange", "description": "Fires before the value for the configuration attribute 'elapsedTime' changes. Return false to cancel the attribute change."}, "iterationCountChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "iterationCountChange", "description": "Fires when the value for the configuration attribute 'iterationCount' changes."}, "beforeIterationsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeIterationsChange", "description": "Fires before the value for the configuration attribute 'iterations' changes. Return false to cancel the attribute change."}, "startTimeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "startTimeChange", "description": "Fires when the value for the configuration attribute 'startTime' changes."}, "runningChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "runningChange", "description": "Fires when the value for the configuration attribute 'running' changes."}, "beforeReversedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeReversedChange", "description": "Fires before the value for the configuration attribute 'reversed' changes. Return false to cancel the attribute change."}, "durationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "durationChange", "description": "Fires when the value for the configuration attribute 'duration' changes."}, "toChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "toChange", "description": "Fires when the value for the configuration attribute 'to' changes."}, "beforeDurationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDurationChange", "description": "Fires before the value for the configuration attribute 'duration' changes. Return false to cancel the attribute change."}, "nodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "nodeChange", "description": "Fires when the value for the configuration attribute 'node' changes."}, "beforeFromChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeFromChange", "description": "Fires before the value for the configuration attribute 'from' changes. Return false to cancel the attribute change."}, "reversedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "reversedChange", "description": "Fires when the value for the configuration attribute 'reversed' changes."}, "beforeStartTimeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeStartTimeChange", "description": "Fires before the value for the configuration attribute 'startTime' changes. Return false to cancel the attribute change."}, "beforeDirectionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDirectionChange", "description": "Fires before the value for the configuration attribute 'direction' changes. Return false to cancel the attribute change."}, "iterationsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "iterationsChange", "description": "Fires when the value for the configuration attribute 'iterations' changes."}, "directionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "directionChange", "description": "Fires when the value for the configuration attribute 'direction' changes."}, "beforeNodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeNodeChange", "description": "Fires before the value for the configuration attribute 'node' changes. Return false to cancel the attribute change."}, "elapsedTimeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "elapsedTimeChange", "description": "Fires when the value for the configuration attribute 'elapsedTime' changes."}}, "guessedname": "Anim", "methods": {"_runFrame": {"guessedname": "_runFrame", "static": "", "description": "Called per Interval to handle each animation frame.", "private": "", "guessedtype": "function"}, "start": {"static": "", "description": "Starts all animation instances.\nOnly one thread can run at a time.", "guessedname": "run", "guessedtype": "function"}, "run": {"params": [{"type": "NUM|String", "name": "elapsed", "description": " optional Millisecond or\npercent start time marker."}], "description": "Starts or resumes an animation.", "guessedname": "run", "guessedtype": "function"}, "pause": {"static": "", "description": "Pauses all animation instances.", "guessedname": "pause", "guessedtype": "function"}, "stop": {"static": "", "description": "Stops all animation instances.", "guessedname": "stop", "guessedtype": "function"}}, "file": "anim.js", "guessedtype": "function", "shortname": "Y.Anim", "properties": {"behaviors": {"static": "", "description": "Bucket for custom getters and setters", "guessedname": "behaviors", "guessedtype": "property"}, "NAME": {"static": "", "description": "The lowercase name of the class.", "guessedname": "NAME", "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"}, "DEFAULT_SETTER": {"static": "", "description": "The default setter to use when setting object properties.", "guessedname": "DEFAULT_SETTER", "guessedtype": "function"}, "RE_DEFAULT_UNIT": {"static": "", "description": "Regex of properties that should use the default unit.", "guessedname": "RE_DEFAULT_UNIT", "guessedtype": "property"}}, "description": "Provides an API for animating objects.\nUsage:\n<pre>\nvar anim = new Y.Anim({\nnode: '#foo',\nfrom: {\nopacity: 0\n},\nto: {\nheight: 200,\nwidth: function(node) {\nreturn node.get('offsetHeight') \/ 2;\n},\nopacity: 1\n},\neasing: Y.Easing.easeOut\n});\nanim.run(); \n<\/pre>"}, "Attribute": {"name": "Attribute", "namespace": "", "module": "attribute", "methods": {"removeAtt": {"params": [{"type": "String", "name": "name", "description": " The attribute key"}], "description": "Removes an attribute.", "guessedname": "removeAtt", "guessedtype": "function"}, "on": {"description": "Alias for the Event.Target subscribe method.", "guessedname": "on", "guessedtype": "function"}, "_getSubAttVal": {"return": {"type": "Any", "description": "The value stored in the path or undefined if not found."}, "description": "Retrieves the sub value at the provided path,\nfrom the value object provided.", "private": "", "params": [{"type": "Array", "name": "path", "description": " A path array, specifying the object traversal path\nfrom which to obtain the sub value."}, {"type": "Object", "name": "val", "description": " The object from which to extract the property value"}], "guessedname": "_getSubAttVal", "guessedtype": "function"}, "set": {"params": [{"type": "String", "name": "name", "description": " The name of the attribute. Note, if the \nvalue of the attribute is an Object, dot notation can be used\nto set the value of a property within the object \n(e.g. <code>set(\"x.y.z\", 5)<\/code>), if the attribute has not\nbeen declared as an immutable attribute (see Attribute.CLONE)."}, {"type": "Any", "name": "value", "description": " The value to apply to the attribute"}, {"type": "Object", "name": "opts", "description": " Optional event data. This object will be mixed into\nthe event facade passed as the first argument to subscribers \nof attribute change events"}], "description": "Sets the value of an attribute.", "guessedname": "set", "guessedtype": "function"}, "get": {"params": [{"type": "String", "name": "key", "description": " The attribute whose value will be returned. If\nthe value of the attribute is an Object, dot notation can be used to\nobtain the value of a property of the object (e.g. <code>get(\"x.y.z\")<\/code>)"}], "description": "Returns the current value of the attribute. If the attribute\nhas been configured with a 'get' handler, this method will delegate\nto the 'get' handler to obtain the value of the attribute.\nThe 'get' handler will be passed the current value of the attribute \nas the only argument.", "guessedname": "get", "guessedtype": "function"}, "_cloneAttVal": {"description": "Clone utility method, which will \nclone the provided value using YUI's \nmerge, or clone utilities based\non the clone type provided.", "private": "", "see": "Attribute.CLONE", "params": [{"type": "Any", "name": "val", "description": " Value to clone"}, {"type": "int", "name": "type", "description": " Clone type to use, See the CLONE property"}], "guessedname": "_cloneAttVal", "guessedtype": "function"}, "setAtts": {"params": [{"type": "Object", "name": "atts", "description": " A hash of attributes: name\/value pairs"}], "description": "Sets multiple attribute values.", "guessedname": "setAtts", "guessedtype": "function"}, "_defAttSet": {"guessedname": "_defAttSet", "params": [{"type": "EventFacade", "name": "e", "description": " The event object for the custom event"}], "description": "Default handler implementation for set events", "private": "", "guessedtype": "function"}, "_setSubAttVal": {"return": {"type": "Object", "description": "The modified object, with the new sub value set, or \nundefined, if the path was invalid."}, "description": "Sets the sub value at the provided path on the value object.\nReturns the modified value object, or undefined if the path is invalid.", "private": "", "params": [{"type": "Array", "name": "path", "description": " A path array, specifying the object traversal path\nat which to set the sub value."}, {"type": "Object", "name": "val", "description": " The object on which to set the sub value."}, {"type": "Any", "name": "subval", "description": " The sub value to set."}], "guessedname": "_setSubAttVal", "guessedtype": "function"}, "_fireAttChange": {"guessedname": "_fireAttChange", "params": [{"type": "String", "name": "type", "description": " The event name"}, {"type": "Any", "name": "currVal", "description": " The current value of the attribute"}, {"type": "Any", "name": "newVal", "description": " The new value of the attribute"}, {"type": "String", "name": "attrName", "description": " The name of the attribute"}, {"type": "String", "name": "strFullPath", "description": " The full path of the property being changed, \nif this is a sub-attribute value being change"}, {"type": "Function", "name": "defaultFn", "description": " The default handler for the change event"}, {"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 \nfire the attribute change event.", "private": "", "guessedtype": "function"}, "getAtts": {"return": {"type": "Object", "description": "A hash of attributes: name\/value pairs"}, "description": "Gets multiple attribute values.", "guessedname": "getAtts", "guessedtype": "function"}, "addAtt": {"params": [{"type": "String", "name": "name", "description": " The attribute key"}, {"type": "Object", "name": "config", "description": " (optional) An object literal specifying the configuration for the attribute.\n<strong>NOTE:<\/strong> The config object is modified when adding an attribute, \nso if you need to protect the original values, you will need to merge or clone the object."}], "description": "<p>\nAdds an attribute, with the provided configuration to the host object. Intended\nto be used by the host object to setup it's set of available attributes.\n<\/p>\n<p>\nThe config argument object literal supports the following optional properties:\n<\/p>\n<dl>\n<dt>value {Any}<\/dt>\n<dd>The initial value to set on the attribute<\/dd>\n<dt>readOnly {Boolean}<\/dt>\n<dd>Whether or not the attribute is read only. Attributes having readOnly set to true\ncannot be set by invoking the set method.<\/dd>\n<dt>writeOnce {Boolean}<\/dt>\n<dd>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.<\/dd>\n<dt>set {Function}<\/dt>\n<dd>The setter function to be invoked (within the context of the host object) before \nthe attribute is stored by a call to the set method. The value returned by the \nset function will be the finally stored value.<\/dd>\n<dt>get {Function}<\/dt>\n<dd>The getter function to be invoked (within the context of the host object) before\nthe stored values is returned to a user invoking the get method for the attribute.\nThe value returned by the get function is the final value which will be returned to the \nuser when they invoke get.<\/dd>\n<dt>validator {Function}<\/dt>\n<dd>The validator function which is invoked prior to setting the stored value. Returning\nfalse from the validator function will prevent the value from being stored<\/dd>\n<dt>clone {int}<\/dt>\n<dd>If and how the value returned by a call to the get method, should be de-referenced from\nthe stored value. By default values are not cloned, and hence a call to get will return\na reference to the stored value. See Attribute.CLONE for more details about the clone \noptions available<\/dd>\n<\/dl>", "guessedname": "addAtt", "guessedtype": "function"}, "_splitAttrValues": {"return": {"type": "Object", "description": "Object literal with 2 properties - \"simple\" and \"complex\",\ncontaining simple and complex attribute values respectively keyed \nby attribute the top level attribute name."}, "description": "Utility to split out regular attribute values\nfrom complex attribute values, so that complex\nattributes can be keyed by top level attribute name.", "private": "", "params": [{"type": "Object", "name": "valueHash", "description": " Name\/value hash of initial values"}], "guessedname": "_splitAttVals", "guessedtype": "function"}, "_initAtts": {"protected": "", "params": [{"type": "Object", "name": "cfg", "description": " Attribute configuration object literal"}, {"type": "Object", "name": "initValues", "description": " Name\/value hash of initial values to apply"}], "description": "Configures attributes, and sets initial values", "guessedname": "_initAtts", "guessedtype": "function"}, "_initAttVal": {"return": {"type": "Any", "description": "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 initValues \nhash provided.", "private": "", "params": [{"type": "String", "name": "att", "description": " Attribute name"}, {"type": "Object", "name": "cfg", "description": " Default attribute configuration\nobject literal"}, {"type": "Object", "name": "initVales", "description": " Initial attribute values, provided \nfor the instance"}], "guessedname": "_initAttVal", "guessedtype": "function"}}, "uses": ["Event.Target"], "file": "Attribute.js", "shortname": "Attribute", "properties": {"CLONE": {"type": "Object\n<p>\nConstants for clone formats supported by Attribute.\n<\/p>\n<p>\nBy default attribute values returned by the get method\nare not cloned. However setting the attribute's \"clone\"\nproperty to:\n<\/p>\n<dl>\n<dt>Attribute.CLONE.DEEP<\/dt>\n<dd>Will result in a deep cloned value being returned\n(using Y.clone). This can be expensive for complex\nobjects.\n<\/dd>\n<dt>Attribute.CLONE.SHALLOW<\/dt>\n<dd>Will result in a shallow cloned value being returned\n(using Y.merge).\n<\/dd>\n<dt>Attribute.CLONE.IMMUTABLE<\/dt>\n<dd>Will result in a deep cloned value being returned\nwhen using the get method. Additionally users will\nnot be able to set sub values of the attribute \nusing the complex attribute notation (obj.set(\"x.y.z, 5)).\nHowever the value of the attribute can be changed, making\nit different from a READONLY attribute.\n<\/dd>\n<dt>Attribute.CLONE.NONE<\/dt>\n<dd>\nThe value will not be cloned, resulting in a reference\nto the stored value being passed back, if the value is an object.\nThis is the default behavior.\n<\/dd>\n<\/dl>", "static": "", "final": "", "guessedname": "CLONE", "guessedtype": "property"}}, "description": "<p>\nAttribute provides managed attribute support. \n<\/p>\n<p>\nThe class is designed to be augmented onto a host class, \nand allows the host to support get\/set methods for attributes,\ninitial configuration support and attribute change events.\n<\/p>\n<p>Attributes added to the host can:<\/p>\n<ul>\n<li>Be defined as read-only.<\/li>\n<li>Be defined as write-once.<\/li>\n<li>Be defined with a set function, used to manipulate\nvalues passed to Attribute's set method, before they are stored.<\/li>\n<li>Be defined with a validator function, to validate values before they are stored.<\/li>\n<li>Be defined with a get function, which can be used to manipulate stored values,\nbefore they are returned by Attribute's get method.<\/li>\n<li>Specify if and how they should be cloned on 'get' (see Attribute.CLONE for supported clone modes).<\/li>\n<\/ul>\n<em>See the addAtt method, for details about how to add attributes with\na specific configuration<\/em>"}, "Event.Subscriber": {"name": "Event.Subscriber", "constructors": [{"params": [{"type": "Function", "name": "fn", "description": " The wrapped function to execute"}, {"type": "Object", "name": "obj", "description": " An object to be passed along when the event fires"}, {"type": "Array", "name": "args", "description": " subscribe() additional arguments"}], "description": "Stores the subscriber information to be used when the event fires."}], "namespace": "", "module": "event", "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": "obj", "description": " an object to be passed along when the event fires"}], "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"}, "toString": {"guessedname": "toString", "guessedtype": "function"}, "notify": {"params": [{"type": "", "name": "defaultContext", "description": " The execution context if not overridden\nby the subscriber"}, {"type": "Array", "name": "args", "description": " Arguments array for the subscriber"}], "description": "Executes the subscriber.", "guessedname": "notify", "guessedtype": "function"}}, "file": "event-custom.js", "guessedtype": "function", "shortname": "Event.Subscriber", "properties": {"wrappedFn": {"type": "Function", "description": "}\nfn bound to obj with additional arguments applied via Y.bind", "guessedname": "wrappedFn", "guessedtype": "property"}, "args": {"type": "Array", "description": "Optional additional arguments supplied to subscribe(). If present,\nthese will be appended to the arguments supplied to fire()"}, "obj": {"type": "Object", "description": "An optional custom object that will passed to the callback when\nthe event fires", "guessedname": "obj", "guessedtype": "property"}, "id": {"type": "String", "description": "Unique subscriber id", "guessedname": "id", "guessedtype": "property"}, "fn": {"type": "Function", "description": "The callback that will be execute when the event fires\nThis is wrapped by Y.bind if obj was supplied.", "guessedname": "fn", "guessedtype": "property"}}, "description": "Stores the subscriber information to be used when the event fires."}, "Do.AlterReturn": {"name": "Do.AlterReturn", "namespace": "", "module": "event", "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"}, "Loader": {"name": "Loader", "namespace": "", "module": "loader", "properties": {"force": {"type": "string[]", "description": "A list of modules that should always be loaded, even\nif they have already been inserted into the page.", "guessedname": "force", "guessedtype": "property"}, "rollups": {"description": "List of rollup files found in the library metadata", "guessedname": "rollups", "guessedtype": "property"}, "allowRollup": {"default": "true", "type": "boolean", "description": "Should we allow rollups", "guessedname": "allowRollup", "guessedtype": "property"}, "loaded": {"type": "{string: boolean}", "propery": "loaded", "description": "Set when beginning to compute the dependency tree. \nComposed of what YUI reports to be loaded combined\nwith what has been loaded by the tool", "guessedname": "loaded", "guessedtype": "property"}, "_internalCallback": {"private": "", "description": "Internal callback to handle multiple internal insert() calls\nso that css is inserted prior to js", "guessedname": "_internalCallback", "guessedtype": "property"}, "inserted": {"type": "{string: boolean}", "description": "List of modules inserted by the utility", "guessedname": "inserted", "guessedtype": "property"}, "charset": {"default": "utf-8", "type": "string", "description": "The charset attribute for inserted nodes", "guessedname": "charset", "guessedtype": "property"}, "loadOptional": {"default": "false", "type": "boolean", "description": "Whether or not to load optional dependencies for \nthe requested modules", "guessedname": "loadOptional", "guessedtype": "property"}, "ignoreRegistered": {"default": "false", "description": "Ignore modules registered on the YUI global", "guessedname": "ignoreRegistered", "guessedtype": "property"}, "combine": {"default": "false", "type": "boolean", "description": "If configured, YUI JS resources will use the combo\nhandler", "guessedname": "combine", "guessedtype": "property"}, "moduleInfo": {"description": "The library metadata"}, "filter": {"type": "string|{searchExp: string, replaceStr: string}", "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<dl>\n<dt>DEBUG<\/dt>\n<dd>Selects the debug versions of the library (e.g., event-debug.js).\nThis option will automatically include the logger widget<\/dd>\n<dt>RAW<\/dt>\n<dd>Selects the non-minified version of the library (e.g., event.js).<\/dd>\n<\/dl>\nYou can also define a custom filter, which must be an object literal \ncontaining a search expression and a replace string:\n<pre>\nmyFilter: &#123; \n'searchExp': \"-min\\\\.js\", \n'replaceStr': \"-debug.js\"\n&#125;\n<\/pre>", "guessedname": "filter", "guessedtype": "property"}, "comboBase": {"default": "http:\/\/yui.yahooapis.com\/combo?", "type": "string", "description": "Base path for the combo service", "guessedname": "comboBase", "guessedtype": "property"}, "context": {"default": "{YUI} the YUI instance", "description": "The execution context for all callbacks", "guessedname": "context", "guessedtype": "property"}, "insertBefore": {"type": "string|HTMLElement", "description": "Node reference or id where new nodes should be inserted before", "guessedname": "insertBefore", "guessedtype": "property"}, "base": {"default": "http:\/\/yui.yahooapis.com\/[YUI VERSION]\/build\/", "type": "string", "description": "The base directory.", "guessedname": "base", "guessedtype": "property"}, "sorted": {"type": "string[]", "description": "All of the derived dependencies in sorted order, which\nwill be populated when either calculate() or insert()\nis called", "guessedname": "sorted", "guessedtype": "property"}, "data": {"description": "Data that is passed to all callbacks", "guessedname": "data", "guessedtype": "property"}, "_useYahooListener": {"private": "", "description": "Use the YUI environment listener to detect script load. This\nis only switched on for Safari 2.x and below.", "guessedname": "_useYahooListener", "guessedtype": "property"}, "required": {"type": "{string: boolean}", "description": "The list of requested modules", "guessedname": "required", "guessedtype": "property"}, "ignore": {"type": "string[]", "description": "A list of modules that should not be loaded, even if\nthey turn up in the dependency tree", "guessedname": "ignore", "guessedtype": "property"}, "dirty": {"default": "true", "type": "boolean", "description": "Flag to indicate the dependency tree needs to be recomputed\nif insert is called again.", "guessedname": "dirty", "guessedtype": "property"}, "timeout": {"type": "int", "description": "Timeout value in milliseconds. If set, this value will be used by\nthe get utility. the timeout event will fire if\na timeout occurs.", "guessedname": "timeout", "guessedtype": "property"}, "root": {"default": "[YUI VERSION]\/build\/", "type": "string", "description": "Root path to prepend to module path for the combo\nservice", "guessedname": "root", "guessedtype": "property"}}, "methods": {"insert": {"params": [{"type": "", "name": "o", "description": " optional options object"}, {"type": "string", "name": "type", "description": " the type of dependency to insert"}], "description": "inserts the requested modules and their dependencies. \n<code>type<\/code> can be \"js\" or \"css\". Both script and \ncss are inserted if type is not provided.", "guessedname": "insert", "guessedtype": "function"}, "_explode": {"private": "", "description": "Inspects the required modules list looking for additional \ndependencies. Expands the required list to include all \nrequired modules. Called by calculate()", "guessedname": "_explode", "guessedtype": "function"}, "calculate": {"params": [{"type": "", "name": "o", "description": " optional options object"}], "description": "Calculates the dependency tree, the result is stored in the sorted \nproperty", "guessedname": "calculate", "guessedtype": "function"}, "_sort": {"private": "", "description": "Sorts the dependency tree. The last step of calculate()", "guessedname": "_sort", "guessedtype": "function"}, "_pushEvents": {"guessedname": "_pushEvents", "params": [{"type": "Function", "name": "optional", "description": " function reference"}], "description": "In IE, the onAvailable\/onDOMReady events need help when Event is\nloaded dynamically", "private": "", "guessedtype": "function"}, "_setup": {"private": "", "description": "Investigates the current YUI configuration on the page. By default,\nmodules already detected will not be loaded again unless a force\noption is encountered. Called by calculate()", "guessedname": "_setup", "guessedtype": "function"}, "require": {"params": [{"type": "string[] | string*", "name": "what", "description": " the modules to load"}], "description": "Add a requirement for one or more module", "guessedname": "require", "guessedtype": "function"}, "getRequires": {"params": [{"type": "", "name": "mod", "description": " The module definition from moduleInfo"}], "description": "Returns an object containing properties for all modules required\nin order to load the requested module", "guessedname": "getRequires", "guessedtype": "function"}, "addModule": {"return": {"type": "boolean", "description": "true if the module was added, false if \nthe object passed in did not provide all required attributes"}, "params": [{"type": "", "name": "o", "description": " An object containing the module data"}, {"type": "", "name": "name", "description": " the module name (optional), required if not in the module data"}], "description": "Add a new module to the component metadata. \n<dl>\n<dt>name:<\/dt> <dd>required, the component name<\/dd>\n<dt>type:<\/dt> <dd>required, the component type (js or css)<\/dd>\n<dt>path:<\/dt> <dd>required, the path to the script from \"base\"<\/dd>\n<dt>requires:<\/dt> <dd>array of modules required by this component<\/dd>\n<dt>optional:<\/dt> <dd>array of optional modules for this component<\/dd>\n<dt>supersedes:<\/dt> <dd>array of the modules this component replaces<\/dd>\n<dt>after:<\/dt> <dd>array of modules the components which, if present, should be sorted above this one<\/dd>\n<dt>rollup:<\/dt> <dd>the number of superseded modules required for automatic rollup<\/dd>\n<dt>fullpath:<\/dt> <dd>If fullpath is specified, this is used instead of the configured base + path<\/dd>\n<dt>skinnable:<\/dt> <dd>flag to determine if skin assets should automatically be pulled in<\/dd>\n<\/dl>", "guessedname": "addModule", "guessedtype": "function"}, "_reduce": {"private": "", "description": "Remove superceded modules and loaded modules. Called by\ncalculate() after we have the mega list of all dependencies", "guessedname": "_reduce", "guessedtype": "function"}, "loadNext": {"params": [{"type": "string", "name": "mname", "description": " optional the name of the module that has\nbeen loaded (which is usually why it is time to load the next\none)"}], "description": "Executed every time a module is loaded, and if we are in a load\ncycle, we attempt to load the next script. Public so that it\nis possible to call this if using a method other than\nY.register to determine when scripts are fully loaded", "guessedname": "loadNext", "guessedtype": "function"}, "_url": {"return": {"type": "string", "description": "the full url"}, "description": "Generates the full url for a module\nmethod _url", "private": "", "params": [{"type": "string", "name": "path", "description": " the path fragment"}], "guessedname": "_url", "guessedtype": "function"}, "getProvides": {"return": {"type": "", "description": "what this module provides"}, "params": [{"type": "string", "name": "name", "description": " The name of the module"}, {"type": "string", "name": "notMe", "description": " don't add this module name, only include superseded modules"}], "description": "Returns an object literal of the modules the supplied module satisfies", "guessedname": "getProvides", "guessedtype": "function"}, "_rollup": {"private": "", "description": "Look for rollup packages to determine if all of the modules a\nrollup supersedes are required. If so, include the rollup to\nhelp reduce the total number of connections required. Called\nby calculate()", "guessedname": "_rollup", "guessedtype": "function"}}, "file": "loader.js", "shortname": "Loader", "events": {"failure": {"description": "Executed when the loader fails to complete an insert operation.\nThis can be subscribed to normally, or a listener can be passed\nas an onFailure config option."}, "timeout": {"description": "Executed when a Get operation times out.\nThis can be subscribed to normally, or a listener can be passed\nas an onTimeout config option."}, "success": {"description": "Executed when the loader successfully completes an insert operation\nThis can be subscribed to normally, or a listener can be passed\nas an onSuccess config option."}}, "description": "Loader provides dynamic loading for YUI."}, "Array": {"name": "Array", "namespace": "", "module": "yui", "methods": {"test": {"todo": "current implementation (intenionally) will not implicitly \nhandle html elements that are array-like (forms, selects, etc).", "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", "guessedname": "test", "guessedtype": "function"}, "indexOf": {"return": {"type": "", "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.", "params": [{"type": "Array", "name": "a", "description": " the array to search"}, {"type": "", "name": "val", "description": " the value to search for"}], "guessedname": "indexOf", "guessedtype": "function", "todo": "use native method if avail"}, "Array": {"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.", "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."}], "description": "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.", "guessedname": "Array", "guessedtype": "function"}, "hash": {"return": {"type": "", "description": "the hash"}, "params": [{"type": "Array", "name": "k", "description": " keyset"}, {"type": "Array", "name": "v", "description": " optional valueset"}], "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.", "guessedname": "hash", "guessedtype": "function"}, "each": {"description": "Executes the supplied function on each item in the array.", "guessedname": "each", "guessedtype": "property"}}, "static": "", "file": "yui-array.js", "shortname": "Array", "todo": "investigate using Array subclasses for some of this", "description": "Array utilities"}, "DropPlugin": {"name": "DropPlugin", "constructors": [{"description": "This is a simple Drop plugin that can be attached to a Node via the plug method."}], "namespace": "", "module": "dd-plugin", "guessedname": "Plugin", "extends": "Drop", "superclass": "Drop", "file": "dd-drop-plugin.js", "guessedtype": "property", "shortname": "DropPlugin", "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."}, "Event": {"name": "Event", "namespace": "", "module": "event", "guessedname": "Event", "methods": {"onDOMReady": {"description": "Executes the supplied callback when the DOM is first usable. This\nwill execute immediately if called after the DOMReady event has\nfired. @todo the DOMContentReady event does not fire when the\nscript is dynamically injected into the page. This means the\nDOMReady custom event will never fire in FireFox or Opera when the\nlibrary is injected. It _will_ fire in Safari, and the IE \nimplementation would allow for us to fire it if the defered script\nis not available. We want this to behave the same in all browsers.\nIs there a way to identify when the script has been injected \ninstead of included inline? Is there a way to know whether the \nwindow onload event has fired without having had a listener attached \nto it when it did so?\n<p>The callback is a Event.Custom, so the signature is:<\/p>\n<p>type &lt;string&gt;, args &lt;array&gt;, customobject &lt;object&gt;<\/p>\n<p>For DOMReady events, there are no fire argments, so the\nsignature is:<\/p>\n<p>\"DOMReady\", [], obj<\/p>", "static": "", "guessedname": "onDOMReady", "guessedtype": "function", "params": [{"type": "function", "name": "fn", "description": " what to execute when the element is found."}], "optional": "context execution context"}, "nativeRemove": {"description": "Basic remove listener", "private": "", "static": "", "guessedname": "nativeRemove", "guessedtype": "function", "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"}]}, "addListener": {"return": {"type": "Boolean", "description": "True if the action was successful or defered,\nfalse if one or more of the elements \ncould not have the listener attached,\nor if the operation throws an exception."}, "description": "Appends an event handler", "static": "", "guessedname": "addListener", "guessedtype": "function", "params": [{"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": "String", "name": "type", "description": " The type of event to append"}, {"type": "Function", "name": "fn", "description": " The method the event invokes"}, {"type": "Object", "name": "obj", "description": " An arbitrary object that will be \npassed as a parameter to the handler"}, {"type": "Boolean|object", "name": "args", "description": " 1..n ar"}]}, "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": "boundEl", "description": " the element the listener is attached to"}]}, "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", "guessedname": "resolve", "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"}, "_unload": {"guessedname": "_unload", "static": "", "description": "Removes all listeners registered by pe.event. Called \nautomatically during the unload event.", "private": "", "guessedtype": "function"}, "_tryPreloadAttach": {"guessedname": "_tryPreloadAttach", "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"}, "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.", "private": "", "static": "", "guessedname": "_isValidCollection", "guessedtype": "function", "params": [{"type": "", "name": "o", "description": " the object to test"}]}, "onContentReady": {"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<p>The callback is executed with a single parameter:\nthe custom object parameter, if provided.<\/p>"}, "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": "function", "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"}]}, "_load": {"guessedname": "_load", "static": "", "description": "hook up any deferred listeners", "private": "", "guessedtype": "function"}, "onAvailable": {"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<p>The callback is executed with a single parameter:\nthe custom object parameter, if provided.<\/p>"}, "on": {"see": "addListener", "static": "", "description": "Y.Event.on is an alias for addListener", "guessedname": "attach", "guessedtype": "function"}, "removeListener": {"return": {"type": "boolean", "description": "true if the unbind was successful, false * otherwise."}, "description": "Removes an event listener", "static": "", "guessedname": "removeListener", "guessedtype": "function", "params": [{"type": "String|HTMLElement|Array|NodeList", "name": "el", "description": " An id, an element \nreference, or a collection of ids and\/or elements to remove\nthe listener from."}, {"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 * removed."}]}}, "static": "", "file": "event-dom.js", "guessedtype": "function", "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 2000@amp;20 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"}, "POLL_INTERVAL": {"description": "The poll interval in milliseconds", "static": "", "guessedname": "POLL_INTERVAL", "guessedtype": "property", "type": "int", "final": ""}, "webkitKeymap": {"private": "", "description": "webkit key remapping required for Safari < 3.1", "guessedname": "webkitKeymap", "guessedtype": "property"}, "_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"}, "loadComplete": {"description": "True after the onload event has fired", "private": "", "static": "", "guessedname": "loadComplete", "guessedtype": "property", "type": "boolean"}, "_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."}}, "version": "3.00PR1", "modules": {"node": {"classlist": ["Node", "NodeList"], "name": "node", "filelist": ["node.js"], "description": "Provides a wrapper for dom nodes that supports selector queries normalizes x-browser differences."}, "queue": {"classlist": ["Queue"], "name": "queue", "filelist": ["Queue.js"], "description": "Executes a series of callbacks in a non-blocking queue"}, "anim": {"classlist": ["Anim", "Y.Anim"], "name": "anim", "filelist": ["anim.js"], "description": "Y.Animation Utility."}, "io": {"classlist": ["io"], "name": "io", "filelist": ["io.js"], "description": "HTTP communications module."}, "anim-curve": {"classlist": [], "name": "anim-curve", "filelist": [], "description": "Adds bezier curve behaviors to Y.Anim."}, "anim-scroll": {"name": "anim-scroll", "classlist": [], "filelist": [], "guessedname": "scroll", "guessedtype": "property", "description": "Adds scroll behaviors to Y.Anim."}, "attribute": {"name": "attribute", "classlist": ["Attribute"], "filelist": ["Attribute.js"], "guessedname": "O", "guessedtype": "property", "description": "Managed Attribute Provider"}, "node-class": {"classlist": [], "name": "node-class", "filelist": [], "description": "Extended Node interface for managing classNames."}, "anim-xy": {"name": "anim-xy", "classlist": [], "filelist": [], "guessedname": "xy", "guessedtype": "property", "description": "Adds xy position behaviors to Y.Anim."}, "loader": {"classlist": ["Get", "Loader"], "name": "loader", "filelist": ["get.js", "loader.js"], "description": "Provides dynamic loading for the YUI library. It includes the dependency\ninfo for the library, and will automatically pull in dependencies for\nthe modules requested. It supports rollup files (such as utilities.js, and \nwill automatically use these when appropriate in order to minimize the \nnumber of http connections required to load all of the dependencies. It\ncan load the files from the Yahoo! CDN, and it can use the combo service\nprovided on that network."}, "yui": {"classlist": ["Array", "Lang", "Object", "UA", "YUI"], "name": "yui", "filelist": ["yui-array.js", "yui-core.js", "yui-dump.js", "yui-init.js", "yui-lang.js", "yui-later.js", "yui-log.js", "yui-object.js", "yui-ua.js", "yui.js"], "description": "YUI core"}, "json": {"classlist": ["JSON", "JSON"], "name": "json", "filelist": ["dump.js", "substitute.js", "Parse.js", "Stringify.js"], "description": "Provides Y.JSON.stringify method for converting objects to JSON strings."}, "base": {"name": "base", "classlist": ["Base"], "filelist": ["Base.js"], "guessedname": "L", "guessedtype": "property", "description": "Base class support for objects requiring\nmanaged attributes and acting as event targets"}, "dd-plugin": {"classlist": ["DropPlugin", "DragPlugin"], "name": "dd-plugin", "filelist": ["dd-drop-plugin.js", "dd-plugin.js"], "description": "This is a simple Drag plugin that can be attached to a Node via the plug method.\n<p>Module Name: <strong>dd-plugin<\/strong><\/p>"}, "node-region": {"name": "node-region", "classlist": [], "filelist": [], "guessedname": "ATTR", "guessedtype": "property", "description": "Extended Node interface for managing regions."}, "anim-color": {"name": "anim-color", "classlist": [], "filelist": [], "guessedname": "color", "guessedtype": "property", "description": "Adds color behaviors to Y.Anim."}, "anim-easing": {"classlist": ["Easing"], "name": "anim-easing", "filelist": [], "description": "Singleton that determines how an animation proceeds from start to end."}, "event": {"classlist": ["Event.Handle", "Event.Custom", "Event.Subscriber", "Do", "Do.Method", "Do.Error", "Do.AlterArgs", "Do.AlterReturn", "Event", "Event.Facade", "Event.Target"], "name": "event", "filelist": ["event-custom.js", "event-do.js", "event-dom.js", "event-facade.js", "event-ready.js", "event-target.js", "event.js"], "description": "The YUI event system"}, "node-screen": {"classlist": [], "name": "node-screen", "filelist": [], "description": "This module applies adds support for positioning elements and\nnormalizes window size and scroll detection."}}, "filemap": {"Parse.js": {"classlist": ["JSON"], "name": "Parse.js", "module": "json"}, "get.js": {"classlist": ["Get"], "name": "get.js", "module": "loader"}, "dd-plugin.js": {"classlist": ["DragPlugin"], "name": "dd-plugin.js", "module": "dd-plugin"}, "yui.js": {"classlist": ["YUI"], "name": "yui.js", "module": "yui"}, "yui-dump.js": {"classlist": [], "name": "yui-dump.js", "module": "yui"}, "yui-object.js": {"classlist": ["Object"], "name": "yui-object.js", "module": "yui"}, "yui-ua.js": {"classlist": ["UA"], "name": "yui-ua.js", "module": "yui"}, "yui-init.js": {"classlist": [], "name": "yui-init.js", "module": "yui"}, "yui-log.js": {"classlist": [], "name": "yui-log.js", "module": "yui"}, "Attribute.js": {"classlist": ["Attribute"], "name": "Attribute.js", "module": "attribute"}, "dump.js": {"classlist": [], "name": "dump.js", "module": "json"}, "event-ready.js": {"classlist": [], "name": "event-ready.js", "module": "event"}, "dd-drop-plugin.js": {"classlist": ["DropPlugin"], "name": "dd-drop-plugin.js", "module": "dd-plugin"}, "yui-core.js": {"classlist": [], "name": "yui-core.js", "module": "yui"}, "event-custom.js": {"classlist": ["Event.Handle", "Event.Custom", "Event.Subscriber"], "name": "event-custom.js", "module": "event"}, "yui-later.js": {"classlist": [], "name": "yui-later.js", "module": "yui"}, "event-do.js": {"classlist": ["Do", "Do.Method", "Do.Error", "Do.AlterArgs", "Do.AlterReturn"], "name": "event-do.js", "module": "event"}, "Base.js": {"classlist": ["Base"], "name": "Base.js", "module": "base"}, "yui-array.js": {"classlist": ["Array"], "name": "yui-array.js", "module": "yui"}, "anim.js": {"classlist": ["Anim", "Y.Anim", "Easing"], "name": "anim.js", "module": "anim"}, "node.js": {"classlist": ["Node", "NodeList"], "name": "node.js", "module": "node"}, "io.js": {"classlist": ["io"], "name": "io.js", "module": "io"}, "loader.js": {"classlist": ["Loader"], "name": "loader.js", "module": "loader"}, "event-target.js": {"classlist": ["Event.Target"], "name": "event-target.js", "module": "event"}, "yui-lang.js": {"classlist": ["Lang"], "name": "yui-lang.js", "module": "yui"}, "substitute.js": {"classlist": [], "name": "substitute.js", "module": "json"}, "event-facade.js": {"classlist": ["Event.Facade"], "name": "event-facade.js", "module": "event"}, "event-dom.js": {"classlist": ["Event"], "name": "event-dom.js", "module": "event"}, "Queue.js": {"classlist": ["Queue"], "name": "Queue.js", "module": "queue"}, "event.js": {"classlist": [], "name": "event.js", "module": "event"}, "Stringify.js": {"classlist": ["JSON"], "name": "Stringify.js", "module": "json"}}}