Node charset, default utf-8<\/dd>\n<\/dl>\n\nYAHOO.util.Get.css(\"http:\/\/yui.yahooapis.com\/2.3.1\/build\/menu\/assets\/skins\/sam\/menu.css\");\n<\/pre>\n\nYAHOO.util.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>"}]}}, "file": "Get.js", "guessedtype": "function", "shortname": "Get", "properties": {"POLL_FREQ": {"description": "The default poll freqency in ms, when needed", "default": "10", "static": "", "guessedname": "POLL_FREQ", "guessedtype": "property", "type": "int"}, "qidx": {"guessedname": "qidx", "type": "int", "description": "queue index used to generate transaction ids", "private": "", "guessedtype": "property"}, "queues": {"private": "", "description": "hash of queues to manage multiple requests", "guessedname": "queues", "guessedtype": "property"}, "purging": {"guessedname": "purging", "type": "boolean", "description": "interal property used to prevent multiple simultaneous purge \nprocesses", "private": "", "guessedtype": "property"}, "TIMEOUT": {"description": "The length time to poll for varName when loading a script in\nSafari 2.x before the transaction fails.\nproperty TIMEOUT", "default": "2000", "static": "", "guessedname": "TIMEOUT", "guessedtype": "property", "type": "int"}, "nidx": {"guessedname": "nidx", "type": "int", "description": "node index used to generate unique node 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"}}, "description": "Fetches and inserts one or more script or link nodes into the document"}, "YAHOO.widget.BaseCellEditor": {"name": "YAHOO.widget.BaseCellEditor", "constructors": [{"params": [{"type": "String", "name": "sType", "description": " Type indicator, to map to YAHOO.widget.DataTable.Editors."}, {"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The BaseCellEditor class provides base functionality common to all inline cell\neditors for a DataTable widget."}], "namespace": "YAHOO.widget", "module": "datatable", "events": {"saveEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}, {"type": "Object", "name": "oArgs.newData", "description": " New data value from form input field."}, {"type": "Object", "name": "oArgs.oldData", "description": " Old data value."}], "description": "Fired when a CellEditor input is saved."}, "revertEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}, {"type": "Object", "name": "oArgs.newData", "description": " New data value from form input field."}, {"type": "Object", "name": "oArgs.oldData", "description": " Old data value."}], "description": "Fired when a CellEditor input is reverted due to asyncSubmitter failure."}, "blurEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}], "description": "Fired when a CellEditor has a blur event."}, "showEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}], "description": "Fired when a CellEditor is shown."}, "cancelEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}], "description": "Fired when a CellEditor input is canceled."}, "invalidDataEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}, {"type": "Object", "name": "oArgs.newData", "description": " New data value from form input field."}, {"type": "Object", "name": "oArgs.oldData", "description": " Old data value."}], "description": "Fired when a CellEditor input is reverted due to invalid data."}, "keydownEvent": {"params": [{"type": "YAHOO.widget.CellEditor", "name": "oArgs.editor", "description": " The CellEditor instance."}, {"type": "HTMLEvent", "name": "oArgs.event", "description": " The event object."}], "description": "Fired when a CellEditor has a keydown."}}, "guessedname": "BaseCellEditor", "methods": {"_initEvents": {"private": "", "description": "Initialize Custom Events.", "guessedname": "_initEvents", "guessedtype": "function"}, "getColumn": {"return": {"type": "YAHOO.widget.Column", "description": "Column instance."}, "description": "Returns reference to associated Column instance.", "guessedname": "getColumn", "guessedtype": "function"}, "getDataTable": {"return": {"type": "YAHOO.widget.DataTable", "description": "DataTable instance."}, "description": "Returns reference to associated DataTable instance.", "guessedname": "getDataTable", "guessedtype": "function"}, "render": {"description": "Renders DOM elements and attaches event listeners.", "guessedname": "render", "guessedtype": "function"}, "show": {"description": "Displays CellEditor UI in the correct position.", "guessedname": "show", "guessedtype": "function"}, "move": {"description": "Moves container into position for display.", "guessedname": "move", "guessedtype": "function"}, "focus": {"description": "Sets focus in CellEditor.", "guessedname": "focus", "guessedtype": "function"}, "renderBtns": {"description": "Renders Save\/Cancel buttons.", "guessedname": "renderBtns", "guessedtype": "function"}, "unblock": {"description": "Fires unblockEvent", "guessedname": "unblock", "guessedtype": "function"}, "cancel": {"description": "Cancels CellEditor input and hides UI.", "guessedname": "cancel", "guessedtype": "function"}, "doAfterRender": {"description": "Access to add additional event listeners.", "guessedname": "doAfterRender", "guessedtype": "function"}, "renderForm": {"description": "Renders form elements.", "guessedname": "renderForm", "guessedtype": "function"}, "getRecord": {"return": {"type": "YAHOO.widget.Record", "description": "Record instance."}, "description": "Returns reference to associated Record instance.", "guessedname": "getRecord", "guessedtype": "function"}, "getId": {"return": {"type": "String", "description": "Unique ID of the CellEditor instance."}, "description": "CellEditor unique ID.", "guessedname": "getId", "guessedtype": "function"}, "attach": {"params": [{"type": "YAHOO.widget.DataTable", "name": "oDataTable", "description": " Associated DataTable instance."}, {"type": "HTMLElement", "name": "elCell", "description": " Cell to edit."}], "description": "Attach CellEditor for a new interaction.", "guessedname": "attach", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the CellEditor instance."}, "description": "CellEditor instance name, for logging.", "guessedname": "toString", "guessedtype": "function"}, "getInputValue": {"description": "Retrieves input value from CellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}, "destroy": {"description": "Nulls out the entire CellEditor instance and related objects, removes attached\nevent listeners, and clears out DOM elements inside the container, removes\ncontainer from the DOM.", "guessedname": "destroy", "guessedtype": "function"}, "save": {"description": "Saves value of CellEditor and hides UI.", "guessedname": "save", "guessedtype": "function"}, "handleDisabledBtns": {"description": "After rendering form, if disabledBtns is set to true, then sets up a mechanism\nto save input without them.", "guessedname": "handleDisabledBtns", "guessedtype": "function"}, "resetForm": {"description": "Resets CellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}, "getContainerEl": {"return": {"type": "HTMLElement", "description": "Reference to container element."}, "description": "Returns container element.", "guessedname": "getContainerEl", "guessedtype": "function"}, "getTdEl": {"return": {"type": "HTMLElement", "description": "TD element."}, "description": "Returns reference to associated TD element.", "guessedname": "getTdEl", "guessedtype": "function"}, "_initConfigs": {"private": "", "description": "Initialize configs.", "guessedname": "_initConfigs", "guessedtype": "function"}, "block": {"description": "Fires blockEvent", "guessedname": "block", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "CellEditor.js", "guessedtype": "function", "shortname": "BaseCellEditor", "properties": {"LABEL_SAVE": {"default": "\"Save\"", "type": "String", "description": "Text to display on Save button.", "guessedname": "LABEL_SAVE", "guessedtype": "property"}, "CellEditor._nCount": {"description": "Global instance counter.", "default": "0", "private": "", "static": "", "guessedname": "_nCount", "guessedtype": "property", "type": "Number"}, "_sType": {"guessedname": "_sType", "type": "String", "description": "Editor type.", "private": "", "guessedtype": "property"}, "_sId": {"guessedname": "_sId", "type": "String", "description": "Unique id assigned to instance \"yui-ceditorN\", useful prefix for generating unique\nDOM ID strings and log messages.", "private": "", "guessedtype": "property"}, "defaultValue": {"default": "null", "type": "MIXED", "description": "Default value in case Record data is undefined. NB: Null values will not trigger\nthe default value.", "guessedname": "defaultValue", "guessedtype": "property"}, "_oColumn": {"default": "null", "type": "YAHOO.widget.Column", "description": "Column instance.", "guessedname": "_oColumn", "guessedtype": "property"}, "_elContainer": {"guessedname": "_elContainer", "type": "HTMLElement", "description": "Container for inline editor.", "private": "", "guessedtype": "property"}, "value": {"type": "MIXED", "description": "Current value.", "guessedname": "value", "guessedtype": "property"}, "_elCancelBtn": {"description": "Reference to Cancel button, if available.", "default": "null", "private": "", "guessedname": "_elCancelBtn", "guessedtype": "property", "type": "HTMLElement"}, "asyncSubmitter": {"type": "HTMLFunction", "description": "Implementer defined function that can submit the input value to a server. This\nfunction must accept the arguments fnCallback and oNewValue. When the submission\nis complete, the function must also call fnCallback(bSuccess, oNewValue) to \nfinish the save routine in the CellEditor. This function can also be used to \nperform extra validation or input value manipulation.", "guessedname": "asyncSubmitter", "guessedtype": "property"}, "disableBtns": {"default": "false", "type": "Boolean", "description": "True if Save\/Cancel buttons should not be displayed in the CellEditor.", "guessedname": "disableBtns", "guessedtype": "property"}, "_oDataTable": {"guessedname": "_oDataTable", "type": "YAHOO.widget.DataTable", "description": "DataTable instance.", "private": "", "guessedtype": "property"}, "_elTd": {"description": "TD element.", "default": "null", "private": "", "guessedname": "_elTd", "guessedtype": "property", "type": "HTMLElement"}, "CellEditor.CLASS_CELLEDITOR": {"description": "Class applied to CellEditor container.", "default": "\"yui-ceditor\"", "static": "", "guessedname": "CLASS_CELLEDITOR", "guessedtype": "property", "type": "String"}, "_oRecord": {"description": "Record instance.", "default": "null", "private": "", "guessedname": "_oRecord", "guessedtype": "property", "type": "YAHOO.widget.Record"}, "_elSaveBtn": {"description": "Reference to Save button, if available.", "default": "null", "private": "", "guessedname": "_elSaveBtn", "guessedtype": "property", "type": "HTMLElement"}, "LABEL_CANCEL": {"default": "\"Cancel\"", "type": "String", "description": "Text to display on Cancel button.", "guessedname": "LABEL_CANCEL", "guessedtype": "property"}, "isActive": {"type": "Boolean", "description": "True if currently active.", "guessedname": "isActive", "guessedtype": "property"}, "validator": {"default": "null", "type": "HTMLFunction", "description": "Validator function for input data, called from the DataTable instance scope,\nreceives the arguments (inputValue, currentValue, editorInstance) and returns\neither the validated (or type-converted) value or undefined.", "guessedname": "validator", "guessedtype": "property"}}, "description": "The BaseCellEditor class provides base functionality common to all inline cell\neditors for a DataTable widget."}, "YAHOO.widget.TVFadeIn": {"name": "YAHOO.widget.TVFadeIn", "constructors": [{"params": [{"type": "HTMLElement", "name": "el", "description": " the element to animate"}, {"type": "function", "name": "callback", "description": " function to invoke when the animation is finished"}], "description": "A 1\/2 second fade-in animation."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "TVFadeIn", "methods": {"onComplete": {"description": "Clean up and invoke callback", "guessedname": "onComplete", "guessedtype": "function"}, "animate": {"description": "Performs the animation", "guessedname": "animate", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "the string representation of the instance"}, "description": "toString", "guessedname": "toString", "guessedtype": "function"}}, "file": "TVFadeIn.js", "guessedtype": "function", "shortname": "TVFadeIn", "properties": {"el": {"type": "HTMLElement", "description": "The element to animate", "guessedname": "el", "guessedtype": "property"}, "callback": {"type": "function", "description": "the callback to invoke when the animation is complete", "guessedname": "callback", "guessedtype": "property"}}, "description": "A 1\/2 second fade-in animation."}, "YAHOO.widget.CalendarGroup": {"name": "YAHOO.widget.CalendarGroup", "configs": {"MY_LABEL_YEAR_POSITION": {"default": "2", "type": "Number", "description": "The position of the year in the month year label string used as the Calendar header", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEKDAYS": {"default": "true", "type": "Boolean", "description": "True if the Calendar should show weekday labels. True by default.", "guessedname": "value", "guessedtype": "property"}, "MDY_DAY_POSITION": {"default": "2", "type": "Number", "description": "The position of the day in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "MY_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "MONTHS_SHORT": {"default": "[\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]", "type": "String[]", "description": "The short month labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "MULTI_SELECT": {"default": "false", "type": "Boolean", "description": "True if the Calendar should allow multiple selections. False by default.", "guessedname": "value", "guessedtype": "property"}, "MY_LABEL_YEAR_SUFFIX": {"default": "\"\"", "type": "String", "description": "The suffix used after the year when rendering the Calendar header", "guessedname": "value", "guessedtype": "property"}, "DATE_FIELD_DELIMITER": {"default": "\"\/\"", "type": "String", "description": "The value used to delimit date fields in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "MY_YEAR_POSITION": {"default": "2", "type": "Number", "description": "The position of the year in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "close": {"default": "false", "type": "Boolean", "description": "Whether or not a close button should be displayed for this CalendarGroup", "guessedname": "value", "guessedtype": "property"}, "MONTHS_LONG": {"default": "[\"January\", \"February\", \"March\", \"April\", \"May\", \"June\", \"July\", \"August\", \"September\", \"October\", \"November\", \"December\"", "type": "String[]", "description": "The long month labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_MEDIUM": {"default": "[\"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", \"Sat\"]", "type": "String[]", "description": "The medium weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "LOCALE_WEEKDAYS": {"default": "\"short\"", "type": "String", "description": "The setting that determines which length of weekday labels should be used. Possible values are \"1char\", \"short\", \"medium\", and \"long\".", "guessedname": "value", "guessedtype": "property"}, "DATE_RANGE_DELIMITER": {"default": "\"-\"", "type": "String", "description": "The value used to delimit date ranges in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEK_HEADER": {"default": "false", "type": "Boolean", "description": "True if the Calendar should show week row headers. False by default.", "guessedname": "value", "guessedtype": "property"}, "title": {"default": "\"\"", "type": "String", "description": "The title to display above the CalendarGroup's month header", "guessedname": "value", "guessedtype": "property"}, "maxdate": {"default": "null", "type": "String | Date", "description": "The maximum selectable date in the current Calendar (mm\/dd\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "selected": {"default": "[]", "type": "String", "description": "The date or range of dates representing the current Calendar selection", "guessedname": "value", "guessedtype": "property"}, "pages": {"default": "2", "type": "Number", "description": "The number of pages to include in the CalendarGroup. This value can only be set once, in the CalendarGroup's constructor arguments.", "guessedname": "value", "guessedtype": "property"}, "NAV_ARROW_RIGHT": {"description": "The image that should be used for the right navigation arrow.", "default": "null", "deprecated": "You can customize the image by overriding the default CSS class for the right arrow - \"calnavright\"", "guessedname": "value", "guessedtype": "property", "type": "String"}, "HIDE_BLANK_WEEKS": {"default": "false", "type": "Boolean", "description": "True if the Calendar should suppress weeks that are not a part of the current month. False by default.", "guessedname": "value", "guessedtype": "property"}, "mindate": {"default": "null", "type": "String | Date", "description": "The minimum selectable date in the current Calendar (mm\/dd\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "START_WEEKDAY": {"default": "0", "type": "number", "description": "The weekday the week begins on. Default is 0 (Sunday).", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEK_FOOTER": {"default": "false", "type": "Boolean", "description": "True if the Calendar should show week row footers. False by default.", "guessedname": "value", "guessedtype": "property"}, "MDY_YEAR_POSITION": {"default": "3", "type": "Number", "description": "The position of the year in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_LONG": {"default": "[\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"]", "type": "String[]", "description": "The long weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "MDY_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "pagedate": {"default": "today's date", "type": "String | Date", "description": "The month\/year representing the current visible Calendar date (mm\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "MY_LABEL_MONTH_SUFFIX": {"default": "\" \"", "type": "String", "description": "The suffix used after the month when rendering the Calendar header", "guessedname": "value", "guessedtype": "property"}, "MD_DAY_POSITION": {"default": "2", "type": "Number", "description": "The position of the day in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "NAV_ARROW_LEFT": {"description": "The image that should be used for the left navigation arrow.", "default": "null", "deprecated": "You can customize the image by overriding the default CSS class for the left arrow - \"calnavleft\"", "guessedname": "value", "guessedtype": "property", "type": "String"}, "MY_LABEL_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in the month year label string used as the Calendar header", "guessedname": "value", "guessedtype": "property"}, "MD_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/day date string", "guessedname": "value", "guessedtype": "property"}, "DATE_DELIMITER": {"default": "\",\"", "type": "String", "description": "The value used to delimit individual dates in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "LOCALE_MONTHS": {"default": "\"long\"", "type": "String", "description": "The setting that determines which length of month labels should be used. Possible values are \"short\" and \"long\".", "guessedname": "value", "guessedtype": "property"}, "iframe": {"default": "true for IE6 and below, false for all other browsers", "type": "Boolean", "description": "Whether or not an iframe shim should be placed under the Calendar to prevent select boxes from bleeding through in Internet Explorer 6 and below.\nThis property is enabled by default for IE6 and below. It is disabled by default for other browsers for performance reasons, but can be \nenabled if required.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_1CHAR": {"default": "[\"S\", \"M\", \"T\", \"W\", \"T\", \"F\", \"S\"]", "type": "String[]", "description": "The 1-character weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_SHORT": {"default": "[\"Su\", \"Mo\", \"Tu\", \"We\", \"Th\", \"Fr\", \"Sa\"]", "type": "String[]", "description": "The short weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "NAV": {"default": "null", "type": "Object", "description": "Configuration for the Month Year Navigation UI. By default it is disabled", "guessedname": "value", "guessedtype": "property"}, "strings": {"default": "An object with the properties shown below:\n
\n- previousMonth<\/dt>
- String<\/em> : The string to use for the \"Previous Month\" navigation UI. Defaults to \"Previous Month\".<\/dd>\n
- nextMonth<\/dt>
- String<\/em> : The string to use for the \"Next Month\" navigation UI. Defaults to \"Next Month\".<\/dd>\n
- close<\/dt>
- String<\/em> : The string to use for the close button label. Defaults to \"Close\".<\/dd>\n<\/dl>", "type": "{Object}", "description": "The map of UI strings which the CalendarGroup UI uses."}}, "constructors": [{"params": [{"type": "String", "name": "id", "description": " optional The id of the table element that will represent the CalendarGroup widget. As of 2.4.0, this argument is optional."}, {"type": "String | HTMLElement", "name": "container", "description": " The id of the container div element that will wrap the CalendarGroup table, or a reference to a DIV element which exists in the document."}, {"type": "Object", "name": "config", "description": " optional The configuration object containing the initial configuration values for the CalendarGroup."}], "description": "YAHOO.widget.CalendarGroup is a special container class for YAHOO.widget.Calendar. This class facilitates\nthe ability to have multi-page calendar views that share a single dataset and are\ndependent on each other.\nThe calendar group instance will refer to each of its elements using a 0-based index.\nFor example, to construct the placeholder for a calendar group widget with id \"cal1\" and\ncontainerId of \"cal1Container\", the markup would be as follows:\n<![CDATA[\n<div id=\"cal1Container_0\"><\/div>\n<div id=\"cal1Container_1\"><\/div>\n<\/xmp>\nThe tables for the calendars (\"cal1_0\" and \"cal1_1\") will be inserted into those containers.\n<p>\n<strong>NOTE: As of 2.4.0, the constructor's ID argument is optional.<\/strong>\nThe CalendarGroup can be constructed by simply providing a container ID string, \nor a reference to a container DIV HTMLElement (the element needs to exist \nin the document).\nE.g.:\n<xmp>\nvar c = new YAHOO.widget.CalendarGroup(\"calContainer\", configOptions);\n<\/xmp>\nor:\n<xmp>\nvar containerDiv = YAHOO.util.Dom.get(\"calContainer\");\nvar c = new YAHOO.widget.CalendarGroup(containerDiv, configOptions);\n<\/xmp>\n<\/p>\n<p>\nIf not provided, the ID will be generated from the container DIV ID by adding an \"_t\" suffix.\nFor example if an ID is not provided, and the container's ID is \"calContainer\", the CalendarGroup's ID will be set to \"calContainer_t\".\n<\/p>"}], "namespace": "YAHOO.widget", "module": "calendar", "events": {"showNavEvent": {"description": "Fired after the CalendarNavigator is shown", "guessedname": "showNavEvent", "guessedtype": "property"}, "beforeDeselectEvent": {"description": "Fired before a selection is made", "guessedname": "beforeDeselectEvent", "guessedtype": "property"}, "beforeRenderNavEvent": {"description": "Fired just before the CalendarNavigator is to be rendered", "guessedname": "beforeRenderNavEvent", "guessedtype": "property"}, "beforeHideNavEvent": {"description": "Fired just before the CalendarNavigator is to be hidden", "guessedname": "beforeHideNavEvent", "guessedtype": "property"}, "hideEvent": {"description": "Fired after the CalendarGroup is hidden", "guessedname": "hideEvent", "guessedtype": "property"}, "hideNavEvent": {"description": "Fired after the CalendarNavigator is hidden", "guessedname": "hideNavEvent", "guessedtype": "property"}, "renderNavEvent": {"description": "Fired after the CalendarNavigator is rendered", "guessedname": "renderNavEvent", "guessedtype": "property"}, "beforeRenderEvent": {"description": "Fired before the Calendar is rendered", "guessedname": "beforeRenderEvent", "guessedtype": "property"}, "beforeShowEvent": {"description": "Fired just before the CalendarGroup is to be shown", "guessedname": "beforeShowEvent", "guessedtype": "property"}, "beforeSelectEvent": {"description": "Fired before a selection is made", "guessedname": "beforeSelectEvent", "guessedtype": "property"}, "renderEvent": {"description": "Fired when the Calendar is rendered", "guessedname": "renderEvent", "guessedtype": "property"}, "changePageEvent": {"description": "Fired when the Calendar page is changed", "guessedname": "changePageEvent", "guessedtype": "property"}, "resetEvent": {"description": "Fired when the Calendar is reset", "guessedname": "resetEvent", "guessedtype": "property"}, "clearEvent": {"description": "Fired when the Calendar is cleared", "guessedname": "clearEvent", "guessedtype": "property"}, "showEvent": {"description": "Fired after the CalendarGroup is shown", "guessedname": "showEvent", "guessedtype": "property"}, "beforeDestroyEvent": {"description": "Fired just before the CalendarGroup is to be destroyed", "guessedname": "beforeDestroyEvent", "guessedtype": "property"}, "destroyEvent": {"description": "Fired after the CalendarGroup is destroyed. This event should be used\nfor notification only. When this event is fired, important CalendarGroup instance\nproperties, dom references and event listeners have already been \nremoved\/dereferenced, and hence the CalendarGroup instance is not in a usable \nstate.", "guessedname": "destroyEvent", "guessedtype": "property"}, "selectEvent": {"params": [{"type": "Array", "name": "Array", "description": " of Date field arrays in the format [YYYY, MM, DD]."}], "description": "Fired when a selection is made", "guessedname": "selectEvent", "guessedtype": "property"}, "beforeHideEvent": {"description": "Fired just before the CalendarGroup is to be hidden", "guessedname": "beforeHideEvent", "guessedtype": "property"}, "beforeShowNavEvent": {"description": "Fired just before the CalendarNavigator is to be shown", "guessedname": "beforeShowNavEvent", "guessedtype": "property"}, "deselectEvent": {"params": [{"type": "Array", "name": "Array", "description": " of Date field arrays in the format [YYYY, MM, DD]."}], "description": "Fired when a selection is made", "guessedname": "deselectEvent", "guessedtype": "property"}}, "methods": {"deselectCell": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "Number", "name": "cellIndex", "description": "\tThe index of the cell to deselect."}], "description": "Deselects dates in the CalendarGroup based on the cell index provided. This method is used to select cells without having to do a full render. The selected style is applied to the cells directly.\ndeselectCell will deselect the cell at the specified index on each displayed Calendar page.", "guessedname": "deselectCell", "guessedtype": "function"}, "addWeekdayRenderer": {"params": [{"type": "Number", "name": "weekday", "description": "\t\tThe weekday (1-7) to associate with this renderer. 1=Sunday, 2=Monday etc."}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a weekday to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the weekday passed to this method.", "guessedname": "addWeekdayRenderer", "guessedtype": "function"}, "render": {"description": "Calls the render function of all child calendars within the group.", "guessedname": "render", "guessedtype": "function"}, "nextYear": {"description": "Navigates to the next year in the currently selected month in the calendar widget.", "guessedname": "nextYear", "guessedtype": "function"}, "delegateConfig": {"params": [{"type": "String", "name": "type", "description": "\tThe CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": "\tThe CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": "\tThe scope object. For configuration handlers, this will usually equal the owner."}], "description": "Delegates a configuration property to the CustomEvents associated with the CalendarGroup's children", "guessedname": "delegateConfig", "guessedtype": "function"}, "configPages": {"params": [{"type": "String", "name": "type", "description": "\tThe CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": "\tThe CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": "\tThe scope object. For configuration handlers, this will usually equal the owner."}], "description": "The default Config handler for the \"pages\" property", "guessedname": "configPages", "guessedtype": "function"}, "subtractYears": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of years to subtract from the current calendar"}], "description": "Subtcats the designated number of years from the current calendar, and sets the current\ncalendar page date to the new month.", "guessedname": "subtractYears", "guessedtype": "function"}, "previousMonth": {"description": "Navigates to the previous month page in the calendar widget.", "guessedname": "previousMonth", "guessedtype": "function"}, "select": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "String\/Date\/Date[]", "name": "date", "description": "\tThe date string of dates to select in the current calendar. Valid formats are\nindividual date(s) (12\/24\/2005,12\/26\/2005) or date range(s) (12\/24\/2005-1\/1\/2006).\nMultiple comma-delimited dates can also be passed to this method (12\/24\/2005,12\/11\/2005-12\/13\/2005).\nThis method can also take a JavaScript Date object or an array of Date objects."}], "description": "Selects a date or a collection of dates on the current calendar. This method, by default,\ndoes not call the render method explicitly. Once selection has completed, render must be \ncalled for the changes to be reflected visually.", "guessedname": "select", "guessedtype": "function"}, "callChildFunction": {"params": [{"type": "String", "name": "fnName", "description": "\t\tThe name of the function"}, {"type": "Array", "name": "args", "description": "\t\tThe arguments to pass to the function"}], "description": "Calls a function within all child Calendars within this CalendarGroup.", "guessedname": "callChildFunction", "guessedtype": "function"}, "deselect": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "String\/Date\/Date[]", "name": "date", "description": "\tThe date string of dates to deselect in the current calendar. Valid formats are\nindividual date(s) (12\/24\/2005,12\/26\/2005) or date range(s) (12\/24\/2005-1\/1\/2006).\nMultiple comma-delimited dates can also be passed to this method (12\/24\/2005,12\/11\/2005-12\/13\/2005).\nThis method can also take a JavaScript Date object or an array of Date objects."}], "description": "Deselects a date or a collection of dates on the current calendar. This method, by default,\ndoes not call the render method explicitly. Once deselection has completed, render must be \ncalled for the changes to be reflected visually.", "guessedname": "deselect", "guessedtype": "function"}, "sub": {"guessedname": "sub", "params": [{"type": "Function", "name": "fn", "description": "\tThe function to subscribe to this CustomEvent"}, {"type": "Object", "name": "obj", "description": "\tThe CustomEvent's scope object"}, {"type": "Boolean", "name": "bOverride", "description": "\tWhether or not to apply scope correction"}], "description": "Proxy subscriber to subscribe to the CalendarGroup's child Calendars' CustomEvents", "private": "", "guessedtype": "function"}, "initEvents": {"description": "Initializes CalendarGroup's built-in CustomEvents", "guessedname": "initEvents", "guessedtype": "function"}, "previousYear": {"description": "Navigates to the previous year in the currently selected month in the calendar widget.", "guessedname": "previousYear", "guessedtype": "function"}, "nextMonth": {"description": "Navigates to the next month page in the calendar widget.", "guessedname": "nextMonth", "guessedtype": "function"}, "configPageDate": {"params": [{"type": "String", "name": "type", "description": "\tThe CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": "\tThe CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": "\tThe scope object. For configuration handlers, this will usually equal the owner."}], "description": "The default Config handler for the \"pagedate\" property", "guessedname": "configPageDate", "guessedtype": "function"}, "setChildFunction": {"params": [{"type": "String", "name": "fnName", "description": "\t\tThe name of the function"}, {"type": "Function", "name": "fn", "description": "\t\t\tThe function to apply to each Calendar page object"}], "description": "Adds a function to all child Calendars within this CalendarGroup.", "guessedname": "setChildFunction", "guessedtype": "function"}, "addMonthRenderer": {"params": [{"type": "Number", "name": "month", "description": "\t\tThe month (1-12) to associate with this renderer"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a month to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the month passed to this method.", "guessedname": "addMonthRenderer", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "id", "description": " optional The id of the table element that will represent the CalendarGroup widget. As of 2.4.0, this argument is optional."}, {"type": "String | HTMLElement", "name": "container", "description": " The id of the container div element that will wrap the CalendarGroup table, or a reference to a DIV element which exists in the document."}, {"type": "Object", "name": "config", "description": " optional The configuration object containing the initial configuration values for the CalendarGroup."}], "description": "Initializes the calendar group. All subclasses must call this method in order for the\ngroup to be initialized properly.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "A string representation of the CalendarGroup object."}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "_setMonthOnDate": {"guessedname": "_setMonthOnDate", "params": [{"type": "Date", "name": "date", "description": "\tThe Date object on which to set the month index"}, {"type": "Number", "name": "iMonth", "description": "\tThe month index to set"}], "description": "Sets the month on a Date object, taking into account year rollover if the month is less than 0 or greater than 11.\nThe Date object passed in is modified. It should be cloned before passing it into this method if the original value needs to be maintained", "private": "", "guessedtype": "function"}, "removeRenderers": {"description": "Removes all custom renderers added to the CalendarGroup through the addRenderer, addMonthRenderer and \naddWeekRenderer methods. CalendarGroup's render method needs to be called to after removing renderers \nto see the changes applied.", "guessedname": "removeRenderers", "guessedtype": "function"}, "selectCell": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "Number", "name": "cellIndex", "description": "\tThe index of the cell to be selected."}], "description": "Selects dates in the CalendarGroup based on the cell index provided. This method is used to select cells without having to do a full render. The selected style is applied to the cells directly.\nThe value of the MULTI_SELECT Configuration attribute will determine the set of dates which get selected. \n<ul>\n<li>If MULTI_SELECT is false, selectCell will select the cell at the specified index for only the last displayed Calendar page.<\/li>\n<li>If MULTI_SELECT is true, selectCell will select the cell at the specified index, on each displayed Calendar page.<\/li>\n<\/ul>", "guessedname": "selectCell", "guessedtype": "function"}, "renderFooter": {"description": "Renders a footer for the 2-up calendar container. By default, this method is\nunimplemented.", "guessedname": "renderFooter", "guessedtype": "function"}, "configSelected": {"params": [{"type": "String", "name": "type", "description": "\tThe CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": "\tThe CustomEvent arguments. For configuration handlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": "\tThe scope object. For configuration handlers, this will usually equal the owner."}], "description": "The default Config handler for the CalendarGroup \"selected\" property", "guessedname": "configSelected", "guessedtype": "function"}, "_fixWidth": {"private": "", "description": "Fixes the width of the CalendarGroup container element, to account for miswrapped floats", "guessedname": "_fixWidth", "guessedtype": "function"}, "destroy": {"description": "Destroys the CalendarGroup instance. The method will remove references\nto HTML elements, remove any event listeners added by the CalendarGroup.\nIt will also destroy the Config and CalendarNavigator instances created by the \nCalendarGroup and the individual Calendar instances created for each page.", "guessedname": "destroy", "guessedtype": "function"}, "unsub": {"guessedname": "unsub", "params": [{"type": "Function", "name": "fn", "description": "\tThe function to subscribe to this CustomEvent"}, {"type": "Object", "name": "obj", "description": "\tThe CustomEvent's scope object"}], "description": "Proxy unsubscriber to unsubscribe from the CalendarGroup's child Calendars' CustomEvents", "private": "", "guessedtype": "function"}, "getSelectedDates": {"type": "Date[]", "return": {"type": "", "description": "An array of currently selected JavaScript Date objects."}, "description": "Gets the list of currently selected dates from the calendar.", "guessedname": "getSelectedDates", "guessedtype": "function"}, "addRenderer": {"params": [{"type": "String", "name": "sDates", "description": "\t\tA date string to associate with the specified renderer. Valid formats\ninclude date (12\/24\/2005), month\/day (12\/24), and range (12\/1\/2004-1\/1\/2005)"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a renderer to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the conditions specified in the date string for this renderer.", "guessedname": "addRenderer", "guessedtype": "function"}, "reset": {"description": "Resets the calendar widget to the originally selected month and year, and \nsets the calendar to the initial selection(s).", "guessedname": "reset", "guessedtype": "function"}, "deselectAll": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected.\nAssuming that this function executes properly, the return value should be an empty array.\nHowever, the empty array is returned for the sake of being able to check the selection status\nof the calendar."}, "description": "Deselects all dates on the current calendar.", "guessedname": "deselectAll", "guessedtype": "function"}, "setMonth": {"params": [{"type": "Number", "name": "month", "description": "\t\tThe numeric month, from 0 (January) to 11 (December)"}], "description": "Sets the calendar group's month explicitly. This month will be set into the first\npage of the multi-page calendar, and all other months will be iterated appropriately.", "guessedname": "setMonth", "guessedtype": "function"}, "clear": {"description": "Clears the selected dates in the current calendar widget and sets the calendar\nto the current month and year.", "guessedname": "clear", "guessedtype": "function"}, "getCalendarPage": {"return": {"type": "Calendar", "description": "The Calendar page instance representing the month to which the date \nbelongs."}, "params": [{"type": "Date", "name": "date", "description": " The JavaScript Date object for which a Calendar page is to be found."}], "description": "Returns the Calendar page instance which has a pagedate (month\/year) matching the given date. \nReturns null if no match is found.", "guessedname": "getCalendarPage", "guessedtype": "function"}, "addMonths": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of months to add to the current calendar"}], "description": "Adds the designated number of months to the current calendar month, and sets the current\ncalendar page date to the new month.", "guessedname": "addMonths", "guessedtype": "function"}, "subtractMonths": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of months to subtract from the current calendar"}], "description": "Subtracts the designated number of months from the current calendar month, and sets the current\ncalendar page date to the new month.", "guessedname": "subtractMonths", "guessedtype": "function"}, "constructChild": {"return": {"type": "YAHOO.widget.Calendar", "description": "The YAHOO.widget.Calendar instance that is constructed"}, "params": [{"type": "String", "name": "id", "description": "\t\t\tThe id of the table element that will represent the calendar widget"}, {"type": "String", "name": "containerId", "description": "\tThe id of the container div element that will wrap the calendar table"}, {"type": "Object", "name": "config", "description": "\t\tThe configuration object containing the Calendar's arguments"}], "description": "Constructs a child calendar. This method can be overridden if a subclassed version of the default\ncalendar is to be used.", "guessedname": "constructChild", "guessedtype": "function"}, "setYear": {"params": [{"type": "Number", "name": "year", "description": "\t\tThe numeric 4-digit year"}], "description": "Sets the calendar group's year explicitly. This year will be set into the first\npage of the multi-page calendar, and all other months will be iterated appropriately.", "guessedname": "setYear", "guessedtype": "function"}, "renderHeader": {"description": "Renders the header for the CalendarGroup.", "guessedname": "renderHeader", "guessedtype": "function"}, "addYears": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of years to add to the current calendar"}], "description": "Adds the designated number of years to the current calendar, and sets the current\ncalendar page date to the new month.", "guessedname": "addYears", "guessedtype": "function"}}, "file": "CalendarGroup.js", "shortname": "CalendarGroup", "properties": {"YAHOO.widget.CalendarGroup.CSS_2UPCLOSE": {"description": "CSS class representing the close icon for the 2-up calendar", "deprecated": "Along with Calendar.IMG_ROOT and NAV_ARROW_LEFT, NAV_ARROW_RIGHT configuration properties.\nCalendar's <a href=\"YAHOO.widget.Calendar.html#Style.CSS_CLOSE\">Style.CSS_CLOSE<\/a> property now represents the CSS class used to render the close icon", "static": "", "guessedname": "CSS_2UPCLOSE", "guessedtype": "property", "type": "String", "final": ""}, "containerId": {"type": "String", "description": "The unique id associated with the CalendarGroup container", "guessedname": "containerId", "guessedtype": "property"}, "Locale": {"type": "Object", "description": "The local object which contains the CalendarGroup's locale settings", "guessedname": "Locale", "guessedtype": "property"}, "cfg": {"type": "YAHOO.util.Config", "description": "The Config object used to hold the configuration variables for the CalendarGroup", "guessedname": "cfg", "guessedtype": "property"}, "YAHOO.widget.CalendarGroup.CSS_2UPTITLE": {"description": "CSS class representing the title for the 2-up calendar", "static": "", "guessedname": "CSS_2UPTITLE", "guessedtype": "property", "type": "String", "final": ""}, "Options": {"type": "Object", "description": "The local object which contains the CalendarGroup's options", "guessedname": "Options", "guessedtype": "property"}, "YAHOO.widget.CalendarGroup.CSS_CONTAINER": {"description": "CSS class representing the container for the calendar", "static": "", "guessedname": "CSS_CONTAINER", "guessedtype": "property", "type": "String", "final": ""}, "id": {"type": "String", "description": "The unique id associated with the CalendarGroup", "guessedname": "id", "guessedtype": "property"}, "YAHOO.widget.CalendarGroup.CSS_MULTI_UP": {"description": "CSS class representing the container for the calendar", "static": "", "guessedname": "CSS_MULTI_UP", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.CalendarGroup._DEFAULT_CONFIG": {"description": "The set of default Config property keys and values for the CalendarGroup", "private": "", "static": "", "guessedname": "_DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "pages": {"type": "YAHOO.widget.Calendar[]", "description": "The collection of Calendar pages contained within the CalendarGroup", "guessedname": "pages", "guessedtype": "property"}}, "description": "YAHOO.widget.CalendarGroup is a special container class for YAHOO.widget.Calendar. This class facilitates\nthe ability to have multi-page calendar views that share a single dataset and are\ndependent on each other.\nThe calendar group instance will refer to each of its elements using a 0-based index.\nFor example, to construct the placeholder for a calendar group widget with id \"cal1\" and\ncontainerId of \"cal1Container\", the markup would be as follows:\n<xmp>\n<div id=\"cal1Container_0\"><\/div>\n<div id=\"cal1Container_1\"><\/div>\n<\/xmp>\nThe tables for the calendars (\"cal1_0\" and \"cal1_1\") will be inserted into those containers.\n<p>\n<strong>NOTE: As of 2.4.0, the constructor's ID argument is optional.<\/strong>\nThe CalendarGroup can be constructed by simply providing a container ID string, \nor a reference to a container DIV HTMLElement (the element needs to exist \nin the document).\nE.g.:\n<xmp>\nvar c = new YAHOO.widget.CalendarGroup(\"calContainer\", configOptions);\n<\/xmp>\nor:\n<xmp>\nvar containerDiv = YAHOO.util.Dom.get(\"calContainer\");\nvar c = new YAHOO.widget.CalendarGroup(containerDiv, configOptions);\n<\/xmp>\n<\/p>\n<p>\nIf not provided, the ID will be generated from the container DIV ID by adding an \"_t\" suffix.\nFor example if an ID is not provided, and the container's ID is \"calContainer\", the CalendarGroup's ID will be set to \"calContainer_t\".\n<\/p>"}, "YAHOO.widget.CategoryAxis": {"name": "YAHOO.widget.CategoryAxis", "constructors": [{"description": "A type of axis that displays items in categories."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "CategoryAxis", "file": "CategoryAxis.js", "guessedtype": "function", "shortname": "CategoryAxis", "properties": {"categoryNames": {"type": "Array", "description": "A list of category names to display along this axis.", "guessedname": "categoryNames", "guessedtype": "property"}}, "description": "A type of axis that displays items in categories."}, "YAHOO.util.Assert": {"name": "YAHOO.util.Assert", "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "Assert", "methods": {"isTrue": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is true. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isTrue", "guessedtype": "function"}, "isFalse": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is false. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isFalse", "guessedtype": "function"}, "isNotNull": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not null. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNotNull", "guessedtype": "function"}, "fail": {"static": "", "params": [{"type": "String", "name": "message", "description": " (Optional) The message to display with the failure."}], "description": "Forces an assertion error to occur.", "guessedname": "fail", "guessedtype": "function"}, "isFunction": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a function.", "guessedname": "isFunction", "guessedtype": "function"}, "isNaN": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not a number.", "guessedname": "isNaN", "guessedtype": "function"}, "isBoolean": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a Boolean.", "guessedname": "isBoolean", "guessedtype": "function"}, "areNotSame": {"static": "", "params": [{"type": "Object", "name": "unexpected", "description": " The unexpected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not the same as another. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "areNotSame", "guessedtype": "function"}, "isNotNaN": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not the special NaN value.", "guessedname": "isNotNaN", "guessedtype": "function"}, "areNotEqual": {"static": "", "params": [{"type": "Object", "name": "unexpected", "description": " The unexpected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not equal to another. This uses the double equals sign\nso type cohersion may occur.", "guessedname": "areNotEqual", "guessedtype": "function"}, "areSame": {"static": "", "params": [{"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is the same as another. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "areSame", "guessedtype": "function"}, "isUndefined": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is undefined. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isUndefined", "guessedtype": "function"}, "isArray": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an array.", "guessedname": "isArray", "guessedtype": "function"}, "isTypeOf": {"static": "", "params": [{"type": "String", "name": "expectedType", "description": " The expected type of the variable."}, {"type": "Object", "name": "actualValue", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is of a particular type.", "guessedname": "isTypeOf", "guessedtype": "function"}, "_formatMessage": {"return": {"type": "String", "description": "The final error message, containing either or both."}, "description": "Formats a message so that it can contain the original assertion message\nin addition to the custom message.", "protected": "", "static": "", "guessedname": "_formatMessage", "guessedtype": "function", "params": [{"type": "String", "name": "customMessage", "description": " The message passed in by the developer."}, {"type": "String", "name": "defaultMessage", "description": " The message created by the error by default."}]}, "areEqual": {"static": "", "params": [{"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is equal to another. This uses the double equals sign\nso type cohersion may occur.", "guessedname": "areEqual", "guessedtype": "function"}, "isNumber": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a number.", "guessedname": "isNumber", "guessedtype": "function"}, "isObject": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an object.", "guessedname": "isObject", "guessedtype": "function"}, "isString": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is a string.", "guessedname": "isString", "guessedtype": "function"}, "isNotUndefined": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not undefined. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNotUndefined", "guessedtype": "function"}, "isNull": {"static": "", "params": [{"type": "Object", "name": "actual", "description": " The actual value to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is null. This uses the triple equals sign\nso no type cohersion may occur.", "guessedname": "isNull", "guessedtype": "function"}, "isInstanceOf": {"static": "", "params": [{"type": "Function", "name": "expected", "description": " The function that the object should be an instance of."}, {"type": "Object", "name": "actual", "description": " The object to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is an instance of a particular object. This may return\nincorrect results when comparing objects from one frame to constructors in\nanother frame. For best results, don't use in a cross-frame manner.", "guessedname": "isInstanceOf", "guessedtype": "function"}}, "static": "", "file": "Assert.js", "guessedtype": "property", "shortname": "Assert", "description": "The Assert object provides functions to test JavaScript values against\nknown and expected results. Whenever a comparison (assertion) fails,\nan error is thrown."}, "YAHOO.widget.LogMsg": {"name": "YAHOO.widget.LogMsg", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " Object literal of configuration params."}], "description": "The LogMsg class defines a single log message."}], "namespace": "YAHOO.widget", "module": "logger", "guessedname": "LogMsg", "file": "LogMsg.js", "guessedtype": "function", "shortname": "LogMsg", "properties": {"msg": {"type": "String", "description": "Log message.", "guessedname": "msg", "guessedtype": "property"}, "category": {"type": "String", "description": "Log category.", "guessedname": "category", "guessedtype": "property"}, "sourceDetail": {"type": "String", "description": "Log source detail. The remainder of the string passed in as the source argument, not\nincluding the first word (if any).", "guessedname": "sourceDetail", "guessedtype": "property"}, "source": {"type": "String", "description": "Log source. The first word passed in as the source argument.", "guessedname": "source", "guessedtype": "property"}, "time": {"type": "Date", "description": "Log timestamp.", "guessedname": "time", "guessedtype": "property"}}, "description": "The LogMsg class defines a single log message."}, "YAHOO.widget.DropdownCellEditor": {"name": "YAHOO.widget.DropdownCellEditor", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The DropdownCellEditor class provides functionality for inline editing\nDataTable cell data a SELECT element."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "DropdownCellEditor", "methods": {"renderForm": {"description": "Render a form with select element.", "guessedname": "renderForm", "guessedtype": "function"}, "handleDisabledBtns": {"description": "After rendering form, if disabledBtns is set to true, then sets up a mechanism\nto save input without them.", "guessedname": "handleDisabledBtns", "guessedtype": "function"}, "getInputValue": {"description": "Retrieves input value from DropdownCellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}, "focus": {"description": "Sets focus in DropdownCellEditor.", "guessedname": "focus", "guessedtype": "function"}, "resetForm": {"description": "Resets DropdownCellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}}, "extends": "YAHOO.widget.BaseCellEditor", "superclass": "YAHOO.widget.BaseCellEditor", "file": "CellEditor.js", "guessedtype": "function", "shortname": "DropdownCellEditor", "properties": {"dropdownOptions": {"type": "String[] | Object[]", "description": "Array of dropdown values. Can either be a simple array (e.g., \n[\"Alabama\",\"Alaska\",\"Arizona\",\"Arkansas\"]) or a an array of objects (e.g., \n[{label:\"Alabama\", value:\"AL\"}, {label:\"Alaska\", value:\"AK\"},\n{label:\"Arizona\", value:\"AZ}, {label:\"Arkansas\", value:\"AR}]).", "guessedname": "dropdownOptions", "guessedtype": "property"}, "dropdown": {"type": "HTMLElement", "description": "Reference to Dropdown element.", "guessedname": "dropdown", "guessedtype": "property"}}, "description": "The DropdownCellEditor class provides functionality for inline editing\nDataTable cell data a SELECT element."}, "YAHOO.widget.TextboxCellEditor": {"name": "YAHOO.widget.TextboxCellEditor", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The TextboxCellEditor class provides functionality for inline editing\nDataTable cell data with an INPUT TYPE=TEXT element."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "TextboxCellEditor", "methods": {"renderForm": {"description": "Render a form with input type=text.", "guessedname": "renderForm", "guessedtype": "function"}, "move": {"description": "Moves TextboxCellEditor UI to a cell.", "guessedname": "move", "guessedtype": "function"}, "getInputValue": {"description": "Returns new value for TextboxCellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}, "focus": {"description": "Sets focus in TextboxCellEditor.", "guessedname": "focus", "guessedtype": "function"}, "resetForm": {"description": "Resets TextboxCellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}}, "extends": "YAHOO.widget.BaseCellEditor", "superclass": "YAHOO.widget.BaseCellEditor", "file": "CellEditor.js", "guessedtype": "function", "shortname": "TextboxCellEditor", "properties": {"DataTable.Editors": {"type": "Object", "static": "", "description": "CellEditor subclasses.", "guessedname": "Editors", "guessedtype": "property"}, "textbox": {"description": "Reference to the textbox element.", "guessedname": "textbox", "guessedtype": "property"}}, "description": "The TextboxCellEditor class provides functionality for inline editing\nDataTable cell data with an INPUT TYPE=TEXT element."}, "YAHOO.widget.Paginator.ui.CurrentPageReport": {"properties": {"span": {"guessedname": "span", "type": "HTMLElement", "description": "Span node containing the formatted info", "private": "", "guessedtype": "property"}}, "name": "YAHOO.widget.Paginator.ui.CurrentPageReport", "for": "YAHOO.widget.Paginator", "innerClasses": ["YAHOO.widget.Paginator"], "constructors": [{"params": [{"type": "Pagintor", "name": "p", "description": " Paginator instance to attach to"}], "description": "ui Component to generate the textual report of current pagination status.\nE.g. \"Now viewing page 1 of 13\"."}], "namespace": "YAHOO.widget.Paginator.ui", "module": "paginator", "events": {"pageReportTemplateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageReportTemplateChange", "description": "Fires when the value for the configuration attribute 'pageReportTemplate' changes."}, "beforePageReportValueGenaratorChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageReportValueGenaratorChange", "description": "Fires before the value for the configuration attribute 'pageReportValueGenarator' changes. Return false to cancel the attribute change."}, "beforePageReportClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageReportClassChange", "description": "Fires before the value for the configuration attribute 'pageReportClass' changes. Return false to cancel the attribute change."}, "pageReportValueGenaratorChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageReportValueGenaratorChange", "description": "Fires when the value for the configuration attribute 'pageReportValueGenarator' changes."}, "beforePageReportTemplateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageReportTemplateChange", "description": "Fires before the value for the configuration attribute 'pageReportTemplate' changes. Return false to cancel the attribute change."}, "pageReportClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageReportClassChange", "description": "Fires when the value for the configuration attribute 'pageReportClass' changes."}}, "guessedname": "CurrentPageReport", "methods": {"destroy": {"private": "", "description": "Removes the link\/span node and clears event listeners\nremoval.", "guessedname": "destroy", "guessedtype": "function"}, "init": {"static": "", "params": [{"type": "Paginator", "name": "p", "description": " Paginator instance to decorate"}], "description": "Decorates Paginator instances with new attributes. Called during\nPaginator instantiation.", "guessedname": "init", "guessedtype": "function"}, "sprintf": {"return": {"type": "string", "description": ""}, "description": "Replace place holders in a string with the named values found in an\nobject literal.", "static": "", "guessedname": "sprintf", "guessedtype": "function", "params": [{"type": "string", "name": "template", "description": " The content string containing place holders"}, {"type": "object", "name": "values", "description": " The key:value pairs used to replace the place holders"}]}, "render": {"return": {"type": "HTMLElement", "description": ""}, "params": [{"type": "string", "name": "id_base", "description": " used to create unique ids for generated nodes"}], "description": "Generate the span containing info formatted per the pageReportTemplate\nattribute.", "guessedname": "render", "guessedtype": "function"}, "update": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event"}], "description": "Regenerate the content of the span if appropriate. Calls\nCurrentPageReport.sprintf with the value of the pageReportTemplate\nattribute and the value map returned from pageReportValueGenerator\nfunction.", "guessedname": "update", "guessedtype": "function"}}, "file": "CurrentPageReport.js", "guessedtype": "function", "shortname": "CurrentPageReport", "configs": {"pageReportValueGenarator": {"description": "Function to generate the value map used to populate the\npageReportTemplate. The function is passed the Paginator instance as a\nparameter. The default function returns a map with the following keys:\n<ul>\n<li>currentPage<\/li>\n<li>totalPages<\/li>\n<li>startIndex<\/li>\n<li>endIndex<\/li>\n<li>startRecord<\/li>\n<li>endRecord<\/li>\n<li>totalRecords<\/li>\n<\/ul>"}, "pageReportClass": {"default": "'yui-pg-current'", "description": "CSS class assigned to the span containing the info."}, "pageReportTemplate": {"default": "'({currentPage} of {totalPages})'", "see": "pageReportValueGenerator attribute", "description": "Used as innerHTML for the span. Place holders in the form of {name}\nwill be replaced with the so named value from the key:value map\ngenerated by the function held in the pageReportValueGenerator attribute."}}, "description": "ui Component to generate the textual report of current pagination status.\nE.g. \"Now viewing page 1 of 13\"."}, "YAHOO.util.Bezier": {"name": "YAHOO.util.Bezier", "namespace": "YAHOO.util", "module": "animation", "guessedname": "Bezier", "methods": {"getPosition": {"return": {"type": "Array", "description": "An array containing int x and y member data"}, "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"}], "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.", "guessedname": "getPosition", "guessedtype": "function"}}, "file": "Bezier.js", "guessedtype": "function", "shortname": "Bezier", "description": "Used to calculate Bezier splines for any number of control points."}, "YAHOO.util.Subscriber": {"name": "YAHOO.util.Subscriber", "constructors": [{"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": "boolean", "name": "override", "description": " If true, the obj passed in becomes the execution\nscope of the listener"}], "description": "Stores the subscriber information to be used when the event fires."}], "namespace": "YAHOO.util", "module": "event", "guessedname": "Subscriber", "methods": {"getScope": {"params": [{"type": "Object", "name": "defaultScope", "description": " the scope to use if this listener does not\noverride it."}], "description": "Returns the execution scope for this listener. If override was set to true\nthe custom obj will be the scope. If override is an object, that is the\nscope, otherwise the default scope will be used.", "guessedname": "getScope", "guessedtype": "function"}, "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"}}, "file": "CustomEvent.js", "guessedtype": "function", "shortname": "Subscriber", "properties": {"override": {"type": "boolean|object", "description": "The default execution scope for the event listener is defined when the\nevent is created (usually the object which contains the event).\nBy setting override to true, the execution scope becomes the custom\nobject passed in by the subscriber. If override is an object, that \nobject becomes the scope.", "guessedname": "override", "guessedtype": "property"}, "obj": {"type": "object", "description": "An optional custom object that will passed to the callback when\nthe event fires", "guessedname": "obj", "guessedtype": "property"}, "fn": {"type": "function", "description": "The callback that will be execute when the event fires", "guessedname": "fn", "guessedtype": "property"}}, "description": "Stores the subscriber information to be used when the event fires."}, "YAHOO.widget.Paginator.ui.PageLinks": {"properties": {"current": {"guessedname": "current", "type": "number", "description": "Current page", "private": "", "guessedtype": "property"}, "container": {"guessedname": "container", "type": "HTMLElement", "description": "Span node containing the page links", "private": "", "guessedtype": "property"}}, "name": "YAHOO.widget.Paginator.ui.PageLinks", "for": "YAHOO.widget.Paginator", "innerClasses": ["YAHOO.widget.Paginator"], "constructors": [{"params": [{"type": "Pagintor", "name": "p", "description": " Paginator instance to attach to"}], "description": "ui Component to generate the page links"}], "namespace": "YAHOO.widget.Paginator.ui", "module": "paginator", "events": {"currentPageClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "currentPageClassChange", "description": "Fires when the value for the configuration attribute 'currentPageClass' changes."}, "pageLabelBuilderChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageLabelBuilderChange", "description": "Fires when the value for the configuration attribute 'pageLabelBuilder' changes."}, "beforePageLinksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageLinksChange", "description": "Fires before the value for the configuration attribute 'pageLinks' changes. Return false to cancel the attribute change."}, "beforeCurrentPageClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCurrentPageClassChange", "description": "Fires before the value for the configuration attribute 'currentPageClass' changes. Return false to cancel the attribute change."}, "beforePageLabelBuilderChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageLabelBuilderChange", "description": "Fires before the value for the configuration attribute 'pageLabelBuilder' changes. Return false to cancel the attribute change."}, "beforePageLinksContainerClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageLinksContainerClassChange", "description": "Fires before the value for the configuration attribute 'pageLinksContainerClass' changes. Return false to cancel the attribute change."}, "pageLinksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageLinksChange", "description": "Fires when the value for the configuration attribute 'pageLinks' changes."}, "pageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageLinkClassChange", "description": "Fires when the value for the configuration attribute 'pageLinkClass' changes."}, "beforePageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePageLinkClassChange", "description": "Fires before the value for the configuration attribute 'pageLinkClass' changes. Return false to cancel the attribute change."}, "pageLinksContainerClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pageLinksContainerClassChange", "description": "Fires when the value for the configuration attribute 'pageLinksContainerClass' changes."}}, "guessedname": "PageLinks", "methods": {"render": {"return": {"type": "HTMLElement", "description": ""}, "params": [{"type": "string", "name": "id_base", "description": " used to create unique ids for generated nodes"}], "description": "Generate the nodes and return the container node containing page links\nappropriate to the current pagination state.", "guessedname": "render", "guessedtype": "function"}, "rebuild": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event"}], "description": "Force a rebuild of the page links.", "guessedname": "rebuild", "guessedtype": "function"}, "update": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event"}], "description": "Update the links if appropriate", "guessedname": "update", "guessedtype": "function"}, "init": {"static": "", "params": [{"type": "Paginator", "name": "p", "description": " Paginator instance to decorate"}], "description": "Decorates Paginator instances with new attributes. Called during\nPaginator instantiation.", "guessedname": "init", "guessedtype": "function"}, "onClick": {"params": [{"type": "DOMEvent", "name": "e", "description": " The click event"}], "description": "Listener for the container's onclick event. Looks for qualifying link\nclicks, and pulls the page number from the link's page attribute.\nSends link's page attribute to the Paginator's setPage method.", "guessedname": "onClick", "guessedtype": "function"}, "destroy": {"private": "", "description": "Removes the page links container node and clears event listeners", "guessedname": "destroy", "guessedtype": "function"}, "calculateRange": {"return": {"type": "Array", "description": "[start_page_number, end_page_number]"}, "description": "Calculates start and end page numbers given a current page, attempting\nto keep the current page in the middle", "static": "", "guessedname": "calculateRange", "guessedtype": "function", "params": [{"type": "int", "name": "currentPage", "description": " The current page"}, {"type": "int", "name": "totalPages", "description": " (optional) Maximum number of pages"}, {"type": "int", "name": "numPages", "description": " (optional) Preferred number of pages in range"}]}}, "file": "PageLinks.js", "guessedtype": "function", "shortname": "PageLinks", "configs": {"pageLinksContainerClass": {"default": "'yui-pg-pages'", "description": "CSS class assigned to the span containing the page links."}, "currentPageClass": {"default": "'yui-pg-current-page'", "description": "CSS class assigned to the current page span."}, "pageLabelBuilder": {"default": "function (page, paginator) { return page; }", "description": "Function used generate the innerHTML for each page link\/span. The\nfunction receives as parameters the page number and a reference to the\npaginator object."}, "pageLinks": {"default": "10", "description": "Maximum number of page links to display at one time."}, "pageLinkClass": {"default": "'yui-pg-page'", "description": "CSS class assigned to each page link\/span."}}, "description": "ui Component to generate the page links"}, "YAHOO.widget.MenuBar": {"name": "YAHOO.widget.MenuBar", "configs": {"position": {"default": "static", "type": "String", "description": "String indicating how a menu bar should be positioned on the \nscreen. Possible values are \"static\" and \"dynamic.\" Static menu bars \nare visible by default and reside in the normal flow of the document \n(CSS position: static). Dynamic menu bars are hidden by default, reside\nout of the normal flow of the document (CSS position: absolute), and can \noverlay other elements on the screen."}, "submenualignment": {"default": "[\"tl\",\"bl\"]", "type": "Array", "description": "Array defining how submenus should be aligned to their \nparent menu bar item. The format is: [itemCorner, submenuCorner]."}, "autosubmenudisplay": {"default": "false", "type": "Boolean", "description": "Boolean indicating if submenus are automatically made \nvisible when the user mouses over the menu bar's items."}, "submenutoggleregion": {"default": "false", "type": "Boolean", "description": "Boolean indicating if only a specific region of a MenuBarItem should toggle the \ndisplay of a submenu. The default width of the region is determined by the value of the\nSUBMENU_TOGGLE_REGION_WIDTH property. If set to true, the autosubmenudisplay \nconfiguration property will be set to false, and any click event listeners will not be \ncalled when the user clicks inside the submenu toggle region of a MenuBarItem. If the \nuser clicks outside of the submenu toggle region, the MenuBarItem will maintain its \nstandard behavior."}}, "constructors": [{"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the menu bar."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source for the \nmenu bar."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object specifying \nthe <code><div><\/code> element of the menu bar."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><select><\/code> element to be used as the data \nsource for the menu bar."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu bar. See configuration class documentation for\nmore details."}], "description": "Horizontal collection of items, each of which can contain a submenu."}], "namespace": "YAHOO.widget", "module": "menu", "guessedname": "MenuBar", "methods": {"configSubmenuToggle": {"params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event was fired."}], "description": "Event handler for when the \"submenutoggleregion\" configuration property of \na MenuBar changes.", "guessedname": "configSubmenuToggle", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the menu bar."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source for the \nmenu bar."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object specifying \nthe <code><div><\/code> element of the menu bar."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><select><\/code> element to be used as the data \nsource for the menu bar."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu bar. See configuration class documentation for\nmore details."}], "description": "The MenuBar class's initialization method. This method is \nautomatically called by the constructor, and sets up all DOM references for \npre-existing markup, and creates required markup if it is not already present.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the menu bar.", "guessedname": "toString", "guessedtype": "function"}, "_onClick": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuBar", "name": "p_oMenuBar", "description": " Object representing the menu bar \nthat fired the event."}], "description": "\"click\" event handler for the menu bar.", "guessedname": "_onClick", "guessedtype": "function"}, "checkPosition": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "Object", "name": "p_sPosition", "description": " String specifying the position of the menu."}], "description": "Checks to make sure that the value of the \"position\" property \nis one of the supported strings. Returns true if the position is supported.", "private": ""}, "_onKeyDown": {"guessedname": "_onKeyDown", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuBar", "name": "p_oMenuBar", "description": " Object representing the menu bar \nthat fired the event."}], "description": "\"keydown\" Custom Event handler for the menu bar.", "private": "", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be\nchanged using the menu bar's Config object (\"cfg\").", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "extends": "YAHOO.widget.Menu", "superclass": "YAHOO.widget.Menu", "file": "menubar.js", "guessedtype": "function", "shortname": "MenuBar", "properties": {"SUBMENU_TOGGLE_REGION_WIDTH": {"description": "Width (in pixels) of the area of a MenuBarItem that, when pressed, will toggle the\ndisplay of the MenuBarItem's submenu.", "default": "20", "guessedname": "SUBMENU_TOGGLE_REGION_WIDTH", "guessedtype": "property", "type": "Number", "final": ""}, "CSS_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied to the menu \nbar's <code><div><\/code> element.", "default": "\"yuimenubar\"", "guessedname": "CSS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Horizontal collection of items, each of which can contain a submenu."}, "YAHOO.env": {"name": "YAHOO.env", "namespace": "", "module": "yahoo", "guessedname": "env", "methods": {"getVersion": {"return": {"type": "Object", "description": "The version info"}, "description": "Returns the version data for the specified module:\n<dl>\n<dt>name:<\/dt> <dd>The name of the module<\/dd>\n<dt>version:<\/dt> <dd>The version in use<\/dd>\n<dt>build:<\/dt> <dd>The build number in use<\/dd>\n<dt>versions:<\/dt> <dd>All versions that were registered<\/dd>\n<dt>builds:<\/dt> <dd>All builds that were registered.<\/dd>\n<dt>mainClass:<\/dt> <dd>An object that was was stamped with the\ncurrent version and build. If \nmainClass.VERSION != version or mainClass.BUILD != build,\nmultiple versions of pieces of the library have been\nloaded, potentially causing issues.<\/dd>\n<\/dl>", "static": "", "guessedname": "getVersion", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " the name of the module (event, slider, etc)"}]}}, "static": "", "file": "Env.js", "guessedtype": "property", "shortname": "YAHOO.env", "properties": {"listeners": {"type": "Function[]", "description": "List of functions that should be executed every time a YUI module\nreports itself.", "guessedname": "listeners", "guessedtype": "property"}, "modules": {"type": "Object[]", "description": "Keeps the version info for all YUI modules that have reported themselves", "guessedname": "modules", "guessedtype": "property"}}, "description": "YAHOO.env is used to keep track of what is known about the YUI library and\nthe browsing environment"}, "YAHOO.util.ShouldFail": {"name": "YAHOO.util.ShouldFail", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "ShouldFail is subclass of AssertionError that is thrown whenever\na test was expected to fail but did not."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "ShouldFail", "extends": "YAHOO.util.AssertionError", "superclass": "YAHOO.util.AssertionError", "file": "Assert.js", "guessedtype": "function", "shortname": "ShouldFail", "properties": {"name": {"type": "String", "description": "The name of the error that occurred."}}, "description": "ShouldFail is subclass of AssertionError that is thrown whenever\na test was expected to fail but did not."}, "YAHOO.widget.TextareaCellEditor": {"name": "YAHOO.widget.TextareaCellEditor", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The TextareaCellEditor class provides functionality for inline editing\nDataTable cell data with a TEXTAREA element."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "TextareaCellEditor", "methods": {"move": {"description": "Moves TextareaCellEditor UI to a cell.", "guessedname": "move", "guessedtype": "function"}, "renderForm": {"description": "Render a form with textarea.", "guessedname": "renderForm", "guessedtype": "function"}, "handleDisabledBtns": {"description": "After rendering form, if disabledBtns is set to true, then sets up a mechanism\nto save input without them.", "guessedname": "handleDisabledBtns", "guessedtype": "function"}, "focus": {"description": "Sets focus in TextareaCellEditor.", "guessedname": "focus", "guessedtype": "function"}, "resetForm": {"description": "Resets TextareaCellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}, "getInputValue": {"description": "Retrieves input value from TextareaCellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}}, "extends": "YAHOO.widget.BaseCellEditor", "superclass": "YAHOO.widget.BaseCellEditor", "file": "CellEditor.js", "guessedtype": "function", "shortname": "TextareaCellEditor", "properties": {"textarea": {"type": "HTMLElement", "description": "Reference to textarea element.", "guessedname": "textarea", "guessedtype": "property"}}, "description": "The TextareaCellEditor class provides functionality for inline editing\nDataTable cell data with a TEXTAREA element."}, "YAHOO.widget.SliderThumb": {"name": "YAHOO.widget.SliderThumb", "constructors": [{"params": [{"type": "String", "name": "id", "description": " the id of the slider html element"}, {"type": "String", "name": "sGroup", "description": " the group of related DragDrop items"}, {"type": "int", "name": "iLeft", "description": " the number of pixels the element can move left"}, {"type": "int", "name": "iRight", "description": " the number of pixels the element can move right"}, {"type": "int", "name": "iUp", "description": " the number of pixels the element can move up"}, {"type": "int", "name": "iDown", "description": " the number of pixels the element can move down"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the element \nshould move a certain number pixels at a time."}], "description": "A drag and drop implementation to be used as the thumb of a slider."}], "namespace": "YAHOO.widget", "module": "slider", "guessedname": "SliderThumb", "methods": {"onChange": {"private": "", "description": "The onchange event for the handle\/thumb is delegated to the YAHOO.widget.Slider\ninstance it belongs to.", "guessedname": "onChange", "guessedtype": "function"}, "getValue": {"return": {"type": "int", "description": "the number of pixels (positive or negative) the\nslider has moved from the start position."}, "description": "Gets the current offset from the element's start position in\npixels.", "guessedname": "getValue", "guessedtype": "function"}, "getOffsetFromParent": {"type": "[int, int]", "params": [{"type": "[int, int]", "name": "parentPos", "description": " Optionally accepts the position of the parent"}], "description": "Returns the difference between the location of the thumb and its parent.", "guessedname": "getOffsetFromParent0", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "string representation of the instance"}, "description": "Thumb toString", "guessedname": "toString", "guessedtype": "function"}, "getYValue": {"return": {"type": "int", "description": "the number of pixels (positive or negative) the\nslider has moved vertically from the start position."}, "description": "Gets the current Y offset from the element's start position in\npixels.", "guessedname": "getYValue", "guessedtype": "function"}, "initSlider": {"params": [{"type": "int", "name": "iLeft", "description": " the number of pixels the element can move left"}, {"type": "int", "name": "iRight", "description": " the number of pixels the element can move right"}, {"type": "int", "name": "iUp", "description": " the number of pixels the element can move up"}, {"type": "int", "name": "iDown", "description": " the number of pixels the element can move down"}, {"type": "int", "name": "iTickSize", "description": " the width of the tick interval."}], "description": "Set up the slider, must be called in the constructor of all subclasses", "guessedname": "initSlider", "guessedtype": "function"}, "getXValue": {"return": {"type": "int", "description": "the number of pixels (positive or negative) the\nslider has moved horizontally from the start position."}, "description": "Gets the current X offset from the element's start position in\npixels.", "guessedname": "getXValue", "guessedtype": "function"}, "clearTicks": {"description": "Clear's the slider's ticks", "guessedname": "clearTicks", "guessedtype": "function"}}, "extends": "YAHOO.util.DD", "superclass": "YAHOO.util.DD", "file": "SliderThumb.js", "guessedtype": "function", "shortname": "SliderThumb", "properties": {"isTarget": {"private": "", "description": "Overrides the isTarget property in YAHOO.util.DragDrop", "guessedname": "isTarget", "guessedtype": "property"}, "maintainOffset": {"guessedname": "maintainOffset", "type": "boolean", "description": "Informs the drag and drop util that the offsets should remain when\nresetting the constraints. This preserves the slider value when\nthe constraints are reset", "private": "", "guessedtype": "property"}, "parentElId": {"type": "string", "description": "The id of the thumbs parent HTML element (the slider background \nelement).", "guessedname": "parentElId", "guessedtype": "property"}, "_isHoriz": {"guessedname": "_isHoriz", "type": "boolean", "description": "Flag used to figure out if this is a horizontal or vertical slider", "private": "", "guessedtype": "property"}, "tickSize": {"guessedname": "tickSize", "type": "int", "description": "The tick size for this slider", "private": "", "guessedtype": "property"}, "_prevVal": {"guessedname": "_prevVal", "type": "int", "description": "Cache the last value so we can check for change", "private": "", "guessedtype": "property"}, "startOffset": {"type": "[int, int]", "description": "The (X and Y) difference between the thumb location and its parent \n(the slider background) when the control is instantiated.", "guessedname": "startOffset", "guessedtype": "property"}, "dragOnly": {"default": "true", "type": "boolean", "description": "Override the default setting of dragOnly to true.", "guessedname": "dragOnly", "guessedtype": "property"}, "_graduated": {"guessedname": "_graduated", "type": "boolean", "description": "The slider is _graduated if there is a tick interval defined", "private": "", "guessedtype": "property"}, "scroll": {"private": "", "description": "Turns off the autoscroll feature in drag and drop", "guessedname": "scroll", "guessedtype": "property"}}, "description": "A drag and drop implementation to be used as the thumb of a slider."}, "YAHOO.util.AttributeProvider": {"name": "YAHOO.util.AttributeProvider", "namespace": "YAHOO.util", "module": "element", "guessedname": "AttributeProvider", "methods": {"set": {"return": {"type": "Boolean", "description": "Whether or not the value was set."}, "params": [{"type": "String", "name": "key", "description": " The name of the attribute"}, {"type": "Any", "name": "value", "description": " The value to apply to the attribute"}, {"type": "Boolean", "name": "silent", "description": " Whether or not to suppress change events"}], "description": "Sets the value of a config.", "guessedname": "set", "guessedtype": "function"}, "fireBeforeChangeEvent": {"params": [{"type": "String", "name": "key", "description": " The attribute's name."}, {"type": "Obj", "name": "e", "description": " The event object to pass to handlers."}], "description": "Fires the attribute's beforeChange event.", "guessedname": "fireBeforeChangeEvent", "guessedtype": "function"}, "resetValue": {"return": {"type": "Boolean", "description": "Whether or not the value was set"}, "params": [{"type": "String", "name": "key", "description": " The name of the attribute"}, {"type": "Boolean", "name": "silent", "description": " Whether or not to suppress change events"}], "description": "Resets the specified attribute's value to its initial value.", "guessedname": "resetValue", "guessedtype": "function"}, "get": {"params": [{"type": "String", "name": "key", "description": " The attribute whose value will be returned."}], "description": "Returns the current value of the attribute.", "guessedname": "get", "guessedtype": "function"}, "setAttributeConfig": {"params": [{"type": "String", "name": "key", "description": " The attribute's name."}, {"type": "Object", "name": "map", "description": " A key-value map of attribute properties"}, {"type": "Boolean", "name": "init", "description": " Whether or not this should become the intial config."}], "description": "Sets or updates an Attribute instance's properties.", "guessedname": "setAttributeConfig", "guessedtype": "function"}, "resetAttributeConfig": {"guessedname": "resetAttributeConfig", "params": [{"type": "String", "name": "key", "description": " The attribute's name."}], "description": "Resets an attribute to its intial configuration.", "private": "", "guessedtype": "function"}, "register": {"deprecated": "Use setAttributeConfig", "params": [{"type": "String", "name": "key", "description": " The attribute's name"}, {"type": "Object", "name": "map", "description": " A key-value map containing the\nattribute's properties."}], "description": "Adds an Attribute to the AttributeProvider instance.", "guessedname": "register", "guessedtype": "function"}, "getAttributeConfig": {"return": {"type": "object", "description": "A key-value map containing all of the\nattribute's properties."}, "description": "Returns the attribute's properties.", "private": "", "params": [{"type": "String", "name": "key", "description": " The attribute's name"}], "guessedname": "getAttributeConfig", "guessedtype": "function"}, "refresh": {"params": [{"type": "String | Array", "name": "key", "description": " The attribute(s) to refresh"}, {"type": "Boolean", "name": "silent", "description": " Whether or not to suppress change events"}], "description": "Sets the attribute's value to its current value.", "guessedname": "refresh", "guessedtype": "function"}, "configureAttribute": {"deprecated": "Use setAttributeConfig", "params": [{"type": "String", "name": "key", "description": " The attribute's name."}, {"type": "Object", "name": "map", "description": " A key-value map of attribute properties"}, {"type": "Boolean", "name": "init", "description": " Whether or not this should become the intial config."}], "description": "Sets or updates an Attribute instance's properties.", "guessedname": "configureAttribute", "guessedtype": "function"}, "getAttributeKeys": {"return": {"type": "Array", "description": "An array of attribute names."}, "description": "Returns an array of attribute names.", "guessedname": "getAttributeKeys", "guessedtype": "function"}, "fireChangeEvent": {"params": [{"type": "String", "name": "key", "description": " The attribute's name."}, {"type": "Obj", "name": "e", "description": " The event object to pass to the handlers."}], "description": "Fires the attribute's change event.", "guessedname": "fireChangeEvent", "guessedtype": "function"}, "setAttributes": {"params": [{"type": "Object", "name": "map", "description": " A key-value map of attributes"}, {"type": "Boolean", "name": "silent", "description": " Whether or not to suppress change events"}], "description": "Sets multiple attribute values.", "guessedname": "setAttributes", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "AttributeProvider.js", "guessedtype": "function", "shortname": "AttributeProvider", "properties": {"_configs": {"description": "A key-value map of Attribute configurations", "private": "", "protected": "", "guessedname": "_configs", "guessedtype": "property", "type": "{Object}"}}, "description": "Provides and manages YAHOO.util.Attribute instances"}, "YAHOO.widget.Column": {"name": "YAHOO.widget.Column", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " Object literal of definitions."}], "description": "The Column class defines and manages attributes of DataTable Columns"}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "Column", "methods": {"getSanitizedKey": {"return": {"type": "String", "description": "Sanitized Column key."}, "description": "Returns Column key which has been sanitized for DOM (class and ID) usage\nstarts with letter, contains only letters, numbers, hyphen, or period.", "guessedname": "getSanitizedKey", "guessedtype": "function"}, "getTreeIndex": {"return": {"type": "Number", "description": "Position index, or null."}, "description": "Public accessor returns Column's current position index within its\nColumnSet's tree array, if applicable. Only non-nested and top-level parent\nColumns will return a value;", "guessedname": "getTreeIndex", "guessedtype": "function"}, "getParent": {"return": {"type": "YAHOO.widget.Column", "description": "Column's parent instance."}, "description": "Public accessor returns Column's parent instance if any, or null otherwise.", "guessedname": "getParent", "guessedtype": "function"}, "getField": {"return": {"type": "String", "description": "Column field."}, "description": "Returns field.", "guessedname": "getField", "guessedtype": "function"}, "getDefinition": {"return": {"type": "Object", "description": "Object literal definition."}, "description": "Returns object literal definition.", "guessedname": "getDefinition", "guessedtype": "function"}, "getId": {"return": {"type": "String", "description": "Unique ID string."}, "description": "Returns unique ID string.", "guessedname": "getId", "guessedtype": "function"}, "getKey": {"return": {"type": "String", "description": "Column key."}, "description": "Returns unique Column key.", "guessedname": "getKey", "guessedtype": "function"}, "getKeyIndex": {"return": {"type": "Number", "description": "Position index, or null."}, "description": "Public accessor returns Column's current position index within its\nColumnSet's keys array, if applicable. Only non-nested and bottom-level\nchild Columns will return a value.", "guessedname": "getKeyIndex", "guessedtype": "function"}, "getColspan": {"return": {"type": "Number", "description": "Column's COLSPAN value."}, "description": "Public accessor returns Column's calculated COLSPAN value.", "guessedname": "getColspan", "guessedtype": "function"}, "getRowspan": {"return": {"type": "Number", "description": "Column's ROWSPAN value."}, "description": "Public accessor returns Column's calculated ROWSPAN value.", "guessedname": "getRowspan", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Column's unique name."}, "description": "Column instance name, for logging.", "guessedname": "toString", "guessedtype": "function"}, "getColEl": {"deprecated": "Use getThEl", "guessedname": "getColEl", "guessedtype": "function"}, "getThLInerEl": {"return": {"type": "HTMLElement", "description": "TH element."}, "description": "Returns DOM reference to the TH's liner DIV element. Introduced since\nresizeable Columns may have an extra resizer liner, making the DIV liner\nnot reliably the TH element's first child.", "guessedname": "getThLinerEl", "guessedtype": "function"}, "getThEl": {"return": {"type": "HTMLElement", "description": "TH element."}, "description": "Returns DOM reference to the key TH element.", "guessedname": "getThEl", "guessedtype": "function"}, "getResizerEl": {"return": {"type": "HTMLElement", "description": "DIV element."}, "description": "Returns DOM reference to the resizer element, or null.", "guessedname": "getResizerEl", "guessedtype": "function"}}, "file": "ColumnSet.js", "guessedtype": "function", "shortname": "Column", "properties": {"sortOptions.sortFunction": {"default": "null", "type": "Function", "description": "Custom sort handler.", "guessedname": "sortOptions", "guessedtype": "property"}, "_nTreeIndex": {"guessedname": "_nTreeIndex", "type": "Number", "description": "Reference to Column's current position index within its ColumnSet's tree\narray, if applicable. This property only applies to non-nested and top-\nlevel parent Columns.", "private": "", "guessedtype": "property"}, "_elResizer": {"guessedname": "_elResizer", "type": "HTMLElement", "description": "The DOM reference to the associated resizerelement (if any).", "private": "", "guessedtype": "property"}, "sortOptions.defaultOrder": {"deprecated": "Use sortOptions.defaultDir."}, "resizeable": {"default": "false", "type": "Boolean", "description": "True if Column is resizeable, false otherwise. The Drag & Drop Utility is\nrequired to enable this feature. Only bottom-level and non-nested Columns are\nresizeble.", "guessedname": "resizeable", "guessedtype": "property"}, "children": {"type": "Object[]", "description": "Array of object literals that define children (nested headers) of a Column.", "guessedname": "children", "guessedtype": "property"}, "_elThLiner": {"guessedname": "_elThLiner", "type": "HTMLElement", "description": "The DOM reference to the associated TH element's liner DIV element.", "private": "", "guessedtype": "property"}, "_elTh": {"guessedname": "_elTh", "type": "HTMLElement", "description": "The DOM reference to the associated TH element.", "private": "", "guessedtype": "property"}, "width": {"type": "Number", "description": "Column width (in pixels).", "guessedname": "width", "guessedtype": "property"}, "sortOptions.field": {"default": "null", "type": "String", "description": "Custom field to sort on."}, "selected": {"default": "false", "type": "Boolean", "description": "True if Column is in selected state.", "guessedname": "selected", "guessedtype": "property"}, "sortOptions.defaultDir": {"default": "null", "type": "String", "description": "Default sort direction for Column: YAHOO.widget.DataTable.CLASS_ASC or YAHOO.widget.DataTable.CLASS_DESC."}, "label": {"type": "String", "description": "Text or HTML for display as Column's label in the TH element.", "guessedname": "label", "guessedtype": "property"}, "minWidth": {"default": "null", "type": "Number", "description": "Minimum Column width (in pixels).", "guessedname": "minWidth", "guessedtype": "property"}, "field": {"type": "String", "description": "Associated database field, or null.", "guessedname": "field", "guessedtype": "property"}, "editor": {"type": "YAHOO.widget.CellEditor", "description": "A CellEditor instance, otherwise Column is not editable.", "guessedname": "editor", "guessedtype": "property"}, "_nRowspan": {"guessedname": "_nRowspan", "type": "Number", "description": "Number of table rows the Column spans.", "private": "", "guessedtype": "property"}, "_nColspan": {"guessedname": "_nColspan", "type": "Number", "description": "Number of table cells the Column spans.", "private": "", "guessedtype": "property"}, "formatter": {"type": "String || HTMLFunction", "description": "Defines a format function.", "guessedname": "formatter", "guessedtype": "property"}, "Column._nCount": {"description": "Internal class variable to index multiple Column instances.", "private": "", "static": "", "guessedname": "_nCount", "guessedtype": "property", "type": "Number"}, "_dd": {"guessedname": "_dd", "type": "YAHOO.util.DragDrop", "description": "For unreg() purposes, a reference to the Column's DragDrop instance.", "private": "", "guessedtype": "property"}, "currencyOptions": {"default": "null", "type": "Object", "description": "Config passed to YAHOO.util.Number.format() by the 'currency' Column formatter.", "guessedname": "currencyOptions", "guessedtype": "property"}, "_nKeyIndex": {"guessedname": "_nKeyIndex", "type": "Number", "description": "Reference to Column's current position index within its ColumnSet's keys\narray, if applicable. This property only applies to non-nested and bottom-\nlevel child Columns.", "private": "", "guessedtype": "property"}, "abbr": {"type": "String", "description": "Column head cell ABBR for accessibility.", "guessedname": "abbr", "guessedtype": "property"}, "key": {"type": "String", "description": "Unique name, required.", "guessedname": "key", "guessedtype": "property"}, "hidden": {"default": "false", "type": "Boolean", "description": "True if Column is in hidden state.", "guessedname": "hidden", "guessedtype": "property"}, "_elThLabel": {"guessedname": "_elThLabel", "type": "HTMLElement", "description": "The DOM reference to the associated TH element's label SPAN element.", "private": "", "guessedtype": "property"}, "_ddResizer": {"guessedname": "_ddResizer", "type": "YAHOO.util.DragDrop", "description": "For unreg() purposes, a reference to the Column resizer's DragDrop instance.", "private": "", "guessedtype": "property"}, "sortable": {"default": "false", "type": "Boolean", "description": "True if Column is sortable, false otherwise.", "guessedname": "sortable", "guessedtype": "property"}, "_sId": {"guessedname": "_sId", "type": "String", "description": "Unique String identifier assigned at instantiation.", "private": "", "guessedtype": "property"}, "className": {"type": "String || String[]", "description": "Custom CSS class or array of classes to be applied to every cell in the Column.", "guessedname": "className", "guessedtype": "property"}, "dateOptions": {"default": "null", "type": "Object", "description": "Config passed to YAHOO.util.Date.format() by the 'date' Column formatter.", "guessedname": "dateOptions", "guessedtype": "property"}, "_nWidth": {"guessedname": "_nWidth", "type": "Number", "description": "Internal width tracker.", "private": "", "guessedtype": "property"}, "_oParent": {"guessedname": "_oParent", "type": "YAHOO.widget.Column", "description": "Column's parent Column instance, or null.", "private": "", "guessedtype": "property"}, "maxAutoWidth": {"default": "null", "type": "Number", "description": "When a width is not defined for a Column, maxAutoWidth defines an upper\nlimit that the Column should be auto-sized to. If resizeable is enabled, \nusers may still resize to a greater width. Most useful for Columns intended\nto hold long unbroken, unwrapped Strings, such as URLs, to prevent very\nwide Columns from disrupting visual readability by inducing truncation.", "guessedname": "maxAutoWidth", "guessedtype": "property"}}, "description": "The Column class defines and manages attributes of DataTable Columns"}, "YAHOO.util.LocalDataSource": {"name": "YAHOO.util.LocalDataSource", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "LocalDataSource class for in-memory data structs including JavaScript arrays,\nJavaScript object literals (JSON), XML documents, and HTML tables."}], "namespace": "YAHOO.util", "module": "datasource", "guessedname": "LocalDataSource", "extends": "YAHOO.util.DataSourceBase", "superclass": "YAHOO.util.DataSourceBase", "file": "DataSource.js", "guessedtype": "function", "shortname": "LocalDataSource", "description": "LocalDataSource class for in-memory data structs including JavaScript arrays,\nJavaScript object literals (JSON), XML documents, and HTML tables."}, "YAHOO.env.ua": {"name": "YAHOO.env.ua", "namespace": "", "module": "yahoo", "guessedname": "ua", "static": "", "file": "Env.js", "guessedtype": "function", "shortname": "YAHOO.env.ua", "properties": {"opera": {"type": "float", "description": "Opera version number or 0. Example: 9.2", "guessedname": "opera", "guessedtype": "property"}, "ie": {"type": "float", "description": "Internet Explorer version number or 0. Example: 6", "guessedname": "ie", "guessedtype": "property"}, "air": {"type": "float", "description": "Adobe AIR version number or 0. Only populated if webkit is detected.\nExample: 1.0", "guessedname": "air", "guessedtype": "property"}, "mobile": {"type": "string", "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"}, "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). \n3.x yahoo.com, flickr:422 <-- Safari 3.x hacks the user agent\nstring when hitting yahoo.com and \nflickr.com.\nSafari 3.0.4 (523.12):523.12 <-- First Tiger release - automatic update\nfrom 2.x via the 10.4.11 OS patch\nWebkit nightly 1\/2008:525+ <-- Supports DOMContentLoaded event.\nyahoo.com user agent hack removed.\n<\/pre>\nhttp:\/\/developer.apple.com\/internet\/safari\/uamatrix.html", "guessedname": "webkit", "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"}}, "description": "Do not fork for a browser if it can be avoided. Use feature detection when\nyou can. Use the user agent as a last resort. YAHOO.env.ua stores a version\nnumber for the browser engine, 0 otherwise. This value may or may not map\nto the version number of the browser using the engine. The value is \npresented as a float so that it can easily be used for boolean evaluation \nas well as for looking for a particular range of versions. Because of this, \nsome of the granularity of the version info may be lost (e.g., Gecko 1.8.0.9 \nreports 1.8)."}, "YAHOO.widget.LogWriter": {"name": "YAHOO.widget.LogWriter", "constructors": [{"params": [{"type": "String", "name": "sSource", "description": " Source of LogWriter instance."}], "description": "The LogWriter class provides a mechanism to log messages through\nYAHOO.widget.Logger from a named source."}], "namespace": "YAHOO.widget", "module": "logger", "guessedname": "LogWriter", "methods": {"getSource": {"return": {"type": "String", "description": "The LogWriter source."}, "description": "Public accessor to get the source name.", "guessedname": "getSource", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the LogWriter instance."}, "description": "Public accessor to the unique name of the LogWriter instance.", "guessedname": "toString", "guessedtype": "function"}, "log": {"params": [{"type": "String", "name": "sMsg", "description": " The log message."}, {"type": "String", "name": "sCategory", "description": " Category name."}], "description": "Logs a message attached to the source of the LogWriter.", "guessedname": "log", "guessedtype": "function"}, "setSource": {"params": [{"type": "String", "name": "sSource", "description": " Source of LogWriter instance."}], "description": "Public accessor to set the source name.", "guessedname": "setSource", "guessedtype": "function"}}, "file": "LogWriter.js", "guessedtype": "function", "shortname": "LogWriter", "properties": {"_source": {"guessedname": "_source", "type": "String", "description": "Source of the LogWriter instance.", "private": "", "guessedtype": "property"}}, "description": "The LogWriter class provides a mechanism to log messages through\nYAHOO.widget.Logger from a named source."}, "YAHOO.widget.PieSeries": {"name": "YAHOO.widget.PieSeries", "constructors": [{"description": "PieSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "PieSeries", "file": "Series.js", "guessedtype": "function", "shortname": "PieSeries", "properties": {"categoryField": {"type": "String", "description": "The field used to access the category value from the items from the data source.", "guessedname": "categoryField", "guessedtype": "property"}, "labelFunction": {"type": "String", "description": "A string reference to the globally-accessible function that may be called to\ndetermine each of the label values for this series. Also accepts function references.", "guessedname": "labelFunction", "guessedtype": "property"}, "dataField": {"type": "String", "description": "The field used to access the data value from the items from the data source.", "guessedname": "dataField", "guessedtype": "property"}}, "description": "PieSeries class for the YUI Charts widget."}, "YAHOO.widget.ScrollingDataTable": {"name": "YAHOO.widget.ScrollingDataTable", "configs": {"width": {"type": "String", "description": "Table width for scrollable tables. Note: When setting width\nand height at runtime, please set height first."}, "COLOR_COLUMNFILLER": {"default": "\"#F2F2F2\"", "type": "String", "description": "CSS color value assigned to header filler on scrollable tables."}, "height": {"type": "String", "description": "Table body height for scrollable tables, not including headers."}}, "constructors": [{"params": [{"type": "HTMLElement", "name": "elContainer", "description": " Container element for the TABLE."}, {"type": "Object[]", "name": "aColumnDefs", "description": " Array of object literal Column definitions."}, {"type": "YAHOO.util.DataSource", "name": "oDataSource", "description": " DataSource instance."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "The ScrollingDataTable class extends the DataTable class to provide\nfunctionality for x-scrolling, y-scrolling, and xy-scrolling."}], "namespace": "YAHOO.widget", "module": "datatable", "events": {"COLOR_COLUMNFILLERChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "COLOR_COLUMNFILLERChange", "description": "Fires when the value for the configuration attribute 'COLOR_COLUMNFILLER' changes."}, "heightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "heightChange", "description": "Fires when the value for the configuration attribute 'height' changes."}, "beforeCOLOR_COLUMNFILLERChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCOLOR_COLUMNFILLERChange", "description": "Fires before the value for the configuration attribute 'COLOR_COLUMNFILLER' changes. Return false to cancel the attribute change."}, "beforeWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeWidthChange", "description": "Fires before the value for the configuration attribute 'width' changes. Return false to cancel the attribute change."}, "tableScrollEvent": {"params": [{"type": "HTMLEvent", "name": "oArgs.event", "description": " The event object."}, {"type": "HTMLElement", "name": "oArgs.target", "description": " The DataTable's CONTAINER element (in IE)\nor the DataTable's TBODY element (everyone else)."}], "description": "Fired when a fixed scrolling DataTable has a scroll."}, "beforeHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHeightChange", "description": "Fires before the value for the configuration attribute 'height' changes. Return false to cancel the attribute change."}, "widthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "widthChange", "description": "Fires when the value for the configuration attribute 'width' changes."}}, "guessedname": "ScrollingDataTable", "methods": {"onColumnChange": {"params": [{"type": "Object", "name": "oArgs", "description": " Custom Event data."}], "description": "Handles Column mutations", "guessedname": "_onColumnChange", "guessedtype": "function"}, "setColumnWidth": {"params": [{"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}, {"type": "Number", "name": "nWidth", "description": " New width in pixels."}], "description": "Sets given Column to given pixel width. If new width is less than minWidth\nwidth, sets to minWidth. Updates oColumn.width value.", "guessedname": "setColumnWidth", "guessedtype": "function"}, "validateColumnWidths": {"params": [{"type": "YAHOO.widget.Column", "name": "oArg.column", "description": " (optional) One Column to validate. If null, all Columns' widths are validated."}], "description": "For one or all Columns of a ScrollingDataTable, when Column is not hidden,\nand width is not set, syncs widths of header and body cells and \nvalidates that width against minWidth and\/or maxAutoWidth as necessary.", "guessedname": "validateColumnWidths", "guessedtype": "function"}, "insertColumn": {"return": {"type": "YAHOO.widget.Column", "description": "oColumn Inserted Column instance."}, "params": [{"type": "Object | YAHOO.widget.Column", "name": "oColumn", "description": " Object literal Column\ndefinition or a Column instance."}, {"type": "Number", "name": "index", "description": " (optional) New tree index."}], "description": "Inserts given Column at the index if given, otherwise at the end. NOTE: You\ncan only add non-nested Columns and top-level parent Columns. You cannot add\na nested Column to an existing parent.", "guessedname": "insertColumn", "guessedtype": "function"}, "initAttributes": {"guessedname": "initAttributes", "params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal definition of configuration values."}], "description": "Implementation of Element's abstract method. Sets up config values.", "private": "", "guessedtype": "function"}, "_validateColumnWidth": {"guessedname": "_validateColumnWidth", "params": [{"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}, {"type": "HTMLElement", "name": "elTd", "description": " TD element to validate against."}], "description": "Helper function calculates and sets a validated width for a Column in a ScrollingDataTable.", "private": "", "guessedtype": "function"}, "_syncScrollY": {"private": "", "description": "Snaps container width for y-scrolling tables.", "guessedname": "_syncScrollY", "guessedtype": "function"}, "_syncScrollX": {"private": "", "description": "Snaps container height for x-scrolling tables in IE. Syncs message TBODY width.", "guessedname": "_syncScrollX", "guessedtype": "function"}, "_initBdThEl": {"guessedname": "_initBdThEl", "params": [{"type": "HTMLElement", "name": "elTh", "description": " TH element reference."}, {"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column object."}], "description": "Populates TH element for the body THEAD element.", "private": "", "guessedtype": "function"}, "_destroyBdTheadEl": {"private": "", "description": "Destroy's the DataTable body THEAD element, if available.", "guessedname": "_destroyBdTheadEl", "guessedtype": "function"}, "_initTableEl": {"private": "", "description": "Initializes ScrollingDataTable TABLE elements into the two inner containers.", "guessedname": "_initTableEl", "guessedtype": "function"}, "_initTheadEl": {"guessedname": "_initTheadEl", "params": [{"type": "HTMLElement", "name": "elHdTable", "description": " (optional) Fixed header TABLE element reference."}, {"type": "HTMLElement", "name": "elTable", "description": " (optional) TABLE element reference."}], "description": "Initializes ScrollingDataTable THEAD elements into the two inner containers.", "private": "", "guessedtype": "function"}, "showTableMessage": {"params": [{"type": "String", "name": "sHTML", "description": " (optional) Value for innerHTMlang."}, {"type": "String", "name": "sClassName", "description": " (optional) Classname."}], "description": "Displays message within secondary TBODY.", "guessedname": "showTableMessage", "guessedtype": "function"}, "_focusEl": {"guessedname": "_focusEl", "params": [{"type": "HTMLElement", "name": "el", "description": " Element."}], "description": "Sets focus on the given element.", "private": "", "guessedtype": "function"}, "_destroyHdTableEl": {"private": "", "description": "Destroy's the DataTable head TABLE element, if available.", "guessedname": "_destroyHdTableEl", "guessedtype": "function"}, "getHdTableEl": {"return": {"type": "HTMLElement", "description": "Reference to TABLE element."}, "description": "Returns DOM reference to the DataTable's fixed header TABLE element.", "guessedname": "getHdTableEl", "guessedtype": "function"}, "_onTheadKeydown": {"guessedname": "_onTheadKeydown", "params": [{"type": "HTMLEvent", "name": "e", "description": " The key event."}, {"type": "YAHOO.widget.ScrollingDataTable", "name": "oSelf", "description": " ScrollingDataTable instance."}], "description": "Handles keydown events on the THEAD element.", "private": "", "guessedtype": "function"}, "getBdContainerEl": {"return": {"type": "HTMLElement", "description": "Reference to DIV element."}, "description": "Returns DOM reference to the DataTable's scrolling body container element.", "guessedname": "getBdContainerEl", "guessedtype": "function"}, "_initDomElements": {"guessedname": "_initDomElements", "params": [{"type": "HTMLElement | String} HTML DIV element by reference or ID. \nreturn {Boolean", "name": "elContainer", "description": " False in case of error, otherwise true"}], "description": "Initializes DOM elements for a ScrollingDataTable, including creation of\ntwo separate TABLE elements.", "private": "", "guessedtype": "function"}, "_syncScroll": {"private": "", "description": "Syncs padding around scrollable tables, including Column header right-padding\nand container width and height.", "guessedname": "_syncScroll", "guessedtype": "function"}, "disable": {"description": "Disables ScrollingDataTable UI.", "guessedname": "disable", "guessedtype": "function"}, "_setOverhangValue": {"guessedname": "_setOverhangValue", "params": [{"type": "Number", "name": "nBorderWidth", "description": " Value of new border for overhang."}], "description": "Sets Column header overhang to given width.", "private": "", "guessedtype": "function"}, "_initCaptionEl": {"guessedname": "_initCaptionEl", "params": [{"type": "String", "name": "sCaption", "description": " Text for caption."}], "description": "Creates HTML markup CAPTION element.", "private": "", "guessedtype": "function"}, "removeColumn": {"return": {"type": "YAHOO.widget.Column", "description": "oColumn Removed Column instance."}, "params": [{"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}], "description": "Removes given Column. NOTE: You cannot remove nested Columns. You can only remove\nnon-nested Columns, and top-level parent Columns (which will remove all\nchildren Columns).", "guessedname": "removeColumn", "guessedtype": "function"}, "_runRenderChain": {"private": "", "description": "Internal wrapper calls run() on render Chain instance.", "guessedname": "_runRenderChain", "guessedtype": "function"}, "_destroyContainerEl": {"guessedname": "_destroyContainerEl", "params": [{"type": "HTMLElement", "name": "elContainer", "description": " Reference to the container element."}], "description": "Destroy's the DataTable outer and inner container elements, if available.", "private": "", "guessedtype": "function"}, "getBdTableEl": {"return": {"type": "HTMLElement", "description": "Reference to TABLE element."}, "description": "Returns DOM reference to the DataTable's scrolling body TABLE element.", "guessedname": "getBdTableEl", "guessedtype": "function"}, "getHdContainerEl": {"return": {"type": "HTMLElement", "description": "Reference to DIV element."}, "description": "Returns DOM reference to the DataTable's fixed header container element.", "guessedname": "getHdContainerEl", "guessedtype": "function"}, "_onScroll": {"guessedname": "_onScroll", "params": [{"type": "HTMLEvent", "name": "e", "description": " The scroll event."}, {"type": "YAHOO.widget.ScrollingDataTable", "name": "oSelf", "description": " ScrollingDataTable instance."}], "description": "Syncs scrolltop and scrollleft of all TABLEs.", "private": "", "guessedtype": "function"}, "_retoreScrollPositions": {"private": "", "description": "Restores scroll positions to stored value.", "guessedname": "_restoreScrollPositions", "guessedtype": "function"}, "_initBdTheadEl": {"return": {"type": "HTMLElement", "description": "Initialized THEAD element."}, "description": "Initializes body THEAD element.", "private": "", "params": [{"type": "HTMLElement", "name": "elTable", "description": " TABLE element into which to create THEAD."}], "guessedname": "_initBdTheadEl", "guessedtype": "function"}, "_initTbodyEl": {"guessedname": "_initTbodyEl", "params": [{"type": "HTMLElement", "name": "elTable", "description": " TABLE element into which to create TBODY ."}], "description": "Initializes ScrollingDataTable TBODY element for data", "private": "", "guessedtype": "function"}, "_storeScrollPositions": {"private": "", "description": "Stores scroll positions so they can be restored after a render.", "guessedname": "_storeScrollPositions", "guessedtype": "function"}, "_initContainerEl": {"guessedname": "_initContainerEl", "params": [{"type": "HTMLElement | String", "name": "elContainer", "description": " HTML DIV element by reference or ID."}], "description": "Initializes the DataTable outer container element and creates inner header\nand body container elements.", "private": "", "guessedtype": "function"}, "reorderColumn": {"params": [{"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}, {"type": "Number", "name": "index", "description": " New tree index."}], "description": "Removes given Column and inserts into given tree index. NOTE: You\ncan only reorder non-nested Columns and top-level parent Columns. You cannot\nreorder a nested Column to an existing parent.", "guessedname": "reorderColumn", "guessedtype": "function"}, "_initThEl": {"guessedname": "_initThEl", "params": [{"type": "HTMLElement", "name": "elTh", "description": " TH element reference."}, {"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column object."}], "description": "SDT changes ID so as not to duplicate the accessibility TH IDs.", "private": "", "guessedtype": "function"}, "_syncScrollOverhang": {"private": "", "description": "Adds\/removes Column header overhang as necesary.", "guessedname": "_syncScrollOverhang", "guessedtype": "function"}}, "extends": "YAHOO.widget.DataTable", "superclass": "YAHOO.widget.DataTable", "file": "ScrollingDataTable.js", "guessedtype": "function", "shortname": "ScrollingDataTable", "properties": {"DataTable.CLASS_BODY": {"description": "Class name assigned to inner DataTable body container.", "default": "\"yui-dt-bd\"", "static": "", "guessedname": "CLASS_BODY", "guessedtype": "property", "type": "String", "final": ""}, "_elBdThead": {"guessedname": "_elBdThead", "type": "HTMLElement", "description": "Body THEAD element.", "private": "", "guessedtype": "property"}, "DataTable.CLASS_HEADER": {"description": "Class name assigned to inner DataTable header container.", "default": "\"yui-dt-hd\"", "static": "", "guessedname": "CLASS_HEADER", "guessedtype": "property", "type": "String", "final": ""}, "_elHdContainer": {"guessedname": "_elHdContainer", "type": "HTMLElement", "description": "Container for fixed header TABLE element.", "private": "", "guessedtype": "property"}, "_elHdTable": {"guessedname": "_elHdTable", "type": "HTMLElement", "description": "Fixed header TABLE element.", "private": "", "guessedtype": "property"}, "_bScrollbarX": {"guessedname": "_bScrollbarX", "type": "Boolean", "description": "True if x-scrollbar is currently visible.", "private": "", "guessedtype": "property"}, "_elTmpTable": {"guessedname": "_elTmpTable", "type": "HTMLElement", "description": "Offscreen TABLE element for auto-width calculation.", "private": "", "guessedtype": "property"}, "_elBdContainer": {"guessedname": "_elBdContainer", "type": "HTMLElement", "description": "Container for scrolling body TABLE element.", "private": "", "guessedtype": "property"}, "_elTmpContainer": {"guessedname": "_elTmpContainer", "type": "HTMLElement", "description": "Offscreen container to temporarily clone SDT for auto-width calculation.", "private": "", "guessedtype": "property"}}, "description": "The ScrollingDataTable class extends the DataTable class to provide\nfunctionality for x-scrolling, y-scrolling, and xy-scrolling."}, "YAHOO_config": {"name": "YAHOO_config", "namespace": "", "module": "yahoo", "static": "", "file": "YAHOO.js", "shortname": "YAHOO_config", "properties": {"listener": {"default": "undefined", "type": "Function", "static": "", "description": "A reference to a function that will be executed every time a YAHOO module\nis loaded. As parameter, this function will receive the version\ninformation for the module. See <a href=\"YAHOO.env.html#getVersion\">\nYAHOO.env.getVersion<\/a> for the description of the version data structure."}, "load": {"default": "undefined", "see": "yuiloader", "static": "", "description": "Instructs the yuiloader component to dynamically load yui components and\ntheir dependencies. See the yuiloader documentation for more information\nabout dynamic loading"}, "locale": {"description": "Forces the use of the supplied locale where applicable in the library", "default": "undefined", "static": "", "guessedname": "YAHOO", "guessedtype": "property", "type": "string"}, "injecting": {"default": "undefined", "type": "boolean", "static": "", "description": "Set to true if the library will be dynamically loaded after window.onload.\nDefaults to false"}}, "description": "YAHOO_config is not included as part of the library. Instead it is an \nobject that can be defined by the implementer immediately before \nincluding the YUI library. The properties included in this object\nwill be used to configure global properties needed as soon as the \nlibrary begins to load."}, "YAHOO.util.FunctionDataSource": {"name": "YAHOO.util.FunctionDataSource", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "FunctionDataSource class for JavaScript functions."}], "namespace": "YAHOO.util", "module": "datasource", "guessedname": "FunctionDataSource", "methods": {"makeConnection": {"return": {"type": "Number", "description": "Transaction ID."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " Callback object literal."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "Overriding method passes query to a function. The returned response is then\nforwarded to the handleResponse function.", "guessedname": "makeConnection", "guessedtype": "function"}}, "extends": "YAHOO.util.DataSourceBase", "superclass": "YAHOO.util.DataSourceBase", "file": "DataSource.js", "guessedtype": "function", "shortname": "FunctionDataSource", "description": "FunctionDataSource class for JavaScript functions."}, "YAHOO.widget.Dialog": {"name": "YAHOO.widget.Dialog", "configs": {"buttons": {"default": "\"none\"", "type": "{Array|String}", "description": "Array of object literals, each containing a set of properties \ndefining a button to be appended into the Dialog's footer.\nEach button object in the buttons array can have three properties:\n<dt>text:<\/dt>\n<dd>The text that will display on the face of the button. The text can \ninclude HTML, as long as it is compliant with HTML Button specifications.\n<\/dd>\n<dt>handler:<\/dt>\n<dd>Can be either:\n<ol>\n<li>A reference to a function that should fire when the \nbutton is clicked. (In this case scope of this function is \nalways its Dialog instance.)<\/li>\n<li>An object literal representing the code to be \nexecuted when the button is clicked. Format:<br> <code> {<br>\n<strong>fn:<\/strong> Function, // The handler to call \nwhen the event fires.<br> <strong>obj:<\/strong> Object,\n// An object to pass back to the handler.<br> <strong>\nscope:<\/strong> Object // The object to use for the \nscope of the handler. <br> } <\/code> <br><\/li>\n<\/ol>\n<\/dd>\n<dt>isDefault:<\/dt>\n<dd>An optional boolean value that specifies that a button \nshould be highlighted and focused by default.<\/dd>\n<em>NOTE:<\/em>If the YUI Button Widget is included on the page, \nthe buttons created will be instances of YAHOO.widget.Button. \nOtherwise, HTML Buttons (<code><BUTTON><\/code>) will be \ncreated."}, "hideaftersubmit": {"default": "true", "type": "Boolean", "description": "This property is used to configure whether or not the \ndialog should be automatically hidden after submit."}, "postmethod": {"default": "async", "type": "String", "description": "The method to use for posting the Dialog's form. Possible values \nare \"async\", \"form\", and \"manual\"."}}, "constructors": [{"params": [{"type": "String", "name": "el", "description": " The element ID representing the Dialog <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Dialog"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal containing \nthe configuration that should be set for this Dialog. See configuration \ndocumentation for more details."}], "description": "<p>\nDialog is an implementation of Panel that can be used to submit form \ndata.\n<\/p>\n<p>\nBuilt-in functionality for buttons with event handlers is included. \nIf the optional YUI Button dependancy is included on the page, the buttons\ncreated will be instances of YAHOO.widget.Button, otherwise regular HTML buttons\nwill be created.\n<\/p>\n<p>\nForms can be processed in 3 ways -- via an asynchronous Connection utility call, \na simple form POST or GET, or manually. The YUI Connection utility should be\nincluded if you're using the default \"async\" postmethod, but is not required if\nyou're using any of the other postmethod values.\n<\/p>"}], "namespace": "YAHOO.widget", "module": "container", "events": {"beforeSubmitEvent": {"description": "CustomEvent fired prior to submission", "guessedname": "beforeSubmitEvent", "guessedtype": "property"}, "asyncSubmitEvent": {"description": "CustomEvent fired prior to asynchronous submission", "guessedname": "asyncSubmitEvent", "guessedtype": "property"}, "submitEvent": {"description": "CustomEvent fired after submission", "guessedname": "submitEvent", "guessedtype": "property"}, "manualSubmitEvent": {"description": "CustomEvent fired prior to manual submission", "guessedname": "manualSubmitEvent", "guessedtype": "property"}, "formSubmitEvent": {"description": "CustomEvent fired prior to form-based submission", "guessedname": "formSubmitEvent", "guessedtype": "property"}, "cancelEvent": {"description": "CustomEvent fired after cancel", "guessedname": "cancelEvent", "guessedtype": "property"}}, "guessedname": "Dialog", "methods": {"configButtons": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler for the \"buttons\" configuration property", "guessedname": "configButtons", "guessedtype": "function"}, "getButtons": {"return": {"type": "Array", "description": ""}, "description": "Returns an array containing each of the Dialog's \nbuttons, by default an array of HTML <code><BUTTON><\/code> \nelements. If the Dialog's buttons were created using the \nYAHOO.widget.Button class (via the inclusion of the optional Button \ndependancy on the page), an array of YAHOO.widget.Button instances \nis returned.", "guessedname": "getButtons", "guessedtype": "function"}, "doSubmit": {"description": "Submits the Dialog's form depending on the value of the \n\"postmethod\" configuration property. <strong>Please note:\n<\/strong> As of version 2.3 this method will automatically handle \nasyncronous file uploads should the Dialog instance's form contain \n<code><input type=\"file\"><\/code> elements. If a Dialog \ninstance will be handling asyncronous file uploads, its \n<code>callback<\/code> property will need to be setup with a \n<code>upload<\/code> handler rather than the standard \n<code>success<\/code> and, or <code>failure<\/code> handlers. For more \ninformation, see the <a href=\"http:\/\/developer.yahoo.com\/yui\/\nconnection\/#file\">Connection Manager documenation on file uploads<\/a>.", "guessedname": "doSubmit", "guessedtype": "function"}, "configClose": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For \nconfiguration handlers, args[0] will equal the newly applied value \nfor the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"close\" property is \nchanged. The method controls the appending or hiding of the close\nicon at the top right of the Dialog.", "guessedname": "configClose", "guessedtype": "function"}, "_submitHandler": {"protected": "", "params": [{"type": "DOMEvent", "name": "e", "description": " The DOM Event object"}], "description": "Internal handler for the form submit event", "guessedname": "_submitHandler", "guessedtype": "function"}, "_doClose": {"protected": "", "params": [{"type": "DOMEvent", "name": "e", "description": ""}], "description": "Event handler for the close icon", "guessedname": "_doClose", "guessedtype": "function"}, "cancel": {"description": "Executes the cancel of the Dialog followed by a hide.", "guessedname": "cancel", "guessedtype": "function"}, "configPostMethod": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For \nconfiguration handlers, args[0] will equal the newly applied value \nfor the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler for the \"postmethod\" configuration property", "guessedname": "configPostMethod", "guessedtype": "function"}, "focusFirstButton": {"description": "Sets the focus to the first button created via the \"buttons\"\nconfiguration property.", "guessedname": "focusFirstButton", "guessedtype": "function"}, "initEvents": {"description": "Initializes the custom events for Dialog which are fired \nautomatically at appropriate times by the Dialog class.", "guessedname": "initEvents", "guessedtype": "function"}, "focusFirst": {"description": "Sets focus to the first element in the Dialog's form or the first \nbutton defined via the \"buttons\" configuration property. Called \nwhen the Dialog is made visible.", "guessedname": "focusFirst", "guessedtype": "function"}, "submit": {"description": "Executes a submit of the Dialog if validation \nis successful. By default the Dialog is hidden\nafter submission, but you can set the \"hideaftersubmit\"\nconfiguration property to false, to prevent the Dialog\nfrom being hidden.", "guessedname": "submit", "guessedtype": "function"}, "focusLastButton": {"description": "Sets the focus to the last button created via the \"buttons\" \nconfiguration property.", "guessedname": "focusLastButton", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "el", "description": " The element ID representing the Dialog <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Dialog"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal \ncontaining the configuration that should be set for this Dialog. \nSee configuration documentation for more details."}], "description": "The Dialog initialization method, which is executed for Dialog and \nall of its subclasses. This method is automatically called by the \nconstructor, and sets up all DOM references for pre-existing markup, \nand creates required markup if it is not already present.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The string representation of the Dialog"}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "focusDefaultButton": {"description": "Sets the focus to the button that is designated as the default via \nthe \"buttons\" configuration property. By default, this method is \ncalled when the Dialog is made visible.", "guessedname": "focusDefaultButton", "guessedtype": "function"}, "getData": {"return": {"type": "Object", "description": "A JSON object reprsenting the data of the \ncurrent form."}, "description": "Returns a JSON-compatible data structure representing the data \ncurrently contained in the form.", "guessedname": "getData", "guessedtype": "function"}, "blurButtons": {"description": "Blurs all the buttons defined via the \"buttons\" \nconfiguration property.", "guessedname": "blurButtons", "guessedtype": "function"}, "focusLast": {"description": "Sets focus to the last element in the Dialog's form or the last \nbutton defined via the \"buttons\" configuration property.", "guessedname": "focusLast", "guessedtype": "function"}, "destroy": {"description": "Removes the Panel element from the DOM and sets all child elements \nto null.", "guessedname": "destroy", "guessedtype": "function"}, "validate": {"description": "Built-in function hook for writing a validation function that will \nbe checked for a \"true\" value prior to a submit. This function, as \nimplemented by default, always returns true, so it should be \noverridden if validation is necessary.", "guessedname": "validate", "guessedtype": "function"}, "registerForm": {"description": "Prepares the Dialog's internal FORM object, creating one if one is\nnot currently present.", "guessedname": "registerForm", "guessedtype": "function"}, "setFirstLastFocusable": {"description": "Configures instance properties, pointing to the \nfirst and last focusable elements in the Dialog's form.", "guessedname": "setFirstLastFocusable", "guessedtype": "function"}, "_getFormAttributes": {"return": {"type": "Object", "description": "Object literal, with method and action String properties."}, "description": "Retrieves important attributes (currently method and action) from\nthe form element, accounting for any elements which may have the same name \nas the attributes. Defaults to \"POST\" and \"\" for method and action respectively\nif the attribute cannot be retrieved.", "protected": "", "params": [{"type": "HTMLFormElement", "name": "oForm", "description": " The HTML Form element from which to retrieve the attributes"}], "guessedname": "_getFormAttributes", "guessedtype": "function"}, "setTabLoop": {"params": [{"type": "HTMLElement", "name": "firstElement", "description": ""}, {"type": "HTMLElement", "name": "lastElement", "description": ""}], "description": "Sets up a tab, shift-tab loop between the first and last elements\nprovided. NOTE: Sets up the preventBackTab and preventTabOut KeyListener\ninstance properties, which are reset everytime this method is invoked.", "guessedname": "setTabLoop", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be changed \nusing the Dialog's Config object (cfg).", "guessedname": "initDefaultConfig", "guessedtype": "function"}, "_getButton": {"return": {"type": "YAHOO.widget.Button|HTMLElement", "description": ""}, "description": "Helper method to normalize button references. It either returns the \nYUI Button instance for the given element if found,\nor the passes back the HTMLElement reference if a corresponding YUI Button\nreference is not found or YAHOO.widget.Button does not exist on the page.", "private": "", "params": [{"type": "HTMLElement", "name": "button", "description": ""}], "guessedname": "_getButton", "guessedtype": "function"}}, "extends": "YAHOO.widget.Panel", "superclass": "YAHOO.widget.Panel", "file": "Dialog.js", "guessedtype": "function", "shortname": "Dialog", "properties": {"YAHOO.widget.Dialog.CSS_DIALOG": {"description": "Constant representing the default CSS class used for a Dialog", "static": "", "guessedname": "CSS_DIALOG", "guessedtype": "property", "type": "String", "final": ""}, "form": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-40002357\">HTMLFormElement<\/a>", "description": "Object reference to the Dialog's \n<code><form><\/code> element.", "guessedname": "form", "guessedtype": "property"}, "callback.success": {"type": "Function", "description": "The function to execute upon success of the \nConnection submission (when the form does not\ncontain a file input element).", "guessedname": "success", "guessedtype": "property"}, "callback.failure": {"type": "Function", "description": "The function to execute upon failure of the \nConnection submission", "guessedname": "failure", "guessedtype": "property"}, "callback": {"type": "Object", "description": "The internally maintained callback object for use with the \nConnection utility. The format of the callback object is \nsimilar to Connection Manager's callback object and is \nsimply passed through to Connection Manager when the async \nrequest is made.", "guessedname": "callback", "guessedtype": "property"}, "EVENT_TYPES": {"description": "Constant representing the name of the Dialog's events", "private": "", "guessedname": "EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "callback.upload": {"type": "Function", "description": "<p>\nThe function to execute upon success of the \nConnection submission, when the form contains\na file input element.\n<\/p>\n<p>\n<em>NOTE:<\/em> Connection manager will not\ninvoke the success or failure handlers for the file\nupload use case. This will be the only callback\nhandler invoked.\n<\/p>\n<p>\nFor more information, see the <a href=\"http:\/\/developer.yahoo.com\/yui\/connection\/#file\">\nConnection Manager documenation on file uploads<\/a>.\n<\/p>"}, "DEFAULT_CONFIG": {"description": "Constant representing the Dialog's configuration properties", "private": "", "guessedname": "DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "callback.argument": {"type": "Object", "description": "The arbitraty argument or arguments to pass to the Connection \ncallback functions", "guessedname": "argument", "guessedtype": "property"}}, "description": "<p>\nDialog is an implementation of Panel that can be used to submit form \ndata.\n<\/p>\n<p>\nBuilt-in functionality for buttons with event handlers is included. \nIf the optional YUI Button dependancy is included on the page, the buttons\ncreated will be instances of YAHOO.widget.Button, otherwise regular HTML buttons\nwill be created.\n<\/p>\n<p>\nForms can be processed in 3 ways -- via an asynchronous Connection utility call, \na simple form POST or GET, or manually. The YUI Connection utility should be\nincluded if you're using the default \"async\" postmethod, but is not required if\nyou're using any of the other postmethod values.\n<\/p>"}, "YAHOO.util.DateLocale": {"name": "YAHOO.util.DateLocale", "namespace": "YAHOO.util", "module": "datasource", "guessedname": "DateLocale", "file": "Type.js", "guessedtype": "property", "shortname": "DateLocale", "requires": "yahoo", "description": "The DateLocale class is a container and base class for all\nlocalised date strings used by YAHOO.util.Date. It is used\ninternally, but may be extended to provide new date localisations.\nTo create your own DateLocale, follow these steps:\n<ol>\n<li>Find an existing locale that matches closely with your needs<\/li>\n<li>Use this as your base class. Use YAHOO.util.DateLocale if nothing\nmatches.<\/li>\n<li>Create your own class as an extension of the base class using\nYAHOO.lang.merge, and add your own localisations where needed.<\/li>\n<\/ol>\nSee the YAHOO.util.DateLocale['en-US'] and YAHOO.util.DateLocale['en-GB']\nclasses which extend YAHOO.util.DateLocale['en'].\nFor example, to implement locales for French french and Canadian french,\nwe would do the following:\n<ol>\n<li>For French french, we have no existing similar locale, so use\nYAHOO.util.DateLocale as the base, and extend it:\n<pre>\nYAHOO.util.DateLocale['fr'] = YAHOO.lang.merge(YAHOO.util.DateLocale, {\na: ['dim', 'lun', 'mar', 'mer', 'jeu', 'ven', 'sam'],\nA: ['dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi'],\nb: ['jan', 'fév', 'mar', 'avr', 'mai', 'jun', 'jui', 'aoû', 'sep', 'oct', 'nov', 'déc'],\nB: ['janvier', 'février', 'mars', 'avril', 'mai', 'juin', 'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre'],\nc: '%a %d %b %Y %T %Z',\np: ['', ''],\nP: ['', ''],\nx: '%d.%m.%Y',\nX: '%T'\n});\n<\/pre>\n<\/li>\n<li>For Canadian french, we start with French french and change the meaning of \\%x:\n<pre>\nYAHOO.util.DateLocale['fr-CA'] = YAHOO.lang.merge(YAHOO.util.DateLocale['fr'], {\nx: '%Y-%m-%d'\n});\n<\/pre>\n<\/li>\n<\/ol>\nWith that, you can use your new locales:\n<pre>\nvar d = new Date(\"2008\/04\/22\");\nYAHOO.util.Date.format(d, {format: \"%A, %d %B == %x\"}, \"fr\");\n<\/pre>\nwill return:\n<pre>\nmardi, 22 avril == 22.04.2008\n<\/pre>\nAnd\n<pre>\nYAHOO.util.Date.format(d, {format: \"%A, %d %B == %x\"}, \"fr-CA\");\n<\/pre>\nWill return:\n<pre>\nmardi, 22 avril == 2008-04-22\n<\/pre>"}, "YAHOO.tool.TestSuite": {"name": "YAHOO.tool.TestSuite", "constructors": [{"params": [{"type": "String||Object", "name": "data", "description": " The name of the test suite or an object containing\na name property as well as setUp and tearDown methods."}], "description": "A test suite that can contain a collection of TestCase and TestSuite objects."}], "namespace": "YAHOO.tool", "module": "yuitest", "guessedname": "TestSuite", "methods": {"tearDown": {"return": {"type": "Void", "description": ""}, "description": "Function to run after each test is executed.", "guessedname": "tearDown", "guessedtype": "function"}, "add": {"return": {"type": "Void", "description": ""}, "params": [{"type": "YAHOO.tool.TestSuite||YAHOO.tool.TestCase", "name": "testObject", "description": " The test suite or test case to add."}], "description": "Adds a test suite or test case to the test suite.", "guessedname": "add", "guessedtype": "function"}, "setUp": {"return": {"type": "Void", "description": ""}, "description": "Function to run before each test is executed.", "guessedname": "setUp", "guessedtype": "function"}}, "file": "TestSuite.js", "guessedtype": "function", "shortname": "TestSuite", "properties": {"name": {"type": "String", "description": "The name of the test suite."}}, "description": "A test suite that can contain a collection of TestCase and TestSuite objects."}, "YAHOO.util.DragDropMgr.ElementWrapper": {"name": "YAHOO.util.DragDropMgr.ElementWrapper", "for": "DragDropMgr", "innerClasses": ["DragDropMgr"], "deprecated": "", "namespace": "YAHOO.util", "module": "dragdrop", "guessedname": "ElementWrapper", "private": "", "file": "DragDropMgr.js", "guessedtype": "function", "shortname": "DragDropMgr.ElementWrapper", "properties": {"el": {"description": "The element", "guessedname": "el", "guessedtype": "property"}, "id": {"description": "The element id", "guessedname": "id", "guessedtype": "property"}, "css": {"description": "A reference to the style property", "guessedname": "css", "guessedtype": "property"}}, "description": "Inner class for cached elements"}, "YAHOO.util.ColumnResizer": {"name": "YAHOO.util.ColumnResizer", "constructors": [{"params": [{"type": "YAHOO.widget.DataTable", "name": "oDataTable", "description": " DataTable instance."}, {"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}, {"type": "HTMLElement", "name": "elTh", "description": " TH element reference."}, {"type": "String", "name": "sHandleElId", "description": " DOM ID of the handle element that causes the resize."}, {"type": "HTMLElement", "name": "elProxy", "description": " Resizer proxy element."}], "description": "ColumnResizer subclasses DragDrop to support resizeable Columns."}], "namespace": "YAHOO.util", "module": "datatable", "guessedname": "ColumnResizer", "methods": {"startDrag": {"params": [{"type": "string", "name": "e", "description": " The drag event"}], "description": "Handles start drag on the Column resizer.", "guessedname": "startDrag", "guessedtype": "function"}, "resetResizerEl": {"description": "Resets resizer element.", "guessedname": "resetResizerEl", "guessedtype": "function"}, "onMouseDown": {"params": [{"type": "string", "name": "e", "description": " The mousedown event"}], "description": "Handles mousedown events on the Column resizer.", "guessedname": "onMouseDown", "guessedtype": "function"}, "onMouseUp": {"params": [{"type": "string", "name": "e", "description": " The mouseup event"}], "description": "Handles mouseup events on the Column resizer.", "guessedname": "onMouseUp", "guessedtype": "function"}, "onDrag": {"params": [{"type": "string", "name": "e", "description": " The drag event"}], "description": "Handles drag events on the Column resizer.", "guessedname": "onDrag", "guessedtype": "function"}, "clickValidator": {"guessedname": "clickValidator", "params": [{"type": "Event", "name": "e", "description": ""}], "description": "Custom clickValidator to ensure Column is not in hidden state.", "private": "", "guessedtype": "function"}}, "extends": "YAHOO.util.DDProxy", "superclass": "YAHOO.util.DDProxy", "file": "ColumnSet.js", "guessedtype": "function", "shortname": "ColumnResizer", "properties": {"editorOptions": {"deprecated": "Pass configs directly to CellEditor constructor."}}, "description": "ColumnResizer subclasses DragDrop to support resizeable Columns."}, "YAHOO.widget.DualSlider": {"name": "YAHOO.widget.DualSlider", "constructors": [{"params": [{"type": "Slider", "name": "minSlider", "description": " The Slider instance used for the min value thumb"}, {"type": "Slider", "name": "maxSlider", "description": " The Slider instance used for the max value thumb"}, {"type": "int", "name": "range", "description": " The number of pixels the thumbs may move within"}, {"type": "Array", "name": "initVals", "description": " (optional) [min,max] Initial thumb placement"}], "description": "A slider with two thumbs, one that represents the min value and \nthe other the max. Actually a composition of two sliders, both with\nthe same background. The constraints for each slider are adjusted\ndynamically so that the min value of the max slider is equal or greater\nto the current value of the min slider, and the max value of the min\nslider is the current value of the max slider.\nConstructor assumes both thumbs are positioned absolutely at the 0 mark on\nthe background."}], "namespace": "YAHOO.widget", "module": "slider", "events": {"ready": {"params": [{"type": "DualSlider", "name": "dualslider", "description": " the DualSlider instance"}], "description": "Event that fires when the slider is finished setting up"}, "slideEnd": {"params": [{"type": "Slider", "name": "activeSlider", "description": " the moving slider"}], "description": "Event that fires when one of the thumbs finishes moving"}, "change": {"params": [{"type": "DualSlider", "name": "dualslider", "description": " the DualSlider instance"}], "description": "Event that fires when either the min or max value changes"}, "slideStart": {"params": [{"type": "Slider", "name": "activeSlider", "description": " the moving slider"}], "description": "Event that fires when one of the thumbs begins to move"}}, "guessedname": "DualSlider", "methods": {"handleMouseDown": {"private": "", "description": "Overrides the onMouseDown for both slider, only moving the active slider", "guessedname": "_handleMouseDown", "guessedtype": "function"}, "_handleSlideStart": {"private": "", "description": "Executed when one of the sliders fires the slideStart event", "guessedname": "_handleSlideStart", "guessedtype": "function"}, "_oneTimeCallback": {"guessedname": "_oneTimeCallback", "params": [{"type": "EventProvider", "name": "o", "description": " Object to attach the event to"}, {"type": "string", "name": "evt", "description": " Name of the event"}, {"type": "Function", "name": "fn", "description": " function to execute once"}], "description": "Schedule an event callback that will execute once, then unsubscribe\nitself.", "private": "", "guessedtype": "function"}, "_handleSlideEnd": {"private": "", "description": "Executed when one of the sliders fires the slideEnd event", "guessedname": "_handleSlideEnd", "guessedtype": "function"}, "_handleDrag": {"private": "", "description": "Overrides the onDrag method for both sliders", "guessedname": "_handleDrag", "guessedtype": "function"}, "selectActiveSlider": {"guessedname": "selectActiveSlider", "params": [{"type": "Event", "name": "e", "description": " the mousedown event"}], "description": "A background click will move the slider thumb nearest to the click.\nOverride if you need different behavior.", "private": "", "guessedtype": "function"}, "setMinValue": {"params": [{"type": "int", "name": "min", "description": " Pixel offset for min thumb"}, {"type": "boolean", "name": "skipAnim", "description": " (optional) Set to true to skip thumb animation.\nDefault false"}, {"type": "boolean", "name": "force", "description": " (optional) ignore the locked setting and set\nvalue anyway. Default false"}, {"type": "boolean", "name": "silent", "description": " (optional) Set to true to skip firing change\nevents. Default false"}], "description": "Set the min thumb position to a new value.", "guessedname": "setMinValue", "guessedtype": "function"}, "setMaxValue": {"params": [{"type": "int", "name": "max", "description": " Pixel offset for max thumb"}, {"type": "boolean", "name": "skipAnim", "description": " (optional) Set to true to skip thumb animation.\nDefault false"}, {"type": "boolean", "name": "force", "description": " (optional) ignore the locked setting and set\nvalue anyway. Default false"}, {"type": "boolean", "name": "silent", "description": " (optional) Set to true to skip firing change\nevents. Default false"}], "description": "Set the max thumb position to a new value.", "guessedname": "setMaxValue", "guessedtype": "function"}, "_cleanEvent": {"guessedname": "_cleanEvent", "params": [{"type": "EventProvider", "name": "o", "description": " object housing the CustomEvent"}, {"type": "string", "name": "evt", "description": " name of the CustomEvent"}], "description": "Clean up the slideEnd event subscribers array, since each one-time\ncallback will be replaced in the event's subscribers property with\nnull. This will cause memory bloat and loss of performance.", "private": "", "guessedtype": "function"}, "updateValue": {"guessedname": "updateValue", "params": [{"type": "boolean", "name": "silent", "description": " (optional) Set to true to skip firing change\nevents. Default false"}], "description": "Executed when one of the sliders is moved", "private": "", "guessedtype": "function"}, "_handleMinChange": {"private": "", "description": "Executed when the min slider fires the change event", "guessedname": "_handleMinChange", "guessedtype": "function"}, "setValues": {"params": [{"type": "int", "name": "min", "description": " Pixel offset to assign to the min thumb"}, {"type": "int", "name": "max", "description": " Pixel offset to assign to the max thumb"}, {"type": "boolean", "name": "skipAnim", "description": " (optional) Set to true to skip thumb animation.\nDefault false"}, {"type": "boolean", "name": "force", "description": " (optional) ignore the locked setting and set\nvalue anyway. Default false"}, {"type": "boolean", "name": "silent", "description": " (optional) Set to true to skip firing change\nevents. Default false"}], "description": "Sets the min and max thumbs to new values.", "guessedname": "setValues", "guessedtype": "function"}, "_handleMaxChange": {"private": "", "description": "Executed when the max slider fires the change event", "guessedname": "_handleMaxChange", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "DualSlider.js", "guessedtype": "function", "shortname": "DualSlider", "properties": {"maxVal": {"type": "int", "description": "The current value of the max thumb. <strong>read only<\/strong>.", "guessedname": "maxVal", "guessedtype": "property"}, "minRange": {"default": "0", "type": "int", "description": "Pixel distance to maintain between thumbs.", "guessedname": "minRange", "guessedtype": "property"}, "minVal": {"type": "int", "description": "The current value of the min thumb. <strong>read only<\/strong>.", "guessedname": "minVal", "guessedtype": "property"}, "maxSlider": {"type": "Slider", "description": "A slider instance that keeps track of the upper value of the range.\n<strong>read only<\/strong>", "guessedname": "maxSlider", "guessedtype": "property"}, "minSlider": {"type": "Slider", "description": "A slider instance that keeps track of the lower value of the range.\n<strong>read only<\/strong>", "guessedname": "minSlider", "guessedtype": "property"}, "isHoriz": {"type": "boolean", "description": "Is the DualSlider oriented horizontally or vertically?\n<strong>read only<\/strong>", "guessedname": "isHoriz", "guessedtype": "property"}, "activeSlider": {"type": "Slider", "description": "The currently active slider (min or max). <strong>read only<\/strong>", "guessedname": "activeSlider", "guessedtype": "property"}}, "description": "A slider with two thumbs, one that represents the min value and \nthe other the max. Actually a composition of two sliders, both with\nthe same background. The constraints for each slider are adjusted\ndynamically so that the min value of the max slider is equal or greater\nto the current value of the min slider, and the max value of the min\nslider is the current value of the max slider.\nConstructor assumes both thumbs are positioned absolutely at the 0 mark on\nthe background."}, "YAHOO.widget.DateCellEditor": {"name": "YAHOO.widget.DateCellEditor", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The DataCellEditor class provides functionality for inline editing\nDataTable cell data with a YUI Calendar."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "DateCellEditor", "methods": {"renderForm": {"description": "Render a Calendar.", "guessedname": "renderForm", "guessedtype": "function"}, "handleDisabledBtns": {"description": "After rendering form, if disabledBtns is set to true, then sets up a mechanism\nto save input without them.", "guessedname": "handleDisabledBtns", "guessedtype": "function"}, "getInputValue": {"description": "Retrieves input value from DateCellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}, "focus": {"description": "Sets focus in DateCellEditor.", "guessedname": "focus", "guessedtype": "function"}, "resetForm": {"description": "Resets DateCellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}}, "extends": "YAHOO.widget.BaseCellEditor", "superclass": "YAHOO.widget.BaseCellEditor", "file": "CellEditor.js", "guessedtype": "function", "shortname": "DateCellEditor", "properties": {"calendar": {"type": "YAHOO.widget.Calendar", "description": "Reference to Calendar instance.", "guessedname": "calendar", "guessedtype": "property"}, "defaultValue": {"default": "new Date()", "type": "Date", "description": "Default value.", "guessedname": "defaultValue", "guessedtype": "property"}}, "description": "The DataCellEditor class provides functionality for inline editing\nDataTable cell data with a YUI Calendar."}, "YAHOO.util.Element": {"name": "YAHOO.util.Element", "configs": {"element": {"type": "HTMLElement", "description": "The HTMLElement the Element instance refers to."}}, "constructors": [{"params": [{"type": "HTMLElement | String", "name": "el", "description": " The html element that \nrepresents the Element."}, {"type": "Object", "name": "map", "description": " A key-value map of initial config names and values"}], "description": "Element provides an wrapper object to simplify adding\nevent listeners, using dom methods, and managing attributes."}], "namespace": "YAHOO.util", "module": "element", "events": {"available": {"description": "Fires when the Element's HTMLElement can be retrieved by Id.\n<p>See: <a href=\"#addListener\">Element.addListener<\/a><\/p>\n<p><strong>Event fields:<\/strong><br>\n<code><String> type<\/code> available<br>\n<code><HTMLElement>\ntarget<\/code> the HTMLElement bound to this Element instance<br>\n<p><strong>Usage:<\/strong><br>\n<code>var handler = function(e) {var target = e.target};<br>\nmyTabs.addListener('available', handler);<\/code><\/p>"}, "contentReady": {"description": "Fires when the Element's HTMLElement subtree is rendered.\n<p>See: <a href=\"#addListener\">Element.addListener<\/a><\/p>\n<p><strong>Event fields:<\/strong><br>\n<code><String> type<\/code> contentReady<br>\n<code><HTMLElement>\ntarget<\/code> the HTMLElement bound to this Element instance<br>\n<p><strong>Usage:<\/strong><br>\n<code>var handler = function(e) {var target = e.target};<br>\nmyTabs.addListener('contentReady', handler);<\/code><\/p>"}, "beforeElementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeElementChange", "description": "Fires before the value for the configuration attribute 'element' changes. Return false to cancel the attribute change."}, "beforeAppendTo": {"description": "Fires before the Element is appended to another Element.\n<p>See: <a href=\"#addListener\">Element.addListener<\/a><\/p>\n<p><strong>Event fields:<\/strong><br>\n<code><String> type<\/code> beforeAppendTo<br>\n<code><HTMLElement\/Element>\ntarget<\/code> the HTMLElement\/Element being appended to \n<p><strong>Usage:<\/strong><br>\n<code>var handler = function(e) {var target = e.target};<br>\nmyTabs.addListener('beforeAppendTo', handler);<\/code><\/p>"}, "elementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "elementChange", "description": "Fires when the value for the configuration attribute 'element' changes."}, "appendTo": {"description": "Fires after the Element is appended to another Element.\n<p>See: <a href=\"#addListener\">Element.addListener<\/a><\/p>\n<p><strong>Event fields:<\/strong><br>\n<code><String> type<\/code> appendTo<br>\n<code><HTMLElement\/Element>\ntarget<\/code> the HTMLElement\/Element being appended to \n<p><strong>Usage:<\/strong><br>\n<code>var handler = function(e) {var target = e.target};<br>\nmyTabs.addListener('appendTo', handler);<\/code><\/p>"}}, "guessedname": "Element", "methods": {"fireQueue": {"description": "Apply any queued set calls.", "guessedname": "fireQueue", "guessedtype": "function"}, "appendChild": {"params": [{"type": "YAHOO.util.Element || HTMLElement", "name": "child", "description": " The element to append."}], "description": "Wrapper for HTMLElement method.", "guessedname": "appendChild", "guessedtype": "function"}, "addListener": {"params": [{"type": "String", "name": "type", "description": " The name of the event to listen for"}, {"type": "Function", "name": "fn", "description": " The handler to call when the event fires"}, {"type": "Any", "name": "obj", "description": " A variable to pass to the handler"}, {"type": "Object", "name": "scope", "description": " The object to use for the scope of the handler"}], "description": "Adds a listener for the given event. These may be DOM or \ncustomEvent listeners. Any event that is fired via fireEvent\ncan be listened for. All handlers receive an event object.", "guessedname": "addListener", "guessedtype": "function"}, "removeClass": {"params": [{"type": "String", "name": "className", "description": " The className to remove"}], "description": "Wrapper for Dom method.", "guessedname": "removeClass", "guessedtype": "function"}, "insertBefore": {"params": [{"type": "HTMLElement", "name": "element", "description": " The HTMLElement to insert"}, {"type": "HTMLElement", "name": "before", "description": " The HTMLElement to insert\nthe element before."}], "description": "Wrapper for HTMLElement method.", "guessedname": "insertBefore", "guessedtype": "function"}, "on": {"params": [{"type": "String", "name": "type", "description": " The name of the event to listen for"}, {"type": "Function", "name": "fn", "description": " The function call when the event fires"}, {"type": "Any", "name": "obj", "description": " A variable to pass to the handler"}, {"type": "Object", "name": "scope", "description": " The object to use for the scope of the handler"}], "description": "Alias for addListener", "guessedname": "on", "guessedtype": "function"}, "getElementsByTagName": {"params": [{"type": "String", "name": "tag", "description": " The tagName to collect"}], "description": "Wrapper for HTMLElement method.", "guessedname": "getElementsByTagName", "guessedtype": "function"}, "getElementsByClassName": {"return": {"type": "Array", "description": "Array of HTMLElements"}, "params": [{"type": "String", "name": "className", "description": " The className to collect"}, {"type": "String", "name": "tag", "description": " (optional) The tag to use in\nconjunction with class name"}], "description": "Wrapper for Dom method.", "guessedname": "getElementsByClassName", "guessedtype": "function"}, "subscribe": {"params": [{"type": "String", "name": "type", "description": " The name of the event to listen for"}, {"type": "Function", "name": "fn", "description": " The function call when the event fires"}, {"type": "Any", "name": "obj", "description": " A variable to pass to the handler"}, {"type": "Object", "name": "scope", "description": " The object to use for the scope of the handler"}], "description": "Alias for addListener", "guessedname": "subscribe", "guessedtype": "function"}, "appendTo": {"params": [{"type": "HTMLElement | Element", "name": "parentNode", "description": " The node to append to"}, {"type": "HTMLElement | Element", "name": "before", "description": " An optional node to insert before"}], "description": "Appends the HTMLElement into either the supplied parentNode.", "guessedname": "appendTo", "guessedtype": "function"}, "getStyle": {"return": {"type": "String", "description": "The current value of the property"}, "params": [{"type": "String", "name": "property", "description": " The style property to retrieve"}], "description": "Wrapper for Dom method.", "guessedname": "getStyle", "guessedtype": "function"}, "setStyle": {"params": [{"type": "String", "name": "property", "description": " The style property to set"}, {"type": "String", "name": "value", "description": " The value to apply to the style property"}], "description": "Wrapper for Dom method.", "guessedname": "setStyle", "guessedtype": "function"}, "removeChild": {"params": [{"type": "HTMLElement", "name": "child", "description": " The HTMLElement to remove"}], "description": "Wrapper for HTMLElement method.", "guessedname": "removeChild", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "map", "description": " A key-value map of initial attribute configs"}], "description": "Registers Element specific attributes.", "guessedname": "initAttributes", "guessedtype": "function"}, "hasChildNodes": {"return": {"type": "Boolean", "description": "Whether or not the element has childNodes"}, "description": "Wrapper for HTMLElement method.", "guessedname": "hasChildNodes", "guessedtype": "function"}, "replaceClass": {"params": [{"type": "String", "name": "oldClassName", "description": " The className to replace"}, {"type": "String", "name": "newClassName", "description": " The className to add"}], "description": "Wrapper for Dom method.", "guessedname": "replaceClass", "guessedtype": "function"}, "replaceChild": {"params": [{"type": "HTMLElement", "name": "newNode", "description": " The HTMLElement to insert"}, {"type": "HTMLElement", "name": "oldNode", "description": " The HTMLElement to replace"}], "description": "Wrapper for HTMLElement method.", "guessedname": "replaceChild", "guessedtype": "function"}, "hasClass": {"return": {"type": "Boolean", "description": "Whether or not the element has the class name"}, "params": [{"type": "String", "name": "className", "description": " The className to add"}], "description": "Wrapper for Dom method.", "guessedname": "hasClass", "guessedtype": "function"}, "_registerHTMLAttr": {"guessedname": "_registerHTMLAttr", "params": [{"type": "YAHOO.util.Element", "name": "element", "description": " The Element instance to\nregister the config to."}, {"type": "String", "name": "key", "description": " The name of the config to register"}, {"type": "Object", "name": "map", "description": " A key-value map of the config's params"}], "description": "Sets the value of the property and fires beforeChange and change events.", "private": "", "guessedtype": "function"}, "removeListener": {"params": [{"type": "String", "name": "type", "description": " The name of the event to listen for"}, {"type": "Function", "name": "fn", "description": " The function call when the event fires"}], "description": "Remove an event listener", "guessedname": "removeListener", "guessedtype": "function"}, "addClass": {"params": [{"type": "String", "name": "className", "description": " The className to add"}], "description": "Wrapper for Dom method.", "guessedname": "addClass", "guessedtype": "function"}}, "uses": ["YAHOO.util.AttributeProvider"], "file": "Element.js", "guessedtype": "function", "shortname": "Element", "properties": {"DOM_EVENTS": {"type": "Object", "description": "Dom events supported by the Element instance.", "guessedname": "DOM_EVENTS", "guessedtype": "property"}}, "description": "Element provides an wrapper object to simplify adding\nevent listeners, using dom methods, and managing attributes."}, "YAHOO.util.DragDrop": {"name": "YAHOO.util.DragDrop", "constructors": [{"params": [{"type": "String", "name": "id", "description": " of the element that is linked to this instance"}, {"type": "String", "name": "sGroup", "description": " the group of related DragDrop objects"}, {"type": "object", "name": "config", "description": " an object containing configurable attributes\nValid properties for DragDrop: \npadding, isTarget, maintainOffset, primaryButtonOnly,"}], "description": "Defines the interface and base operation of items that that can be \ndragged or can be drop targets. It was designed to be extended, overriding\nthe event handlers for startDrag, onDrag, onDragOver, onDragOut.\nUp to three html elements can be associated with a DragDrop instance:\n<ul>\n<li>linked element: the element that is passed into the constructor.\nThis is the element which defines the boundaries for interaction with \nother DragDrop objects.<\/li>\n<li>handle element(s): The drag operation only occurs if the element that \nwas clicked matches a handle element. By default this is the linked \nelement, but there are times that you will want only a portion of the \nlinked element to initiate the drag operation, and the setHandleElId() \nmethod provides a way to define this.<\/li>\n<li>drag element: this represents an the element that would be moved along\nwith the cursor during a drag operation. By default, this is the linked\nelement itself as in {@link YAHOO.util.DD}. setDragElId() lets you define\na separate element that would be moved, as in {@link YAHOO.util.DDProxy}\n<\/li>\n<\/ul>\nThis class should not be instantiated until the onload event to ensure that\nthe associated elements are available.\nThe following would define a DragDrop obj that would interact with any \nother DragDrop obj in the \"group1\" group:\n<pre>\ndd = new YAHOO.util.DragDrop(\"div1\", \"group1\");\n<\/pre>\nSince none of the event handlers have been implemented, nothing would \nactually happen if you were to run the code above. Normally you would \noverride this class or one of the default implementations, but you can \nalso override the methods you want on an instance of the class...\n<pre>\ndd.onDragDrop = function(e, id) {\n alert(\"dd was dropped on \" + id);\n}\n<\/pre>"}], "namespace": "YAHOO.util", "module": "dragdrop", "events": {"startDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs after a mouse down and the drag threshold has been met. The drag threshold default is either 3 pixels of mouse movement or 1 full second of holding the mousedown."}, "mouseUpEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fired from inside DragDropMgr when the drag operation is finished."}, "dragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs every mousemove event while dragging."}, "dragOverEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires every mousemove event while over a drag and drop object."}, "dragOutEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when a dragged object is no longer over an object that had the onDragEnter fire."}, "b4EndDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the endDragEvent. Returning false will cancel."}, "b4StartDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the startDragEvent, returning false will cancel the startDrag Event."}, "b4DragOutEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragOutEvent"}, "endDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires on the mouseup event after a drag has been initiated (startDrag fired)."}, "b4DragOverEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragOverEvent."}, "dragEnterEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs when the dragged object first interacts with another targettable drag and drop object."}, "b4DragDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragDropEvent"}, "b4DragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragEvent."}, "dragDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when the dragged objects is dropped on another."}, "mouseDownEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Provides access to the mousedown event. The mousedown does not always result in a drag operation."}, "invalidDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when the dragged objects is dropped in a location that contains no drop targets."}, "b4MouseDownEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Provides access to the mousedown event, before the mouseDownEvent gets fired. Returning false will cancel the drag."}}, "guessedname": "DragDrop", "methods": {"addToGroup": {"params": [{"type": "string", "name": "sGroup", "description": " the name of the group"}], "description": "Add this instance to a group of related drag\/drop objects. All \ninstances belong to at least one group, and can belong to as many \ngroups as needed.", "guessedname": "addToGroup", "guessedtype": "function"}, "startDrag": {"params": [{"type": "int", "name": "X", "description": " click location"}, {"type": "int", "name": "Y", "description": " click location"}], "description": "Abstract method called after a drag\/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.", "guessedname": "startDrag", "guessedtype": "function"}, "isValidHandleChild": {"return": {"type": "boolean", "description": "true if this is a valid tag type, false if not"}, "params": [{"type": "HTMLElement", "name": "node", "description": " the HTMLElement to evaluate"}], "description": "Checks the tag exclusion list to see if this click should be ignored", "guessedname": "isValidHandleChild", "guessedtype": "function"}, "b4Drag": {"private": "", "description": "Code that executes immediately before the onDrag event", "guessedname": "b4Drag", "guessedtype": "function"}, "lock": {"description": "Lock this instance", "guessedname": "lock", "guessedtype": "function"}, "onDragEnter": {"params": [{"type": "Event", "name": "e", "description": " the mousemove event"}, {"type": "String|DragDrop[]", "name": "id", "description": " In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more \ndragdrop items being hovered over."}], "description": "Abstract method called when this element fist begins hovering over \nanother DragDrop obj", "guessedname": "onDragEnter", "guessedtype": "function"}, "b4StartDrag": {"private": "", "description": "Code that executes immediately before the startDrag event", "guessedname": "b4StartDrag", "guessedtype": "function"}, "onMouseDown": {"params": [{"type": "Event", "name": "e", "description": " the mousedown event"}], "description": "Event handler that fires when a drag\/drop obj gets a mousedown", "guessedname": "onMouseDown", "guessedtype": "function"}, "setOuterHandleElId": {"params": [{"type": "", "name": "id", "description": " the id of the element that will be used to initiate the drag"}], "description": "Allows you to set an element outside of the linked element as a drag \nhandle", "guessedname": "setOuterHandleElId", "guessedtype": "function"}, "unlock": {"description": "Unlock this instace", "guessedname": "unlock", "guessedtype": "function"}, "clearTicks": {"description": "Clears any tick interval defined for this instance", "guessedname": "clearTicks", "guessedtype": "function"}, "setStartPosition": {"guessedname": "setStartPosition", "params": [{"type": "", "name": "pos", "description": " current position (from previous lookup)"}], "description": "Sets the start position of the element. This is set when the obj\nis initialized, the reset when a drag is started.", "private": "", "guessedtype": "function"}, "resetConstraints": {"description": "resetConstraints must be called if you manually reposition a dd element.", "guessedname": "resetConstraints", "guessedtype": "function"}, "clickValidator": {"params": [{"type": "Event", "name": "e", "description": ""}], "description": "Method validates that the clicked element\nwas indeed the handle or a valid child of the handle", "guessedname": "clickValidator", "guessedtype": "function"}, "handleMouseDown": {"guessedname": "handleMouseDown", "params": [{"type": "Event", "name": "e", "description": ""}, {"type": "YAHOO.util.DragDrop", "name": "oDD", "description": " the clicked dd object (this dd obj)"}], "description": "Fired when this object is clicked", "private": "", "guessedtype": "function"}, "onDragOver": {"params": [{"type": "Event", "name": "e", "description": " the mousemove event"}, {"type": "String|DragDrop[]", "name": "id", "description": " In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items \nbeing hovered over."}], "description": "Abstract method called when this element is hovering over another \nDragDrop obj", "guessedname": "onDragOver", "guessedtype": "function"}, "addInvalidHandleType": {"params": [{"type": "string", "name": "tagName", "description": " the type of element to exclude"}], "description": "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.", "guessedname": "addInvalidHandleType", "guessedtype": "function"}, "setDragElId": {"params": [{"type": "string", "name": "id", "description": " the id of the element that will be used to initiate the drag"}], "description": "Allows you to specify that an element other than the linked element \nwill be moved with the cursor during a drag", "guessedname": "setDragElId", "guessedtype": "function"}, "setXConstraint": {"params": [{"type": "int", "name": "iLeft", "description": " the number of pixels the element can move to the left"}, {"type": "int", "name": "iRight", "description": " the number of pixels the element can move to the \nright"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the \nelement\nshould move iTickSize pixels at a time."}], "description": "By default, the element can be dragged any place on the screen. Use \nthis method to limit the horizontal travel of the element. Pass in \n0,0 for the parameters if you want to lock the drag to the y axis.", "guessedname": "setXConstraint", "guessedtype": "function"}, "getTick": {"return": {"type": "int", "description": "the closest tick"}, "description": "Normally the drag element is moved pixel by pixel, but we can specify \nthat it move a number of pixels at a time. This method resolves the \nlocation when we have it set up like this.", "private": "", "params": [{"type": "int", "name": "val", "description": " where we want to place the object"}, {"type": "int[]", "name": "tickArray", "description": " sorted array of valid points"}], "guessedname": "getTick", "guessedtype": "function"}, "init": {"params": [{"type": "", "name": "id", "description": " the id of the linked element"}, {"type": "String", "name": "sGroup", "description": " the group of related items"}, {"type": "object", "name": "config", "description": " configuration attributes"}], "description": "Sets up the DragDrop object. Must be called in the constructor of any\nYAHOO.util.DragDrop subclass", "guessedname": "init", "guessedtype": "function"}, "clearConstraints": {"description": "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.", "guessedname": "clearConstraints", "guessedtype": "function"}, "getEl": {"return": {"type": "HTMLElement", "description": "the html element"}, "description": "Returns a reference to the linked element", "guessedname": "getEl", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "string representation of the dd obj"}, "description": "toString method", "guessedname": "toString", "guessedtype": "function"}, "onMouseUp": {"params": [{"type": "Event", "name": "e", "description": " the mouseup event"}], "description": "Event handler that fires when a drag\/drop obj gets a mouseup", "guessedname": "onMouseUp", "guessedtype": "function"}, "removeInvalidHandleType": {"params": [{"type": "string", "name": "tagName", "description": " the type of element to unexclude"}], "description": "Unsets an excluded tag name set by addInvalidHandleType", "guessedname": "removeInvalidHandleType", "guessedtype": "function"}, "getTargetCoord": {"return": {"type": "", "description": "an object that contains the coordinates (Object.x and Object.y)"}, "description": "Finds the location the element should be placed if we want to move\nit to where the mouse location less the click offset would place us.", "private": "", "params": [{"type": "int", "name": "iPageX", "description": " the X coordinate of the click"}, {"type": "int", "name": "iPageY", "description": " the Y coordinate of the click"}], "guessedname": "getTargetCoord", "guessedtype": "function"}, "setHandleElId": {"params": [{"type": "string", "name": "id", "description": " the id of the element that will be used to \ninitiate the drag."}], "description": "Allows you to specify a child of the linked element that should be \nused to initiate the drag operation. An example of this would be if \nyou have a content div with text and links. Clicking anywhere in the \ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element \nthat starts the drag operation.", "guessedname": "setHandleElId", "guessedtype": "function"}, "onDragOut": {"params": [{"type": "Event", "name": "e", "description": " the mousemove event"}, {"type": "String|DragDrop[]", "name": "id", "description": " In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items \nthat the mouse is no longer over."}], "description": "Abstract method called when we are no longer hovering over an element", "guessedname": "onDragOut", "guessedtype": "function"}, "onInvalidDrop": {"params": [{"type": "Event", "name": "e", "description": " the mouseup event"}], "description": "Abstract method called when this item is dropped on an area with no\ndrop target", "guessedname": "onInvalidDrop", "guessedtype": "function"}, "setInitialPosition": {"guessedname": "setInitPosition", "params": [{"type": "int", "name": "diffX", "description": " the X offset, default 0"}, {"type": "int", "name": "diffY", "description": " the Y offset, default 0"}], "description": "Stores the initial placement of the linked element.", "private": "", "guessedtype": "function"}, "b4DragDrop": {"private": "", "description": "Code that executes immediately before the onDragDrop event", "guessedname": "b4DragDrop", "guessedtype": "function"}, "removeFromGroup": {"params": [{"type": "string", "name": "sGroup", "description": " The group to drop"}], "description": "Remove's this instance from the supplied interaction group", "guessedname": "removeFromGroup", "guessedtype": "function"}, "initTarget": {"params": [{"type": "", "name": "id", "description": " the id of the linked element"}, {"type": "String", "name": "sGroup", "description": " the group of related items"}, {"type": "object", "name": "config", "description": " configuration attributes"}], "description": "Initializes Targeting functionality only... the object does not\nget a mousedown handler.", "guessedname": "initTarget", "guessedtype": "function"}, "removeInvalidHandleClass": {"params": [{"type": "string", "name": "cssClass", "description": " the class of the element(s) you wish to \nre-enable"}], "description": "Unsets an invalid css class", "guessedname": "removeInvalidHandleClass", "guessedtype": "function"}, "onDragDrop": {"params": [{"type": "Event", "name": "e", "description": " the mouseup event"}, {"type": "String|DragDrop[]", "name": "id", "description": " In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this \nwas dropped on."}], "description": "Abstract method called when this item is dropped on another DragDrop \nobj", "guessedname": "onDragDrop", "guessedtype": "function"}, "setYTicks": {"private": "", "description": "Create the array of vertical tick marks if an interval was specified in \nsetYConstraint().", "guessedname": "setYTicks", "guessedtype": "function"}, "b4EndDrag": {"private": "", "description": "Code that executes immediately before the endDrag event", "guessedname": "b4EndDrag", "guessedtype": "function"}, "removeInvalidHandleId": {"params": [{"type": "string", "name": "id", "description": " the id of the element to re-enable"}], "description": "Unsets an invalid handle id", "guessedname": "removeInvalidHandleId", "guessedtype": "function"}, "onAvailable": {"description": "Override the onAvailable method to do what is needed after the initial\nposition was determined.", "guessedname": "onAvailable", "guessedtype": "function"}, "getDragEl": {"return": {"type": "HTMLElement", "description": "the html element"}, "description": "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another \nelement. An example of this can be found in YAHOO.util.DDProxy", "guessedname": "getDragEl", "guessedtype": "function"}, "onDrag": {"params": [{"type": "Event", "name": "e", "description": " the mousemove event"}], "description": "Abstract method called during the onMouseMove event while dragging an \nobject.", "guessedname": "onDrag", "guessedtype": "function"}, "applyConfig": {"description": "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and \nDragDrop in order to get all of the parameters that are available in\neach object.", "guessedname": "applyConfig", "guessedtype": "function"}, "on": {"description": "Shortcut for EventProvider.subscribe, see <a href=\"YAHOO.util.EventProvider.html#subscribe\">YAHOO.util.EventProvider.subscribe<\/a>", "guessedname": "on", "guessedtype": "function"}, "b4DragOver": {"private": "", "description": "Code that executes immediately before the onDragOver event", "guessedname": "b4DragOver", "guessedtype": "function"}, "setYConstraint": {"params": [{"type": "int", "name": "iUp", "description": " the number of pixels the element can move up"}, {"type": "int", "name": "iDown", "description": " the number of pixels the element can move down"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the \nelement should move iTickSize pixels at a time."}], "description": "By default, the element can be dragged any place on the screen. Set \nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.", "guessedname": "setYConstraint", "guessedtype": "function"}, "endDrag": {"params": [{"type": "Event", "name": "e", "description": " the mouseup event"}], "description": "Fired when we are done dragging the object", "guessedname": "endDrag", "guessedtype": "function"}, "isLocked": {"return": {"type": "boolean", "description": "true if this obj or all drag\/drop is locked, else \nfalse"}, "description": "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag\/drop is disabled on the page.)", "guessedname": "isLocked", "guessedtype": "function"}, "addInvalidHandleClass": {"params": [{"type": "string", "name": "cssClass", "description": " the class of the elements you wish to ignore"}], "description": "Lets you specify a css class of elements that will not initiate a drag", "guessedname": "addInvalidHandleClass", "guessedtype": "function"}, "handleOnAvailable": {"private": "", "description": "Executed when the linked element is available", "guessedname": "handleOnAvailable", "guessedtype": "function"}, "setPadding": {"params": [{"type": "int", "name": "iTop", "description": " Top pad"}, {"type": "int", "name": "iRight", "description": " Right pad"}, {"type": "int", "name": "iBot", "description": " Bot pad"}, {"type": "int", "name": "iLeft", "description": " Left pad"}], "description": "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations. \nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.", "guessedname": "setPadding", "guessedtype": "function"}, "unreg": {"description": "Remove all drag and drop hooks for this element", "guessedname": "unreg", "guessedtype": "function"}, "b4MouseDown": {"guessedname": "b4MouseDown", "params": [{"type": "Event", "name": "e", "description": " the mousedown event"}], "description": "Code executed immediately before the onMouseDown event", "private": "", "guessedtype": "function"}, "b4DragOut": {"private": "", "description": "Code that executes immediately before the onDragOut event", "guessedname": "b4DragOut", "guessedtype": "function"}, "addInvalidHandleId": {"params": [{"type": "string", "name": "id", "description": " the element id of the element you wish to ignore"}], "description": "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag", "guessedname": "addInvalidHandleId", "guessedtype": "function"}, "setXTicks": {"private": "", "description": "Create the array of horizontal tick marks if an interval was specified\nin setXConstraint().", "guessedname": "setXTicks", "guessedtype": "function"}}, "file": "DragDrop.js", "guessedtype": "function", "shortname": "DragDrop", "properties": {"maxX": {"guessedname": "maxX", "type": "int", "description": "The right constraint", "private": "", "guessedtype": "property"}, "maxY": {"guessedname": "maxY", "type": "int", "description": "The down constraint", "private": "", "guessedtype": "property"}, "hasOuterHandles": {"default": "false", "type": "boolean", "description": "By default, drags can only be initiated if the mousedown occurs in the\nregion the linked element is. This is done in part to work around a\nbug in some browsers that mis-report the mousedown if the previous\nmouseup happened outside of the window. This property is set to true\nif outer handles are defined.", "guessedname": "hasOuterHandles", "guessedtype": "property"}, "_domRef": {"private": "", "description": "Cached reference to the linked element", "guessedname": "_domRef", "guessedtype": "property"}, "yTicks": {"type": "int[]", "description": "Array of pixel locations the element will snap to if we specified a \nvertical graduation\/interval. This array is generated automatically \nwhen you define a tick interval.", "guessedname": "yTicks", "guessedtype": "property"}, "startPageY": {"guessedname": "startPageY", "type": "int", "description": "The linked element's absolute X position at the time the drag was \nstarted", "private": "", "guessedtype": "property"}, "id": {"type": "String", "description": "The id of the element associated with this object. This is what we \nrefer to as the \"linked element\" because the size and position of \nthis element is used to determine when the drag and drop objects have \ninteracted.", "guessedname": "id", "guessedtype": "property"}, "deltaX": {"guessedname": "deltaX", "type": "int", "description": "The difference between the click position and the source element's location", "private": "", "guessedtype": "property"}, "deltaY": {"guessedname": "deltaY", "type": "int", "description": "The difference between the click position and the source element's location", "private": "", "guessedtype": "property"}, "__ygDragDrop": {"private": "", "description": "Internal typeof flag", "guessedname": "__ygDragDrop", "guessedtype": "property"}, "overlap": {"type": "YAHOO.util.Region", "description": "Property that is assigned to a drag and drop object when testing to\nsee if it is being targeted by another dd object. This is a region\nthat represents the area the draggable element overlaps this target.\nDDM.getBestMatch uses this property to compare the size of the overlap\nto that of other targets in order to determine the closest match in\nINTERSECT mode when multiple targets are part of the same interaction.", "guessedname": "overlap", "guessedtype": "property"}, "minX": {"guessedname": "minX", "type": "int", "description": "The left constraint", "private": "", "guessedtype": "property"}, "minY": {"guessedname": "minY", "type": "int", "description": "The up constraint", "private": "", "guessedtype": "property"}, "invalidHandleIds": {"type": "{string: string}", "description": "An associative array of ids for elements that will be ignored if clicked", "guessedname": "invalidHandleIds", "guessedtype": "property"}, "config": {"type": "object", "description": "Configuration attributes passed into the constructor", "guessedname": "config", "guessedtype": "property"}, "dragElId": {"guessedname": "dragElId", "type": "String", "description": "The id of the element that will be dragged. By default this is same \nas the linked element , but could be changed to another element. Ex: \nYAHOO.util.DDProxy", "private": "", "guessedtype": "property"}, "available": {"type": "boolean", "description": "The availabe property is false until the linked dom element is accessible.", "guessedname": "available", "guessedtype": "property"}, "invalidHandleClasses": {"type": "string[]", "description": "An indexted array of css class names for elements that will be ignored\nif clicked.", "guessedname": "invalidHandleClasses", "guessedtype": "property"}, "isTarget": {"type": "boolean", "description": "By default, all instances can be a drop target. This can be disabled by\nsetting isTarget to false.", "guessedname": "isTarget", "guessedtype": "property"}, "invalidHandleTypes": {"type": "{string: string}", "description": "An associative array of HTML tags that will be ignored if clicked.", "guessedname": "invalidHandleTypes", "guessedtype": "property"}, "startPageX": {"guessedname": "startPageX", "type": "int", "description": "The linked element's absolute X position at the time the drag was \nstarted", "private": "", "guessedtype": "property"}, "cursorIsOver": {"type": "boolean", "description": "Property that is assigned to a drag and drop object when testing to\nsee if it is being targeted by another dd object. This property\ncan be used in intersect mode to help determine the focus of\nthe mouse interaction. DDM.getBestMatch uses this property first to\ndetermine the closest match in INTERSECT mode when multiple targets\nare part of the same interaction.", "guessedname": "cursorIsOver", "guessedtype": "property"}, "constrainY": {"guessedname": "constrainY", "type": "boolean", "description": "Set to true when vertical contraints are applied", "private": "", "guessedtype": "property"}, "constrainX": {"guessedname": "constrainX", "type": "boolean", "description": "Set to true when horizontal contraints are applied", "private": "", "guessedtype": "property"}, "padding": {"type": "int[]", "description": "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.", "guessedname": "padding", "guessedtype": "property"}, "dragOnly": {"type": "Boolean", "description": "If this flag is true, do not fire drop events. The element is a drag only element (for movement not dropping)", "guessedname": "dragOnly", "guessedtype": "property"}, "groups": {"type": "{string: string}", "description": "The group defines a logical collection of DragDrop objects that are \nrelated. Instances only get events when interacting with other \nDragDrop object in the same group. This lets us define multiple \ngroups using a single DragDrop subclass if we want.", "guessedname": "groups", "guessedtype": "property"}, "maintainOffset": {"type": "boolean", "description": "Maintain offsets when we resetconstraints. Set to true when you want\nthe position of the element relative to its parent to stay the same\nwhen the page changes", "guessedname": "maintainOffset", "guessedtype": "property"}, "handleElId": {"guessedname": "handleElId", "type": "String", "description": "the id of the element that initiates the drag operation. By default \nthis is the linked element, but could be changed to be a child of this\nelement. This lets us do things like only starting the drag when the \nheader element within the linked html element is clicked.", "private": "", "guessedtype": "property"}, "xTicks": {"type": "int[]", "description": "Array of pixel locations the element will snap to if we specified a \nhorizontal graduation\/interval. This array is generated automatically\nwhen you define a tick interval.", "guessedname": "xTicks", "guessedtype": "property"}, "locked": {"guessedname": "locked", "type": "boolean", "description": "Individual drag\/drop instances can be locked. This will prevent \nonmousedown start drag.", "private": "", "guessedtype": "property"}, "useShim": {"type": "Boolean", "description": "If this flag is true, a shim will be placed over the screen\/viewable area to track mouse events. Should help with dragging elements over iframes and other controls.", "guessedname": "useShim", "guessedtype": "property"}, "events": {"type": "object", "description": "An Object Literal containing the events that we will be using: mouseDown, b4MouseDown, mouseUp, b4StartDrag, startDrag, b4EndDrag, endDrag, mouseUp, drag, b4Drag, invalidDrop, b4DragOut, dragOut, dragEnter, b4DragOver, dragOver, b4DragDrop, dragDrop\nBy setting any of these to false, then event will not be fired.", "guessedname": "events", "guessedtype": "property"}, "primaryButtonOnly": {"type": "boolean", "description": "By default the drag and drop instance will only respond to the primary\nbutton click (left button for a right-handed mouse). Set to true to\nallow drag and drop to start with any mouse click that is propogated\nby the browser", "guessedname": "primaryButtonOnly", "guessedtype": "property"}}, "description": "Defines the interface and base operation of items that that can be \ndragged or can be drop targets. It was designed to be extended, overriding\nthe event handlers for startDrag, onDrag, onDragOver, onDragOut.\nUp to three html elements can be associated with a DragDrop instance:\n<ul>\n<li>linked element: the element that is passed into the constructor.\nThis is the element which defines the boundaries for interaction with \nother DragDrop objects.<\/li>\n<li>handle element(s): The drag operation only occurs if the element that \nwas clicked matches a handle element. By default this is the linked \nelement, but there are times that you will want only a portion of the \nlinked element to initiate the drag operation, and the setHandleElId() \nmethod provides a way to define this.<\/li>\n<li>drag element: this represents an the element that would be moved along\nwith the cursor during a drag operation. By default, this is the linked\nelement itself as in {@link YAHOO.util.DD}. setDragElId() lets you define\na separate element that would be moved, as in {@link YAHOO.util.DDProxy}\n<\/li>\n<\/ul>\nThis class should not be instantiated until the onload event to ensure that\nthe associated elements are available.\nThe following would define a DragDrop obj that would interact with any \nother DragDrop obj in the \"group1\" group:\n<pre>\ndd = new YAHOO.util.DragDrop(\"div1\", \"group1\");\n<\/pre>\nSince none of the event handlers have been implemented, nothing would \nactually happen if you were to run the code above. Normally you would \noverride this class or one of the default implementations, but you can \nalso override the methods you want on an instance of the class...\n<pre>\ndd.onDragDrop = function(e, id) {\n alert(\"dd was dropped on \" + id);\n}\n<\/pre>"}, "YAHOO.widget.ColumnSet": {"name": "YAHOO.widget.ColumnSet", "constructors": [{"params": [{"type": "Object[]", "name": "aDefinitions", "description": " Array of object literals that define cells in\nthe THEAD."}], "description": "The ColumnSet class defines and manages a DataTable's Columns,\nincluding nested hierarchies and access to individual Column instances."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "ColumnSet", "methods": {"getColumn": {"return": {"type": "YAHOO.widget.Column", "description": "Column instance."}, "params": [{"type": "String | Number", "name": "column", "description": " Column key or ColumnSet key index."}], "description": "Returns Column instance with given key or ColumnSet key index.", "guessedname": "getColumn", "guessedtype": "function"}, "getDefinitions": {"return": {"type": "Object[]", "description": "Array of object literal Column definitions."}, "description": "Public accessor to the definitions array.", "guessedname": "getDefinitions", "guessedtype": "function"}, "_init": {"guessedname": "_init", "params": [{"type": "Object[]", "name": "aDefinitions", "description": " Array of object literals that define cells in\nthe THEAD ."}], "description": "Initializes ColumnSet instance with data from Column definitions.", "private": "", "guessedtype": "function"}, "getId": {"return": {"type": "String", "description": "Unique name of the ColumnSet instance."}, "description": "Returns unique name of the ColumnSet instance.", "guessedname": "getId", "guessedtype": "function"}, "getColumnById": {"return": {"type": "YAHOO.widget.Column", "description": "Column instance."}, "params": [{"type": "String", "name": "column", "description": " Column ID."}], "description": "Returns Column instance with given ID.", "guessedname": "getColumnById", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the ColumnSet instance."}, "description": "ColumnSet instance name, for logging.", "guessedname": "toString", "guessedtype": "function"}, "getDescendants": {"parem": "{YAHOO.widget.Column} Column instance.", "return": {"type": "Array", "description": "Array including the Column itself and all descendants (if any)."}, "description": "Public accessor returns array of given Column's desendants (if any), including itself.", "guessedname": "getDescendants", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "ColumnSet.js", "guessedtype": "function", "shortname": "ColumnSet", "properties": {"flat": {"default": "[]", "type": "YAHOO.widget.Column[]", "description": "Flattened representation of all Columns.", "guessedname": "flat", "guessedtype": "property"}, "_aDefinitions": {"guessedname": "_aDefinitions", "type": "Object[]", "description": "Array of object literal Column definitions passed to the constructor.", "private": "", "guessedtype": "property"}, "keys": {"default": "[]", "type": "YAHOO.widget.Column[]", "description": "Array of Columns that map one-to-one to a table column.", "guessedname": "keys", "guessedtype": "property"}, "_sId": {"guessedname": "_sId", "type": "String", "description": "Unique instance name.", "private": "", "guessedtype": "property"}, "tree": {"type": "YAHOO.widget.Column[]", "description": "Top-down tree representation of Column hierarchy.", "guessedname": "tree", "guessedtype": "property"}, "ColumnSet._nCount": {"description": "Internal class variable to index multiple ColumnSet instances.", "private": "", "static": "", "guessedname": "_nCount", "guessedtype": "property", "type": "Number"}, "headers": {"default": "[]", "type": "String[]", "description": "ID index of nested parent hierarchies for HEADERS accessibility attribute.", "guessedname": "headers", "guessedtype": "property"}}, "description": "The ColumnSet class defines and manages a DataTable's Columns,\nincluding nested hierarchies and access to individual Column instances."}, "YAHOO.widget.Carousel": {"name": "YAHOO.widget.Carousel", "configs": {"navigation": {"default": "<br>\n{ prev: null, \/\/ the previous navigation element<br>\nnext: null } \/\/ the next navigation element", "type": "Object", "description": "The set of navigation controls for Carousel"}, "scrollIncrement": {"default": "1", "type": "Number", "description": "The number of items to scroll by for arrow keys."}, "selectedItem": {"type": "Number", "description": "The index of the selected item."}, "firstVisible": {"default": "0", "type": "Number", "description": "The index to start the Carousel from (indexes begin\nfrom zero)"}, "selectOnScroll": {"default": "true", "type": "Boolean", "description": "Set this to true to automatically set focus to\nfollow scrolling in the Carousel."}, "numVisible": {"default": "3", "type": "Number", "description": "The number of visible items in the Carousel's\nviewport."}, "animation": {"default": "<br>\n{ speed: 0, \/\/ the animation speed (in seconds)<br>\neffect: null } \/\/ the animation effect (like\nYAHOO.util.Easing.easeOut)", "type": "Object", "description": "The optional animation attributes for the Carousel."}, "numItems": {"type": "Number", "description": "The number of items in the Carousel."}, "isCircular": {"default": "false", "type": "Boolean", "description": "Set this to true to wrap scrolling of the contents\nin the Carousel."}, "currentPage": {"type": "Number", "description": "The current page number (read-only.)"}, "autoPlay": {"type": "Number", "description": "Set this to time in milli-seconds to have the\nCarousel automatically scroll the contents."}, "isVertical": {"default": "false", "type": "Boolean", "description": "True if the orientation of the Carousel is vertical"}, "revealAmount": {"default": "0", "type": "Number", "description": "The percentage of the item to be revealed on each\nside of the Carousel (before and after the first and last item\nin the Carousel's viewport.)"}}, "constructors": [{"params": [{"type": "HTMLElement | String", "name": "el", "description": " The HTML element that represents the\nthe container that houses the Carousel."}, {"type": "Object", "name": "cfg", "description": " (optional) The configuration values"}], "description": "The Carousel widget."}], "namespace": "YAHOO.widget", "module": "carousel", "events": {"selectedItemChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "selectedItemChange", "description": "Fires when the value for the configuration attribute 'selectedItem' changes."}, "beforeIsCircularChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeIsCircularChange", "description": "Fires before the value for the configuration attribute 'isCircular' changes. Return false to cancel the attribute change."}, "render": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is rendered. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "renderEvent", "guessedtype": "property"}, "show": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is shown. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "showEvent", "guessedtype": "property"}, "loadItems": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel needs more items to be loaded for\ndisplaying them. Passes back the first and last visible items in the\nCarousel, and the number of items needed to be loaded. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "loadItemsEvent", "guessedtype": "property"}, "focus": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel gains focus. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "focusEvent", "guessedtype": "property"}, "itemAdded": {"type": "YAHOO.util.CustomEvent", "description": "Fires when an item has been added to the Carousel. Passes\nback the content of the item that would be added, the index at which the\nitem would be added, and the event itself. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "itemAddedEvent", "guessedtype": "property"}, "numItemsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "numItemsChange", "description": "Fires when the value for the configuration attribute 'numItems' changes."}, "currentPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "currentPageChange", "description": "Fires when the value for the configuration attribute 'currentPage' changes."}, "beforeNumVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNumVisibleChange", "description": "Fires before the value for the configuration attribute 'numVisible' changes. Return false to cancel the attribute change."}, "itemRemoved": {"type": "YAHOO.util.CustomEvent", "description": "Fires when an item has been removed from the Carousel.\nPasses back the content of the item that would be removed, the index\nfrom which the item would be removed, and the event itself. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "itemRemovedEvent", "guessedtype": "property"}, "autoPlayChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "autoPlayChange", "description": "Fires when the value for the configuration attribute 'autoPlay' changes."}, "beforeHide": {"type": "YAHOO.util.CustomEvent", "description": "Fires before the Carousel is hidden. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "beforeHideEvent", "guessedtype": "property"}, "hide": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is hidden. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "hideEvent", "guessedtype": "property"}, "beforeFirstVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeFirstVisibleChange", "description": "Fires before the value for the configuration attribute 'firstVisible' changes. Return false to cancel the attribute change."}, "scrollIncrementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "scrollIncrementChange", "description": "Fires when the value for the configuration attribute 'scrollIncrement' changes."}, "beforeAnimationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeAnimationChange", "description": "Fires before the value for the configuration attribute 'animation' changes. Return false to cancel the attribute change."}, "firstVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "firstVisibleChange", "description": "Fires when the value for the configuration attribute 'firstVisible' changes."}, "selectOnScrollChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "selectOnScrollChange", "description": "Fires when the value for the configuration attribute 'selectOnScroll' changes."}, "navigationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "navigationChange", "description": "Fires when the value for the configuration attribute 'navigation' changes."}, "blur": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel loses focus. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "blurEvent", "guessedtype": "property"}, "afterScroll": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel has scrolled to the previous or\nnext page. Passes back the index of the first and last visible items in\nthe Carousel. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "afterScrollEvent", "guessedtype": "property"}, "beforeSelectOnScrollChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSelectOnScrollChange", "description": "Fires before the value for the configuration attribute 'selectOnScroll' changes. Return false to cancel the attribute change."}, "beforeRevealAmountChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRevealAmountChange", "description": "Fires before the value for the configuration attribute 'revealAmount' changes. Return false to cancel the attribute change."}, "pageChange": {"type": "YAHOO.util.CustomEvent", "description": "Fires after the Carousel has scrolled to the previous or\nnext page. Passes back the page number of the current page. Note\nthat the first page number is zero. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "pageChangeEvent", "guessedtype": "property"}, "numVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "numVisibleChange", "description": "Fires when the value for the configuration attribute 'numVisible' changes."}, "itemSelected": {"type": "YAHOO.util.CustomEvent", "description": "Fires when an item has been selected in the Carousel.\nPasses back the index of the selected item in the Carousel. Note, that\nthe index begins from zero. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "itemSelectedEvent", "guessedtype": "property"}, "animationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "animationChange", "description": "Fires when the value for the configuration attribute 'animation' changes."}, "beforeNumItemsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNumItemsChange", "description": "Fires before the value for the configuration attribute 'numItems' changes. Return false to cancel the attribute change."}, "beforeScroll": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is about to scroll to the previous\nor next page. Passes back the index of the first and last visible items\nin the Carousel and the direction (backward\/forward) of the scroll. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "beforeScrollEvent", "guessedtype": "property"}, "beforeCurrentPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCurrentPageChange", "description": "Fires before the value for the configuration attribute 'currentPage' changes. Return false to cancel the attribute change."}, "beforeShow": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is about to be shown. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "beforeShowEvent", "guessedtype": "property"}, "revealAmountChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "revealAmountChange", "description": "Fires when the value for the configuration attribute 'revealAmount' changes."}, "beforeSelectedItemChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSelectedItemChange", "description": "Fires before the value for the configuration attribute 'selectedItem' changes. Return false to cancel the attribute change."}, "beforeScrollIncrementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeScrollIncrementChange", "description": "Fires before the value for the configuration attribute 'scrollIncrement' changes. Return false to cancel the attribute change."}, "beforeAutoPlayChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeAutoPlayChange", "description": "Fires before the value for the configuration attribute 'autoPlay' changes. Return false to cancel the attribute change."}, "beforeNavigationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNavigationChange", "description": "Fires before the value for the configuration attribute 'navigation' changes. Return false to cancel the attribute change."}, "stopAutoPlay": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the auto play has been stopped in the Carousel.\nSee\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "stopAutoPlayEvent", "guessedtype": "property"}, "beforePageChange": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the Carousel is about to scroll to the previous\nor next page. Passes back the page number of the current page. Note\nthat the first page number is zero. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "beforePageChangeEvent", "guessedtype": "property"}, "isCircularChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "isCircularChange", "description": "Fires when the value for the configuration attribute 'isCircular' changes."}, "beforeIsVerticalChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeIsVerticalChange", "description": "Fires before the value for the configuration attribute 'isVertical' changes. Return false to cancel the attribute change."}, "isVerticalChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "isVerticalChange", "description": "Fires when the value for the configuration attribute 'isVertical' changes."}, "navigationStateChange": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the state of either one of the navigation\nbuttons are changed from enabled to disabled or vice versa. Passes back\nthe state (true\/false) of the previous and next buttons. The value true\nsignifies the button is enabled, false signifies disabled. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "navigationStateChangeEvent", "guessedtype": "property"}, "startAutoPlay": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the auto play has started in the Carousel. See\n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a>\nfor more information on listening for this event.", "guessedname": "startAutoPlayEvent", "guessedtype": "property"}}, "guessedname": "Carousel", "methods": {"syncNavigation": {"description": "Fire custom events for enabling\/disabling navigation elements.", "private": ""}, "_validateAnimation": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate animation parameters.", "protected": "", "params": [{"type": "Object", "name": "cfg", "description": " The animation configuration"}], "guessedname": "_validateAnimation", "guessedtype": "function"}, "render": {"return": {"type": "Boolean", "description": "Status of the operation"}, "description": "Render the Carousel.", "params": [{"type": "HTMLElement | String", "name": "appendTo", "description": " The element to which the\nCarousel should be appended prior to rendering."}], "guessedname": "render", "guessedtype": "function", "public": ""}, "show": {"description": "Display the Carousel.", "public": "", "guessedname": "show", "guessedtype": "function"}, "scrollTo": {"public": "", "params": [{"type": "", "name": "item", "description": " Number The index of the element to position at."}, {"type": "", "name": "dontSelect", "description": " Boolean True if select should be avoided"}], "description": "Scroll the Carousel to make the item the first visible item.", "guessedname": "scrollTo", "guessedtype": "function"}, "loadItems": {"description": "The load the required set of items that are needed for display.", "private": ""}, "_updateTabIndex": {"protected": "", "params": [{"type": "Object", "name": "el", "description": " The element to be focussed"}], "description": "Set the correct tab index for the Carousel items.", "guessedname": "_updateTabIndex", "guessedtype": "function"}, "focus": {"description": "Set focus on the Carousel.", "public": "", "guessedname": "focus", "guessedtype": "function"}, "_setupCarouselNavigation": {"protected": "", "description": "Setup\/Create the Carousel navigation element (if needed).", "guessedname": "_setupCarouselNavigation", "guessedtype": "function"}, "createCarouselItem": {"protected": "", "params": [{"type": "Object", "name": "obj", "description": " The attributes of the element to be created"}], "description": "Create the Carousel item.", "guessedname": "_createCarouselItem", "guessedtype": "function"}, "_syncPagerUI": {"protected": "", "description": "Synchronize and redraw the Pager UI if necessary.", "guessedname": "_syncPagerUI", "guessedtype": "function"}, "initAttributes": {"public": "", "params": [{"type": "Object", "name": "attrs", "description": " The set of configuration attributes for\ncreating the Carousel."}], "description": "Initialize the configuration attributes used to create the Carousel.", "guessedname": "initAttributes", "guessedtype": "function"}, "getElementForItem": {"return": {"type": "Element", "description": "Return the item at index or null if not found"}, "description": "Return the ITEM_TAG_NAME at index or null if the index is not found.", "params": [{"type": "Number", "name": "index", "description": " The index of the item to be returned"}], "guessedname": "getElementForItem", "guessedtype": "function", "public": ""}, "_setRevealAmount": {"return": {"type": "Number", "description": "The new value that would be set"}, "description": "Set the value for the reveal amount percentage in the Carousel.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for revealAmount"}], "guessedname": "_setRevealAmount", "guessedtype": "function"}, "scrollPageBackward": {"description": "Scroll the Carousel by a page backward.", "private": "", "params": [{"type": "Event", "name": "ev", "description": " The event object"}, {"type": "Object", "name": "obj", "description": " The context object"}], "guessedname": "scrollPageBackward", "guessedtype": "function", "public": ""}, "_setNumVisible": {"return": {"type": "Number", "description": "The new value that would be set"}, "description": "Set the value for the number of visible items in the Carousel.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for numVisible"}], "guessedname": "_setNumVisible", "guessedtype": "function"}, "_updateNavButtons": {"protected": "", "params": [{"type": "Object", "name": "el", "description": " The target button"}, {"type": "Boolean", "name": "setFocus", "description": " True to set focus ring, false otherwise."}], "description": "Set the correct class for the navigation buttons.", "guessedname": "_updateNavButtons", "guessedtype": "function"}, "scrollForward": {"description": "Scroll the Carousel by an item forward.", "public": "", "guessedname": "scrollForward", "guessedtype": "function"}, "addItems": {"return": {"type": "Boolean", "description": "Return true on success, false otherwise"}, "description": "Insert or append multiple items to the Carousel.", "params": [{"type": "Array} An array of items to be added with each item\nrepresenting an item, index pair [{item, index", "name": "items", "description": " , ...]"}], "guessedname": "addItems", "guessedtype": "function", "public": ""}, "scrollPageForward": {"description": "Scroll the Carousel by a page forward.", "private": "", "params": [{"type": "Event", "name": "ev", "description": " The event object"}, {"type": "Object", "name": "obj", "description": " The context object"}], "guessedname": "scrollPageForward", "guessedtype": "function", "public": ""}, "initEvents": {"description": "Initialize and bind the event handlers.", "public": "", "guessedname": "initEvents", "guessedtype": "function"}, "_setSelectedItem": {"protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for \"selected\" item"}], "description": "Set the value for the selected item.", "guessedname": "_setSelectedItem", "guessedtype": "function"}, "createElement": {"params": [{"type": "String", "name": "el", "description": " The element to be created"}, {"type": "Object", "name": "attrs", "description": " Configuration of parent, class and id attributes.\nIf the content is specified, it is inserted after creation of the\nelement. The content can also be an HTML element in which case it would\nbe appended as a child node of the created element."}], "description": "Create an element, set its class name and optionally install the element\nto its parent.", "private": ""}, "_getSelectedItem": {"return": {"type": "Number", "description": "The new value that would be set"}, "description": "Get the value for the selected item.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for \"selected\" item"}], "guessedname": "_getSelectedItem", "guessedtype": "function"}, "_setNavigation": {"return": {"type": "Object", "description": "The new value that would be set"}, "description": "Set the value for the Carousel's navigation.", "protected": "", "params": [{"type": "Object", "name": "cfg", "description": " The navigation configuration"}], "guessedname": "_setNavigation", "guessedtype": "function"}, "init": {"public": "", "params": [{"type": "HTMLElement | String", "name": "el", "description": " The html element that represents\nthe Carousel container."}, {"type": "Object", "name": "attrs", "description": " The set of configuration attributes for\ncreating the Carousel."}], "description": "Initialize the Carousel.", "guessedname": "init", "guessedtype": "function"}, "getById": {"public": "", "static": "", "description": "Return the appropriate Carousel object based on the id associated with\nthe Carousel element or false if none match.", "guessedname": "getById", "guessedtype": "function"}, "toString": {"public": "", "return": {"type": "String", "description": ""}, "description": "Return the string representation of the Carousel.", "guessedname": "toString", "guessedtype": "function"}, "blur": {"description": "Remove focus from the Carousel.", "public": "", "guessedname": "blur", "guessedtype": "function"}, "createCarouselClip": {"protected": "", "description": "Create the Carousel clip container.", "guessedname": "_createCarouselClip", "guessedtype": "function"}, "_itemClickHandler": {"protected": "", "params": [{"type": "Event", "name": "ev", "description": " The event object"}], "description": "The \"click\" handler for the item.", "guessedname": "_itemClickHandler", "guessedtype": "function"}, "_validateNumVisible": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate the numVisible value.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The numVisible value"}], "guessedname": "_validateNumVisible", "guessedtype": "function"}, "_validateNavigation": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate and navigation parameters.", "protected": "", "params": [{"type": "Object", "name": "cfg", "description": " The navigation configuration"}], "guessedname": "_validateNavigation", "guessedtype": "function"}, "parseCarouselItems": {"protected": "", "description": "Find the items within the Carousel and add them to the items table.\nA Carousel item is identified by elements that matches the carousel\nitem element tag.", "guessedname": "_parseCarouselItems", "guessedtype": "function"}, "getItems": {"public": "", "return": {"type": "Array", "description": "Return all items in the Carousel"}, "description": "Return all items as an array.", "guessedname": "getItems", "guessedtype": "function"}, "parseCarousel": {"return": {"type": "Boolean", "description": "True if Carousel is found, false otherwise"}, "description": "Find the Carousel within a container. The Carousel is identified by\nthe first element that matches the carousel element tag or the\nelement that has the Carousel class.", "protected": "", "params": [{"type": "HTMLElement", "name": "parent", "description": " The parent element to look under"}], "guessedname": "_parseCarousel", "guessedtype": "function"}, "addItem": {"return": {"type": "Boolean", "description": "Return true on success, false otherwise"}, "description": "Insert or append an item to the Carousel.", "params": [{"type": "String | Object | HTMLElement", "name": "item", "description": " The item to be appended\nto the Carousel. If the parameter is a string, it is assumed to be\nthe content of the newly created item. If the parameter is an\nobject, it is assumed to supply the content and an optional class\nand an optional id of the newly created item."}, {"type": "Number", "name": "index", "description": " optional The position to where in the list\n(starts from zero)."}], "guessedname": "addItem", "guessedtype": "function", "public": ""}, "_setContainerSize": {"protected": "", "params": [{"type": "HTMLElement", "name": "clip", "description": " The clip container element."}, {"type": "String", "name": "attr", "description": " Either set the height or width."}], "description": "Set the container size.", "guessedname": "_setContainerSize", "guessedtype": "function"}, "_setNumItems": {"return": {"type": "Number", "description": "The new value that would be set"}, "description": "Set the number of items in the Carousel.\nWarning: Setting this to a lower number than the current removes\nitems from the end.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for numItems"}], "guessedname": "_setNumItems", "guessedtype": "function"}, "getScrollOffset": {"params": [{"type": "Number", "name": "delta", "description": " The delta number of elements to scroll by."}], "description": "Return the scrolling offset size given the number of elements to\nscroll.", "private": ""}, "_pagerClickHandler": {"protected": "", "params": [{"type": "Event", "name": "ev", "description": " The event object"}], "description": "The \"click\" handler for the pager navigation.", "guessedname": "_pagerClickHandler", "guessedtype": "function"}, "getStyle": {"params": [{"type": "HTMLElement", "name": "el", "description": " The element for which the style needs to be\nreturned."}, {"type": "String", "name": "style", "description": " The style attribute"}, {"type": "String", "name": "type", "description": " \"int\", \"float\", etc. (defaults to int)"}], "description": "Get the computed style of an element.", "private": ""}, "createCarousel": {"protected": "", "params": [{"type": "String", "name": "elId", "description": " The id of the element to be created"}], "description": "Create the Carousel.", "guessedname": "_createCarousel", "guessedtype": "function"}, "getItem": {"return": {"type": "Object", "description": "Return the item at index or null if not found"}, "description": "Return the item at index or null if the index is not found.", "params": [{"type": "Number", "name": "index", "description": " The index of the item to be returned"}], "guessedname": "getItem", "guessedtype": "function", "public": ""}, "removeItem": {"return": {"type": "Boolean", "description": "Return true on success, false otherwise"}, "description": "Remove an item at index from the Carousel.", "params": [{"type": "Number", "name": "index", "description": " The position to where in the list (starts from\nzero)."}], "guessedname": "removeItem", "guessedtype": "function", "public": ""}, "autoScroll": {"description": "Automatically scroll the contents of the Carousel.", "private": ""}, "hide": {"description": "Hide the Carousel.", "public": "", "guessedname": "hide", "guessedtype": "function"}, "_validateRevealAmount": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate the revealAmount value.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The revealAmount value"}], "guessedname": "_validateRevealAmount", "guessedtype": "function"}, "_setOrientation": {"return": {"type": "Boolean", "description": "The new value that would be set"}, "description": "Set the orientation of the Carousel.", "protected": "", "params": [{"type": "Boolean", "name": "val", "description": " The new value for isVertical"}], "guessedname": "_setOrientation", "guessedtype": "function"}, "scrollBackward": {"description": "Scroll the Carousel by an item backward.", "public": "", "guessedname": "scrollBackward", "guessedtype": "function"}, "stopAutoPlay": {"description": "Stop auto-playing the Carousel.", "public": "", "guessedname": "stopAutoPlay", "guessedtype": "function"}, "_validateScrollIncrement": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate the scrollIncrement value.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The scrollIncrement value"}], "guessedname": "_validateScrollIncrement", "guessedtype": "function"}, "syncUI": {"params": [{"type": "Object", "name": "o", "description": " The item that needs to be added or removed"}], "description": "Fire custom events for synchronizing the DOM.", "private": ""}, "parseCarouselNavigation": {"return": {"type": "Boolean", "description": "True if at least one is found, false otherwise"}, "description": "Find the Carousel navigation within a container. The navigation\nelements need to match the carousel navigation class names.", "protected": "", "params": [{"type": "HTMLElement", "name": "parent", "description": " The parent element to look under"}], "guessedname": "_parseCarouselNavigation", "guessedtype": "function"}, "clearItems\npublic": {"description": "Clears the items from Carousel.", "guessedname": "clearItems", "guessedtype": "function"}, "setItemSelection": {"params": [{"type": "Number", "name": "newposition", "description": " The index of the new position"}, {"type": "Number", "name": "oldposition", "description": " The index of the previous position"}], "description": "Set the selected item.", "private": ""}, "getCarouselItemSize": {"params": [{"type": "String", "name": "which", "description": " \"height\" or \"width\" to be returned. If this is\npassed explicitly, the calculated size is not cached."}], "description": "Compute and return the height or width of a single Carousel item\ndepending upon the orientation.", "private": ""}, "getElementForItems": {"public": "", "return": {"type": "Array", "description": "Return all the items"}, "description": "Return the ITEM_TAG_NAME for all items in the Carousel.", "guessedname": "getElementForItems", "guessedtype": "function"}, "_setClipContainerSize": {"protected": "", "params": [{"type": "HTMLElement", "name": "clip", "description": " The clip container element."}, {"type": "Number", "name": "num", "description": " optional The number of items per page."}], "description": "Set the clip container size (based on the new numVisible value).", "guessedname": "_setClipContainerSize", "guessedtype": "function"}, "_setFirstVisible": {"return": {"type": "Number", "description": "The new value that would be set"}, "description": "Set the value for the Carousel's first visible item.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The new value for firstVisible"}], "guessedname": "_setFirstVisible", "guessedtype": "function"}, "_validateNumItems": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate the numItems value.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The numItems value"}], "guessedname": "_validateNumItems", "guessedtype": "function"}, "startAutoPlay": {"description": "Start auto-playing the Carousel.", "public": "", "guessedname": "startAutoPlay", "guessedtype": "function"}, "_keyboardEventHandler": {"protected": "", "params": [{"type": "Event", "name": "ev", "description": " The event that is being handled."}], "description": "The keyboard event handler for Carousel.", "guessedname": "_keyboardEventHandler", "guessedtype": "function"}, "getItemPositionById": {"public": "", "params": [{"type": "Number", "name": "index", "description": " The index of the item to be returned"}], "description": "Return the position of the Carousel item that has the id \"id\", or -1\nif the id is not found.", "guessedname": "getItemPositionById", "guessedtype": "function"}, "_validateFirstVisible": {"return": {"type": "Boolean", "description": "The status of the validation"}, "description": "Validate the firstVisible value.", "protected": "", "params": [{"type": "Number", "name": "val", "description": " The first visible value"}], "guessedname": "_validateFirstVisible", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "Carousel.js", "guessedtype": "function", "shortname": "Carousel", "properties": {"NEXT_PAGE": {"default": "\"yui-carousel-next\"", "description": "The class name of the next navigation link. This variable is not\nonly used for styling, but also for identifying the link within\nthe Carousel container.", "guessedname": "NEXT_PAGE", "guessedtype": "property"}, "PREV_PAGE": {"default": "\"yui-carousel-prev\"", "description": "The class name of the previous navigation link. This variable\nis not only used for styling, but also for identifying the link\nwithin the Carousel container.", "guessedname": "PREV_PAGE", "guessedtype": "property"}, "_itemsTable": {"private": "", "description": "The table of items in the Carousel.\nThe numItems is the number of items in the Carousel, items being the\narray of items in the Carousel. The size is the size of a single\nitem in the Carousel. It is cached here for efficiency (to avoid\ncomputing the size multiple times).", "guessedname": "_itemsTable", "guessedtype": "property"}, "instances": {"guessedname": "instances", "static": "", "description": "The internal table of Carousel instances.", "private": "", "guessedtype": "property"}, "TAG_NAME": {"default": "\"OL\"", "description": "The tag name of the Carousel.", "guessedname": "TAG_NAME", "guessedtype": "property"}, "SELECTED_ITEM": {"default": "\"yui-carousel-item-selected\"", "description": "The class name of the selected item.", "guessedname": "SELECTED_ITEM", "guessedtype": "property"}, "MIN_WIDTH": {"default": "99", "description": "The minimum width of the Carousel container to support the\nnavigation buttons.", "guessedname": "MIN_WIDTH", "guessedtype": "property"}, "HORIZONTAL": {"default": "\"yui-carousel-horizontal\"", "description": "The class name of a horizontally oriented Carousel.", "guessedname": "HORIZONTAL", "guessedtype": "property"}, "_isAnimationInProgress": {"private": "", "description": "Is the animation still in progress?", "guessedname": "_isAnimationInProgress", "guessedtype": "property"}, "_prevEnabled": {"private": "", "description": "Status of the previous navigation item.", "guessedname": "_prevEnabled", "guessedtype": "property"}, "NEXT_BUTTON_TEXT": {"default": "\"Next Page\"", "description": "The next navigation button name\/text.", "guessedname": "NEXT_BUTTON_TEXT", "guessedtype": "property"}, "VERTICAL_CONTAINER": {"default": "\"yui-carousel-vertical-container\"", "description": "The class name of the (vertical) Carousel's container element.", "guessedname": "VERTICAL_CONTAINER", "guessedtype": "property"}, "PREVIOUS_BUTTON_TEXT": {"default": "\"Previous Page\"", "description": "The previous navigation button name\/text.", "guessedname": "PREVIOUS_BUTTON_TEXT", "guessedtype": "property"}, "FIRST_NAV_DISABLED": {"default": "\"yui-carousel-first-button-disabled\"", "description": "The class name of a first disabled navigation button.", "guessedname": "FIRST_NAV_DISABLED", "guessedtype": "property"}, "FIRST_PAGE": {"default": "\"yui-carousel-nav-first-page\"", "description": "The class name of a first page element.", "guessedname": "FIRST_PAGE", "guessedtype": "property"}, "_navBtns": {"private": "", "description": "The Carousel navigation buttons.", "guessedname": "_navBtns", "guessedtype": "property"}, "CAROUSEL": {"default": "\"yui-carousel\"", "description": "The class name of the Carousel element.", "guessedname": "CAROUSEL", "guessedtype": "property"}, "_nextEnabled": {"private": "", "description": "Status of the next navigation item.", "guessedname": "_nextEnabled", "guessedtype": "property"}, "CAROUSEL_EL": {"default": "\"yui-carousel-element\"", "description": "The class name of the container of the items in the Carousel.", "guessedname": "CAROUSEL_EL", "guessedtype": "property"}, "_pages": {"private": "", "description": "The Carousel pages structure.\nThis is an object of the total number of pages and the current page.", "guessedname": "_pages", "guessedtype": "property"}, "NAVIGATION": {"default": "\"yui-carousel-nav\"", "description": "The navigation element container class name.", "guessedname": "NAVIGATION", "guessedtype": "property"}, "_carouselEl": {"private": "", "description": "The Carousel element.", "guessedname": "_carouselEl", "guessedtype": "property"}, "NUM_VISIBLE": {"default": "3", "description": "The number of visible items in the Carousel.", "guessedname": "NUM_VISIBLE", "guessedtype": "property"}, "CONTAINER": {"default": "\"yui-carousel-container\"", "description": "The class name of the Carousel's container element.", "guessedname": "CONTAINER", "guessedtype": "property"}, "VERTICAL": {"default": "\"yui-carousel-vertical\"", "description": "The class name of a vertically oriented Carousel.", "guessedname": "VERTICAL", "guessedtype": "property"}, "WidgetName": {"guessedname": "WidgetName", "static": "", "description": "The widget name.", "private": "", "guessedtype": "property"}, "ITEM_LOADING": {"default": "The progress indicator (spinner) image", "description": "The element to be used as the progress indicator when the item\nis still being loaded.", "guessedname": "ITEM_LOADING", "guessedtype": "property"}, "VISIBLE": {"default": "\"yui-carousel-visible\"", "description": "The class name of a visible Carousel.", "guessedname": "VISIBLE", "guessedtype": "property"}, "_navEl": {"private": "", "description": "The Carousel navigation.", "guessedname": "_navEl", "guessedtype": "property"}, "DISABLED": {"default": "\"yui-carousel-button-disabled\"", "description": "The class name of a disabled navigation button.", "guessedname": "DISABLED", "guessedtype": "property"}, "SELECTED_NAV": {"default": "\"yui-carousel-nav-page-selected\"", "description": "The class name of the selected paging navigation.", "guessedname": "SELECTED_NAV", "guessedtype": "property"}, "ITEM_TAG_NAME": {"default": "\"LI\"", "description": "The tag name of the Carousel item.", "guessedname": "ITEM_TAG_NAME", "guessedtype": "property"}, "MAX_PAGER_BUTTONS": {"default": "5", "description": "The maximum number of pager buttons allowed beyond which the UI\nof the pager would be a drop-down of pages instead of buttons.", "guessedname": "MAX_PAGER_BUTTONS", "guessedtype": "property"}, "FIRST_VISIBLE": {"default": "0", "description": "The offset of the first visible item in the Carousel.", "guessedname": "FIRST_VISIBLE", "guessedtype": "property"}, "CONTENT": {"default": "\"yui-carousel-content\"", "description": "The class name of the Carousel's container element.", "guessedname": "CONTENT", "guessedtype": "property"}, "PAGER_PREFIX_TEXT": {"default": "\"Go to page \"", "description": "The prefix text for the pager in case the UI is a drop-down.", "guessedname": "PAGER_PREFIX_TEXT", "guessedtype": "property"}, "_clipEl": {"private": "", "description": "The Carousel clipping container element.", "guessedname": "_clipEl", "guessedtype": "property"}, "BUTTON": {"default": "\"yui-carousel-button\"", "description": "The class name of the Carousel navigation buttons.", "guessedname": "BUTTON", "guessedtype": "property"}, "_firstItem": {"private": "", "description": "The current first index of the Carousel.", "guessedname": "_firstItem", "guessedtype": "property"}, "_recomputeSize": {"private": "", "description": "Whether the Carousel size needs to be recomputed or not?", "guessedname": "_recomputeSize", "guessedtype": "property"}, "FIRST_NAV": {"default": "\" yui-carousel-first-button\"", "description": "The class name of the first Carousel navigation button.", "guessedname": "FIRST_NAV", "guessedtype": "property"}, "NAV_CONTAINER": {"default": "\"yui-carousel-buttons\"", "description": "The class name for the navigation container for prev\/next.", "guessedname": "NAV_CONTAINER", "guessedtype": "property"}, "FOCUSSED_BUTTON": {"default": "\"yui-carousel-button-focus\"", "description": "The class name of the Carousel navigation button that has focus.", "guessedname": "FOCUSSED_BUTTON", "guessedtype": "property"}}, "description": "The Carousel widget."}, "YAHOO.widget.TreeView": {"name": "YAHOO.widget.TreeView", "constructors": [{"params": [{"type": "string|HTMLElement", "name": "id", "description": " The id of the element, or the element itself that the tree will be inserted into. Existing markup in this element, if valid, will be used to build the tree"}, {"type": "Array|object|string", "name": "oConfig", "description": " (optional) An array containing the definition of the tree. Objects will be converted to arrays of one element. A string will produce a single TextNode"}], "description": "Contains the tree view state data and the root node."}], "namespace": "YAHOO.widget", "module": "treeview", "events": {"enterKeyPressed": {"type": "CustomEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that has the focus"}], "description": "Fires when the Enter key is pressed on a node that has the focus"}, "labelClick": {"deprecated": "use clickEvent or dblClickEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node clicked"}], "description": "Custom event that is fired when the text node label is clicked. \r\nThe node clicked is provided as an argument", "type": "CustomEvent"}, "collapse": {"type": "CustomEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that is collapsing"}], "description": "Fires when a node is going to be collapsed. Return false to stop\r\nthe collapse."}, "dblClickEvent": {"type": "CustomEvent", "params": [{"type": "HTMLEvent", "name": "oArgs.event", "description": " The event object"}, {"type": "YAHOO.widget.Node", "name": "oArgs.node", "description": " node the node that was clicked"}], "description": "Fires when the label in a TextNode or MenuNode or content in an HTMLNode receives a double Click", "guessedname": "self", "guessedtype": "property"}, "collapseComplete": {"type": "CustomEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that was collapsed"}], "description": "Fires after a node is successfully collapsed. This event will not fire\r\nif the \"collapse\" event was cancelled."}, "animComplete": {"type": "CustomEvent", "parm": "{String} type the type of animation (\"expand\" or \"collapse\")", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that is expanding\/collapsing"}], "description": "When animation is enabled, this event fires when the animation\r\ncompletes"}, "expandComplete": {"type": "CustomEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that was expanded"}], "description": "Fires after a node is successfully expanded. This event will not fire\r\nif the \"expand\" event was cancelled."}, "animStart": {"type": "CustomEvent", "parm": "{String} type the type of animation (\"expand\" or \"collapse\")", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that is expanding\/collapsing"}], "description": "When animation is enabled, this event fires when the animation\r\nstarts"}, "clickEvent": {"type": "CustomEvent", "params": [{"type": "HTMLEvent", "name": "oArgs.event", "description": " The event object"}, {"type": "YAHOO.widget.Node", "name": "oArgs.node", "description": " node the node that was clicked"}], "description": "Fires when the label in a TextNode or MenuNode or content in an HTMLNode receives a Click.\r\nThe listener may return false to cancel toggling and focusing on the node."}, "expand": {"type": "CustomEvent", "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node that is expanding"}], "description": "Fires when a node is going to be expanded. Return false to stop\r\nthe collapse."}}, "guessedname": "TreeView", "methods": {"animateExpand": {"return": {"type": "boolean", "description": "true if animation could be invoked, false otherwise"}, "params": [{"type": "HTMLElement", "name": "el", "description": " the element to animate"}, {"type": "YAHOO.util.Node", "name": "node", "description": " the node that was expanded"}], "description": "Perform the expand animation if configured, or just show the\r\nelement if not configured or too many animations are in progress", "guessedname": "animateExpand", "guessedtype": "function"}, "setDynamicLoad": {"params": [{"type": "function", "name": "fnDataLoader", "description": " the function that will be called to get the data"}, {"type": "int", "name": "iconMode", "description": " configures the icon that is displayed when a dynamic\r\nload node is expanded the first time without children. By default, the \r\n\"collapse\" icon will be used. If set to 1, the leaf node icon will be\r\ndisplayed."}], "description": "Configures this tree to dynamically load all child data", "guessedname": "setDynamicLoad", "guessedtype": "function"}, "render": {"description": "Renders the tree boilerplate and visible nodes", "guessedname": "render", "guessedtype": "function"}, "getNodeByIndex": {"return": {"type": "Node", "description": "the node with index=nodeIndex, null if no match"}, "params": [{"type": "int", "name": "nodeIndex", "description": " the index of the node wanted"}], "description": "Returns a node in the tree that has the specified index (this index\r\nis created internally, so this function probably will only be used\r\nin html generated for a given node.)", "guessedname": "getNodeByIndex", "guessedtype": "function"}, "collapseComplete": {"description": "Function executed when the collapse animation completes", "guessedname": "collapseComplete", "guessedtype": "function"}, "regNode": {"guessedname": "regNode", "params": [{"type": "Node", "name": "node", "description": " the node to register"}], "description": "Nodes register themselves with the tree instance when they are created.", "private": "", "guessedtype": "function"}, "onExpand": {"deprecated": "use treeobj.subscribe(\"expand\") instead", "params": [{"type": "Node", "name": "node", "description": " the node that was expanded"}], "description": "Abstract method that is executed when a node is expanded", "guessedname": "onExpand", "guessedtype": "function"}, "YAHOO.widget.TreeView.preload": {"static": "", "params": [{"type": "string", "name": "prefix", "description": " the prefix to use to generate the names of the\r\nimages to preload, default is ygtv"}], "description": "Attempts to preload the images defined in the styles used to draw the tree by\r\nrendering off-screen elements that use the styles.", "guessedname": "preload", "guessedtype": "function"}, "setExpandAnim": {"params": [{"type": "string", "name": "type", "description": " the type of animation (acceptable values defined \r\nin YAHOO.widget.TVAnim)"}], "description": "Sets up the animation for expanding children", "guessedname": "setExpandAnim", "guessedtype": "function"}, "YAHOO.widget.TreeView.getTree": {"return": {"type": "TreeView", "description": "the tree instance requested, null if not found."}, "description": "Global method for getting a tree by its id. Used in the generated\r\ntree html.", "static": "", "guessedname": "getTree", "guessedtype": "function", "params": [{"type": "String", "name": "treeId", "description": " the id of the tree instance"}]}, "removeNode": {"return": {"type": "boolean", "description": "False is there was a problem, true otherwise."}, "params": [{"type": "Node", "name": "The", "description": " node to remove"}, {"type": "boolean", "name": "autoRefresh", "description": " automatically refreshes branch if true"}], "description": "Removes the node and its children, and optionally refreshes the \r\nbranch of the tree that was affected.", "guessedname": "removeNode", "guessedtype": "function"}, "popNode": {"params": [{"type": "Node", "name": "the", "description": " node to remove"}], "description": "Removes the node from the tree, preserving the child collection \r\nto make it possible to insert the branch into another part of the \r\ntree, or another tree.", "guessedname": "popNode", "guessedtype": "function"}, "onCollapse": {"deprecated": "use treeobj.subscribe(\"collapse\") instead", "params": [{"type": "Node", "name": "node", "description": " the node that was collapsed."}], "description": "Abstract method that is executed when a node is collapsed.", "guessedname": "onCollapse", "guessedtype": "function"}, "init": {"guessedname": "init", "parm": "{string|HTMLElement} id the id of the element that will hold the tree", "description": "Initializes the tree", "private": "", "guessedtype": "function"}, "getEl": {"return": {"type": "HTMLElement", "description": "the host element"}, "description": "Returns the tree's host element", "guessedname": "getEl", "guessedtype": "function"}, "removeChildren": {"params": [{"type": "Node", "name": "node", "description": " the node to purge"}], "description": "Deletes this nodes child collection, recursively. Also collapses\r\nthe node, and resets the dynamic load flag. The primary use for\r\nthis method is to purge a node and allow it to fetch its data\r\ndynamically again.", "guessedname": "removeChildren", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "string representation of the tree"}, "description": "TreeView instance toString", "guessedname": "toString", "guessedtype": "function"}, "destroy": {"description": "Nulls out the entire TreeView instance and related objects, removes attached\r\nevent listeners, and clears out DOM elements inside the container. After\r\ncalling this method, the instance reference should be expliclitly nulled by\r\nimplementer, as in myDataTable = null. Use with caution!", "guessedname": "destroy", "guessedtype": "function"}, "animateCollapse": {"return": {"type": "boolean", "description": "true if animation could be invoked, false otherwise"}, "params": [{"type": "HTMLElement", "name": "el", "description": " the element to animate"}, {"type": "YAHOO.util.Node", "name": "node", "description": " the node that was expanded"}], "description": "Perform the collapse animation if configured, or just show the\r\nelement if not configured or too many animations are in progress", "guessedname": "animateCollapse", "guessedtype": "function"}, "expandAll": {"description": "Expands all child nodes. Note: this conflicts with the \"multiExpand\"\r\nnode property. If expand all is called in a tree with nodes that\r\ndo not allow multiple siblings to be displayed, only the last sibling\r\nwill be expanded.", "guessedname": "expandAll", "guessedtype": "function"}, "getNodeCount": {"return": {"type": "int", "description": "number of nodes in the tree"}, "description": "Count of nodes in tree", "guessedname": "getNodeCount", "guessedtype": "function"}, "draw": {"deprecated": "Use render instead", "description": "Renders the tree boilerplate and visible nodes.\r\nAlias for render", "guessedname": "draw", "guessedtype": "property"}, "getTreeDefinition": {"return": {"type": "Object | false", "description": "definition of the tree or false if any node is defined as dynamic"}, "description": "Returns an object which could be used to rebuild the tree.\r\nIt can be passed to the tree constructor to reproduce the same tree.\r\nIt will return false if any node loads dynamically, regardless of whether it is loaded or not.", "guessedname": "getTreeDefinition", "guessedtype": "function"}, "YAHOO.widget.TreeView.getNode": {"return": {"type": "Node", "description": "the node instance requested, null if not found"}, "description": "Global method for getting a node by its id. Used in the generated\r\ntree html.", "static": "", "guessedname": "getNode", "guessedtype": "function", "params": [{"type": "String", "name": "treeId", "description": " the id of the tree instance"}, {"type": "String", "name": "nodeIndex", "description": " the index of the node to return"}]}, "getNodeByProperty": {"return": {"type": "Node", "description": "the matching node, null if no match"}, "params": [{"type": "object", "name": "property", "description": " the property to search (usually a string)"}, {"type": "object", "name": "value", "description": " the value we want to find (usuall an int or string)"}], "description": "Returns a node that has a matching property and value in the data\r\nobject that was passed into its constructor.", "guessedname": "getNodeByProperty", "guessedtype": "function"}, "onEventEditNode": {"params": [{"type": "object", "name": "oArgs", "description": " Object passed as arguments to TreeView event listeners"}], "description": "Method to be associated with an event (clickEvent, dblClickEvent or enterKeyPressed) to pop up the contents editor\r\nIt calls the corresponding node editNode method.", "guessedname": "onEventEditNode", "guessedtype": "function"}, "_removeChildren_animComplete": {"guessedname": "_removeChildren_animComplete", "params": [{"type": "", "name": "o", "description": " the custom event payload"}], "description": "wait until the animation is complete before deleting \r\nto avoid javascript errors", "private": "", "guessedtype": "function"}, "_closeEditor": {"guessedname": "_closeEditor", "params": [{"type": "Boolean", "name": "save", "description": " true if the edited value is to be saved, false if discarded"}], "description": "Method to be called when the inline editing is finished and the editor is to be closed", "private": "", "guessedtype": "function"}, "getNodesByProperty": {"return": {"type": "Array", "description": "the matching collection of nodes, null if no match"}, "params": [{"type": "object", "name": "property", "description": " the property to search (usually a string)"}, {"type": "object", "name": "value", "description": " the value we want to find (usuall an int or string)"}], "description": "Returns a collection of nodes that have a matching property \r\nand value in the data object that was passed into its constructor.", "guessedname": "getNodesByProperty", "guessedtype": "function"}, "_deleteNode": {"private": "", "description": "Deletes the node and recurses children", "guessedname": "_deleteNode", "guessedtype": "function"}, "getRoot": {"return": {"type": "Node", "description": "the root node"}, "description": "Returns the root node of this tree", "guessedname": "getRoot", "guessedtype": "function"}, "collapseAll": {"description": "Collapses all expanded child nodes in the entire tree.", "guessedname": "collapseAll", "guessedtype": "function"}, "setCollapseAnim": {"params": [{"type": "string", "name": "the", "description": " type of animation (acceptable values defined in \r\nYAHOO.widget.TVAnim)"}], "description": "Sets up the animation for collapsing children", "guessedname": "setCollapseAnim", "guessedtype": "function"}, "buildTreeFromObject": {"params": [{"type": "Array", "name": "oConfig", "description": " array containing a full description of the tree"}], "description": "Builds the TreeView from an object. This is the method called by the constructor to build the tree when it has a second argument.", "guessedname": "buildTreeFromObject", "guessedtype": "function"}, "buildTreeFromMarkup": {"params": [{"type": "string|HTMLElement", "name": "id", "description": " the id of the element that contains the markup or a reference to it."}], "description": "Builds the TreeView from existing markup. Markup should consist of <UL> or <OL> elements, possibly nested. \r\nDepending what the <LI> elements contain the following will be created: <ul>\r\n<li>plain text: a regular TextNode<\/li>\r\n<li>an (un-)ordered list: a nested branch<\/li>\r\n<li>anything else: an HTMLNode<\/li><\/ul>\r\nOnly the first outermost (un-)ordered list in the markup and its children will be parsed.\r\nTree will be fully collapsed.\r\nHTMLNodes have hasIcon set to true if the markup for that node has a className called hasIcon.", "guessedname": "buildTreeFromMarkup", "guessedtype": "function"}, "_nodeEditing": {"return": {"type": "Boolean", "description": "true to indicate that the node is editable and prevent any further bubbling of the click."}, "params": [{"type": "YAHOO.widget.Node", "name": "node", "description": " the node to be edited"}], "description": "Entry point of the editing plug-in. \r\nTreeView will call this method if it exists when a node label is clicked", "guessedname": "_nodeEditing", "guessedtype": "function"}, "expandComplete": {"description": "Function executed when the expand animation completes", "guessedname": "expandComplete", "guessedtype": "function"}, "getNodeByElement": {"return": {"type": "YAHOO.widget.Node", "description": "a node reference or null"}, "params": [{"type": "HTMLElement", "name": "the", "description": " element to test"}], "description": "Returns the treeview node reference for an anscestor element\r\nof the node, or null if it is not contained within any node\r\nin this tree.", "guessedname": "getNodeByElement", "guessedtype": "function"}, "_destroyEditor": {"guessedname": "_destroyEditor", "description": "Entry point for TreeView's destroy method to destroy whatever the editing plug-in has created", "private": "", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "TreeView.js", "guessedtype": "function", "shortname": "TreeView", "properties": {"_dblClickTimer": {"guessedname": "_dblClickTimer", "type": "window.timer object", "description": "Stores the timer used to check for double clicks", "private": "", "guessedtype": "property"}, "YAHOO.widget.TreeView.nodeCount": {"type": "int", "static": "", "description": "Running count of all nodes created in all trees. This is \r\nused to provide unique identifies for all nodes. Deleting\r\nnodes does not change the nodeCount.", "guessedname": "nodeCount", "guessedtype": "property"}, "locked": {"type": "boolean", "description": "We lock the tree control while waiting for the dynamic loader to return", "guessedname": "locked", "guessedtype": "property"}, "_expandAnim": {"guessedname": "_expandAnim", "type": "string", "description": "The animation to use for expanding children, if any", "private": "", "guessedtype": "property"}, "_collapseAnim": {"guessedname": "_collapseAnim", "type": "string", "description": "The animation to use for collapsing children, if any", "private": "", "guessedtype": "property"}, "editorData": {"static": "", "description": "An object to store information used for in-line editing\r\nfor all Nodes of all TreeViews. It contains:\r\n<ul>\r\n<li>active {boolean}, whether there is an active cell editor <\/li>\r\n<li>whoHasIt {YAHOO.widget.TreeView} TreeView instance that is currently using the editor<\/li>\r\n<li>nodeType {string} value of static Node._type property, allows reuse of input element if node is of the same type.<\/li>\r\n<li>editorPanel {HTMLelement (<div>)} element holding the in-line editor<\/li>\r\n<li>inputContainer {HTMLelement (<div>)} element which will hold the type-specific input element(s) to be filled by the fillEditorContainer method<\/li>\r\n<li>buttonsContainer {HTMLelement (<div>)} element which holds the <button> elements for Ok\/Cancel. If you don't want any of the buttons, hide it via CSS styles, don't destroy it<\/li>\r\n<li>node {YAHOO.widget.Node} reference to the Node being edited<\/li>\r\n<li>saveOnEnter {boolean}, whether the Enter key should be accepted as a Save command (Esc. is always taken as Cancel), disable for multi-line input elements <\/li>\r\n<\/ul>\r\nEditors are free to use this object to store additional data.", "guessedname": "editorData", "guessedtype": "property"}, "_el": {"guessedname": "_el", "type": "HTMLelement", "description": "The host element for this tree", "private": "", "guessedtype": "property"}, "YAHOO.widget.TreeView.trees": {"description": "Global cache of tree instances", "private": "", "static": "", "guessedname": "trees", "guessedtype": "property", "type": "Array"}, "_nodes": {"guessedname": "_nodes", "type": "Node[]", "description": "Flat collection of all nodes in this tree. This is a sparse\r\narray, so the length property can't be relied upon for a\r\nnode count for the tree.", "private": "", "guessedtype": "property"}, "_animCount": {"guessedname": "_animCount", "type": "int", "description": "The current number of animations that are executing", "private": "", "guessedtype": "property"}, "_hasDblClickSubscriber": {"guessedname": "_hasDblClickSubscriber", "type": "boolean", "description": "Whether there is any subscriber to dblClickEvent", "private": "", "guessedtype": "property"}, "maxAnim": {"type": "int", "description": "The maximum number of animations to run at one time.", "guessedname": "maxAnim", "guessedtype": "property"}, "id": {"type": "String", "description": "The id of tree container element", "guessedname": "id", "guessedtype": "property"}, "TreeView.FOCUS_CLASS_NAME": {"description": "Class name assigned to elements that have the focus", "default": "\"ygtvfocus\"", "static": "", "guessedname": "FOCUS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Contains the tree view state data and the root node."}, "YAHOO.util.ScriptNodeDataSource": {"name": "YAHOO.util.ScriptNodeDataSource", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "ScriptNodeDataSource class for accessing remote data via the YUI Get Utility."}], "namespace": "YAHOO.util", "module": "datasource", "guessedname": "ScriptNodeDataSource", "methods": {"makeConnection": {"return": {"type": "Number", "description": "Transaction ID."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " Callback object literal."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "Overriding method passes query to Get Utility. The returned\nresponse is then forwarded to the handleResponse function.", "guessedname": "makeConnection", "guessedtype": "function"}, "generateRequestCallback": {"return": {"type": "String", "description": "String fragment that gets appended to script URI that \nspecifies the callback function"}, "description": "Creates a request callback that gets appended to the script URI. Implementers\ncan customize this string to match their server's query syntax.", "guessedname": "generateRequestCallback", "guessedtype": "function"}}, "extends": "YAHOO.util.DataSourceBase", "superclass": "YAHOO.util.DataSourceBase", "file": "DataSource.js", "guessedtype": "function", "shortname": "ScriptNodeDataSource", "properties": {"_nPending": {"description": "Counter for pending requests. When this is 0, it is safe to purge callbacks\narray.", "private": "", "static": "", "guessedname": "_nPending", "guessedtype": "property", "type": "Number"}, "scriptCallbackParam": {"default": "\"callback\"", "type": "String", "description": "Callback string parameter name sent to the remote script. By default,\nrequests are sent to\n<URI>?<scriptCallbackParam>=callbackFunction", "guessedname": "scriptCallbackParam", "guessedtype": "property"}, "getUtility": {"default": "YAHOO.util.Get", "type": "Object", "description": "Alias to YUI Get Utility, to allow implementers to use a custom class.", "guessedname": "getUtility", "guessedtype": "property"}, "_nId": {"description": "Unique ID to track requests.", "private": "", "static": "", "guessedname": "_nId", "guessedtype": "property", "type": "Number"}, "callbacks": {"type": "Function[]", "static": "", "description": "Global array of callback functions, one for each request sent.", "guessedname": "callbacks", "guessedtype": "property"}, "asyncMode": {"default": "\"allowAll\"", "type": "String", "description": "Defines request\/response management in the following manner:\n<dl>\n<!--<dt>queueRequests<\/dt>\n<dd>If a request is already in progress, wait until response is returned before sending the next request.<\/dd>\n<dt>cancelStaleRequests<\/dt>\n<dd>If a request is already in progress, cancel it before sending the next request.<\/dd>-->\n<dt>ignoreStaleResponses<\/dt>\n<dd>Send all requests, but handle only the response for the most recently sent request.<\/dd>\n<dt>allowAll<\/dt>\n<dd>Send all requests and handle all responses.<\/dd>\n<\/dl>", "guessedname": "asyncMode", "guessedtype": "property"}}, "description": "ScriptNodeDataSource class for accessing remote data via the YUI Get Utility."}, "YAHOO.util.Anim": {"name": "YAHOO.util.Anim", "constructors": [{"params": [{"type": "String | HTMLElement", "name": "el", "description": " Reference to the element that will be animated"}, {"type": "Object", "name": "attributes", "description": " The attribute(s) to be animated. \nEach attribute is an object with at minimum a \"to\" or \"by\" member defined. \nAdditional optional members are \"from\" (defaults to current value), \"units\" (defaults to \"px\"). \nAll attribute names use camelCase."}, {"type": "Number", "name": "duration", "description": " (optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based"}, {"type": "Function", "name": "method", "description": " (optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)"}], "description": "Base animation class that provides the interface for building animated effects.\n<p>Usage: var myAnim = new YAHOO.util.Anim(el, { width: { from: 10, to: 100 } }, 1, YAHOO.util.Easing.easeOut);<\/p>"}], "namespace": "YAHOO.util", "module": "animation", "events": {"onComplete": {"description": "Custom event that fires when animation ends\nListen via subscribe method (e.g. myAnim.onComplete.subscribe(someFunction)", "guessedname": "onComplete", "guessedtype": "property"}, "onStart": {"description": "Custom event that fires when animation begins\nListen via subscribe method (e.g. myAnim.onStart.subscribe(someFunction)", "guessedname": "onStart", "guessedtype": "property"}, "onTween": {"description": "Custom event that fires between each frame\nListen via subscribe method (e.g. myAnim.onTween.subscribe(someFunction)", "guessedname": "onTween", "guessedtype": "property"}}, "guessedname": "Anim", "methods": {"isAnimated": {"return": {"type": "Boolean", "description": "current value of isAnimated."}, "description": "Checks whether the element is currently animated.", "guessedname": "isAnimated", "guessedtype": "function"}, "setEl": {"description": "Changes the animated element", "guessedname": "setEl", "guessedtype": "function"}, "getAttribute": {"return": {"type": "Number", "description": "val The current value of the attribute."}, "params": [{"type": "String", "name": "attr", "description": " The name of the attribute."}], "description": "Returns current value of the attribute.", "guessedname": "getAttribute", "guessedtype": "function"}, "setAttribute": {"params": [{"type": "String", "name": "attr", "description": " The name of the attribute."}, {"type": "Number", "name": "val", "description": " The value to be applied to the attribute."}, {"type": "String", "name": "unit", "description": " The unit ('px', '%', etc.) of the value."}], "description": "Applies a value to an attribute.", "guessedname": "setAttribute", "guessedtype": "function"}, "onTween": {"private": "", "description": "Feeds the starting and ending values for each animated attribute to doMethod once per frame, then applies the resulting value to the attribute(s).", "guessedname": "onTween", "guessedtype": "function"}, "doMethod": {"return": {"type": "Number", "description": "The Value to be applied to the attribute."}, "params": [{"type": "String", "name": "attr", "description": " The name of the attribute."}, {"type": "Number", "name": "start", "description": " The value this attribute should start from for this animation."}, {"type": "Number", "name": "end", "description": " The value this attribute should end at for this animation."}], "description": "Returns the value computed by the animation's \"method\".", "guessedname": "doMethod", "guessedtype": "function"}, "getEl": {"return": {"type": "HTMLElement", "description": ""}, "description": "Returns a reference to the animated element.", "guessedname": "getEl", "guessedtype": "function"}, "setRuntimeAttribute": {"guessedname": "setRuntimeAttribute", "params": [{"type": "Object", "name": "attr", "description": " The attribute object"}], "description": "Sets the actual values to be used during the animation. Should only be needed for subclass use.", "private": "", "guessedtype": "function"}, "stop": {"params": [{"type": "Boolean", "name": "finish", "description": " (optional) If true, animation will jump to final frame."}], "description": "Stops the animation. Normally called by AnimMgr when animation completes.", "guessedname": "stop", "guessedtype": "function"}, "init": {"params": [{"type": "String | HTMLElement", "name": "el", "description": " Reference to the element that will be animated"}, {"type": "Object", "name": "attributes", "description": " The attribute(s) to be animated. \nEach attribute is an object with at minimum a \"to\" or \"by\" member defined. \nAdditional optional members are \"from\" (defaults to current value), \"units\" (defaults to \"px\"). \nAll attribute names use camelCase."}, {"type": "Number", "name": "duration", "description": " (optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based"}, {"type": "Function", "name": "method", "description": " (optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)"}], "description": "Constructor for Anim instance.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Provides a readable name for the Anim instance.", "guessedname": "toString", "guessedtype": "function"}, "getDefaultUnit": {"return": {"type": "String", "description": "The default unit to be used."}, "params": [{"type": "attr", "name": "attr", "description": " The name of the attribute."}], "description": "Returns the unit to use when none is supplied.", "guessedname": "getDefaultUnit", "guessedtype": "function"}, "animate": {"description": "Starts the animation by registering it with the animation manager.", "guessedname": "animate", "guessedtype": "function"}, "getStartTime": {"return": {"type": "Date", "description": "current value of startTime."}, "description": "Returns the animation start time.", "guessedname": "getStartTime", "guessedtype": "function"}}, "file": "Anim.js", "guessedtype": "function", "shortname": "Anim", "requires": "YAHOO.util.AnimMgr", "properties": {"isAnimated": {"guessedname": "isAnimated", "type": "Boolean", "description": "Whether or not the animation is running.", "private": "", "guessedtype": "property"}, "_onTween": {"private": "", "description": "Custom event that fires after onTween", "guessedname": "_onTween", "guessedtype": "property"}, "el": {"guessedname": "el", "type": "HTMLElement", "description": "The element to be animated.", "private": "", "guessedtype": "property"}, "actualFrames": {"guessedname": "actualFrames", "type": "Int", "description": "The number of frames this animation was able to execute.", "private": "", "guessedtype": "property"}, "useSeconds": {"type": "Boolean", "description": "Whether or not the duration should be treated as seconds.\nDefaults to true.", "guessedname": "useSeconds", "guessedtype": "property"}, "totalFrames": {"type": "Int", "description": "The total number of frames to be executed.\nIn time-based animations, this is used by AnimMgr to ensure the animation finishes on time.", "guessedname": "totalFrames", "guessedtype": "property"}, "_onStart": {"private": "", "description": "Custom event that fires after onStart, useful in subclassing", "guessedname": "_onStart", "guessedtype": "property"}, "_onComplete": {"private": "", "description": "Custom event that fires after onComplete", "guessedname": "_onComplete", "guessedtype": "property"}, "startTime": {"guessedname": "startTime", "type": "Date", "description": "A Date object that is created when the animation begins.", "private": "", "guessedtype": "property"}, "duration": {"type": "Number", "description": "The length of the animation. Defaults to \"1\" (second).", "guessedname": "duration", "guessedtype": "property"}, "attributes": {"type": "Object", "description": "The collection of attributes to be animated. \nEach attribute must have at least a \"to\" or \"by\" defined in order to animate. \nIf \"to\" is supplied, the animation will end with the attribute at that value. \nIf \"by\" is supplied, the animation will end at that value plus its starting value. \nIf both are supplied, \"to\" is used, and \"by\" is ignored. \nOptional additional member include \"from\" (the value the attribute should start animating from, defaults to current value), and \"unit\" (the units to apply to the values).", "guessedname": "attributes", "guessedtype": "property"}, "method": {"type": "Function", "description": "The method that will provide values to the attribute(s) during the animation. \nDefaults to \"YAHOO.util.Easing.easeNone\".", "guessedname": "method", "guessedtype": "property"}, "currentFrame": {"type": "Int", "description": "The location of the current animation on the timeline.\nIn time-based animations, this is used by AnimMgr to ensure the animation finishes on time.", "guessedname": "currentFrame", "guessedtype": "property"}}, "description": "Base animation class that provides the interface for building animated effects.\n<p>Usage: var myAnim = new YAHOO.util.Anim(el, { width: { from: 10, to: 100 } }, 1, YAHOO.util.Easing.easeOut);<\/p>"}, "YAHOO.util.Sort": {"name": "YAHOO.util.Sort", "namespace": "YAHOO.util", "module": "datatable", "guessedname": "Sort", "methods": {"compare": {"params": [{"type": "Object", "name": "a", "description": " First sort argument."}, {"type": "Object", "name": "b", "description": " Second sort argument."}, {"type": "Boolean", "name": "desc", "description": " True if sort direction is descending, false if\nsort direction is ascending."}], "description": "Comparator function for simple case-insensitive string sorting.", "guessedname": "compare", "guessedtype": "function"}}, "static": "", "file": "ColumnSet.js", "guessedtype": "property", "shortname": "Sort", "description": "Sort static utility to support Column sorting."}, "YAHOO.util.UserAction": {"name": "YAHOO.util.UserAction", "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "UserAction", "methods": {"fireKeyEvent": {"description": "Fires an event that normally would be fired by the keyboard (keyup,\nkeydown, keypress). Make sure to specify either keyCode or charCode as\nan option.", "private": "", "static": "", "guessedname": "fireKeyEvent", "guessedtype": "function", "params": [{"type": "String", "name": "type", "description": " The type of event (\"keyup\", \"keydown\" or \"keypress\")."}, {"type": "HTMLElement", "name": "target", "description": " The target of the event."}, {"type": "Object", "name": "options", "description": " Options for the event. Either keyCode or charCode\nare required."}]}, "mouseEvent": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to click on."}, {"type": "String", "name": "type", "description": " The type of event to fire. This can be any one of\nthe following: click, dblclick, mousedown, mouseup, mouseout,\nmouseover, and mousemove."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mouse event on a particular element.", "guessedname": "fireMouseEvent", "guessedtype": "function"}, "keypress": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a keypress on a particular element.", "guessedname": "keypress", "guessedtype": "function"}, "keyup": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a keyup event on a particular element.", "guessedname": "keyup", "guessedtype": "function"}, "mouseup": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mouseup on a particular element.", "guessedname": "mouseup", "guessedtype": "function"}, "keydown": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a keydown event on a particular element.", "guessedname": "keydown", "guessedtype": "function"}, "mousemove": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mousemove on a particular element.", "guessedname": "mousemove", "guessedtype": "function"}, "simulateMouseEvent": {"description": "Simulates a mouse event using the given event information to populate\nthe generated event object. This method does browser-equalizing\ncalculations to account for differences in the DOM and IE event models\nas well as different browser quirks.", "private": "", "static": "", "guessedname": "simulateMouseEvent", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "target", "description": " The target of the given event."}, {"type": "String", "name": "type", "description": " The type of event to fire. This can be any one of\nthe following: click, dblclick, mousedown, mouseup, mouseout,\nmouseover, and mousemove."}, {"type": "Boolean", "name": "bubbles", "description": " (Optional) Indicates if the event can be\nbubbled up. DOM Level 2 specifies that all mouse events bubble by\ndefault. The default is true."}, {"type": "Boolean", "name": "cancelable", "description": " (Optional) Indicates if the event can be\ncanceled using preventDefault(). DOM Level 2 specifies that all\nmouse events except mousemove can be cancelled. The default \nis true for all events except mousemove, for which the default \nis false."}, {"type": "Window", "name": "view", "description": " (Optional) The view containing the target. This is\ntypically the window object. The default is window."}, {"type": "int", "name": "detail", "description": " (Optional) The number of times the mouse button has\nbeen used. The default value is 1."}, {"type": "int", "name": "screenX", "description": " (Optional) The x-coordinate on the screen at which\npoint the event occured. The default is 0."}, {"type": "int", "name": "screenY", "description": " (Optional) The y-coordinate on the screen at which\npoint the event occured. The default is 0."}, {"type": "int", "name": "clientX", "description": " (Optional) The x-coordinate on the client at which\npoint the event occured. The default is 0."}, {"type": "int", "name": "clientY", "description": " (Optional) The y-coordinate on the client at which\npoint the event occured. The default is 0."}, {"type": "Boolean", "name": "ctrlKey", "description": " (Optional) Indicates if one of the CTRL keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "altKey", "description": " (Optional) Indicates if one of the ALT keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "shiftKey", "description": " (Optional) Indicates if one of the SHIFT keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "metaKey", "description": " (Optional) Indicates if one of the META keys\nis pressed while the event is firing. The default is false."}, {"type": "int", "name": "button", "description": " (Optional) The button being pressed while the event\nis executing. The value should be 0 for the primary mouse button\n(typically the left button), 1 for the terciary mouse button\n(typically the middle button), and 2 for the secondary mouse button\n(typically the right button). The default is 0."}, {"type": "HTMLElement", "name": "relatedTarget", "description": " (Optional) For mouseout events,\nthis is the element that the mouse has moved to. For mouseover\nevents, this is the element that the mouse has moved from. This\nargument is ignored for all other events. The default is null."}]}, "mousedown": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mousedown on a particular element.", "guessedname": "mousedown", "guessedtype": "function"}, "mouseout": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mouseout event on a particular element. Use \"relatedTarget\"\non the options object to specify where the mouse moved to.\nQuirks: Firefox less than 2.0 doesn't set relatedTarget properly, so\ntoElement is assigned in its place. IE doesn't allow toElement to be\nbe assigned, so relatedTarget is assigned in its place. Both of these\nconcessions allow YAHOO.util.Event.getRelatedTarget() to work correctly\nin both browsers.", "guessedname": "mouseout", "guessedtype": "function"}, "simulateKeyEvent": {"description": "Simulates a key event using the given event information to populate\nthe generated event object. This method does browser-equalizing\ncalculations to account for differences in the DOM and IE event models\nas well as different browser quirks. Note: keydown causes Safari 2.x to\ncrash.", "private": "", "static": "", "guessedname": "simulateKeyEvent", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "target", "description": " The target of the given event."}, {"type": "String", "name": "type", "description": " The type of event to fire. This can be any one of\nthe following: keyup, keydown, and keypress."}, {"type": "Boolean", "name": "bubbles", "description": " (Optional) Indicates if the event can be\nbubbled up. DOM Level 3 specifies that all key events bubble by\ndefault. The default is true."}, {"type": "Boolean", "name": "cancelable", "description": " (Optional) Indicates if the event can be\ncanceled using preventDefault(). DOM Level 3 specifies that all\nkey events can be cancelled. The default \nis true."}, {"type": "Window", "name": "view", "description": " (Optional) The view containing the target. This is\ntypically the window object. The default is window."}, {"type": "Boolean", "name": "ctrlKey", "description": " (Optional) Indicates if one of the CTRL keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "altKey", "description": " (Optional) Indicates if one of the ALT keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "shiftKey", "description": " (Optional) Indicates if one of the SHIFT keys\nis pressed while the event is firing. The default is false."}, {"type": "Boolean", "name": "metaKey", "description": " (Optional) Indicates if one of the META keys\nis pressed while the event is firing. The default is false."}, {"type": "int", "name": "keyCode", "description": " (Optional) The code for the key that is in use. \nThe default is 0."}, {"type": "int", "name": "charCode", "description": " (Optional) The Unicode code for the character\nassociated with the key being used. The default is 0."}]}, "mouseover": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to act on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a mouseover event on a particular element. Use \"relatedTarget\"\non the options object to specify where the mouse moved from.\nQuirks: Firefox less than 2.0 doesn't set relatedTarget properly, so\nfromElement is assigned in its place. IE doesn't allow fromElement to be\nbe assigned, so relatedTarget is assigned in its place. Both of these\nconcessions allow YAHOO.util.Event.getRelatedTarget() to work correctly\nin both browsers.", "guessedname": "mouseover", "guessedtype": "function"}, "click": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to click on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a click on a particular element.", "guessedname": "click", "guessedtype": "function"}, "dblclick": {"static": "", "params": [{"type": "HTMLElement", "name": "target", "description": " The element to double click on."}, {"type": "Object", "name": "options", "description": " Additional event options (use DOM standard names)."}], "description": "Simulates a double click on a particular element.", "guessedname": "dblclick", "guessedtype": "function"}}, "static": "", "file": "UserAction.js", "guessedtype": "property", "shortname": "UserAction", "description": "The UserAction object provides functions that simulate events occurring in\nthe browser. Since these are simulated events, they do not behave exactly\nas regular, user-initiated events do, but can be used to test simple\nuser interactions safely."}, "YAHOO.widget.Tab": {"name": "YAHOO.widget.Tab", "configs": {"disabled": {"type": "Boolean", "description": "Whether or not the tab is disabled."}, "dataTimeout": {"default": "null", "type": "Number", "description": "Number if milliseconds before aborting and calling failure handler."}, "contentEl": {"type": "HTMLElement", "description": "The HTMLElement that contains the tab's content."}, "href": {"default": "'#'", "type": "String", "description": "The href of the tab's anchor element."}, "cacheData": {"default": "false", "type": "Boolean", "description": "Whether or not content should be reloaded for every view."}, "dataSrc": {"type": "String", "description": "The tab's data source, used for loading content dynamically."}, "label": {"type": "String", "description": "The tab's label text (or innerHTML)."}, "content": {"type": "String", "description": "The tab's content."}, "loadMethod": {"default": "\"GET\"", "type": "String", "description": "The method to use for the data request."}, "contentVisible": {"default": "false", "type": "Boolean", "description": "The Whether or not the tab's content is visible."}, "activationEvent": {"type": "String", "description": "The event that triggers the tab's activation."}, "active": {"type": "Boolean", "description": "Whether or not the tab is currently active.\nIf a dataSrc is set for the tab, the content will be loaded from\nthe given source."}, "labelEl": {"type": "HTMLElement", "description": "The element that contains the tab's label."}, "dataLoaded": {"type": "Boolean", "description": "Whether or not any data has been loaded from the server."}}, "constructors": [{"params": [{"type": "HTMLElement | String", "name": "element", "description": " (optional) The html element that \nrepresents the TabView. An element will be created if none provided."}, {"type": "Object", "name": "properties", "description": " A key map of initial properties"}], "description": "A representation of a Tab's label and content."}], "namespace": "YAHOO.widget", "module": "tabview", "events": {"contentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "contentChange", "description": "Fires when the value for the configuration attribute 'content' changes."}, "beforeContentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContentChange", "description": "Fires before the value for the configuration attribute 'content' changes. Return false to cancel the attribute change."}, "beforeDisabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDisabledChange", "description": "Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change."}, "dataTimeoutChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataTimeoutChange", "description": "Fires when the value for the configuration attribute 'dataTimeout' changes."}, "beforeDataTimeoutChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataTimeoutChange", "description": "Fires before the value for the configuration attribute 'dataTimeout' changes. Return false to cancel the attribute change."}, "beforeHrefChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHrefChange", "description": "Fires before the value for the configuration attribute 'href' changes. Return false to cancel the attribute change."}, "beforeCacheDataChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCacheDataChange", "description": "Fires before the value for the configuration attribute 'cacheData' changes. Return false to cancel the attribute change."}, "activationEventChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "activationEventChange", "description": "Fires when the value for the configuration attribute 'activationEvent' changes."}, "hrefChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hrefChange", "description": "Fires when the value for the configuration attribute 'href' changes."}, "beforeDataSrcChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataSrcChange", "description": "Fires before the value for the configuration attribute 'dataSrc' changes. Return false to cancel the attribute change."}, "loadMethodChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "loadMethodChange", "description": "Fires when the value for the configuration attribute 'loadMethod' changes."}, "dataSrcChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataSrcChange", "description": "Fires when the value for the configuration attribute 'dataSrc' changes."}, "beforeLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLabelChange", "description": "Fires before the value for the configuration attribute 'label' changes. Return false to cancel the attribute change."}, "beforeContentElChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContentElChange", "description": "Fires before the value for the configuration attribute 'contentEl' changes. Return false to cancel the attribute change."}, "labelElChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "labelElChange", "description": "Fires when the value for the configuration attribute 'labelEl' changes."}, "beforeActivationEventChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeActivationEventChange", "description": "Fires before the value for the configuration attribute 'activationEvent' changes. Return false to cancel the attribute change."}, "labelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "labelChange", "description": "Fires when the value for the configuration attribute 'label' changes."}, "disabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "disabledChange", "description": "Fires when the value for the configuration attribute 'disabled' changes."}, "cacheDataChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "cacheDataChange", "description": "Fires when the value for the configuration attribute 'cacheData' changes."}, "contentElChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "contentElChange", "description": "Fires when the value for the configuration attribute 'contentEl' changes."}, "beforeContentVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContentVisibleChange", "description": "Fires before the value for the configuration attribute 'contentVisible' changes. Return false to cancel the attribute change."}, "activeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "activeChange", "description": "Fires when the value for the configuration attribute 'active' changes."}, "beforeLabelElChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLabelElChange", "description": "Fires before the value for the configuration attribute 'labelEl' changes. Return false to cancel the attribute change."}, "beforeLoadMethodChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLoadMethodChange", "description": "Fires before the value for the configuration attribute 'loadMethod' changes. Return false to cancel the attribute change."}, "beforeActiveChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeActiveChange", "description": "Fires before the value for the configuration attribute 'active' changes. Return false to cancel the attribute change."}, "beforeDataLoadedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataLoadedChange", "description": "Fires before the value for the configuration attribute 'dataLoaded' changes. Return false to cancel the attribute change."}, "contentVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "contentVisibleChange", "description": "Fires when the value for the configuration attribute 'contentVisible' changes."}, "dataLoadedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataLoadedChange", "description": "Fires when the value for the configuration attribute 'dataLoaded' changes."}}, "guessedname": "Tab", "methods": {"initAttributes": {"params": [{"type": "Object", "name": "attr", "description": " Hash of initial attributes"}], "description": "setAttributeConfigs TabView specific properties.", "guessedname": "initAttributes", "guessedtype": "function"}, "toString": {"return": {"type": "", "description": "String"}, "description": "Provides a readable name for the tab.", "guessedname": "toString", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "Tab.js", "guessedtype": "function", "shortname": "Tab", "properties": {"ACTIVE_TITLE": {"default": "\"active\"", "type": "String", "description": "The title applied to active tabs.", "guessedname": "ACTIVE_TITLE", "guessedtype": "property"}, "DISABLED_CLASSNAME": {"default": "\"disabled\"", "type": "String", "description": "The class name applied to disabled tabs.", "guessedname": "DISABLED_CLASSNAME", "guessedtype": "property"}, "LOADING_CLASSNAME": {"default": "\"disabled\"", "type": "String", "description": "The class name applied to dynamic tabs while loading.", "guessedname": "LOADING_CLASSNAME", "guessedtype": "property"}, "LABEL_INNER_TAGNAME": {"default": "\"em\"", "type": "String", "description": "The default tag name for a Tab's inner element.", "guessedname": "LABEL_TAGNAME", "guessedtype": "property"}, "ACTIVE_CLASSNAME": {"default": "\"selected\"", "type": "String", "description": "The class name applied to active tabs.", "guessedname": "ACTIVE_CLASSNAME", "guessedtype": "property"}, "loadHandler": {"type": "object", "description": "Object containing success and failure callbacks for loading data.", "guessedname": "loadHandler", "guessedtype": "property"}, "dataConnection": {"type": "Object", "description": "Provides a reference to the connection request object when data is\nloaded dynamically.", "guessedname": "dataConnection", "guessedtype": "property"}}, "description": "A representation of a Tab's label and content."}, "YAHOO.widget.Menu": {"name": "YAHOO.widget.Menu", "configs": {"constraintoviewport": {"default": "true", "type": "Boolean", "description": "Boolean indicating if the menu will try to remain inside \nthe boundaries of the size of viewport. This property is only applied \nwhen the \"position\" configuration property is set to dynamic and is \nautomatically applied to all submenus."}, "maxheight": {"default": "0", "type": "Number", "description": "Number defining the maximum height (in pixels) for a menu's \nbody element (<code><div class=\"bd\"<<\/code>). Once a menu's body \nexceeds this height, the contents of the body are scrolled to maintain \nthis value. This value cannot be set lower than the value of the \n\"minscrollheight\" configuration property."}, "classname": {"default": "null", "type": "String", "description": "String representing the CSS class to be applied to the \nmenu's root <code><div><\/code> element. The specified class(es) \nare appended in addition to the default class as specified by the menu's\nCSS_CLASS_NAME constant. When set this property is automatically \napplied to all submenus."}, "visible": {"default": "false", "type": "Boolean", "description": "Boolean indicating whether or not the menu is visible. If \nthe menu's \"position\" configuration property is set to \"dynamic\" (the \ndefault), this property toggles the menu's <code><div><\/code> \nelement's \"visibility\" style property between \"visible\" (true) or \n\"hidden\" (false). If the menu's \"position\" configuration property is \nset to \"static\" this property toggles the menu's \n<code><div><\/code> element's \"display\" style property \nbetween \"block\" (true) or \"none\" (false)."}, "xy": {"default": "null", "type": "Number[]", "description": "Array of the absolute x and y positions of the Menu. This \nproperty is only applied when the \"position\" configuration property is \nset to dynamic."}, "container": {"default": "document.body", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>|String", "description": "HTML element reference or string specifying the id \nattribute of the HTML element that the menu's markup should be \nrendered into."}, "scrollincrement": {"default": "1", "type": "Number", "description": "Number used to control the scroll speed of a menu. Used to \nincrement the \"scrollTop\" property of the menu's body by when a menu's \ncontent is scrolling. When set this property is automatically applied \nto all submenus."}, "minscrollheight": {"default": "90", "type": "Number", "description": "Number defining the minimum threshold for the \"maxheight\" \nconfiguration property. When set this property is automatically applied \nto all submenus."}, "fixedcenter": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the Menu should be anchored to the \ncenter of the viewport. This property is only applied when the \n\"position\" configuration property is set to dynamic."}, "autosubmenudisplay": {"default": "true", "type": "Boolean", "description": "Boolean indicating if submenus are automatically made \nvisible when the user mouses over the menu's items."}, "context": {"default": "null", "type": "Array", "description": "Array of context arguments for context-sensitive positioning. \nThe format is: [id or element, element corner, context corner]. \nFor example, setting this property to [\"img1\", \"tl\", \"bl\"] would \nalign the Mnu's top left corner to the context element's \nbottom left corner. This property is only applied when the \"position\" \nconfiguration property is set to dynamic."}, "keepopen": {"default": "flase", "type": "Boolean", "description": "Boolean indicating if the menu should remain open when clicked."}, "clicktohide": {"default": "true", "type": "Boolean", "description": "Boolean indicating if the menu will automatically be \nhidden if the user clicks outside of it. This property is only \napplied when the \"position\" configuration property is set to dynamic \nand is automatically applied to all submenus."}, "submenualignment": {"default": "[\"tl\",\"tr\"]", "type": "Array", "description": "Array defining how submenus should be aligned to their \nparent menu item. The format is: [itemCorner, submenuCorner]. By default\na submenu's top left corner is aligned to its parent menu item's top \nright corner."}, "disabled": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the menu should be disabled. \nDisabling a menu disables each of its items. (Disabled menu items are \ndimmed and will not respond to user input or fire events.) Disabled\nmenus have a corresponding \"disabled\" CSS class applied to their root\n<code><div><\/code> element."}, "effect": {"default": "null", "type": "Object", "description": "Object or array of objects representing the ContainerEffect \nclasses that are active for animating the container. When set this \nproperty is automatically applied to all submenus."}, "showdelay": {"default": "250", "type": "Number", "description": "Number indicating the time (in milliseconds) that should \nexpire before a submenu is made visible when the user mouses over \nthe menu's items. This property is only applied when the \"position\" \nconfiguration property is set to dynamic and is automatically applied \nto all submenus."}, "preventcontextoverlap": {"default": "true", "type": "Boolean", "description": "Boolean indicating whether or not a submenu should overlap its parent MenuItem \nwhen the \"constraintoviewport\" configuration property is set to \"true\"."}, "x": {"default": "null", "type": "Number", "description": "Number representing the absolute x-coordinate position of \nthe Menu. This property is only applied when the \"position\" \nconfiguration property is set to dynamic."}, "shadow": {"default": "true", "type": "Boolean", "description": "Boolean indicating if the menu should have a shadow."}, "hidedelay": {"default": "0", "type": "Number", "description": "Number indicating the time (in milliseconds) that should \nexpire before the menu is hidden. This property is only applied when \nthe \"position\" configuration property is set to dynamic and is \nautomatically applied to all submenus."}, "submenuhidedelay": {"default": "250", "type": "Number", "description": "Number indicating the time (in milliseconds) that should \nexpire before a submenu is hidden when the user mouses out of a menu item \nheading in the direction of a submenu. The value must be greater than or \nequal to the value specified for the \"showdelay\" configuration property.\nThis property is only applied when the \"position\" configuration property \nis set to dynamic and is automatically applied to all submenus."}, "iframe": {"default": "true for IE6 and below, false for all other browsers.", "type": "Boolean", "description": "Boolean indicating whether or not the Menu should \nhave an IFRAME shim; used to prevent SELECT elements from \npoking through an Overlay instance in IE6. When set to \"true\", \nthe iframe shim is created when the Menu instance is intially\nmade visible. This property is only applied when the \"position\" \nconfiguration property is set to dynamic and is automatically applied \nto all submenus."}, "y": {"default": "null", "type": "Number", "description": "Number representing the absolute y-coordinate position of \nthe Menu. This property is only applied when the \"position\" \nconfiguration property is set to dynamic."}, "position": {"default": "dynamic", "type": "String", "description": "String indicating how a menu should be positioned on the \nscreen. Possible values are \"static\" and \"dynamic.\" Static menus are \nvisible by default and reside in the normal flow of the document \n(CSS position: static). Dynamic menus are hidden by default, reside \nout of the normal flow of the document (CSS position: absolute), and \ncan overlay other elements on the screen."}}, "constructors": [{"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the menu."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source \nfor the menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><div><\/code> element of the menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " \nObject specifying the <code><select><\/code> element to be used as \nthe data source for the menu."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu. See configuration class documentation for \nmore details."}], "description": "The Menu class creates a container that holds a vertical list representing \na set of options or commands. Menu is the base class for all \nmenu containers."}], "namespace": "YAHOO.widget", "module": "menu", "events": {"mouseOutEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the mouse has left the menu. Passes back the DOM \nEvent object as an argument."}, "mouseUpEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user releases a mouse button while the mouse is \nover the menu. Passes back the DOM Event object as an argument."}, "keyUpEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user releases a key when one of the menu's items \nhas focus. Passes back the DOM Event object as an argument."}, "keyPressEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user presses an alphanumeric key when one of the\nmenu's items has focus. Passes back the DOM Event object as an argument."}, "itemAddedEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when an item is added to the menu."}, "mouseOverEvent": {"description": "Fires when the mouse has entered the menu. Passes back \nthe DOM Event object as an argument."}, "itemRemovedEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when an item is removed to the menu."}, "mouseDownEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user mouses down on the menu. Passes back the \nDOM Event object as an argument."}, "clickEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user clicks the on the menu. Passes back the \nDOM Event object as an argument."}, "keyDownEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user presses a key when one of the menu's items \nhas focus. Passes back the DOM Event object as an argument."}}, "guessedname": "Menu", "methods": {"_onRender": {"guessedname": "_onRender", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"render\" event handler for the menu.", "private": "", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the menu.", "guessedname": "toString", "guessedtype": "function"}, "configMaxHeight": {"params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " The Menu instance fired\nthe event."}], "description": "Event handler for when the \"maxheight\" configuration property of \na Menu changes.", "guessedname": "configMaxHeight", "guessedtype": "function"}, "configDisabled": {"params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " The Menu instance fired the event."}], "description": "Event handler for when the \"disabled\" configuration property of \na menu changes.", "guessedname": "configDisabled", "guessedtype": "function"}, "getSubmenus": {"return": {"type": "Array", "description": ""}, "description": "Returns an array of all of the submenus that are immediate \nchildren of the menu.", "guessedname": "getSubmenus", "guessedtype": "function"}, "_onVisibleChange": {"guessedname": "_onVisibleChange", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "Change event handler for the the menu's \"visible\" configuration\nproperty.", "private": "", "guessedtype": "function"}, "positionOffScreen": {"description": "Positions the menu outside of the boundaries of the browser's \nviewport. Called automatically when a menu is hidden to ensure that \nit doesn't force the browser to render uncessary scrollbars.", "guessedname": "positionOffScreen", "guessedtype": "function"}, "_onMenuItemDestroy": {"guessedname": "_onMenuItemDestroy", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item \nthat fired the event."}], "description": "\"destroy\" event handler for the menu's items.", "private": "", "guessedtype": "function"}, "getItemGroups": {"return": {"type": "Array", "description": ""}, "description": "Multi-dimensional Array representing the menu items as they \nare grouped in the menu.", "guessedname": "getItemGroups", "guessedtype": "function"}, "destroy": {"description": "Removes the menu's <code><div><\/code> element \n(and accompanying child nodes) from the document.", "guessedname": "destroy", "guessedtype": "function"}, "_onBeforeRender": {"guessedname": "_onBeforeRender", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"beforerender\" event handler for the menu. Appends all of the \n<code><ul><\/code>, <code><li><\/code> and their accompanying \ntitle elements to the body element of the menu.", "private": "", "guessedtype": "function"}, "_cancelShowDelay": {"description": "Cancels the call to the \"showMenu.\"", "private": "", "guessedname": "_cancelShowDelay", "guessedtype": "function"}, "_getItemGroup": {"return": {"type": "Array", "description": ""}, "description": "Returns the menu item group at the specified index.", "private": "", "params": [{"type": "Number", "name": "p_nIndex", "description": " Number indicating the index of the menu item group \nto be retrieved."}], "guessedname": "_getItemGroup", "guessedtype": "function"}, "setInitialSelection": {"description": "Sets the \"selected\" configuration property of the menu's first \nenabled item to \"true.\"", "guessedname": "setInitialSelection", "guessedtype": "function"}, "_onClick": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"click\" event handler for the menu.", "guessedname": "_onClick", "guessedtype": "function"}, "_onInit": {"guessedname": "_onInit", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"init\" event handler for the menu.", "private": "", "guessedtype": "function"}, "_updateItemProperties": {"guessedname": "_updateItemProperties", "params": [{"type": "Number", "name": "p_nGroupIndex", "description": " Number indicating the group of items to update."}], "description": "Updates the \"index,\" \"groupindex,\" and \"className\" properties \nof the menu items in the specified group.", "private": "", "guessedtype": "function"}, "_onItemAdded": {"guessedname": "_onItemAdded", "params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}], "description": "\"itemadded\" event handler for a Menu instance.", "private": "", "guessedtype": "function"}, "_onHide": {"guessedname": "_onHide", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"hide\" event handler for the menu.", "private": "", "guessedtype": "function"}, "_setScrollHeight": {"guessedname": "_setScrollHeight", "params": [{"type": "String", "name": "p_nScrollHeight", "description": " Number representing the scrolling height of the Menu."}], "description": "", "private": "", "guessedtype": "function"}, "_removeItemFromGroupByValue": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Removes a menu item from a group by reference. Returns the \nmenu item that was removed.", "private": "", "params": [{"type": "Number", "name": "p_nGroupIndex", "description": " Number indicating the group to which the\nmenu item belongs."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance to be removed."}], "guessedname": "_removeItemFromGroupByValue", "guessedtype": "function"}, "_onMenuItemConfigChange": {"guessedname": "_onMenuItemConfigChange", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item \nthat fired the event."}], "description": "\"configchange\" event handler for the menu's items.", "private": "", "guessedtype": "function"}, "clearActiveItem": {"params": [{"type": "Boolean", "name": "p_bBlur", "description": " Boolean indicating if the menu's active item \nshould be blurred."}], "description": "Sets the \"selected\" configuration property of the menu's active\nitem to \"false\" and hides the item's submenu.", "guessedname": "clearActiveItem", "guessedtype": "function"}, "_onMouseOver": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"mouseover\" event handler for the menu.", "guessedname": "_onMouseOver", "guessedtype": "function"}, "_onParentMenuRender": {"guessedname": "_onParentMenuRender", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oSubmenu", "description": " Object representing the submenu that \nsubscribed to the event."}], "description": "\"render\" event handler for a submenu. Renders a \nsubmenu in response to the firing of its parent's \"render\" event.", "private": "", "guessedtype": "function"}, "_enableScrollFooter": {"protected": "", "description": "Enables the footer used for scrolling the body of the menu.", "guessedname": "_enableScrollFooter", "guessedtype": "function"}, "_onBeforeShow": {"guessedname": "_onBeforeShow", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"beforeshow\" event handler for the menu.", "private": "", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the menu."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source \nfor the menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><div><\/code> element of the menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " \nObject specifying the <code><select><\/code> element to be used as \nthe data source for the menu."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu. See configuration class documentation for \nmore details."}], "description": "The Menu class's initialization method. This method is \nautomatically called by the constructor, and sets up all DOM references \nfor pre-existing markup, and creates required markup if it is not \nalready present.", "guessedname": "init", "guessedtype": "function"}, "_addItemToGroup": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Adds a menu item to a group.", "private": "", "params": [{"type": "Number", "name": "p_nGroupIndex", "description": " Number indicating the group to which the \nitem belongs."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance to be added to the menu."}, {"type": "String", "name": "p_oItem", "description": " String specifying the text of the item to be added \nto the menu."}, {"type": "Object", "name": "p_oItem", "description": " Object literal containing a set of menu item \nconfiguration properties."}, {"type": "Number", "name": "p_nItemIndex", "description": " Optional. Number indicating the index at \nwhich the menu item should be added."}], "guessedname": "_addItemToGroup", "guessedtype": "function"}, "_onParentMenuConfigChange": {"guessedname": "_onParentMenuConfigChange", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oSubmenu", "description": " Object representing the submenu that \nsubscribed to the event."}], "description": "\"configchange\" event handler for a submenu.", "private": "", "guessedtype": "function"}, "_cancelHideDelay": {"description": "Cancels the call to \"hideMenu.\"", "private": "", "guessedname": "_cancelHideDelay", "guessedtype": "function"}, "blur": {"description": "Causes the menu to lose focus and fires the \"blur\" event.", "guessedname": "blur", "guessedtype": "function"}, "configHideDelay": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "Event handler for when the \"hidedelay\" configuration property \nof the menu changes.", "guessedname": "configHideDelay", "guessedtype": "function"}, "addItems": {"return": {"type": "Array", "description": ""}, "params": [{"type": "Array", "name": "p_aItems", "description": " Array of items to be added to the menu. The array \ncan contain strings specifying the text for each item to be created, object\nliterals specifying each of the menu item configuration properties, \nor MenuItem instances."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number specifying the group to \nwhich the items belongs."}], "description": "Adds an array of items to the menu.", "guessedname": "addItems", "guessedtype": "function"}, "_onBeforeHide": {"guessedname": "_onBeforeHide", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"beforehide\" event handler for the menu.", "private": "", "guessedtype": "function"}, "setInitialFocus": {"description": "Sets focus to the menu's first enabled item.", "guessedname": "setInitialFocus", "guessedtype": "function"}, "_getFirstEnabledItem": {"guessedname": "_getFirstEnabledItem", "return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Returns the first enabled item in the menu.", "private": "", "guessedtype": "function"}, "_createItemGroup": {"return": {"type": "Array", "description": ""}, "description": "Creates a new menu item group (array) and its associated \n<code><ul><\/code> element. Returns an aray of menu item groups.", "private": "", "params": [{"type": "Number", "name": "p_nIndex", "description": " Number indicating the group to create."}], "guessedname": "_createItemGroup", "guessedtype": "function"}, "getItems": {"return": {"type": "Array", "description": ""}, "description": "Returns an array of all of the items in the menu.", "guessedname": "getItems", "guessedtype": "function"}, "focus": {"description": "Causes the menu to receive focus and fires the \"focus\" event.", "guessedname": "focus", "guessedtype": "function"}, "insertItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "params": [{"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance to be added to the menu."}, {"type": "String", "name": "p_oItem", "description": " String specifying the text of the item to be added \nto the menu."}, {"type": "Object", "name": "p_oItem", "description": " Object literal containing a set of menu item \nconfiguration properties."}, {"type": "Number", "name": "p_nItemIndex", "description": " Number indicating the ordinal position at which\nthe item should be added."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number indicating the group to which \nthe item belongs."}], "description": "Inserts an item into the menu at the specified index.", "guessedname": "insertItem", "guessedtype": "function"}, "_configureSubmenu": {"guessedname": "_configureSubmenu", "params": [{"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance with the submenu to be configured."}], "description": "Subscribes the menu item's submenu to its parent menu's events.", "private": "", "guessedtype": "function"}, "addItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "params": [{"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance to be added to the menu."}, {"type": "String", "name": "p_oItem", "description": " String specifying the text of the item to be added \nto the menu."}, {"type": "Object", "name": "p_oItem", "description": " Object literal containing a set of menu item \nconfiguration properties."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number indicating the group to\nwhich the item belongs."}], "description": "Appends an item to the menu.", "guessedname": "addItem", "guessedtype": "function"}, "_onScrollTargetMouseOut": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed \nback by the event utility (YAHOO.util.Event)."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "\"mouseout\" event handler for the menu's \"header\" and \"footer\" \nelements. Used to stop scrolling the body of the menu up and down when the \nmenu's \"maxheight\" configuration property is set to a value greater than 0.", "guessedname": "_onScrollTargetMouseOut", "guessedtype": "function"}, "_disableScrollHeader": {"protected": "", "description": "Disables the header used for scrolling the body of the menu.", "guessedname": "_disableScrollHeader", "guessedtype": "function"}, "configVisible": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "Event handler for when the \"visible\" configuration property \nthe menu changes.", "guessedname": "configVisible", "guessedtype": "function"}, "configContainer": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "Event handler for when the \"container\" configuration property \nof the menu changes.", "guessedname": "configContainer", "guessedtype": "function"}, "_clearSetWidthFlag": {"description": "Change event listener for the \"width\" configuration property. This listener is \nadded when a Menu's \"width\" configuration property is set by the \"_setScrollHeight\" method, and \nis used to set the \"_widthSetForScroll\" property to \"false\" if the \"width\" configuration property \nis changed after it was set by the \"_setScrollHeight\" method. If the \"_widthSetForScroll\" \nproperty is set to \"false\", and the \"_setScrollHeight\" method is in the process of tearing down \nscrolling functionality, it will maintain the Menu's new width rather than reseting it.", "private": "", "guessedname": "_clearSetWidthFlag", "guessedtype": "function"}, "clearContent": {"description": "Removes all of the content from the menu, including the menu \nitems, group titles, header and footer.", "guessedname": "clearContent", "guessedtype": "function"}, "getItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "params": [{"type": "Number", "name": "p_nItemIndex", "description": " Number indicating the ordinal position of the \nitem to be retrieved."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number indicating the group to which \nthe item belongs."}], "description": "Returns the item at the specified index.", "guessedname": "getItem", "guessedtype": "function"}, "removeItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "params": [{"type": "YAHOO.widget.MenuItem", "name": "p_oObject", "description": " Object reference for the MenuItem \ninstance to be removed from the menu."}, {"type": "Number", "name": "p_oObject", "description": " Number specifying the index of the item \nto be removed."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number specifying the group to \nwhich the item belongs."}], "description": "Removes the specified item from the menu.", "guessedname": "removeItem", "guessedtype": "function"}, "_enableScrollHeader": {"protected": "", "description": "Enables the header used for scrolling the body of the menu.", "guessedname": "_enableScrollHeader", "guessedtype": "function"}, "_removeItemFromGroupByIndex": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Removes a menu item from a group by index. Returns the menu \nitem that was removed.", "private": "", "params": [{"type": "Number", "name": "p_nGroupIndex", "description": " Number indicating the group to which the menu \nitem belongs."}, {"type": "Number", "name": "p_nItemIndex", "description": " Number indicating the index of the menu item \nto be removed."}], "guessedname": "_removeItemFromGroupByIndex", "guessedtype": "function"}, "_onShow": {"guessedname": "_onShow", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"show\" event handler for the menu.", "private": "", "guessedtype": "function"}, "_disableScrollFooter": {"protected": "", "description": "Disables the footer used for scrolling the body of the menu.", "guessedname": "_disableScrollFooter", "guessedtype": "function"}, "hasFocus": {"return": {"type": "Boolean", "description": ""}, "description": "Returns a boolean indicating whether or not the menu has focus.", "guessedname": "hasFocus", "guessedtype": "function"}, "setItemGroupTitle": {"params": [{"type": "String", "name": "p_sGroupTitle", "description": " String specifying the title of the group."}, {"type": "Number", "name": "p_nGroupIndex", "description": " Optional. Number specifying the group to which\nthe title belongs."}], "description": "Sets the title of a group of menu items.", "guessedname": "setItemGroupTitle", "guessedtype": "function"}, "_onMouseMove": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed \nback by the event utility (YAHOO.util.Event)."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "\"click\" event handler for the menu.", "guessedname": "_onMouseMove", "guessedtype": "function"}, "getRoot": {"description": "Finds the menu's root menu.", "guessedname": "getRoot", "guessedtype": "function"}, "configShadow": {"params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " The Menu instance fired the event."}], "description": "Event handler for when the \"shadow\" configuration property of \na menu changes.", "guessedname": "configShadow", "guessedtype": "function"}, "subscribe": {"params": [{"type": "string", "name": "p_type", "description": " the type, or name of the event"}, {"type": "function", "name": "p_fn", "description": " the function to exectute when the event fires"}, {"type": "Object", "name": "p_obj", "description": " An object to be passed along when the event \nfires"}, {"type": "boolean", "name": "p_override", "description": " If true, the obj passed in becomes the \nexecution scope of the listener"}], "description": "Adds the specified CustomEvent subscriber to the menu and each of \nits submenus.", "guessedname": "subscribe", "guessedtype": "function"}, "_setMaxHeight": {"guessedname": "_setMaxHeight", "params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}, {"type": "Number", "name": "p_nMaxHeight", "description": " Number representing the value to set for the \n\"maxheight\" configuration property."}], "description": "\"renderEvent\" handler used to defer the setting of the \n\"maxheight\" configuration property until the menu is rendered in lazy \nload scenarios.", "private": "", "guessedtype": "function"}, "_subscribeToItemEvents": {"guessedname": "_subscribeToItemEvents", "params": [{"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object reference for the MenuItem \ninstance whose events should be subscribed to."}], "description": "Subscribes a menu to a menu item's event.", "private": "", "guessedtype": "function"}, "_onYChange": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}], "description": "\"y\" event handler for a Menu instance.", "guessedname": "_onYChange", "guessedtype": "function"}, "_onMouseOut": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"mouseout\" event handler for the menu.", "guessedname": "_onMouseOut", "guessedtype": "function"}, "_initSubTree": {"description": "Iterates the childNodes of the source element to find nodes \nused to instantiate menu and menu items.", "private": "", "guessedname": "_initSubTree", "guessedtype": "function"}, "configIframe": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "Event handler for when the \"iframe\" configuration property of \nthe menu changes.", "guessedname": "configIframe", "guessedtype": "function"}, "_onScrollTargetMouseOver": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed \nback by the event utility (YAHOO.util.Event)."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "\"mouseover\" event handler for the menu's \"header\" and \"footer\" \nelements. Used to scroll the body of the menu up and down when the \nmenu's \"maxheight\" configuration property is set to a value greater than 0.", "guessedname": "_onScrollTargetMouseOver", "guessedtype": "function"}, "configClassName": {"params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " The Menu instance fired the event."}], "description": "Event handler for when the \"classname\" configuration property of \na menu changes.", "guessedname": "configClassName", "guessedtype": "function"}, "_onKeyPress": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}], "description": "\"keypress\" event handler for a Menu instance.", "guessedname": "_onKeyPress", "guessedtype": "function"}, "initEvents": {"description": "Initializes the custom events for the menu.", "guessedname": "initEvents", "guessedtype": "function"}, "checkPosition": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "Object", "name": "p_sPosition", "description": " String specifying the position of the menu."}], "description": "Checks to make sure that the value of the \"position\" property \nis one of the supported strings. Returns true if the position is supported.", "private": ""}, "_execSubmenuHideDelay": {"guessedname": "_execSubmenuHideDelay", "params": [{"type": "YAHOO.widget.Menu", "name": "p_oSubmenu", "description": " Object specifying the submenu that \nshould be hidden."}, {"type": "Number", "name": "p_nMouseX", "description": " The x coordinate of the mouse when it left \nthe specified submenu's parent menu item."}, {"type": "Number", "name": "p_nHideDelay", "description": " The number of milliseconds that should ellapse\nbefore the submenu is hidden."}], "description": "Hides a submenu after the number of milliseconds specified by \nthe \"submenuhidedelay\" configuration property have ellapsed.", "private": "", "guessedtype": "function"}, "_onKeyDown": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"keydown\" event handler for the menu.", "guessedname": "_onKeyDown", "guessedtype": "function"}, "_onBlur": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " The name of the event that was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Collection of arguments sent when the event \nwas fired."}], "description": "\"blur\" event handler for a Menu instance.", "guessedname": "_onBlur", "guessedtype": "function"}, "configPosition": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object representing the menu that \nfired the event."}], "description": "Event handler for when the \"position\" configuration property \nof the menu changes.", "guessedname": "configPosition", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be\nchanged using the menu's Config object (\"cfg\").", "guessedname": "initDefaultConfig", "guessedtype": "function"}, "_execHideDelay": {"description": "Hides the menu after the number of milliseconds specified by \nthe \"hidedelay\" configuration property.", "private": "", "guessedname": "_execHideDelay", "guessedtype": "function"}}, "extends": "YAHOO.widget.Overlay", "superclass": "YAHOO.widget.Overlay", "file": "menu.js", "guessedtype": "function", "shortname": "Menu", "properties": {"activeItem": {"default": "null", "type": "YAHOO.widget.MenuItem", "description": "Object reference to the item in the menu that has is selected.", "guessedname": "activeItem", "guessedtype": "property"}, "CSS_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied to the \nmenu's <code><div><\/code> element.", "default": "\"yuimenu\"", "guessedname": "CSS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}, "lazyLoad": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the menu's \"lazy load\" feature is \nenabled. If set to \"true,\" initialization and rendering of the menu's \nitems will be deferred until the first time it is made visible. This \nproperty should be set via the constructor using the configuration \nobject literal.", "guessedname": "lazyLoad", "guessedtype": "property"}, "parent": {"default": "null", "type": "YAHOO.widget.MenuItem", "description": "Object reference to the menu's parent menu or menu item. \nThis property can be set via the constructor using the configuration \nobject literal.", "guessedname": "parent", "guessedtype": "property"}, "_bStopMouseEventHandlers": {"description": "Stops \"mouseover,\" \"mouseout,\" and \"mousemove\" event handlers \nfrom executing.", "default": "false", "private": "", "guessedname": "_bStopMouseEventHandlers", "guessedtype": "property", "type": "Boolean"}, "_bHandledMouseOverEvent": {"description": "Boolean indicating the current state of the menu's \n\"mouseover\" event.", "default": "false", "private": "", "guessedname": "_bHandledMouseOverEvent", "guessedtype": "property", "type": "Boolean"}, "srcElement": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-94282980\">HTMLSelectElement<\/a>|<a \nhref=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.\nhtml#ID-22445964\">HTMLDivElement<\/a>", "description": "Object reference to the HTML element (either \n<code><select><\/code> or <code><div><\/code>) used to \ncreate the menu.", "guessedname": "srcElement", "guessedtype": "property"}, "_bHandledMouseOutEvent": {"description": "Boolean indicating the current state of the menu's\n\"mouseout\" event.", "default": "false", "private": "", "guessedname": "_bHandledMouseOutEvent", "guessedtype": "property", "type": "Boolean"}, "_sClassName": {"description": "The current value of the \"classname\" configuration attribute.", "default": "null", "private": "", "guessedname": "_sClassName", "guessedtype": "property", "type": "String"}, "ITEM_TYPE": {"description": "Object representing the type of menu item to instantiate and \nadd when parsing the child nodes (either <code><li><\/code> element, \n<code><optgroup><\/code> element or <code><option><\/code>) \nof the menu's source HTML element.", "default": "YAHOO.widget.MenuItem", "guessedname": "ITEM_TYPE", "guessedtype": "property", "type": "YAHOO.widget.MenuItem", "final": ""}, "itemData": {"default": "null", "type": "Array", "description": "Array of items to be added to the menu. The array can contain \nstrings representing the text for each item to be created, object literals \nrepresenting the menu item configuration properties, or MenuItem instances. \nThis property should be set via the constructor using the configuration \nobject literal.", "guessedname": "itemData", "guessedtype": "property"}, "GROUP_TITLE_TAG_NAME": {"description": "String representing the tagname of the HTML element used to \ntitle the menu's item groups.", "default": "H6", "guessedname": "GROUP_TITLE_TAG_NAME", "guessedtype": "property", "type": "String", "final": ""}, "_aGroupTitleElements": {"description": "Array of HTML element used to title groups of menu items.", "default": "[]", "private": "", "guessedname": "_aGroupTitleElements", "guessedtype": "property", "type": "Array"}, "_bHideDelayEventHandlersAssigned": {"description": "Boolean indicating if the \"mouseover\" and \"mouseout\" event \nhandlers used for hiding the menu via a call to \"YAHOO.lang.later\" have \nalready been assigned.", "default": "false", "private": "", "guessedname": "_bHideDelayEventHandlersAssigned", "guessedtype": "property", "type": "Boolean"}, "_aListElements": {"description": "Array of <code><ul><\/code> elements, each of which is \nthe parent node for each item's <code><li><\/code> element.", "default": "[]", "private": "", "guessedname": "_aListElements", "guessedtype": "property", "type": "Array"}, "_nCurrentMouseX": {"description": "The current x coordinate of the mouse inside the area of \nthe menu.", "default": "0", "private": "", "guessedname": "_nCurrentMouseX", "guessedtype": "property", "type": "Number"}, "_aItemGroups": {"description": "Multi-dimensional Array representing the menu items as they\nare grouped in the menu.", "default": "[]", "private": "", "guessedname": "_aItemGroups", "guessedtype": "property", "type": "Array"}, "OFF_SCREEN_POSITION": {"description": "Array representing the default x and y position that a menu \nshould have when it is positioned outside the viewport by the \n\"poistionOffScreen\" method.", "default": "\"-999em\"", "guessedname": "OFF_SCREEN_POSITION", "guessedtype": "property", "type": "String", "final": ""}}, "description": "The Menu class creates a container that holds a vertical list representing \na set of options or commands. Menu is the base class for all \nmenu containers."}, "YAHOO.util.Number": {"name": "YAHOO.util.Number", "namespace": "YAHOO.util", "module": "datasource", "guessedname": "Number", "methods": {"format": {"return": {"type": "String", "description": "Formatted number for display."}, "params": [{"type": "Number", "name": "nData", "description": " Number."}, {"type": "Object} (Optional) Optional configuration values:\n<dl>\n<dt>prefix {String}<\/dd>\n<dd>String prepended before each number, like a currency designator \"$\"<\/dd>\n<dt>decimalPlaces {Number}<\/dd>\n<dd>Number of decimal places to round.<\/dd>\n<dt>decimalSeparator {String}<\/dd>\n<dd>Decimal separator<\/dd>\n<dt>thousandsSeparator {String}<\/dd>\n<dd>Thousands separator<\/dd>\n<dt>suffix {String", "name": "oConfig", "description": " <\/dd>\n<dd>String appended after each number, like \" items\" (note the space)<\/dd>\n<\/dl>"}], "description": "Takes a native JavaScript Number and formats to string for display to user.", "guessedname": "format", "guessedtype": "function"}}, "static": "", "file": "Type.js", "guessedtype": "property", "shortname": "Number", "requires": "yahoo", "description": "The static Number class provides helper functions to deal with data of type\nNumber."}, "YAHOO.widget.Calendar2up": {"name": "YAHOO.widget.Calendar2up", "deprecated": "The old Calendar2up class is no longer necessary, since CalendarGroup renders in a 2up view by default.", "namespace": "YAHOO.widget", "module": "calendar", "guessedname": "Calendar2up", "extends": "YAHOO.widget.CalendarGroup", "superclass": "YAHOO.widget.CalendarGroup", "file": "CalendarGroup.js", "guessedtype": "function", "shortname": "Calendar2up", "properties": {"Cal2up": {"deprecated": "The old Calendar2up class is no longer necessary, since CalendarGroup renders in a 2up view by default.", "guessedname": "Cal2up", "guessedtype": "property"}}}, "YAHOO.widget.Slider": {"name": "YAHOO.widget.Slider", "description": "A DragDrop implementation that can be used as a background for a\nslider. It takes a reference to the thumb instance \nso it can delegate some of the events to it. The goal is to make the \nthumb jump to the location on the background when the background is \nclicked.", "constructors": [{"params": [{"type": "String", "name": "id", "description": " The id of the element linked to this instance"}, {"type": "String", "name": "sGroup", "description": " The group of related DragDrop items"}, {"type": "SliderThumb", "name": "oThumb", "description": " The thumb for this slider"}, {"type": "String", "name": "sType", "description": " The type of slider (horiz, vert, region)"}], "description": "A DragDrop implementation that can be used as a background for a\nslider. It takes a reference to the thumb instance \nso it can delegate some of the events to it. The goal is to make the \nthumb jump to the location on the background when the background is \nclicked."}], "namespace": "YAHOO.widget", "module": "slider", "events": {"slideEnd": {"description": "Event that fires at the end of a slider thumb move"}, "change": {"params": [{"type": "int", "name": "newOffset|x", "description": " the new offset for normal sliders, or the new\nx offset for region sliders"}, {"type": "int", "name": "y", "description": " the number of pixels the thumb has moved on the y axis\n(region sliders only)"}], "description": "Event the fires when the value of the control changes. If \nthe control is animated the event will fire every point\nalong the way."}, "slideStart": {"description": "Event that fires at the beginning of a slider thumb move."}}, "guessedname": "Slider", "uses": ["YAHOO.util.EventProvider"], "superclass": "YAHOO.util.DragDrop", "file": "Slider.js", "guessedtype": "function", "extends": "YAHOO.util.DragDrop", "shortname": "Slider", "properties": {"moveComplete": {"deprecated": "use the slideEnd event instead", "type": "Boolean", "description": "moveComplete is set to true when the slider has moved to its final\ndestination. For animated slider, this value can be checked in \nthe onChange handler to make it possible to execute logic only\nwhen the move is complete rather than at all points along the way.\nDeprecated because this flag is only useful when the background is\nclicked and the slider is animated. If the user drags the thumb,\nthe flag is updated when the drag is over ... the final onDrag event\nfires before the mouseup the ends the drag, so the implementer will\nnever see it.", "guessedname": "moveComplete", "guessedtype": "property"}, "isTarget": {"private": "", "description": "Overrides the isTarget property in YAHOO.util.DragDrop", "guessedname": "isTarget", "guessedtype": "property"}, "thumb": {"type": "YAHOO.widget.SliderThumb", "description": "A YAHOO.widget.SliderThumb instance that we will use to \nreposition the thumb when the background is clicked", "guessedname": "thumb", "guessedtype": "property"}, "baselinePos": {"type": "[int, int]", "description": "The basline position of the background element, used\nto determine if the background has moved since the last\noperation.", "guessedname": "baselinePos", "guessedtype": "property"}, "thumbCenterPoint": {"type": "{\"x\": int, \"y\": int}", "description": "The center of the slider element is stored so we can \nplace it in the correct position when the background is clicked.", "guessedname": "thumbCenterPoint", "guessedtype": "property"}, "SOURCE_SET_VALUE": {"default": "2", "final": "", "description": "Constant for valueChangeSource, indicating that the value was altered\nby a programmatic call to setValue\/setRegionValue.", "guessedname": "SOURCE_SET_VALUE", "guessedtype": "property"}, "SOURCE_UI_EVENT": {"default": "1", "final": "", "description": "Constant for valueChangeSource, indicating that the user clicked or\ndragged the slider to change the value.", "guessedname": "SOURCE_UI_EVENT", "guessedtype": "property"}, "keyIncrement": {"type": "int", "description": "Specifies the number of pixels the arrow keys will move the slider.\nDefault is 20.", "guessedname": "keyIncrement", "guessedtype": "property"}, "_silent": {"guessedname": "_silent", "type": "boolean", "description": "Indicates whether or not events will be supressed for the current\nslide operation", "private": "", "guessedtype": "property"}, "dragOnly": {"default": "true", "type": "boolean", "description": "Override the default setting of dragOnly to true.", "guessedname": "dragOnly", "guessedtype": "property"}, "valueChangeSource": {"since": "2.3.0", "type": "int", "description": "When the slider value changes, this property is set to identify where\nthe update came from. This will be either 1, meaning the slider was\nclicked or dragged, or 2, meaning that it was set via a setValue() call.\nThis can be used within event handlers to apply some of the logic only\nwhen dealing with one source or another.", "guessedname": "valueChangeSource", "guessedtype": "property"}, "backgroundEnabled": {"type": "boolean", "description": "Set to false to disable a background click thumb move", "guessedname": "backgroundEnabled", "guessedtype": "property"}, "animationDuration": {"default": "0.2", "type": "int", "description": "If animation is configured, specifies the length of the animation\nin seconds.", "guessedname": "animationDuration", "guessedtype": "property"}, "YAHOO.widget.Slider.ANIM_AVAIL": {"type": "boolean", "static": "", "description": "By default, animation is available if the animation utility is detected.", "guessedname": "ANIM_AVAIL", "guessedtype": "property"}, "lastOffset": {"type": "[int, int]", "description": "Saved offset used to protect against NaN problems when slider is\nset to display:none", "guessedname": "lastOffset", "guessedtype": "property"}, "type": {"type": "string", "description": "The type of the slider (horiz, vert, region)", "guessedname": "type", "guessedtype": "property"}, "animate": {"type": "boolean", "description": "Flag that determines if the thumb will animate when moved", "guessedname": "animate", "guessedtype": "property"}, "tickPause": {"type": "int", "description": "Adjustment factor for tick animation, the more ticks, the\nfaster the animation (by default)", "guessedname": "tickPause", "guessedtype": "property"}, "enableKeys": {"type": "boolean", "description": "Enables the arrow, home and end keys, defaults to true.", "guessedname": "enableKeys", "guessedtype": "property"}}, "methods": {"YAHOO.widget.Slider.getHorizDualSlider": {"return": {"type": "DualSlider", "description": "a horizontal dual-thumb slider control"}, "description": "Factory method for creating a horizontal dual-thumb slider", "static": "", "guessedname": "getHorizDualSlider", "guessedtype": "property", "params": [{"type": "String", "name": "bg", "description": " the id of the slider's background element"}, {"type": "String", "name": "minthumb", "description": " the id of the min thumb"}, {"type": "String", "name": "maxthumb", "description": " the id of the thumb thumb"}, {"type": "int", "name": "range", "description": " the number of pixels the thumbs can move within"}, {"type": "int", "name": "iTickSize", "description": " (optional) the element should move this many pixels\nat a time"}, {"type": "Array", "name": "initVals", "description": " (optional) [min,max] Initial thumb placement"}]}, "fireEvents": {"guessedname": "fireEvents", "params": [{"type": "boolean", "name": "thumbEvent", "description": " set to true if this event is fired from an event\nthat occurred on the thumb. If it is, the state of the\nthumb dd object should be correct. Otherwise, the event\noriginated on the background, so the thumb state needs to\nbe refreshed before proceeding."}], "description": "Fires the change event if the value has been changed. Ignored if we are in\nthe middle of an animation as the event will fire when the animation is\ncomplete", "private": "", "guessedtype": "function"}, "lock": {"description": "Locks the slider, overrides YAHOO.util.DragDrop", "guessedname": "lock", "guessedtype": "function"}, "YAHOO.widget.Slider.getHorizSlider": {"return": {"type": "Slider", "description": "a horizontal slider control"}, "description": "Factory method for creating a horizontal slider", "static": "", "guessedname": "getHorizSlider", "guessedtype": "property", "params": [{"type": "String", "name": "sBGElId", "description": " the id of the slider's background element"}, {"type": "String", "name": "sHandleElId", "description": " the id of the thumb element"}, {"type": "int", "name": "iLeft", "description": " the number of pixels the element can move left"}, {"type": "int", "name": "iRight", "description": " the number of pixels the element can move right"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the element \nshould move a certain number pixels at a time."}]}, "focus": {"private": "", "description": "Try to focus the element when clicked so we can add\naccessibility features", "guessedname": "focus", "guessedtype": "function"}, "onMouseDown": {"private": "", "description": "Handles the mousedown event for the slider background", "guessedname": "onMouseDown", "guessedtype": "function"}, "handleKeyDown": {"params": [{"type": "Event", "name": "e", "description": " the keydown event"}], "description": "Executed when a keydown event happens with the control focused.\nUpdates the slider value and display when the keypress is an\narrow key, home, or end as long as enableKeys is set to true.", "guessedname": "handleKeyDown", "guessedtype": "function"}, "resetThumbConstraints": {"protected": "", "description": "Resets the X and Y contraints for the thumb. Used in lieu of the thumb\ninstance's inherited resetConstraints because some logic was not\napplicable.", "guessedname": "resetThumbConstraints", "guessedtype": "function"}, "getXValue": {"return": {"type": "int", "description": "the current horizontal offset"}, "description": "Returns the slider's thumb X offset from the start position", "guessedname": "getXValue", "guessedtype": "function"}, "moveThumb": {"guessedname": "moveThumb", "params": [{"type": "int", "name": "x", "description": " the X coordinate of the click"}, {"type": "int", "name": "y", "description": " the Y coordinate of the click"}, {"type": "boolean", "name": "skipAnim", "description": " don't animate if the move happend onDrag"}, {"type": "boolean", "name": "midMove", "description": " set to true if this is not terminating\nthe slider movement"}], "description": "Move the associated slider moved to a timeout to try to get around the \nmousedown stealing moz does when I move the slider element between the \ncursor and the background during the mouseup event", "private": "", "guessedtype": "function"}, "setRegionValue": {"return": {"type": "boolean", "description": "true if the move was performed, false if it failed"}, "params": [{"type": "int", "name": "newOffset", "description": " the number of pixels the thumb should be\npositioned away from the initial start point (x axis for region)"}, {"type": "int", "name": "newOffset2", "description": " the number of pixels the thumb should be\npositioned away from the initial start point (y axis for region)"}, {"type": "boolean", "name": "skipAnim", "description": " set to true to disable the animation\nfor this move action (but not others)."}, {"type": "boolean", "name": "force", "description": " ignore the locked setting and set value anyway"}, {"type": "boolean", "name": "silent", "description": " when true, do not fire events"}], "description": "Provides a way to set the value of the region slider in code.", "guessedname": "setRegionValue", "guessedtype": "function"}, "onSliderEnd": {"deprecated": "use instance.subscribe(\"slideEnd\") instead", "description": "Event that fires at the end of a slider thumb move", "guessedname": "onSlideEnd", "guessedtype": "function"}, "thumbMouseUp": {"private": "", "description": "Handles mouseup event on the thumb", "guessedname": "thumbMouseUp", "guessedtype": "function"}, "YAHOO.widget.Slider.getSliderRegion": {"return": {"type": "Slider", "description": "a slider region control"}, "description": "Factory method for creating a slider region like the one in the color\npicker example", "static": "", "guessedname": "getSliderRegion", "guessedtype": "property", "params": [{"type": "String", "name": "sBGElId", "description": " the id of the slider's background element"}, {"type": "String", "name": "sHandleElId", "description": " the id of the thumb element"}, {"type": "int", "name": "iLeft", "description": " the number of pixels the element can move left"}, {"type": "int", "name": "iRight", "description": " the number of pixels the element can move right"}, {"type": "int", "name": "iUp", "description": " the number of pixels the element can move up"}, {"type": "int", "name": "iDown", "description": " the number of pixels the element can move down"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the element \nshould move a certain number pixels at a time."}]}, "verifyOffset": {"return": {"type": "boolean", "description": "True if the offset is the same as the baseline."}, "params": [{"type": "boolean", "name": "checkPos", "description": " check the position instead of using cached value"}], "description": "Checks the background position element position. If it has moved from the\nbaseline position, the constraints for the thumb are reset", "guessedname": "verifyOffset", "guessedtype": "function"}, "initThumb": {"params": [{"type": "YAHOO.widget.SliderThumb", "name": "t", "description": " the slider thumb"}], "description": "Initializes the slider's thumb. Executed in the constructor.", "guessedname": "initThumb", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "string representation of the instance"}, "description": "Slider toString", "guessedname": "toString", "guessedtype": "function"}, "moveOneTick": {"guessedname": "moveOneTick", "params": [{"type": "int[]", "name": "the", "description": " destination coordinate"}], "description": "Move the slider one tick mark towards its final coordinate. Used\nfor the animation when tick marks are defined", "private": "", "guessedtype": "function"}, "onChange": {"deprecated": "use instance.subscribe(\"change\") instead", "params": [{"type": "int", "name": "firstOffset", "description": " the number of pixels the thumb has moved\nfrom its start position. Normal horizontal and vertical sliders will only\nhave the firstOffset. Regions will have both, the first is the horizontal\noffset, the second the vertical."}, {"type": "int", "name": "secondOffset", "description": " the y offset for region sliders"}], "description": "Event that fires when the value of the slider has changed", "guessedname": "onChange", "guessedtype": "function"}, "initSlider": {"params": [{"type": "string", "name": "sType", "description": " the type of slider (horiz, vert, region)"}], "description": "Initializes the slider. Executed in the constructor", "guessedname": "initSlider", "guessedtype": "function"}, "setValue": {"return": {"type": "boolean", "description": "true if the move was performed, false if it failed"}, "params": [{"type": "int", "name": "newOffset", "description": " the number of pixels the thumb should be\npositioned away from the initial start point"}, {"type": "boolean", "name": "skipAnim", "description": " set to true to disable the animation\nfor this move action (but not others)."}, {"type": "boolean", "name": "force", "description": " ignore the locked setting and set value anyway"}, {"type": "boolean", "name": "silent", "description": " when true, do not fire events"}], "description": "Provides a way to set the value of the slider in code.", "guessedname": "setValue", "guessedtype": "function"}, "setThumbCenterPoint": {"description": "When the thumb is available, we cache the centerpoint of the element so\nwe can position the element correctly when the background is clicked", "guessedname": "setThumbCenterPoint", "guessedtype": "function"}, "handleThumbChange": {"private": "", "description": "Internal handler for the slider thumb's onChange event", "guessedname": "handleThumbChange", "guessedtype": "function"}, "endMove": {"private": "", "description": "Fired when the slider movement ends", "guessedname": "endMove", "guessedtype": "function"}, "getYValue": {"return": {"type": "int", "description": "the current vertical offset"}, "description": "Returns the slider's thumb Y offset from the start position", "guessedname": "getYValue", "guessedtype": "function"}, "onAvailable": {"description": "Executed when the slider element is available", "guessedname": "onAvailable", "guessedtype": "function"}, "onSlideStart": {"deprecated": "use instance.subscribe(\"slideStart\") instead", "description": "Event that fires when the at the beginning of the slider thumb move", "guessedname": "onSlideStart", "guessedtype": "function"}, "onDrag": {"private": "", "description": "Handles the onDrag event for the slider background", "guessedname": "onDrag", "guessedtype": "function"}, "getThumb": {"return": {"type": "SliderThumb", "description": "this slider's thumb"}, "description": "Returns a reference to this slider's thumb", "guessedname": "getThumb", "guessedtype": "function"}, "YAHOO.widget.Slider.getVertSlider": {"return": {"type": "Slider", "description": "a vertical slider control"}, "description": "Factory method for creating a vertical slider", "static": "", "guessedname": "getVertSlider", "guessedtype": "property", "params": [{"type": "String", "name": "sBGElId", "description": " the id of the slider's background element"}, {"type": "String", "name": "sHandleElId", "description": " the id of the thumb element"}, {"type": "int", "name": "iUp", "description": " the number of pixels the element can move up"}, {"type": "int", "name": "iDown", "description": " the number of pixels the element can move down"}, {"type": "int", "name": "iTickSize", "description": " optional parameter for specifying that the element \nshould move a certain number pixels at a time."}]}, "handleKeyPress": {"params": [{"type": "Event", "name": "e", "description": " the keypress event"}], "description": "Executed when a keypress event happens with the control focused.\nPrevents the default behavior for navigation keys. The actual\nlogic for moving the slider thumb in response to a key event\nhappens in handleKeyDown.", "guessedname": "handleKeyPress", "guessedtype": "function"}, "setStartSliderState": {"description": "Initialization that sets up the value offsets once the elements are ready", "guessedname": "setStartSliderState", "guessedtype": "function"}, "getValue": {"return": {"type": "int", "description": "the current value"}, "description": "Returns the slider's thumb offset from the start position", "guessedname": "getValue", "guessedtype": "function"}, "b4MouseDown": {"private": "", "description": "Resets the constraints before moving the thumb.", "guessedname": "b4MouseDown", "guessedtype": "function"}, "unlock": {"description": "Unlocks the slider, overrides YAHOO.util.DragDrop", "guessedname": "unlock", "guessedtype": "function"}, "YAHOO.widget.Slider.getVertDualSlider": {"return": {"type": "DualSlider", "description": "a vertical dual-thumb slider control"}, "description": "Factory method for creating a vertical dual-thumb slider.", "static": "", "guessedname": "getVertDualSlider", "guessedtype": "property", "params": [{"type": "String", "name": "bg", "description": " the id of the slider's background element"}, {"type": "String", "name": "minthumb", "description": " the id of the min thumb"}, {"type": "String", "name": "maxthumb", "description": " the id of the thumb thumb"}, {"type": "int", "name": "range", "description": " the number of pixels the thumbs can move within"}, {"type": "int", "name": "iTickSize", "description": " (optional) the element should move this many pixels\nat a time"}, {"type": "Array", "name": "initVals", "description": " (optional) [min,max] Initial thumb placement"}]}, "_getNextY": {"private": "", "description": "Returns the next Y tick value based on the current coord and the target coord.", "guessedname": "_getNextY", "guessedtype": "function"}, "_getNextX": {"private": "", "description": "Returns the next X tick value based on the current coord and the target coord.", "guessedname": "_getNextX", "guessedtype": "function"}}}, "YAHOO.util.ImageLoader.bgImgObj": {"name": "YAHOO.util.ImageLoader.bgImgObj", "constructors": [{"params": [{"type": "String", "name": "domId", "description": "\tHTML DOM id of the image element"}, {"type": "String", "name": "url", "description": "\tURL for the image"}], "description": "Background image object. A background image is one whose URL is specified by \"background-image\" in the element's style"}], "namespace": "YAHOO.util", "module": "imageloader", "guessedname": "bgImgObj", "methods": {"_applyUrl": {"guessedname": "_applyUrl", "params": [{"type": "Object", "name": "el", "description": "\tHTML DOM element"}], "description": "Inserts the image URL into the DOM so that the image is displayed.\nSets style.backgroundImage", "private": "", "guessedtype": "function"}}, "extends": "YAHOO.util.ImageLoader.imgObj", "superclass": "YAHOO.util.ImageLoader.imgObj", "file": "ImageLoader.js", "guessedtype": "function", "shortname": "ImageLoader.bgImgObj", "description": "Background image object. A background image is one whose URL is specified by \"background-image\" in the element's style"}, "YAHOO.widget.LayoutUnit": {"name": "YAHOO.widget.LayoutUnit", "configs": {"dataTimeout": {"default": "null", "type": "Number", "description": "Number if milliseconds before aborting and calling failure handler."}, "grids": {"type": "Boolean", "description": "Set this option to true if you want the LayoutUnit to fix the first layer of YUI CSS Grids (margins)"}, "height": {"type": "Number", "description": "The height of the Unit"}, "header": {"description": "The text to use as the Header of the Unit"}, "wrap": {"type": "HTMLElement", "description": "A reference to the wrap element", "private": ""}, "close": {"description": "Adds a close icon to the unit"}, "animate": {"type": "Boolean", "description": "Use animation to collapse\/expand the unit"}, "collapseSize": {"type": "Number", "description": "The pixel size of the Clip that we will collapse to"}, "top": {"type": "Number", "description": "The current top positioning of the Unit", "private": ""}, "minWidth": {"type": "Number", "description": "The minWidth parameter passed to the Resize Utility"}, "width": {"type": "Number", "description": "The width of the Unit"}, "maxWidth": {"type": "Number", "description": "The maxWidth parameter passed to the Resize Utility"}, "body": {"description": "The content for the body. If we find an element in the page with an id that matches the passed option we will move that element into the body of this unit."}, "hover": {"description": "Config option to pass to the Resize Utility"}, "collapse": {"description": "Adds a collapse icon to the unit"}, "parent": {"type": "{Object} YAHOO.widget.Layout", "description": "The parent Layout that we are assigned to"}, "duration": {"description": "The duration to give the Animation Utility when animating the opening and closing of Units"}, "minHeight": {"type": "Number", "description": "The minHeight parameter passed to the Resize Utility"}, "dataSrc": {"type": "String", "description": "The unit data source, used for loading content dynamically."}, "zIndex": {"type": "{Number}", "description": "The CSS zIndex to give to the unit, so you can have overlapping elements such as menus in a unit."}, "proxy": {"type": "Boolean", "description": "Use the proxy config setting for the Resize Utility"}, "position": {"type": "{String}", "description": "The position (top, right, bottom, left or center) of the Unit in the Layout"}, "dataLoaded": {"type": "Boolean", "description": "Whether or not any data has been loaded from the server."}, "resize": {"description": "Should a Resize instance be added to this unit"}, "gutter": {"type": "String", "description": "The gutter that we should apply to the parent Layout around this Unit. Supports standard CSS markup: (2 4 0 5) or (2) or (2 5)"}, "footer": {"description": "The content for the footer. If we find an element in the page with an id that matches the passed option we will move that element into the footer of this unit."}, "useShim": {"description": "Config option to pass to the Resize Utility"}, "loadMethod": {"default": "\"GET\"", "type": "String", "description": "The method to use for the data request."}, "maxHeight": {"type": "Number", "description": "The maxHeight parameter passed to the Resize Utility"}, "easing": {"description": "The Animation Easing to apply to the Animation instance for this unit."}, "scroll": {"type": "Boolean\/Null", "description": "Adds a class to the unit to allow for overflow: auto (yui-layout-scroll), default is overflow: hidden (yui-layout-noscroll). If true scroll bars will be placed on the element when the content exceeds the given area, false will put overflow hidden to hide the content. Passing null will render the content as usual overflow."}, "left": {"type": "Number", "description": "The current left position of the Unit", "private": ""}}, "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The element to make a unit."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "<p>Provides a fixed position unit containing a header, body and footer for use with a YAHOO.widget.Layout instance.<\/p>"}], "namespace": "YAHOO.widget", "module": "layout", "events": {"load": {"type": "YAHOO.util.CustomEvent", "description": "Fired when data is loaded via the dataSrc config."}, "contentChange": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the content in the header, body or footer is changed via the API"}, "proxyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "proxyChange", "description": "Fires when the value for the configuration attribute 'proxy' changes."}, "heightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "heightChange", "description": "Fires when the value for the configuration attribute 'height' changes."}, "beforeGutterChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeGutterChange", "description": "Fires before the value for the configuration attribute 'gutter' changes. Return false to cancel the attribute change."}, "beforeExpand": {"type": "YAHOO.util.CustomEvent", "description": "Fired before the unit is exanded. If you return false, the collapse is cancelled."}, "zIndexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "zIndexChange", "description": "Fires when the value for the configuration attribute 'zIndex' changes."}, "beforeMaxHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMaxHeightChange", "description": "Fires before the value for the configuration attribute 'maxHeight' changes. Return false to cancel the attribute change."}, "beforeLeftChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLeftChange", "description": "Fires before the value for the configuration attribute 'left' changes. Return false to cancel the attribute change."}, "maxWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "maxWidthChange", "description": "Fires when the value for the configuration attribute 'maxWidth' changes."}, "close": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the unit is closed"}, "gridsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "gridsChange", "description": "Fires when the value for the configuration attribute 'grids' changes."}, "beforeDataTimeoutChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataTimeoutChange", "description": "Fires before the value for the configuration attribute 'dataTimeout' changes. Return false to cancel the attribute change."}, "beforeParentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeParentChange", "description": "Fires before the value for the configuration attribute 'parent' changes. Return false to cancel the attribute change."}, "resizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "resizeChange", "description": "Fires when the value for the configuration attribute 'resize' changes."}, "beforeTopChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTopChange", "description": "Fires before the value for the configuration attribute 'top' changes. Return false to cancel the attribute change."}, "beforeHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHeightChange", "description": "Fires before the value for the configuration attribute 'height' changes. Return false to cancel the attribute change."}, "beforeResizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeResizeChange", "description": "Fires before the value for the configuration attribute 'resize' changes. Return false to cancel the attribute change."}, "beforeHeaderChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHeaderChange", "description": "Fires before the value for the configuration attribute 'header' changes. Return false to cancel the attribute change."}, "leftChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "leftChange", "description": "Fires when the value for the configuration attribute 'left' changes."}, "easingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "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."}, "beforeMinWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMinWidthChange", "description": "Fires before the value for the configuration attribute 'minWidth' changes. Return false to cancel the attribute change."}, "scrollChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "scrollChange", "description": "Fires when the value for the configuration attribute 'scroll' changes."}, "beforeDataSrcChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataSrcChange", "description": "Fires before the value for the configuration attribute 'dataSrc' changes. Return false to cancel the attribute change."}, "startResize": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the Resize Utility fires it's startResize Event."}, "collapseSizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "collapseSizeChange", "description": "Fires when the value for the configuration attribute 'collapseSize' changes."}, "beforeGridsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeGridsChange", "description": "Fires before the value for the configuration attribute 'grids' changes. Return false to cancel the attribute change."}, "beforeMinHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMinHeightChange", "description": "Fires before the value for the configuration attribute 'minHeight' changes. Return false to cancel the attribute change."}, "maxHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "maxHeightChange", "description": "Fires when the value for the configuration attribute 'maxHeight' changes."}, "beforeResize": {"type": "YAHOO.util.CustomEvent", "description": "Firef at the beginning of the resize method. If you return false, the resize is cancelled."}, "dataSrcChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataSrcChange", "description": "Fires when the value for the configuration attribute 'dataSrc' changes."}, "beforePositionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePositionChange", "description": "Fires before the value for the configuration attribute 'position' changes. Return false to cancel the attribute change."}, "expand": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the unit is exanded"}, "beforeWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeWidthChange", "description": "Fires before the value for the configuration attribute 'width' changes. Return false to cancel the attribute change."}, "useShimChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "useShimChange", "description": "Fires when the value for the configuration attribute 'useShim' changes."}, "hoverChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hoverChange", "description": "Fires when the value for the configuration attribute 'hover' changes."}, "beforeFooterChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeFooterChange", "description": "Fires before the value for the configuration attribute 'footer' changes. Return false to cancel the attribute change."}, "beforeCollapseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCollapseChange", "description": "Fires before the value for the configuration attribute 'collapse' changes. Return false to cancel the attribute change."}, "minWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "minWidthChange", "description": "Fires when the value for the configuration attribute 'minWidth' changes."}, "beforeScrollChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeScrollChange", "description": "Fires before the value for the configuration attribute 'scroll' changes. Return false to cancel the attribute change."}, "beforeCollapseSizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCollapseSizeChange", "description": "Fires before the value for the configuration attribute 'collapseSize' changes. Return false to cancel the attribute change."}, "bodyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "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."}, "gutterChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "gutterChange", "description": "Fires when the value for the configuration attribute 'gutter' changes."}, "durationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "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."}, "beforeZIndexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeZIndexChange", "description": "Fires before the value for the configuration attribute 'zIndex' changes. Return false to cancel the attribute change."}, "animateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "animateChange", "description": "Fires when the value for the configuration attribute 'animate' changes."}, "beforeDurationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous 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."}, "beforeProxyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeProxyChange", "description": "Fires before the value for the configuration attribute 'proxy' changes. Return false to cancel the attribute change."}, "footerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "footerChange", "description": "Fires when the value for the configuration attribute 'footer' changes."}, "headerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "headerChange", "description": "Fires when the value for the configuration attribute 'header' changes."}, "beforeHoverChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHoverChange", "description": "Fires before the value for the configuration attribute 'hover' changes. Return false to cancel the attribute change."}, "beforeWrapChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeWrapChange", "description": "Fires before the value for the configuration attribute 'wrap' changes. Return false to cancel the attribute change."}, "loadMethodChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "loadMethodChange", "description": "Fires when the value for the configuration attribute 'loadMethod' changes."}, "beforeCloseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCloseChange", "description": "Fires before the value for the configuration attribute 'close' changes. Return false to cancel the attribute change."}, "beforeDataLoadedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataLoadedChange", "description": "Fires before the value for the configuration attribute 'dataLoaded' changes. Return false to cancel the attribute change."}, "resize": {"type": "YAHOO.util.CustomEvent", "description": "Fired when this.resize is called"}, "endResize": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the Resize Utility fires it's endResize Event."}, "positionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "positionChange", "description": "Fires when the value for the configuration attribute 'position' changes."}, "beforeAnimateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeAnimateChange", "description": "Fires before the value for the configuration attribute 'animate' changes. Return false to cancel the attribute change."}, "minHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "minHeightChange", "description": "Fires when the value for the configuration attribute 'minHeight' changes."}, "loadError": {"type": "YAHOO.util.CustomEvent", "description": "Fired when an error occurs loading data via the dataSrc config. Error message is passed as argument to this event."}, "dataLoadedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataLoadedChange", "description": "Fires when the value for the configuration attribute 'dataLoaded' changes."}, "beforeEasingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous 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."}, "beforeMaxWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMaxWidthChange", "description": "Fires before the value for the configuration attribute 'maxWidth' changes. Return false to cancel the attribute change."}, "topChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "topChange", "description": "Fires when the value for the configuration attribute 'top' changes."}, "collapse": {"type": "YAHOO.util.CustomEvent", "description": "Fired when the unit is collapsed"}, "beforeBodyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous 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."}, "beforeLoadMethodChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLoadMethodChange", "description": "Fires before the value for the configuration attribute 'loadMethod' changes. Return false to cancel the attribute change."}, "beforeUseShimChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeUseShimChange", "description": "Fires before the value for the configuration attribute 'useShim' changes. Return false to cancel the attribute change."}, "parentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "parentChange", "description": "Fires when the value for the configuration attribute 'parent' changes."}, "beforeCollapse": {"type": "YAHOO.util.CustomEvent", "description": "Fired before the unit is collapsed. If you return false, the collapse is cancelled."}, "wrapChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "wrapChange", "description": "Fires when the value for the configuration attribute 'wrap' changes."}, "closeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "closeChange", "description": "Fires when the value for the configuration attribute 'close' changes."}, "dataTimeoutChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataTimeoutChange", "description": "Fires when the value for the configuration attribute 'dataTimeout' changes."}, "collapseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "collapseChange", "description": "Fires when the value for the configuration attribute 'collapse' changes."}, "widthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "widthChange", "description": "Fires when the value for the configuration attribute 'width' changes."}}, "guessedname": "LayoutUnit", "methods": {"_getBoxSize": {"return": {"type": "Array", "description": "An array of height and width"}, "description": "Get's the elements clientHeight and clientWidth plus the size of the borders", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The HTMLElement to get the size of"}], "guessedname": "_getBoxSize", "guessedtype": "function"}, "toggle": {"return": {"type": "<a href=\"YAHOO.widget.LayoutUnit.html\">YAHOO.widget.LayoutUnit<\/a>", "description": "The LayoutUnit instance"}, "description": "Toggles the Unit, replacing it with a clipped version.", "guessedname": "toggle", "guessedtype": "function"}, "init": {"description": "The initalization method inherited from Element.", "private": "", "guessedname": "init", "guessedtype": "function"}, "_getBorderSizes": {"return": {"type": "Array", "description": "An array of the top, right, bottom, left borders."}, "description": "Get the CSS border size of the element passed.", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The element to get the border size of"}], "guessedname": "_getBorderSizes", "guessedtype": "function"}, "_setHeight": {"return": {"type": "Number", "description": "The new height, fixed for borders and IE QuirksMode"}, "description": "Sets the height of the element based on the border size of the element.", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The HTMLElement to have it's height set"}, {"type": "Number", "name": "h", "description": " The height that you want it the element set to"}], "guessedname": "_setHeight", "guessedtype": "function"}, "_setWidth": {"return": {"type": "Number", "description": "The new width, fixed for borders and IE QuirksMode"}, "description": "Sets the width of the element based on the border size of the element.", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The HTMLElement to have it's width set"}, {"type": "Number", "name": "w", "description": " The width that you want it the element set to"}], "guessedname": "_setWidth", "guessedtype": "function"}, "_toggleClip": {"description": "Toggle th current state of the Clip element and set it's height, width and position", "private": "", "guessedname": "_toggleClip", "guessedtype": "function"}, "getLayoutUnitById": {"static": "", "return": {"type": "Object", "description": "The Layout Object"}, "description": "Get's a layout unit object by the HTML id of the element associated with the Layout Unit object.", "guessedname": "getLayoutUnitById", "guessedtype": "function"}, "_fixQuirks": {"return": {"type": "Number", "description": "The fixed dimension"}, "description": "Fixes the box calculations for IE in QuirksMode", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The HTMLElement to set the dimension on"}, {"type": "Number", "name": "dim", "description": " The number of the dimension to fix"}, {"type": "String", "name": "side", "description": " The dimension (h or w) to fix. Defaults to h"}], "guessedname": "_fixQuirks", "guessedtype": "function"}, "loadContent": {"return": {"type": "object", "description": "YUI Connection Manager handler"}, "description": "Loading the content of the unit using the connection manager", "guessedname": "loadContent", "guessedtype": "function"}, "_createClip": {"description": "Create the clip element used when the Unit is collapsed", "private": "", "guessedname": "_createClip", "guessedtype": "function"}, "initAttributes": {"description": "Processes the config", "private": "", "guessedname": "initAttributes", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the LayoutUnit.", "guessedname": "toString", "guessedtype": "function"}, "getSizes": {"return": {"type": "Object", "description": "An object of the sizes used for calculations"}, "description": "Get a reference to the internal sizes object for this unit", "guessedname": "getSizes", "guessedtype": "function"}, "_cleanGrids": {"description": "This method attempts to clean up the first level of the YUI CSS Grids, YAHOO.util.Selector is required for this operation.", "private": "", "guessedname": "_cleanGrids", "guessedtype": "function"}, "destroy": {"return": {"type": "<a href=\"YAHOO.widget.Layout.html\">YAHOO.widget.Layout<\/a>", "description": "The parent Layout instance"}, "params": [{"type": "Boolean", "name": "force", "description": " Don't report to the parent, because we are being called from the parent."}], "description": "Removes this unit from the parent and cleans up after itself.", "guessedname": "destroy", "guessedtype": "function"}, "expand": {"return": {"type": "<a href=\"YAHOO.widget.LayoutUnit.html\">YAHOO.widget.LayoutUnit<\/a>", "description": "The LayoutUnit instance"}, "description": "Expand the Unit if it is collapsed.", "guessedname": "expand", "guessedtype": "function"}, "close": {"return": {"type": "<a href=\"YAHOO.widget.Layout.html\">YAHOO.widget.Layout<\/a>", "description": "The parent Layout instance"}, "description": "Close the unit, removing it from the parent Layout.", "guessedname": "close", "guessedtype": "function"}, "_createHeader": {"guessedname": "_createHeader", "return": {"type": "HTMLElement", "description": "The new HTMLElement"}, "description": "Creates the HTMLElement for the header", "private": "", "guessedtype": "function"}, "resize": {"return": {"type": "<a href=\"YAHOO.widget.LayoutUnit.html\">YAHOO.widget.LayoutUnit<\/a>", "description": "The LayoutUnit instance"}, "params": [{"type": "Boolean", "name": "force", "description": " This will force full calculations even when the unit is collapsed"}], "description": "Resize either the unit or it's clipped state, also updating the box inside", "guessedname": "resize", "guessedtype": "function"}, "collapse": {"return": {"type": "<a href=\"YAHOO.widget.LayoutUnit.html\">YAHOO.widget.LayoutUnit<\/a>", "description": "The LayoutUnit instance"}, "description": "Collapse the Unit if it is not collapsed.", "guessedname": "collapse", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "layoutunit.js", "guessedtype": "function", "shortname": "LayoutUnit", "properties": {"_lastWidth": {"guessedname": "_lastWidth", "type": "Number", "description": "A holder for the last known width of the unit", "private": "", "guessedtype": "property"}, "LOADING_CLASSNAME": {"default": "\"disabled\"", "type": "String", "description": "The class name applied to dynamic tabs while loading.", "guessedname": "LOADING_CLASSNAME", "guessedtype": "property"}, "header": {"type": "HTMLELement", "description": "A reference to the HTML element used for the Header", "guessedname": "header", "guessedtype": "property"}, "_anim": {"guessedname": "_anim", "type": "YAHOO.util.Anim", "description": "A reference to the Animation instance used by this LayouUnit", "private": "", "guessedtype": "property"}, "STR_COLLAPSE": {"type": "{String}", "description": "String used for collapse button title", "guessedname": "STR_COLLAPSE", "guessedtype": "property"}, "_collapsed": {"guessedname": "_collapsed", "type": "Boolean", "description": "Flag to determine if the unit is collapsed or not.", "private": "", "guessedtype": "property"}, "_lastScroll": {"guessedname": "_lastScroll", "type": "Boolean", "description": "A holder for the last known scroll state of the unit", "private": "", "guessedtype": "property"}, "_lastLeft": {"guessedname": "_lastLeft", "type": "Number", "description": "A holder for the last known left of the unit", "private": "", "guessedtype": "property"}, "_instances": {"description": "Internal hash table for all layout unit instances", "private": "", "static": "", "guessedname": "_instances", "guessedtype": "property", "type": "Object"}, "_lastHeight": {"guessedname": "_lastHeight", "type": "Number", "description": "A holder for the last known height of the unit", "private": "", "guessedtype": "property"}, "_loading": {"guessedname": "_loading", "type": "Number", "description": "During the loading process this variable will be true", "private": "", "guessedtype": "property"}, "body": {"type": "HTMLElement", "description": "A reference to the HTML element used for the body", "guessedname": "body", "guessedtype": "property"}, "_lastCenetrScroll": {"guessedname": "_lastCenterScroll", "type": "Boolean", "description": "A holder for the last known scroll state of the center unit", "private": "", "guessedtype": "property"}, "_resize": {"guessedname": "_resize", "type": "YAHOO.util.Resize", "description": "A reference to the Resize instance used by this LayoutUnit", "private": "", "guessedtype": "property"}, "_sizes": {"guessedname": "_sizes", "type": "Object", "description": "A collection of the current sizes of the contents of this Layout Unit", "private": "", "guessedtype": "property"}, "STR_CLOSE": {"type": "{String}", "description": "String used for close button title", "guessedname": "STR_CLOSE", "guessedtype": "property"}, "_lastTop": {"guessedname": "_lastTop", "type": "Number", "description": "A holder for the last known top of the unit", "private": "", "guessedtype": "property"}, "loadHandler": {"type": "Object", "description": "Callback method for the YUI Connection Manager used for load the body using AJAX", "guessedname": "loadHandler", "guessedtype": "property"}, "_collapsing": {"guessedname": "_collapsing", "type": "Boolean", "description": "A flag set while the unit is being collapsed, used so we don't fire events while animating the size", "private": "", "guessedtype": "property"}, "footer": {"type": "HTMLElement", "description": "A reference to the HTML element used for the footer", "guessedname": "footer", "guessedtype": "property"}, "_gutter": {"guessedname": "_gutter", "type": "Object", "description": "A simple hash table used to store the gutter to apply to the Unit", "private": "", "guessedtype": "property"}, "_lastScrollTop": {"guessedname": "_lastScrollTop", "type": "Number", "description": "A holder for the last known scrollTop state of the unit", "private": "", "guessedtype": "property"}, "STR_EXPAND": {"type": "{String}", "description": "String used for expand button title", "guessedname": "STR_EXPAND", "guessedtype": "property"}, "_clip": {"guessedname": "_clip", "type": "HTMLElement", "description": "A reference to the clip element used when collapsing the unit", "private": "", "guessedtype": "property"}, "dataConnection": {"type": "Object", "description": "YUI Connection Manager handler", "guessedname": "dataConnection", "guessedtype": "property"}, "browser": {"type": "Object", "description": "A modified version of the YAHOO.env.ua object", "guessedname": "browser", "guessedtype": "property"}}, "description": "<p>Provides a fixed position unit containing a header, body and footer for use with a YAHOO.widget.Layout instance.<\/p>"}, "YAHOO.widget.NumericAxis": {"name": "YAHOO.widget.NumericAxis", "constructors": [{"description": "A type of axis whose units are measured in numeric values."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "NumericAxis", "file": "NumericAxis.js", "guessedtype": "function", "shortname": "NumericAxis", "properties": {"scale": {"type": "String", "description": "The scaling algorithm to use on this axis. May be \"linear\" or \"logarithmic\".", "guessedname": "scale", "guessedtype": "property"}, "stackingEnabled": {"type": "Boolean", "description": "Series that are stackable will only stack when this value is set to true.", "guessedname": "stackingEnabled", "guessedtype": "property"}, "maximum": {"type": "Number", "description": "The maximum value drawn by the axis. If not set explicitly, the axis maximum\nwill be calculated automatically.", "guessedname": "maximum", "guessedtype": "property"}, "minorUnit": {"type": "Number", "description": "The spacing between minor intervals on this axis.", "guessedname": "minorUnit", "guessedtype": "property"}, "minimum": {"type": "Number", "description": "The minimum value drawn by the axis. If not set explicitly, the axis minimum\nwill be calculated automatically.", "guessedname": "minimum", "guessedtype": "property"}, "majorUnit": {"type": "Number", "description": "The spacing between major intervals on this axis.", "guessedname": "majorUnit", "guessedtype": "property"}, "snapToUnits": {"type": "Boolean", "description": "If true, the labels, ticks, gridlines, and other objects will snap to\nthe nearest major or minor unit. If false, their position will be based\non the minimum value.", "guessedname": "snapToUnits", "guessedtype": "property"}, "alwaysShowZero": {"type": "Boolean", "description": "If true, and the bounds are calculated automatically, either the minimum or\nmaximum will be set to zero.", "guessedname": "alwaysShowZero", "guessedtype": "property"}}, "description": "A type of axis whose units are measured in numeric values."}, "YAHOO.widget.Uploader": {"name": "YAHOO.widget.Uploader", "constructors": [{"params": [{"type": "HTMLElement", "name": "containerId", "description": " Container element for the Flash Player instance."}], "description": "Uploader class for the YUI Uploader component."}], "namespace": "YAHOO.widget", "module": "uploader", "properties": {"Chart.SWFURL": {"description": "Location of the Uploader SWF", "default": "\"assets\/uploader.swf\"", "private": "", "static": "", "guessedname": "SWFURL", "guessedtype": "property", "final": ""}}, "guessedname": "Uploader", "methods": {"uploadAll": {"params": [{"type": "String", "name": "uploadScriptPath", "description": " The URL of the upload location."}, {"type": "String", "name": "method", "description": " Either \"GET\" or \"POST\", specifying how the variables accompanying the file upload POST request should be submitted. \"GET\" by default."}, {"type": "Object", "name": "vars", "description": " The object containing variables to be sent in the same request as the file upload."}, {"type": "String", "name": "fieldName", "description": " The name of the variable in the POST request containing the file data. \"Filedata\" by default."}, {"type": "Object", "name": "headers", "description": " An object containing variables that should be set as headers in the POST request. The following header names\ncannot be used: \n<code>\nAccept-Charset, Accept-Encoding, Accept-Ranges, Age, Allow, Allowed, Authorization, Charge-To, Connect, Connection, \nContent-Length, Content-Location, Content-Range, Cookie, Date, Delete, ETag, Expect, Get, Head, Host, Keep-Alive, \nLast-Modified, Location, Max-Forwards, Options, Post, Proxy-Authenticate, Proxy-Authorization, Proxy-Connection, \nPublic, Put, Range, Referer, Request-Range, Retry-After, Server, TE, Trace, Trailer, Transfer-Encoding, Upgrade, \nURI, User-Agent, Vary, Via, Warning, WWW-Authenticate, x-flash-version.\n<\/code>"}], "description": "Starts uploading all files in the queue. If this function is called, the upload queue is automatically managed.", "guessedname": "uploadAll", "guessedtype": "function"}, "setAllowLogging": {"params": [{"type": "Boolean", "name": "allowLogging", "description": " If true, logs are output; otherwise, no logs are produced."}], "description": "Turns the logging functionality on.\nUses Flash internal trace logging, as well as YUI Logger, if available.", "guessedname": "setAllowLogging", "guessedtype": "function"}, "clearFileList": {"description": "Clears the list of files queued for upload.", "guessedname": "clearFileList", "guessedtype": "function"}, "upload": {"params": [{"type": "String", "name": "fileID", "description": " The id of the file to start uploading."}, {"type": "String", "name": "uploadScriptPath", "description": " The URL of the upload location."}, {"type": "String", "name": "method", "description": " Either \"GET\" or \"POST\", specifying how the variables accompanying the file upload POST request should be submitted. \"GET\" by default."}, {"type": "Object", "name": "vars", "description": " The object containing variables to be sent in the same request as the file upload."}, {"type": "String", "name": "fieldName", "description": " The name of the variable in the POST request containing the file data. \"Filedata\" by default."}, {"type": "Object", "name": "headers", "description": " An object containing variables that should be set as headers in the POST request. The following header names\ncannot be used: \n<code>\nAccept-Charset, Accept-Encoding, Accept-Ranges, Age, Allow, Allowed, Authorization, Charge-To, Connect, Connection, \nContent-Length, Content-Location, Content-Range, Cookie, Date, Delete, ETag, Expect, Get, Head, Host, Keep-Alive, \nLast-Modified, Location, Max-Forwards, Options, Post, Proxy-Authenticate, Proxy-Authorization, Proxy-Connection, \nPublic, Put, Range, Referer, Request-Range, Retry-After, Server, TE, Trace, Trailer, Transfer-Encoding, Upgrade, \nURI, User-Agent, Vary, Via, Warning, WWW-Authenticate, x-flash-version.\n<\/code>"}], "description": "Starts the upload of the file specified by fileID to the location specified by uploadScriptPath.", "guessedname": "upload", "guessedtype": "function"}, "removeFile": {"params": [{"type": "String", "name": "fileID", "description": " The id of the file to remove from the upload queue."}], "description": "Removes the specified file from the upload queue.", "guessedname": "removeFile", "guessedtype": "function"}, "setSimUploadLimit": {"params": [{"type": "int", "name": "simUploadLimit", "description": " Number of simultaneous uploads, between 1 and 5."}], "description": "Sets the number of simultaneous uploads when using uploadAll()\nThe minimum value is 1, and maximum value is 5. The default value is 2.", "guessedname": "setSimUploadLimit", "guessedtype": "function"}, "setAllowMultipleFiles": {"params": [{"type": "Boolean", "name": "allowMultipleFiles", "description": " If true, multiple files can be selected. False by default."}], "description": "Sets the flag allowing users to select multiple files for the upload.", "guessedname": "setAllowMultipleFiles", "guessedtype": "function"}, "cancel": {"params": [{"type": "String", "name": "fileID", "description": " The ID of the file whose upload should be cancelled."}], "description": "Cancels the upload of a specified file. If no file id is specified, all ongoing uploads are cancelled.", "guessedname": "cancel", "guessedtype": "function"}, "setFileFilters": {"params": [{"type": "extensions: extensionString, description: descriptionString, [optional]macType: macTypeString", "name": "newFilterArray", "description": " An array of sets of key-value pairs of the form\n\nThe extensions string is a semicolon-delimited list of elements of the form \"*.xxx\", \ne.g. \"*.jpg;*.gif;*.png\"."}], "description": "Sets the file filters for the \"Browse\" dialog.", "guessedname": "setFileFilters", "guessedtype": "function"}}, "uses": ["YAHOO.widget.FlashAdapter"], "file": "Uploader.js", "guessedtype": "function", "shortname": "Uploader", "events": {"uploadProgress": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "String", "name": "event.id", "description": " The id of the file with which the upload progress data is associated"}, {"type": "Number", "name": "bytesLoaded", "description": " The number of bytes of the file uploaded so far"}, {"type": "Number", "name": "bytesTotal", "description": " The total size of the file"}], "description": "Fires when new information about the upload progress for a specific file is available."}, "uploadCompleteData": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "String", "name": "event.id", "description": " The id of the file for which the upload has been completed."}, {"type": "String", "name": "event.data", "description": " The raw data returned by the server in response to the upload."}], "description": "Fires when the server sends data in response to a completed upload."}, "uploadStart": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}], "description": "Fires when an upload of a specific file has started.", "param": "event.type {String} The event type"}, "fileSelect": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Array", "name": "event.fileList", "description": " An array of objects with file information"}, {"type": "Number", "name": "event.fileList[].size", "description": " File size in bytes for a specific file in fileList"}, {"type": "Date", "name": "event.fileList[].cDate", "description": " Creation date for a specific file in fileList"}, {"type": "Date", "name": "event.fileList[].mDate", "description": " Modification date for a specific file in fileList"}, {"type": "String", "name": "event.fileList[].name", "description": " File name for a specific file in fileList"}, {"type": "String", "name": "event.fileList[].id", "description": " Unique file id of a specific file in fileList"}], "description": "Fires when the user has finished selecting files in the \"Open File\" dialog."}, "uploadComplete": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "String", "name": "event.id", "description": " The id of the file for which the upload has been completed."}], "description": "Fires when an upload for a specific file is complete."}, "rollOut": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}], "description": "Fires when an upload of a specific file has started."}, "uploadCancel": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "String", "name": "event.id", "description": " The id of the file with which the upload has been cancelled."}], "description": "Fires when an upload for a specific file is cancelled."}, "rollOver": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}], "description": "Fires when an upload of a specific file has started."}, "uploadError": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "String", "name": "event.id", "description": " The id of the file that was being uploaded when the error has occurred."}, {"type": "String", "name": "event.status", "description": " The status message associated with the error."}], "description": "Fires when an upload error occurs."}}, "description": "Uploader class for the YUI Uploader component."}, "YAHOO.util.ShouldError": {"name": "YAHOO.util.ShouldError", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "ShouldError is subclass of AssertionError that is thrown whenever\na test is expected to throw an error but doesn't."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "ShouldError", "extends": "YAHOO.util.AssertionError", "superclass": "YAHOO.util.AssertionError", "file": "Assert.js", "guessedtype": "function", "shortname": "ShouldError", "properties": {"name": {"type": "String", "description": "The name of the error that occurred."}}, "description": "ShouldError is subclass of AssertionError that is thrown whenever\na test is expected to throw an error but doesn't."}, "YAHOO.util.ComparisonFailure": {"name": "YAHOO.util.ComparisonFailure", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}, {"type": "Object", "name": "expected", "description": " The expected value."}, {"type": "Object", "name": "actual", "description": " The actual value that caused the assertion to fail."}], "description": "ComparisonFailure is subclass of AssertionError that is thrown whenever\na comparison between two values fails. It provides mechanisms to retrieve\nboth the expected and actual value."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "ComparisonFailure", "methods": {"toString": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. This message\nprovides information about the expected and actual values.", "guessedname": "getMessage", "guessedtype": "function"}}, "extends": "YAHOO.util.AssertionError", "superclass": "YAHOO.util.AssertionError", "file": "Assert.js", "guessedtype": "function", "shortname": "ComparisonFailure", "properties": {"expected": {"type": "Object", "description": "The expected value."}, "actual": {"type": "Object", "description": "The actual value."}, "name": {"type": "String", "description": "The name of the error that occurred."}}, "description": "ComparisonFailure is subclass of AssertionError that is thrown whenever\na comparison between two values fails. It provides mechanisms to retrieve\nboth the expected and actual value."}, "YAHOO.widget.ContextMenu": {"name": "YAHOO.widget.ContextMenu", "configs": {"trigger": {"default": "null", "type": "String|<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>|Array", "description": "The HTML element(s) whose \"contextmenu\" event (\"mousedown\" \nfor Opera) trigger the display of the context menu. Can be a string \nrepresenting the id attribute of the HTML element, an object reference \nfor the HTML element, or an array of strings or HTML element references."}}, "constructors": [{"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the context menu."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source for the \ncontext menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-\nhtml.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object specifying the \n<code><div><\/code> element of the context menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-\nhtml.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " Object specifying \nthe <code><select><\/code> element to be used as the data source for \nthe context menu."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the context menu. See configuration class documentation \nfor more details."}], "description": "Creates a list of options or commands which are made visible in response to \nan HTML element's \"contextmenu\" event (\"mousedown\" for Opera)."}], "namespace": "YAHOO.widget", "module": "menu", "events": {"triggerContextMenuEvent": {"description": "Custom Event wrapper for the \"contextmenu\" DOM event \n(\"mousedown\" for Opera) fired by the element(s) that trigger the display of \nthe context menu.", "guessedname": "triggerContextMenuEvent", "guessedtype": "property"}}, "guessedname": "ContextMenu", "methods": {"initEvents": {"description": "Initializes the custom events for the context menu.", "guessedname": "initEvents", "guessedtype": "function"}, "_onTriggerClick": {"guessedname": "_onTriggerClick", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed back \nby the event utility (YAHOO.util.Event)."}, {"type": "YAHOO.widget.ContextMenu", "name": "p_oMenu", "description": " Object representing the context \nmenu that is handling the event."}], "description": "\"click\" event handler for the HTML element(s) identified as the \n\"trigger\" for the context menu. Used to cancel default behaviors in Opera.", "private": "", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the context menu."}, {"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><select><\/code> element to be used as the data source for \nthe context menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-\nhtml.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object specifying the \n<code><div><\/code> element of the context menu."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-\nhtml.html#ID-94282980\">HTMLSelectElement<\/a>", "name": "p_oElement", "description": " Object specifying \nthe <code><select><\/code> element to be used as the data source for \nthe context menu."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the context menu. See configuration class documentation \nfor more details."}], "description": "The ContextMenu class's initialization method. This method is \nautomatically called by the constructor, and sets up all DOM references for \npre-existing markup, and creates required markup if it is not already present.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the context menu.", "guessedname": "toString", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be \nchanged using the context menu's Config object (\"cfg\").", "guessedname": "initDefaultConfig", "guessedtype": "function"}, "destroy": {"description": "Removes the context menu's <code><div><\/code> element \n(and accompanying child nodes) from the document.", "guessedname": "destroy", "guessedtype": "function"}, "cancel": {"description": "Cancels the display of the context menu.", "guessedname": "cancel", "guessedtype": "function"}, "position": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "Array", "name": "p_aPos", "description": " Array representing the xy position for the context menu."}], "description": "\"beforeShow\" event handler used to position the contextmenu.", "private": ""}, "_onTriggerContextMenu": {"guessedname": "_onTriggerContextMenu", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed back \nby the event utility (YAHOO.util.Event)."}, {"type": "YAHOO.widget.ContextMenu", "name": "p_oMenu", "description": " Object representing the context \nmenu that is handling the event."}], "description": "\"contextmenu\" event handler (\"mousedown\" for Opera) for the HTML \nelement(s) that trigger the display of the context menu.", "private": "", "guessedtype": "function"}, "_removeEventHandlers": {"description": "Removes all of the DOM event handlers from the HTML element(s) \nwhose \"context menu\" event (\"click\" for Opera) trigger the display of \nthe context menu.", "private": "", "guessedname": "_removeEventHandlers", "guessedtype": "function"}, "configTrigger": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.ContextMenu", "name": "p_oMenu", "description": " Object representing the context \nmenu that fired the event."}], "description": "Event handler for when the value of the \"trigger\" configuration \nproperty changes.", "guessedname": "configTrigger", "guessedtype": "function"}}, "extends": "YAHOO.widget.Menu", "superclass": "YAHOO.widget.Menu", "file": "contextmenu.js", "guessedtype": "function", "shortname": "ContextMenu", "properties": {"_oTrigger": {"description": "Object reference to the current value of the \"trigger\" \nconfiguration property.", "default": "null", "private": "", "guessedname": "_oTrigger", "guessedtype": "property", "type": "String|<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/leve\nl-one-html.html#ID-58190037\">HTMLElement<\/a>|Array"}, "contextEventTarget": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-\nhtml.html#ID-58190037\">HTMLElement<\/a>", "description": "Object reference for the HTML element that was the target of the\n\"contextmenu\" DOM event (\"mousedown\" for Opera) that triggered the display of \nthe context menu.", "guessedname": "contextEventTarget", "guessedtype": "property"}, "EVENT_TYPES": {"description": "Constant representing the name of the ContextMenu's events", "private": "", "guessedname": "EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "DEFAULT_CONFIG": {"description": "Constant representing the ContextMenu's configuration properties", "private": "", "guessedname": "TRIGGER_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "_bCancelled": {"description": "Boolean indicating if the display of the context menu should \nbe cancelled.", "default": "false", "private": "", "guessedname": "_bCancelled", "guessedtype": "property", "type": "Boolean"}}, "description": "Creates a list of options or commands which are made visible in response to \nan HTML element's \"contextmenu\" event (\"mousedown\" for Opera)."}, "YAHOO.widget.TVAnim": {"name": "YAHOO.widget.TVAnim", "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "TVAnim", "methods": {"isValid": {"return": {"type": "boolean", "description": "true if valid, false if not"}, "description": "Returns true if the specified animation class is available", "static": "", "guessedname": "isValid", "guessedtype": "function", "params": [{"type": "string", "name": "type", "description": " the type of animation"}]}, "getAnim": {"return": {"type": "YAHOO.util.Animation", "description": "the animation instance"}, "description": "Returns a ygAnim instance of the given type", "static": "", "guessedname": "getAnim", "guessedtype": "function", "params": [{"type": "string", "name": "type", "description": " the type of animation"}, {"type": "HTMLElement", "name": "el", "description": " the element to element (probably the children div)"}, {"type": "function", "name": "callback", "description": " function to invoke when the animation is done."}]}}, "static": "", "file": "TVAnim.js", "guessedtype": "function", "shortname": "TVAnim", "properties": {"FADE_OUT": {"type": "string", "static": "", "description": "Constant for the fade out animation", "guessedname": "FADE_OUT", "guessedtype": "property"}, "FADE_IN": {"type": "string", "static": "", "description": "Constant for the fade in animation", "guessedname": "FADE_IN", "guessedtype": "property"}}, "description": "A static factory class for tree view expand\/collapse animations"}, "YAHOO.util.Easing": {"name": "YAHOO.util.Easing", "namespace": "YAHOO.util", "module": "animation", "guessedname": "Easing", "methods": {"easeIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and accelerates towards end. (quadratic)", "guessedname": "easeIn", "guessedtype": "function"}, "easeInStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and accelerates towards end. (quartic)", "guessedname": "easeInStrong", "guessedtype": "function"}, "bounceBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounces off start and end.", "guessedname": "bounceBoth", "guessedtype": "function"}, "backOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Overshoots end, then reverses and comes back to end.", "guessedname": "backOut", "guessedtype": "function"}, "elasticBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap both elastic effect.", "guessedname": "elasticBoth", "guessedtype": "function"}, "elasticOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap out elastic effect.", "guessedname": "elasticOut", "guessedtype": "function"}, "bounceOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounces off end.", "guessedname": "bounceOut", "guessedtype": "function"}, "backBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Backtracks slightly, then reverses direction, overshoots end, \nthen reverses and comes back to end.", "guessedname": "backBoth", "guessedtype": "function"}, "easeBoth": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and decelerates towards end. (quadratic)", "guessedname": "easeBoth", "guessedtype": "function"}, "bounceIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Bounce off of start.", "guessedname": "bounceIn", "guessedtype": "function"}, "easeOutStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins quickly and decelerates towards end. (quartic)", "guessedname": "easeOutStrong", "guessedtype": "function"}, "easeNone": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Uniform speed between points.", "guessedname": "easeNone", "guessedtype": "function"}, "elasticIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "a", "description": " Amplitude (optional)"}, {"type": "Number", "name": "p", "description": " Period (optional)"}], "description": "Snap in elastic effect.", "guessedname": "elasticIn", "guessedtype": "function"}, "easeBothStrong": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins slowly and decelerates towards end. (quartic)", "guessedname": "easeBothStrong", "guessedtype": "function"}, "easeOut": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}], "description": "Begins quickly and decelerates towards end. (quadratic)", "guessedname": "easeOut", "guessedtype": "function"}, "backIn": {"return": {"type": "Number", "description": "The computed value for the current animation frame"}, "params": [{"type": "Number", "name": "t", "description": " Time value used to compute current value"}, {"type": "Number", "name": "b", "description": " Starting value"}, {"type": "Number", "name": "c", "description": " Delta between start and end values"}, {"type": "Number", "name": "d", "description": " Total length of animation"}, {"type": "Number", "name": "s", "description": " Overshoot (optional)"}], "description": "Backtracks slightly, then reverses direction and moves to end.", "guessedname": "backIn", "guessedtype": "function"}}, "file": "Easing.js", "guessedtype": "property", "shortname": "Easing", "description": "Singleton that determines how an animation proceeds from start to end."}, "YAHOO.util.DragDropMgr": {"name": "YAHOO.util.DragDropMgr", "namespace": "YAHOO.util", "module": "dragdrop", "guessedname": "DragDropMgr", "methods": {"removeDDFromGroup": {"guessedname": "removeDDFromGroup", "static": "", "description": "Removes the supplied dd instance from the supplied group. Executed\nby DragDrop.removeFromGroup, so don't call this function directly.", "private": "", "guessedtype": "function"}, "startDrag": {"static": "", "params": [{"type": "int", "name": "x", "description": " the X position of the original mousedown"}, {"type": "int", "name": "y", "description": " the Y position of the original mousedown"}], "description": "Fired when either the drag pixel threshold or the mousedown hold \ntime threshold has been met.", "guessedname": "startDrag", "guessedtype": "function"}, "getDDById": {"return": {"type": "DragDrop", "description": "the drag drop object, null if it is not found"}, "description": "Returns the DragDrop instance for a given id", "static": "", "guessedname": "getDDById", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the id of the DragDrop object"}]}, "unregAll": {"guessedname": "unregAll", "static": "", "description": "Cleans up the drag and drop events and objects.", "private": "", "guessedtype": "function"}, "getScrollTop": {"static": "", "return": {"type": "int", "description": "the document's scrollTop"}, "description": "Gets the scrollTop", "guessedname": "getScrollTop", "guessedtype": "function"}, "lock": {"static": "", "description": "Lock all drag and drop functionality", "guessedname": "lock", "guessedtype": "function"}, "getPosX": {"return": {"type": "int", "description": "the X coordinate"}, "description": "Returns the X position of an html element", "deprecated": "use YAHOO.util.Dom.getX instead", "static": "", "guessedname": "getPosX", "guessedtype": "function", "params": [{"type": "", "name": "el", "description": " the element for which to get the position"}]}, "getClientWidth": {"return": {"type": "int", "description": "client width in px"}, "description": "Gets the client width", "deprecated": "use YAHOO.util.Dom.getViewportWidth instead", "static": "", "guessedname": "getClientWidth", "guessedtype": "function"}, "unlock": {"static": "", "description": "Unlock all drag and drop functionality", "guessedname": "unlock", "guessedtype": "function"}, "stopDrag": {"static": "", "params": [{"type": "Event", "name": "e", "description": " the mouseup event, another event (or a fake event) \nwith pageX and pageY defined, or nothing if the \nsilent parameter is true"}, {"type": "boolean", "name": "silent", "description": " skips the enddrag and mouseup events if true"}], "description": "Ends the current drag, cleans up the state, and fires the endDrag\nand mouseUp events. Called internally when a mouseup is detected\nduring the drag. Can be fired manually during the drag by passing\neither another event (such as the mousemove event received in onDrag)\nor a fake event with pageX and pageY defined (so that endDrag and\nonMouseUp have usable position data.). Alternatively, pass true\nfor the silent parameter so that the endDrag and onMouseUp events\nare skipped (so no event data is needed.)", "guessedname": "stopDrag", "guessedtype": "function"}, "_deactivateShim": {"guessedname": "_deactivateShim", "static": "", "description": "This method will hide the shim element and set the _shimActive property to false", "private": "", "guessedtype": "function"}, "_onResize": {"guessedname": "_onResize", "static": "", "description": "Reset constraints on all drag and drop objs", "private": "", "guessedtype": "function"}, "_onLoad": {"guessedname": "_onLoad", "static": "", "description": "Drag and drop initialization. Sets up the global event handlers", "private": "", "guessedtype": "function"}, "fireEvents": {"description": "Iterates over all of the DragDrop elements to find ones we are \nhovering over or dropping on", "private": "", "static": "", "guessedname": "fireEvents", "guessedtype": "function", "params": [{"type": "Event", "name": "e", "description": " the event"}, {"type": "boolean", "name": "isDrop", "description": " is this a drop op or a mouseover op?"}]}, "handleMouseDown": {"description": "Fired after a registered DragDrop object gets the mousedown event.\nSets up the events required to track the object being dragged", "private": "", "static": "", "guessedname": "handleMouseDown", "guessedtype": "function", "params": [{"type": "Event", "name": "e", "description": " the event"}, {"type": "", "name": "oDD", "description": " the DragDrop object being dragged"}]}, "regDragDrop": {"static": "", "params": [{"type": "DragDrop", "name": "oDD", "description": " the DragDrop object to register"}, {"type": "String", "name": "sGroup", "description": " the name of the group this element belongs to"}], "description": "Each DragDrop instance must be registered with the DragDropMgr. \nThis is executed in DragDrop.init()", "guessedname": "regDragDrop", "guessedtype": "function"}, "handleMouseMove": {"description": "Internal function to handle the mousemove event. Will be invoked \nfrom the context of the html element.", "private": "", "static": "", "guessedname": "handleMouseMove", "guessedtype": "function", "params": [{"type": "Event", "name": "e", "description": " the event"}], "todo": "figure out what we can do about mouse events lost when the \nuser drags objects beyond the window boundary. Currently we can \ndetect this in internet explorer by verifying that the mouse is \ndown during the mousemove event. Firefox doesn't give us the \nbutton state on the mousemove event."}, "getElement": {"return": {"type": "Object", "description": "The element"}, "description": "Returns the actual DOM element", "deprecated": "use YAHOO.util.Dom.get instead", "static": "", "guessedname": "getElement", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the id of the elment to get"}]}, "init": {"guessedname": "init", "static": "", "description": "Called the first time an element is registered.", "private": "", "guessedtype": "function"}, "_execOnAll": {"guessedname": "_execOnAll", "static": "", "description": "Runs method on all drag and drop objects", "private": "", "guessedtype": "function"}, "getCss": {"return": {"type": "Object", "description": "The style property of the element"}, "description": "Returns the style property for the DOM element (i.e., \ndocument.getElById(id).style)", "deprecated": "use YAHOO.util.Dom instead", "static": "", "guessedname": "getCss", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the id of the elment to get"}]}, "_remove": {"guessedname": "_remove", "static": "", "description": "Unregisters a drag and drop item. This is executed in \nDragDrop.unreg, use that method instead of calling this directly.", "private": "", "guessedtype": "function"}, "isTypeOfDD": {"return": {"type": "boolean", "description": "true if typeof oDD = DragDrop"}, "description": "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof \nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.", "static": "", "guessedname": "isTypeOfDD", "guessedtype": "function", "params": [{"type": "Object", "name": "the", "description": " object to evaluate"}]}, "isLocked": {"static": "", "return": {"type": "boolean", "description": "True if drag and drop is locked, false otherwise."}, "description": "Is drag and drop locked?", "guessedname": "isLocked", "guessedtype": "function"}, "getClientHeight": {"return": {"type": "int", "description": "client height in px"}, "description": "Gets the client height", "deprecated": "use YAHOO.util.Dom.getViewportHeight instead", "static": "", "guessedname": "getClientHeight", "guessedtype": "function"}, "getBestMatch": {"return": {"type": "DragDrop", "description": "The best single match"}, "description": "Helper function for getting the best match from the list of drag \nand drop objects returned by the drag and drop events when we are \nin INTERSECT mode. It returns either the first object that the \ncursor is over, or the object that has the greatest overlap with \nthe dragged element.", "static": "", "guessedname": "getBestMatch", "guessedtype": "function", "params": [{"type": "DragDrop[]", "name": "dds", "description": " The array of drag and drop objects \ntargeted"}]}, "_activateShim": {"guessedname": "_activateShim", "static": "", "description": "This method will create the shim element if needed, then show the shim element, size the element and set the _shimActive property to true", "private": "", "guessedtype": "function"}, "stopEvent": {"static": "", "params": [{"type": "Event", "name": "e", "description": " the event as returned by this.getEvent()"}], "description": "Utility to stop event propagation and event default, if these \nfeatures are turned on.", "guessedname": "stopEvent", "guessedtype": "function"}, "numericSort": {"static": "", "description": "Numeric array sort function", "guessedname": "numericSort", "guessedtype": "function"}, "isOverTarget": {"return": {"type": "boolean", "description": "true if the mouse is over the target"}, "description": "Checks the cursor location to see if it over the target", "private": "", "static": "", "guessedname": "isOverTarget", "guessedtype": "function", "params": [{"type": "YAHOO.util.Point", "name": "pt", "description": " The point to evaluate"}, {"type": "DragDrop", "name": "oTarget", "description": " the DragDrop object we are inspecting"}, {"type": "boolean", "name": "intersect", "description": " true if we are in intersect mode"}, {"type": "YAHOO.util.Region", "name": "pre-cached", "description": " location of the dragged element"}]}, "_sizeShim": {"guessedname": "_createShim", "static": "", "description": "This method will create a shim element (giving it the id of yui-ddm-shim), it also attaches the mousemove and mouseup listeners to it and attaches a scroll listener on the window", "private": "", "guessedtype": "function"}, "isDragDrop": {"return": {"type": "boolean", "description": "true if this element is a DragDrop item, \nfalse otherwise"}, "description": "Utility function to determine if a given element has been \nregistered as a drag drop item.", "static": "", "guessedname": "isDragDrop", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the element id to check"}]}, "_onUnload": {"guessedname": "_onUnload", "static": "", "description": "unload event handler", "private": "", "guessedtype": "function"}, "getLocation": {"return": {"type": "YAHOO.util.Region", "description": "a Region object representing the total area\nthe element occupies, including any padding\nthe instance is configured for."}, "description": "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it", "static": "", "guessedname": "getLocation", "guessedtype": "function", "params": [{"type": "DragDrop", "name": "oDD", "description": " the drag and drop object to get the \nlocation for"}]}, "regHandle": {"static": "", "params": [{"type": "String", "name": "sDDId", "description": " the DragDrop id this element is a handle for"}, {"type": "String", "name": "sHandleId", "description": " the id of the element that is the drag \nhandle"}], "description": "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()", "guessedname": "regHandle", "guessedtype": "function"}, "getRelated": {"return": {"type": "DragDrop[]", "description": "the related instances"}, "description": "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.", "static": "", "guessedname": "getRelated", "guessedtype": "function", "params": [{"type": "DragDrop", "name": "p_oDD", "description": " the obj to get related data for"}, {"type": "boolean", "name": "bTargetsOnly", "description": " if true, only return targetable objs"}]}, "handleWasClicked": {"static": "", "params": [{"type": "", "name": "node", "description": " the html element to inspect"}], "description": "Recursively searches the immediate parent and all child nodes for \nthe handle element in order to determine wheter or not it was \nclicked.", "guessedname": "handleWasClicked", "guessedtype": "function"}, "swapNode": {"static": "", "params": [{"type": "", "name": "n1", "description": " the first node to swap"}, {"type": "", "name": "n2", "description": " the other node to swap"}], "description": "Swap two nodes. In IE, we use the native method, for others we \nemulate the IE behavior", "guessedname": "swapNode", "guessedtype": "function"}, "getScrollLeft": {"static": "", "return": {"type": "int", "description": "the document's scrollTop"}, "description": "Gets the scrollLeft", "guessedname": "getScrollLeft", "guessedtype": "function"}, "getElWrapper": {"return": {"type": "YAHOO.util.DDM.ElementWrapper", "description": "the wrapped element"}, "description": "Get the wrapper for the DOM element specified", "deprecated": "This wrapper isn't that useful", "private": "", "static": "", "guessedname": "getElWrapper", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the id of the element to get"}]}, "_addListeners": {"guessedname": "_addListeners", "static": "", "description": "Trying to make the load order less important. Without this we get\nan error if this file is loaded before the Event Utility.", "private": "", "guessedtype": "function"}, "getStyle": {"return": {"type": "string", "description": "The value of the style property"}, "description": "Returns the specified element style property", "deprecated": "use YAHOO.util.Dom.getStyle", "static": "", "guessedname": "getStyle", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "el", "description": " the element"}, {"type": "string", "name": "styleProp", "description": " the style property"}]}, "getPosY": {"return": {"type": "int", "description": "the Y coordinate"}, "description": "Returns the Y position of an html element", "deprecated": "use YAHOO.util.Dom.getY instead", "static": "", "guessedname": "getPosY", "guessedtype": "function", "params": [{"type": "", "name": "el", "description": " the element for which to get the position"}]}, "isLegalTarget": {"return": {"type": "boolean", "description": "true if the target is a legal target for the \ndd obj"}, "description": "Returns true if the specified dd target is a legal target for \nthe specifice drag obj", "static": "", "guessedname": "isLegalTarget", "guessedtype": "function", "params": [{"type": "DragDrop", "name": "the", "description": " drag obj"}, {"type": "DragDrop", "name": "the", "description": " target"}]}, "refreshCache": {"description": "Refreshes the cache of the top-left and bottom-right points of the \ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical \nusage is:\n<code>\nYAHOO.util.DragDropMgr.refreshCache(ddinstance.groups);\n<\/code>\nAlternatively:\n<code>\nYAHOO.util.DragDropMgr.refreshCache({group1:true, group2:true});\n<\/code>", "static": "", "guessedname": "refreshCache", "guessedtype": "function", "params": [{"type": "Object", "name": "groups", "description": " an associative array of groups to refresh"}], "todo": "this really should be an indexed array. Alternatively this\nmethod could accept both."}, "isHandle": {"return": {"type": "boolean", "description": "true if this element is a DragDrop handle, false \notherwise"}, "description": "Utility function to determine if a given element has been \nregistered as a drag drop handle for the given Drag Drop object.", "static": "", "guessedname": "isHandle", "guessedtype": "function", "params": [{"type": "String", "name": "id", "description": " the element id to check"}]}, "handleMouseUp": {"description": "Internal function to handle the mouseup event. Will be invoked \nfrom the context of the document.", "private": "", "static": "", "guessedname": "handleMouseUp", "guessedtype": "function", "params": [{"type": "Event", "name": "e", "description": " the event"}]}, "verifyEl": {"return": {"type": "boolean", "description": "true if the element looks usable"}, "description": "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element", "static": "", "guessedname": "verifyEl", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to check"}]}, "getScroll": {"guessedname": "getScroll", "static": "", "description": "Returns the current scroll position", "private": "", "guessedtype": "function"}, "moveToEl": {"static": "", "params": [{"type": "HTMLElement", "name": "moveEl", "description": " The element to move"}, {"type": "HTMLElement", "name": "targetEl", "description": " The position reference element"}], "description": "Sets the x\/y position of an element to the location of the\ntarget element.", "guessedname": "moveToEl", "guessedtype": "function"}}, "static": "", "file": "DragDropMgr.js", "guessedtype": "function", "shortname": "DragDropMgr", "properties": {"dragThreshMet": {"description": "Flag that indicates that either the drag pixel threshold or the \nmousdown time threshold has been met", "private": "", "static": "", "guessedname": "dragThreshMet", "guessedtype": "property", "type": "boolean"}, "clickPixelThresh": {"type": "int", "static": "", "description": "The number of pixels that the mouse needs to move after the \nmousedown before the drag is initiated. Default=3;", "guessedname": "clickPixelThresh", "guessedtype": "property"}, "_timeoutCount": {"guessedname": "_timeoutCount", "static": "", "description": "Internal counter", "private": "", "guessedtype": "property"}, "initialized": {"guessedname": "initialized", "static": "", "description": "Internal flag that is set to true when drag and drop has been\ninitialized", "private": "", "guessedtype": "property"}, "elementCache": {"description": "A cache of DOM elements", "deprecated": "elements are not cached now", "private": "", "static": "", "guessedname": "elementCache", "guessedtype": "property"}, "stopPropagation": {"type": "boolean", "static": "", "description": "Flag to determine if we should stop the propagation of the events \nwe generate. This is true by default but you may want to set it to\nfalse if the html element contains other features that require the\nmouse click.", "guessedname": "stopPropagation", "guessedtype": "property"}, "clickTimeout": {"description": "Timeout used for the click time threshold", "private": "", "static": "", "guessedname": "clickTimeout", "guessedtype": "property", "type": "Object"}, "handleIds": {"description": "Array of element ids defined as drag handles. Used to determine \nif the element that generated the mousedown event is actually the \nhandle and not the html element itself.", "private": "", "static": "", "guessedname": "handleIds", "guessedtype": "property", "type": "{string: string}"}, "POINT": {"description": "In point mode, drag and drop interaction is defined by the \nlocation of the cursor during the drag\/drop", "static": "", "guessedname": "POINT", "guessedtype": "property", "type": "int", "final": ""}, "deltaX": {"description": "the X distance between the cursor and the object being dragged", "private": "", "static": "", "guessedname": "deltaX", "guessedtype": "property", "type": "int"}, "deltaY": {"description": "the Y distance between the cursor and the object being dragged", "private": "", "static": "", "guessedname": "deltaY", "guessedtype": "property", "type": "int"}, "dragOvers": {"description": "the DragDrop object(s) that are being hovered over", "private": "", "static": "", "guessedname": "dragOvers", "guessedtype": "property", "type": "Array"}, "useCache": {"type": "boolean", "static": "", "description": "Set useCache to false if you want to force object the lookup of each\ndrag and drop linked element constantly during a drag.", "guessedname": "useCache", "guessedtype": "property"}, "fromTimeout": {"description": "Flag to determine if the drag event was fired from the click timeout and\nnot the mouse move threshold.", "private": "", "static": "", "guessedname": "fromTimeout", "guessedtype": "property", "type": "boolean"}, "clickTimeThresh": {"type": "int", "static": "", "description": "The number of milliseconds after the mousedown event to initiate the\ndrag if we don't get a mouseup event. Default=1000", "guessedname": "clickTimeThresh", "guessedtype": "property"}, "mode": {"type": "int", "static": "", "description": "The current drag and drop mode. Default: POINT", "guessedname": "mode", "guessedtype": "property"}, "startX": {"description": "The X position of the mousedown event stored for later use when a \ndrag threshold is met.", "private": "", "static": "", "guessedname": "startX", "guessedtype": "property", "type": "int"}, "startY": {"description": "The Y position of the mousedown event stored for later use when a \ndrag threshold is met.", "private": "", "static": "", "guessedname": "startY", "guessedtype": "property", "type": "int"}, "_shim": {"description": "The HTML element created to use as a shim over the document to track mouse movements", "private": "", "static": "", "guessedname": "_shim", "guessedtype": "property", "type": "HTMLElement"}, "_debugShim": {"description": "This property is used when useShim is set to true, it will set the opacity on the shim to .5 for debugging. Use: (YAHOO.util.DDM._debugShim = true;)", "private": "", "static": "", "guessedname": "_debugShim", "guessedtype": "property", "type": "Boolean"}, "STRICT_INTERSECT": {"description": "In intersect mode, drag and drop interaction is defined only by the \noverlap of two or more drag and drop objects.", "static": "", "guessedname": "STRICT_INTERSECT", "guessedtype": "property", "type": "int", "final": ""}, "interactionInfo": {"type": "object", "static": "", "description": "Provides additional information about the the current set of\ninteractions. Can be accessed from the event handlers. It\ncontains the following properties:\nout: onDragOut interactions\nenter: onDragEnter interactions\nover: onDragOver interactions\ndrop: onDragDrop interactions\npoint: The location of the cursor\ndraggedRegion: The location of dragged element at the time\nof the interaction\nsourceRegion: The location of the source elemtn at the time\nof the interaction\nvalidDrop: boolean", "guessedname": "interactionInfo", "guessedtype": "property"}, "locationCache": {"guessedname": "locationCache", "static": "", "description": "Location cache that is set for all drag drop objects when a drag is\ninitiated, cleared when the drag is finished.", "private": "", "guessedtype": "property"}, "INTERSECT": {"description": "In intersect mode, drag and drop interaction is defined by the \ncursor position or the amount of overlap of two or more drag and \ndrop objects.", "static": "", "guessedname": "INTERSECT", "guessedtype": "property", "type": "int", "final": ""}, "_shimState": {"description": "This property is used when useShim is set on a DragDrop object to store the current state of DDM.useShim so it can be reset when a drag operation is done.", "private": "", "static": "", "guessedname": "_shimState", "guessedtype": "property", "type": "Boolean"}, "locked": {"guessedname": "locked", "static": "", "description": "All drag and drop can be disabled.", "private": "", "guessedtype": "property"}, "useShim": {"type": "Boolean", "static": "", "description": "This property is used to turn on global use of the shim element on all DragDrop instances, defaults to false for backcompat. (Use: YAHOO.util.DDM.useShim = true)", "guessedname": "useShim", "guessedtype": "property"}, "dragCurrent": {"description": "the DragDrop object that is currently being dragged", "private": "", "static": "", "guessedname": "dragCurrent", "guessedtype": "property", "type": "DragDrop"}, "preventDefault": {"type": "boolean", "static": "", "description": "Flag to determine if we should prevent the default behavior of the\nevents we define. By default this is true, but this can be set to \nfalse if you need the default behavior (not recommended)", "guessedname": "preventDefault", "guessedtype": "property"}, "ids": {"description": "Two dimensional Array of registered DragDrop objects. The first \ndimension is the DragDrop item group, the second the DragDrop \nobject.", "private": "", "static": "", "guessedname": "ids", "guessedtype": "property", "type": "{string: string}"}, "_shimActive": {"description": "This property is used to determine if the shim is active over the screen, default false.", "private": "", "static": "", "guessedname": "_shimActive", "guessedtype": "property", "type": "Boolean"}}, "description": "DragDropMgr is a singleton that tracks the element interaction for \nall DragDrop items in the window. Generally, you will not call \nthis class directly, but it does have helper methods that could \nbe useful in your DragDrop implementations."}, "YAHOO.util.Chain": {"name": "YAHOO.util.Chain", "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 callback is executed via setTimout unless configured with a negative timeout, in which case it is run in blocking mode in the same execution thread as the previous callback. Callbacks can be function references or object literals with the following keys:\n<ul>\n<li><code>method<\/code> - {Function} REQUIRED the callback function.<\/li>\n<li><code>scope<\/code> - {Object} the scope from which to execute the callback. Default is the global window scope.<\/li>\n<li><code>argument<\/code> - {Array} parameters to be passed to method as individual arguments.<\/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 completion and proceed to the next callback.<\/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": "YAHOO.util", "module": "datatable", "events": {"end": {"description": "Event fired when the callback queue is emptied via execution (not via\na call to chain.stop()."}}, "guessedname": "Chain", "methods": {"stop": {"return": {"type": "Chain", "description": "the Chain instance"}, "description": "Stop and clear the Chain's queue after the current execution of the\ncurrent callback completes.", "guessedname": "stop", "guessedtype": "function"}, "add": {"return": {"type": "Chain", "description": "the Chain instance"}, "params": [{"type": "Function|Object", "name": "c", "description": " the callback function ref or object literal"}], "description": "Add a callback to the end of the queue", "guessedname": "add", "guessedtype": "function"}, "pause": {"return": {"type": "Chain", "description": "the Chain instance"}, "description": "Pause the execution of the Chain after the current execution of the\ncurrent callback completes. If called interstitially, clears the\ntimeout for the pending callback. Paused Chains can be restarted with\nchain.run()", "guessedname": "pause", "guessedtype": "function"}, "run": {"return": {"type": "Chain", "description": "the Chain instance"}, "description": "Begin executing the chain, or resume execution from the last paused position.", "guessedname": "run", "guessedtype": "function"}}, "file": "Chain.js", "guessedtype": "function", "shortname": "Chain", "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 state of the Chain. 0 indicates paused or stopped, -1 indicates blocking execution, and any positive number indicates non-blocking execution.", "private": "", "guessedtype": "property"}}, "description": "Mechanism to execute a series of callbacks in a non-blocking queue. Each callback is executed via setTimout unless configured with a negative timeout, in which case it is run in blocking mode in the same execution thread as the previous callback. Callbacks can be function references or object literals with the following keys:\n<ul>\n<li><code>method<\/code> - {Function} REQUIRED the callback function.<\/li>\n<li><code>scope<\/code> - {Object} the scope from which to execute the callback. Default is the global window scope.<\/li>\n<li><code>argument<\/code> - {Array} parameters to be passed to method as individual arguments.<\/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 completion and proceed to the next callback.<\/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>"}, "YAHOO.widget.MenuItem": {"name": "YAHOO.widget.MenuItem", "configs": {"submenu": {"default": "null", "type": "Menu|String|Object|<a href=\"http:\/\/www.w3.org\/TR\/2000\/\nWD-DOM-Level-1-20000929\/level-one-html.html#ID-58190037\">\nHTMLElement<\/a>", "description": "Object specifying the submenu to be appended to the \nmenu item. The value can be one of the following: <ul><li>Object \nspecifying a Menu instance.<\/li><li>Object literal specifying the\nmenu to be created. Format: <code>{ id: [menu id], itemdata: \n[<a href=\"YAHOO.widget.Menu.html#itemData\">array of values for \nitems<\/a>] }<\/code>.<\/li><li>String specifying the id attribute \nof the <code><div><\/code> element of the menu.<\/li><li>\nObject specifying the <code><div><\/code> element of the \nmenu.<\/li><\/ul>"}, "classname": {"default": "null", "type": "String", "description": "CSS class to be applied to the menu item's root \n<code><li><\/code> element. The specified class(es) are \nappended in addition to the default class as specified by the menu \nitem's CSS_CLASS_NAME constant."}, "checked": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the menu item should be rendered \nwith a checkmark."}, "target": {"default": "null", "type": "String", "description": "String specifying the value for the \"target\" attribute \nof the menu item's anchor element. <strong>Specifying a target will \nrequire the user to click directly on the menu item's anchor node in\norder to cause the browser to navigate to the specified URL.<\/strong> \nWhen building a menu from existing HTML the value of this property \nwill be interpreted from the menu's markup."}, "url": {"default": "\"#\"", "type": "String", "description": "String specifying the URL for the menu item's anchor's \n\"href\" attribute. When building a menu from existing HTML the value \nof this property will be interpreted from the menu's markup."}, "text": {"default": "\"\"", "type": "String", "description": "String specifying the text label for the menu item. \nWhen building a menu from existing HTML the value of this property\nwill be interpreted from the menu's markup."}, "selected": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the menu item should \nbe highlighted."}, "strongemphasis": {"default": "false", "deprecated": "Use the \"text\" configuration property to add strong emphasis. \nFor example: <code>oMenuItem.cfg.setProperty(\"text\", \"<strong> \nSome Text<\/strong>\");<\/code>", "type": "Boolean", "description": "Boolean indicating if the text of the menu item will be \nrendered with strong emphasis."}, "disabled": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the menu item should be disabled. \n(Disabled menu items are dimmed and will not respond to user input \nor fire events.)"}, "emphasis": {"default": "false", "deprecated": "Use the \"text\" configuration property to add emphasis. \nFor example: <code>oMenuItem.cfg.setProperty(\"text\", \"<em>Some \nText<\/em>\");<\/code>", "type": "Boolean", "description": "Boolean indicating if the text of the menu item will be \nrendered with emphasis."}, "helptext": {"default": "null", "deprecated": "Use \"text\" configuration property to add help text markup. \nFor example: <code>oMenuItem.cfg.setProperty(\"text\", \"Copy <em \nclass=\\\"helptext\\\">Ctrl + C<\/em>\");<\/code>", "type": "String|<a href=\"http:\/\/www.w3.org\/TR\/\n2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-58190037\">\nHTMLElement<\/a>", "description": "String specifying additional instructional text to \naccompany the text for the menu item."}, "onclick": {"default": "null", "type": "Object", "description": "Object literal representing the code to be executed when \nthe item is clicked. Format:<br> <code> {<br> \n<strong>fn:<\/strong> Function, // The handler to call when \nthe event fires.<br> <strong>obj:<\/strong> Object, // An \nobject to pass back to the handler.<br> <strong>scope:<\/strong> \nObject // The object to use for the scope of the handler.\n<br> } <\/code>"}}, "constructors": [{"params": [{"type": "String", "name": "p_oObject", "description": " String specifying the text of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-74680021\">HTMLLIElement<\/a>", "name": "p_oObject", "description": " Object specifying \nthe <code><li><\/code> element of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-38450247\">HTMLOptGroupElement<\/a>", "name": "p_oObject", "description": " Object \nspecifying the <code><optgroup><\/code> element of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-70901257\">HTMLOptionElement<\/a>", "name": "p_oObject", "description": " Object \nspecifying the <code><option><\/code> element of the menu item."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu item. See configuration class documentation \nfor more details."}], "description": "Creates an item for a menu."}], "namespace": "YAHOO.widget", "module": "menu", "events": {"mouseOutEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the mouse has left the menu item. Passes back \nthe DOM Event object as an argument."}, "mouseUpEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user releases a mouse button while the mouse \nis over the menu item. Passes back the DOM Event object as an argument."}, "keyUpEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user releases a key when the menu item has \nfocus. Passes back the DOM Event object as an argument."}, "focusEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the menu item receives focus."}, "keyPressEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user presses an alphanumeric key when the \nmenu item has focus. Passes back the DOM Event object as an argument."}, "mouseOverEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the mouse has entered the menu item. Passes \nback the DOM Event object as an argument."}, "blurEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the menu item loses the input focus."}, "mouseDownEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user mouses down on the menu item. Passes \nback the DOM Event object as an argument."}, "clickEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user clicks the on the menu item. Passes \nback the DOM Event object as an argument."}, "destroyEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the menu item's <code><li><\/code> \nelement is removed from its parent <code><ul><\/code> element."}, "keyDownEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user presses a key when the menu item has \nfocus. Passes back the DOM Event object as an argument."}}, "guessedname": "MenuItem", "methods": {"_createRootNodeStructure": {"description": "Creates the core DOM structure for the menu item.", "private": "", "guessedname": "_createRootNodeStructure", "guessedtype": "function"}, "hasFocus": {"return": {"type": "Boolean", "description": ""}, "description": "Returns a boolean indicating whether or not the menu item\nhas focus.", "guessedname": "hasFocus", "guessedtype": "function"}, "configURL": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"url\" configuration property of \nthe menu item changes.", "guessedname": "configURL", "guessedtype": "function"}, "focus": {"description": "Causes the menu item to receive the focus and fires the \nfocus event.", "guessedname": "focus", "guessedtype": "function"}, "configEmphasis": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"emphasis\" configuration property\nof the menu item changes.", "guessedname": "configEmphasis", "guessedtype": "function"}, "configTarget": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"target\" configuration property \nof the menu item changes.", "guessedname": "configTarget", "guessedtype": "function"}, "addClassNameForState": {"guessedname": "addClassNameForState", "params": [{"type": "String", "name": "state", "description": " String representing a state - \"disabled,\" \"checked,\" etc."}], "description": "Applies a class name to a MenuItem instance's <LI> and <A> elements\nthat represents a MenuItem's state - \"disabled,\" \"checked,\" etc.", "private": "", "guessedtype": "function"}, "getClassNameForState": {"guessedname": "getClassNameForState", "params": [{"type": "String", "name": "prefix", "description": " String representing the prefix for the class name"}, {"type": "String", "name": "state", "description": " String representing a state - \"disabled,\" \"checked,\" etc."}], "description": "Returns a class name for the specified prefix and state. If the class name does not \nyet exist, it is created and stored in the CLASS_NAMES object to increase performance.", "private": "", "guessedtype": "function"}, "configStrongEmphasis": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"strongemphasis\" configuration \nproperty of the menu item changes.", "guessedname": "configStrongEmphasis", "guessedtype": "function"}, "configSubmenu": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"submenu\" configuration property \nof the menu item changes.", "guessedname": "configSubmenu", "guessedtype": "function"}, "configOnClick": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"onclick\" configuration property \nof the menu item changes.", "guessedname": "configOnClick", "guessedtype": "function"}, "getPreviousEnabledSibling": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Finds the menu item's previous enabled sibling.", "guessedname": "getPreviousEnabledSibling", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oObject", "description": " String specifying the text of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-74680021\">HTMLLIElement<\/a>", "name": "p_oObject", "description": " Object specifying \nthe <code><li><\/code> element of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-38450247\">HTMLOptGroupElement<\/a>", "name": "p_oObject", "description": " Object \nspecifying the <code><optgroup><\/code> element of the menu item."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-70901257\">HTMLOptionElement<\/a>", "name": "p_oObject", "description": " Object \nspecifying the <code><option><\/code> element of the menu item."}, {"type": "Object", "name": "p_oConfig", "description": " Optional. Object literal specifying the \nconfiguration for the menu item. See configuration class documentation \nfor more details."}], "description": "The MenuItem class's initialization method. This method is \nautomatically called by the constructor, and sets up all DOM references \nfor pre-existing markup, and creates required markup if it is not \nalready present.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the menu item.", "guessedname": "toString", "guessedtype": "function"}, "removeClassNameForState": {"guessedname": "removeClassNameForState", "params": [{"type": "String", "name": "state", "description": " String representing a state - \"disabled,\" \"checked,\" etc."}], "description": "Removes a class name from a MenuItem instance's <LI> and <A> elements\nthat represents a MenuItem's state - \"disabled,\" \"checked,\" etc.", "private": "", "guessedtype": "function"}, "_onSubmenuBeforeHide": {"guessedname": "_onSubmenuBeforeHide", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}], "description": "\"beforehide\" Custom Event handler for a submenu.", "private": "", "guessedtype": "function"}, "blur": {"description": "Causes the menu item to lose focus and fires the \nblur event.", "guessedname": "blur", "guessedtype": "function"}, "configHelpText": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"helptext\" configuration property \nof the menu item changes.", "guessedname": "configHelpText", "guessedtype": "function"}, "destroy": {"description": "Removes the menu item's <code><li><\/code> element \nfrom its parent <code><ul><\/code> element.", "guessedname": "destroy", "guessedtype": "function"}, "getNextEnabledSibling": {"return": {"type": "", "description": "YAHOO.widget.MenuItem"}, "description": "Finds the menu item's next enabled sibling.", "guessedname": "getNextEnabledSibling", "guessedtype": "function"}, "configChecked": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"checked\" configuration property \nof the menu item changes.", "guessedname": "configChecked", "guessedtype": "function"}, "configDisabled": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"disabled\" configuration property \nof the menu item changes.", "guessedname": "configDisabled", "guessedtype": "function"}, "configSelected": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"selected\" configuration property \nof the menu item changes.", "guessedname": "configSelected", "guessedtype": "function"}, "_initSubTree": {"description": "Iterates the source element's childNodes collection and uses \nthe child nodes to instantiate other menus.", "private": "", "guessedname": "_initSubTree", "guessedtype": "function"}, "configClassName": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"classname\" configuration \nproperty of a menu item changes.", "guessedname": "configClassName", "guessedtype": "function"}, "configText": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event that \nwas fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event was fired."}, {"type": "YAHOO.widget.MenuItem", "name": "p_oItem", "description": " Object representing the menu item\nthat fired the event."}], "description": "Event handler for when the \"text\" configuration property of \nthe menu item changes.", "guessedname": "configText", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes an item's configurable properties.", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "file": "menuitem.js", "guessedtype": "function", "shortname": "MenuItem", "properties": {"_oSubmenu": {"description": "Object reference to the menu item's submenu.", "default": "null", "private": "", "guessedname": "_oSubmenu", "guessedtype": "property", "type": "YAHOO.widget.Menu"}, "index": {"default": "null", "type": "Number", "description": "Number indicating the ordinal position of the menu item in \nits group.", "guessedname": "index", "guessedtype": "property"}, "CSS_LABEL_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied to the \nmenu item's <code><a><\/code> element.", "default": "\"yuimenuitemlabel\"", "guessedname": "CSS_LABEL_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}, "CSS_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied to the \n<code><li><\/code> element of the menu item.", "default": "\"yuimenuitem\"", "guessedname": "CSS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}, "parent": {"default": "null", "type": "YAHOO.widget.Menu", "description": "Object reference to the menu item's parent menu.", "guessedname": "parent", "guessedtype": "property"}, "SUBMENU_TYPE": {"final": "", "type": "YAHOO.widget.Menu", "description": "Object representing the type of menu to instantiate and \nadd when parsing the child nodes of the menu item's source HTML element.", "guessedname": "SUBMENU_TYPE", "guessedtype": "property"}, "srcElement": {"default": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-74680021\">HTMLLIElement<\/a>|<a href=\"http:\/\/www.\nw3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-38450247\"\n>HTMLOptGroupElement<\/a>|<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-\nLevel-1-20000929\/level-one-html.html#ID-70901257\">HTMLOptionElement<\/a>", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-74680021\">HTMLLIElement<\/a>|<a href=\"http:\/\/www.w3.\norg\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-38450247\">\nHTMLOptGroupElement<\/a>|<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-\nLevel-1-20000929\/level-one-html.html#ID-70901257\">HTMLOptionElement<\/a>", "description": "Object reference to the HTML element (either \n<code><li><\/code>, <code><optgroup><\/code> or \n<code><option><\/code>) used create the menu item.", "guessedname": "srcElement", "guessedtype": "property"}, "value": {"default": "null", "type": "Object", "description": "Object reference to the menu item's value.", "guessedname": "value", "guessedtype": "property"}, "element": {"default": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level\n-one-html.html#ID-74680021\">HTMLLIElement<\/a>", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-74680021\">HTMLLIElement<\/a>", "description": "Object reference to the menu item's \n<code><li><\/code> element.", "guessedname": "element", "guessedtype": "property"}, "_sClassName": {"description": "The current value of the \"classname\" configuration attribute.", "default": "null", "private": "", "guessedname": "_sClassName", "guessedtype": "property", "type": "String"}, "_oAnchor": {"description": "Object reference to the menu item's \n<code><a><\/code> element.", "default": "null", "private": "", "guessedname": "_oAnchor", "guessedtype": "property", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-48250443\">HTMLAnchorElement<\/a>"}, "constructor": {"default": "YAHOO.widget.MenuItem", "type": "YAHOO.widget.MenuItem", "description": "Object reference to the menu item's constructor function.", "guessedname": "constructor", "guessedtype": "property"}, "groupIndex": {"default": "null", "type": "Number", "description": "Number indicating the index of the group to which the menu \nitem belongs.", "guessedname": "groupIndex", "guessedtype": "property"}, "browser": {"deprecated": "Use YAHOO.env.ua", "type": "String", "description": "String representing the browser.", "guessedname": "browser", "guessedtype": "property"}, "_oHelpTextEM": {"description": "Object reference to the menu item's help text \n<code><em><\/code> element.", "default": "null", "private": "", "guessedname": "_oHelpTextEM", "guessedtype": "property", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-58190037\">HTMLElement<\/a>"}, "id": {"default": "null", "type": "String", "description": "Id of the menu item's root <code><li><\/code> \nelement. This property should be set via the constructor using the \nconfiguration object literal. If an id is not specified, then one will \nbe created using the \"generateId\" method of the Dom utility.", "guessedname": "id", "guessedtype": "property"}, "_oOnclickAttributeValue": {"description": "Object reference to the menu item's current value for the \n\"onclick\" configuration attribute.", "default": "null", "private": "", "guessedname": "_oOnclickAttributeValue", "guessedtype": "property", "type": "Object"}}, "description": "Creates an item for a menu."}, "YAHOO.widget.CartesianSeries": {"name": "YAHOO.widget.CartesianSeries", "constructors": [{"description": "CartesianSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "CartesianSeries", "file": "Series.js", "guessedtype": "function", "shortname": "CartesianSeries", "properties": {"yField": {"type": "String", "description": "The field used to access the y-axis value from the items from the data source.", "guessedname": "yField", "guessedtype": "property"}, "xField": {"type": "String", "description": "The field used to access the x-axis value from the items from the data source.", "guessedname": "xField", "guessedtype": "property"}}, "description": "CartesianSeries class for the YUI Charts widget."}, "YAHOO.util.Scroll": {"name": "YAHOO.util.Scroll", "constructors": [{"params": [{"type": "String or HTMLElement", "name": "el", "description": " Reference to the element that will be animated"}, {"type": "Object", "name": "attributes", "description": " The attribute(s) to be animated. \nEach attribute is an object with at minimum a \"to\" or \"by\" member defined. \nAdditional optional members are \"from\" (defaults to current value), \"units\" (defaults to \"px\"). \nAll attribute names use camelCase."}, {"type": "Number", "name": "duration", "description": " (optional, defaults to 1 second) Length of animation (frames or seconds), defaults to time-based"}, {"type": "Function", "name": "method", "description": " (optional, defaults to YAHOO.util.Easing.easeNone) Computes the values that are applied to the attributes per frame (generally a YAHOO.util.Easing method)"}], "description": "Anim subclass for scrolling elements to a position defined by the \"scroll\"\nmember of \"attributes\". All \"scroll\" members are arrays with x, y scroll positions.\n<p>Usage: <code>var myAnim = new YAHOO.util.Scroll(el, { scroll: { to: [0, 800] } }, 1, YAHOO.util.Easing.easeOut);<\/code><\/p>"}], "namespace": "YAHOO.util", "module": "animation", "guessedname": "Scroll", "extends": "YAHOO.util.ColorAnim", "superclass": "YAHOO.util.ColorAnim", "file": "Scroll.js", "guessedtype": "function", "shortname": "Scroll", "requires": "YAHOO.util.Anim", "description": "Anim subclass for scrolling elements to a position defined by the \"scroll\"\nmember of \"attributes\". All \"scroll\" members are arrays with x, y scroll positions.\n<p>Usage: <code>var myAnim = new YAHOO.util.Scroll(el, { scroll: { to: [0, 800] } }, 1, YAHOO.util.Easing.easeOut);<\/code><\/p>"}, "YAHOO.widget.DateMath": {"name": "YAHOO.widget.DateMath", "namespace": "YAHOO.widget", "module": "calendar", "guessedname": "DateMath", "methods": {"isYearOverlapWeek": {"return": {"type": "Boolean", "description": "true if the date overlaps two different years."}, "params": [{"type": "Date", "name": "weekBeginDate", "description": "\tThe JavaScript Date representing the first day of the week."}], "description": "Determines if a given week overlaps two different years.", "guessedname": "isYearOverlapWeek", "guessedtype": "function"}, "getWeekNumber": {"return": {"type": "Number", "description": "The number of the week containing the given date."}, "params": [{"type": "Date", "name": "date", "description": " The JavaScript date for which to find the week number"}, {"type": "Number", "name": "firstDayOfWeek", "description": " The index of the first day of the week (0 = Sun, 1 = Mon ... 6 = Sat).\nDefaults to 0"}, {"type": "Number", "name": "janDate", "description": " The date in the first week of January which defines week one for the year\nDefaults to the value of YAHOO.widget.DateMath.WEEK_ONE_JAN_DATE, which is 1 (Jan 1st). \nFor the U.S, this is normally Jan 1st. ISO8601 uses Jan 4th to define the first week of the year."}], "description": "Calculates the week number for the given date. Can currently support standard\nU.S. week numbers, based on Jan 1st defining the 1st week of the year, and \nISO8601 week numbers, based on Jan 4th defining the 1st week of the year.", "guessedname": "getWeekNumber", "guessedtype": "function"}, "getDayOffset": {"return": {"type": "Number", "description": "The number of days since January 1 of the given year"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript date for which to find the offset"}, {"type": "Number", "name": "calendarYear", "description": "\tThe calendar year to use for determining the offset"}], "description": "Calculates the number of days the specified date is from January 1 of the specified calendar year.\nPassing January 1 to this function would return an offset value of zero.", "guessedname": "getDayOffset", "guessedtype": "function"}, "findMonthEnd": {"return": {"type": "Date", "description": "The JavaScript Date representing the last day of the month"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date used to calculate the month end"}], "description": "Gets the last day of a month containing a given date.", "guessedname": "findMonthEnd", "guessedtype": "function"}, "getFirstDayOfWeek": {"return": {"type": "Date", "description": "The first day of the week"}, "params": [{"type": "Date", "name": "dt", "description": " The date in the week for which the first day is required."}, {"type": "Number", "name": "startOfWeek", "description": " The index for the first day of the week, 0 = Sun, 1 = Mon ... 6 = Sat (defaults to 0)"}], "description": "Get the first day of the week, for the give date.", "guessedname": "getFirstDayOfWeek", "guessedtype": "function"}, "after": {"return": {"type": "Boolean", "description": "true if the date occurs after the compared date; false if not."}, "params": [{"type": "Date", "name": "date", "description": "\t\tThe Date object to compare with the compare argument"}, {"type": "Date", "name": "compareTo", "description": "\tThe Date object to use for the comparison"}], "description": "Determines whether a given date is after another date on the calendar.", "guessedname": "after", "guessedtype": "function"}, "clearTime": {"return": {"type": "Date", "description": "The JavaScript Date cleared of all time fields"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date for which the time fields will be cleared"}], "description": "Clears the time fields from a given date, effectively setting the time to 12 noon.", "guessedname": "clearTime", "guessedtype": "function"}, "isMonthOverlapWeek": {"return": {"type": "Boolean", "description": "true if the date overlaps two different months."}, "params": [{"type": "Date", "name": "weekBeginDate", "description": "\tThe JavaScript Date representing the first day of the week."}], "description": "Determines if a given week overlaps two different months.", "guessedname": "isMonthOverlapWeek", "guessedtype": "function"}, "add": {"return": {"type": "Date", "description": "The resulting Date object"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date object to perform addition on"}, {"type": "String", "name": "field", "description": "\tThe field constant to be used for performing addition."}, {"type": "Number", "name": "amount", "description": "\tThe number of units (measured in the field constant) to add to the date."}], "description": "Adds the specified amount of time to the this instance.", "guessedname": "add", "guessedtype": "function"}, "getJan1": {"return": {"type": "Date", "description": "January 1 of the calendar year specified."}, "params": [{"type": "Number", "name": "calendarYear", "description": "\t\tThe calendar year for which to retrieve January 1"}], "description": "Retrieves a JavaScript Date object representing January 1 of any given year.", "guessedname": "getJan1", "guessedtype": "function"}, "between": {"return": {"type": "Boolean", "description": "true if the date occurs between the compared dates; false if not."}, "params": [{"type": "Date", "name": "date", "description": "\t\tThe date to check for"}, {"type": "Date", "name": "dateBegin", "description": "\tThe start of the range"}, {"type": "Date", "name": "dateEnd", "description": "\t\tThe end of the range"}], "description": "Determines whether a given date is between two other dates on the calendar.", "guessedname": "between", "guessedtype": "function"}, "findMonthStart": {"return": {"type": "Date", "description": "The JavaScript Date representing the first day of the month"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date used to calculate the month start"}], "description": "Gets the first day of a month containing a given date.", "guessedname": "findMonthStart", "guessedtype": "function"}, "getDate": {"return": {"type": "Date", "description": "The JavaScript date object with year, month, date set as provided."}, "params": [{"type": "Number", "name": "y", "description": " Year."}, {"type": "Number", "name": "m", "description": " Month index from 0 (Jan) to 11 (Dec)."}, {"type": "Number", "name": "d", "description": " (optional) Date from 1 to 31. If not provided, defaults to 1."}], "description": "Returns a new JavaScript Date object, representing the given year, month and date. Time fields (hr, min, sec, ms) on the new Date object\nare set to 0. The method allows Date instances to be created with the a year less than 100. \"new Date(year, month, date)\" implementations \nset the year to 19xx if a year (xx) which is less than 100 is provided.\n<p>\n<em>NOTE:<\/em>Validation on argument values is not performed. It is the caller's responsibility to ensure\narguments are valid as per the ECMAScript-262 Date object specification for the new Date(year, month[, date]) constructor.\n<\/p>", "guessedname": "getDate", "guessedtype": "function"}, "subtract": {"return": {"type": "Date", "description": "The resulting Date object"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date object to perform subtraction on"}, {"type": "Number", "name": "field", "description": "\tThe this field constant to be used for performing subtraction."}, {"type": "Number", "name": "amount", "description": "\tThe number of units (measured in the field constant) to subtract from the date."}], "description": "Subtracts the specified amount of time from the this instance.", "guessedname": "subtract", "guessedtype": "function"}, "_addDays": {"guessedname": "_addDays", "params": [{"type": "Date", "name": "d", "description": " JavaScript date object"}, {"type": "Number", "name": "nDays", "description": " The number of days to add to the date object (can be negative)"}], "description": "Private helper method to account for bug in Safari 2 (webkit < 420)\nwhen Date.setDate(n) is called with n less than -128 or greater than 127.\n<p>\nFix approach and original findings are available here:\nhttp:\/\/brianary.blogspot.com\/2006\/03\/safari-date-bug.html\n<\/p>", "private": "", "guessedtype": "function"}, "before": {"return": {"type": "Boolean", "description": "true if the date occurs before the compared date; false if not."}, "params": [{"type": "Date", "name": "date", "description": "\t\tThe Date object to compare with the compare argument"}, {"type": "Date", "name": "compareTo", "description": "\tThe Date object to use for the comparison"}], "description": "Determines whether a given date is before another date on the calendar.", "guessedname": "before", "guessedtype": "function"}}, "file": "DateMath.js", "guessedtype": "property", "shortname": "DateMath", "properties": {"WEEK": {"description": "Constant field representing Week", "static": "", "guessedname": "WEEK", "guessedtype": "property", "type": "String", "final": ""}, "YEAR": {"description": "Constant field representing Year", "static": "", "guessedname": "YEAR", "guessedtype": "property", "type": "String", "final": ""}, "MONTH": {"description": "Constant field representing Month", "static": "", "guessedname": "MONTH", "guessedtype": "property", "type": "String", "final": ""}, "ONE_DAY_MS": {"description": "Constant field representing one day, in milliseconds", "static": "", "guessedname": "ONE_DAY_MS", "guessedtype": "property", "type": "Number", "final": ""}, "WEEK_ONE_JAN_DATE": {"type": "Number", "static": "", "description": "Constant field representing the date in first week of January\nwhich identifies the first week of the year.\n<p>\nIn the U.S, Jan 1st is normally used based on a Sunday start of week.\nISO 8601, used widely throughout Europe, uses Jan 4th, based on a Monday start of week.\n<\/p>", "guessedname": "WEEK_ONE_JAN_DATE", "guessedtype": "property"}, "DAY": {"description": "Constant field representing Day", "static": "", "guessedname": "DAY", "guessedtype": "property", "type": "String", "final": ""}}, "description": "YAHOO.widget.DateMath is used for simple date manipulation. The class is a static utility\nused for adding, subtracting, and comparing dates."}, "YAHOO.util.Color": {"description": "Provides color conversion and validation utils", "namespace": "YAHOO.util", "module": "colorpicker", "guessedname": "Color", "methods": {"hsv2rgb": {"return": {"type": "[int, int, int]", "description": "the red, green, blue values in\ndecimal."}, "params": [{"type": "int|[int, float, float]", "name": "h", "description": " the hue, or an\narray containing all three parameters"}, {"type": "float", "name": "s", "description": " the saturation"}, {"type": "float", "name": "v", "description": " the value\/brightness"}], "description": "Converts HSV (h[0-360], s[0-1]), v[0-1] to RGB [255,255,255]", "guessedname": "hsv2rgb", "guessedtype": "function"}, "websafe": {"return": {"type": "[int, int, int]", "description": "an array containing the closes\nwebsafe rgb colors."}, "params": [{"type": "int|[int, int, int]", "name": "r", "description": " the red value, or an\narray containing all three parameters"}, {"type": "int", "name": "g", "description": " the green value"}, {"type": "int", "name": "b", "description": " the blue value"}], "description": "Returns the closest websafe color to the supplied rgb value.", "guessedname": "websafe", "guessedtype": "function"}, "rgb2hsv": {"return": {"type": "[int, float, float]", "description": "the value converted to hsv"}, "params": [{"type": "int|[int, int, int]", "name": "r", "description": " the red value, or an\narray containing all three parameters"}, {"type": "int", "name": "g", "description": " the green value"}, {"type": "int", "name": "b", "description": " the blue value"}], "description": "Converts to RGB [255,255,255] to HSV (h[0-360], s[0-1]), v[0-1]", "guessedname": "rgb2hsv", "guessedtype": "function"}, "_createHostElement": {"private": "", "description": "Creates the host element if it doesn't exist", "guessedname": "_createHostElement", "guessedtype": "function"}, "hex2dec": {"return": {"type": "int", "description": "the decimal"}, "params": [{"type": "string", "name": "str", "description": " the hex pair to convert"}], "description": "Converts a hex pair 00...FF to an int 0...255", "guessedname": "hex2dec", "guessedtype": "function"}, "rgb2hex": {"return": {"type": "string", "description": "the hex string"}, "params": [{"type": "int|[int, int, int]", "name": "r", "description": " the red value, or an\narray containing all three parameters"}, {"type": "int", "name": "g", "description": " the green value"}, {"type": "int", "name": "b", "description": " the blue value"}], "description": "Converts decimal rgb values into a hex string\n255,255,255 -> FFFFFF", "guessedname": "rgb2hex", "guessedtype": "function"}, "real2dec": {"return": {"type": "int", "description": "a number 0-255"}, "params": [{"type": "float", "name": "n", "description": " the number to convert"}], "description": "Converts 0-1 to 0-255", "guessedname": "real2dec", "guessedtype": "function"}, "dec2hex": {"return": {"type": "string", "description": "the hex equivalent"}, "params": [{"type": "int", "name": "n", "description": " the number to convert"}], "description": "Converts an int 0...255 to hex pair 00...FF", "guessedname": "dec2hex", "guessedtype": "function"}, "hex2rgb": {"return": {"type": "[int, int, int]", "description": "an array containing the rgb values"}, "params": [{"type": "string", "name": "str", "description": " the hex string"}], "description": "Converts a hex string to rgb", "guessedname": "hex2rgb", "guessedtype": "function"}}, "file": "Color.js", "guessedtype": "function", "shortname": "Color", "name": "YAHOO.util.Color"}, "YAHOO.widget.SimpleDialog": {"name": "YAHOO.widget.SimpleDialog", "configs": {"text": {"default": "\"\"", "type": "String", "description": "Sets the text for the SimpleDialog"}, "icon": {"default": "\"none\"", "type": "String", "description": "Sets the informational icon for the SimpleDialog"}}, "constructors": [{"params": [{"type": "String", "name": "el", "description": " The element ID representing the SimpleDialog \n<em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the SimpleDialog"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal containing \nthe configuration that should be set for this SimpleDialog. See \nconfiguration documentation for more details."}], "description": "SimpleDialog is a simple implementation of Dialog that can be used to \nsubmit a single value. Forms can be processed in 3 ways -- via an \nasynchronous Connection utility call, a simple form POST or GET, \nor manually."}], "namespace": "YAHOO.widget", "module": "container", "guessedname": "SimpleDialog", "methods": {"configIcon": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "Fired when the \"icon\" property is set.", "guessedname": "configIcon", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "el", "description": " The element ID representing the SimpleDialog \n<em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the SimpleDialog"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal \ncontaining the configuration that should be set for this \nSimpleDialog. See configuration documentation for more details."}], "description": "The SimpleDialog initialization method, which is executed for \nSimpleDialog and all of its subclasses. This method is automatically \ncalled by the constructor, and sets up all DOM references for \npre-existing markup, and creates required markup if it is not \nalready present.", "guessedname": "init", "guessedtype": "function"}, "setBody": {"params": [{"type": "String", "name": "bodyContent", "description": " The HTML used to set the body. \nAs a convenience, non HTMLElement objects can also be passed into \nthe method, and will be treated as strings, with the body innerHTML\nset to their default toString implementations.\n<em>OR<\/em>"}, {"type": "HTMLElement", "name": "bodyContent", "description": " The HTMLElement to add as the first and only child of the body element.\n<em>OR<\/em>"}, {"type": "DocumentFragment", "name": "bodyContent", "description": " The document fragment \ncontaining elements which are to be added to the body"}], "description": "<p>\nSets the SimpleDialog's body content to the HTML specified. \nIf no body is present, one will be automatically created. \nAn empty string can be passed to the method to clear the contents of the body.\n<\/p>\n<p><strong>NOTE:<\/strong> SimpleDialog provides the <a href=\"#config_text\">text<\/a>\nand <a href=\"#config_icon\">icon<\/a> configuration properties to set the contents\nof it's body element in accordance with the UI design for a SimpleDialog (an \nicon and message text). Calling setBody on the SimpleDialog will not enforce this \nUI design constraint and will replace the entire contents of the SimpleDialog body. \nIt should only be used if you wish the replace the default icon\/text body structure \nof a SimpleDialog with your own custom markup.<\/p>"}, "toString": {"return": {"type": "String", "description": "The string representation of the SimpleDialog"}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "configText": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "Fired when the \"text\" property is set.", "guessedname": "configText", "guessedtype": "function"}, "registerForm": {"description": "Prepares the SimpleDialog's internal FORM object, creating one if one \nis not currently present, and adding the value hidden field.", "guessedname": "registerForm", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be changed \nusing the SimpleDialog's Config object (cfg).", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "extends": "YAHOO.widget.Dialog", "superclass": "YAHOO.widget.Dialog", "file": "SimpleDialog.js", "guessedtype": "function", "shortname": "SimpleDialog", "properties": {"YAHOO.widget.SimpleDialog.CSS_SIMPLEDIALOG": {"description": "Constant representing the default CSS class used for a SimpleDialog", "static": "", "guessedname": "CSS_SIMPLEDIALOG", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_INFO": {"description": "Constant for the standard network icon for info", "static": "", "guessedname": "ICON_INFO", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_CSS_CLASSNAME": {"description": "Constant representing the name of the CSS class applied to the element \ncreated by the \"icon\" configuration property.", "static": "", "guessedname": "ICON_CSS_CLASSNAME", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_BLOCK": {"description": "Constant for the standard network icon for a blocking action", "static": "", "guessedname": "ICON_BLOCK", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_WARN": {"description": "Constant for the standard network icon for warn", "static": "", "guessedname": "ICON_WARN", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_ALARM": {"description": "Constant for the standard network icon for alarm", "static": "", "guessedname": "ICON_ALARM", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_TIP": {"description": "Constant for the standard network icon for a tip", "static": "", "guessedname": "ICON_TIP", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.SimpleDialog.ICON_HELP": {"description": "Constant for the standard network icon for help", "static": "", "guessedname": "ICON_HELP", "guessedtype": "property", "type": "String", "final": ""}, "DEFAULT_CONFIG": {"description": "Constant representing the SimpleDialog's configuration properties", "private": "", "guessedname": "DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}}, "description": "SimpleDialog is a simple implementation of Dialog that can be used to \nsubmit a single value. Forms can be processed in 3 ways -- via an \nasynchronous Connection utility call, a simple form POST or GET, \nor manually."}, "YAHOO.util.Connect": {"name": "YAHOO.util.Connect", "namespace": "YAHOO.util", "module": "connection", "guessedname": "Connect", "methods": {"asyncRequest": {"return": {"type": "object", "description": "Returns the connection object"}, "description": "Method for initiating an asynchronous request via the XHR object.", "static": "", "guessedname": "asyncRequest", "guessedtype": "function", "params": [{"type": "string", "name": "method", "description": " HTTP transaction method"}, {"type": "string", "name": "uri", "description": " Fully qualified path of resource"}, {"type": "callback", "name": "callback", "description": " User-defined callback function or object"}, {"type": "string", "name": "postData", "description": " POST body"}], "public": ""}, "isCallInProgress": {"return": {"type": "boolean", "description": ""}, "description": "Determines if the transaction is still being processed.", "static": "", "guessedname": "isCallInProgress", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object returned by asyncRequest"}], "public": ""}, "createResponseObject": {"return": {"type": "object", "description": ""}, "description": "This method evaluates the server response, creates and returns the results via\nits properties. Success and failure cases will differ in the response\nobject's property values.", "private": "", "static": "", "guessedname": "createResponseObject", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object"}, {"type": "callbackArg", "name": "callbackArg", "description": " The user-defined argument or arguments to be passed to the callback"}]}, "initCustomEvents": {"return": {"type": "void", "description": ""}, "description": "This method creates and subscribes custom events,\nspecific to each transaction", "private": "", "static": "", "guessedname": "initCustomEvents", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object"}, {"type": "callback", "name": "callback", "description": " The user-defined callback object"}]}, "initHeader": {"return": {"type": "void", "description": ""}, "description": "Method that initializes the custom HTTP headers for the each transaction.", "static": "", "guessedname": "initHeader", "guessedtype": "function", "params": [{"type": "string", "name": "label", "description": " The HTTP header label"}, {"type": "string", "name": "value", "description": " The HTTP header value"}, {"type": "string", "name": "isDefault", "description": " Determines if the specific header is a default header\nautomatically sent with each transaction."}], "public": ""}, "setDefaultXhrHeader": {"return": {"type": "", "description": "void"}, "description": "Member to override the default transaction header..", "static": "", "guessedname": "setDefaultXhrHeader", "guessedtype": "function", "params": [{"type": "boolean", "name": "b", "description": " Set and use default header - true or false ."}], "public": ""}, "setForm": {"return": {"type": "string", "description": "string of the HTML form field name and value pairs.."}, "description": "This method assembles the form label and value pairs and\nconstructs an encoded string.\nasyncRequest() will automatically initialize the transaction with a\na HTTP header Content-Type of application\/x-www-form-urlencoded.", "static": "", "guessedname": "setForm", "guessedtype": "function", "params": [{"type": "string || object", "name": "form", "description": " id or name attribute, or form object."}, {"type": "boolean", "name": "optional", "description": " enable file upload."}, {"type": "boolean", "name": "optional", "description": " enable file upload over SSL in IE only."}], "public": ""}, "uploadFile": {"return": {"type": "void", "description": ""}, "description": "Uploads HTML form, inclusive of files\/attachments, using the\niframe created in createFrame to facilitate the transaction.", "private": "", "static": "", "guessedname": "uploadFile", "guessedtype": "function", "params": [{"type": "int", "name": "id", "description": " The transaction id."}, {"type": "object", "name": "callback", "description": " User-defined callback object."}, {"type": "string", "name": "uri", "description": " Fully qualified path of resource."}, {"type": "string", "name": "postData", "description": " POST data to be submitted in addition to HTML form."}]}, "resetFormState": {"return": {"type": "void", "description": ""}, "description": "Resets HTML form properties when an HTML form or HTML form\nwith file upload transaction is sent.", "private": "", "static": "", "guessedname": "resetFormState", "guessedtype": "function"}, "getConnectionObject": {"return": {"type": "object", "description": ""}, "description": "This method is called by asyncRequest to create a\nvalid connection object for the transaction. It also passes a\ntransaction id and increments the transaction id counter.", "private": "", "static": "", "guessedname": "getConnectionObject", "guessedtype": "function"}, "createExceptionObject": {"return": {"type": "object", "description": ""}, "description": "If a transaction cannot be completed due to dropped or closed connections,\nthere may be not be enough information to build a full response object.\nThe failure callback will be fired and this specific condition can be identified\nby a status property value of 0.\nIf an abort was successful, the status property will report a value of -1.", "private": "", "static": "", "guessedname": "createExceptionObject", "guessedtype": "function", "params": [{"type": "int", "name": "tId", "description": " The Transaction Id"}, {"type": "callbackArg", "name": "callbackArg", "description": " The user-defined argument or arguments to be passed to the callback"}, {"type": "boolean", "name": "isAbort", "description": " Determines if the exception case is caused by a transaction abort"}]}, "resetDefaultHeaders": {"return": {"type": "void", "description": ""}, "description": "Resets the default HTTP headers object", "static": "", "guessedname": "resetDefaultHeaders", "guessedtype": "function", "public": ""}, "appendPostData": {"return": {"type": "array", "description": "formElements Collection of hidden fields."}, "description": "Parses the POST data and creates hidden form elements\nfor each key-value, and appends them to the HTML form object.", "private": "", "static": "", "guessedname": "appendPostData", "guessedtype": "function", "params": [{"type": "string", "name": "postData", "description": " The HTTP POST data"}]}, "releaseObject": {"return": {"type": "void", "description": ""}, "description": "Dereference the XHR instance and the connection object after the transaction is completed.", "private": "", "static": "", "guessedname": "releaseObject", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object"}]}, "createXhrObject": {"return": {"type": "", "description": "object"}, "description": "Instantiates a XMLHttpRequest object and returns an object with two properties:\nthe XMLHttpRequest instance and the transaction id.", "private": "", "static": "", "guessedname": "createXhrObject", "guessedtype": "function", "params": [{"type": "int", "name": "transactionId", "description": " Property containing the transaction id for this transaction."}]}, "handleTransactionResponse": {"return": {"type": "void", "description": ""}, "description": "This method attempts to interpret the server response and\ndetermine whether the transaction was successful, or if an error or\nexception was encountered.", "private": "", "static": "", "guessedname": "handleTransactionResponse", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object"}, {"type": "object", "name": "callback", "description": " The user-defined callback object"}, {"type": "boolean", "name": "isAbort", "description": " Determines if the transaction was terminated via abort()."}]}, "createFrame": {"return": {"type": "void", "description": ""}, "description": "Creates an iframe to be used for form file uploads. It is remove from the\ndocument upon completion of the upload transaction.", "private": "", "static": "", "guessedname": "createFrame", "guessedtype": "function", "params": [{"type": "string", "name": "optional", "description": " qualified path of iframe resource for SSL in IE."}]}, "handleReadyState": {"return": {"type": "void", "description": ""}, "description": "This method serves as a timer that polls the XHR object's readyState\nproperty during a transaction, instead of binding a callback to the\nonreadystatechange event. Upon readyState 4, handleTransactionResponse\nwill process the response, and the timer will be cleared.", "private": "", "static": "", "guessedname": "handleReadyState", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object"}, {"type": "callback", "name": "callback", "description": " The user-defined callback object"}]}, "setDefaultPostHeader": {"return": {"type": "", "description": "void"}, "description": "Member to override the default POST header.", "static": "", "guessedname": "setDefaultPostHeader", "guessedtype": "function", "params": [{"type": "boolean", "name": "b", "description": " Set and use default header - true or false ."}], "public": ""}, "abort": {"return": {"type": "boolean", "description": ""}, "description": "Method to terminate a transaction, if it has not reached readyState 4.", "static": "", "guessedname": "abort", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object returned by asyncRequest."}, {"type": "object", "name": "callback", "description": " User-defined callback object."}, {"type": "string", "name": "isTimeout", "description": " boolean to indicate if abort resulted from a callback timeout."}], "public": ""}, "setProgId": {"return": {"type": "", "description": "void"}, "description": "Member to add an ActiveX id to the existing xml_progid array.\nIn the event(unlikely) a new ActiveX id is introduced, it can be added\nwithout internal code modifications.", "static": "", "guessedname": "setProgId", "guessedtype": "function", "params": [{"type": "string", "name": "id", "description": " The ActiveX id to be added to initialize the XHR object."}], "public": ""}, "setPollingInterval": {"return": {"type": "", "description": "void"}, "description": "Member to modify the default polling interval.", "static": "", "guessedname": "setPollingInterval", "guessedtype": "function", "params": [{"type": "int", "name": "i", "description": " The polling interval in milliseconds."}], "public": ""}, "setHeader": {"return": {"type": "void", "description": ""}, "description": "Accessor that sets the HTTP headers for each transaction.", "private": "", "static": "", "guessedname": "setHeader", "guessedtype": "function", "params": [{"type": "object", "name": "o", "description": " The connection object for the transaction."}]}}, "file": "connection.js", "guessedtype": "property", "shortname": "Connect", "properties": {"successEvent": {"description": "Custom event that fires when handleTransactionResponse() determines a\nresponse in the HTTP 2xx range.", "private": "", "static": "", "guessedname": "successEvent", "guessedtype": "property", "type": "CustomEvent"}, "_default_xhr_header": {"description": "The default header value for the label\n\"X-Requested-With\". This is sent with each\ntransaction, by default, to identify the\nrequest as being made by YUI Connection Manager.", "private": "", "static": "", "guessedname": "_default_xhr_header", "guessedtype": "property", "type": "boolean"}, "completeEvent": {"description": "Custom event that fires when a transaction response has completed.", "private": "", "static": "", "guessedname": "completeEvent", "guessedtype": "property", "type": "CustomEvent"}, "_polling_interval": {"description": "The polling frequency, in milliseconds, for HandleReadyState.\nwhen attempting to determine a transaction's XHR readyState.\nThe default is 50 milliseconds.", "private": "", "static": "", "guessedname": "_polling_interval", "guessedtype": "property", "type": "int"}, "_formNode": {"description": "Property modified by setForm() to set a reference to the HTML\nform node if the desired action is file upload.", "private": "", "static": "", "guessedname": "_formNode", "guessedtype": "property", "type": "object"}, "_msxml_progid": {"description": "Array of MSFT ActiveX ids for XMLHttpRequest.", "private": "", "static": "", "guessedname": "_msxml_progid", "guessedtype": "property", "type": "array"}, "_http_header": {"description": "Object literal of HTTP header(s)", "private": "", "static": "", "guessedname": "_http_headers", "guessedtype": "property", "type": "object"}, "_sFormData": {"description": "Property modified by setForm() to set the HTML form data\nfor each transaction.", "private": "", "static": "", "guessedname": "_sFormData", "guessedtype": "property", "type": "string"}, "_default_post_header": {"description": "The default header used for POST transactions.", "private": "", "static": "", "guessedname": "_default_post_header", "guessedtype": "property", "type": "boolean"}, "_isFormSubmit": {"description": "Property modified by setForm() to determine if the data\nshould be submitted as an HTML form.", "private": "", "static": "", "guessedname": "_isFormSubmit", "guessedtype": "property", "type": "boolean"}, "_has_default_header": {"description": "Determines if custom, default headers\nare set for each transaction.", "private": "", "static": "", "guessedname": "_has_default_headers", "guessedtype": "property", "type": "boolean"}, "_hasSubmitListener": {"guessedname": "_hasSubmitListener", "static": "", "description": "Determines whether YAHOO.util.Event is available and returns true or false.\nIf true, an event listener is bound at the document level to trap click events that\nresolve to a target type of \"Submit\". This listener will enable setForm() to determine\nthe clicked \"Submit\" value in a multi-Submit button, HTML form.", "private": "", "guessedtype": "function"}, "_default_form_header": {"description": "The default header used for transactions involving the\nuse of HTML forms.", "private": "", "static": "", "guessedname": "_default_form_header", "guessedtype": "property", "type": "boolean"}, "_use_default_xhr_header": {"description": "Determines if a default header of\n'X-Requested-With: XMLHttpRequest'\nwill be added to each transaction.", "private": "", "static": "", "guessedname": "_use_default_xhr_header", "guessedtype": "property", "type": "boolean"}, "_poll": {"description": "Collection of polling references to the polling mechanism in handleReadyState.", "private": "", "static": "", "guessedname": "_poll", "guessedtype": "property", "type": "object"}, "_timeOut": {"description": "Queue of timeout values for each transaction callback with a defined timeout value.", "private": "", "static": "", "guessedname": "_timeOut", "guessedtype": "property", "type": "object"}, "abortEvent": {"description": "Custom event that fires when a transaction is successfully aborted.", "private": "", "static": "", "guessedname": "abortEvent", "guessedtype": "property", "type": "CustomEvent"}, "_transaction_id": {"description": "A transaction counter that increments the transaction id for each transaction.", "private": "", "static": "", "guessedname": "_transaction_id", "guessedtype": "property", "type": "int"}, "failureEvent": {"description": "Custom event that fires when handleTransactionResponse() determines a\nresponse in the HTTP 4xx\/5xx range.", "private": "", "static": "", "guessedname": "failureEvent", "guessedtype": "property", "type": "CustomEvent"}, "_use_default_post_header": {"description": "Determines if a default header of\nContent-Type of 'application\/x-www-form-urlencoded'\nwill be added to any client HTTP headers sent for POST\ntransactions.", "private": "", "static": "", "guessedname": "_use_default_post_header", "guessedtype": "property", "type": "boolean"}, "_customEvents": {"description": "A reference table that maps callback custom events members to its specific\nevent name.", "private": "", "static": "", "guessedname": "_customEvents", "guessedtype": "property", "type": "object"}, "startEvent": {"description": "Custom event that fires at the start of a transaction", "private": "", "static": "", "guessedname": "startEvent", "guessedtype": "property", "type": "CustomEvent"}, "_isFileUpload": {"description": "Property modified by setForm() to determine if a file(s)\nupload is expected.", "private": "", "static": "", "guessedname": "_isFileUpload", "guessedtype": "property", "type": "boolean"}, "_has_http_headers": {"description": "Determines if HTTP headers are set.", "private": "", "static": "", "guessedname": "_has_http_headers", "guessedtype": "property", "type": "boolean"}, "_submitElementValue": {"description": "Tracks the name-value pair of the \"clicked\" submit button if multiple submit\nbuttons are present in an HTML form; and, if YAHOO.util.Event is available.", "private": "", "static": "", "guessedname": "_submitElementValue", "guessedtype": "property", "type": "string"}}, "description": "The Connection Manager singleton provides methods for creating and managing\nasynchronous transactions."}, "YAHOO.widget.LineChart": {"name": "YAHOO.widget.LineChart", "constructors": [{"params": [{"type": "HTMLElement", "name": "containerId", "description": " Container element for the Flash Player instance."}, {"type": "YAHOO.util.DataSource", "name": "dataSource", "description": " DataSource instance."}, {"type": "object", "name": "attributes", "description": " (optional) Object literal of configuration values."}], "description": "LineChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "LineChart", "uses": ["YAHOO.widget.CartesianChart"], "file": "ChartTypes.js", "guessedtype": "function", "shortname": "LineChart", "description": "LineChart class for the YUI Charts widget."}, "YAHOO.widget.FlashAdapter": {"name": "YAHOO.widget.FlashAdapter", "configs": {"altText": {"type": "String", "description": "The alternative text to provide for screen readers and other assistive technology."}, "version": {"type": "String", "description": "Minimum required version for the SWF file. Only available in the constructor because it may not be\nset after Flash Player has been embedded in the page."}, "swfURL": {"type": "String", "description": "Absolute or relative URL to the SWF displayed by the FlashAdapter. Only available in the constructor because it may not be\nset after Flash Player has been embedded in the page."}, "expressInstall": {"type": "String", "description": "URL pointing to a SWF file that handles Flash Player's express\ninstall feature. Only available in the constructor because it may not be\nset after Flash Player has been embedded in the page."}, "wmode": {"type": "String", "description": "Sets the window mode of the Flash Player control. May be\n\"window\", \"opaque\", or \"transparent\". Only available in the constructor\nbecause it may not be set after Flash Player has been embedded in the page."}, "backgroundColor": {"type": "String", "description": "The background color of the SWF. Only available in the constructor because it may not be\nset after Flash Player has been embedded in the page."}}, "namespace": "YAHOO.widget", "module": "uploader", "properties": {"_swfURL": {"guessedname": "_swfURL", "type": "String", "description": "The URL of the SWF file.", "private": "", "guessedtype": "property"}, "_initialized": {"guessedname": "_initialized", "type": "Boolean", "description": "Indicates whether the SWF has been initialized and is ready\nto communicate with JavaScript", "private": "", "guessedtype": "property"}, "_attributes": {"guessedname": "_attributes", "type": "Object", "description": "The initializing attributes are stored here until the SWF is ready.", "private": "", "guessedtype": "property"}, "_containerID": {"guessedname": "_containerID", "type": "String", "description": "The ID of the containing DIV.", "private": "", "guessedtype": "property"}, "_swf": {"private": "", "description": "A reference to the embedded SWF file.", "guessedname": "_swf", "guessedtype": "property"}, "_id": {"guessedname": "_id", "type": "String", "description": "The id of this instance.", "private": "", "guessedtype": "property"}, "proxyFunctionCount": {"guessedname": "proxyFunctionCount", "static": "", "description": "The number of proxy functions that have been created.", "private": "", "guessedtype": "property"}}, "guessedname": "FlashAdapter", "methods": {"_loadHandler": {"private": "", "description": "Called when the SWF has been initialized.", "guessedname": "_loadHandler", "guessedtype": "function"}, "YAHOO.widget.FlashAdapter.createProxyFunction": {"guessedname": "createProxyFunction", "static": "", "description": "Creates a globally accessible function that wraps a function reference.\nReturns the proxy function's name as a string for use by the SWF through\nExternalInterface.", "private": "", "guessedtype": "function"}, "YAHOO.widget.FlashAdapter.removeProxyFunction": {"guessedname": "removeProxyFunction", "static": "", "description": "Removes a function created with createProxyFunction()", "private": "", "guessedtype": "function"}, "_initAttributes": {"private": "", "description": "Initializes the attributes.", "guessedname": "_initAttributes", "guessedtype": "function"}, "_getAltText": {"private": "", "description": "Getter for altText attribute.", "guessedname": "_getAltText", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the FlashAdapter instance."}, "description": "Public accessor to the unique name of the FlashAdapter instance.", "guessedname": "toString", "guessedtype": "function"}, "YAHOO.widget.FlashAdapter.eventHandler": {"guessedname": "eventHandler", "static": "", "description": "Receives event messages from SWF and passes them to the correct instance\nof FlashAdapter.", "private": "", "guessedtype": "function"}, "_eventHandler": {"private": "", "description": "Handles or re-dispatches events received from the SWF.", "guessedname": "_eventHandler", "guessedtype": "function"}, "_embedSWF": {"private": "", "description": "Embeds the SWF in the page and associates it with this instance.", "guessedname": "_embedSWF", "guessedtype": "function"}, "_getSWFURL": {"private": "", "description": "Getter for swfURL attribute.", "guessedname": "_getSWFURL", "guessedtype": "function"}, "destroy": {"description": "Nulls out the entire FlashAdapter instance and related objects and removes attached\nevent listeners and clears out DOM elements inside the container. After calling\nthis method, the instance reference should be expliclitly nulled by implementer,\nas in myChart = null. Use with caution!", "guessedname": "destroy", "guessedtype": "function"}, "_setAltText": {"private": "", "description": "Setter for altText attribute.", "guessedname": "_setAltText", "guessedtype": "function"}}, "uses": ["YAHOO.util.AttributeProvider"], "file": "FlashAdapter.js", "guessedtype": "function", "shortname": "FlashAdapter", "events": {"contentReady": {"description": "Fires when the SWF is initialized and communication is possible."}, "backgroundColorChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "backgroundColorChange", "description": "Fires when the value for the configuration attribute 'backgroundColor' changes."}, "altTextChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "altTextChange", "description": "Fires when the value for the configuration attribute 'altText' changes."}, "swfURLChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "swfURLChange", "description": "Fires when the value for the configuration attribute 'swfURL' changes."}, "beforeBackgroundColorChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeBackgroundColorChange", "description": "Fires before the value for the configuration attribute 'backgroundColor' changes. Return false to cancel the attribute change."}, "beforeWmodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeWmodeChange", "description": "Fires before the value for the configuration attribute 'wmode' changes. Return false to cancel the attribute change."}, "beforeExpressInstallChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeExpressInstallChange", "description": "Fires before the value for the configuration attribute 'expressInstall' changes. Return false to cancel the attribute change."}, "beforeAltTextChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeAltTextChange", "description": "Fires before the value for the configuration attribute 'altText' changes. Return false to cancel the attribute change."}, "versionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "versionChange", "description": "Fires when the value for the configuration attribute 'version' changes."}, "wmodeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "wmodeChange", "description": "Fires when the value for the configuration attribute 'wmode' changes."}, "beforeVersionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeVersionChange", "description": "Fires before the value for the configuration attribute 'version' changes. Return false to cancel the attribute change."}, "expressInstallChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "expressInstallChange", "description": "Fires when the value for the configuration attribute 'expressInstall' changes."}, "beforeSwfURLChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSwfURLChange", "description": "Fires before the value for the configuration attribute 'swfURL' changes. Return false to cancel the attribute change."}}, "description": "Wraps Flash embedding functionality and allows communication with SWF through\nattributes."}, "YAHOO.util.Date": {"name": "YAHOO.util.Date", "namespace": "YAHOO.util", "module": "datasource", "guessedname": "Dt", "methods": {"format": {"return": {"type": "String", "description": "Formatted date for display."}, "description": "Takes a native JavaScript Date and formats to string for display to user.", "guessedtype": "function", "params": [{"type": "Date", "name": "oDate", "description": " Date."}, {"type": "Object} (Optional) Optional configuration values:\n<dl>\n<dt>format {String", "name": "oConfig", "description": " <\/dt>\n<dd>Any format defined by strftime is supported<\/dd>\n<\/dl>\nstrftime has several format specifiers defined by the Open group at \nhttp:\/\/www.opengroup.org\/onlinepubs\/007908799\/xsh\/strftime.html\nPHP added a few of its own, defined at http:\/\/www.php.net\/strftime\nThis javascript implementation supports all the PHP specifiers and a few more."}, {"type": "String", "name": "sLocale", "description": " (Optional) The locale to use when displaying days of week,\nmonths of the year, and other locale specific strings. The following locales are\nbuilt in:\n<dl>\n<dt>en<\/dt>\n<dd>English<\/dd>\n<dt>en-US<\/dt>\n<dd>US English<\/dd>\n<dt>en-GB<\/dt>\n<dd>British English<\/dd>\n<dt>en-AU<\/dt>\n<dd>Australian English (identical to British English)<\/dd>\n<\/dl>\nMore locales may be added by subclassing of YAHOO.util.DateLocale.\nSee YAHOO.util.DateLocale for more information."}], "guessedname": "format", "arg": "\\%a - abbreviated weekday name according to the current locale", "sa": "YAHOO.util.DateLocale"}}, "static": "", "file": "Type.js", "guessedtype": "property", "shortname": "Date", "requires": "yahoo", "description": "The static Date class provides helper functions to deal with data of type Date."}, "YAHOO.widget.StackedColumnSeries": {"name": "YAHOO.widget.StackedColumnSeries", "constructors": [{"description": "StackedColumnSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "StackedColumnSeries", "file": "Series.js", "guessedtype": "function", "shortname": "StackedColumnSeries", "description": "StackedColumnSeries class for the YUI Charts widget."}, "JSON": {"name": "JSON", "namespace": "", "module": "json", "guessedname": "JSON", "methods": {"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|Function", "name": "w", "description": " (optional) whitelist of acceptable object keys to include OR a function(value,key) to alter values before serialization"}, {"type": "number", "name": "d", "description": " (optional) depth limit to recurse objects\/arrays (practical minimum 1)"}]}, "_prepare": {"return": {"type": "String", "description": "sanitized JSON string ready to be validated\/parsed"}, "params": [{"type": "String", "name": "s", "description": " parse input"}], "description": "Replace certain Unicode characters that may be handled incorrectly by\nsome browser implementations.", "private": ""}, "isValid": {"return": {"type": "boolean", "description": "is the string safe for eval?"}, "description": "Four step determination whether a string is valid JSON. In three steps,\nescape sequences, safe values, and properly placed open square brackets\nare replaced with placeholders or removed. Then in the final step, the\nresult of all these replacements is checked for invalid characters.", "static": "", "guessedname": "isValid", "guessedtype": "function", "params": [{"type": "String", "name": "str", "description": " JSON string to be tested"}]}, "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"}]}, "parse": {"return": {"type": "MIXED", "description": "the native JavaScript representation of the JSON string"}, "description": "Parse a JSON string, returning the native JavaScript representation.\nOnly minor modifications from http:\/\/www.json.org\/json2.js.", "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\npair of object literals, allowing pruning or altering values"}], "throws": "SyntaxError"}, "_char": {"return": {"type": "String", "description": "safe Unicode escape"}, "params": [{"type": "String", "name": "c", "description": " single character to escape"}], "description": "Escapes a special character to a safe Unicode representation"}, "_stringify": {"return": {"type": "String", "description": "serialized version of o"}, "params": [{"type": "Object", "name": "h", "description": " object holding the key"}, {"type": "String", "name": "key", "description": " String key in object h to serialize"}, {"type": "Number", "name": "depth", "description": " depth to serialize"}, {"type": "Array|Function", "name": "w", "description": " array of whitelisted keys OR replacer function"}, {"type": "Array", "name": "pstack", "description": " used to protect against recursion"}], "description": "Worker function used by public stringify."}, "_string": {"return": {"type": "String", "description": "'\"'+s+'\"' after s has had special characters escaped"}, "params": [{"type": "String", "name": "s", "description": " string to wrap"}], "description": "Enclose escaped strings in quotes", "private": ""}, "stringToDate": {"return": {"type": "Date", "description": ""}, "params": [{"type": "String", "name": "str", "description": " String serialization of a Date"}], "description": "Reconstitute Date instances from the default JSON UTC serialization.\nReference this from a reviver function to rebuild Dates during the\nparse operation.", "guessedname": "stringToDate", "guessedtype": "function"}, "_isValid": {"return": {"type": "boolean", "description": "is the string safe for eval?"}, "static": "", "params": [{"type": "String", "name": "str", "description": " JSON string to be tested"}], "description": "Four step determination whether a string is valid JSON. In three steps,\nescape sequences, safe values, and properly placed open square brackets\nare replaced with placeholders or removed. Then in the final step, the\nresult of all these replacements is checked for invalid characters."}, "_revive": {"return": {"type": "MIXED", "description": "The results of the filtered\/mutated data structure"}, "params": [{"type": "MIXED", "name": "data", "description": " Any JavaScript data"}, {"type": "Function", "name": "reviver", "description": " filter or mutation function"}], "description": "Traverses nested objects, applying a filter or reviver function to\neach value. The value returned from the function will replace the\noriginal value in the key:value pair. If the value returned is\nundefined, the key will be omitted from the returned object.", "private": ""}}, "static": "", "file": "JSON.js", "guessedtype": "function", "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}"}, "_VALUES": {"description": "Second step in the validation. Regex used to replace all simple\nvalues with ']' characters.", "private": "", "static": "", "guessedname": "_VALUES", "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}"}, "_UNICODE_EXCEPTIONS": {"guessedname": "_UNICODE_EXCEPTIONS", "type": "{RegExp}", "description": "Replace certain Unicode characters that JavaScript may handle incorrectly\nduring eval--either by deleting them or treating them as line\nendings--with escape sequences.\nIMPORTANT NOTE: This regex will be used to modify the input if a match is\nfound.", "private": "", "guessedtype": "property"}}, "description": "Provides methods to parse JSON strings and convert objects to JSON strings."}, "YAHOO.util.YUILoader": {"name": "YAHOO.util.YUILoader", "namespace": "YAHOO.util", "module": "yuiloader", "methods": {"_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"}, "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"}, "onProgress": {"type": "function", "description": "Callback that will be executed each time a new module is loaded", "guessedname": "onProgress", "guessedtype": "property"}, "onTimeout": {"type": "function", "description": "Callback that will be executed if a timeout occurs", "guessedname": "onTimeout", "guessedtype": "property"}, "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"}, "_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"}, "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"}, "_filter": {"guessedname": "_filter", "return": {"type": "string", "description": "the filtered string"}, "description": "Applies filter\nmethod _filter", "private": "", "guessedtype": "function"}, "_addSkin": {"return": {"type": "string", "description": "the module name for the skin"}, "description": "Adds the skin def to the module info", "private": "", "params": [{"type": "string", "name": "skin", "description": " the name of the skin"}, {"type": "string", "name": "mod", "description": " the name of the module"}], "guessedname": "_addSkin", "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"}, "formatSkin": {"return": {"type": "string", "description": "the full skin module name"}, "params": [{"type": "string", "name": "skin", "description": " the name of the skin"}, {"type": "string", "name": "mod", "description": " optional: the name of a module to skin"}], "description": "Returns the skin module name for the specified skin name. If a\nmodule name is supplied, the returned skin module name is \nspecific to the module passed in.", "guessedname": "formatSkin", "guessedtype": "function"}, "parseSkin": {"return": {"type": "skin: string, module: string", "description": "the parsed skin name \nand module name, or null if the supplied string does not match\nthe skin pattern"}, "params": [{"type": "string", "name": "mod", "description": " the module name to parse"}], "description": "Reverses <code>formatSkin<\/code>, providing the skin name and\nmodule name if the string matches the pattern for skins.", "guessedname": "parseSkin", "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"}], "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"}, "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\nYAHOO.register to determine when scripts are fully loaded", "guessedname": "loadNext", "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"}, "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"}, "_sort": {"private": "", "description": "Sorts the dependency tree. The last step of calculate()", "guessedname": "_sort", "guessedtype": "function"}, "onFailure": {"type": "function", "description": "Callback that will be executed if there is a failure", "guessedname": "onFailure", "guessedtype": "property"}, "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"}, "_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"}, "onSuccess": {"type": "function", "description": "Callback that will be executed when the loader is finished\nwith an insert", "guessedname": "onSuccess", "guessedtype": "property"}, "sandbox": {"params": [{"type": "Function", "name": "callback", "description": " the callback to exectued when the load is\ncomplete."}], "description": "Interns the script for the requested modules. The callback is\nprovided a reference to the sandboxed YAHOO object. This only\napplies to the script: css can not be sandboxed; css will be\nloaded into the page normally if specified.", "guessedname": "sandbox", "guessedtype": "function"}, "_skin": {"guessedname": "_skin", "deprecated": "skin modules are generated for all skinnable\ncomponents during _setup(), and the components\nare configured to require the skin.", "description": "Sets up the requirements for the skin assets if any of the\nrequested modules are skinnable", "private": "", "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"}}, "file": "yuiloader.js", "shortname": "YUILoader", "todo": "version management, automatic sandboxing", "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"}, "varName": {"type": "string", "description": "The name of the variable in a sandbox or script node \n(for external script support in Safari 2.x and earlier)\nto reference when the load is complete. If this variable \nis not available in the specified scripts, the operation will \nfail.", "guessedname": "Name", "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"}, "skin": {"description": "Provides the information used to skin the skinnable components.\nThe following skin definition would result in 'skin1' and 'skin2'\nbeing loaded for calendar (if calendar was requested), and\n'sam' for all other skinnable components:\n<code>\nskin: {\n\/\/ The default skin, which is automatically applied if not\n\/\/ overriden by a component-specific skin definition.\n\/\/ Change this in to apply a different skin globally\ndefaultSkin: 'sam', \n\/\/ This is combined with the loader base property to get\n\/\/ the default root directory for a skin. ex:\n\/\/ http:\/\/yui.yahooapis.com\/2.3.0\/build\/assets\/skins\/sam\/\nbase: 'assets\/skins\/',\n\/\/ The name of the rollup css file for the skin\npath: 'skin.css',\n\/\/ The number of skinnable components requested that are\n\/\/ required before using the rollup file rather than the\n\/\/ individual component css files\nrollup: 3,\n\/\/ Any component-specific overrides can be specified here,\n\/\/ making it possible to load different skins for different\n\/\/ components. It is possible to load more than one skin\n\/\/ for a given component as well.\noverrides: {\ncalendar: ['skin1', 'skin2']\n}\n}\n<\/code>", "guessedname": "self", "guessedtype": "property"}, "loaded": {"type": "{string: boolean}", "propery": "loaded", "description": "Set when beginning to compute the dependency tree. \nComposed of what YAHOO 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"}, "combine": {"default": "false", "type": "boolean", "description": "If configured, YUI will use the the combo handler on the\nYahoo! CDN to pontentially reduce the number of http requests\nrequired."}, "moduleInfo": {"description": "The library metadata", "guessedname": "moduleInfo", "guessedtype": "property"}, "scope": {"default": "this", "description": "The execution scope for all callbacks", "guessedname": "scope", "guessedtype": "property"}, "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).\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: { \n'searchExp': \"-min\\\\.js\", \n'replaceStr': \"-debug.js\"\n}\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"}, "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 YAHOO 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"}}, "description": "YUILoader provides dynamic loading for YUI."}, "YAHOO.widget.ColorPicker": {"name": "YAHOO.widget.ColorPicker", "configs": {"blue": {"type": "int", "description": "The current blue value 0-255"}, "hue": {"type": "int", "description": "The current hue value 0-360"}, "saturation": {"type": "int", "description": "The current saturation value 0-100"}, "pickersize": {"default": "180", "type": "int", "description": "The size of the picker. Trying to change this is not recommended."}, "container": {"type": "YAHOO.widget.Panel", "description": "If the color picker will live inside of a container object,\nset, provide a reference to it so the control can use the\ncontainer's events."}, "showrgbcontrols": {"default": "true", "type": "boolean", "description": "Hide\/show the rgb controls"}, "showhsvcontrols": {"default": "false", "type": "boolean", "description": "Hide\/show the hsv controls"}, "hex": {"readonly": "", "type": "string", "description": "The current hex value #000000-#FFFFFF, without the #"}, "ids": {"type": "{referenceid: realid}", "description": "A list of element ids and\/or element references used by the \ncontrol. The default is the this.ID list, and can be customized\nby passing a list in the contructor", "writeonce": ""}, "value": {"type": "int", "description": "The current value\/brightness value 0-100"}, "showwebsafe": {"default": "true", "type": "boolean", "description": "Hide\/show the websafe swatch"}, "showhexsummary": {"default": "true", "type": "boolean", "description": "Hide\/show the hex summary"}, "elements": {"readonly": "", "type": "{id: HTMLElement}", "description": "The element refs used by this control. Set at initialization"}, "green": {"type": "int", "description": "The current green value 0-255"}, "websafe": {"type": "int", "description": "The closest current websafe value"}, "images": {"type": "{key: image}", "description": "The img src default list\nis this.IMAGES", "writeonce": ""}, "txt": {"type": "{key: txt}", "description": "A list of txt strings for internationalization. Default\nis this.TXT", "writeonce": ""}, "showcontrols": {"default": "true", "type": "boolean", "description": "Hide\/show the entire set of controls"}, "red": {"type": "int", "description": "The current red value 0-255"}, "showhexcontrols": {"default": "true", "type": "boolean", "description": "Hide\/show the hex controls"}}, "constructors": [{"params": [{"type": "HTMLElement | String | Object", "name": "el(optional)", "description": " The html \nelement that represents the colorpicker, or the attribute object to use. \nAn element will be created if none provided."}, {"type": "Object", "name": "attr", "description": " (optional) A key map of the colorpicker's \ninitial attributes. Ignored if first arg is attributes object."}], "description": "A widget to select colors"}], "namespace": "YAHOO.widget", "module": "colorpicker", "events": {"websafeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "websafeChange", "description": "Fires when the value for the configuration attribute 'websafe' changes."}, "beforeShowcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowcontrolsChange", "description": "Fires before the value for the configuration attribute 'showcontrols' changes. Return false to cancel the attribute change."}, "beforeShowhsvcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowhsvcontrolsChange", "description": "Fires before the value for the configuration attribute 'showhsvcontrols' changes. Return false to cancel the attribute change."}, "saturationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "saturationChange", "description": "Fires when the value for the configuration attribute 'saturation' changes."}, "showhexsummaryChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showhexsummaryChange", "description": "Fires when the value for the configuration attribute 'showhexsummary' changes."}, "beforeSaturationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSaturationChange", "description": "Fires before the value for the configuration attribute 'saturation' changes. Return false to cancel the attribute change."}, "beforeShowwebsafeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowwebsafeChange", "description": "Fires before the value for the configuration attribute 'showwebsafe' changes. Return false to cancel the attribute change."}, "showhexcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showhexcontrolsChange", "description": "Fires when the value for the configuration attribute 'showhexcontrols' changes."}, "containerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "containerChange", "description": "Fires when the value for the configuration attribute 'container' changes."}, "beforeImagesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeImagesChange", "description": "Fires before the value for the configuration attribute 'images' changes. Return false to cancel the attribute change."}, "imagesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "imagesChange", "description": "Fires when the value for the configuration attribute 'images' changes."}, "showrgbcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showrgbcontrolsChange", "description": "Fires when the value for the configuration attribute 'showrgbcontrols' changes."}, "redChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "redChange", "description": "Fires when the value for the configuration attribute 'red' changes."}, "beforeBlueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeBlueChange", "description": "Fires before the value for the configuration attribute 'blue' changes. Return false to cancel the attribute change."}, "idsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "idsChange", "description": "Fires when the value for the configuration attribute 'ids' changes."}, "beforeRedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRedChange", "description": "Fires before the value for the configuration attribute 'red' changes. Return false to cancel the attribute change."}, "beforeIdsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeIdsChange", "description": "Fires before the value for the configuration attribute 'ids' changes. Return false to cancel the attribute change."}, "beforeGreenChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeGreenChange", "description": "Fires before the value for the configuration attribute 'green' changes. Return false to cancel the attribute change."}, "showcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showcontrolsChange", "description": "Fires when the value for the configuration attribute 'showcontrols' changes."}, "beforeShowhexcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowhexcontrolsChange", "description": "Fires before the value for the configuration attribute 'showhexcontrols' changes. Return false to cancel the attribute change."}, "beforeHueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHueChange", "description": "Fires before the value for the configuration attribute 'hue' changes. Return false to cancel the attribute change."}, "beforeTxtChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTxtChange", "description": "Fires before the value for the configuration attribute 'txt' changes. Return false to cancel the attribute change."}, "beforePickersizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePickersizeChange", "description": "Fires before the value for the configuration attribute 'pickersize' changes. Return false to cancel the attribute change."}, "beforeShowhexsummaryChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowhexsummaryChange", "description": "Fires before the value for the configuration attribute 'showhexsummary' changes. Return false to cancel the attribute change."}, "hexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hexChange", "description": "Fires when the value for the configuration attribute 'hex' changes."}, "valueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "valueChange", "description": "Fires when the value for the configuration attribute 'value' changes."}, "beforeHexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHexChange", "description": "Fires before the value for the configuration attribute 'hex' changes. Return false to cancel the attribute change."}, "pickersizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pickersizeChange", "description": "Fires when the value for the configuration attribute 'pickersize' changes."}, "txtChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "txtChange", "description": "Fires when the value for the configuration attribute 'txt' changes."}, "hueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hueChange", "description": "Fires when the value for the configuration attribute 'hue' changes."}, "beforeValueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeValueChange", "description": "Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change."}, "greenChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "greenChange", "description": "Fires when the value for the configuration attribute 'green' changes."}, "beforeElementsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous 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."}, "beforeWebsafeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeWebsafeChange", "description": "Fires before the value for the configuration attribute 'websafe' changes. Return false to cancel the attribute change."}, "blueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "blueChange", "description": "Fires when the value for the configuration attribute 'blue' changes."}, "showhsvcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showhsvcontrolsChange", "description": "Fires when the value for the configuration attribute 'showhsvcontrols' changes."}, "beforeContainerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContainerChange", "description": "Fires before the value for the configuration attribute 'container' changes. Return false to cancel the attribute change."}, "elementsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "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."}, "showwebsafeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showwebsafeChange", "description": "Fires when the value for the configuration attribute 'showwebsafe' changes."}, "beforeShowrgbcontrolsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowrgbcontrolsChange", "description": "Fires before the value for the configuration attribute 'showrgbcontrols' changes. Return false to cancel the attribute change."}}, "guessedname": "ColorPicker", "methods": {"_hexFieldKeypress": {"description": "Use the value of the text field to update the control", "param": "e {Event} the keypress event", "params": [{"type": "Event", "name": "e", "description": " an event"}, {"type": "HTMLElement", "name": "el", "description": " the field"}, {"type": "string", "name": "prop", "description": " the key to the linked property"}], "private": "", "guessedname": "_useFieldValue", "guessedtype": "function"}, "_updateRGBFromHSV": {"private": "", "description": "Updates the RGB values from the current state of the HSV\nvalues. Executed when the one of the HSV form fields are\nupdated\n_updateRGBFromHSV", "guessedname": "_updateRGBFromHSV", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "", "name": "attr", "description": " An object containing default attribute values"}], "description": "Sets up the config attributes and the change listeners for this\nproperties", "guessedname": "initAttributes", "guessedtype": "function"}, "_onHueSliderChange": {"guessedname": "_onHueSliderChange", "params": [{"type": "int", "name": "newOffset", "description": " pixels from the start position"}], "description": "Event handler for the hue slider.", "private": "", "guessedtype": "function"}, "_updatePickerSlider": {"private": "", "description": "Moves the picker slider into the position dictated by the current state\nof the control", "guessedname": "_updatePickerSlider", "guessedtype": "function"}, "_updateRGB": {"private": "", "description": "Updates the rgb attribute with the current state of the r,g,b\nfields. This is invoked from change listeners on these\nattributes to facilitate updating these values from the\nindividual form fields", "guessedname": "_updateRGB", "guessedtype": "function"}, "_numbersOnly": {"return": {"type": "boolean", "description": "false if we are canceling the event"}, "description": "Allows numbers and special chars only. Used for the\nrgb and hsv fields keypress handler.", "private": "", "params": [{"type": "Event", "name": "e", "description": " the event"}], "guessedname": "_numbersOnly", "guessedtype": "function"}, "getElement": {"return": {"type": "HTMLElement", "description": "a reference to the element"}, "params": [{"type": "string", "name": "id", "description": " the element id, or key"}], "description": "Returns the element reference that is saved. The id can be either\nthe element id, or the key for this id in the \"id\" config attribute.\nFor instance, the host element id can be obtained by passing its\nid (default: \"yui_picker\") or by its key \"YUI_PICKER\".", "guessedname": "getElement", "guessedtype": "function"}, "_updateSwatch": {"private": "", "description": "Updates the background of the swatch with the current rbg value.\nAlso updates the websafe swatch to the closest websafe color", "guessedname": "_updateSwatch", "guessedtype": "function"}, "_updateSliders": {"private": "", "description": "Moves the sliders into the position dictated by the current state\nof the control", "guessedname": "_updateSliders", "guessedtype": "function"}, "_onPickerSliderChange": {"guessedname": "_onPickerSliderChange", "params": [{"type": "{x: int, y: int}", "name": "newOffset", "description": " x\/y pixels from the start position"}], "description": "Event handler for the picker slider, which controls the\nsaturation and value\/brightness.", "private": "", "guessedtype": "function"}, "_getCommand": {"return": {"type": "int", "description": "a command code\n<ul>\n<li>0 = not a number, letter in range, or special key<\/li>\n<li>1 = number<\/li>\n<li>2 = a-fA-F<\/li>\n<li>3 = increment (up arrow)<\/li>\n<li>4 = decrement (down arrow)<\/li>\n<li>5 = special key (tab, delete, return, escape, left, right)<\/li> \n<li>6 = return<\/li>\n<\/ul>"}, "description": "Key map to well-known commands for txt field input", "private": "", "params": [{"type": "Event", "name": "e", "description": " the keypress or keydown event"}], "guessedname": "_getCommand", "guessedtype": "function"}, "setValue": {"params": [{"type": "[int, int, int]", "name": "rgb", "description": " the rgb value"}, {"type": "boolean", "name": "silent", "description": " whether or not to fire the change event"}], "description": "Sets the control to the specified rgb value and\nmoves the sliders to the proper positions", "guessedname": "setValue", "guessedtype": "function"}, "_updateHex": {"private": "", "description": "Parses the hex string to normalize shorthand values, converts\nthe hex value to rgb and updates the rgb attribute (which\nupdates the state for all of the other values)\nmethod _updateHex", "guessedname": "_updateHex", "guessedtype": "function"}, "_updateFormFields": {"private": "", "description": "Updates the form field controls with the state data contained\nin the control.", "guessedname": "_updateFormFields", "guessedtype": "function"}, "_hexOnly": {"return": {"type": "boolean", "description": "false if we are canceling the event"}, "description": "Allows numbers and special chars, and by default allows a-f. \nUsed for the hex field keypress handler.", "private": "", "params": [{"type": "Event", "name": "e", "description": " the event"}, {"type": "", "name": "numbersOnly", "description": " omits a-f if set to true"}], "guessedname": "_hexOnly", "guessedtype": "function"}, "initPicker": {"description": "Sets the initial state of the sliders", "guessedname": "initPicker", "guessedtype": "function"}, "_updateHueSlider": {"private": "", "description": "Moves the hue slider into the position dictated by the current state\nof the control", "guessedname": "_updateHueSlider", "guessedtype": "function"}, "_getS": {"guessedname": "_getS", "return": {"type": "int", "description": "the saturation from 0 to 1"}, "description": "Translates the slider value into saturation, int[0,1], left to right", "private": "", "guessedtype": "function"}, "_getValuesFromSliders": {"private": "", "description": "Reads the sliders and converts the values to RGB, updating the\ninternal state for all the individual form fields", "guessedname": "_getValuesFromSliders", "guessedtype": "function"}, "_getV": {"guessedname": "_getV", "return": {"type": "int", "description": "the value from 0 to 1"}, "description": "Translates the slider value into value\/brightness, int[0,1], top\nto bottom", "private": "", "guessedtype": "function"}, "_getH": {"guessedname": "_getH", "return": {"type": "int", "description": "the hue from 0 to 359"}, "description": "Translates the slider value into hue, int[0,359]", "private": "", "guessedtype": "function"}, "_rgbFieldKeypress": {"guessedname": "_rgbFieldKeypress", "params": [{"type": "Event", "name": "e", "description": " the keypress event"}, {"type": "HTMLElement", "name": "el", "description": " the field"}, {"type": "string", "name": "prop", "description": " the key to the linked property"}], "description": "Handle keypress on one of the rgb or hsv fields.", "private": "", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "ColorPicker.js", "guessedtype": "function", "shortname": "ColorPicker", "properties": {"DEFAULT": {"final": "", "description": "Constants for the control's default default values", "guessedname": "DEFAULT", "guessedtype": "property"}, "pickerSlider": {"type": "YAHOO.widget.Slider", "description": "The picker region", "guessedname": "pickerSlider", "guessedtype": "property"}, "ID.PICKER_BG": {"description": "The id for the picker region slider", "default": "yui-picker-bg", "guessedname": "PICKER_BG", "guessedtype": "property", "type": "String", "final": ""}, "ID.G": {"description": "The id for the \"green\" form field", "default": "yui-picker-g", "guessedname": "G", "guessedtype": "property", "type": "String", "final": ""}, "ID.G_HEX": {"description": "The id for the \"green\" hex pair output", "default": "yui-picker-ghex", "guessedname": "G_HEX", "guessedtype": "property", "type": "String", "final": ""}, "ID.HSV_CONTROLS": {"default": "yui-picker-hsv-controls", "final": "", "description": "The id for the hsv controls", "guessedname": "HSV_CONTROLS", "guessedtype": "property"}, "ID.SWATCH": {"description": "The id for the color swatch", "default": "yui-picker-swatch", "guessedname": "SWATCH", "guessedtype": "property", "type": "String", "final": ""}, "ID.HEX_CONTROLS": {"default": "yui-picker-hex-controls", "final": "", "description": "The id for the hsv controls", "guessedname": "HEX_CONTROLS", "guessedtype": "property"}, "IMAGE": {"final": "", "description": "Constants for the default image locations for img tags that are\ngenerated by the control. They can be modified by passing the\ncomplete list to the contructor for the \"images\" attribute", "guessedname": "IMAGE", "guessedtype": "property"}, "ID.B_HEX": {"description": "The id for the \"blue\" hex pair output", "default": "yui-picker-bhex", "guessedname": "B_HEX", "guessedtype": "property", "type": "String", "final": ""}, "TXT": {"final": "", "description": "Constants for any script-generated messages. The values here\nare the default messages. They can be updated by providing\nthe complete list to the constructor for the \"txt\" attribute.", "guessedname": "TXT", "guessedtype": "property"}, "ID.HEX": {"description": "The id for the hex value form field", "default": "yui-picker-hex", "guessedname": "HEX", "guessedtype": "property", "type": "String", "final": ""}, "ID.HUE_BG": {"description": "The id for the hue slider", "default": "yui-picker-hue-bg", "guessedname": "HUE_BG", "guessedtype": "property", "type": "String", "final": ""}, "ID.CONTROLS": {"default": "yui-picker-controls", "final": "", "description": "The id for the control details", "guessedname": "CONTROLS", "guessedtype": "property"}, "ID.V": {"description": "The id for the \"value\" form field", "default": "yui-picker-v", "guessedname": "V", "guessedtype": "property", "type": "String", "final": ""}, "ID.S": {"description": "The id for the \"saturation\" form field", "default": "yui-picker-s", "guessedname": "S", "guessedtype": "property", "type": "String", "final": ""}, "ID.R": {"description": "The id for the \"red\" form field", "default": "yui-picker-r", "guessedname": "R", "guessedtype": "property", "type": "String", "final": ""}, "ID.H": {"description": "The id for the \"hue\" form field", "default": "yui-picker-h", "guessedname": "H", "guessedtype": "property", "type": "String", "final": ""}, "ID.WEBSAFE_SWATCH": {"description": "The id for the websafe color swatch", "default": "yui-picker-websafe-swatch", "guessedname": "WEBSAFE_SWATCH", "guessedtype": "property", "type": "String", "final": ""}, "ID": {"final": "", "description": "The element ids used by this control", "guessedname": "ID", "guessedtype": "property"}, "ID.B": {"description": "The id for the \"blue\" form field", "default": "yui-picker-b", "guessedname": "B", "guessedtype": "property", "type": "String", "final": ""}, "OPT": {"final": "", "description": "Constants for the control's configuration attributes", "guessedname": "OPT", "guessedtype": "property"}, "ID.HUE_THUMB": {"description": "The id for the hue thumb", "default": "yui-picker-hue-thumb", "guessedname": "HUE_THUMB", "guessedtype": "property", "type": "String", "final": ""}, "ID.R_HEX": {"description": "The id for the \"red\" hex pair output", "default": "yui-picker-rhex", "guessedname": "R_HEX", "guessedtype": "property", "type": "String", "final": ""}, "ID.RGB_CONTROLS": {"default": "yui-picker-rgb-controls", "final": "", "description": "The id for the rgb controls", "guessedname": "RGB_CONTROLS", "guessedtype": "property"}, "ID.PICKER_THUMB": {"description": "The id for the picker region thumb", "default": "yui-picker-thumb", "guessedname": "PICKER_THUMB", "guessedtype": "property", "type": "String", "final": ""}, "hueSlider": {"type": "YAHOO.widget.Slider", "description": "The hue slider", "guessedname": "hueSlider", "guessedtype": "property"}, "ID.HEX_SUMMARY": {"default": "yui-picker-hex-summary", "final": "", "description": "The id for the hex summary", "guessedname": "HEX_SUMMARY", "guessedtype": "property"}, "ID.CONTROLS_LABEL": {"default": "yui-picker-controls-label", "final": "", "description": "The id for the controls section header", "guessedname": "CONTROLS_LABEL", "guessedtype": "property"}}, "description": "A widget to select colors"}, "YAHOO.widget.ToolbarButton": {"name": "YAHOO.widget.ToolbarButton", "configs": {"container": {"type": "String", "description": "The container that the button is rendered to, handled by Toolbar"}, "title": {"type": "String", "description": "The title of the button"}, "menu": {"type": "Object", "description": "The menu attribute, see YAHOO.widget.Button"}, "value": {"type": "String", "description": "The value of the button"}, "label": {"type": "String", "description": "The text label for the button"}, "disabled": {"type": "String", "description": "Set the button into a disabled state"}, "type": {"type": "String", "description": "The type of button to create: push, menu, color, select, spin"}}, "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The element to turn into a button."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "<p>Creates a basic custom Toolbar Button. Primarily used with the Rich Text Editor's Toolbar<\/p>"}], "namespace": "YAHOO.widget", "module": "editor", "events": {"beforeValueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeValueChange", "description": "Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change."}, "beforeMenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenuChange", "description": "Fires before the value for the configuration attribute 'menu' changes. Return false to cancel the attribute change."}, "titleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "titleChange", "description": "Fires when the value for the configuration attribute 'title' changes."}, "valueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "valueChange", "description": "Fires when the value for the configuration attribute 'value' changes."}, "beforeDisabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDisabledChange", "description": "Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change."}, "labelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "labelChange", "description": "Fires when the value for the configuration attribute 'label' changes."}, "beforeTitleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTitleChange", "description": "Fires before the value for the configuration attribute 'title' changes. Return false to cancel the attribute change."}, "typeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "typeChange", "description": "Fires when the value for the configuration attribute 'type' changes."}, "menuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menuChange", "description": "Fires when the value for the configuration attribute 'menu' changes."}, "beforeLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLabelChange", "description": "Fires before the value for the configuration attribute 'label' changes. Return false to cancel the attribute change."}, "beforeTypeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTypeChange", "description": "Fires before the value for the configuration attribute 'type' changes. Return false to cancel the attribute change."}, "disabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "disabledChange", "description": "Fires when the value for the configuration attribute 'disabled' changes."}}, "guessedname": "ToolbarButton", "beta": "", "methods": {"_handleSelect": {"guessedname": "_handleSelect", "params": [{"type": "Event", "name": "ev", "description": " The change event."}], "description": "The event fired when a change event gets fired on a select element", "private": "", "guessedtype": "function"}, "getMenu": {"description": "A stub function to mimic YAHOO.widget.Button's getMenu method", "guessedname": "getMenu", "guessedtype": "function"}, "_handleMouseOut": {"description": "Removes classes from the button elements on mouseout (hover)", "private": "", "guessedname": "_handleMouseOut", "guessedtype": "function"}, "init": {"description": "The ToolbarButton class's initialization method", "guessedname": "init", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "attr", "description": " Object literal specifying a set of \nconfiguration attributes used to create the toolbar."}], "description": "Initializes all of the configuration attributes used to create \nthe toolbar.", "guessedname": "initAttributes", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the toolbar.", "guessedname": "toString", "guessedtype": "function"}, "checkValue": {"params": [{"type": "String", "name": "value", "description": " The value of the option that we want to mark as selected"}], "description": "Select an option by value", "guessedname": "checkValue", "guessedtype": "function"}, "destroy": {"description": "Destroy the button", "guessedname": "destroy", "guessedtype": "function"}, "_handleMouseOver": {"description": "Adds classes to the button elements on mouseover (hover)", "private": "", "guessedname": "_handleMouseOver", "guessedtype": "function"}, "fireEvent": {"description": "Overridden fireEvent method to prevent DOM events from firing if the button is disabled.", "guessedname": "fireEvent", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "toolbar-button.js", "guessedtype": "function", "shortname": "ToolbarButton", "requires": "yahoo, dom, element, event", "properties": {"buttonType": {"private": "", "description": "Tells if the Button is a Rich Button or a Simple Button", "guessedname": "buttonType", "guessedtype": "property"}, "Dom": {"private": "", "guessedname": "Dom", "guessedtype": "property"}}, "description": "<p>Creates a basic custom Toolbar Button. Primarily used with the Rich Text Editor's Toolbar<\/p>"}, "YAHOO.util.Attribute": {"name": "YAHOO.util.Attribute", "constructors": [{"params": [{"type": "Object", "name": "hash", "description": " The intial Attribute."}, {"type": "YAHOO.util.AttributeProvider", "name": "The", "description": " owner of the Attribute instance."}], "description": "Provides Attribute configurations."}], "namespace": "YAHOO.util", "module": "element", "guessedname": "Attribute", "methods": {"setValue": {"return": {"type": "Boolean", "description": "Whether or not the value was set."}, "params": [{"type": "Any", "name": "value", "description": " The value to apply to the attribute."}, {"type": "Boolean", "name": "silent", "description": " If true the change events will not be fired."}], "description": "Sets the value of the attribute and fires beforeChange and change events.", "guessedname": "setValue", "guessedtype": "function"}, "configure": {"params": [{"type": "Object", "name": "map", "description": " A key-value map of Attribute properties."}, {"type": "Boolean", "name": "init", "description": " Whether or not this should become the initial config."}], "description": "Allows for configuring the Attribute's properties.", "guessedname": "configure", "guessedtype": "function"}, "resetValue": {"return": {"type": "Boolean", "description": "Whether or not the value was set."}, "description": "Resets the value to the initial config value.", "guessedname": "resetValue", "guessedtype": "function"}, "refresh": {"return": {"type": "Boolean", "description": "Whether or not the value was set."}, "description": "Resets the value to the current value.\nUseful when values may have gotten out of sync with actual properties.", "guessedname": "refresh", "guessedtype": "function"}, "getValue": {"return": {"type": "any", "description": "The current value of the attribute."}, "description": "Retrieves the current value of the attribute.", "guessedname": "getValue", "guessedtype": "function"}, "resetConfig": {"description": "Resets the attribute config to the initial config state.", "guessedname": "resetConfig", "guessedtype": "function"}}, "file": "Attribute.js", "guessedtype": "function", "shortname": "Attribute", "properties": {"_written": {"guessedname": "_written", "type": "Boolean", "description": "Whether or not the attribute's value has been set.", "private": "", "guessedtype": "property"}, "name": {"type": "String", "description": "The name of the attribute.", "guessedname": "name", "guessedtype": "property"}, "writeOnce": {"type": "Boolean", "description": "Whether or not the attribute can only be written once.", "guessedname": "writeOnce", "guessedtype": "property"}, "_initialConfig": {"guessedname": "_initialConfig", "type": "Object", "description": "The attribute's initial configuration.", "private": "", "guessedtype": "property"}, "value": {"type": "String", "description": "The value of the attribute.", "guessedname": "value", "guessedtype": "property"}, "readOnly": {"type": "Boolean", "description": "Whether or not the attribute is read only.", "guessedname": "readOnly", "guessedtype": "property"}, "validator": {"type": "Function", "return": "Boolean", "description": "The validator to use when setting the attribute's value.", "guessedname": "validator", "guessedtype": "property"}, "owner": {"type": "YAHOO.util.AttributeProvider", "description": "The owner of the attribute.", "guessedname": "owner", "guessedtype": "property"}, "method": {"type": "Function", "description": "The method to use when setting the attribute's value.\nThe method recieves the new value as the only argument.", "guessedname": "method", "guessedtype": "property"}}, "description": "Provides Attribute configurations."}, "YAHOO.util.DateAssert": {"name": "YAHOO.util.DateAssert", "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "DateAssert", "methods": {"datesAreEqual": {"static": "", "params": [{"type": "Date", "name": "expected", "description": " The expected date."}, {"type": "Date", "name": "actual", "description": " The actual date to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a date's month, day, and year are equal to another date's.", "guessedname": "datesAreEqual", "guessedtype": "function"}, "timesAreEqual": {"static": "", "params": [{"type": "Date", "name": "expected", "description": " The expected date."}, {"type": "Date", "name": "actual", "description": " The actual date to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a date's hour, minutes, and seconds are equal to another date's.", "guessedname": "timesAreEqual", "guessedtype": "function"}}, "static": "", "file": "DateAssert.js", "guessedtype": "property", "shortname": "DateAssert", "description": "The DateAssert object provides functions to test JavaScript Date objects\nfor a variety of cases."}, "YAHOO.widget.Editor": {"name": "YAHOO.widget.Editor", "configs": {"hiddencss": {"default": "<code><pre>\n.yui-hidden font, .yui-hidden strong, .yui-hidden b, .yui-hidden em, .yui-hidden i, .yui-hidden u, .yui-hidden div, .yui-hidden p, .yui-hidden span, .yui-hidden img, .yui-hidden ul, .yui-hidden ol, .yui-hidden li, .yui-hidden table {\nborder: 1px dotted #ccc;\n}\n.yui-hidden .yui-non {\nborder: none;\n}\n.yui-hidden img {\npadding: 2px;\n}<\/pre><\/code>", "type": "String", "description": "The CSS used to show\/hide hidden elements on the page, these rules must be prefixed with the class provided in <code>this.CLASS_HIDDEN<\/code>"}, "localFileWarning": {"default": "true", "type": "Boolean", "description": "Should we throw the warning if we detect a file that is local to their machine?"}}, "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The textarea element to turn into an editor."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "The Rich Text Editor is a UI control that replaces a standard HTML textarea; it allows for the rich formatting of text content, including common structural treatments like lists, formatting treatments like bold and italic text, and drag-and-drop inclusion and sizing of images. The Rich Text Editor's toolbar is extensible via a plugin architecture so that advanced implementations can achieve a high degree of customization."}], "namespace": "YAHOO.widget", "module": "editor", "events": {"hiddencssChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hiddencssChange", "description": "Fires when the value for the configuration attribute 'hiddencss' changes."}, "beforeHiddencssChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHiddencssChange", "description": "Fires before the value for the configuration attribute 'hiddencss' changes. Return false to cancel the attribute change."}, "beforeLocalFileWarningChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLocalFileWarningChange", "description": "Fires before the value for the configuration attribute 'localFileWarning' changes. Return false to cancel the attribute change."}, "localFileWarningChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "localFileWarningChange", "description": "Fires when the value for the configuration attribute 'localFileWarning' changes."}}, "guessedname": "Editor", "methods": {"_fixNodes": {"description": "Fix href and imgs as well as remove invalid HTML.", "private": "", "guessedname": "_fixNodes", "guessedtype": "function"}, "cmd_justifyright": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('justifyright') is used.", "guessedname": "cmd_justifyright", "guessedtype": "function"}, "_defaultImageToolbar": {"description": "A reference to the Toolbar Object inside Image Editor Window.", "private": "", "guessedname": "_defaultImageToolbar", "guessedtype": "property"}, "moveWindow": {"params": [{"type": "Boolean", "name": "force", "description": " Boolean to tell it to move but not use any animation (Usually done the first time the window is loaded.)"}], "description": "Realign the window with the currentElement and reposition the knob above the panel.", "guessedname": "moveWindow", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "attr", "description": " Object literal specifying a set of \nconfiguration attributes used to create the editor."}], "description": "Initializes all of the configuration attributes used to create \nthe editor.", "guessedname": "initAttributes", "guessedtype": "function"}, "openWindow": {"params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">YAHOO.widget.EditorWindow<\/a>", "name": "win", "description": " A <a href=\"YAHOO.widget.EditorWindow.html\">YAHOO.widget.EditorWindow<\/a> instance"}], "description": "Opens a new \"window\/panel\"", "guessedname": "openWindow", "guessedtype": "function"}, "cmd_superscript": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('superscript') is used.", "guessedname": "cmd_superscript", "guessedtype": "function"}, "_renderCreateLinkWindow": {"description": "Pre renders the CreateLink window so we get faster window opening.", "private": "", "guessedname": "_renderCreateLinkWindow", "guessedtype": "function"}, "_hasUndoLevel": {"guessedname": "_hasUndoLevel", "return": {"type": "", "description": "Boolean"}, "description": "Checks to see if we have an undo level available", "private": "", "guessedtype": "function"}, "_defaultImageToolbarConfig": {"description": "Config to be used for the default Image Editor Window.", "private": "", "guessedname": "_defaultImageToolbarConfig", "guessedtype": "property"}, "cmd_justifycenter": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('justifycenter') is used.", "guessedname": "cmd_justifycenter", "guessedtype": "function"}, "cmd_heading": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('heading') is used.", "guessedname": "cmd_heading", "guessedtype": "function"}, "_renderPanel": {"guessedname": "_renderPanel", "return": {"type": "<a href=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a>", "description": ""}, "description": "Renders the panel used for Editor Windows to the document so we can start using it..", "private": "", "guessedtype": "function"}, "cmd_justifyleft": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('justifyleft') is used.", "guessedname": "cmd_justifyleft", "guessedtype": "function"}, "init": {"description": "The Editor class' initialization method", "guessedname": "init", "guessedtype": "function"}, "closeWindow": {"description": "Close the currently open EditorWindow.", "guessedname": "closeWindow", "guessedtype": "function"}, "cmd_script": {"params": [{"type": "", "name": "action", "description": " action passed from the execCommand method"}, {"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is a combined execCommand override method. It is called from the cmd_superscript and cmd_subscript methods.", "guessedname": "cmd_script", "guessedtype": "function"}, "cmd_justify": {"params": [{"type": "", "name": "dir", "description": " The direction to justify"}], "description": "This is a factory method for the justify family of commands.", "guessedname": "cmd_justify", "guessedtype": "function"}, "_renderInsertImageWindow": {"description": "Pre renders the InsertImage window so we get faster window opening.", "private": "", "guessedname": "_renderInsertImageWindow", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the editor.", "guessedname": "toString", "guessedtype": "function"}, "cmd_hiddenelements": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('hiddenelements') is used.", "guessedname": "cmd_hiddenelements", "guessedtype": "function"}, "_handleCreateLinkWindowClose": {"description": "Handles the closing of the Link Properties Window.", "private": "", "guessedname": "_handleCreateLinkWindowClose", "guessedtype": "function"}, "_handleInsertImageWindowClose": {"description": "Handles the closing of the Image Properties Window.", "private": "", "guessedname": "_handleInsertImageWindowClose", "guessedtype": "function"}, "_storeUndo": {"description": "Method to call when you want to store an undo state. Currently called from nodeChange and _handleKeyUp", "private": "", "guessedname": "_storeUndo", "guessedtype": "function"}, "_checkUndo": {"description": "Prunes the undo cache when it reaches the maxUndo config", "private": "", "guessedname": "_checkUndo", "guessedtype": "function"}, "cmd_subscript": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('subscript') is used.", "guessedname": "cmd_subscript", "guessedtype": "function"}, "_getUndo": {"return": {"type": "String", "description": ""}, "description": "Get's a level from the undo cache.", "private": "", "params": [{"type": "Number", "name": "index", "description": " The index of the undo level we want to get."}], "guessedname": "_getUndo", "guessedtype": "function"}, "_handleInsertImageClick": {"description": "Opens the Image Properties Window when the insert Image button is clicked or an Image is Double Clicked.", "private": "", "guessedname": "_handleInsertImageClick", "guessedtype": "function"}, "_windows": {"description": "A reference to the HTML elements used for the body of Editor Windows.", "private": "", "guessedname": "_windows", "guessedtype": "property"}, "cmd_redo": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "Pulls an item from the Undo stack and updates the Editor", "guessedname": "cmd_redo", "guessedtype": "function"}, "_putUndo": {"guessedname": "_putUndo", "params": [{"type": "String", "name": "str", "description": " The content of the Editor"}], "description": "Puts the content of the Editor into the _undoCache.\n\/\/TODO Convert the hash to a series of TEXTAREAS to store state in.", "private": "", "guessedtype": "function"}, "cmd_indent": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('indent') is used.", "guessedname": "cmd_indent", "guessedtype": "function"}, "cmd_undo": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "Pulls an item from the Undo stack and updates the Editor", "guessedname": "cmd_undo", "guessedtype": "function"}, "_undoNodeChange": {"description": "nodeChange listener for undo processing", "private": "", "guessedname": "_undoNodeChange", "guessedtype": "function"}, "_handleKeyDown": {"guessedname": "_handleKeyDown", "params": [{"type": "Event", "name": "ev", "description": " The event we are working on."}], "description": "Override method that handles some new keydown events inside the iFrame document.", "private": "", "guessedtype": "function"}, "cmd_outdent": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('outdent') is used.", "guessedname": "cmd_outdent", "guessedtype": "function"}, "_closeWindow": {"guessedname": "_closeWindow", "params": [{"type": "Event", "name": "ev", "description": " The keypress Event that we are trapping"}], "description": "Close the currently open EditorWindow with the Escape key.", "private": "", "guessedtype": "function"}, "cmd_removeformat": {"params": [{"type": "", "name": "value", "description": " Value passed from the execCommand method"}], "description": "This is an execCommand override method. It is called from execCommand when the execCommand('removeformat') is used.", "guessedname": "cmd_removeformat", "guessedtype": "function"}}, "extends": "YAHOO.widget.SimpleEditor", "superclass": "YAHOO.widget.SimpleEditor", "file": "editor.js", "guessedtype": "function", "shortname": "Editor", "properties": {"_alwaysDisabled": {"guessedname": "_alwaysDisabled", "type": "Object", "description": "The Toolbar items that should ALWAYS be disabled event if there is a selection present in the editor.", "private": "", "guessedtype": "property"}, "STR_LOCAL_FILE_WARNING": {"type": "String", "description": "The label string for the local file warning.", "guessedname": "STR_LOCAL_FILE_WARNING", "guessedtype": "property"}, "STR_CLOSE_WINDOW_NOTE": {"type": "String", "description": "A note appearing in the Editor Window to tell the user that the Escape key will close the window", "guessedname": "STR_CLOSE_WINDOW_NOTE", "guessedtype": "property"}, "CLASS_HIDDEN": {"protected": "", "type": "String", "description": "CSS class applied to the body when the hiddenelements button is pressed.", "guessedname": "CLASS_HIDDEN", "guessedtype": "property"}, "STR_IMAGE_SIZE": {"type": "String", "description": "The label string for Image Size", "guessedname": "STR_IMAGE_SIZE", "guessedtype": "property"}, "STR_IMAGE_COPY": {"type": "String", "description": "The label string for the image copy and paste message for Opera and Safari", "guessedname": "STR_IMAGE_COPY", "guessedtype": "property"}, "STR_LINK_NEW_WINDOW": {"type": "String", "description": "The string for the open in a new window label.", "guessedname": "STR_LINK_NEW_WINDOW", "guessedtype": "property"}, "STR_CLOSE_WINDOW": {"type": "String", "description": "The Title of the close button in the Editor Window", "guessedname": "STR_CLOSE_WINDOW", "guessedtype": "property"}, "_undoCache": {"guessedname": "_undoCache", "type": "Array", "description": "An Array hash of the Undo Levels.", "private": "", "guessedtype": "property"}, "STR_BEFORE_EDITOR": {"type": "String", "description": "The accessibility string for the element before the iFrame", "guessedname": "STR_BEFORE_EDITOR", "guessedtype": "property"}, "_undoLevel": {"guessedname": "_undoLevel", "type": "Number", "description": "The index of the current undo state.", "private": "", "guessedtype": "property"}, "STR_IMAGE_BORDER": {"type": "String", "description": "The label string for the image border.", "guessedname": "STR_IMAGE_BORDER", "guessedtype": "property"}, "STR_IMAGE_TITLE": {"type": "String", "description": "The label string for Image Description", "guessedname": "STR_IMAGE_TITLE", "guessedtype": "property"}, "_alwaysEnabled": {"guessedname": "_alwaysEnabled", "type": "Object", "description": "The Toolbar items that should ALWAYS be enabled event if there isn't a selection present in the editor.", "private": "", "guessedtype": "property"}, "STR_LINK_TITLE": {"type": "String", "description": "The string for the link description.", "guessedname": "STR_LINK_TITLE", "guessedtype": "property"}, "_disabled": {"guessedname": "_disabled", "type": "Array", "description": "The Toolbar items that should be disabled if there is no selection present in the editor.", "private": "", "guessedtype": "property"}, "STR_IMAGE_URL": {"type": "String", "description": "The label string for Image URL", "guessedname": "STR_IMAGE_URL", "guessedtype": "property"}, "STR_IMAGE_TEXTFLOW": {"type": "String", "description": "The label string for the image text flow.", "guessedname": "STR_IMAGE_TEXTFLOW", "guessedtype": "property"}, "STR_LINK_PROP_TITLE": {"type": "String", "description": "The label string for the Link Property Editor Window.", "guessedname": "STR_LINK_PROP_TITLE", "guessedtype": "property"}, "STR_IMAGE_BORDER_TYPE": {"type": "String", "description": "The label string for the image border type.", "guessedname": "STR_IMAGE_BORDER_TYPE", "guessedtype": "property"}, "EDITOR_PANEL_ID": {"type": "String", "description": "HTML id to give the properties window in the DOM.", "guessedname": "EDITOR_PANEL_ID", "guessedtype": "property"}, "STR_IMAGE_ORIG_SIZE": {"type": "String", "description": "The label string for Original Image Size", "guessedname": "STR_IMAGE_ORIG_SIZE", "guessedtype": "property"}, "STR_IMAGE_PADDING": {"type": "String", "description": "The label string for the image padding.", "guessedname": "STR_IMAGE_PADDING", "guessedtype": "property"}, "STR_IMAGE_PROP_TITLE": {"type": "String", "description": "The title for the Image Property Editor Window", "guessedname": "STR_IMAGE_PROP_TITLE", "guessedtype": "property"}, "CLASS_LOCAL_FILE": {"protected": "", "type": "String", "description": "CSS class applied to an element when it's found to have a local url.", "guessedname": "CLASS_LOCAL_FILE", "guessedtype": "property"}, "STR_LINK_PROP_REMOVE": {"type": "String", "description": "The label string for the Remove link from text link inside the property editor.", "guessedname": "STR_LINK_PROP_REMOVE", "guessedtype": "property"}, "STR_IMAGE_BORDER_SIZE": {"type": "String", "description": "The label string for the image border size.", "guessedname": "STR_IMAGE_BORDER_SIZE", "guessedtype": "property"}}, "description": "The Rich Text Editor is a UI control that replaces a standard HTML textarea; it allows for the rich formatting of text content, including common structural treatments like lists, formatting treatments like bold and italic text, and drag-and-drop inclusion and sizing of images. The Rich Text Editor's toolbar is extensible via a plugin architecture so that advanced implementations can achieve a high degree of customization."}, "YAHOO.widget.Paginator.ui.RowsPerPageDropdown": {"properties": {"select": {"guessedname": "select", "type": "HTMLElement", "description": "select node", "private": "", "guessedtype": "property"}}, "name": "YAHOO.widget.Paginator.ui.RowsPerPageDropdown", "for": "YAHOO.widget.Paginator", "innerClasses": ["YAHOO.widget.Paginator"], "constructors": [{"params": [{"type": "Pagintor", "name": "p", "description": " Paginator instance to attach to"}], "description": "ui Component to generate the rows-per-page dropdown"}], "namespace": "YAHOO.widget.Paginator.ui", "module": "paginator", "events": {"rowsPerPageDropdownClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "rowsPerPageDropdownClassChange", "description": "Fires when the value for the configuration attribute 'rowsPerPageDropdownClass' changes."}, "rowsPerPageOptionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "rowsPerPageOptionsChange", "description": "Fires when the value for the configuration attribute 'rowsPerPageOptions' changes."}, "beforeRowsPerPageOptionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRowsPerPageOptionsChange", "description": "Fires before the value for the configuration attribute 'rowsPerPageOptions' changes. Return false to cancel the attribute change."}, "beforeRowsPerPageDropdownClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRowsPerPageDropdownClassChange", "description": "Fires before the value for the configuration attribute 'rowsPerPageDropdownClass' changes. Return false to cancel the attribute change."}}, "guessedname": "RowsPerPageDropdown", "methods": {"render": {"return": {"type": "HTMLElement", "description": ""}, "params": [{"type": "string", "name": "id_base", "description": " used to create unique ids for generated nodes"}], "description": "Generate the select and option nodes and returns the select node.", "guessedname": "render", "guessedtype": "function"}, "rebuild": {"description": "(Re)generate the select options.", "guessedname": "rebuild", "guessedtype": "function"}, "update": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event"}], "description": "Select the appropriate option if changed.", "guessedname": "update", "guessedtype": "function"}, "init": {"static": "", "params": [{"type": "Paginator", "name": "p", "description": " Paginator instance to decorate"}], "description": "Decorates Paginator instances with new attributes. Called during\nPaginator instantiation.", "guessedname": "init", "guessedtype": "function"}, "destroy": {"private": "", "description": "Removes the select node and clears event listeners", "guessedname": "destroy", "guessedtype": "function"}, "onChange": {"params": [{"type": "DOMEvent", "name": "e", "description": " The change event"}], "description": "Listener for the select's onchange event. Sent to setRowsPerPage method.", "guessedname": "onChange", "guessedtype": "function"}}, "file": "RowsPerPageDropDown.js", "guessedtype": "function", "shortname": "RowsPerPageDropdown", "configs": {"rowsPerPageDropdownClass": {"default": "'yui-pg-rpp-options'", "description": "CSS class assigned to the select node"}, "rowsPerPageOptions": {"default": "[]", "description": "Array of available rows-per-page sizes. Converted into select options.\nArray values may be positive integers or object literals in the form<br>\n{ value : NUMBER, text : STRING }"}}, "description": "ui Component to generate the rows-per-page dropdown"}, "YAHOO.widget.Calendar": {"name": "YAHOO.widget.Calendar", "configs": {"MY_LABEL_YEAR_POSITION": {"default": "2", "type": "Number", "description": "The position of the year in the month year label string used as the Calendar header", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEKDAYS": {"default": "true", "type": "Boolean", "description": "True if the Calendar should show weekday labels. True by default.", "guessedname": "value", "guessedtype": "property"}, "MDY_DAY_POSITION": {"default": "2", "type": "Number", "description": "The position of the day in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "MY_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "MONTHS_SHORT": {"default": "[\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\", \"Jul\", \"Aug\", \"Sep\", \"Oct\", \"Nov\", \"Dec\"]", "type": "String[]", "description": "The short month labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "MULTI_SELECT": {"default": "false", "type": "Boolean", "description": "True if the Calendar should allow multiple selections. False by default.", "guessedname": "value", "guessedtype": "property"}, "MY_LABEL_YEAR_SUFFIX": {"default": "\"\"", "type": "String", "description": "The suffix used after the year when rendering the Calendar header", "guessedname": "value", "guessedtype": "property"}, "DATE_FIELD_DELIMITER": {"default": "\"\/\"", "type": "String", "description": "The value used to delimit date fields in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "MY_YEAR_POSITION": {"default": "2", "type": "Number", "description": "The position of the year in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "close": {"default": "false", "type": "Boolean", "description": "Whether or not a close button should be displayed for this Calendar", "guessedname": "value", "guessedtype": "property"}, "MONTHS_LONG": {"default": "[\"January\", \"February\", \"March\", \"April\", \"May\", \"June\", \"July\", \"August\", \"September\", \"October\", \"November\", \"December\"", "type": "String[]", "description": "The long month labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_MEDIUM": {"default": "[\"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri\", \"Sat\"]", "type": "String[]", "description": "The medium weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "MY_LABEL_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in the month year label string used as the Calendar header", "guessedname": "value", "guessedtype": "property"}, "navigator": {"default": "null", "type": "{Object|Boolean}", "description": "Configuration for the Month\/Year CalendarNavigator UI which allows the user to jump directly to a \nspecific Month\/Year without having to scroll sequentially through months.\n<p>\nSetting this property to null (default value) or false, will disable the CalendarNavigator UI.\n<\/p>\n<p>\nSetting this property to true will enable the CalendarNavigatior UI with the default CalendarNavigator configuration values.\n<\/p>\n<p>\nThis property can also be set to an object literal containing configuration properties for the CalendarNavigator UI.\nThe configuration object expects the the following case-sensitive properties, with the \"strings\" property being a nested object.\nAny properties which are not provided will use the default values (defined in the CalendarNavigator class).\n<\/p>\n<dl>\n<dt>strings<\/dt>\n<dd><em>Object<\/em> : An object with the properties shown below, defining the string labels to use in the Navigator's UI\n<dl>\n<dt>month<\/dt><dd><em>String<\/em> : The string to use for the month label. Defaults to \"Month\".<\/dd>\n<dt>year<\/dt><dd><em>String<\/em> : The string to use for the year label. Defaults to \"Year\".<\/dd>\n<dt>submit<\/dt><dd><em>String<\/em> : The string to use for the submit button label. Defaults to \"Okay\".<\/dd>\n<dt>cancel<\/dt><dd><em>String<\/em> : The string to use for the cancel button label. Defaults to \"Cancel\".<\/dd>\n<dt>invalidYear<\/dt><dd><em>String<\/em> : The string to use for invalid year values. Defaults to \"Year needs to be a number\".<\/dd>\n<\/dl>\n<\/dd>\n<dt>monthFormat<\/dt><dd><em>String<\/em> : The month format to use. Either YAHOO.widget.Calendar.LONG, or YAHOO.widget.Calendar.SHORT. Defaults to YAHOO.widget.Calendar.LONG<\/dd>\n<dt>initialFocus<\/dt><dd><em>String<\/em> : Either \"year\" or \"month\" specifying which input control should get initial focus. Defaults to \"year\"<\/dd>\n<\/dl>\n<p>E.g.<\/p>\n<pre>\nvar navConfig = {\nstrings: {\nmonth:\"Calendar Month\",\nyear:\"Calendar Year\",\nsubmit: \"Submit\",\ncancel: \"Cancel\",\ninvalidYear: \"Please enter a valid year\"\n},\nmonthFormat: YAHOO.widget.Calendar.SHORT,\ninitialFocus: \"month\"\n}\n<\/pre>", "guessedname": "value", "guessedtype": "property"}, "DATE_RANGE_DELIMITER": {"default": "\"-\"", "type": "String", "description": "The value used to delimit date ranges in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEK_HEADER": {"default": "false", "type": "Boolean", "description": "True if the Calendar should show week row headers. False by default.", "guessedname": "value", "guessedtype": "property"}, "title": {"default": "\"\"", "type": "String", "description": "The title to display above the Calendar's month header", "guessedname": "value", "guessedtype": "property"}, "maxdate": {"default": "null", "type": "String | Date", "description": "The maximum selectable date in the current Calendar (mm\/dd\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "selected": {"default": "[]", "type": "String", "description": "The date or range of dates representing the current Calendar selection", "guessedname": "value", "guessedtype": "property"}, "LOCALE_WEEKDAYS": {"default": "\"short\"", "type": "String", "description": "The setting that determines which length of weekday labels should be used. Possible values are \"1char\", \"short\", \"medium\", and \"long\".", "guessedname": "value", "guessedtype": "property"}, "NAV_ARROW_RIGHT": {"description": "The image that should be used for the right navigation arrow.", "default": "null", "deprecated": "You can customize the image by overriding the default CSS class for the right arrow - \"calnavright\"", "guessedname": "value", "guessedtype": "property", "type": "String"}, "HIDE_BLANK_WEEKS": {"default": "false", "type": "Boolean", "description": "True if the Calendar should suppress weeks that are not a part of the current month. False by default.", "guessedname": "value", "guessedtype": "property"}, "mindate": {"default": "null", "type": "String | Date", "description": "The minimum selectable date in the current Calendar (mm\/dd\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "START_WEEKDAY": {"default": "0", "type": "number", "description": "The weekday the week begins on. Default is 0 (Sunday = 0, Monday = 1 ... Saturday = 6).", "guessedname": "value", "guessedtype": "property"}, "SHOW_WEEK_FOOTER": {"default": "false", "type": "Boolean", "description": "True if the Calendar should show week row footers. False by default.", "guessedname": "value", "guessedtype": "property"}, "MDY_YEAR_POSITION": {"default": "3", "type": "Number", "description": "The position of the year in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_LONG": {"default": "[\"Sunday\", \"Monday\", \"Tuesday\", \"Wednesday\", \"Thursday\", \"Friday\", \"Saturday\"]", "type": "String[]", "description": "The long weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "MDY_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/day\/year date string", "guessedname": "value", "guessedtype": "property"}, "pagedate": {"default": "today's date", "type": "String | Date", "description": "The month\/year representing the current visible Calendar date (mm\/yyyy)", "guessedname": "value", "guessedtype": "property"}, "MY_LABEL_MONTH_SUFFIX": {"default": "\" \"", "type": "String", "description": "The suffix used after the month when rendering the Calendar header", "guessedname": "value", "guessedtype": "property"}, "MD_DAY_POSITION": {"default": "2", "type": "Number", "description": "The position of the day in a month\/year date string", "guessedname": "value", "guessedtype": "property"}, "NAV_ARROW_LEFT": {"description": "The image that should be used for the left navigation arrow.", "default": "null", "deprecated": "You can customize the image by overriding the default CSS class for the left arrow - \"calnavleft\"", "guessedname": "value", "guessedtype": "property", "type": "String"}, "MD_MONTH_POSITION": {"default": "1", "type": "Number", "description": "The position of the month in a month\/day date string", "guessedname": "value", "guessedtype": "property"}, "DATE_DELIMITER": {"default": "\",\"", "type": "String", "description": "The value used to delimit individual dates in a date string passed to various Calendar functions.", "guessedname": "value", "guessedtype": "property"}, "LOCALE_MONTHS": {"default": "\"long\"", "type": "String", "description": "The setting that determines which length of month labels should be used. Possible values are \"short\" and \"long\".", "guessedname": "value", "guessedtype": "property"}, "iframe": {"default": "true for IE6 and below, false for all other browsers", "type": "Boolean", "description": "Whether or not an iframe shim should be placed under the Calendar to prevent select boxes from bleeding through in Internet Explorer 6 and below.\nThis property is enabled by default for IE6 and below. It is disabled by default for other browsers for performance reasons, but can be \nenabled if required.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_1CHAR": {"default": "[\"S\", \"M\", \"T\", \"W\", \"T\", \"F\", \"S\"]", "type": "String[]", "description": "The 1-character weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "WEEKDAYS_SHORT": {"default": "[\"Su\", \"Mo\", \"Tu\", \"We\", \"Th\", \"Fr\", \"Sa\"]", "type": "String[]", "description": "The short weekday labels for the current locale.", "guessedname": "value", "guessedtype": "property"}, "strings": {"default": "An object with the properties shown below:\n<dl>\n<dt>previousMonth<\/dt><dd><em>String<\/em> : The string to use for the \"Previous Month\" navigation UI. Defaults to \"Previous Month\".<\/dd>\n<dt>nextMonth<\/dt><dd><em>String<\/em> : The string to use for the \"Next Month\" navigation UI. Defaults to \"Next Month\".<\/dd>\n<dt>close<\/dt><dd><em>String<\/em> : The string to use for the close button label. Defaults to \"Close\".<\/dd>\n<\/dl>", "type": "{Object}", "description": "The map of UI strings which the Calendar UI uses."}}, "constructors": [{"params": [{"type": "String", "name": "id", "description": " optional The id of the table element that will represent the Calendar widget. As of 2.4.0, this argument is optional."}, {"type": "String | HTMLElement", "name": "container", "description": " The id of the container div element that will wrap the Calendar table, or a reference to a DIV element which exists in the document."}, {"type": "Object", "name": "config", "description": " optional The configuration object containing the initial configuration values for the Calendar."}], "description": "Calendar is the base class for the Calendar widget. In its most basic\nimplementation, it has the ability to render a calendar widget on the page\nthat can be manipulated to select a single date, move back and forth between\nmonths and years.\n<p>To construct the placeholder for the calendar widget, the code is as\nfollows:\n<xmp>\n<div id=\"calContainer\"><\/div>\n<\/xmp>\n<\/p>\n<p>\n<strong>NOTE: As of 2.4.0, the constructor's ID argument is optional.<\/strong>\nThe Calendar can be constructed by simply providing a container ID string, \nor a reference to a container DIV HTMLElement (the element needs to exist \nin the document).\nE.g.:\n<xmp>\nvar c = new YAHOO.widget.Calendar(\"calContainer\", configOptions);\n<\/xmp>\nor:\n<xmp>\nvar containerDiv = YAHOO.util.Dom.get(\"calContainer\");\nvar c = new YAHOO.widget.Calendar(containerDiv, configOptions);\n<\/xmp>\n<\/p>\n<p>\nIf not provided, the ID will be generated from the container DIV ID by adding an \"_t\" suffix.\nFor example if an ID is not provided, and the container's ID is \"calContainer\", the Calendar's ID will be set to \"calContainer_t\".\n<\/p>"}], "namespace": "YAHOO.widget", "module": "calendar", "events": {"showNavEvent": {"description": "Fired after the CalendarNavigator is shown", "guessedname": "showNavEvent", "guessedtype": "property"}, "beforeDeselectEvent": {"description": "Fired before a selection is made", "guessedname": "beforeDeselectEvent", "guessedtype": "property"}, "beforeRenderNavEvent": {"description": "Fired just before the CalendarNavigator is to be rendered", "guessedname": "beforeRenderNavEvent", "guessedtype": "property"}, "beforeHideNavEvent": {"description": "Fired just before the CalendarNavigator is to be hidden", "guessedname": "beforeHideNavEvent", "guessedtype": "property"}, "hideEvent": {"description": "Fired after the Calendar is hidden", "guessedname": "hideEvent", "guessedtype": "property"}, "hideNavEvent": {"description": "Fired after the CalendarNavigator is hidden", "guessedname": "hideNavEvent", "guessedtype": "property"}, "renderNavEvent": {"description": "Fired after the CalendarNavigator is rendered", "guessedname": "renderNavEvent", "guessedtype": "property"}, "beforeRenderEvent": {"description": "Fired before the Calendar is rendered", "guessedname": "beforeRenderEvent", "guessedtype": "property"}, "beforeShowEvent": {"description": "Fired just before the Calendar is to be shown", "guessedname": "beforeShowEvent", "guessedtype": "property"}, "beforeSelectEvent": {"description": "Fired before a selection is made", "guessedname": "beforeSelectEvent", "guessedtype": "property"}, "renderEvent": {"description": "Fired when the Calendar is rendered", "guessedname": "renderEvent", "guessedtype": "property"}, "changePageEvent": {"description": "Fired when the Calendar page is changed", "guessedname": "changePageEvent", "guessedtype": "property"}, "destroyEvent": {"description": "Fired after the Calendar is destroyed. This event should be used\nfor notification only. When this event is fired, important Calendar instance\nproperties, dom references and event listeners have already been \nremoved\/dereferenced, and hence the Calendar instance is not in a usable \nstate.", "guessedname": "destroyEvent", "guessedtype": "property"}, "clearEvent": {"description": "Fired when the Calendar is cleared", "guessedname": "clearEvent", "guessedtype": "property"}, "showEvent": {"description": "Fired after the Calendar is shown", "guessedname": "showEvent", "guessedtype": "property"}, "beforeDestroyEvent": {"description": "Fired just before the Calendar is to be destroyed", "guessedname": "beforeDestroyEvent", "guessedtype": "property"}, "selectEvent": {"params": [{"type": "Array", "name": "Array", "description": " of Date field arrays in the format [YYYY, MM, DD]."}], "description": "Fired when a selection is made", "guessedname": "selectEvent", "guessedtype": "property"}, "beforeHideEvent": {"description": "Fired just before the Calendar is to be hidden", "guessedname": "beforeHideEvent", "guessedtype": "property"}, "beforeShowNavEvent": {"description": "Fired just before the CalendarNavigator is to be shown", "guessedname": "beforeShowNavEvent", "guessedtype": "property"}, "deselectEvent": {"params": [{"type": "Array", "name": "Array", "description": " of Date field arrays in the format [YYYY, MM, DD]."}], "description": "Fired when a selection is made", "guessedname": "deselectEvent", "guessedtype": "property"}, "resetEvent": {"description": "Fired when the Calendar is reset", "guessedname": "resetEvent", "guessedtype": "property"}}, "methods": {"show": {"description": "Shows the Calendar's outer container.", "guessedname": "show", "guessedtype": "function"}, "nextYear": {"description": "Navigates to the next year in the currently selected month in the calendar widget.", "guessedname": "nextYear", "guessedtype": "function"}, "configLocale": {"description": "The default handler for all configuration locale properties", "guessedname": "configLocale", "guessedtype": "function"}, "subtractYears": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of years to subtract from the current calendar"}], "description": "Subtcats the designated number of years from the current calendar, and sets the current\ncalendar page date to the new month.", "guessedname": "subtractYears", "guessedtype": "function"}, "buildWeekdays": {"return": {"type": "Array", "description": "The current working HTML array"}, "params": [{"type": "Array", "name": "html", "description": "\tThe current working HTML array"}], "description": "Renders the Calendar's weekday headers.", "guessedname": "buildWeekdays", "guessedtype": "function"}, "_parseArgs": {"return": {"type": "Object", "description": "Object with id, container, config properties containing\nthe reconciled argument values."}, "description": "Protected helper used to parse Calendar constructor\/init arguments.\nAs of 2.4.0, Calendar supports a simpler constructor \nsignature. This method reconciles arguments\nreceived in the pre 2.4.0 and 2.4.0 formats.", "protected": "", "params": [{"type": "Array", "name": "Function", "description": " \"arguments\" array"}], "guessedname": "_parseArgs", "guessedtype": "function"}, "previousMonth": {"description": "Navigates to the previous month page in the calendar widget.", "guessedname": "previousMonth", "guessedtype": "function"}, "getSelectedDates": {"return": {"type": "Date[]", "description": "An array of currently selected JavaScript Date objects."}, "description": "Gets the list of currently selected dates from the calendar.", "guessedname": "getSelectedDates", "guessedtype": "function"}, "renderOutOfBoundsDate": {"return": {"type": "String", "description": "YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering\nshould not be terminated"}, "params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a cell that falls before the minimum date or after the maximum date.\nwidget class.", "guessedname": "renderOutOfBoundsDate", "guessedtype": "function"}, "previousYear": {"description": "Navigates to the previous year in the currently selected month in the calendar widget.", "guessedname": "previousYear", "guessedtype": "function"}, "addMonths": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of months to add to the current calendar"}], "description": "Adds the designated number of months to the current calendar month, and sets the current\ncalendar page date to the new month.", "guessedname": "addMonths", "guessedtype": "function"}, "renderBody": {"return": {"type": "Array", "description": "The current working HTML array"}, "params": [{"type": "Date", "name": "workingDate", "description": "\tThe current working Date being used for the render process"}, {"type": "Array", "name": "html", "description": "\tThe current working HTML array"}], "description": "Renders the calendar body.", "guessedname": "renderBody", "guessedtype": "function"}, "addMonthRenderer": {"params": [{"type": "Number", "name": "month", "description": "\t\tThe month (1-12) to associate with this renderer"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a month to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the month passed to this method.", "guessedname": "addMonthRenderer", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "id", "description": " optional The id of the table element that will represent the Calendar widget. As of 2.4.0, this argument is optional."}, {"type": "String | HTMLElement", "name": "container", "description": " The id of the container div element that will wrap the Calendar table, or a reference to a DIV element which exists in the document."}, {"type": "Object", "name": "config", "description": " optional The configuration object containing the initial configuration values for the Calendar."}], "description": "Initializes the Calendar widget.", "guessedname": "init", "guessedtype": "function"}, "addRenderer": {"params": [{"type": "String", "name": "sDates", "description": "\t\tA date string to associate with the specified renderer. Valid formats\ninclude date (12\/24\/2005), month\/day (12\/24), and range (12\/1\/2004-1\/1\/2005)"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a renderer to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the conditions specified in the date string for this renderer.", "guessedname": "addRenderer", "guessedtype": "function"}, "applyListeners": {"description": "Applies the Calendar's DOM listeners to applicable elements.", "guessedname": "applyListeners", "guessedtype": "function"}, "clearAllBodyCellStyles": {"params": [{"type": "style", "name": "style", "description": " The CSS class name to remove from all calendar body cells"}], "description": "Removes all styles from all body cells in the current calendar table.", "guessedname": "clearAllBodyCellStyles", "guessedtype": "function"}, "_parsePageDate": {"return": {"type": "Date", "description": "The Date object representing the pagedate"}, "description": "Parses a pagedate configuration property value. The value can either be specified as a string of form \"mm\/yyyy\" or a Date object \nand is parsed into a Date object normalized to the first day of the month. If no value is passed in, the month and year from today's date are used to create the Date object", "private": "", "params": [{"type": "Date|String", "name": "date", "description": "\tPagedate value which needs to be parsed"}], "guessedname": "_parsePageDate", "guessedtype": "function"}, "getIndexFromId": {"return": {"type": "Number", "description": "The index of the cell, or -1 if id does not contain an index number"}, "params": [{"type": "String", "name": "strId", "description": " The cell id"}], "description": "Given the id used to mark each Calendar cell, this method\nextracts the index number from the id.", "guessedname": "getIndexFromId", "guessedtype": "function"}, "createTitleBar": {"return": {"type": "", "description": "The title bar element"}, "params": [{"type": "String", "name": "strTitle", "description": " The title to display in the title bar"}], "description": "Creates the title bar element and adds it to Calendar container DIV", "guessedname": "createTitleBar", "guessedtype": "function"}, "onBeforeSelect": {"deprecated": "Event handlers for this event should be susbcribed to beforeSelectEvent.", "description": "Event executed before a date is selected in the calendar widget.", "guessedname": "onBeforeSelect", "guessedtype": "function"}, "removeCloseButton": {"description": "Removes the close button HTML element from the DOM", "guessedname": "removeCloseButton", "guessedtype": "function"}, "renderCellStyleHighlight2": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a single standard calendar cell using the CSS hightlight2 style", "guessedname": "renderCellStyleHighlight2", "guessedtype": "function"}, "renderCellStyleHighlight3": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a single standard calendar cell using the CSS hightlight3 style", "guessedname": "renderCellStyleHighlight3", "guessedtype": "function"}, "renderCellStyleHighlight1": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a single standard calendar cell using the CSS hightlight1 style", "guessedname": "renderCellStyleHighlight1", "guessedtype": "function"}, "renderCellStyleHighlight4": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a single standard calendar cell using the CSS hightlight4 style", "guessedname": "renderCellStyleHighlight4", "guessedtype": "function"}, "renderHeader": {"return": {"type": "Array", "description": "The current working HTML array"}, "params": [{"type": "Array", "name": "html", "description": "\tThe current working HTML array"}], "description": "Renders the calendar header.", "guessedname": "renderHeader", "guessedtype": "function"}, "addYears": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of years to add to the current calendar"}], "description": "Adds the designated number of years to the current calendar, and sets the current\ncalendar page date to the new month.", "guessedname": "addYears", "guessedtype": "function"}, "deselectCell": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "Number", "name": "cellIndex", "description": "\tThe index of the cell to deselect in the current calendar."}], "description": "Deselects a date on the current calendar by referencing the index of the cell that should be deselected.\nThis method is used to easily deselect a single cell (usually with a mouse click) without having to do\na full render. The selected style is removed from the cell directly.\nIf the cell is not marked with the CSS_CELL_SELECTABLE class (as is the case by default for out of month \nor out of bounds cells), the method will not attempt to deselect it and in such a case, beforeDeselect and \ndeselect events will not be fired.", "guessedname": "deselectCell", "guessedtype": "function"}, "removeRenderers": {"description": "Removes all custom renderers added to the Calendar through the addRenderer, addMonthRenderer and \naddWeekdayRenderer methods. Calendar's render method needs to be called after removing renderers \nto re-render the Calendar without custom renderers applied.", "guessedname": "removeRenderers", "guessedtype": "function"}, "configOptions": {"description": "The default handler for all configuration options properties", "guessedname": "configOptions", "guessedtype": "function"}, "deselect": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "String\/Date\/Date[]", "name": "date", "description": "\tThe date string of dates to deselect in the current calendar. Valid formats are\nindividual date(s) (12\/24\/2005,12\/26\/2005) or date range(s) (12\/24\/2005-1\/1\/2006).\nMultiple comma-delimited dates can also be passed to this method (12\/24\/2005,12\/11\/2005-12\/13\/2005).\nThis method can also take a JavaScript Date object or an array of Date objects."}], "description": "Deselects a date or a collection of dates on the current calendar. This method, by default,\ndoes not call the render method explicitly. Once deselection has completed, render must be \ncalled for the changes to be reflected visually.\nThe method will not attempt to deselect any dates which are OOB (out of bounds, and hence not selectable) \nand the array of deselected dates passed to the deselectEvent will not contain any OOB dates.\nIf all dates are OOB, beforeDeselect and deselect events will not be fired.", "guessedname": "deselect", "guessedtype": "function"}, "_indexOfSelectedFieldArray": {"return": {"type": "Number", "description": "The index of the date field array within the collection of selected dates.\n-1 will be returned if the date is not found."}, "description": "Gets the index of a date field array [yyyy,mm,dd] in the current list of selected dates.", "private": "", "params": [{"type": "Number[]", "name": "find", "description": "\tThe date field array to search for"}], "guessedname": "_indexOfSelectedFieldArray", "guessedtype": "function"}, "_parseRange": {"return": {"type": "", "description": "An array of date field arrays"}, "description": "Converts a date range to the full list of included dates", "private": "", "params": [{"type": "Number[]", "name": "startDate", "description": "\tDate field array representing the first date in the range"}, {"type": "Number[]", "name": "endDate", "description": "\t\tDate field array representing the last date in the range"}], "guessedname": "_parseRange", "guessedtype": "function", "type": "Array[](Number[])"}, "toString": {"return": {"type": "String", "description": "A string representation of the Calendar object."}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "renderCellNotThisMonth": {"return": {"type": "String", "description": "YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering\nshould not be terminated"}, "params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Applies the default style used for rendering dates that are not a part of the current\nmonth (preceding or trailing the cells for the current month)", "guessedname": "renderCellNotThisMonth", "guessedtype": "function"}, "configLocaleValues": {"description": "The default handler for all configuration locale field length properties", "guessedname": "configLocaleValues", "guessedtype": "function"}, "buildMonthLabel": {"return": {"type": "String", "description": "The formatted calendar month label"}, "description": "Builds the date label that will be displayed in the calendar header or\nfooter, depending on configuration.", "guessedname": "buildMonthLabel", "guessedtype": "function"}, "_parseDates": {"return": {"type": "", "description": "An array of date field arrays"}, "description": "Converts a multi or single-date string to an array of date field arrays", "private": "", "params": [{"type": "String", "name": "sDates", "description": "\t\tDate string with one or more comma-delimited dates. Valid formats are mm\/dd, mm\/dd\/yyyy, mm\/dd\/yyyy-mm\/dd\/yyyy"}], "guessedname": "_parseDates", "guessedtype": "function", "type": "Array[](Number[])"}, "getDateFieldsByCellId": {"return": {"type": "Array", "description": "The array of Date fields for the specified Calendar cell"}, "params": [{"type": "String", "name": "id", "description": "\tThe id of the cell"}], "description": "Retrieves the Date object for the specified Calendar cell", "guessedname": "getDateFieldsByCellId", "guessedtype": "function"}, "configMaxDate": {"description": "The default handler for the \"maxdate\" property", "guessedname": "configMaxDate", "guessedtype": "function"}, "_addRenderer": {"guessedname": "_addRenderer", "params": [{"type": "String", "name": "type", "description": "\t\tThe type string that indicates the type of date renderer being added.\nValues are YAHOO.widget.Calendar.DATE, YAHOO.widget.Calendar.MONTH_DAY, YAHOO.widget.Calendar.WEEKDAY,\nYAHOO.widget.Calendar.RANGE, YAHOO.widget.Calendar.MONTH"}, {"type": "Array", "name": "aDates", "description": "\t\tAn array of dates used to construct the renderer. The format varies based\non the renderer type"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "The private method used for adding cell renderers to the local render stack.\nThis method is called by other methods that set the renderer type prior to the method call.", "private": "", "guessedtype": "function"}, "setMonth": {"params": [{"type": "Number", "name": "month", "description": "\t\tThe numeric month, from 0 (January) to 11 (December)"}], "description": "Sets the calendar's month explicitly", "guessedname": "setMonth", "guessedtype": "function"}, "_fieldArraysAreEqual": {"return": {"type": "Boolean", "description": "The boolean that represents the equality of the two arrays"}, "description": "Converts a date field array [yyyy,mm,dd] to a JavaScript Date object.", "private": "", "params": [{"type": "Number[]", "name": "array1", "description": "\tThe first date field array to compare"}, {"type": "Number[]", "name": "array2", "description": "\tThe first date field array to compare"}], "guessedname": "_fieldArraysAreEqual", "guessedtype": "function"}, "styleCellDefault": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Styles a selectable cell.", "guessedname": "styleCellDefault", "guessedtype": "function"}, "_parseDate": {"return": {"type": "", "description": "A date field array representing the string passed to the method"}, "description": "Converts a date string to a date field array", "private": "", "params": [{"type": "String", "name": "sDate", "description": "\t\t\tDate string. Valid formats are mm\/dd and mm\/dd\/yyyy."}], "guessedname": "_parseDate", "guessedtype": "function", "type": "Array[](Number[])"}, "doCellMouseOver": {"params": [{"type": "DOMEvent", "name": "e", "description": "\tThe event"}, {"type": "Calendar", "name": "cal", "description": "\tA reference to the calendar passed by the Event utility"}], "description": "The event that is executed when the user hovers over a cell", "guessedname": "doCellMouseOver", "guessedtype": "function"}, "doCellMouseOut": {"params": [{"type": "DOMEvent", "name": "e", "description": "\tThe event"}, {"type": "Calendar", "name": "cal", "description": "\tA reference to the calendar passed by the Event utility"}], "description": "The event that is executed when the user moves the mouse out of a cell", "guessedname": "doCellMouseOut", "guessedtype": "function"}, "onClear": {"deprecated": "Event handlers for this event should be susbcribed to clearEvent.", "description": "Event executed when the calendar widget is completely cleared to the current month with no selections.", "guessedname": "onClear", "guessedtype": "function"}, "onDeselect": {"deprecated": "Event handlers for this event should be susbcribed to deselectEvent.", "params": [{"type": "Array", "name": "selected", "description": "\tAn array of date field arrays representing which date or dates were deselected. Example: [ [2006,8,6],[2006,8,7],[2006,8,8] ]"}], "description": "Event executed when a date is deselected in the calendar widget.", "guessedname": "onDeselect", "guessedtype": "function"}, "configNavigator": {"description": "The default handler for the \"navigator\" property", "guessedname": "configNavigator", "guessedtype": "function"}, "configClose": {"description": "Default handler for the \"close\" property", "guessedname": "configClose", "guessedtype": "function"}, "render": {"description": "Renders the calendar after it has been configured. The render() method has a specific call chain that will execute\nwhen the method is called: renderHeader, renderBody, renderFooter.\nRefer to the documentation for those methods for information on \nindividual render tasks.", "guessedname": "render", "guessedtype": "function"}, "_buildMonthLabel": {"return": {"type": "String", "description": "Formated month, year string"}, "description": "Helper method, to format a Month Year string, given a JavaScript Date, based on the \nCalendar localization settings", "private": "", "params": [{"type": "Date", "name": "date", "description": ""}], "guessedname": "_buildMonthLabel", "guessedtype": "function"}, "initStyles": {"description": "Defines the style constants for the Calendar", "guessedname": "initStyles", "guessedtype": "function"}, "resetRenderers": {"description": "Resets the render stack of the current calendar to its original pre-render value.", "guessedname": "resetRenderers", "guessedtype": "function"}, "select": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "String\/Date\/Date[]", "name": "date", "description": "\tThe date string of dates to select in the current calendar. Valid formats are\nindividual date(s) (12\/24\/2005,12\/26\/2005) or date range(s) (12\/24\/2005-1\/1\/2006).\nMultiple comma-delimited dates can also be passed to this method (12\/24\/2005,12\/11\/2005-12\/13\/2005).\nThis method can also take a JavaScript Date object or an array of Date objects."}], "description": "Selects a date or a collection of dates on the current calendar. This method, by default,\ndoes not call the render method explicitly. Once selection has completed, render must be \ncalled for the changes to be reflected visually.\nAny dates which are OOB (out of bounds, not selectable) will not be selected and the array of \nselected dates passed to the selectEvent will not contain OOB dates.\nIf all dates are OOB, the no state change will occur; beforeSelect and select events will not be fired.", "guessedname": "select", "guessedtype": "function"}, "refreshLocale": {"private": "", "description": "Refreshes the locale values used to build the Calendar.", "guessedname": "refreshLocale", "guessedtype": "function"}, "initEvents": {"description": "Initializes Calendar's built-in CustomEvents", "guessedname": "initEvents", "guessedtype": "function"}, "nextMonth": {"description": "Navigates to the next month page in the calendar widget.", "guessedname": "nextMonth", "guessedtype": "function"}, "onReset": {"deprecated": "Event handlers for this event should be susbcribed to resetEvemt.", "description": "Event executed when the calendar widget is reset to its original state.", "guessedname": "onReset", "guessedtype": "function"}, "addWeekdayRenderer": {"params": [{"type": "Number", "name": "weekday", "description": "\t\tThe weekday (Sunday = 1, Monday = 2 ... Saturday = 7) to associate with this renderer"}, {"type": "Function", "name": "fnRender", "description": "\tThe function executed to render cells that match the render rules for this renderer."}], "description": "Adds a weekday to the render stack. The function reference passed to this method will be executed\nwhen a date cell matches the weekday passed to this method.", "guessedname": "addWeekdayRenderer", "guessedtype": "function"}, "isDateOOM": {"return": {"type": "Boolean", "description": "true if the date is OOM"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date object for which to check the OOM status"}], "description": "Determines whether a given date is OOM (out of month).", "guessedname": "isDateOOM", "guessedtype": "function"}, "getCellIndex": {"return": {"type": "Number", "description": "The index of the date in Calendars cellDates\/cells arrays, or -1 if the date \nis not on the curently rendered Calendar page."}, "params": [{"type": "Date", "name": "date", "description": " JavaScript Date object, for which to find a cell index."}], "description": "Find the Calendar's cell index for a given date.\nIf the date is not found, the method returns -1.\n<p>\nThe returned index can be used to lookup the cell HTMLElement \nusing the Calendar's cells array or passed to selectCell to select \ncells by index. \n<\/p>\nSee <a href=\"#cells\">cells<\/a>, <a href=\"#selectCell\">selectCell<\/a>.", "guessedname": "getCellIndex", "guessedtype": "function"}, "isDateOOB": {"return": {"type": "Boolean", "description": "true if the date is OOB"}, "params": [{"type": "Date", "name": "date", "description": "\tThe JavaScript Date object for which to check the OOB status"}], "description": "Determines whether a given date is OOB (out of bounds - less than the mindate or more than the maxdate).", "guessedname": "isDateOOB", "guessedtype": "function"}, "doSelectCell": {"params": [{"type": "DOMEvent", "name": "e", "description": "\tThe DOM event"}, {"type": "Calendar", "name": "cal", "description": "\tA reference to the calendar"}], "description": "The default event handler for date cell selection. Currently attached to \nthe Calendar's bounding box, referenced by it's <a href=\"#property_oDomContainer\">oDomContainer<\/a> property.", "guessedname": "doSelectCell", "guessedtype": "function"}, "configStrings": {"description": "The default handler for the \"strings\" property", "guessedname": "configStrings", "guessedtype": "function"}, "onRender": {"deprecated": "Event handlers for this event should be susbcribed to renderEvent.", "description": "Event executed when the calendar widget is rendered.", "guessedname": "onRender", "guessedtype": "function"}, "renderRowHeader": {"params": [{"type": "Number", "name": "weekNum", "description": "\tThe week number of the current row"}, {"type": "Array", "name": "cell", "description": "\tThe current working HTML array"}], "description": "Renders the row header for a week.", "guessedname": "renderRowHeader", "guessedtype": "function"}, "renderFooter": {"return": {"type": "Array", "description": "The current working HTML array"}, "params": [{"type": "Array", "name": "html", "description": "\tThe current working HTML array"}], "description": "Renders the calendar footer. In the default implementation, there is\nno footer.", "guessedname": "renderFooter", "guessedtype": "function"}, "configSelected": {"description": "The default handler for the \"selected\" property", "guessedname": "configSelected", "guessedtype": "function"}, "renderRowFooter": {"params": [{"type": "Number", "name": "weekNum", "description": "\tThe week number of the current row"}, {"type": "Array", "name": "cell", "description": "\tThe current working HTML array"}], "description": "Renders the row footer for a week.", "guessedname": "renderRowFooter", "guessedtype": "function"}, "reset": {"description": "Resets the calendar widget to the originally selected month and year, and \nsets the calendar to the initial selection(s).", "guessedname": "reset", "guessedtype": "function"}, "deselectAll": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected.\nAssuming that this function executes properly, the return value should be an empty array.\nHowever, the empty array is returned for the sake of being able to check the selection status\nof the calendar."}, "description": "Deselects all dates on the current calendar.", "guessedname": "deselectAll", "guessedtype": "function"}, "renderBodyCellRestricted": {"return": {"type": "String", "description": "YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering\nshould not be terminated"}, "params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders the current calendar cell as a non-selectable \"black-out\" date using the default\nrestricted style.", "guessedname": "renderBodyCellRestricted", "guessedtype": "function"}, "onBeforeDeselect": {"deprecated": "Event handlers for this event should be susbcribed to beforeDeselectEvent.", "description": "Event executed before a date is deselected in the calendar widget.", "guessedname": "onBeforeDeselect", "guessedtype": "function"}, "onChangePage": {"deprecated": "Event handlers for this event should be susbcribed to changePageEvent.", "description": "Event executed when the user navigates to a different calendar page.", "guessedname": "onChangePage", "guessedtype": "function"}, "_toFieldArray": {"return": {"type": "Array[](Number[])", "description": "Array of date field arrays"}, "description": "Converts a date (either a JavaScript Date object, or a date string) to the internal data structure\nused to represent dates: [[yyyy,mm,dd],[yyyy,mm,dd]].", "private": "", "params": [{"type": "String\/Date\/Date[]", "name": "date", "description": "\tThe date string of dates to deselect in the current calendar. Valid formats are\nindividual date(s) (12\/24\/2005,12\/26\/2005) or date range(s) (12\/24\/2005-1\/1\/2006).\nMultiple comma-delimited dates can also be passed to this method (12\/24\/2005,12\/11\/2005-12\/13\/2005).\nThis method can also take a JavaScript Date object or an array of Date objects."}], "guessedname": "_toFieldArray", "guessedtype": "function"}, "renderCellStyleSelected": {"return": {"type": "String", "description": "YAHOO.widget.Calendar.STOP_RENDER if rendering should stop with this style, null or nothing if rendering\nshould not be terminated"}, "params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Applies the default style used for rendering selected dates to the current calendar cell", "guessedname": "renderCellStyleSelected", "guessedtype": "function"}, "clearElement": {"params": [{"type": "HTMLTableCellElement", "name": "cell", "description": " The cell to clear"}], "description": "Clears the inner HTML, CSS class and style information from the specified cell.", "guessedname": "clearElement", "guessedtype": "function"}, "renderCellDefault": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Renders a single standard calendar cell in the calendar widget table.\nAll logic for determining how a standard default cell will be rendered is \nencapsulated in this method, and must be accounted for when extending the\nwidget class.", "guessedname": "renderCellDefault", "guessedtype": "function"}, "subtractMonths": {"params": [{"type": "Number", "name": "count", "description": "\tThe number of months to subtract from the current calendar"}], "description": "Subtracts the designated number of months from the current calendar month, and sets the current\ncalendar page date to the new month.", "guessedname": "subtractMonths", "guessedtype": "function"}, "buildDayLabel": {"return": {"type": "String", "description": "The formatted day label"}, "params": [{"type": "Date", "name": "workingDate", "description": "\tThe current working date"}], "description": "Builds the date digit that will be displayed in calendar cells", "guessedname": "buildDayLabel", "guessedtype": "function"}, "toDate": {"return": {"type": "Date", "description": "JavaScript Date object representing the date field array."}, "params": [{"type": "Number[]", "name": "dateFieldArray", "description": "\tThe date field array to convert to a JavaScript Date."}], "description": "Converts a date field array [yyyy,mm,dd] to a JavaScript Date object. The date field array\nis the format in which dates are as provided as arguments to selectEvent and deselectEvent listeners.", "guessedname": "toDate", "guessedtype": "function"}, "configPageDate": {"description": "The default handler for the \"pagedate\" property", "guessedname": "configPageDate", "guessedtype": "function"}, "createCloseButton": {"return": {"type": "", "description": "The close HTML element created"}, "description": "Creates the close button HTML element and adds it to Calendar container DIV", "guessedname": "createCloseButton", "guessedtype": "function"}, "destroy": {"description": "Destroys the Calendar instance. The method will remove references\nto HTML elements, remove any event listeners added by the Calendar,\nand destroy the Config and CalendarNavigator instances it has created.", "guessedname": "destroy", "guessedtype": "function"}, "configTitle": {"description": "Default handler for the \"title\" property", "guessedname": "configTitle", "guessedtype": "function"}, "selectCell": {"return": {"type": "Date[]", "description": "Array of JavaScript Date objects representing all individual dates that are currently selected."}, "params": [{"type": "Number", "name": "cellIndex", "description": "\tThe index of the cell to select in the current calendar."}], "description": "Selects a date on the current calendar by referencing the index of the cell that should be selected.\nThis method is used to easily select a single cell (usually with a mouse click) without having to do\na full render. The selected style is applied to the cell directly.\nIf the cell is not marked with the CSS_CELL_SELECTABLE class (as is the case by default for out of month \nor out of bounds cells), it will not be selected and in such a case beforeSelect and select events will not be fired.", "guessedname": "selectCell", "guessedtype": "function"}, "doPreviousMonthNav": {"params": [{"type": "DOMEvent", "name": "e", "description": "\tThe DOM event"}, {"type": "Calendar", "name": "cal", "description": "\tA reference to the calendar"}], "description": "The default event handler for clicks on the \"Previous Month\" navigation UI", "guessedname": "doPreviousMonthNav", "guessedtype": "function"}, "removeTitleBar": {"description": "Removes the title bar element from the DOM", "guessedname": "removeTitleBar", "guessedtype": "function"}, "configMinDate": {"description": "The default handler for the \"mindate\" property", "guessedname": "configMinDate", "guessedtype": "function"}, "hide": {"description": "Hides the Calendar's outer container from view.", "guessedname": "hide", "guessedtype": "function"}, "validate": {"type": "Boolean", "return": {"type": "", "description": "Should return true if the widget validates, and false if\nit doesn't."}, "description": "Validates the calendar widget. This method has no default implementation\nand must be extended by subclassing the widget.", "guessedname": "validate", "guessedtype": "function"}, "getDateByCellId": {"return": {"type": "Date", "description": "The Date object for the specified Calendar cell"}, "params": [{"type": "String", "name": "id", "description": "\tThe id of the cell"}], "description": "Retrieves the Date object for the specified Calendar cell", "guessedname": "getDateByCellId", "guessedtype": "function"}, "clear": {"description": "Clears the selected dates in the current calendar widget and sets the calendar\nto the current month and year.", "guessedname": "clear", "guessedtype": "function"}, "configIframe": {"description": "Default Config listener for the iframe property. If the iframe config property is set to true, \nrenders the built-in IFRAME shim if the container is relatively or absolutely positioned.", "guessedname": "configIframe", "guessedtype": "function"}, "_toDate": {"return": {"type": "Date", "description": "JavaScript Date object representing the date field array"}, "description": "Converts a date field array [yyyy,mm,dd] to a JavaScript Date object.", "deprecated": "Made public, toDate", "private": "", "params": [{"type": "Number[]", "name": "dateFieldArray", "description": "\tThe date field array to convert to a JavaScript Date."}], "guessedname": "_toDate", "guessedtype": "function"}, "onSelect": {"deprecated": "Event handlers for this event should be susbcribed to selectEvent.", "params": [{"type": "Array", "name": "selected", "description": "\tAn array of date field arrays representing which date or dates were selected. Example: [ [2006,8,6],[2006,8,7],[2006,8,8] ]"}], "description": "Event executed when a date is selected in the calendar widget.", "guessedname": "onSelect", "guessedtype": "function"}, "setYear": {"params": [{"type": "Number", "name": "year", "description": "\t\tThe numeric 4-digit year"}], "description": "Sets the calendar's year explicitly.", "guessedname": "setYear", "guessedtype": "function"}, "renderCellStyleToday": {"params": [{"type": "Date", "name": "workingDate", "description": "\t\tThe current working Date object being used to generate the calendar"}, {"type": "HTMLTableCellElement", "name": "cell", "description": "\t\t\tThe current working cell in the calendar"}], "description": "Applies the default style used for rendering today's date to the current calendar cell", "guessedname": "renderCellStyleToday", "guessedtype": "function"}, "doNextMonthNav": {"params": [{"type": "DOMEvent", "name": "e", "description": "\tThe DOM event"}, {"type": "Calendar", "name": "cal", "description": "\tA reference to the calendar"}], "description": "The default event handler for clicks on the \"Next Month\" navigation UI", "guessedname": "doNextMonthNav", "guessedtype": "function"}}, "file": "Calendar.js", "shortname": "Calendar", "properties": {"Style.CSS_HEADER_TEXT": {"guessedname": "CSS_HEADER_TEXT", "guessedtype": "property"}, "Style.CSS_CELL_RIGHT": {"guessedname": "CSS_CELL_RIGHT", "guessedtype": "property"}, "Style.CSS_CELL_BOTTOM": {"guessedname": "CSS_CELL_BOTTOM", "guessedtype": "property"}, "YAHOO.widget.Calendar.WEEKDAY": {"description": "Type constant used for renderers to represent a weekday", "static": "", "guessedname": "WEEKDAY", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Calendar.LONG": {"description": "Constant used to represent long date field string formats (e.g. Monday or February)", "static": "", "guessedname": "LONG", "guessedtype": "property", "type": "String", "final": ""}, "cfg": {"type": "YAHOO.util.Config", "description": "The Config object used to hold the configuration variables for the Calendar", "guessedname": "cfg", "guessedtype": "property"}, "Style.CSS_HEADER": {"guessedname": "CSS_HEADER", "guessedtype": "property"}, "Style.CSS_CELL_HIGHLIGHT4": {"guessedname": "CSS_CELL_HIGHLIGHT4", "guessedtype": "property"}, "Style.CSS_CONTAINER": {"guessedname": "CSS_CONTAINER", "guessedtype": "property"}, "YAHOO.widget.Calendar.MONTH_DAY": {"description": "Type constant used for renderers to represent an individual date across any year (M\/D)", "static": "", "guessedname": "MONTH_DAY", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Calendar.IMG_ROOT": {"description": "The path to be used for images loaded for the Calendar", "deprecated": "You can now customize images by overriding the calclose, calnavleft and calnavright default CSS classes for the close icon, left arrow and right arrow respectively", "static": "", "guessedname": "IMG_ROOT", "guessedtype": "property", "type": "String"}, "Style.CSS_NAV_RIGHT": {"guessedname": "CSS_NAV_RIGHT", "guessedtype": "property"}, "Config": {"description": "The configuration object used to set up the calendars various locale and style options.", "deprecated": "Configuration properties should be set by calling Calendar.cfg.setProperty.", "private": "", "guessedname": "Config", "guessedtype": "property", "type": "Object"}, "id": {"type": "String", "description": "The id that uniquely identifies this Calendar.", "guessedname": "id", "guessedtype": "property"}, "_selectedDates": {"guessedname": "_selectedDates", "type": "Array", "description": "The private list of initially selected dates.", "private": "", "guessedtype": "property"}, "index": {"type": "Number", "description": "The index of this item in the parent group", "guessedname": "index", "guessedtype": "property"}, "YAHOO.widget.Calendar.ONE_CHAR": {"description": "Constant used to represent single character date field string formats (e.g. M, T, W)", "static": "", "guessedname": "ONE_CHAR", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Calendar.STOP_RENDER": {"description": "Constant used for halting the execution of the remainder of the render stack", "static": "", "guessedname": "STOP_RENDER", "guessedtype": "property", "type": "String", "final": ""}, "oNavigator": {"type": "CalendarNavigator", "description": "A reference to the CalendarNavigator instance created for this Calendar.\nWill be null if the \"navigator\" configuration property has not been set", "guessedname": "oNavigator", "guessedtype": "property"}, "YAHOO.widget.Calendar.MONTH": {"description": "Type constant used for renderers to represent a month across any year", "static": "", "guessedname": "MONTH", "guessedtype": "property", "type": "String", "final": ""}, "Style.CSS_CELL": {"guessedname": "CSS_CELL", "guessedtype": "property"}, "renderStack": {"type": "Array[]", "description": "The list of render functions, along with required parameters, used to render cells.", "guessedname": "renderStack", "guessedtype": "property"}, "Style.CSS_CELL_LEFT": {"guessedname": "CSS_CELL_LEFT", "guessedtype": "property"}, "Style.CSS_BODY": {"guessedname": "CSS_BODY", "guessedtype": "property"}, "Style.CSS_CELL_HIGHLIGHT1": {"guessedname": "CSS_CELL_HIGHLIGHT1", "guessedtype": "property"}, "Style.CSS_SINGLE": {"guessedname": "CSS_SINGLE", "guessedtype": "property"}, "_renderStack": {"guessedname": "_renderStack", "type": "Array", "description": "A copy of the initial render functions created before rendering.", "private": "", "guessedtype": "property"}, "Style.CSS_CELL_HIGHLIGHT3": {"guessedname": "CSS_CELL_HIGHLIGHT3", "guessedtype": "property"}, "today": {"type": "Date", "description": "A Date object representing today's date.", "guessedname": "today", "guessedtype": "property"}, "Style.CSS_CELL_HIGHLIGHT2": {"guessedname": "CSS_CELL_HIGHLIGHT2", "guessedtype": "property"}, "Style.CSS_WEEKDAY_CELL": {"guessedname": "CSS_WEEKDAY_CELL", "guessedtype": "property"}, "browser": {"description": "Returns a string representing the current browser.", "deprecated": "As of 2.3.0, environment information is available in YAHOO.env.ua", "see": "YAHOO.env.ua", "guessedname": "browser", "guessedtype": "function", "type": "String"}, "containerId": {"type": "String", "description": "The unique id associated with the Calendar's container", "guessedname": "containerId", "guessedtype": "property"}, "parent": {"type": "CalendarGroup", "description": "The parent CalendarGroup, only to be set explicitly by the parent group", "guessedname": "parent", "guessedtype": "property"}, "Style.CSS_CELL_OOM": {"guessedname": "CSS_CELL_OOM", "guessedtype": "property"}, "Style.CSS_CELL_OOB": {"guessedname": "CSS_CELL_OOB", "guessedtype": "property"}, "YAHOO.widget.Calendar._EVENT_TYPES": {"description": "The set of Custom Event types supported by the Calendar", "private": "", "static": "", "guessedname": "_EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "Style.CSS_CLOSE": {"guessedname": "CSS_CLOSE", "guessedtype": "property"}, "Style.CSS_CALENDAR": {"guessedname": "CSS_CALENDAR", "guessedtype": "property"}, "Style.CSS_CELL_TODAY": {"guessedname": "CSS_CELL_TODAY", "guessedtype": "property"}, "Style.CSS_FOOTER": {"guessedname": "CSS_FOOTER", "guessedtype": "property"}, "YAHOO.widget.Calendar._DEFAULT_CONFIG": {"description": "The set of default Config property keys and values for the Calendar", "private": "", "static": "", "guessedname": "_DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "YAHOO.widget.Calendar.MEDIUM": {"description": "Constant used to represent medium date field string formats (e.g. Mon)", "static": "", "guessedname": "MEDIUM", "guessedtype": "property", "type": "String", "final": ""}, "Style.CSS_CELL_SELECTABLE": {"guessedname": "CSS_CELL_SELECTABLE", "guessedtype": "property"}, "YAHOO.widget.Calendar.RANGE": {"description": "Type constant used for renderers to represent a range of individual dates (M\/D\/Y-M\/D\/Y)", "static": "", "guessedname": "RANGE", "guessedtype": "property", "type": "String", "final": ""}, "Style.CSS_CELL_HOVER": {"guessedname": "CSS_CELL_HOVER", "guessedtype": "property"}, "Style.CSS_CELL_SELECTOR": {"guessedname": "CSS_CELL_SELECTOR", "guessedtype": "property"}, "Options": {"type": "Object", "description": "The local object which contains the Calendar's options", "guessedname": "Options", "guessedtype": "property"}, "Style.CSS_WEEKDAY_ROW": {"guessedname": "CSS_WEEKDAY_ROW", "guessedtype": "property"}, "Style.CSS_CELL_RESTRICTED": {"guessedname": "CSS_CELL_RESTRICTED", "guessedtype": "property"}, "cellDates": {"type": "Array[](Number[])", "description": "The collection of calendar cell dates that is parallel to the cells collection. The array contains dates field arrays in the format of [YYYY, M, D].", "guessedname": "cellDates", "guessedtype": "property"}, "Style.CSS_ROW_HEADER": {"guessedname": "CSS_ROW_HEADER", "guessedtype": "property"}, "Style.CSS_ROW_FOOTER": {"guessedname": "CSS_ROW_FOOTER", "guessedtype": "property"}, "Style.CSS_CELL_TOP": {"guessedname": "CSS_CELL_TOP", "guessedtype": "property"}, "Locale": {"type": "Object", "description": "The local object which contains the Calendar's locale settings", "guessedname": "Locale", "guessedtype": "property"}, "cells": {"type": "HTMLTableCellElement[]", "description": "The collection of calendar table cells", "guessedname": "cells", "guessedtype": "property"}, "Style.CSS_CELL_SELECTED": {"guessedname": "CSS_CELL_SELECTED", "guessedtype": "property"}, "YAHOO.widget.Calendar.DATE": {"description": "Type constant used for renderers to represent an individual date (M\/D\/Y)", "static": "", "guessedname": "DATE", "guessedtype": "property", "type": "String", "final": ""}, "domEventMap": {"type": "Object", "description": "A map of DOM event handlers to attach to cells associated with specific CSS class names", "guessedname": "domEventMap", "guessedtype": "property"}, "YAHOO.widget.Calendar.DISPLAY_DAYS": {"description": "Constant that represents the total number of date cells that are displayed in a given month", "static": "", "guessedname": "DISPLAY_DAYS", "guessedtype": "property", "type": "Number", "final": ""}, "oDomContainer": {"type": "HTMLElement", "description": "The DOM element reference that points to this calendar's container element. The calendar will be inserted into this element when the shell is rendered.", "guessedname": "oDomContainer", "guessedtype": "property"}, "YAHOO.widget.Calendar._STYLES": {"description": "The set of default style constants for the Calendar", "private": "", "static": "", "guessedname": "_STYLES", "guessedtype": "property", "type": "Object", "final": ""}, "Style.CSS_NAV_LEFT": {"guessedname": "CSS_NAV_LEFT", "guessedtype": "property"}, "Style.CSS_NAV": {"guessedname": "CSS_NAV", "guessedtype": "property"}, "YAHOO.widget.Calendar.SHORT": {"description": "Constant used to represent short date field string formats (e.g. Tu or Feb)", "static": "", "guessedname": "SHORT", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Calendar is the base class for the Calendar widget. In its most basic\nimplementation, it has the ability to render a calendar widget on the page\nthat can be manipulated to select a single date, move back and forth between\nmonths and years.\n<p>To construct the placeholder for the calendar widget, the code is as\nfollows:\n<xmp>\n<div id=\"calContainer\"><\/div>\n<\/xmp>\n<\/p>\n<p>\n<strong>NOTE: As of 2.4.0, the constructor's ID argument is optional.<\/strong>\nThe Calendar can be constructed by simply providing a container ID string, \nor a reference to a container DIV HTMLElement (the element needs to exist \nin the document).\nE.g.:\n<xmp>\nvar c = new YAHOO.widget.Calendar(\"calContainer\", configOptions);\n<\/xmp>\nor:\n<xmp>\nvar containerDiv = YAHOO.util.Dom.get(\"calContainer\");\nvar c = new YAHOO.widget.Calendar(containerDiv, configOptions);\n<\/xmp>\n<\/p>\n<p>\nIf not provided, the ID will be generated from the container DIV ID by adding an \"_t\" suffix.\nFor example if an ID is not provided, and the container's ID is \"calContainer\", the Calendar's ID will be set to \"calContainer_t\".\n<\/p>"}, "YAHOO.widget.StackedBarSeries": {"name": "YAHOO.widget.StackedBarSeries", "constructors": [{"description": "StackedBarSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "StackedBarSeries", "file": "Series.js", "guessedtype": "function", "shortname": "StackedBarSeries", "description": "StackedBarSeries class for the YUI Charts widget."}, "YAHOO.widget.Axis": {"name": "YAHOO.widget.Axis", "constructors": [{"description": "Defines a CartesianChart's vertical or horizontal axis."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "Axis", "file": "Axis.js", "guessedtype": "function", "shortname": "Axis", "properties": {"labelFunction": {"type": "String", "description": "A string reference to the globally-accessible function that may be called to\ndetermine each of the label values for this axis. Also accepts function references.", "guessedname": "labelFunction", "guessedtype": "property"}, "type": {"type": "String", "description": "The type of axis.", "guessedname": "type", "guessedtype": "property"}, "reverse": {"type": "Boolean", "description": "If true, the items on the axis will be drawn in opposite direction.", "guessedname": "reverse", "guessedtype": "property"}}, "description": "Defines a CartesianChart's vertical or horizontal axis."}, "YAHOO.util.Cookie": {"name": "YAHOO.util.Cookie", "namespace": "YAHOO.util", "module": "cookie", "guessedname": "Cookie", "methods": {"setSub": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a sub cookie with a given name to a particular value.", "static": "", "guessedname": "setSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to set."}, {"type": "Variant", "name": "value", "description": " The value to set."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true\/false)."}]}, "_parseCookieHash": {"return": {"type": "Object", "description": "An object containing entries for each cookie value."}, "description": "Parses a cookie hash string into an object.", "private": "", "static": "", "guessedname": "_parseCookieHash", "guessedtype": "function", "params": [{"type": "String", "name": "text", "description": " The cookie hash string to parse. The string should already be URL-decoded."}]}, "set": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a cookie with a given name and value.", "static": "", "guessedname": "set", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "Variant", "name": "value", "description": " The value to set for the cookie."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true\/false)."}]}, "_createCookieHash": {"return": {"type": "String", "description": "A string suitable for use as a cookie value."}, "description": "Formats a cookie value for an object containing multiple values.", "private": "", "static": "", "guessedname": "_createCookieHashString", "guessedtype": "function", "params": [{"type": "Object", "name": "hash", "description": " An object of key-value pairs to create a string for."}]}, "setSubs": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Sets a cookie with a given name to contain a hash of name-value pairs.", "static": "", "guessedname": "setSubs", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to set."}, {"type": "Object", "name": "value", "description": " An object containing name-value pairs."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true\/false)."}]}, "get": {"return": {"type": "Variant", "description": "If no converter is specified, returns a string or null if\nthe cookie doesn't exist. If the converter is specified, returns the value\nreturned from the converter or null if the cookie doesn't exist."}, "description": "Returns the cookie value for the given name.", "static": "", "guessedname": "get", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}, {"type": "Function", "name": "converter", "description": " (Optional) A function to run on the value before returning\nit. The function is not used if the cookie doesn't exist."}]}, "_parseCookieString": {"return": {"type": "Object", "description": "An object containing entries for each accessible cookie."}, "description": "Parses a cookie string into an object representing all accessible cookies.", "private": "", "static": "", "guessedname": "_parseCookieString", "guessedtype": "function", "params": [{"type": "String", "name": "text", "description": " The cookie string to parse."}, {"type": "Boolean", "name": "decode", "description": " (Optional) Indicates if the cookie values should be decoded or not. Default is true."}]}, "remove": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Removes a cookie from the machine by setting its expiration date to\nsometime in the past.", "static": "", "guessedname": "remove", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to remove."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), \nand secure (true\/false). The expires option will be overwritten\nby the method."}]}, "getHash": {"return": {"type": "Object", "description": "An object of name-value pairs if the cookie with the given name\nexists, null if it does not."}, "description": "Returns an object containing name-value pairs stored in the cookie with the given name.", "static": "", "guessedname": "getSubs", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}]}, "removeSub": {"return": {"type": "String", "description": "The created cookie string."}, "description": "Removes a sub cookie with a given name.", "static": "", "guessedname": "removeSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie in which the subcookie exists."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to remove."}, {"type": "Object", "name": "options", "description": " (Optional) An object containing one or more\ncookie options: path (a string), domain (a string), expires (a Date object),\nand secure (true\/false). This must be the same settings as the original\nsubcookie."}]}, "getSub": {"return": {"type": "Variant", "description": "If the cookie doesn't exist, null is returned. If the subcookie\ndoesn't exist, null if also returned. If no converter is specified and the\nsubcookie exists, a string is returned. If a converter is specified and the\nsubcookie exists, the value returned from the converter is returned."}, "description": "Returns the value of a subcookie.", "static": "", "guessedname": "getSub", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie to retrieve."}, {"type": "String", "name": "subName", "description": " The name of the subcookie to retrieve."}, {"type": "Function", "name": "converter", "description": " (Optional) A function to run on the value before returning\nit. The function is not used if the cookie doesn't exist."}]}, "_createCookieString": {"return": {"type": "String", "description": "The formatted cookie string."}, "description": "Creates a cookie string that can be assigned into document.cookie.", "private": "", "static": "", "guessedname": "_createCookieString", "guessedtype": "function", "params": [{"type": "String", "name": "name", "description": " The name of the cookie."}, {"type": "String", "name": "value", "description": " The value of the cookie."}, {"type": "encodeValue", "name": "encodeValue", "description": " True to encode the value, false to leave as-is."}, {"type": "Object", "name": "options", "description": " (Optional) Options for the cookie."}]}}, "static": "", "file": "Cookie.js", "guessedtype": "property", "shortname": "Cookie", "description": "Cookie utility."}, "YAHOO.widget.Calendar_Core": {"name": "YAHOO.widget.Calendar_Core", "deprecated": "The old Calendar_Core class is no longer necessary.", "namespace": "YAHOO.widget", "module": "calendar", "guessedname": "Calendar_Core", "extends": "YAHOO.widget.Calendar", "superclass": "YAHOO.widget.Calendar", "file": "Calendar.js", "guessedtype": "property", "shortname": "Calendar_Core"}, "YAHOO.widget.HTMLNode": {"name": "YAHOO.widget.HTMLNode", "constructors": [{"params": [{"type": "object", "name": "oData", "description": " a string or object containing the data that will\r\nbe used to render this node. \r\nProviding a string is the same as providing an object with a single property named html.\r\nAll values in the oData will be used to set equally named properties in the node\r\nas long as the node does have such properties, they are not undefined, private or functions.\r\nAll other attributes are made available in noderef.data, which\r\ncan be used to store custom attributes. TreeView.getNode(s)ByProperty\r\ncan be used to retrieve a node by one of the attributes."}, {"type": "YAHOO.widget.Node", "name": "oParent", "description": " this node's parent node"}, {"type": "boolean", "name": "expanded", "description": " the initial expanded\/collapsed state (deprecated; use oData.expanded)"}, {"type": "boolean", "name": "hasIcon", "description": " specifies whether or not leaf nodes should\r\nbe rendered with or without a horizontal line line and\/or toggle icon. If the icon\r\nis not displayed, the content fills the space it would have occupied.\r\nThis option operates independently of the leaf node presentation logic\r\nfor dynamic nodes.\r\n(deprecated; use oData.hasIcon)"}], "description": "This implementation takes either a string or object for the\r\noData argument. If is it a string, it will use it for the display\r\nof this node (and it can contain any html code). If the parameter\r\nis an object,it looks for a parameter called \"html\" that will be\r\nused for this node's display."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "HTMLNode", "methods": {"getNodeDefinition": {"return": {"type": "Object | false", "description": "definition of the tree or false if any node is defined as dynamic"}, "description": "Returns an object which could be used to build a tree out of this node and its children.\r\nIt can be passed to the tree constructor to reproduce this node as a tree.\r\nIt will return false if any node loads dynamically, regardless of whether it is loaded or not.", "guessedname": "getNodeDefinition", "guessedtype": "function"}, "getContentEl": {"return": {"type": "HTMLElement", "description": "the element"}, "description": "Returns the outer html element for this node's content", "guessedname": "getContentEl", "guessedtype": "function"}}, "extends": "YAHOO.widget.Node", "superclass": "YAHOO.widget.Node", "file": "HTMLNode.js", "guessedtype": "function", "shortname": "HTMLNode", "properties": {"setHtml": {"param": "o {object} An html string or object containing an html property", "description": "Synchronizes the node.data, node.html, and the node's content", "guessedname": "setHtml", "guessedtype": "function"}, "_type": {"description": "The node type", "default": "\"HTMLNode\"", "private": "", "guessedname": "_type", "guessedtype": "property", "type": "string"}, "html": {"type": "string", "description": "The HTML content to use for this node's display", "guessedname": "html", "guessedtype": "property"}, "initContent": {"param": "oData {object} An html string or object containing an html property", "description": "Sets up the node label", "guessedname": "initContent", "guessedtype": "function"}, "contentStyle": {"type": "string", "description": "The CSS class for the html content container. Defaults to ygtvhtml, but \r\ncan be overridden to provide a custom presentation for a specific node.", "guessedname": "contentStyle", "guessedtype": "property"}}, "description": "This implementation takes either a string or object for the\r\noData argument. If is it a string, it will use it for the display\r\nof this node (and it can contain any html code). If the parameter\r\nis an object,it looks for a parameter called \"html\" that will be\r\nused for this node's display."}, "YAHOO.util.ArrayAssert": {"name": "YAHOO.util.ArrayAssert", "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "ArrayAssert", "methods": {"containsMatch": {"static": "", "params": [{"type": "Function", "name": "matcher", "description": " A function that returns true if the items matches or false if not."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value matching some condition is present in an array. This uses\na function to determine a match.", "guessedname": "containsMatch", "guessedtype": "function"}, "doesNotContain": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value that is expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is not present in an array. This uses the triple equals \nsign so no type cohersion may occur.", "guessedname": "doesNotContain", "guessedtype": "function"}, "indexOf": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value to look for."}, {"type": "Array", "name": "haystack", "description": " The array to search in."}, {"type": "int", "name": "index", "description": " The index at which the value should exist."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the given value is contained in an array at the specified index.\nThis uses the triple equals sign so no type cohersion will occur.", "guessedname": "indexOf", "guessedtype": "function"}, "itemsAreSame": {"static": "", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the values in an array are the same, and in the same position,\nas values in another array. This uses the triple equals sign\nso no type cohersion will occur. Note that the array objects themselves\nneed not be the same for this test to pass.", "guessedname": "itemsAreSame", "guessedtype": "function"}, "contains": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value that is expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a value is present in an array. This uses the triple equals \nsign so no type cohersion may occur.", "guessedname": "contains", "guessedtype": "function"}, "containsItems": {"static": "", "params": [{"type": "Object[]", "name": "needles", "description": " An array of values that are expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values to check."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a set of values are present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nbe found.", "guessedname": "containsItems", "guessedtype": "function"}, "doesNotContainItems": {"static": "", "params": [{"type": "Object[]", "name": "needles", "description": " An array of values that are not expected in the array."}, {"type": "Array", "name": "haystack", "description": " An array of values to check."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that a set of values are not present in an array. This uses the triple equals \nsign so no type cohersion may occur. For this assertion to pass, all values must\nnot be found.", "guessedname": "doesNotContainItems", "guessedtype": "function"}, "itemsAreEquivalent": {"return": {"type": "Void", "description": ""}, "description": "Asserts that the values in an array are equivalent, and in the same position,\nas values in another array. This uses a function to determine if the values\nare equivalent. Note that the array objects themselves\nneed not be the same for this test to pass.", "static": "", "guessedname": "itemsAreEquivalent", "guessedtype": "function", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "Function", "name": "comparator", "description": " A function that returns true if the values are equivalent\nor false if not."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}]}, "itemsAreEqual": {"static": "", "params": [{"type": "Array", "name": "expected", "description": " An array of the expected values."}, {"type": "Array", "name": "actual", "description": " Any array of the actual values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the values in an array are equal, and in the same position,\nas values in another array. This uses the double equals sign\nso type cohersion may occur. Note that the array objects themselves\nneed not be the same for this test to pass.", "guessedname": "itemsAreEqual", "guessedtype": "function"}, "isEmpty": {"static": "", "params": [{"type": "Array", "name": "actual", "description": " The array to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an array is empty.", "guessedname": "isEmpty", "guessedtype": "function"}, "lastIndexOf": {"static": "", "params": [{"type": "Object", "name": "needle", "description": " The value to look for."}, {"type": "Array", "name": "haystack", "description": " The array to search in."}, {"type": "int", "name": "index", "description": " The index at which the value should exist."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that the given value is contained in an array at the specified index,\nstarting from the back of the array.\nThis uses the triple equals sign so no type cohersion will occur.", "guessedname": "lastIndexOf", "guessedtype": "function"}, "isNotEmpty": {"static": "", "params": [{"type": "Array", "name": "actual", "description": " The array to test."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that an array is not empty.", "guessedname": "isNotEmpty", "guessedtype": "function"}, "doesNotContainMatch": {"static": "", "params": [{"type": "Function", "name": "matcher", "description": " A function that returns true if the items matches or false if not."}, {"type": "Array", "name": "haystack", "description": " An array of values."}, {"type": "String", "name": "message", "description": " (Optional) The message to display if the assertion fails."}], "description": "Asserts that no values matching a condition are present in an array. This uses\na function to determine a match.", "guessedname": "doesNotContainMatch", "guessedtype": "function"}}, "static": "", "file": "ArrayAssert.js", "guessedtype": "property", "shortname": "ArrayAssert", "description": "The ArrayAssert object provides functions to test JavaScript array objects\nfor a variety of cases."}, "YAHOO.widget.StackedColumnChart": {"name": "YAHOO.widget.StackedColumnChart", "constructors": [{"params": [{"type": "HTMLElement", "name": "containerId", "description": " Container element for the Flash Player instance."}, {"type": "YAHOO.util.DataSource", "name": "dataSource", "description": " DataSource instance."}, {"type": "object", "name": "attributes", "description": " (optional) Object literal of configuration values."}], "description": "StackedColumnChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "StackedColumnChart", "uses": ["YAHOO.widget.CartesianChart"], "file": "ChartTypes.js", "guessedtype": "function", "shortname": "StackedColumnChart", "description": "StackedColumnChart class for the YUI Charts widget."}, "YAHOO.util.DataSourceBase": {"name": "YAHOO.util.DataSourceBase", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "Base class for the YUI DataSource utility."}], "namespace": "YAHOO.util", "module": "datasource", "properties": {"TYPE_HTMLTABLE": {"description": "Type is an HTML TABLE element. Data is parsed out of TR elements from all TBODY elements.", "default": "6", "guessedname": "TYPE_HTMLTABLE", "guessedtype": "property", "type": "Number", "final": ""}, "maxCacheEntries": {"default": "0", "type": "Number", "description": "Max size of the local cache. Set to 0 to turn off caching. Caching is\nuseful to reduce the number of server connections. Recommended only for data\nsources that return comprehensive results for queries or when stale data is\nnot an issue.", "guessedname": "maxCacheEntries", "guessedtype": "property"}, "_oQueue": {"guessedname": "_oQueue", "type": "Object", "description": "Local queue of request connections, enabled if queue needs to be managed.", "private": "", "guessedtype": "property"}, "TYPE_SCRIPTNODE": {"description": "Type is hosted on a server via a dynamic script node.", "default": "7", "guessedname": "TYPE_SCRIPTNODE", "guessedtype": "property", "type": "Number", "final": ""}, "TYPE_TEXT": {"description": "Type is plain text.", "default": "5", "guessedname": "TYPE_TEXT", "guessedtype": "property", "type": "Number", "final": ""}, "_sName": {"guessedname": "_sName", "type": "String", "description": "Name of DataSource instance.", "private": "", "guessedtype": "property"}, "DataSourceBase._nTransactionId": {"description": "Internal class variable to assign unique transaction IDs.", "private": "", "static": "", "guessedname": "_nTransactionId", "guessedtype": "property", "type": "Number"}, "responseType": {"default": "YAHOO.util.DataSourceBase.TYPE_UNKNOWN", "type": "Number", "description": "Format of response:\n<dl> \n<dt>TYPE_UNKNOWN<\/dt>\n<dt>TYPE_JSARRAY<\/dt>\n<dt>TYPE_JSON<\/dt>\n<dt>TYPE_XML<\/dt>\n<dt>TYPE_TEXT<\/dt>\n<dt>TYPE_HTMLTABLE<\/dt> \n<\/dl>", "guessedname": "responseType", "guessedtype": "property"}, "DataSourceBase._nIndex": {"description": "Internal class variable to index multiple DataSource instances.", "private": "", "static": "", "guessedname": "_nIndex", "guessedtype": "property", "type": "Number"}, "TYPE_XHR": {"description": "Type is hosted on a server via an XHR connection.", "default": "2", "guessedname": "TYPE_XHR", "guessedtype": "property", "type": "Number", "final": ""}, "TYPE_JSON": {"description": "Type is JSON.", "default": "3", "guessedname": "TYPE_JSON", "guessedtype": "property", "type": "Number", "final": ""}, "TYPE_UNKNOWN": {"description": "Type is unknown.", "default": "-1", "guessedname": "TYPE_UNKNOWN", "guessedtype": "property", "type": "Number", "final": ""}, "TYPE_JSFUNCTION": {"description": "Type is a JavaScript Function.", "default": "1", "guessedname": "TYPE_JSFUNCTION", "guessedtype": "property", "type": "Number", "final": ""}, "dataType": {"default": "YAHOO.util.DataSourceBase.TYPE_UNKNOWN", "type": "Number", "description": "Where the live data is held:\n<dl> \n<dt>TYPE_UNKNOWN<\/dt>\n<dt>TYPE_LOCAL<\/dt>\n<dt>TYPE_XHR<\/dt>\n<dt>TYPE_SCRIPTNODE<\/dt>\n<dt>TYPE_JSFUNCTION<\/dt>\n<\/dl>", "guessedname": "dataType", "guessedtype": "property"}, "_aCache": {"guessedname": "_aCache", "type": "Object[]", "description": "Local cache of data result object literals indexed chronologically.", "private": "", "guessedtype": "property"}, "liveData": {"type": "Object", "description": "Pointer to live database.", "guessedname": "liveData", "guessedtype": "property"}, "TYPE_LOCAL": {"description": "Type is local.", "default": "8", "guessedname": "TYPE_LOCAL", "guessedtype": "property", "type": "Number", "final": ""}, "ERROR_DATAINVALID": {"description": "Error message for invalid dataresponses.", "default": "\"Invalid data\"", "guessedname": "ERROR_DATAINVALID", "guessedtype": "property", "type": "String", "final": ""}, "responseSchema": {"type": "Object", "description": "Response schema object literal takes a combination of the following properties:\n<dl>\n<dt>resultsList<\/dt> <dd>Pointer to array of tabular data<\/dd>\n<dt>resultNode<\/dt> <dd>Pointer to node name of row data (XML data only)<\/dd>\n<dt>recordDelim<\/dt> <dd>Record delimiter (text data only)<\/dd>\n<dt>fieldDelim<\/dt> <dd>Field delimiter (text data only)<\/dd>\n<dt>fields<\/dt> <dd>Array of field names (aka keys), or array of object literals\nsuch as: {key:\"fieldname\",parser:YAHOO.util.DataSourceBase.parseDate}<\/dd>\n<dt>metaFields<\/dt> <dd>Object literal of keys to include in the oParsedResponse.meta collection<\/dd>\n<dt>metaNode<\/dt> <dd>Name of the node under which to search for meta information in XML response data<\/dd>\n<\/dl>", "guessedname": "responseSchema", "guessedtype": "property"}, "TYPE_JSARRAY": {"description": "Type is a JavaScript Array.", "default": "0", "guessedname": "TYPE_JSARRAY", "guessedtype": "property", "type": "Number", "final": ""}, "TYPE_XML": {"description": "Type is XML.", "default": "4", "guessedname": "TYPE_XML", "guessedtype": "property", "type": "Number", "final": ""}, "ERROR_DATANULL": {"description": "Error message for null data responses.", "default": "\"Null data\"", "guessedname": "ERROR_DATANULL", "guessedtype": "property", "type": "String", "final": ""}, "DataSource.Parser": {"type": "Object", "static": "", "description": "Data parsing functions.", "guessedname": "Parser", "guessedtype": "property"}, "_aIntervals": {"guessedname": "_aIntervals", "type": "Array", "description": "Array of polling interval IDs that have been enabled, needed to clear all intervals.", "private": "", "guessedtype": "property"}}, "guessedname": "DataSourceBase", "methods": {"flushCache": {"description": "Flushes cache.", "guessedname": "flushCache", "guessedtype": "function"}, "DataSourceBase.parseNumber": {"return": {"type": "Number", "description": "A number, or null if NaN."}, "description": "Converts data to type Number.", "static": "", "guessedname": "parseNumber", "guessedtype": "function", "params": [{"type": "String | Number | Boolean | Null", "name": "oData", "description": " Data to convert. Beware, null\nreturns as 0."}]}, "parseArrayData": {"return": {"type": "Object", "description": "Parsed response object with the following properties:<br>\n- results (Array) Array of parsed data results<br>\n- error (Boolean) True if there was an error"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full Array from the live database."}], "description": "Overridable method parses Array data into a response object.", "guessedname": "parseArrayData", "guessedtype": "function"}, "sendRequest": {"return": {"type": "Number", "description": "Transaction ID, or null if response found in cache."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " An object literal with the following properties:\n<dl>\n<dt><code>success<\/code><\/dt>\n<dd>The function to call when the data is ready.<\/dd>\n<dt><code>failure<\/code><\/dt>\n<dd>The function to call upon a response failure condition.<\/dd>\n<dt><code>scope<\/code><\/dt>\n<dd>The object to serve as the scope for the success and failure handlers.<\/dd>\n<dt><code>argument<\/code><\/dt>\n<dd>Arbitrary data that will be passed back to the success and failure handlers.<\/dd>\n<\/dl>"}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "First looks for cached response, then sends request to live data.", "guessedname": "sendRequest", "guessedtype": "function"}, "issueCallback": {"static": "", "params": [{"type": "Function|Object", "name": "callback", "description": " the callback to execute"}, {"type": "Array", "name": "params", "description": " params to be passed to the callback method"}, {"type": "Boolean", "name": "error", "description": " whether an error occurred"}, {"type": "Object", "name": "scope", "description": " the scope from which to execute the callback\n(deprecated - use an object literal callback)"}], "description": "Executes a configured callback. For object literal callbacks, the third\nparam determines whether to execute the success handler or failure handler.", "guessedname": "issueCallback", "guessedtype": "function"}, "parseData": {"return": {"type": "Object} Parsed response object with the following properties:<br>\n- results {Array} Array of parsed data results<br>\n- meta {Object} Object literal of meta values<br>\n- error {Boolean", "description": "(optional) True if there was an error<br>"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full Array from the live database."}], "description": "Overridable method parses data of generic RESPONSE_TYPE into a response object.", "guessedname": "parseData", "guessedtype": "function"}, "parseTextData": {"return": {"type": "Object", "description": "Parsed response object with the following properties:<br>\n- results (Array) Array of parsed data results<br>\n- error (Boolean) True if there was an error"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full text response from the live database."}], "description": "Overridable method parses plain text data into a response object.", "guessedname": "parseTextData", "guessedtype": "function"}, "parseHTMLTableData": {"return": {"type": "Object", "description": "Parsed response object with the following properties<br>\n- results (Array) Array of parsed data results<br>\n- error (Boolean) True if there was an error"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full HTML element reference from the live database."}], "description": "Overridable method parses an HTML TABLE element reference into a response object.\nData is parsed out of TR elements from all TBODY elements.", "guessedname": "parseHTMLTableData", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the DataSource instance."}, "description": "Public accessor to the unique name of the DataSource instance.", "guessedname": "toString", "guessedtype": "function"}, "parseJSONData": {"return": {"type": "Object", "description": "Parsed response object with the following properties<br>\n- results (Array) Array of parsed data results<br>\n- error (Boolean) True if there was an error"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full JSON from the live database."}], "description": "Overridable method parses JSON data into a response object.", "guessedname": "parseJSONData", "guessedtype": "function"}, "doBeforeCallback": {"return": {"type": "Object", "description": "Parsed response object."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full response from the live database."}, {"type": "Object", "name": "oParsedResponse", "description": " The parsed response to return to calling object."}, {"type": "Object", "name": "oCallback", "description": " The callback object."}], "description": "Overridable method gives implementers access to the original full response and\nthe parsed response (parsed against the given schema) before the data\nis added to the cache (if applicable) and then sent back to callback function.\nThis is your chance to access the raw response and\/or populate the parsed\nresponse with any custom data.", "guessedname": "doBeforeCallback", "guessedtype": "function"}, "addToCache": {"params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oResponse", "description": " Response object to cache."}], "description": "Adds a new item to the cache. If cache is full, evicts the stalest item\nbefore adding the new item.", "guessedname": "addToCache", "guessedtype": "function"}, "getCachedResponse": {"return": {"type": "Object", "description": "Cached response object or null."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " Callback object."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use callback object."}], "description": "Overridable method passes request to cache and returns cached response if any,\nrefreshing the hit in the cache as the newest item. Returns null if there is\nno cache hit.", "guessedname": "getCachedResponse", "guessedtype": "function"}, "setInterval": {"return": {"type": "Number", "description": "Interval ID."}, "params": [{"type": "Number", "name": "nMsec", "description": " Length of interval in milliseconds."}, {"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Function", "name": "oCallback", "description": " Handler function to receive the response."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "Sets up a polling mechanism to send requests at set intervals and forward\nresponses to given callback.", "guessedname": "setInterval", "guessedtype": "function"}, "parseXMLResult": {"return": {"type": "Object", "description": "Object literal of data for one result."}, "params": [{"type": "XML", "name": "result", "description": " XML for one result."}], "description": "Overridable method parses XML data for one result into an object literal.", "guessedname": "parseXMLResult", "guessedtype": "function"}, "handleResponse": {"params": [{"type": "Object", "name": "oRequest", "description": " Request object"}, {"type": "Object", "name": "oRawResponse", "description": " The raw response from the live database."}, {"type": "Object", "name": "oCallback", "description": " Callback object literal."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}, {"type": "Number", "name": "tId", "description": " Transaction ID."}], "description": "Receives raw data response and type converts to XML, JSON, etc as necessary.\nForwards oFullResponse to appropriate parsing function to get turned into\noParsedResponse. Calls doBeforeCallback() and adds oParsedResponse to \nthe cache when appropriate before calling issueCallback().\nThe oParsedResponse object literal has the following properties:\n<dl>\n<dd><dt>tId {Number}<\/dt> Unique transaction ID<\/dd>\n<dd><dt>results {Array}<\/dt> Array of parsed data results<\/dd>\n<dd><dt>meta {Object}<\/dt> Object literal of meta values<\/dd> \n<dd><dt>error {Boolean}<\/dt> (optional) True if there was an error<\/dd>\n<dd><dt>cached {Boolean}<\/dt> (optional) True if response was cached<\/dd>\n<\/dl>", "guessedname": "handleResponse", "guessedtype": "function"}, "clearInterval": {"params": [{"type": "Number", "name": "nId", "description": " Interval ID."}], "description": "Disables polling mechanism associated with the given interval ID.", "guessedname": "clearInterval", "guessedtype": "function"}, "parseXMLData": {"return": {"type": "Object", "description": "Parsed response object with the following properties<br>\n- results (Array) Array of parsed data results<br>\n- error (Boolean) True if there was an error"}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full XML response from the live database."}], "description": "Overridable method parses XML data into a response object.", "guessedname": "parseXMLData", "guessedtype": "function"}, "DataSourceBase.parseDate": {"return": {"type": "Date", "description": "A Date instance."}, "description": "Converts data to type Date.", "static": "", "guessedname": "parseDate", "guessedtype": "function", "params": [{"type": "Date | String | Number", "name": "oData", "description": " Data to convert."}]}, "makeConnection": {"return": {"type": "Number", "description": "Transaction ID."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " Callback object literal."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "Overridable default method generates a unique transaction ID and passes \nthe live data reference directly to the handleResponse function. This\nmethod should be implemented by subclasses to achieve more complex behavior\nor to access remote data.", "guessedname": "makeConnection", "guessedtype": "function"}, "doBeforeParseData": {"return": {"type": "Object", "description": "Full response for parsing."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oFullResponse", "description": " The full response from the live database."}, {"type": "Object", "name": "oCallback", "description": " The callback object."}], "description": "Overridable method gives implementers access to the original full response\nbefore the data gets parsed. Implementers should take care not to return an\nunparsable or otherwise invalid response.", "guessedname": "doBeforeParseData", "guessedtype": "function"}, "DataSourceBase.parseString": {"return": {"type": "Number", "description": "A string, or null."}, "description": "Converts data to type String.", "static": "", "guessedname": "parseString", "guessedtype": "function", "params": [{"type": "String | Number | Boolean | Date | Array | Object", "name": "oData", "description": " Data to parse.\nThe special values null and undefined will return null."}]}, "isCacheHit": {"return": {"type": "Boolean", "description": "True if given request matches cached request, false otherwise."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCachedRequest", "description": " Cached request object."}], "description": "Default overridable method matches given request to given cached request.\nReturns true if is a hit, returns false otherwise. Implementers should\noverride this method to customize the cache-matching algorithm.", "guessedname": "isCacheHit", "guessedtype": "function"}, "clearAllIntervals": {"description": "Disables all known polling intervals.", "guessedname": "clearAllIntervals", "guessedtype": "function"}}, "file": "DataSource.js", "guessedtype": "function", "shortname": "DataSourceBase", "events": {"dataErrorEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}, {"type": "String", "name": "oArgs.message", "description": " The error message."}], "description": "Fired when an error is encountered with the live data source."}, "responseEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.response", "description": " The raw response object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Number", "name": "oArgs.tId", "description": " Transaction ID."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when live data source sends response."}, "responseCacheEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.response", "description": " The parsed response object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when response is cached."}, "cacheFlushEvent": {"description": "Fired when the local cache is flushed."}, "requestEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Number", "name": "oArgs.tId", "description": " Transaction ID."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when a request is sent to the live data source."}, "cacheRequestEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when a request is made to the local cache."}, "responseParseEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.response", "description": " The parsed response object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when response is parsed."}, "cacheResponseEvent": {"params": [{"type": "Object", "name": "oArgs.request", "description": " The request object."}, {"type": "Object", "name": "oArgs.response", "description": " The response object."}, {"type": "Object", "name": "oArgs.callback", "description": " The callback object."}, {"type": "Object", "name": "oArgs.caller", "description": " (deprecated) Use callback.scope."}], "description": "Fired when data is retrieved from the local cache."}}, "description": "Base class for the YUI DataSource utility."}, "YAHOO.util.UnexpectedError": {"name": "YAHOO.util.UnexpectedError", "constructors": [{"params": [{"type": "Error", "name": "cause", "description": " The unexpected error that caused this error to be \nthrown."}], "description": "UnexpectedError is subclass of AssertionError that is thrown whenever\nan error occurs within the course of a test and the test was not expected\nto throw an error."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "UnexpectedError", "extends": "YAHOO.util.AssertionError", "superclass": "YAHOO.util.AssertionError", "file": "Assert.js", "guessedtype": "function", "shortname": "UnexpectedError", "properties": {"cause": {"type": "Error", "description": "The unexpected error that occurred."}, "name": {"type": "String", "description": "The name of the error that occurred."}, "stack": {"type": "String", "description": "Stack information for the error (if provided)."}}, "description": "UnexpectedError is subclass of AssertionError that is thrown whenever\nan error occurs within the course of a test and the test was not expected\nto throw an error."}, "YAHOO.util.DataSource": {"name": "YAHOO.util.DataSource", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "Factory class for creating a BaseDataSource subclass instance. The sublcass is\ndetermined by oLiveData's type, unless the dataType config is explicitly passed in."}], "namespace": "YAHOO.util", "module": "datasource", "guessedname": "DataSource", "file": "DataSource.js", "guessedtype": "function", "shortname": "DataSource", "description": "Factory class for creating a BaseDataSource subclass instance. The sublcass is\ndetermined by oLiveData's type, unless the dataType config is explicitly passed in."}, "YAHOO.widget.Series": {"name": "YAHOO.widget.Series", "constructors": [{"description": "Series class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "Series", "file": "Series.js", "guessedtype": "function", "shortname": "Series", "properties": {"displayName": {"type": "String", "description": "The human-readable name of the series.", "guessedname": "displayName", "guessedtype": "property"}, "type": {"type": "String", "description": "The type of series.", "guessedname": "type", "guessedtype": "property"}}, "description": "Series class for the YUI Charts widget."}, "YAHOO.util.DDTarget": {"name": "YAHOO.util.DDTarget", "constructors": [{"params": [{"type": "String", "name": "id", "description": " the id of the element that is a drop target"}, {"type": "String", "name": "sGroup", "description": " the group of related DragDrop objects"}, {"type": "object", "name": "config", "description": " an object containing configurable attributes\nValid properties for DDTarget in addition to those in \nDragDrop: \nnone"}], "description": "A DragDrop implementation that does not move, but can be a drop \ntarget. You would get the same result by simply omitting implementation \nfor the event callbacks, but this way we reduce the processing cost of the \nevent listener and the callbacks."}], "namespace": "YAHOO.util", "module": "dragdrop", "guessedname": "DDTarget", "extends": "YAHOO.util.DragDrop", "superclass": "YAHOO.util.DragDrop", "file": "DDTarget.js", "guessedtype": "function", "shortname": "DDTarget", "description": "A DragDrop implementation that does not move, but can be a drop \ntarget. You would get the same result by simply omitting implementation \nfor the event callbacks, but this way we reduce the processing cost of the \nevent listener and the callbacks."}, "YAHOO.widget.ButtonGroup": {"name": "YAHOO.widget.ButtonGroup", "configs": {"disabled": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the button group should be \ndisabled. Disabling the button group will disable each button \nin the button group. Disabled buttons are dimmed and will not \nrespond to user input or fire events."}, "checkedButton": {"default": "null", "type": "{<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a>}", "description": "Reference for the button in the button group that \nis checked."}, "container": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>|String", "description": "HTML element reference or string specifying the id \nattribute of the HTML element that the button group's markup\nshould be rendered into."}, "name": {"default": "null", "type": "String", "description": "String specifying the name for the button group. \nThis name will be applied to each button in the button group."}, "value": {"default": "null", "type": "Object", "description": "Object specifying the value for the button group."}}, "constructors": [{"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the button group."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><div><\/code> element of the button group."}, {"type": "Object", "name": "p_oElement", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button group."}, {"type": "Object", "name": "p_oAttributes", "description": " Optional. Object literal specifying a set \nof configuration attributes used to create the button group."}], "description": "The ButtonGroup class creates a set of buttons that are mutually \nexclusive; checking one button in the set will uncheck all others in the \nbutton group."}], "namespace": "YAHOO.widget", "module": "button", "events": {"beforeValueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeValueChange", "description": "Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change."}, "beforeCheckedButtonChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCheckedButtonChange", "description": "Fires before the value for the configuration attribute 'checkedButton' changes. Return false to cancel the attribute change."}, "valueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "valueChange", "description": "Fires when the value for the configuration attribute 'value' changes."}, "beforeDisabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDisabledChange", "description": "Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change."}, "beforeContainerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContainerChange", "description": "Fires before the value for the configuration attribute 'container' changes. Return false to cancel the attribute change."}, "checkedButtonChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "checkedButtonChange", "description": "Fires when the value for the configuration attribute 'checkedButton' changes."}, "containerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "containerChange", "description": "Fires when the value for the configuration attribute 'container' changes."}, "nameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "nameChange", "description": "Fires when the value for the configuration attribute 'name' changes."}, "beforeNameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNameChange", "description": "Fires before the value for the configuration attribute 'name' changes. Return false to cancel the attribute change."}, "disabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "disabledChange", "description": "Fires when the value for the configuration attribute 'disabled' changes."}}, "guessedname": "ButtonGroup", "methods": {"getButton": {"return": {"type": "<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a>", "description": ""}, "params": [{"type": "Number", "name": "p_nIndex", "description": " The index of the button to retrieve from the \nbutton group."}], "description": "Returns the button at the specified index.", "guessedname": "getButton", "guessedtype": "function"}, "_setDisabled": {"protected": "", "params": [{"type": "Boolean", "name": "p_bDisabled", "description": " Boolean indicating the value for\nthe button group's \"disabled\" attribute."}], "description": "Sets the value of the button groups's \n\"disabled\" attribute.", "guessedname": "_setDisabled", "guessedtype": "function"}, "getButtons": {"return": {"type": "Array", "description": ""}, "description": "Returns an array of the buttons in the button group.", "guessedname": "getButtons", "guessedtype": "function"}, "destroy": {"description": "Removes the button group's element from its parent \nelement and removes all event handlers.", "guessedname": "destroy", "guessedtype": "function"}, "addButtons": {"return": {"type": "Array", "description": ""}, "params": [{"type": "Array", "name": "p_aButtons", "description": " Array of <a href=\"YAHOO.widget.Button.html\">\nYAHOO.widget.Button<\/a> instances to be added \nto the button group."}, {"type": "Array", "name": "p_aButtons", "description": " Array of strings specifying the id \nattribute of the <code><input><\/code> or <code><span>\n<\/code> elements to be used to create the buttons to be added to the \nbutton group."}, {"type": "Array", "name": "p_aButtons", "description": " Array of object references for the \n<code><input><\/code> or <code><span><\/code> elements \nto be used to create the buttons to be added to the button group."}, {"type": "Array", "name": "p_aButtons", "description": " Array of object literals, each containing\na set of <a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a> \nconfiguration attributes used to configure each button to be added \nto the button group."}], "description": "Adds the array of buttons to the button group.", "guessedname": "addButtons", "guessedtype": "function"}, "focus": {"params": [{"type": "Number", "name": "p_nIndex", "description": " Number indicating the index of the button \nto focus."}], "description": "Sets focus to the button at the specified index.", "guessedname": "focus", "guessedtype": "function"}, "addButton": {"return": {"type": "<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a>", "description": ""}, "params": [{"type": "<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a>", "name": "p_oButton", "description": " Object reference for the <a href=\"YAHOO.widget.Button.html\">\nYAHOO.widget.Button<\/a> instance to be added to the button group."}, {"type": "String", "name": "p_oButton", "description": " String specifying the id attribute of the \n<code><input><\/code> or <code><span><\/code> element \nto be used to create the button to be added to the button group."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-6043025\">HTMLInputElement<\/a>|<a href=\"\nhttp:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#\nID-33759296\">HTMLElement<\/a>", "name": "p_oButton", "description": " Object reference for the \n<code><input><\/code> or <code><span><\/code> element \nto be used to create the button to be added to the button group."}, {"type": "Object", "name": "p_oButton", "description": " Object literal specifying a set of \n<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a> \nconfiguration attributes used to configure the button to be added to \nthe button group."}], "description": "Adds the button to the button group.", "guessedname": "addButton", "guessedtype": "function"}, "removeButton": {"params": [{"type": "Number", "name": "p_nIndex", "description": " Number specifying the index of the button \nto be removed from the button group."}], "description": "Removes the button at the specified index from the \nbutton group.", "guessedname": "removeButton", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><div><\/code> element of the button group."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-22445964\">HTMLDivElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying the <code><div><\/code> element of the button group."}, {"type": "Object", "name": "p_oElement", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button group."}, {"type": "Object", "name": "p_oAttributes", "description": " Optional. Object literal specifying a\nset of configuration attributes used to create the button group."}], "description": "The ButtonGroup class's initialization method.", "guessedname": "init", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "p_oAttributes", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button group."}], "description": "Initializes all of the configuration attributes used to \ncreate the button group.", "guessedname": "initAttributes", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the button group.", "guessedname": "toString", "guessedtype": "function"}, "getCount": {"return": {"type": "Number", "description": ""}, "description": "Returns the number of buttons in the button group.", "guessedname": "getCount", "guessedtype": "function"}, "_onAppendTo": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the event that was fired."}], "description": "\"appendTo\" event handler for the button group.", "guessedname": "_onAppendTo", "guessedtype": "function"}, "_onButtonCheckedChange": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the event that was fired."}, {"type": "<a href=\"YAHOO.widget.Button.html\">YAHOO.widget.Button<\/a>", "name": "p_oButton", "description": " Object representing the button that fired the event."}], "description": "\"checkedChange\" event handler for each button in the \nbutton group.", "guessedname": "_onButtonCheckedChange", "guessedtype": "function"}, "_onKeyDown": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"keydown\" event handler for the button group.", "guessedname": "_onKeyDown", "guessedtype": "function"}, "check": {"params": [{"type": "Number", "name": "p_nIndex", "description": " Number indicating the index of the button \nto check."}], "description": "Checks the button at the specified index.", "guessedname": "check", "guessedtype": "function"}, "_createGroupElement": {"protected": "", "return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-22445964\">HTMLDivElement<\/a>", "description": ""}, "description": "Creates the button group's element.", "guessedname": "_createGroupElement", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "buttongroup.js", "guessedtype": "function", "shortname": "ButtonGroup", "properties": {"_buttons": {"description": "Array of buttons in the button group.", "default": "null", "protected": "", "guessedname": "_buttons", "guessedtype": "property", "type": "Array"}, "CSS_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied \nto the button group's element.", "default": "\"yui-buttongroup\"", "guessedname": "CSS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}, "NODE_NAME": {"description": "The name of the tag to be used for the button \ngroup's element.", "default": "\"DIV\"", "guessedname": "NODE_NAME", "guessedtype": "property", "type": "String", "final": ""}}, "description": "The ButtonGroup class creates a set of buttons that are mutually \nexclusive; checking one button in the set will uncheck all others in the \nbutton group."}, "YAHOO.widget.LogReader": {"name": "YAHOO.widget.LogReader", "constructors": [{"params": [{"type": "HTMLElement", "name": "elContainer", "description": " (optional) DOM element reference of an existing DIV."}, {"type": "String", "name": "elContainer", "description": " (optional) String ID of an existing DIV."}, {"type": "Object", "name": "oConfigs", "description": " (optional) Object literal of configuration params."}], "description": "The LogReader class provides UI to read messages logged to YAHOO.widget.Logger."}], "namespace": "YAHOO.widget", "module": "logger", "guessedname": "LogReader", "methods": {"getLastTime": {"return": {"type": "Date", "description": "Timestamp of the last log."}, "description": "Gets timestamp of the last log.", "guessedname": "getLastTime", "guessedtype": "function"}, "_onReset": {"guessedname": "_onReset", "params": [{"type": "String", "name": "sType", "description": " The event."}, {"type": "Object[]", "name": "aArgs", "description": " Data passed from event firer."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles Logger's resetEvent.", "private": "", "guessedtype": "function"}, "show": {"description": "Shows UI of LogReader. Logging functionality is not disrupted.", "guessedname": "show", "guessedtype": "function"}, "setTitle": {"params": [{"type": "String", "name": "sTitle", "description": " New title."}], "description": "Updates title to given string.", "guessedname": "setTitle", "guessedtype": "function"}, "getCategories": {"return": {"type": "String[]", "description": "Array of enabled categories."}, "description": "Returns array of enabled categories.", "guessedname": "getCategories", "guessedtype": "function"}, "_createSourceCheckbox": {"guessedname": "_createSourceCheckbox", "params": [{"type": "String", "name": "sSource", "description": " Source name."}], "description": "Creates a checkbox in the LogReader footer element to filter by source.", "private": "", "guessedtype": "function"}, "_onClickClearBtn": {"guessedname": "_onClickClearBtn", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles click events on the clear button.", "private": "", "guessedtype": "function"}, "_initCategories": {"private": "", "description": "Initializes category filters.", "guessedname": "_initCategories", "guessedtype": "function"}, "pause": {"description": "Pauses output of log messages. While paused, log messages are not lost, but\nget saved to a buffer and then output upon resume of LogReader.", "guessedname": "pause", "guessedtype": "function"}, "hide": {"description": "Hides UI of LogReader. Logging functionality is not disrupted.", "guessedname": "hide", "guessedtype": "function"}, "_printToConsole": {"guessedname": "_printToConsole", "params": [{"type": "Object[]", "name": "aEntries", "description": " Array of LogMsg objects to output to console."}], "description": "Cycles through an array of log messages, and outputs each one to the console\nif its category has not been filtered out.", "private": "", "guessedtype": "function"}, "_initHeaderEl": {"private": "", "description": "Initializes the header element.", "guessedname": "_initHeaderEl", "guessedtype": "function"}, "_initDragDrop": {"private": "", "description": "Initializes Drag and Drop on the header element.", "guessedname": "_initDragDrop", "guessedtype": "function"}, "_printBuffer": {"private": "", "description": "Sends buffer of log messages to output and clears buffer.", "guessedname": "_printBuffer", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the LogReader instance."}, "description": "Public accessor to the unique name of the LogReader instance.", "guessedname": "toString", "guessedtype": "function"}, "showSource": {"params": [{"type": "String", "name": "Source", "description": " name."}], "description": "Shows log messages associated with given source.", "guessedname": "showSource", "guessedtype": "function"}, "getCheckbox": {"return": {"type": "Array", "description": "Array of all filter checkboxes."}, "params": [{"type": "String", "name": "Category", "description": " or source name."}], "description": "Returns related checkbox element for given filter (i.e., category or source).", "guessedname": "getCheckbox", "guessedtype": "function"}, "showCategory": {"params": [{"type": "String", "name": "Category", "description": " name."}], "description": "Shows log messages associated with given category.", "guessedname": "showCategory", "guessedtype": "function"}, "_onClickCollapseBtn": {"guessedname": "_onClickCollapseBtn", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance"}], "description": "Handles click events on the collapse button.", "private": "", "guessedtype": "function"}, "_onCategoryCreate": {"guessedname": "_onCategoryCreate", "params": [{"type": "String", "name": "sType", "description": " The event."}, {"type": "Object[]", "name": "aArgs", "description": " Data passed from event firer."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles Logger's categoryCreateEvent.", "private": "", "guessedtype": "function"}, "collapse": {"description": "Collapses UI of LogReader. Logging functionality is not disrupted.", "guessedname": "collapse", "guessedtype": "function"}, "resume": {"description": "Resumes output of log messages, including outputting any log messages that\nhave been saved to buffer while paused.", "guessedname": "resume", "guessedtype": "function"}, "_onSourceCreate": {"guessedname": "_onSourceCreate", "params": [{"type": "String", "name": "sType", "description": " The event."}, {"type": "Object[]", "name": "aArgs", "description": " Data passed from event firer."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles Logger's sourceCreateEvent.", "private": "", "guessedtype": "function"}, "_onClickPauseBtn": {"guessedname": "_onClickPauseBtn", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles click events on the pause button.", "private": "", "guessedtype": "function"}, "_initFooterEl": {"private": "", "description": "Initializes the footer element.", "guessedname": "_initFooterEl", "guessedtype": "function"}, "_onNewLog": {"guessedname": "_onNewLog", "params": [{"type": "String", "name": "sType", "description": " The event."}, {"type": "Object[]", "name": "aArgs", "description": " Data passed from event firer."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles Logger's newLogEvent.", "private": "", "guessedtype": "function"}, "html2Text": {"guessedname": "html2Text", "params": [{"type": "String", "name": "sHtml", "description": " String to convert."}], "description": "Converts input chars \"<\", \">\", and \"&\" to HTML entities.", "private": "", "guessedtype": "function"}, "_filterLogs": {"private": "", "description": "Reprints all log messages in the stack through filters.", "guessedname": "_filterLogs", "guessedtype": "function"}, "_onCheckCategory": {"guessedname": "_onCheckCategory", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles check events on the category filter checkboxes.", "private": "", "guessedtype": "function"}, "_onCheckSource": {"guessedname": "_onCheckSource", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "Object", "name": "oSelf", "description": " The LogReader instance."}], "description": "Handles check events on the category filter checkboxes.", "private": "", "guessedtype": "function"}, "expand": {"description": "Expands UI of LogReader. Logging functionality is not disrupted.", "guessedname": "expand", "guessedtype": "function"}, "getSources": {"return": {"type": "Array", "description": "Array of enabled sources."}, "description": "Returns array of enabled sources.", "guessedname": "getSources", "guessedtype": "function"}, "_initSources": {"private": "", "description": "Initializes source filters.", "guessedname": "_initSources", "guessedtype": "function"}, "hideCategory": {"params": [{"type": "String", "name": "Category", "description": " name."}], "description": "Hides log messages associated with given category.", "guessedname": "hideCategory", "guessedtype": "function"}, "_createCategoryCheckbox": {"guessedname": "_createCategoryCheckbox", "params": [{"type": "String", "name": "sCategory", "description": " Category name."}], "description": "Creates the UI for a category filter in the LogReader footer element.", "private": "", "guessedtype": "function"}, "_initConsoleEl": {"private": "", "description": "Initializes the console element.", "guessedname": "_initConsoleEl", "guessedtype": "function"}, "_initContainerEl": {"guessedname": "_initContainerEl", "params": [{"type": "HTMLElement", "name": "elContainer", "description": " Container element by reference or string ID."}], "description": "Initializes the primary container element.", "private": "", "guessedtype": "function"}, "clearConsole": {"description": "Does not delete any log messages, but clears all printed log messages from\nthe console. Log messages will be printed out again if user re-filters. The\nstatic method YAHOO.widget.Logger.reset() should be called in order to\nactually delete log messages.", "guessedname": "clearConsole", "guessedtype": "function"}, "hideSource": {"params": [{"type": "String", "name": "Source", "description": " name."}], "description": "Hides log messages associated with given source.", "guessedname": "hideSource", "guessedtype": "function"}}, "file": "LogReader.js", "guessedtype": "function", "shortname": "LogReader", "properties": {"right": {"type": "String", "description": "Public member to access CSS right position of the LogReader container.", "guessedname": "right", "guessedtype": "property"}, "entryFormat": {"default": "null", "type": "String", "description": "Custom output format for log messages. Defaults to null, which falls\nback to verboseOutput param deciding between LogReader.VERBOSE_TEMPLATE\nand LogReader.BASIC_TEMPLATE. Use bracketed place holders to mark where\nmessage info should go. Available place holder names include:\n<ul>\n<li>category<\/li>\n<li>label<\/li>\n<li>sourceAndDetail<\/li>\n<li>message<\/li>\n<li>localTime<\/li>\n<li>elapsedTime<\/li>\n<li>totalTime<\/li>\n<\/ul>", "guessedname": "entryFormat", "guessedtype": "property"}, "height": {"type": "String", "description": "Public member to access CSS height of the LogReader container.", "guessedname": "height", "guessedtype": "property"}, "newestOnTop": {"type": "Boolean", "description": "Whether or not newest message is printed on top.", "guessedname": "newestOnTop", "guessedtype": "property"}, "_elCollapse": {"guessedname": "_elCollapse", "type": "HTMLElement", "description": "LogReader collapse element.", "private": "", "guessedtype": "property"}, "_elCategoryFilters": {"guessedname": "_elCategoryFilters", "type": "HTMLElement", "description": "Container element for LogReader category filter checkboxes.", "private": "", "guessedtype": "property"}, "_memberName": {"description": "Internal class member to index multiple LogReader instances.", "default": "0", "private": "", "static": "", "guessedname": "_index", "guessedtype": "property", "type": "Number"}, "_sName": {"guessedname": "_sName", "type": "String", "description": "Name of LogReader instance.", "private": "", "guessedtype": "property"}, "isCollapsed": {"default": "false", "type": "Boolean", "description": "True when LogReader is in a collapsed state, false otherwise.", "guessedname": "isCollapsed", "guessedtype": "property"}, "_btnCollapse": {"guessedname": "_btnCollapse", "type": "HTMLElement", "description": "LogReader collapse button element.", "private": "", "guessedtype": "property"}, "logReaderEnabled": {"default": "true", "type": "Boolean", "description": "Whether or not LogReader is enabled to output log messages.", "guessedname": "logReaderEnabled", "guessedtype": "property"}, "_filterCheckboxes": {"guessedname": "_filterCheckboxes", "type": "Object", "description": "Hash of filters and their related checkbox elements.", "private": "", "guessedtype": "property"}, "thresholdMax": {"default": "500", "type": "Number", "description": "Maximum number of messages a LogReader console will display.", "guessedname": "thresholdMax", "guessedtype": "property"}, "_buffer": {"guessedname": "_buffer", "type": "Object[]", "description": "Buffer of log message objects for batch output.", "private": "", "guessedtype": "property"}, "bottom": {"type": "String", "description": "Public member to access CSS bottom position of the LogReader container.", "guessedname": "bottom", "guessedtype": "property"}, "_elBtns": {"guessedname": "_elBtns", "type": "HTMLElement", "description": "LogReader buttons container element.", "private": "", "guessedtype": "property"}, "_lastTime": {"guessedname": "_lastTime", "type": "Date", "description": "Date of last output log message.", "private": "", "guessedtype": "property"}, "top": {"type": "String", "description": "Public member to access CSS top position of the LogReader container.", "guessedname": "top", "guessedtype": "property"}, "_btnPause": {"guessedname": "_btnPause", "type": "HTMLElement", "description": "LogReader pause button element.", "private": "", "guessedtype": "property"}, "_elContainer": {"guessedname": "_elContainer", "type": "HTMLElement", "description": "LogReader container element.", "private": "", "guessedtype": "property"}, "width": {"type": "String", "description": "Public member to access CSS width of the LogReader container.", "guessedname": "width", "guessedtype": "property"}, "VERBOSE_TEMPLATE": {"default": "\"<span class='{category}'>{label}<\/span>{totalTime}ms (+{elapsedTime}) {localTime}:<\/p><p>{sourceAndDetail}<\/p><p>{message}<\/p>\"", "static": "", "description": "Template used for innerHTML of verbose entry output.", "guessedname": "VERBOSE_TEMPLATE", "guessedtype": "property"}, "fontSize": {"type": "String", "description": "Public member to access CSS font size of the LogReader container.", "guessedname": "fontSize", "guessedtype": "property"}, "footerEnabled": {"default": "true", "type": "Boolean", "description": "Whether or not the footer UI is enabled for the LogReader.", "guessedname": "footerEnabled", "guessedtype": "property"}, "verboseOutput": {"default": "true", "type": "Boolean", "description": "Whether or not output is verbose (more readable). Setting to true will make\noutput more compact (less readable).", "guessedname": "verboseOutput", "guessedtype": "property"}, "_sourceFilters": {"guessedname": "_sourceFilters", "type": "String[]", "description": "Array of filters for log message sources.", "private": "", "guessedtype": "property"}, "_elHd": {"guessedname": "_elHd", "type": "HTMLElement", "description": "LogReader header element.", "private": "", "guessedtype": "property"}, "_categoryFilters": {"guessedname": "_categoryFilters", "type": "String[]", "description": "Array of filters for log message categories.", "private": "", "guessedtype": "property"}, "_consoleMsgCount": {"description": "Number of log messages output to console.", "default": "0", "private": "", "guessedname": "_consoleMsgCount", "guessedtype": "property", "type": "Number"}, "_elSourceFilters": {"guessedname": "_elSourceFilters", "type": "HTMLElement", "description": "Container element for LogReader source filter checkboxes.", "private": "", "guessedtype": "property"}, "thresholdMin": {"default": "100", "type": "Number", "description": "When a LogReader console reaches its thresholdMax, it will clear out messages\nand print out the latest thresholdMin number of messages.", "guessedname": "thresholdMin", "guessedtype": "property"}, "_title": {"guessedname": "_title", "type": "HTMLElement", "description": "LogReader title header element.", "private": "", "guessedtype": "property"}, "_elDefaultContainer": {"type": "HTMLElement", "description": "A class member shared by all LogReaders if a container needs to be\ncreated during instantiation. Will be null if a container element never needs to\nbe created on the fly, such as when the implementer passes in their own element.", "private": ""}, "_elFt": {"guessedname": "_elFt", "type": "HTMLElement", "description": "LogReader footer element.", "private": "", "guessedtype": "property"}, "outputBuffer": {"default": "100", "type": "Number", "description": "Output timeout buffer in milliseconds.", "guessedname": "outputBuffer", "guessedtype": "property"}, "_elConsole": {"guessedname": "_elConsole", "type": "HTMLElement", "description": "LogReader console element.", "private": "", "guessedtype": "property"}, "draggable": {"default": "true", "type": "Boolean", "description": "Enables draggable LogReader if DragDrop Utility is present.", "guessedname": "draggable", "guessedtype": "property"}, "ENTRY_TEMPLATE": {"description": "Node template for the log entries", "default": "PRE.yui-log-entry element", "static": "", "guessedname": "ENTRY_TEMPLATE", "guessedtype": "function", "type": "{HTMLElement}"}, "isPaused": {"default": "false", "type": "Boolean", "description": "True when LogReader is in a paused state, false otherwise.", "guessedname": "isPaused", "guessedtype": "property"}, "_btnClear": {"guessedname": "_btnClear", "type": "HTMLElement", "description": "Clear button element.", "private": "", "guessedtype": "property"}, "_timeout": {"guessedname": "_timeout", "type": "Number", "description": "Batched output timeout ID.", "private": "", "guessedtype": "property"}, "BASIC_TEMPLATE": {"default": "\"<p><span class='{category}'>{label}<\/span>{totalTime}ms (+{elapsedTime}) {localTime}: {sourceAndDetail}: {message}<\/p>\"", "static": "", "description": "Template used for innerHTML of compact entry output.", "guessedname": "BASIC_TEMPLATE", "guessedtype": "property"}, "left": {"type": "String", "description": "Public member to access CSS left position of the LogReader container.", "guessedname": "left", "guessedtype": "property"}}, "description": "The LogReader class provides UI to read messages logged to YAHOO.widget.Logger."}, "YAHOO.util.ImageLoader.pngBgImgObj": {"name": "YAHOO.util.ImageLoader.pngBgImgObj", "constructors": [{"params": [{"type": "String", "name": "domId", "description": "\tHTML DOM id of the image element"}, {"type": "String", "name": "url", "description": "\tURL for the image"}, {"type": "Object", "name": "ailProps", "description": " The AlphaImageLoader properties to be set for the image\nValid properties are 'sizingMethod' and 'enabled'"}], "description": "PNG background image object. A PNG background image is one whose URL is specified through AlphaImageLoader or by \"background-image\" in the element's style"}], "namespace": "YAHOO.util", "module": "imageloader", "guessedname": "pngBgImgObj", "methods": {"_applyUrl": {"guessedname": "_applyUrl", "params": [{"type": "Object", "name": "el", "description": "\tHTML DOM element"}], "description": "Inserts the image URL into the DOM so that the image is displayed.\nIf the browser is determined to be IE6 (or older), sets the AlphaImageLoader src; otherwise sets style.backgroundImage", "private": "", "guessedtype": "function"}}, "extends": "YAHOO.util.ImageLoader.imgObj", "superclass": "YAHOO.util.ImageLoader.imgObj", "file": "ImageLoader.js", "guessedtype": "function", "shortname": "ImageLoader.pngBgImgObj", "properties": {"props": {"type": "Object", "description": "AlphaImageLoader properties to be set for the image.\nValid properties are \"sizingMethod\" and \"enabled\".", "guessedname": "props", "guessedtype": "property"}}, "description": "PNG background image object. A PNG background image is one whose URL is specified through AlphaImageLoader or by \"background-image\" in the element's style"}, "YAHOO.widget.MenuManager": {"name": "YAHOO.widget.MenuManager", "namespace": "YAHOO.widget", "module": "menu", "guessedname": "MenuManager", "methods": {"getMenuRootElement": {"params": [{"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>", "name": "p_oElement", "description": " Object \nspecifying an HTML element."}], "description": "Finds the root DIV node of a menu or the root LI node of \na menu item.", "private": ""}, "addMenu": {"params": [{"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object specifying the Menu \ninstance to be added."}], "description": "Adds a menu to the collection of known menus.", "guessedname": "addMenu", "guessedtype": "function"}, "getFocusedMenu": {"return": {"type": "YAHOO.widget.Menu", "description": ""}, "description": "Returns a reference to the menu that currently \nhas focus.", "guessedname": "getFocusedMenu", "guessedtype": "function"}, "getMenuItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "params": [{"type": "String", "name": "p_sId", "description": " String specifying the id of the \n<code><li><\/code> element representing the menu item to\nbe retrieved."}], "description": "Returns a menu item with the specified id.", "guessedname": "getMenuItem", "guessedtype": "function"}, "onItemDestroy": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"destroy\" event handler for a MenuItem instance.", "private": ""}, "onMenuShow": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"show\" event handler for a MenuItem instance.", "private": ""}, "getMenu": {"return": {"type": "YAHOO.widget.Menu", "description": ""}, "params": [{"type": "String", "name": "p_sId", "description": " String specifying the id of the \n<code><div><\/code> element representing the menu to\nbe retrieved."}], "description": "Returns a menu with the specified id.", "guessedname": "getMenu", "guessedtype": "function"}, "onMenuDestroy": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}, {"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " The menu that fired the event."}], "description": "\"destroy\" event handler for a menu.", "private": ""}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the menu manager.", "guessedname": "toString", "guessedtype": "function"}, "onItemAdded": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"itemadded\" event handler for a Menu instance.", "private": ""}, "getMenuItemGroup": {"return": {"type": "Array", "description": ""}, "params": [{"type": "String", "name": "p_sId", "description": " String specifying the id of the \n<code><ul><\/code> element representing the group of \nmenu items to be retrieved."}], "description": "Returns an array of menu item instances whose \ncorresponding <code><li><\/code> elements are child \nnodes of the <code><ul><\/code> element with the \nspecified id.", "guessedname": "getMenuItemGroup", "guessedtype": "function"}, "onDOMEvent": {"params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "Generic, global event handler for all of a menu's \nDOM-based events. This listens for events against the document \nobject. If the target of a given event is a member of a menu or \nmenu item's DOM, the instance's corresponding Custom Event is fired.", "private": ""}, "onMenuVisibleConfigChange": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "Event handler for when the \"visible\" configuration \nproperty of a Menu instance changes.", "private": ""}, "onMenuBlur": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"blur\" event handler for a MenuItem instance.", "private": ""}, "removeItem": {"params": [{"type": "MenuItem", "name": "p_oMenuItem", "description": " The MenuItem instance to be removed."}], "description": "Removes a MenuItem instance from the MenuManager's collection of MenuItems.", "private": ""}, "getMenus": {"return": {"type": "Object", "description": ""}, "description": "Returns a collection of all menus registered with the \nmenu manger.", "guessedname": "getMenus", "guessedtype": "function"}, "hideVisible": {"description": "Hides all visible, dynamically positioned menus \n(excluding instances of YAHOO.widget.MenuBar).", "guessedname": "hideVisible", "guessedtype": "function"}, "onMenuHide": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"hide\" event handler for a Menu instance.", "private": ""}, "getVisible": {"return": {"type": "Object", "description": ""}, "description": "Returns a collection of all visible menus registered\nwith the menu manger.", "guessedname": "getVisible", "guessedtype": "function"}, "getFocusedMenuItem": {"return": {"type": "YAHOO.widget.MenuItem", "description": ""}, "description": "Returns a reference to the menu item that currently \nhas focus.", "guessedname": "getFocusedMenuItem", "guessedtype": "function"}, "onMenuFocus": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"focus\" event handler for a MenuItem instance.", "private": ""}, "removeMenu": {"params": [{"type": "YAHOO.widget.Menu", "name": "p_oMenu", "description": " Object specifying the Menu \ninstance to be removed."}], "description": "Removes a menu from the collection of known menus.", "guessedname": "removeMenu", "guessedtype": "function"}}, "static": "", "file": "menumanager.js", "guessedtype": "function", "shortname": "MenuManager", "description": "Singleton that manages a collection of all menus and menu items. Listens \nfor DOM events at the document level and dispatches the events to the \ncorresponding menu or menu item."}, "YAHOO.widget.Logger": {"name": "YAHOO.widget.Logger", "namespace": "YAHOO.widget", "module": "logger", "events": {"logResetEvent": {"description": "Fired when the Logger has been reset has been created.", "guessedname": "logResetEvent", "guessedtype": "property"}, "newLogEvent": {"params": [{"type": "String", "name": "sMsg", "description": " Log message."}], "description": "Fired when a new log message has been created.", "guessedname": "newLogEvent", "guessedtype": "property"}, "sourceCreateEvent": {"params": [{"type": "String", "name": "sSource", "description": " Source name."}], "description": "Fired when a new source has been named.", "guessedname": "sourceCreateEvent", "guessedtype": "property"}, "categoryCreateEvent": {"params": [{"type": "String", "name": "sCategory", "description": " Category name."}], "description": "Fired when a new category has been created.", "guessedname": "categoryCreateEvent", "guessedtype": "property"}}, "guessedname": "Logger", "methods": {"reset": {"description": "Resets internal stack and startTime, enables Logger, and fires logResetEvent.", "guessedname": "reset", "guessedtype": "function"}, "_isNewSource": {"return": {"type": "Boolean", "description": "Returns true if source is unknown, else returns false."}, "description": "Checks to see if a source already exists.", "private": "", "params": [{"type": "String", "name": "sSource", "description": " Source name."}], "guessedname": "_isNewSource", "guessedtype": "function"}, "getStack": {"return": {"type": "Object[]", "description": "Array of log message objects."}, "description": "Public accessor to internal stack of log message objects.", "guessedname": "getStack", "guessedtype": "function"}, "log": {"params": [{"type": "String", "name": "sMsg", "description": " The log message."}, {"type": "String", "name": "sCategory", "description": " Category of log message, or null."}, {"type": "String", "name": "sSource", "description": " Source of LogWriter, or null if global."}], "description": "Saves a log message to the stack and fires newLogEvent. If the log message is\nassigned to an unknown category, creates a new category. If the log message is\nfrom an unknown source, creates a new source. If browser console is enabled,\noutputs the log message to browser console.", "guessedname": "log", "guessedtype": "function"}, "_onWindowError": {"guessedname": "_onWindowError", "params": [{"type": "String", "name": "sMsg", "description": " The error message."}, {"type": "String", "name": "sUrl", "description": " URL of the error."}, {"type": "String", "name": "sLine", "description": " Line number of the error."}], "description": "Handles logging of messages due to window error events.", "private": "", "guessedtype": "function"}, "_isNewCategory": {"return": {"type": "Boolean", "description": "Returns true if category is unknown, else returns false."}, "description": "Checks to see if a category has already been created.", "private": "", "params": [{"type": "String", "name": "sCategory", "description": " Category name."}], "guessedname": "_isNewCategory", "guessedtype": "function"}, "handleWindowErrors": {"description": "Surpresses native JavaScript errors and outputs to console. By default,\nLogger does not handle JavaScript window error events.\nNB: Not all browsers support the window.onerror event.", "guessedname": "handleWindowErrors", "guessedtype": "function"}, "_printToBrowserConsole": {"guessedname": "_printToBrowserConsole", "params": [{"type": "Object", "name": "oEntry", "description": " Log entry object."}], "description": "Outputs a log message to global console.log() function.", "private": "", "guessedtype": "function"}, "_createNewCategory": {"guessedname": "_createNewCategory", "params": [{"type": "String", "name": "sCategory", "description": " Category name."}], "description": "Creates a new category of log messages and fires categoryCreateEvent.", "private": "", "guessedtype": "function"}, "_createNewSource": {"guessedname": "_createNewSource", "params": [{"type": "String", "name": "sSource", "description": " Source name."}], "description": "Creates a new source of log messages and fires sourceCreateEvent.", "private": "", "guessedtype": "function"}, "enableBrowserConsole": {"description": "Enables output to the browser's global console.log() function, which is used\nby the Firebug extension to Firefox as well as Safari.", "guessedname": "enableBrowserConsole", "guessedtype": "function"}, "disableBrowserConsole": {"description": "Disables output to the browser's global console.log() function, which is used\nby the Firebug extension to Firefox as well as Safari.", "guessedname": "disableBrowserConsole", "guessedtype": "function"}, "unhandleWindowErrors": {"description": "Unsurpresses native JavaScript errors. By default,\nLogger does not handle JavaScript window error events.\nNB: Not all browsers support the window.onerror event.", "guessedname": "unhandleWindowErrors", "guessedtype": "function"}, "getStartTime": {"return": {"type": "Date", "description": "Internal date of when Logger singleton was initialized."}, "description": "Public accessor to internal start time.", "guessedname": "getStartTime", "guessedtype": "function"}}, "static": "", "file": "Logger.js", "guessedtype": "property", "shortname": "Logger", "properties": {"maxStackEntries": {"default": "2500", "type": "Number", "static": "", "description": "Upper limit on size of internal stack."}, "_lastTime": {"type": "Date", "static": "", "description": "Timestamp of last logged message.", "private": ""}, "_startTime": {"type": "Date", "static": "", "description": "Static timestamp of Logger initialization.", "private": ""}, "_browserConsoleEnabled": {"default": "false", "type": "Boolean", "static": "", "description": "Internal property to track whether output to browser console is enabled.", "private": ""}, "loggerEnabled": {"default": "true", "type": "Boolean", "static": "", "description": "True if Logger is enabled, false otherwise."}, "sources": {"default": "[\"global\"]", "type": "String[]", "static": "", "description": "Array of sources."}, "_stack": {"type": "Array", "static": "", "description": "Array to hold all log messages.", "private": ""}, "categories": {"default": "[\"info\",\"warn\",\"error\",\"time\",\"window\"]", "type": "String[]", "static": "", "description": "Array of categories."}}, "description": "The singleton Logger class provides core log management functionality. Saves\nlogs written through the global YAHOO.log function or written by a LogWriter\ninstance. Provides access to logs for reading by a LogReader instance or\nnative browser console such as the Firebug extension to Firefox or Safari's\nJavaScript console through integration with the console.log() method."}, "YAHOO.widget.Overlay": {"name": "YAHOO.widget.Overlay", "configs": {"iframe": {"default": "true for IE6 and below, false for all other browsers.", "type": "Boolean", "description": "Boolean indicating whether or not the Overlay should \nhave an IFRAME shim; used to prevent SELECT elements from \npoking through an Overlay instance in IE6. When set to \"true\", \nthe iframe shim is created when the Overlay instance is intially\nmade visible."}, "constraintoviewport": {"default": "false", "type": "Boolean", "description": "True if the Overlay should be prevented from being positioned \nout of the viewport."}, "height": {"default": "null", "type": "String", "description": "CSS height of the Overlay."}, "zIndex": {"default": "null", "type": "Number", "description": "CSS z-index of the Overlay."}, "width": {"default": "null", "type": "String", "description": "CSS width of the Overlay."}, "xy": {"default": "null", "type": "Number[]", "description": "An array with the absolute x and y positions of the Overlay"}, "preventcontextoverlap": {"default": "false", "type": "Boolean", "description": "Boolean indicating whether or not the Overlay should overlap its \ncontext element (defined using the \"context\" configuration property) when the \n\"constraintoviewport\" configuration property is set to \"true\"."}, "context": {"default": "null", "type": "Array", "description": "<p>\nThe array of context arguments for context-sensitive positioning. \n<\/p>\n<p>\nThe format of the array is: <code>[contextElementOrId, overlayCorner, contextCorner, arrayOfTriggerEvents (optional)]<\/code>, the\nthe 4 array elements described in detail below:\n<\/p>\n<dl>\n<dt>contextElementOrId <String|HTMLElement><\/dt>\n<dd>A reference to the context element to which the overlay should be aligned (or it's id).<\/dd>\n<dt>overlayCorner <String><\/dt>\n<dd>The corner of the overlay which is to be used for alignment. This corner will be aligned to the \ncorner of the context element defined by the \"contextCorner\" entry which follows. Supported string values are: \n\"tr\" (top right), \"tl\" (top left), \"br\" (bottom right), or \"bl\" (bottom left).<\/dd>\n<dt>contextCorner <String><\/dt>\n<dd>The corner of the context element which is to be used for alignment. Supported string values are the same ones listed for the \"overlayCorner\" entry above.<\/dd>\n<dt>arrayOfTriggerEvents (optional) <Array[String|CustomEvent]><\/dt>\n<dd>\n<p>\nBy default, context alignment is a one time operation, aligning the Overlay to the context element when context configuration property is set, or when the <a href=\"#method_align\">align<\/a> \nmethod is invoked. However, you can use the optional \"arrayOfTriggerEvents\" entry to define the list of events which should force the overlay to re-align itself with the context element. \nThis is useful in situations where the layout of the document may change, resulting in the context element's position being modified.\n<\/p>\n<p>\nThe array can contain either event type strings for events the instance publishes (e.g. \"beforeShow\") or CustomEvent instances. Additionally the following\n3 static container event types are also currently supported : <code>\"windowResize\", \"windowScroll\", \"textResize\"<\/code> (defined in <a href=\"#property__TRIGGER_MAP\">_TRIGGER_MAP<\/a> private property).\n<\/p>\n<\/dd>\n<\/dl>\n<p>\nFor example, setting this property to <code>[\"img1\", \"tl\", \"bl\"]<\/code> will \nalign the Overlay's top left corner to the bottom left corner of the\ncontext element with id \"img1\".\n<\/p>\n<p>\nAdding the optional trigger values: <code>[\"img1\", \"tl\", \"bl\", [\"beforeShow\", \"windowResize\"]]<\/code>,\nwill re-align the overlay position, whenever the \"beforeShow\" or \"windowResize\" events are fired.\n<\/p>"}, "autofillheight": {"default": "null", "type": "String", "description": "Standard module element which should auto fill out the height of the Overlay if the height config property is set.\nSupported values are \"header\", \"body\", \"footer\"."}, "y": {"default": "null", "type": "Number", "description": "The absolute y-coordinate position of the Overlay"}, "x": {"default": "null", "type": "Number", "description": "The absolute x-coordinate position of the Overlay"}, "fixedcenter": {"default": "false", "type": "Boolean", "description": "True if the Overlay should be anchored to the center of \nthe viewport."}}, "constructors": [{"params": [{"type": "String", "name": "el", "description": " The element ID representing the Overlay <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Overlay"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal containing \nthe configuration that should be set for this Overlay. See configuration \ndocumentation for more details."}], "description": "Overlay is a Module that is absolutely positioned above the page flow. It \nhas convenience methods for positioning and sizing, as well as options for \ncontrolling zIndex and constraining the Overlay's position to the current \nvisible viewport. Overlay also contains a dynamicly generated IFRAME which \nis placed beneath it for Internet Explorer 6 and 5.x so that it will be \nproperly rendered above SELECT elements."}], "namespace": "YAHOO.widget", "module": "container", "events": {"YAHOO.widget.Overlay.windowScrollEvent": {"description": "A singleton CustomEvent used for reacting to the DOM event for \nwindow scroll", "guessedname": "windowScrollEvent", "guessedtype": "property"}, "moveEvent": {"params": [{"type": "Number", "name": "x", "description": " x coordinate"}, {"type": "Number", "name": "y", "description": " y coordinate"}], "description": "CustomEvent fired after the Overlay is moved.", "guessedname": "moveEvent", "guessedtype": "property"}, "YAHOO.widget.Overlay.windowResizeEvent": {"description": "A singleton CustomEvent used for reacting to the DOM event for\nwindow resize", "guessedname": "windowResizeEvent", "guessedtype": "property"}, "beforeMoveEvent": {"params": [{"type": "Number", "name": "x", "description": " x coordinate"}, {"type": "Number", "name": "y", "description": " y coordinate"}], "description": "CustomEvent fired before the Overlay is moved.", "guessedname": "beforeMoveEvent", "guessedtype": "property"}}, "guessedname": "Overlay", "methods": {"moveTo": {"params": [{"type": "Number", "name": "x", "description": " The Overlay's new x position"}, {"type": "Number", "name": "y", "description": " The Overlay's new y position"}], "description": "Moves the Overlay to the specified position. This function is \nidentical to calling this.cfg.setProperty(\"xy\", [x,y]);", "guessedname": "moveTo", "guessedtype": "function"}, "stackIframe": {"description": "Sets the zindex of the iframe shim, if it exists, based on the zindex of\nthe Overlay element. The zindex of the iframe is set to be one less \nthan the Overlay element's zindex.\n<p>NOTE: This method will not bump up the zindex of the Overlay element\nto ensure that the iframe shim has a non-negative zindex.\nIf you require the iframe zindex to be 0 or higher, the zindex of \nthe Overlay element should be set to a value greater than 0, before \nthis method is called.\n<\/p>", "guessedname": "stackIframe", "guessedtype": "function"}, "showIframe": {"description": "Shows the iframe shim, if it has been enabled.", "guessedname": "showIframe", "guessedtype": "function"}, "configFixedCenter": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"fixedcenter\" property \nis changed.", "guessedname": "configFixedCenter", "guessedtype": "function"}, "YAHOO.widget.Overlay.windowResizeHandler": {"static": "", "params": [{"type": "DOMEvent", "name": "e", "description": " The DOM resize event"}], "description": "The DOM event handler used to fire the CustomEvent for window resize", "guessedname": "windowResizeHandler", "guessedtype": "function"}, "showMacGeckoScrollbars": {"description": "Adds a CSS class (\"show-scrollbars\") and removes a CSS class \n(\"hide-scrollbars\") to the Overlay to fix a bug in Gecko on Mac OS X \n(https:\/\/bugzilla.mozilla.org\/show_bug.cgi?id=187435)", "guessedname": "showMacGeckoScrollbars", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The string representation of the Overlay."}, "description": "Returns a String representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "hideMacGeckoScrollbars": {"description": "Adds a CSS class (\"hide-scrollbars\") and removes a CSS class \n(\"show-scrollbars\") to the Overlay to fix a bug in Gecko on Mac OS X \n(https:\/\/bugzilla.mozilla.org\/show_bug.cgi?id=187435)", "guessedname": "hideMacGeckoScrollbars", "guessedtype": "function"}, "initEvents": {"description": "Initializes the custom events for Overlay which are fired \nautomatically at appropriate times by the Overlay class.", "guessedname": "initEvents", "guessedtype": "function"}, "bringToTop": {"description": "Places the Overlay on top of all other instances of \nYAHOO.widget.Overlay.", "guessedname": "bringToTop", "guessedtype": "function"}, "_processTriggers": {"protected": "", "params": [{"type": "Array[String|CustomEvent]", "name": "triggers", "description": " An array of either CustomEvents, event type strings \n(e.g. \"beforeShow\", \"windowScroll\") to\/from which the provided function should be \nsubscribed\/unsubscribed respectively."}, {"type": "String", "name": "mode", "description": " Either \"subscribe\" or \"unsubscribe\", specifying whether or not\nwe are subscribing or unsubscribing trigger listeners"}, {"type": "Function", "name": "fn", "description": " The function to be subscribed\/unsubscribed to\/from the trigger event.\nContext is always set to the overlay instance, and no additional object argument \nget passed to the subscribed function."}], "description": "Utility method that subscribes or unsubscribes the given \nfunction from the list of trigger events provided.", "guessedname": "_processTriggers", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "el", "description": " The element ID representing the Overlay <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Overlay"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal \ncontaining the configuration that should be set for this Overlay. \nSee configuration documentation for more details."}], "description": "The Overlay initialization method, which is executed for Overlay and \nall of its subclasses. This method is automatically called by the \nconstructor, and sets up all DOM references for pre-existing markup, \nand creates required markup if it is not already present.", "guessedname": "init", "guessedtype": "function"}, "configXY": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"xy\" property is changed.", "guessedname": "configXY", "guessedtype": "function"}, "_getPreciseHeight": {"return": {"type": "Float", "description": "The sub-pixel height if supported by the browser, else the rounded height."}, "description": "Returns the sub-pixel height of the el, using getBoundingClientRect, if available,\notherwise returns the offsetHeight", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": ""}], "guessedname": "_getPreciseHeight", "guessedtype": "function"}, "_autoFillOnHeightChange": {"protected": "", "params": [{"type": "String", "name": "type", "description": " The event type"}, {"type": "Array", "name": "args", "description": " The array of arguments passed to event subscribers"}, {"type": "HTMLElement", "name": "el", "description": " The header, body or footer element which is to be resized to fill\nout the containers height"}], "description": "The default custom event handler executed when the overlay's height is changed, \nif the autofillheight property has been set.", "guessedname": "_autoFillOnHeightChange", "guessedtype": "function"}, "fillHeight": {"params": [{"type": "HTMLElement", "name": "el", "description": " The element which should be resized to fill out the height\nof the container element."}], "description": "<p>\nSets the height on the provided header, body or footer element to \nfill out the height of the container. It determines the height of the \ncontainers content box, based on it's configured height value, and \nsets the height of the autofillheight element to fill out any \nspace remaining after the other standard module element heights \nhave been accounted for.\n<\/p>\n<p><strong>NOTE:<\/strong> This method is not designed to work if an explicit \nheight has not been set on the container, since for an \"auto\" height container, \nthe heights of the header\/body\/footer will drive the height of the container.<\/p>", "guessedname": "fillHeight", "guessedtype": "function"}, "syncPosition": {"description": "Synchronizes the Panel's \"xy\", \"x\", and \"y\" properties with the \nPanel's position in the DOM. This is primarily used to update \nposition information during drag & drop.", "guessedname": "syncPosition", "guessedtype": "function"}, "hideIframe": {"description": "Hides the iframe shim, if it has been enabled.", "guessedname": "hideIframe", "guessedtype": "function"}, "configHeight": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"height\" property is changed.", "guessedname": "configHeight", "guessedtype": "function"}, "getConstrainedXY": {"return": {"type": "Array", "description": "The constrained x and y coordinates at index 0 and 1 respectively;"}, "params": [{"type": "Number", "name": "x", "description": " The X coordinate value to be constrained"}, {"type": "Number", "name": "y", "description": " The Y coordinate value to be constrained"}], "description": "Given x, y coordinate values, returns the calculated coordinates required to \nposition the Overlay if it is to be constrained to the viewport, based on the \ncurrent element size, viewport dimensions and scroll values.", "guessedname": "getConstrainedXY", "guessedtype": "function"}, "configContext": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"context\" property\nis changed.", "guessedname": "configContext", "guessedtype": "function"}, "onDomResize": {"params": [{"type": "DOMEvent", "name": "e", "description": " The resize DOM event"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "Event handler fired when the resize monitor element is resized.", "guessedname": "onDomResize", "guessedtype": "function"}, "configConstrainToViewport": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for \nthe property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"constraintoviewport\" \nproperty is changed.", "guessedname": "configConstrainToViewport", "guessedtype": "function"}, "configVisible": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration\nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"visible\" property is \nchanged. This method is responsible for firing showEvent\nand hideEvent.", "guessedname": "configVisible", "guessedtype": "function"}, "_validateAutoFillHeight": {"return": {"type": "", "description": "true, if valid, false otherwise"}, "description": "autofillheight validator. Verifies that the autofill value is either null \nor one of the strings : \"body\", \"header\" or \"footer\".", "protected": "", "params": [{"type": "String", "name": "val", "description": ""}], "guessedname": "_validateAutoFillHeight", "guessedtype": "function"}, "_alignOnTrigger": {"protected": "", "params": [{"type": "String", "name": "type", "description": " The event type (not used by the default implementation)"}, {"type": "Any[]", "name": "args", "description": " The array of arguments for the trigger event (not used by the default implementation)"}], "description": "Custom Event handler for context alignment triggers. Invokes the align method", "guessedname": "_alignOnTrigger", "guessedtype": "function"}, "configWidth": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"width\" property is changed.", "guessedname": "configWidth", "guessedtype": "function"}, "destroy": {"description": "Removes the Overlay element from the DOM and sets all child \nelements to null.", "guessedname": "destroy", "guessedtype": "function"}, "_primeXYFromDOM": {"protected": "", "description": "Set's the container's XY value from DOM if not already set.\nDiffers from syncPosition, in that the XY value is only sync'd with DOM if \nnot already set. The method also refire's the XY config property event, so any\nbeforeMove, Move event listeners are invoked.", "guessedname": "_primeXYFromDOM", "guessedtype": "function"}, "configAutoFillHeight": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"autofillheight\" property is changed.", "guessedname": "configAutoFillHeight", "guessedtype": "function"}, "YAHOO.widget.Overlay.windowScrollHandler": {"static": "", "params": [{"type": "DOMEvent", "name": "e", "description": " The DOM scroll event"}], "description": "The DOM event handler used to fire the CustomEvent for window scroll", "guessedname": "windowScrollHandler", "guessedtype": "function"}, "center": {"description": "Centers the container in the viewport.", "guessedname": "center", "guessedtype": "function"}, "_findTriggerCE": {"guessedname": "_findTriggerCE", "params": [{"type": "String|CustomEvent", "name": "t", "description": " Either a CustomEvent, or event type (e.g. \"windowScroll\") for which a \ncustom event instance needs to be looked up from the Overlay._TRIGGER_MAP."}], "description": "Helper method to locate the custom event instance for the event name string\npassed in. As a convenience measure, any custom events passed in are returned.", "private": "", "guessedtype": "function"}, "align": {"params": [{"type": "String", "name": "elementAlign", "description": " The String representing the corner of \nthe Overlay that should be aligned to the context element"}, {"type": "String", "name": "contextAlign", "description": " The corner of the context element \nthat the elementAlign corner should stick to."}], "description": "Aligns the Overlay to its context element using the specified corner \npoints (represented by the constants TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, \nand BOTTOM_RIGHT.", "guessedname": "align", "guessedtype": "function"}, "syncIframe": {"description": "Syncronizes the size and position of iframe shim to that of its \ncorresponding Overlay instance.", "guessedname": "syncIframe", "guessedtype": "function"}, "configIframe": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"iframe\" property is changed.", "guessedname": "configIframe", "guessedtype": "function"}, "_getComputedHeight": {"return": {"type": "Number", "description": "The content box height of the given element, or null if it could not be determined."}, "description": "Determines the content box height of the given element (height of the element, without padding or borders) in pixels.", "private": "", "params": [{"type": "HTMLElement", "name": "el", "description": " The element for which the content height needs to be determined"}], "guessedname": "_getComputedHeight", "guessedtype": "function"}, "configY": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"y\" property is changed.", "guessedname": "configY", "guessedtype": "function"}, "configX": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"x\" property is changed.", "guessedname": "configX", "guessedtype": "function"}, "getConstrainedY": {"return": {"type": "Number", "description": "The constrained y coordinate"}, "params": [{"type": "Number", "name": "y", "description": " The Y coordinate value to be constrained"}], "description": "Given y coordinate value, returns the calculated y coordinate required to \nposition the Overlay if it is to be constrained to the viewport, based on the \ncurrent element size, viewport dimensions and scroll values.", "guessedname": "getConstrainedY", "guessedtype": "function"}, "getConstrainedX": {"return": {"type": "Number", "description": "The constrained x coordinate"}, "params": [{"type": "Number", "name": "x", "description": " The X coordinate value to be constrained"}], "description": "Given x coordinate value, returns the calculated x coordinate required to \nposition the Overlay if it is to be constrained to the viewport, based on the \ncurrent element size, viewport dimensions and scroll values.", "guessedname": "getConstrainedX", "guessedtype": "function"}, "configzIndex": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"zIndex\" property is changed.", "guessedname": "configzIndex", "guessedtype": "function"}, "doCenterOnDOMEvent": {"description": "Center event handler used for centering on scroll\/resize, but only if \nthe Overlay is visible", "guessedname": "doCenterOnDOMEvent", "guessedtype": "function"}, "enforceConstraints": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler executed when the moveEvent is fired, if the \n\"constraintoviewport\" is set to true.", "guessedname": "enforceConstraints", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be changed \nusing the Overlay's Config object (cfg).", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "extends": "YAHOO.widget.Module", "superclass": "YAHOO.widget.Module", "file": "Overlay.js", "guessedtype": "function", "shortname": "Overlay", "properties": {"DEFAULT_CONFIG": {"description": "Constant representing the Overlay's configuration properties", "private": "", "guessedname": "DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "YAHOO.widget.Overlay._initialized": {"guessedname": "_initialized", "type": "Boolean", "description": "A boolean that indicated whether the window resize and scroll events have \nalready been subscribed to.", "private": "", "guessedtype": "property"}, "YAHOO.widget.Overlay.STD_MOD_RE": {"description": "Constant representing the names of the standard module elements\nused in the overlay.", "static": "", "guessedname": "STD_MOD_RE", "guessedtype": "property", "type": "RegExp", "final": ""}, "CONTEXT_TRIGGERS": {"final": "", "type": "Array", "description": "<p>\nArray of default event types which will trigger\ncontext alignment for the Overlay class.\n<\/p>\n<p>The array is empty by default for Overlay,\nbut maybe populated in future releases, so classes extending\nOverlay which need to define their own set of CONTEXT_TRIGGERS\nshould concatenate their super class's prototype.CONTEXT_TRIGGERS \nvalue with their own array of values.\n<\/p>\n<p>\nE.g.:\n<code>CustomOverlay.prototype.CONTEXT_TRIGGERS = YAHOO.widget.Overlay.prototype.CONTEXT_TRIGGERS.concat([\"windowScroll\"]);<\/code>\n<\/p>", "guessedname": "CONTEXT_TRIGGERS", "guessedtype": "property"}, "YAHOO.widget.Overlay._TRIGGER_MAP": {"description": "Internal map of special event types, which are provided\nby the instance. It maps the event type to the custom event \ninstance. Contains entries for the \"windowScroll\", \"windowResize\" and\n\"textResize\" static container events.", "private": "", "static": "", "guessedname": "_TRIGGER_MAP", "guessedtype": "property", "type": "Object"}, "YAHOO.widget.Overlay.CSS_OVERLAY": {"description": "Constant representing the default CSS class used for an Overlay", "static": "", "guessedname": "CSS_OVERLAY", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Overlay.BOTTOM_RIGHT": {"description": "Constant representing the bottom right corner of an element, used for \nconfiguring the context element alignment", "static": "", "guessedname": "BOTTOM_RIGHT", "guessedtype": "property", "type": "String", "final": ""}, "EVENT_TYPES": {"description": "Constant representing the name of the Overlay's events", "private": "", "guessedname": "EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "YAHOO.widget.Overlay.VIEWPORT_OFFSET": {"description": "Number representing the minimum distance an Overlay instance should be \npositioned relative to the boundaries of the browser's viewport, in pixels.", "default": "10", "static": "", "guessedname": "VIEWPORT_OFFSET", "guessedtype": "property", "type": "Number", "final": ""}, "YAHOO.widget.Overlay.TOP_RIGHT": {"description": "Constant representing the top right corner of an element, used for \nconfiguring the context element alignment", "static": "", "guessedname": "TOP_RIGHT", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Overlay.TOP_LEFT": {"description": "Constant representing the top left corner of an element, used for \nconfiguring the context element alignment", "static": "", "guessedname": "TOP_LEFT", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Overlay.IFRAME_SRC": {"description": "The URL that will be placed in the iframe", "default": "3", "static": "", "guessedname": "IFRAME_SRC", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.Overlay.BOTTOM_LEFT": {"description": "Constant representing the top bottom left corner of an element, used for \nconfiguring the context element alignment", "static": "", "guessedname": "BOTTOM_LEFT", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Overlay is a Module that is absolutely positioned above the page flow. It \nhas convenience methods for positioning and sizing, as well as options for \ncontrolling zIndex and constraining the Overlay's position to the current \nvisible viewport. Overlay also contains a dynamicly generated IFRAME which \nis placed beneath it for Internet Explorer 6 and 5.x so that it will be \nproperly rendered above SELECT elements."}, "YAHOO.widget.EditorWindow": {"file": "editor.js", "description": "Class to hold Window information between uses. We use the same panel to show the windows, so using this will allow you to configure a window before it is shown.\nThis is what you pass to Editor.openWindow();. These parameters will not take effect until the openWindow() is called in the editor.", "namespace": "YAHOO.widget", "module": "editor", "events": {"afterOpenWindow": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}, {"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}], "description": "Event fires after an Editor Window is opened. See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event."}, "windowCreateLinkRender": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}, {"type": "HTMLElement", "name": "body", "description": " The HTML element used as the body of the window.."}], "description": "Event fired when the pre render of the Create Link window has finished."}, "windowInsertImageRender": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}, {"type": "HTMLElement", "name": "body", "description": " The HTML element used as the body of the window.."}, {"type": "Toolbar", "name": "toolbar", "description": " A reference to the toolbar object used inside this window."}], "description": "Event fired when the pre render of the Insert Image window has finished."}, "closeWindow": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}], "description": "Event fires after an Editor Window is closed. See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event."}, "windowRender": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}, {"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}], "description": "Event fired when the initial Overlay is rendered. Can be used to manipulate the content of the panel."}, "windowCMDOpen": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}, {"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}], "description": "Dynamic event fired when an <a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a> is opened.. The dynamic event is based on the name of the window. Example Window: createlink, opening this window would fire the windowcreatelinkOpen event. See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event."}, "beforeOpenWindow": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}, {"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}], "description": "Event fires before an Editor Window is opened. See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event."}, "windowCMDClose": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "<a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a>", "name": "win", "description": " The EditorWindow object"}, {"type": "Overlay", "name": "panel", "description": " The Overlay object that is used to create the window."}], "description": "Dynamic event fired when an <a href=\"YAHOO.widget.EditorWindow.html\">EditorWindow<\/a> is closed.. The dynamic event is based on the name of the window. Example Window: createlink, opening this window would fire the windowcreatelinkClose event. See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event."}}, "methods": {"setFooter": {"params": [{"type": "String\/HTMLElement", "name": "str", "description": " The string or DOM reference to be used as the windows footer."}], "description": "Sets the footer for the window.", "guessedname": "setFooter", "guessedtype": "function"}, "setBody": {"params": [{"type": "String\/HTMLElement", "name": "str", "description": " The string or DOM reference to be used as the windows body."}], "description": "Sets the body for the window.", "guessedname": "setBody", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the EditorWindow.", "guessedname": "toString", "guessedtype": "function"}, "setHeader": {"params": [{"type": "String\/HTMLElement", "name": "str", "description": " The string or DOM reference to be used as the windows header."}], "description": "Sets the header for the window.", "guessedname": "setHeader", "guessedtype": "function"}}, "param": "{String} name The name of the window.", "guessedname": "EditorWindow", "guessedtype": "function", "shortname": "EditorWindow", "properties": {"body": {"private": "", "description": "Holder for the body of the window, used in Editor.openWindow", "guessedname": "body", "guessedtype": "property"}, "header": {"private": "", "description": "Holder for the header of the window, used in Editor.openWindow", "guessedname": "header", "guessedtype": "property"}, "footer": {"private": "", "description": "Holder for the footer of the window, used in Editor.openWindow", "guessedname": "footer", "guessedtype": "property"}, "name": {"private": "", "description": "A unique name for the window", "guessedname": "name", "guessedtype": "property"}, "attrs": {"private": "", "description": "The window attributes", "guessedname": "attrs", "guessedtype": "property"}}, "name": "YAHOO.widget.EditorWindow"}, "YAHOO.widget.Paginator": {"name": "YAHOO.widget.Paginator", "configs": {"alwaysVisible": {"default": "true", "type": "boolean", "description": "Display pagination controls even when there is only one page. Set\nto false to forgo rendering and\/or hide the containers when there\nis only one page of data. Note if you are using the rowsPerPage\ndropdown ui component, visibility will be maintained as long as the\nnumber of records exceeds the smallest page size."}, "updateOnChange": {"default": "false", "type": "boolean", "description": "Update the UI immediately upon interaction. If false, changeRequest\nsubscribers or other external code will need to explicitly set the\nnew values in the paginator to trigger repaint."}, "containerClass": {"default": "'yui-pg-container'", "type": "string", "description": "Class assigned to the element(s) containing pagination controls."}, "initialPage": {"default": "1", "type": "integer", "description": "Page to display on initial paint"}, "totalRecords": {"default": "0", "type": "integer", "description": "Total number of records to paginate through"}, "recordOffset": {"default": "0", "type": "integer", "description": "Zero based index of the record considered first on the current page.\nFor page based interactions, don't modify this attribute directly;\nuse setPage(n)."}, "rendered": {"type": "boolean", "description": "Indicator of whether the DOM nodes have been initially created", "final": ""}, "rowsPerPage": {"type": "integer", "description": "REQUIRED. Number of records constituting a "page""}, "template": {"see": "Paginator.TEMPLATE_DEFAULT", "type": "string", "description": "Template used to render controls. The string will be used as\ninnerHTML on all specified container nodes. Bracketed keys\n(e.g. {pageLinks}) in the string will be replaced with an instance\nof the so named ui component."}, "id": {"type": "integer", "description": "Unique id assigned to this instance", "final": ""}, "containers": {"type": "{string|HTMLElement|Array(string|HTMLElement)}", "description": "REQUIRED. Node references or ids of nodes in which to render the\npagination controls."}}, "constructors": [{"params": [{"type": "Object", "name": "config", "description": " Object literal to set instance and ui component\nconfiguration."}], "description": "Instantiate a Paginator, passing a configuration object to the contructor.\nThe configuration object should contain the following properties:\n<ul>\n<li>rowsPerPage : <em>n<\/em> (int)<\/li>\n<li>totalRecords : <em>n<\/em> (int or Paginator.VALUE_UNLIMITED)<\/li>\n<li>containers : <em>id | el | arr<\/em> (HTMLElement reference, its id, or an array of either)<\/li>\n<\/ul>"}], "namespace": "YAHOO.widget", "module": "paginator", "events": {"rendered": {"deprecated": "use render event", "description": "Event fired when the Paginator is initially rendered"}, "templateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "templateChange", "description": "Fires when the value for the configuration attribute 'template' changes."}, "render": {"description": "Event fired when the Paginator is initially rendered"}, "initialPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "initialPageChange", "description": "Fires when the value for the configuration attribute 'initialPage' changes."}, "beforeContainerClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContainerClassChange", "description": "Fires before the value for the configuration attribute 'containerClass' changes. Return false to cancel the attribute change."}, "alwaysVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "alwaysVisibleChange", "description": "Fires when the value for the configuration attribute 'alwaysVisible' changes."}, "beforeRenderedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRenderedChange", "description": "Fires before the value for the configuration attribute 'rendered' changes. Return false to cancel the attribute change."}, "beforeRecordOffsetChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRecordOffsetChange", "description": "Fires before the value for the configuration attribute 'recordOffset' changes. Return false to cancel the attribute change."}, "beforeTemplateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTemplateChange", "description": "Fires before the value for the configuration attribute 'template' changes. Return false to cancel the attribute change."}, "beforeTotalRecordsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTotalRecordsChange", "description": "Fires before the value for the configuration attribute 'totalRecords' changes. Return false to cancel the attribute change."}, "updateOnChangeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "updateOnChangeChange", "description": "Fires when the value for the configuration attribute 'updateOnChange' changes."}, "renderedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "renderedChange", "description": "Fires when the value for the configuration attribute 'rendered' changes."}, "destroy": {"description": "Event used to trigger cleanup of ui components"}, "beforeContainersChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContainersChange", "description": "Fires before the value for the configuration attribute 'containers' changes. Return false to cancel the attribute change."}, "changeRequest": {"description": "Event fired when a change in pagination values is requested,\neither by interacting with the various ui components or via the\nsetStartIndex(n) etc APIs.\nSubscribers will receive the proposed state as the first parameter.\nThe proposed state object will contain the following keys:\n<ul>\n<li>paginator - the Paginator instance<\/li>\n<li>page<\/li>\n<li>totalRecords<\/li>\n<li>recordOffset - index of the first record on the new page<\/li>\n<li>rowsPerPage<\/li>\n<li>records - array containing [start index, end index] for the records on the new page<\/li>\n<li>before - object literal with all these keys for the current state<\/li>\n<\/ul>"}, "pageChange": {"description": "Event fired when attribute changes have resulted in the calculated\ncurrent page changing."}, "beforeRowsPerPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRowsPerPageChange", "description": "Fires before the value for the configuration attribute 'rowsPerPage' changes. Return false to cancel the attribute change."}, "rowsPerPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "rowsPerPageChange", "description": "Fires when the value for the configuration attribute 'rowsPerPage' changes."}, "beforeDestroy": {"description": "Event that fires before the destroy event."}, "totalRecordsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "totalRecordsChange", "description": "Fires when the value for the configuration attribute 'totalRecords' changes."}, "recordOffsetChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "recordOffsetChange", "description": "Fires when the value for the configuration attribute 'recordOffset' changes."}, "containersChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "containersChange", "description": "Fires when the value for the configuration attribute 'containers' changes."}, "containerClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "containerClassChange", "description": "Fires when the value for the configuration attribute 'containerClass' changes."}, "beforeInitialPageChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeInitialPageChange", "description": "Fires before the value for the configuration attribute 'initialPage' changes. Return false to cancel the attribute change."}, "beforeIdChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeIdChange", "description": "Fires before the value for the configuration attribute 'id' changes. Return false to cancel the attribute change."}, "beforeUpdateOnChangeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeUpdateOnChangeChange", "description": "Fires before the value for the configuration attribute 'updateOnChange' changes. Return false to cancel the attribute change."}, "beforeAlwaysVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeAlwaysVisibleChange", "description": "Fires before the value for the configuration attribute 'alwaysVisible' changes. Return false to cancel the attribute change."}, "idChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "idChange", "description": "Fires when the value for the configuration attribute 'id' changes."}}, "guessedname": "Paginator", "methods": {"render": {"description": "Render the pagination controls per the format attribute into the\nspecified container nodes.", "guessedname": "render", "guessedtype": "function"}, "getRowsPerPage": {"return": {"type": "number", "description": "the current setting of the rowsPerPage attribute"}, "description": "Get the number of rows per page.", "guessedname": "getRowsPerPage", "guessedtype": "function"}, "getTotalRecords": {"return": {"type": "number", "description": "the current setting of totalRecords attribute"}, "description": "Get the total number of records.", "guessedname": "getTotalRecords", "guessedtype": "function"}, "getPreviousPage": {"return": {"type": "number", "description": ""}, "description": "Get the page number of the previous page, or null if the current page\nis the first page.", "guessedname": "getPreviousPage", "guessedtype": "function"}, "getTotalPages": {"return": {"type": "number", "description": ""}, "description": "Get the total number of pages in the data set according to the current\nrowsPerPage and totalRecords values. If totalRecords is not set, or\nset to YAHOO.widget.Paginator.VALUE_UNLIMITED, returns\nYAHOO.widget.Paginator.VALUE_UNLIMITED.", "guessedname": "getTotalPages", "guessedtype": "function"}, "setState": {"params": [{"type": "Object", "name": "state", "description": " Object literal of attribute:value pairs to set"}], "description": "Convenience method to facilitate setting state attributes rowsPerPage,\ntotalRecords, recordOffset in batch. Also supports calculating\nrecordOffset from state.page if state.recordOffset is not provided.\nFires only a single pageChange event, if appropriate.\nThis will not fire a changeRequest event.", "guessedname": "setState", "guessedtype": "function"}, "updateVisibility": {"description": "Hides the containers if there is only one page of data and attribute\nalwaysVisible is false. Conversely, it displays the containers if either\nthere is more than one page worth of data or alwaysVisible is turned on.", "guessedname": "updateVisibility", "guessedtype": "function"}, "hasNextPage": {"return": {"type": "boolean", "description": ""}, "description": "Are there records on the next page?", "guessedname": "hasNextPage", "guessedtype": "function"}, "initEvents": {"private": "", "description": "Initialize this instance's CustomEvents.", "guessedname": "initEvents", "guessedtype": "function"}, "_firePageChange": {"protected": "", "params": [{"type": "Object", "name": "state", "description": " the result of getState(oldState)"}], "description": "Fires a pageChange event in the form of a standard attribute change\nevent with additional properties prevState and newState.", "guessedname": "_firePageChange", "guessedtype": "function"}, "setStartIndex": {"params": [{"type": "number", "name": "offset", "description": " the new record offset"}, {"type": "boolean", "name": "silent", "description": " whether to forcibly avoid firing the changeRequest event"}], "description": "Move the record offset to a new starting index. This will likely cause\nthe calculated current page to change. You should probably use setPage.", "guessedname": "setStartIndex", "guessedtype": "function"}, "destroy": {"description": "Removes controls from the page and unhooks events.", "guessedname": "destroy", "guessedtype": "function"}, "getCurrentPage": {"return": {"type": "number", "description": ""}, "description": "Get the page number corresponding to the current record offset.", "guessedname": "getCurrentPage", "guessedtype": "function"}, "getState": {"return": {"type": "object", "description": ""}, "params": [{"type": "object", "name": "changes", "description": " OPTIONAL object literal with proposed values\nSupported change keys include:\n<ul>\n<li>rowsPerPage<\/li>\n<li>totalRecords<\/li>\n<li>recordOffset OR<\/li>\n<li>page<\/li>\n<\/ul>"}], "description": "Get an object literal describing the current state of the paginator. If\nan object literal of proposed values is passed, the proposed state will\nbe returned as an object literal with the following keys:\n<ul>\n<li>paginator - instance of the Paginator<\/li>\n<li>page - number<\/li>\n<li>totalRecords - number<\/li>\n<li>recordOffset - number<\/li>\n<li>rowsPerPage - number<\/li>\n<li>records - [ start_index, end_index ]<\/li>\n<li>before - (OPTIONAL) { state object literal for current state }<\/li>\n<\/ul>", "guessedname": "getState", "guessedtype": "function"}, "hasPreviousPage": {"return": {"type": "boolean", "description": ""}, "description": "Is there a page before the current page?", "guessedname": "hasPreviousPage", "guessedtype": "function"}, "getStartIndex": {"return": {"type": "number", "description": "the index of the first record on the current page"}, "description": "Get the index of the first record on the current page", "guessedname": "getStartIndex", "guessedtype": "function"}, "setTotalRecords": {"params": [{"type": "number", "name": "total", "description": " the new total number of records"}, {"type": "boolean", "name": "silent", "description": " whether to forcibly avoid firing the changeRequest event"}], "description": "Set the total number of records.", "guessedname": "setTotalRecords", "guessedtype": "function"}, "hasPage": {"return": {"type": "boolean", "description": ""}, "params": [{"type": "number", "name": "page", "description": " the page in question"}], "description": "Does the requested page have any records?", "guessedname": "hasPage", "guessedtype": "function"}, "setRowsPerPage": {"params": [{"type": "number", "name": "rpp", "description": " the new number of rows per page"}, {"type": "boolean", "name": "silent", "description": " whether to forcibly avoid firing the\nchangeRequest event"}], "description": "Set the number of rows per page.", "guessedname": "setRowsPerPage", "guessedtype": "function"}, "setPage": {"params": [{"type": "number", "name": "newPage", "description": " the new page number"}, {"type": "boolean", "name": "silent", "description": " whether to forcibly avoid firing the\nchangeRequest event"}], "description": "Set the current page to the provided page number if possible.", "guessedname": "setPage", "guessedtype": "function"}, "_selfSubscribe": {"protected": "", "description": "Subscribes to instance attribute change events to automate certain\nbehaviors.", "guessedname": "_selfSubscribe", "guessedtype": "function"}, "initUIComponents": {"private": "", "description": "Initialize registered ui components onto this instance.", "guessedname": "initUIComponents", "guessedtype": "function"}, "_syncRecordOffset": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " totalRecordsChange event"}], "description": "Sets recordOffset to the starting index of the previous page when\ntotalRecords is reduced below the current recordOffset.", "guessedname": "_syncRecordOffset", "guessedtype": "function"}, "_handleStateChange": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " the attribute change event"}], "description": "Fires the pageChange event when the state attributes have changed in\nsuch a way as to locate the current recordOffset on a new page.", "guessedname": "_handleStateChange", "guessedtype": "function"}, "getNextPage": {"return": {"type": "number", "description": ""}, "description": "Get the page number of the next page, or null if the current page is the\nlast page.", "guessedname": "getNextPage", "guessedtype": "function"}, "initConfig": {"private": "", "description": "Initialize the Paginator's attributes (see YAHOO.util.Element class\nAttributeProvider).", "guessedname": "initConfig", "guessedtype": "function"}, "getContainerNodes": {"return": {"type": "Array", "description": "array of HTMLElement nodes"}, "description": "Get the configured container nodes", "guessedname": "getContainerNodes", "guessedtype": "function"}, "getPageRecords": {"return": {"type": "Array", "description": "[start_index, end_index]"}, "params": [{"type": "number", "name": "page", "description": " (optional) The page (current page if not specified)"}], "description": "Get the start and end record indexes of the specified page.", "guessedname": "getPageRecords", "guessedtype": "function"}}, "file": "Paginator.js", "guessedtype": "function", "shortname": "Paginator", "properties": {"_pageChanged": {"protected": "", "type": "boolean", "description": "Used by setState to indicate when a page change has occurred", "guessedname": "_pageChanged", "guessedtype": "property"}, "_batch": {"protected": "", "type": "boolean", "description": "Flag used to indicate multiple attributes are being updated via setState", "guessedname": "_batch", "guessedtype": "property"}, "_containers": {"guessedname": "_containers", "type": "Array(HTMLElement)", "description": "Array of nodes in which to render pagination controls. This is set via\nthe "containers" attribute.", "private": "", "guessedtype": "property"}, "_state": {"protected": "", "type": "Object", "description": "Temporary state cache used by setState to keep track of the previous\nstate for eventual pageChange event firing", "guessedname": "_state", "guessedtype": "property"}, "ui": {"static": "", "description": "Storage object for UI Components", "guessedname": "ui", "guessedtype": "property"}, "ID_BASE": {"description": "Base of id strings used for ui components.", "private": "", "static": "", "guessedname": "ID_BASE", "guessedtype": "property", "type": "string"}, "TEMPLATE_DEFAULT": {"type": "string", "static": "", "description": "Default template used by Paginator instances. Update this if you want\nall new Paginators to use a different default template.", "guessedname": "TEMPLATE_DEFAULT", "guessedtype": "property"}, "VALUE_UNLIMITED": {"description": "Used to identify unset, optional configurations, or used explicitly in\nthe case of totalRecords to indicate unlimited pagination.", "static": "", "guessedname": "VALUE_UNLIMITED", "guessedtype": "property", "type": "number", "final": ""}, "id": {"description": "Incrementing index used to give instances unique ids.", "private": "", "static": "", "guessedname": "id", "guessedtype": "property", "type": "number"}, "TEMPLATE_ROWS_PER_PAGE": {"type": "string", "static": "", "description": "Common alternate pagination format, including page links, links for\nprevious, next, first and last pages as well as a rows-per-page\ndropdown. Offered as a convenience.", "guessedname": "TEMPLATE_ROWS_PER_PAGE", "guessedtype": "property"}}, "description": "Instantiate a Paginator, passing a configuration object to the contructor.\nThe configuration object should contain the following properties:\n<ul>\n<li>rowsPerPage : <em>n<\/em> (int)<\/li>\n<li>totalRecords : <em>n<\/em> (int or Paginator.VALUE_UNLIMITED)<\/li>\n<li>containers : <em>id | el | arr<\/em> (HTMLElement reference, its id, or an array of either)<\/li>\n<\/ul>"}, "YAHOO.util.AnimMgr": {"name": "YAHOO.util.AnimMgr", "namespace": "YAHOO.util", "module": "animation", "guessedname": "AnimMgr", "methods": {"run": {"description": "Called per Interval to handle each animation frame.", "guessedname": "run", "guessedtype": "function"}, "unRegister": {"guessedname": "unRegister", "params": [{"type": "object", "name": "tween", "description": " The Anim instance to be be registered"}, {"type": "Int", "name": "index", "description": " The index of the Anim instance"}], "description": "removes an animation instance from the animation queue.\nAll animation instances must be registered in order to animate.", "private": "", "guessedtype": "function"}, "stop": {"params": [{"type": "object", "name": "tween", "description": " A specific Anim instance to stop (optional)\nIf no instance given, Manager stops thread and all animations."}], "description": "Stops the animation thread or a specific animation instance.", "guessedname": "stop", "guessedtype": "function"}, "start": {"description": "Starts the animation thread.\nOnly one thread can run at a time.", "guessedname": "start", "guessedtype": "function"}, "registerElement": {"params": [{"type": "object", "name": "tween", "description": " The Anim instance to be be registered"}], "description": "Adds an animation instance to the animation queue.\nAll animation instances must be registered in order to animate.", "guessedname": "registerElement", "guessedtype": "function"}, "correctFrame": {"guessedname": "correctFrame", "params": [{"type": "Object", "name": "tween", "description": " The Anim instance being corrected."}], "description": "On the fly frame correction to keep animation on time.", "private": "", "guessedtype": "function"}}, "file": "AnimMgr.js", "guessedtype": "function", "shortname": "AnimMgr", "properties": {"queue": {"guessedname": "queue", "type": "Array", "description": "The current queue of registered animation objects.", "private": "", "guessedtype": "property"}, "tweenCount": {"guessedname": "tweenCount", "type": "Int", "description": "The number of active animations.", "private": "", "guessedtype": "property"}, "delay": {"type": "Int", "description": "Interval delay in milliseconds, defaults to fastest possible.", "guessedname": "delay", "guessedtype": "property"}, "fps": {"type": "Int", "description": "Base frame rate (frames per second). \nArbitrarily high for better x-browser calibration (slower browsers drop more frames).", "guessedname": "fps", "guessedtype": "property"}, "thread": {"guessedname": "thread", "type": "Int", "description": "Reference to the animation Interval.", "private": "", "guessedtype": "property"}}, "description": "Handles animation queueing and threading.\nUsed by Anim and subclasses."}, "YAHOO.util.ImageLoader.group": {"name": "YAHOO.util.ImageLoader.group", "constructors": [{"params": [{"type": "String|HTMLElement", "name": "trigEl", "description": "\tThe HTML element id or reference to assign the trigger event to. Can be null for no trigger"}, {"type": "String", "name": "trigAct", "description": " The type of event to assign to trigEl. Can be null for no trigger"}, {"type": "Number", "name": "timeout", "description": "\tTimeout (time limit) length, in seconds. Can be undefined, or <= 0, for no time limit"}], "description": "A group for images. A group can have one time limit and a series of triggers. Thus the images belonging to this group must share these constraints."}], "namespace": "YAHOO.util", "module": "imageloader", "guessedname": "group", "methods": {"registerBgImage": {"return": {"type": "Object", "description": "bgImgObj that was registered, for modifying any attributes in the object"}, "params": [{"type": "String", "name": "domId", "description": "\tHTML DOM id of the image element"}, {"type": "String", "name": "url", "description": "\tURL for the image"}], "description": "Registers a background image with the group", "guessedname": "registerBgImage", "guessedtype": "function"}, "addCustomTrigger": {"params": [{"type": "Object", "name": "event", "description": " A YAHOO.util.CustomEvent object"}], "description": "Adds a custom event trigger to the group.", "guessedname": "addCustomTrigger", "guessedtype": "function"}, "addTrigger": {"params": [{"type": "String|HTMLElement", "name": "trigEl", "description": " The HTML element id or reference to assign the trigger event to"}, {"type": "String", "name": "trigAct", "description": " The type of event to assign to trigEl"}], "description": "Adds a trigger to the group. Call this with the same style as YAHOO.util.Event.addListener", "guessedname": "addTrigger", "guessedtype": "function"}, "_getFetchTimeout": {"guessedname": "_getFetchTimeout", "return": {"type": "Function", "description": "group's fetch method"}, "description": "Returns the group's fetch method, with the proper closure, for use with setTimeout", "private": "", "guessedtype": "function"}, "registerSrcImage": {"return": {"type": "Object", "description": "srcImgObj that was registered, for modifying any attributes in the object"}, "params": [{"type": "String", "name": "domId", "description": "\tHTML DOM id of the image element"}, {"type": "String", "name": "url", "description": "\tURL for the image"}, {"type": "Int", "name": "width", "description": "\tpixel width of the image - defaults to image's natural size"}, {"type": "Int", "name": "height", "description": "\tpixel height of the image - defaults to image's natural size"}], "description": "Registers a src image with the group", "guessedname": "registerSrcImage", "guessedtype": "function"}, "registerPngBgImage": {"return": {"type": "Object", "description": "pngBgImgObj that was registered, for modifying any attributes in the object"}, "params": [{"type": "String", "name": "domId", "description": "\tHTML DOM id of the image element"}, {"type": "String", "name": "url", "description": "\tURL for the image"}, {"type": "Object", "name": "ailProps", "description": " The AlphaImageLoader properties to be set for the image\nValid properties are 'sizingMethod' and 'enabled'"}], "description": "Registers an alpha-channel-type png background image with the group", "guessedname": "registerPngBgImage", "guessedtype": "function"}, "_onloadTasks": {"private": "", "description": "Setup to do in the window's onload\nInitiates time limit for group; executes the fold check for the images", "guessedname": "_onloadTasks", "guessedtype": "function"}, "_foldCheck": {"private": "", "description": "Checks the position of each image in the group. If any part of the image is within the client viewport, shows the image immediately.", "guessedname": "_foldCheck", "guessedtype": "function"}, "fetch": {"description": "Displays the images in the group", "guessedname": "fetch", "guessedtype": "function"}, "_fetchByClass": {"private": "", "description": "Finds all elements in the Dom with the class name specified in the group. Removes the class from the element in order to let the style definitions trigger the image fetching", "guessedname": "_fetchByClass", "guessedtype": "function"}}, "file": "ImageLoader.js", "guessedtype": "function", "shortname": "ImageLoader.group", "requires": "YAHOO.util.Dom", "properties": {"name": {"type": "String", "description": "Name for the group. Only used to identify the group in logging statements", "guessedname": "name", "guessedtype": "property"}, "_classImageEls": {"guessedname": "_classImageEls", "type": "Array", "description": "HTML elements having the class name that is associated with this group\nElements are stored during the _foldCheck function and reused later during the fetch function. Gives a slight performance improvement when className and foldConditional are both used", "private": "", "guessedtype": "property"}, "_imgObjs": {"guessedname": "_imgObjs", "type": "Object", "description": "Collection of images registered with this group", "private": "", "guessedtype": "property"}, "timeoutLen": {"type": "Number", "description": "Timeout (time limit) length, in seconds", "guessedname": "timeoutLen", "guessedtype": "property"}, "className": {"type": "String", "description": "Class name that will identify images belonging to the group. This class name will be removed from each element in order to fetch images.\nThis class should have, in its CSS style definition, \"background:none !important;\"", "guessedname": "className", "guessedtype": "property"}, "_triggers": {"guessedname": "_triggers", "type": "Array", "description": "Collection of triggers for this group.\nKeeps track of each trigger's element, event, and event-listener-callback \"fetch\" function", "private": "", "guessedtype": "property"}, "_customTriggers": {"guessedname": "_customTriggers", "type": "Array", "description": "Collection of custom-event triggers for this group.\nKeeps track of each trigger's event object and event-listener-callback \"fetch\" function", "private": "", "guessedtype": "property"}, "_timeout": {"guessedname": "_timeout", "type": "Object", "description": "Timeout object to keep a handle on the time limit", "private": "", "guessedtype": "property"}, "foldConditional": {"type": "Boolean", "description": "Flag to check if images are above the fold. If foldConditional is true, the group will check each of its image locations at page load. If any part of the image is within the client viewport, the image is displayed immediately", "guessedname": "foldConditional", "guessedtype": "property"}}, "description": "A group for images. A group can have one time limit and a series of triggers. Thus the images belonging to this group must share these constraints."}, "YAHOO.util.XHRDataSource": {"name": "YAHOO.util.XHRDataSource", "constructors": [{"params": [{"type": "HTMLElement", "name": "oLiveData", "description": " Pointer to live data."}, {"type": "object", "name": "oConfigs", "description": " (optional) Object literal of configuration values."}], "description": "XHRDataSource class for accessing remote data via the YUI Connection Manager\nUtility"}], "namespace": "YAHOO.util", "module": "datasource", "guessedname": "XHRDataSource", "methods": {"_xhrFailure": {"guessedname": "_xhrFailure", "params": [{"type": "Object", "name": "oResponse", "description": " HTTPXMLRequest object"}], "description": "Define Connection Manager failure handler", "private": "", "guessedtype": "function"}, "_xhrSuccess": {"guessedname": "_xhrSuccess", "params": [{"type": "Object", "name": "oResponse", "description": " HTTPXMLRequest object"}], "description": "Define Connection Manager success handler", "private": "", "guessedtype": "function"}, "makeConnection": {"return": {"type": "Number", "description": "Transaction ID."}, "params": [{"type": "Object", "name": "oRequest", "description": " Request object."}, {"type": "Object", "name": "oCallback", "description": " Callback object literal."}, {"type": "Object", "name": "oCaller", "description": " (deprecated) Use oCallback.scope."}], "description": "Overriding method passes query to Connection Manager. The returned\nresponse is then forwarded to the handleResponse function.", "guessedname": "makeConnection", "guessedtype": "function"}}, "extends": "YAHOO.util.DataSourceBase", "superclass": "YAHOO.util.DataSourceBase", "file": "DataSource.js", "guessedtype": "function", "shortname": "XHRDataSource", "properties": {"connTimeout": {"default": "0", "type": "Number", "description": "The connection timeout defines how many milliseconds the XHR connection will\nwait for a server response. Any non-zero value will enable the Connection Manager's\nAuto-Abort feature.", "guessedname": "connTimeout", "guessedtype": "property"}, "connMethodPost": {"default": "false", "type": "Boolean", "description": "True if data is to be sent via POST. By default, data will be sent via GET.", "guessedname": "connMethodPost", "guessedtype": "property"}, "_xhrCallback": {"guessedname": "_xhrCallback", "param": "oResponse {Object} HTTPXMLRequest object", "description": "Define Connection Manager callback object", "private": "", "guessedtype": "property"}, "connXhrMode": {"default": "\"allowAll\"", "type": "String", "description": "Defines request\/response management in the following manner:\n<dl>\n<dt>queueRequests<\/dt>\n<dd>If a request is already in progress, wait until response is returned\nbefore sending the next request.<\/dd>\n<dt>cancelStaleRequests<\/dt>\n<dd>If a request is already in progress, cancel it before sending the next\nrequest.<\/dd>\n<dt>ignoreStaleResponses<\/dt>\n<dd>Send all requests, but handle only the response for the most recently\nsent request.<\/dd>\n<dt>allowAll<\/dt>\n<dd>Send all requests and handle all responses.<\/dd>\n<\/dl>", "guessedname": "connXhrMode", "guessedtype": "property"}, "connMgr": {"default": "YAHOO.util.Connect", "type": "Object", "description": "Alias to YUI Connection Manager, to allow implementers to use a custom class.", "guessedname": "connMgr", "guessedtype": "property"}}, "description": "XHRDataSource class for accessing remote data via the YUI Connection Manager\nUtility"}, "YAHOO": {"name": "YAHOO", "description": "The YAHOO global namespace object. If YAHOO is already defined, the\nexisting YAHOO object will not be overwritten so that defined\nnamespaces are preserved.", "namespace": "", "module": "yahoo", "guessedname": "YAHOO", "static": "", "file": "YAHOO.js", "guessedtype": "property", "shortname": "YAHOO", "methods": {"register": {"static": "", "params": [{"type": "String", "name": "name", "description": " the name of the module (event, slider, etc)"}, {"type": "Function", "name": "mainClass", "description": " a reference to class in the module. This\nclass will be tagged with the version info\nso that it will be possible to identify the\nversion that is in use when multiple versions\nhave loaded"}, {"type": "Object", "name": "data", "description": " metadata object for the module. Currently it\nis expected to contain a \"version\" property\nand a \"build\" property at minimum."}], "description": "Registers a module with the YAHOO object", "guessedname": "register", "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>\nYAHOO.namespace(\"property.package\");\nYAHOO.namespace(\"YAHOO.property.package\");\n<\/pre>\nEither of the above would create YAHOO.property, then\nYAHOO.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>\nYAHOO.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"}]}, "extend": {"static": "", "params": [{"type": "Function", "name": "subc", "description": " the object to modify"}, {"type": "Function", "name": "superc", "description": " the object to inherit"}, {"type": "Object", "name": "overrides", "description": " additional properties\/methods to add to the\nsubclass prototype. These will override the\nmatching items obtained from the superclass if present."}], "description": "An alias for <a href=\"YAHOO.lang.html#extend\">YAHOO.lang.extend<\/a>", "guessedname": "extend", "guessedtype": "property"}, "augment": {"static": "", "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": "String*", "name": "arguments", "description": " zero or more properties methods to \naugment the receiver with. If none specified, everything\nin the supplier will be used unless it would\noverwrite an existing property in the receiver"}], "description": "An alias for <a href=\"YAHOO.lang.html#augment\">YAHOO.lang.augment<\/a>", "guessedname": "augment", "guessedtype": "property"}, "log": {"return": {"type": "Boolean", "description": "True if the log operation was successful."}, "description": "Uses YAHOO.widget.Logger to output a log message, if the widget is\navailable.", "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)"}]}}}, "YAHOO.util.Event": {"name": "YAHOO.util.Event", "namespace": "YAHOO.util", "module": "event", "events": {"DOMReadyEvent": {"description": "Custom event the fires when the dom is initially usable", "guessedname": "DOMReadyEvent", "guessedtype": "property"}}, "guessedname": "Event", "methods": {"regCE": {"description": "Used by old versions of CustomEvent, restored for backwards\ncompatibility", "deprecated": "still here for backwards compatibility", "private": "", "static": "", "guessedname": "regCE", "guessedtype": "function"}, "_removeListener": {"return": {"type": "boolean", "description": "true if the unbind was successful, false \notherwise."}, "description": "Removes an event listener", "private": "", "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": "sType", "description": " the type of event to remove."}, {"type": "Function", "name": "fn", "description": " the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are \nremoved."}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "_getScrollLeft": {"guessedname": "_getScrollLeft", "static": "", "description": "Returns scrollLeft", "private": "", "guessedtype": "function"}, "getTime": {"return": {"type": "Date", "description": "the time of the event"}, "description": "Returns the time of the event. If the time is not included, the\nevent is modified using the current time.", "static": "", "guessedname": "getTime", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}, "addBlurListener": {"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 a blur event handler. (The focusout event is used for Internet Explorer, \nthe focusout, capture-event for Opera, WebKit, and Gecko.)", "static": "", "guessedname": "addBlurListener", "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": "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": "override", "description": " If true, the obj passed in becomes\nthe execution scope of the listener. If an\nobject, this object becomes the execution\nscope."}]}, "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"}]}, "getTarget": {"return": {"type": "HTMLElement", "description": "the event's target"}, "description": "Returns the event's target element. Safari sometimes provides\na text node, and this is automatically resolved to the text\nnode's parent so that it behaves like other browsers.", "static": "", "guessedname": "getTarget", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}, {"type": "boolean", "name": "resolveTextNode", "description": " when set to true the target's\nparent will be returned if the target is a \ntext node. @deprecated, the text node is\nnow resolved automatically"}]}, "_simpleRemove": {"description": "Basic remove listener", "private": "", "static": "", "guessedname": "_simpleRemove", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to bind the handler to"}, {"type": "string", "name": "sType", "description": " the type of event handler"}, {"type": "function", "name": "fn", "description": " the callback to invoke"}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "stopPropagation": {"static": "", "params": [{"type": "Event", "name": "ev", "description": " the event"}], "description": "Stops event propagation", "guessedname": "stopPropagation", "guessedtype": "function"}, "getCharCode": {"return": {"type": "int", "description": "the event's charCode"}, "description": "Returns the charcode for an event", "static": "", "guessedname": "getCharCode", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}, "removeBlurListener": {"return": {"type": "boolean", "description": "true if the unbind was successful, false \notherwise."}, "description": "Removes a blur event listener", "static": "", "guessedname": "removeBlurListener", "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": "Function", "name": "fn", "description": " the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are \nremoved."}]}, "_simpleAdd": {"description": "Adds a DOM event directly without the caching, cleanup, scope adj, etc", "private": "", "static": "", "guessedname": "_simpleAdd", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "el", "description": " the element to bind the handler to"}, {"type": "string", "name": "sType", "description": " the type of event handler"}, {"type": "function", "name": "fn", "description": " the callback to invoke"}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "useLegacyEvent": {"guessedname": "useLegacyEvent", "static": "", "description": "Logic that determines when we should automatically use legacy\nevents instead of DOM2 events. Currently this is limited to old\nSafari browsers with a broken preventDefault", "private": "", "guessedtype": "function"}, "_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"}]}, "getEl": {"description": "We cache elements bound by id because when the unload event \nfires, we can no longer use document.getElementById", "deprecated": "Elements are not cached any longer", "private": "", "static": "", "guessedname": "getEl", "guessedtype": "function"}, "_load": {"guessedname": "_load", "static": "", "description": "hook up any deferred listeners", "private": "", "guessedtype": "function"}, "resolveTextNode": {"return": {"type": "HTMLElement", "description": "the normized node"}, "description": "In some cases, some browsers will return a text node inside\nthe actual element that was targeted. This normalizes the\nreturn value for getTarget and getRelatedTarget.", "static": "", "guessedname": "resolveTextNode", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "node", "description": " node to resolve"}]}, "stopEvent": {"static": "", "params": [{"type": "Event", "name": "ev", "description": " the event"}], "description": "Convenience method for stopPropagation + preventDefault", "guessedname": "stopEvent", "guessedtype": "function"}, "addFocusListener": {"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 a focus event handler. (The focusin event is used for Internet Explorer, \nthe focus, capture-event for Opera, WebKit, and Gecko.)", "static": "", "guessedname": "addFocusListener", "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": "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": "override", "description": " If true, the obj passed in becomes\nthe execution scope of the listener. If an\nobject, this object becomes the execution\nscope."}]}, "fireLegacyEvent": {"guessedname": "fireLegacyEvent", "static": "", "description": "When using legacy events, the handler is routed to this object\nso we can fire our custom listener stack.", "private": "", "guessedtype": "function"}, "getLegacyIndex": {"guessedname": "getLegacyIndex", "static": "", "description": "Returns the legacy event index that matches the supplied \nsignature", "private": "", "guessedtype": "function"}, "getXY": {"return": {"type": "[x, y]", "description": "the pageX and pageY properties of the event"}, "description": "Returns the pageX and pageY properties as an indexed array.", "static": "", "guessedname": "getXY", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}, "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": "sType", "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": "override", "description": " If true, the obj passed in becomes\nthe execution scope of the listener. If an\nobject, this object becomes the execution\nscope."}]}, "_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"}, "onBlur": {"see": "addBlurListener", "static": "", "description": "YAHOO.util.Event.onBlur is an alias for addBlurListener", "guessedname": "onBlur", "guessedtype": "property"}, "_getScrollTop": {"guessedname": "_getScrollTop", "static": "", "description": "Returns scrollTop", "private": "", "guessedtype": "function"}, "onContentReady": {"static": "", "params": [{"type": "string", "name": "p_id", "description": " the id of the element to look for."}, {"type": "function", "name": "p_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 p_fn."}, {"type": "boolean|object", "name": "p_override", "description": " If set to true, p_fn will execute\nin the scope of p_obj. If an object, p_fn will\nexectute in the scope 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>", "guessedname": "onContentReady", "guessedtype": "function"}, "startInterval": {"static": "", "private": "", "guessedname": "startInterval", "guessedtype": "function"}, "onAvailable": {"static": "", "params": [{"type": "string||string[]", "name": "p_id", "description": " the id of the element, or an array\nof ids to look for."}, {"type": "function", "name": "p_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 p_fn."}, {"type": "boolean|object", "name": "p_override", "description": " If set to true, p_fn will execute\nin the scope of p_obj, if set to an object it\nwill execute in the scope 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>", "guessedname": "onAvailable", "guessedtype": "function"}, "removeListener": {"return": {"type": "boolean", "description": "true if the unbind was successful, false \notherwise."}, "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": "sType", "description": " the type of event to remove."}, {"type": "Function", "name": "fn", "description": " the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are \nremoved."}]}, "clearCache": {"description": "Clears the element cache", "deprecated": "Elements are not cached any longer", "private": "", "static": "", "guessedname": "clearCache", "guessedtype": "function"}, "onDOMReady": {"static": "", "params": [{"type": "function", "name": "p_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 p_fn."}, {"type": "boolean|object", "name": "p_scope", "description": " If set to true, p_fn will execute\nin the scope of p_obj, if set to an object it\nwill execute in the scope of that object"}], "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 CustomEvent, so the signature is:<\/p>\n<p>type <string>, args <array>, customobject <object><\/p>\n<p>For DOMReady events, there are no fire argments, so the\nsignature is:<\/p>\n<p>\"DOMReady\", [], obj<\/p>", "guessedname": "onDOMReady", "guessedtype": "function"}, "on": {"see": "addListener", "static": "", "description": "YAHOO.util.Event.on is an alias for addListener", "guessedname": "on", "guessedtype": "property"}, "_getScroll": {"guessedname": "_getScroll", "static": "", "description": "Returns the scrollTop and scrollLeft. Used to calculate the \npageX and pageY in Internet Explorer", "private": "", "guessedtype": "function"}, "getListeners": {"return": {"type": "Object", "description": "the listener. Contains the following fields:\n type: (string) the type of event\n fn: (function) the callback supplied to addListener\n obj: (object) the custom object supplied to addListener\n adjust: (boolean|object) whether or not to adjust the default scope\n scope: (boolean) the derived scope based on the adjust parameter\n scope: (capture) the capture parameter supplied to addListener\n index: (int) its position in the Event util listener cache"}, "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": "sType", "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"}]}, "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": "sType", "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"}, "_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", "private": "", "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": "sType", "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": "override", "description": " If true, the obj passed in becomes\nthe execution scope of the listener. If an\nobject, this object becomes the execution\nscope."}, {"type": "boolen", "name": "capture", "description": " capture or bubble phase"}]}, "preventDefault": {"static": "", "params": [{"type": "Event", "name": "ev", "description": " the event"}], "description": "Prevents the default behavior of the event", "guessedname": "preventDefault", "guessedtype": "function"}, "_getCacheIndex": {"guessedname": "_getCacheIndex", "static": "", "description": "Locating the saved event handler data by function ref", "private": "", "guessedtype": "function"}, "_ready": {"guessedname": "_ready", "static": "", "description": "Fires the DOMReady event listeners the first time the document is\nusable.", "private": "", "guessedtype": "function"}, "getPageY": {"return": {"type": "int", "description": "the event's pageY"}, "description": "Returns the event's pageY", "static": "", "guessedname": "getPageY", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}, "getPageX": {"return": {"type": "int", "description": "the event's pageX"}, "description": "Returns the event's pageX", "static": "", "guessedname": "getPageX", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}, "removeFocusListener": {"return": {"type": "boolean", "description": "true if the unbind was successful, false \notherwise."}, "description": "Removes a focus event listener", "static": "", "guessedname": "removeFocusListener", "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": "Function", "name": "fn", "description": " the method the event invokes. If fn is\nundefined, then all event handlers for the type of event are \nremoved."}]}, "getRelatedTarget": {"return": {"type": "HTMLElement", "description": "the event's relatedTarget"}, "description": "Returns the event's related target", "static": "", "guessedname": "getRelatedTarget", "guessedtype": "function", "params": [{"type": "Event", "name": "ev", "description": " the event"}]}}, "static": "", "file": "Event.js", "guessedtype": "function", "shortname": "Event", "properties": {"isSafari": {"description": "Safari detection", "deprecated": "use YAHOO.env.ua.webkit", "private": "", "static": "", "guessedname": "isSafari", "guessedtype": "property"}, "CAPTURE": {"description": "The original capture parameter passed into _addListener", "static": "", "guessedname": "CAPTURE", "guessedtype": "property", "type": "int", "final": ""}, "WFN": {"description": "Function wrapped for scope correction and cleanup, int constant", "static": "", "guessedname": "WFN", "guessedtype": "property", "type": "int", "final": ""}, "throwErrors": {"default": "false", "type": "boolean", "description": "Errors thrown by subscribers of custom events are caught\nand the error message is written to the debug console. If\nthis property is set to true, it will also re-throw the\nerror.", "guessedname": "throwErrors", "guessedtype": "property"}, "legacyEvents": {"guessedname": "legacyEvents", "static": "", "description": "Cache of DOM0 event handlers to work around issues with DOM2 events\nin Safari", "private": "", "guessedtype": "property"}, "legacyHandlers": {"guessedname": "legacyHandlers", "static": "", "description": "Listener stack for DOM0 events", "private": "", "guessedtype": "property"}, "FN": {"description": "Function to execute, int constant", "static": "", "guessedname": "FN", "guessedtype": "property", "type": "int", "final": ""}, "DOMReady": {"type": "boolean", "static": "", "description": "True when the document is initially usable", "guessedname": "DOMReady", "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": ""}, "isIE": {"description": "IE detection", "deprecated": "use YAHOO.env.ua.ie", "private": "", "static": "", "guessedname": "isIE", "guessedtype": "property"}, "unloadListeners": {"description": "User-defined unload function that will be fired before all events\nare detached", "private": "", "static": "", "guessedname": "unloadListeners", "guessedtype": "property", "type": "array"}, "OVERRIDE": {"description": "The original scope parameter passed into addListener", "static": "", "guessedname": "OVERRIDE", "guessedtype": "property", "type": "int", "final": ""}, "EL": {"description": "Element to bind, int constant", "static": "", "guessedname": "EL", "guessedtype": "property", "type": "int", "final": ""}, "OBJ": {"description": "Object passed in by the user that will be returned as a \nparameter to the callback, int constant. Specific to\nunload listeners", "static": "", "guessedname": "UNLOAD_OBJ", "guessedtype": "property", "type": "int", "final": ""}, "elCache\nDOM element cache": {"deprecated": "Elements are not cached due to issues that arise when\nelements are removed and re-added", "static": "", "guessedname": "elCache", "private": "", "guessedtype": "property"}, "_interval": {"guessedname": "_interval", "static": "", "description": "poll handle", "private": "", "guessedtype": "property"}, "webkit": {"description": "webkit version", "deprecated": "use YAHOO.env.ua.webkit", "private": "", "static": "", "guessedname": "webkit", "guessedtype": "property", "type": "string"}, "legacyMap": {"guessedname": "legacyMap", "static": "", "description": "Lookup table for legacy events", "private": "", "guessedtype": "property"}, "loadComplete": {"description": "True after the onload event has fired", "private": "", "static": "", "guessedname": "loadComplete", "guessedtype": "property", "type": "boolean"}, "webkitKeymap": {"description": "Normalized keycodes for webkit\/safari", "private": "", "static": "", "guessedname": "webkitKeymap", "guessedtype": "property", "type": "{int: int}", "final": ""}, "_dri": {"guessedname": "_dri", "static": "", "description": "document readystate poll handle", "private": "", "guessedtype": "property"}, "counter": {"guessedname": "counter", "static": "", "description": "Counter for auto id generation", "private": "", "guessedtype": "property"}, "POLL_INTERVAL": {"description": "The poll interval in milliseconds", "static": "", "guessedname": "POLL_INTERVAL", "guessedtype": "property", "type": "int", "final": ""}, "ADJ_SCOPE": {"description": "Adjusted scope, either the element we are registering the event\non or the custom object passed in by the listener, int constant", "static": "", "guessedname": "ADJ_SCOPE", "guessedtype": "property", "type": "int", "final": ""}, "onAvailStack": {"guessedname": "onAvailStack", "static": "", "description": "onAvailable listeners", "private": "", "guessedtype": "property"}, "listeners": {"description": "Cache of wrapped listeners", "private": "", "static": "", "guessedname": "listeners", "guessedtype": "property", "type": "array"}, "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"}, "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"}, "TYPE": {"description": "Type of event, int constant", "static": "", "guessedname": "TYPE", "guessedtype": "property", "type": "int", "final": ""}}, "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."}, "YAHOO.util.Dom": {"name": "YAHOO.util.Dom", "namespace": "YAHOO.util", "module": "dom", "guessedname": "Dom", "methods": {"getElementsBy": {"return": {"type": "Array", "description": "Array of HTMLElements"}, "params": [{"type": "Function", "name": "method", "description": " - A boolean method for testing elements which receives the element as its only argument."}, {"type": "String", "name": "tag", "description": " (optional) The tag name of the elements being collected"}, {"type": "String | HTMLElement", "name": "root", "description": " (optional) The HTMLElement or an ID to use as the starting point"}, {"type": "Function", "name": "apply", "description": " (optional) A function to apply to each element when found"}], "description": "Returns a array of HTMLElements that pass the test applied by supplied boolean method.\nFor optimized performance, include a tag and\/or root node when possible.", "guessedname": "getElementsBy", "guessedtype": "function"}, "generateId": {"return": {"type": "String | Array", "description": "The generated ID, or array of generated IDs (or original ID if already present on an element)"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " (optional) An optional element array of elements to add an ID to (no ID is added if one is already present)."}, {"type": "String", "name": "prefix", "description": " (optional) an optional prefix to use (defaults to \"yui-gen\")."}], "description": "Returns an ID and applies it to the element \"el\", if provided.", "guessedname": "generateId", "guessedtype": "function"}, "getDocumentWidth": {"return": {"type": "Int", "description": "The width of the actual document (which includes the body and its margin)."}, "description": "Returns the width of the document.", "guessedname": "getDocumentWidth", "guessedtype": "function"}, "setStyle": {"params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}, {"type": "String", "name": "property", "description": " The style property to be set."}, {"type": "String", "name": "val", "description": " The value to apply to the given property."}], "description": "Wrapper for setting style properties of HTMLElements. Normalizes \"opacity\" across modern browsers.", "guessedname": "setStyle", "guessedtype": "function"}, "getX": {"return": {"type": "Number | Array", "description": "The X position of the element(s)"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements"}], "description": "Gets the current X position of an element based on page coordinates. The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "getX", "guessedtype": "function"}, "getY": {"return": {"type": "Number | Array", "description": "The Y position of the element(s)"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements"}], "description": "Gets the current Y position of an element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "getY", "guessedtype": "function"}, "getChildren": {"return": {"type": "Array", "description": "A static array of HTMLElements"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}], "description": "Returns an array of HTMLElement childNodes.", "guessedname": "getChildren", "guessedtype": "function"}, "getFirstChild": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}], "description": "Returns the first HTMLElement child.", "guessedname": "getFirstChild", "guessedtype": "function"}, "getClientRegion": {"return": {"type": "Region", "description": "A Region object representing the viewport which accounts for document scroll"}, "description": "Creates a Region based on the viewport relative to the document.", "guessedname": "getClientRegion", "guessedtype": "function"}, "getLastChildBy": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to use as the starting point"}, {"type": "Function", "name": "method", "description": " A boolean function used to test children\nthat receives the node being tested as its only argument"}], "description": "Returns the last HTMLElement child that passes the test method.", "guessedname": "getLastChildBy", "guessedtype": "function"}, "getAncestorBy": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to use as the starting point"}, {"type": "Function", "name": "method", "description": " - A boolean method for testing elements which receives the element as its only argument."}], "description": "Returns the nearest ancestor that passes the test applied by supplied boolean method.\nFor performance reasons, IDs are not accepted and argument validation omitted.", "guessedname": "getAncestorBy", "guessedtype": "function"}, "insertBefore": {"return": {"type": "HTMLElement", "description": "The node that was inserted (or null if insert fails)"}, "params": [{"type": "String | HTMLElement", "name": "newNode", "description": " The node to be inserted"}, {"type": "String | HTMLElement", "name": "referenceNode", "description": " The node to insert the new node before"}], "description": "Inserts the new node as the previous sibling of the reference node", "guessedname": "insertBefore", "guessedtype": "function"}, "getPreviousSiblingBy": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to use as the starting point"}, {"type": "Function", "name": "method", "description": " A boolean function used to test siblings\nthat receives the sibling node being tested as its only argument"}], "description": "Returns the previous sibling that is an HTMLElement. \nFor performance reasons, IDs are not accepted and argument validation omitted.\nReturns the nearest HTMLElement sibling if no method provided.", "guessedname": "getPreviousSiblingBy", "guessedtype": "function"}, "getElementsByClassName": {"return": {"type": "Array", "description": "An array of elements that have the given class name"}, "params": [{"type": "String", "name": "className", "description": " The class name to match against"}, {"type": "String", "name": "tag", "description": " (optional) The tag name of the elements being collected"}, {"type": "String | HTMLElement", "name": "root", "description": " (optional) The HTMLElement or an ID to use as the starting point"}, {"type": "Function", "name": "apply", "description": " (optional) A function to apply to each element when found"}], "description": "Returns a array of HTMLElements with the given class.\nFor optimized performance, include a tag and\/or root node when possible.", "guessedname": "getElementsByClassName", "guessedtype": "function"}, "replaceClass": {"return": {"type": "Boolean | Array", "description": "A pass\/fail boolean or array of booleans"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " The element or collection to remove the class from"}, {"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.", "guessedname": "replaceClass", "guessedtype": "function"}, "getNextSibling": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}], "description": "Returns the next sibling that is an HTMLElement", "guessedname": "getNextSibling", "guessedtype": "function"}, "getDocumentHeight": {"return": {"type": "Int", "description": "The height of the actual document (which includes the body and its margin)."}, "description": "Returns the height of the document.", "guessedname": "getDocumentHeight", "guessedtype": "function"}, "getLastChild": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}], "description": "Returns the last HTMLElement child.", "guessedname": "getLastChild", "guessedtype": "function"}, "getClientHeight": {"deprecated": "Now using getViewportHeight. This interface left intact for back compat.", "return": {"type": "Int", "description": "The height of the viewable area of the page."}, "description": "Returns the height of the client (viewport).", "guessedname": "getClientHeight", "guessedtype": "function"}, "inDocument": {"return": {"type": "Boolean", "description": "Whether or not the element is present in the current document"}, "params": [{"type": "String | HTMLElement", "name": "el", "description": " The element to search for"}], "description": "Determines whether an HTMLElement is present in the current document.", "guessedname": "inDocument", "guessedtype": "function"}, "insertAfter": {"return": {"type": "HTMLElement", "description": "The node that was inserted (or null if insert fails)"}, "params": [{"type": "String | HTMLElement", "name": "newNode", "description": " The node to be inserted"}, {"type": "String | HTMLElement", "name": "referenceNode", "description": " The node to insert the new node after"}], "description": "Inserts the new node as the next sibling of the reference node", "guessedname": "insertAfter", "guessedtype": "function"}, "getViewportHeight": {"return": {"type": "Int", "description": "The height of the viewable area of the page (excludes scrollbars)."}, "description": "Returns the current height of the viewport.", "guessedname": "getViewportHeight", "guessedtype": "function"}, "addClass": {"return": {"type": "Boolean | Array", "description": "A pass\/fail boolean or array of booleans"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " The element or collection to add the class to"}, {"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.", "guessedname": "addClass", "guessedtype": "function"}, "getAncestorByClassName": {"return": {"type": "Object", "description": "HTMLElement"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}, {"type": "String", "name": "className", "description": ""}], "description": "Returns the nearest ancestor with the given className.", "guessedname": "getAncestorByClassName", "guessedtype": "function"}, "getViewportWidth": {"return": {"type": "Int", "description": "The width of the viewable area of the page (excludes scrollbars)."}, "description": "Returns the current width of the viewport.", "guessedname": "getViewportWidth", "guessedtype": "function"}, "get": {"return": {"type": "HTMLElement | Array", "description": "A DOM reference to an HTML element or an array of HTMLElements."}, "params": [{"type": "String | HTMLElement |Array", "name": "el", "description": " Accepts a string to use as an ID for getting a DOM reference, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}], "description": "Returns an HTMLElement reference.", "guessedname": "get", "guessedtype": "function"}, "removeClass": {"return": {"type": "Boolean | Array", "description": "A pass\/fail boolean or array of booleans"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " The element or collection to remove the class from"}, {"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.", "guessedname": "removeClass", "guessedtype": "function"}, "getStyle": {"return": {"type": "String | Array", "description": "The current value of the style property for the element(s)."}, "params": [{"type": "String | HTMLElement |Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}, {"type": "String", "name": "property", "description": " The style property whose value is returned."}], "description": "Normalizes currentStyle and ComputedStyle.", "guessedname": "getStyle", "guessedtype": "function"}, "setXY": {"params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements"}, {"type": "Array", "name": "pos", "description": " Contains X & Y values for new position (coordinates are page-based)"}, {"type": "Boolean", "name": "noRetry", "description": " By default we try and set the position a second time if the first fails"}], "description": "Set the position of an html element in page coordinates, regardless of how the element is positioned.\nThe element(s) must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setXY", "guessedtype": "function"}, "getPreviousSibling": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}], "description": "Returns the previous sibling that is an HTMLElement", "guessedname": "getPreviousSibling", "guessedtype": "function"}, "getDocumentScrollTop": {"return": {"type": "Int", "description": "The amount that the document is scrolled to the top"}, "params": [{"type": "HTMLDocument", "name": "document", "description": " (optional) The document to get the scroll value of"}], "description": "Returns the top scroll value of the document", "guessedname": "getDocumentScrollTop", "guessedtype": "function"}, "setX": {"params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}, {"type": "Int", "name": "x", "description": " The value to use as the X coordinate for the element(s)."}], "description": "Set the X position of an html element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setX", "guessedtype": "function"}, "setY": {"params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}, {"type": "Int", "name": "x", "description": " To use as the Y coordinate for the element(s)."}], "description": "Set the Y position of an html element in page coordinates, regardless of how the element is positioned.\nThe element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "setY", "guessedtype": "function"}, "getXY": {"return": {"type": "Array", "description": "The XY position of the element(s)"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements"}], "description": "Gets the current position of an element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).", "guessedname": "getXY", "guessedtype": "function"}, "getFirstChildBy": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to use as the starting point"}, {"type": "Function", "name": "method", "description": " A boolean function used to test children\nthat receives the node being tested as its only argument"}], "description": "Returns the first HTMLElement child that passes the test method.", "guessedname": "getFirstChildBy", "guessedtype": "function"}, "getClientWidth": {"deprecated": "Now using getViewportWidth. This interface left intact for back compat.", "return": {"type": "Int", "description": "The width of the viewable area of the page."}, "description": "Returns the width of the client (viewport).", "guessedname": "getClientWidth", "guessedtype": "function"}, "getNextSiblingBy": {"return": {"type": "Object", "description": "HTMLElement or null if not found"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to use as the starting point"}, {"type": "Function", "name": "method", "description": " A boolean function used to test siblings\nthat receives the sibling node being tested as its only argument"}], "description": "Returns the next HTMLElement sibling that passes the boolean method. \nFor performance reasons, IDs are not accepted and argument validation omitted.\nReturns the nearest HTMLElement sibling if no method provided.", "guessedname": "getNextSiblingBy", "guessedtype": "function"}, "getRegion": {"return": {"type": "Region | Array", "description": "A Region or array of Region instances containing \"top, left, bottom, right\" member data."}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " Accepts a string to use as an ID, an actual DOM reference, or an Array of IDs and\/or HTMLElements."}], "description": "Returns the region position of the given element.\nThe element must be part of the DOM tree to have a region (display:none or elements not appended return false).", "guessedname": "getRegion", "guessedtype": "function"}, "batch": {"return": {"type": "Any | Array", "description": "The return value(s) from the supplied method"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " (optional) An element or array of elements to apply the method to"}, {"type": "Function", "name": "method", "description": " The method to apply to the element(s)"}, {"type": "Any", "name": "o", "description": " (optional) An optional arg that is passed to the supplied method"}, {"type": "Boolean", "name": "override", "description": " (optional) Whether or not to override the scope of \"method\" with \"o\""}], "description": "Runs the supplied method against each item in the Collection\/Array.\nThe method is called with the element(s) as the first arg, and the optional param as the second ( method(el, o) ).", "guessedname": "batch", "guessedtype": "function"}, "getChildrenBy": {"return": {"type": "Array", "description": "A static array of HTMLElements"}, "params": [{"type": "HTMLElement", "name": "node", "description": " The HTMLElement to start from"}, {"type": "Function", "name": "method", "description": " A boolean function used to test children\nthat receives the node being tested as its only argument"}], "description": "Returns an array of HTMLElement childNodes that pass the test method.", "guessedname": "getChildrenBy", "guessedtype": "function"}, "isAncestor": {"return": {"type": "Boolean", "description": "Whether or not the haystack is an ancestor of needle"}, "params": [{"type": "String | HTMLElement", "name": "haystack", "description": " The possible ancestor"}, {"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": "isAncestor", "guessedtype": "function"}, "getDocumentScrollLeft": {"return": {"type": "Int", "description": "The amount that the document is scrolled to the left"}, "params": [{"type": "HTMLDocument", "name": "document", "description": " (optional) The document to get the scroll value of"}], "description": "Returns the left scroll value of the document", "guessedname": "getDocumentScrollLeft", "guessedtype": "function"}, "getAncestorByTagName": {"return": {"type": "Object", "description": "HTMLElement"}, "params": [{"type": "String | HTMLElement", "name": "node", "description": " The HTMLElement or an ID to use as the starting point"}, {"type": "String", "name": "tagName", "description": ""}], "description": "Returns the nearest ancestor with the given tagName.", "guessedname": "getAncestorByTagName", "guessedtype": "function"}, "hasClass": {"return": {"type": "Boolean | Array", "description": "A boolean value or array of boolean values"}, "params": [{"type": "String | HTMLElement | Array", "name": "el", "description": " The element or collection to test"}, {"type": "String", "name": "className", "description": " the class name to search for"}], "description": "Determines whether an HTMLElement has the given className.", "guessedname": "hasClass", "guessedtype": "function"}}, "file": "Dom.js", "guessedtype": "property", "shortname": "Dom", "description": "Provides helper methods for DOM elements."}, "YAHOO.widget.TVFadeOut": {"name": "YAHOO.widget.TVFadeOut", "constructors": [{"params": [{"type": "HTMLElement", "name": "el", "description": " the element to animate"}, {"type": "Function", "name": "callback", "description": " function to invoke when the animation is finished"}], "description": "A 1\/2 second fade out animation."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "TVFadeOut", "methods": {"onComplete": {"description": "Clean up and invoke callback", "guessedname": "onComplete", "guessedtype": "function"}, "animate": {"description": "Performs the animation", "guessedname": "animate", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "the string representation of the instance"}, "description": "toString", "guessedname": "toString", "guessedtype": "function"}}, "file": "TVFadeOut.js", "guessedtype": "function", "shortname": "TVFadeOut", "properties": {"el": {"type": "HTMLElement", "description": "The element to animate", "guessedname": "el", "guessedtype": "property"}, "callback": {"type": "function", "description": "the callback to invoke when the animation is complete", "guessedname": "callback", "guessedtype": "property"}}, "description": "A 1\/2 second fade out animation."}, "YAHOO.widget.RadioCellEditor": {"name": "YAHOO.widget.RadioCellEditor", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (Optional) Object literal of configs."}], "description": "The RadioCellEditor class provides functionality for inline editing\nDataTable cell data with radio buttons."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "RadioCellEditor", "methods": {"renderForm": {"description": "Render a form with input(s) type=radio.", "guessedname": "renderForm", "guessedtype": "function"}, "handleDisabledBtns": {"description": "After rendering form, if disabledBtns is set to true, then sets up a mechanism\nto save input without them.", "guessedname": "handleDisabledBtns", "guessedtype": "function"}, "getInputValue": {"description": "Retrieves input value from RadioCellEditor.", "guessedname": "getInputValue", "guessedtype": "function"}, "focus": {"description": "Sets focus in RadioCellEditor.", "guessedname": "focus", "guessedtype": "function"}, "resetForm": {"description": "Resets RadioCellEditor UI to initial state.", "guessedname": "resetForm", "guessedtype": "function"}}, "extends": "YAHOO.widget.BaseCellEditor", "superclass": "YAHOO.widget.BaseCellEditor", "file": "CellEditor.js", "guessedtype": "function", "shortname": "RadioCellEditor", "properties": {"radioOptions": {"type": "String[] | Object[]", "description": "Array of radio values. Can either be a simple array (e.g., [\"yes\",\"no\",\"maybe\"])\nor a an array of objects (e.g., [{label:\"yes\", value:1}, {label:\"no\", value:-1},\n{label:\"maybe\", value:0}]).", "guessedname": "radioOptions", "guessedtype": "property"}, "radios": {"type": "HTMLElement[]", "description": "Reference to radio elements.", "guessedname": "radios", "guessedtype": "property"}}, "description": "The RadioCellEditor class provides functionality for inline editing\nDataTable cell data with radio buttons."}, "YAHOO.widget.Paginator.ui.LastPageLink": {"properties": {"current": {"guessedname": "current", "type": "HTMLElement", "description": "Currently placed HTMLElement node", "private": "", "guessedtype": "property"}, "span": {"guessedname": "span", "type": "HTMLElement", "description": "Span node (inactive link)", "private": "", "guessedtype": "property"}, "link": {"guessedname": "link", "type": "HTMLElement", "description": "Link HTMLElement node", "private": "", "guessedtype": "property"}, "na": {"guessedname": "na", "type": "HTMLElement", "description": "Empty place holder node for when the last page link is inappropriate to\ndisplay in any form (unlimited paging).", "private": "", "guessedtype": "property"}}, "name": "YAHOO.widget.Paginator.ui.LastPageLink", "for": "YAHOO.widget.Paginator", "innerClasses": ["YAHOO.widget.Paginator"], "constructors": [{"params": [{"type": "Pagintor", "name": "p", "description": " Paginator instance to attach to"}], "description": "ui Component to generate the link to jump to the last page."}], "namespace": "YAHOO.widget.Paginator.ui", "module": "paginator", "events": {"beforeLastPageLinkLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLastPageLinkLabelChange", "description": "Fires before the value for the configuration attribute 'lastPageLinkLabel' changes. Return false to cancel the attribute change."}, "lastPageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "lastPageLinkClassChange", "description": "Fires when the value for the configuration attribute 'lastPageLinkClass' changes."}, "beforeLastPageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLastPageLinkClassChange", "description": "Fires before the value for the configuration attribute 'lastPageLinkClass' changes. Return false to cancel the attribute change."}, "lastPageLinkLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "lastPageLinkLabelChange", "description": "Fires when the value for the configuration attribute 'lastPageLinkLabel' changes."}}, "guessedname": "LastPageLink", "methods": {"onClick": {"params": [{"type": "DOMEvent", "name": "e", "description": " The click event"}], "description": "Listener for the link's onclick event. Passes to setPage method.", "guessedname": "onClick", "guessedtype": "function"}, "destroy": {"private": "", "description": "Removes the link\/span node and clears event listeners", "guessedname": "destroy", "guessedtype": "function"}, "init": {"static": "", "params": [{"type": "Paginator", "name": "paginator", "description": " Paginator instance to decorate"}], "description": "Decorates Paginator instances with new attributes. Called during\nPaginator instantiation.", "guessedname": "init", "guessedtype": "function"}, "update": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event (ignored)"}], "description": "Swap the link, span, and na nodes if appropriate.", "guessedname": "update", "guessedtype": "function"}, "render": {"return": {"type": "HTMLElement", "description": ""}, "params": [{"type": "string", "name": "id_base", "description": " used to create unique ids for generated nodes"}], "description": "Generate the nodes and return the appropriate node given the current\npagination state.", "guessedname": "render", "guessedtype": "function"}}, "file": "LastPageLink.js", "guessedtype": "function", "shortname": "LastPageLink", "configs": {"lastPageLinkClass": {"default": "'yui-pg-last'", "description": "CSS class assigned to the link\/span"}, "lastPageLinkLabel": {"default": "'last >>'", "description": "Used as innerHTML for the last page link\/span."}}, "description": "ui Component to generate the link to jump to the last page."}, "YAHOO.widget.Chart": {"name": "YAHOO.widget.Chart", "configs": {"categoryNames": {"type": "Array", "description": "Defines the names of the categories to be displayed in the Chart.."}, "series": {"type": "Array", "description": "Defines the series to be displayed by the Chart."}, "request": {"type": "String", "description": "Request to be sent to the Chart's DataSource."}, "dataTipFunction": {"type": "String", "description": "The string representation of a globally-accessible function\nthat may be called by the SWF to generate the datatip text for a Chart's item."}, "dataSource": {"type": "DataSource", "description": "The DataSource instance to display in the Chart."}, "polling": {"type": "Number", "description": "A numeric value indicating the number of milliseconds between\npolling requests to the DataSource."}}, "constructors": [{"params": [{"type": "String", "name": "type", "description": " The char type. May be \"line\", \"column\", \"bar\", or \"pie\""}, {"type": "HTMLElement", "name": "containerId", "description": " Container element for the Flash Player instance."}, {"type": "YAHOO.util.DataSource", "name": "dataSource", "description": " DataSource instance."}, {"type": "object", "name": "attributes", "description": " (optional) Object literal of configuration values."}], "description": "Chart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "properties": {"_dataTipFunction": {"guessedname": "_dataTipFunction", "type": "String", "description": "Stores a reference to the dataTipFunction created by\nYAHOO.widget.FlashAdapter.createProxyFunction()", "private": "", "guessedtype": "property"}, "_dataSource": {"private": "", "description": "Storage for the dataSource attribute.", "guessedname": "_dataSource", "guessedtype": "property"}, "_request": {"private": "", "description": "Storage for the request attribute.", "guessedname": "_request", "guessedtype": "property"}, "_pollingInterval": {"guessedname": "_pollingInterval", "type": "Number", "description": "The time, in ms, between requests for data.", "private": "", "guessedtype": "property"}, "_type": {"guessedname": "_type", "type": "String", "description": "The type of this chart instance.", "private": "", "guessedtype": "property"}, "_seriesDefs": {"private": "", "description": "Storage for the series attribute.", "guessedname": "_seriesDefs", "guessedtype": "property"}, "Chart.SWFURL": {"description": "Storage for the dataTipFunction attribute.", "default": "\"assets\/charts.swf\"", "private": "", "static": "", "guessedname": "SWFURL", "guessedtype": "property", "final": ""}, "_seriesLabelFunctions": {"guessedname": "_seriesLabelFunctions", "type": "Array", "description": "Stores references to series labelFunction values created by\nYAHOO.widget.FlashAdapter.createProxyFunction()", "private": "", "guessedtype": "property"}, "_pollingID": {"guessedname": "_pollingID", "type": "Number", "description": "The id returned from the DataSource's setInterval function.", "private": "", "guessedtype": "property"}}, "guessedname": "Chart", "methods": {"_getSeriesDefs": {"private": "", "description": "Getter for the series attribute.", "guessedname": "_getSeriesDefs", "guessedtype": "function"}, "_loadHandler": {"private": "", "description": "Called when the SWF is ready for communication. Sets the type, initializes\nthe styles, and sets the DataSource.", "guessedname": "_loadHandler", "guessedtype": "function"}, "_loadDataHandler": {"private": "", "description": "Called when the DataSource receives new data. The series definitions are used\nto build a data provider for the SWF chart.", "guessedname": "_loadDataHandler", "guessedtype": "function"}, "_getRequest": {"private": "", "description": "Getter for the request attribute.", "guessedname": "_getRequest", "guessedtype": "function"}, "_setSeriesDefs": {"private": "", "description": "Setter for the series attribute.", "guessedname": "_setSeriesDefs", "guessedtype": "function"}, "_setRequest": {"private": "", "description": "Setter for the request attribute.", "guessedname": "_setRequest", "guessedtype": "function"}, "_getDataSource": {"private": "", "description": "Getter for the dataSource attribute.", "guessedname": "_getDataSource", "guessedtype": "function"}, "refreshData": {"description": "Sends (or resends) the request to the DataSource.", "guessedname": "refreshData", "guessedtype": "function"}, "_setDataSource": {"private": "", "description": "Setter for the dataSource attribute.", "guessedname": "_setDataSource", "guessedtype": "function"}, "_initAttributes": {"private": "", "description": "Initializes the attributes.", "guessedname": "_initAttributes", "guessedtype": "function"}, "_setCategoryNames": {"private": "", "description": "Setter for the categoryNames attribute.", "guessedname": "_setCategoryNames", "guessedtype": "function"}, "setStyles": {"params": [{"type": "Object", "name": "styles", "description": " Initializer for all Chart styles."}], "description": "Resets all styles on the Chart instance.", "guessedname": "setStyles", "guessedtype": "function"}, "setSeriesStyles": {"params": [{"type": "Array", "name": "styles", "description": " Initializer for all Chart series styles."}], "description": "Sets the styles on all series in the Chart.", "guessedname": "setSeriesStyles", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the Chart instance."}, "description": "Public accessor to the unique name of the Chart instance.", "guessedname": "toString", "guessedtype": "function"}, "_getPolling": {"private": "", "description": "Getter for the polling attribute.", "guessedname": "_getPolling", "guessedtype": "function"}, "_setPolling": {"private": "", "description": "Setter for the polling attribute.", "guessedname": "_setPolling", "guessedtype": "function"}, "_getCategoryNames": {"private": "", "description": "Getter for the categoryNames attribute.", "guessedname": "_getCategoryNames", "guessedtype": "function"}, "setStyle": {"params": [{"type": "String", "name": "name", "description": " Name of the Chart style value to change."}, {"type": "Object", "name": "value", "description": " New value to pass to the Chart style."}], "description": "Sets a single style value on the Chart instance.", "guessedname": "setStyle", "guessedtype": "function"}, "_setDataTipFunction": {"private": "", "description": "Setter for the dataTipFunction attribute.", "guessedname": "_setDataTipFunction", "guessedtype": "function"}}, "uses": ["YAHOO.widget.FlashAdapter"], "file": "Chart.js", "guessedtype": "function", "shortname": "Chart", "events": {"itemDragEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user moves the mouse during a drag action."}, "beforeDataSourceChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataSourceChange", "description": "Fires before the value for the configuration attribute 'dataSource' changes. Return false to cancel the attribute change."}, "beforeSeriesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSeriesChange", "description": "Fires before the value for the configuration attribute 'series' changes. Return false to cancel the attribute change."}, "itemDragStartEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user presses the mouse down on an item to initiate a drag action."}, "dataTipFunctionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataTipFunctionChange", "description": "Fires when the value for the configuration attribute 'dataTipFunction' changes."}, "dataSourceChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "dataSourceChange", "description": "Fires when the value for the configuration attribute 'dataSource' changes."}, "seriesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "seriesChange", "description": "Fires when the value for the configuration attribute 'series' changes."}, "pollingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "pollingChange", "description": "Fires when the value for the configuration attribute 'polling' changes."}, "beforeCategoryNamesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCategoryNamesChange", "description": "Fires before the value for the configuration attribute 'categoryNames' changes. Return false to cancel the attribute change."}, "itemMouseOverEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user moves the mouse over the bounds of an item renderer in the chart."}, "categoryNamesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "categoryNamesChange", "description": "Fires when the value for the configuration attribute 'categoryNames' changes."}, "beforeDataTipFunctionChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDataTipFunctionChange", "description": "Fires before the value for the configuration attribute 'dataTipFunction' changes. Return false to cancel the attribute change."}, "beforePollingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforePollingChange", "description": "Fires before the value for the configuration attribute 'polling' changes. Return false to cancel the attribute change."}, "requestChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "requestChange", "description": "Fires when the value for the configuration attribute 'request' changes."}, "itemClickEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user clicks an item renderer in the chart with the mouse."}, "itemDragEndEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user releases the mouse during a drag action."}, "beforeRequestChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeRequestChange", "description": "Fires before the value for the configuration attribute 'request' changes. Return false to cancel the attribute change."}, "itemDoubleClickEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user double-clicks an item renderer in the chart with the mouse."}, "itemMouseOutEvent": {"params": [{"type": "String", "name": "event.type", "description": " The event type"}, {"type": "Object", "name": "event.item", "description": " The data displayed by the renderer"}, {"type": "Number", "name": "event.index", "description": " The position within the series that the item appears."}, {"type": "Number", "name": "event.seriesIndex", "description": " The position within the series definition that the series appears."}, {"type": "Number", "name": "event.x", "description": " The horizontal position of the mouse, relative to the SWF."}, {"type": "Number", "name": "event.y", "description": " The vertical position of the mouse, relative to the SWF."}], "description": "Fires when the user moves the mouse out of the bounds of an item renderer in the chart."}}, "description": "Chart class for the YUI Charts widget."}, "YAHOO.util.ColumnDD": {"name": "YAHOO.util.ColumnDD", "constructors": [{"params": [{"type": "YAHOO.widget.DataTable", "name": "oDataTable", "description": " DataTable instance."}, {"type": "YAHOO.widget.Column", "name": "oColumn", "description": " Column instance."}, {"type": "HTMLElement", "name": "elTh", "description": " TH element reference."}, {"type": "HTMLElement", "name": "elTarget", "description": " Drag target element."}], "description": "ColumnDD subclasses DragDrop to support rearrangeable Columns."}], "namespace": "YAHOO.util", "module": "datatable", "guessedname": "ColumnDD", "extends": "YAHOO.util.DDProxy", "superclass": "YAHOO.util.DDProxy", "file": "ColumnSet.js", "guessedtype": "function", "shortname": "ColumnDD", "description": "ColumnDD subclasses DragDrop to support rearrangeable Columns."}, "YAHOO.widget.RootNode": {"name": "YAHOO.widget.RootNode", "constructors": [{"params": [{"type": "YAHOO.widget.TreeView", "name": "oTree", "description": " The tree instance this node belongs to"}], "description": "A custom YAHOO.widget.Node that handles the unique nature of \r\nthe virtual, presentationless root node."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "RootNode", "methods": {"getNodeCount": {"return": {"type": "int", "description": "number of nodes in the tree"}, "description": "Count of nodes in tree. \r\nIt overrides Nodes.getNodeCount because the root node should not be counted.", "guessedname": "getNodeCount", "guessedtype": "function"}, "getNodeDefinition": {"return": {"type": "Object | false", "description": "definition of the tree or false if any child node is defined as dynamic"}, "description": "Returns an object which could be used to build a tree out of this node and its children.\r\nIt can be passed to the tree constructor to reproduce this node as a tree.\r\nSince the RootNode is automatically created by treeView, \r\nits own definition is excluded from the returned node definition\r\nwhich only contains its children.", "guessedname": "getNodeDefinition", "guessedtype": "function"}}, "extends": "YAHOO.widget.Node", "superclass": "YAHOO.widget.Node", "file": "RootNode.js", "guessedtype": "function", "shortname": "RootNode", "properties": {"_type": {"description": "The node type", "default": "\"RootNode\"", "private": "", "guessedname": "_type", "guessedtype": "property", "type": "string"}}, "description": "A custom YAHOO.widget.Node that handles the unique nature of \r\nthe virtual, presentationless root node."}, "YAHOO.tool.TestNode": {"name": "YAHOO.tool.TestNode", "constructors": [{"params": [{"type": "Variant", "name": "testObject", "description": " A TestSuite, TestCase, or the name of a test function."}], "description": "A node in the test tree structure. May represent a TestSuite, TestCase, or\ntest function."}], "namespace": "YAHOO.tool", "module": "yuitest", "methods": {"appendChild": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Variant", "name": "testObject", "description": " A TestSuite, TestCase, or the name of a test function."}], "description": "Appends a new test object (TestSuite, TestCase, or test function name) as a child\nof this node.", "guessedname": "appendChild", "guessedtype": "function"}}, "private": "", "file": "TestRunner.js", "shortname": "TestNode", "properties": {"testObject": {"type": "Variant", "description": "The TestSuite, TestCase, or test function represented by this node.", "guessedname": "testObject", "guessedtype": "property"}, "parent": {"type": "TestNode", "description": "Pointer to this node's parent.", "guessedname": "parent", "guessedtype": "property"}, "results": {"type": "object", "description": "Test results for this test object."}, "firstChild": {"type": "TestNode", "description": "Pointer to this node's first child."}, "next": {"type": "TestNode", "description": "Pointer to this node's next sibling.", "guessedname": "next", "guessedtype": "property"}, "lastChild": {"type": "TestNode", "description": "Pointer to this node's last child.", "guessedname": "lastChild", "guessedtype": "property"}}, "description": "A node in the test tree structure. May represent a TestSuite, TestCase, or\ntest function."}, "YAHOO.widget.ProfilerViewer": {"name": "YAHOO.widget.ProfilerViewer", "configs": {"tableHeight": {"default": "\"15em\"", "type": "string", "description": "The height of the DataTable. The table will scroll\nvertically if the content overflows the specified\nheight."}, "swfUrl": {"default": "\"http:\/\/yui.yahooapis.com\/2.5.0\/build\/charts\/assets\/charts.swf\"", "description": "The path to the YUI Charts swf file; must be a full URI\nor a path relative to the page being profiled. Changes at runtime\nnot supported; pass this value in at instantiation."}, "sortedBy": {"default": "{key:\"total\", dir:\"yui-dt-desc\"}", "type": "obj", "description": "The default column key to sort by. Valid keys are: fn, calls,\navg, min, max, total. Valid dir values are: \nYAHOO.widget.DataTable.CLASS_ASC AND\nYAHOO.widget.DataTable.CLASS_DESC."}, "filter": {"default": "null", "type": "function", "description": "A filter function to use in selecting functions that will\nappear in the ProfilerViewer report. The function is passed\na function report object and should return a boolean indicating\nwhether that function should be included in the ProfilerViewer\ndisplay. The argument is structured as follows:\n{\nfn: <str function name>,\ncalls : <n number of calls>,\navg : <n average call duration>,\nmax: <n duration of longest call>,\nmin: <n duration of shortest call>,\ntotal: <n total time of all calls>\npoints : <array time in ms of each call>\n}\nFor example, you would use the follwing filter function to \nreturn only functions that have been called at least once:\nfunction(o) {\nreturn (o.calls > 0);\n}"}, "visible": {"default": "false", "type": "boolean", "description": "The default visibility setting for the viewer canvas. If true,\nthe viewer will load all necessary files and render itself\nimmediately upon instantiation; otherwise, the viewer will\nload only minimal resources until the user toggles visibility\nvia the UI."}, "base": {"default": "\"\"", "type": "string", "description": "The YUI Loader base path from which to pull YUI files needed\nin the rendering of the ProfilerViewer canvas. Passed directly\nto YUI Loader. Leave blank to draw files from\nyui.yahooapis.com."}, "maxChartFunctions": {"default": "6", "type": "int", "description": "The maximum number of functions to profile in the chart. The\ngreater the number of functions, the greater the height of the\nchart canvas.\nheight."}, "chartStyle": {"default": "See JS source for default definitions.", "type": "obj", "description": "The style object that defines the chart's visual presentation.\nConforms to the style attribute passed to the Charts Control\nconstructor. See Charts Control User's Guide for more information\non how to format this object."}, "showChart": {"default": "true", "type": "boolean", "description": "The default visibility setting for the chart."}, "chartSeriesDefinitions": {"default": "See JS source for full default definitions.", "type": "obj", "description": "The series definition information to use when charting\nspecific fields on the chart. displayName, xField,\nand style members are used to construct the series\ndefinition; the \"group\" member is the array of fields\nthat should be charted when the table is sorted by a\ngiven field."}}, "constructors": [{"params": [{"type": "HTMLElement | String | Object", "name": "el(optional)", "description": " The html \nelement into which the ProfileViewer should be rendered. \nAn element will be created if none provided."}, {"type": "Object", "name": "attr", "description": " (optional) A key map of the ProfilerViewer's \ninitial attributes. Ignored if first arg is an attributes object."}], "description": "A widget to view YUI Profiler output."}], "namespace": "YAHOO.widget", "module": "profilerviewer", "events": {"beforeChartSeriesDefinitionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeChartSeriesDefinitionsChange", "description": "Fires before the value for the configuration attribute 'chartSeriesDefinitions' changes. Return false to cancel the attribute change."}, "beforeVisibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeVisibleChange", "description": "Fires before the value for the configuration attribute 'visible' changes. Return false to cancel the attribute change."}, "swfUrlChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "swfUrlChange", "description": "Fires when the value for the configuration attribute 'swfUrl' changes."}, "beforeFilterChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeFilterChange", "description": "Fires before the value for the configuration attribute 'filter' changes. Return false to cancel the attribute change."}, "showChartChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "showChartChange", "description": "Fires when the value for the configuration attribute 'showChart' changes."}, "sortedByChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "sortedByChange", "description": "Fires when the value for the configuration attribute 'sortedBy' changes."}, "chartSeriesDefinitionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "chartSeriesDefinitionsChange", "description": "Fires when the value for the configuration attribute 'chartSeriesDefinitions' changes."}, "beforeShowChartChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeShowChartChange", "description": "Fires before the value for the configuration attribute 'showChart' changes. Return false to cancel the attribute change."}, "beforeTableHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTableHeightChange", "description": "Fires before the value for the configuration attribute 'tableHeight' changes. Return false to cancel the attribute change."}, "maxChartFunctionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "maxChartFunctionsChange", "description": "Fires when the value for the configuration attribute 'maxChartFunctions' changes."}, "tableHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "tableHeightChange", "description": "Fires when the value for the configuration attribute 'tableHeight' changes."}, "beforeSortedByChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSortedByChange", "description": "Fires before the value for the configuration attribute 'sortedBy' changes. Return false to cancel the attribute change."}, "visibleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "visibleChange", "description": "Fires when the value for the configuration attribute 'visible' changes."}, "beforeSwfUrlChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSwfUrlChange", "description": "Fires before the value for the configuration attribute 'swfUrl' changes. Return false to cancel the attribute change."}, "beforeBaseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeBaseChange", "description": "Fires before the value for the configuration attribute 'base' changes. Return false to cancel the attribute change."}, "baseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "baseChange", "description": "Fires when the value for the configuration attribute 'base' changes."}, "chartStyleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "chartStyleChange", "description": "Fires when the value for the configuration attribute 'chartStyle' changes."}, "beforeMaxChartFunctionsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMaxChartFunctionsChange", "description": "Fires before the value for the configuration attribute 'maxChartFunctions' changes. Return false to cancel the attribute change."}, "filterChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "filterChange", "description": "Fires when the value for the configuration attribute 'filter' changes."}, "beforeChartStyleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeChartStyleChange", "description": "Fires before the value for the configuration attribute 'chartStyle' changes. Return false to cancel the attribute change."}, "renderEvent": {"description": "Fired when the viewer canvas first renders. No arguments are passed\nwith this event."}, "refreshDataEvent": {"description": "Fired when a data refresh is requested. No arguments are passed\nwith this event."}}, "guessedname": "ProfilerViewer", "methods": {"getDataTable": {"public": "", "return": {"type": "", "description": "YAHOO.widget.DataTable"}, "description": "Returns the element containing the console's DataTable\ninstance.", "guessedname": "getDataTable", "guessedtype": "function"}, "show": {"guessedname": "_show", "return": {"type": "", "description": "void"}, "description": "Shows the viewer canvas.", "private": "", "guessedtype": "function"}, "refreshData": {"public": "", "return": {"type": "", "description": "void"}, "description": "Refreshes the data displayed in the ProfilerViewer. When called,\nthis will invoke a refresh of the DataTable and (if displayed)\nthe Chart.", "guessedname": "refreshData", "guessedtype": "function"}, "_initViewerDOM": {"private": "", "description": "Set up the DOM structure for the ProfilerViewer canvas,\nincluding the holder for the DataTable.", "guessedname": "_initViewerDOM", "guessedtype": "function"}, "_drawChartLegend": {"private": "", "description": "Set up the Chart's legend", "guessedname": "_drawChartLegend", "guessedtype": "function"}, "_dataTableRenderHandler": {"private": "", "description": "Proxy the render event in DataTable into the ProfilerViewer\nattribute.", "guessedname": "_dataTableRenderHandler", "guessedtype": "function"}, "initAttributes": {"guessedname": "initAttributes", "params": [{"type": "Object", "name": "attr", "description": " Hash of initial attributes"}], "description": "setAttributeConfigs TabView specific properties.", "private": "", "guessedtype": "function"}, "getHeadEl": {"public": "", "return": {"type": "", "description": "HTMLElement"}, "description": "Returns the element containing the console's header.", "guessedname": "getHeadEl", "guessedtype": "function"}, "getChartEl": {"public": "", "return": {"type": "", "description": "HTMLElement"}, "description": "Returns the element containing the console's chart.", "guessedname": "getChartEl", "guessedtype": "function"}, "_createButton": {"private": "", "description": "Create anchor elements for use as buttons. Args: label\nis text to appear on the face of the button, parentEl\nis the el to which the anchor will be attached, position\nis true for inserting as the first node and false for\ninserting as the last node of the parentEl.", "guessedname": "_createButton", "guessedtype": "function"}, "_refreshDataTable": {"private": "", "description": "Refresh DataTable, getting new data from Profiler.", "guessedname": "_refreshDataTable", "guessedtype": "function"}, "_sortedByChange": {"private": "", "description": "Proxy the sort event in DataTable into the ProfilerViewer\nattribute.", "guessedname": "_sortedByChange", "guessedtype": "function"}, "_initDataTable": {"private": "", "description": "Set up the DataTable.", "guessedname": "_initDataTable", "guessedtype": "function"}, "_toggleVisible": {"guessedname": "_toggleVisible", "return": {"type": "", "description": "void"}, "description": "Toggles visibility of the viewer canvas.", "private": "", "guessedtype": "function"}, "getBodyEl": {"public": "", "return": {"type": "", "description": "HTMLElement"}, "description": "Returns the element containing the console's body, including\nthe chart and the datatable..", "guessedname": "getBodyEl", "guessedtype": "function"}, "hide": {"guessedname": "_hide", "return": {"type": "", "description": "void"}, "description": "Hides the viewer canvas.", "private": "", "guessedtype": "function"}, "_initChart": {"private": "", "description": "Set up the Chart.", "guessedname": "_initChart", "guessedtype": "function"}, "_getChartData": {"private": "", "description": "Get data for the Chart from DataTable recordset", "guessedname": "_getChartData", "guessedtype": "function"}, "toString": {"guessedname": "toString", "return": {"type": "", "description": "String"}, "description": "Provides a readable name for the ProfilerViewer instance.", "private": "", "guessedtype": "function"}, "_sizeChartCanvas": {"private": "", "description": "Resize the chart's canvas if based on number of records\nreturned from the chart's datasource.", "guessedname": "_sizeChartCanvas", "guessedtype": "function"}, "getTableEl": {"public": "", "return": {"type": "", "description": "HTMLElement"}, "description": "Returns the element containing the console's dataTable.", "guessedname": "getTableEl", "guessedtype": "function"}, "_thClickHandler": {"private": "", "description": "Event handler for clicks on the DataTable's sortable column\nheads.", "guessedname": "_thClickHandler", "guessedtype": "function"}, "_initLauncherDOM": {"private": "", "description": "Set up the DOM structure for the ProfilerViewer launcher.", "guessedname": "_initLauncherDOM", "guessedtype": "function"}, "_arraySum": {"private": "", "description": "Utility function for array sums.", "guessedname": "_arraySum", "guessedtype": "function"}, "_createProfilerViewerElement": {"guessedname": "_createProfilerViewerElement", "return": {"type": "", "description": "HTMLElement"}, "description": "If no element is passed in, create it as the first element\nin the document.", "private": "", "guessedtype": "function"}, "_getSeriesDef": {"private": "", "description": "Build series definition based on current configuration attributes.", "guessedname": "_getSeriesDef", "guessedtype": "function"}, "_initChartDOM": {"private": "", "description": "Set up the DOM structure for the ProfilerViewer canvas.", "guessedname": "_initChartDOM", "guessedtype": "function"}, "_setBusyState": {"private": "", "description": "Set's console busy state.", "guessedname": "_setBusyState", "guessedtype": "function"}, "_refreshChart": {"private": "", "description": "Refresh chart, getting new data from table.", "guessedname": "_refreshChart", "guessedtype": "function"}, "_render": {"guessedname": "_render", "return": {"type": "", "description": "void"}, "description": "Render the viewer canvas", "private": "", "guessedtype": "function"}, "_getProfilerData": {"private": "", "description": "Retrieves data from Profiler, filtering and sorting as needed\nbased on current widget state. Adds calculated percentage\ncolumn and function name to data returned by Profiler.", "guessedname": "_getProfilerData", "guessedtype": "function"}, "getChart": {"public": "", "return": {"type": "", "description": "YAHOO.widget.BarChart"}, "description": "Returns the element containing the console's Chart instance.", "guessedname": "getChart", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "profilerviewer.js", "guessedtype": "function", "shortname": "ProfilerViewer", "properties": {"CLASS_CHART": {"description": "Classname for element containing the chart.", "default": "\"yui-pv-chart\"", "static": "", "guessedname": "CLASS_CHART", "guessedtype": "property", "type": "string", "public": ""}, "CLASS_BUSY": {"description": "Classname for busy indicator in the dashboard.", "default": "\"yui-pv-busy\"", "static": "", "guessedname": "CLASS_BUSY", "guessedtype": "property", "type": "string", "public": ""}, "timeAxisLabelFunction": {"description": "Function used to format numbers in milliseconds\nfor chart; must be publicly accessible, per Charts spec.", "private": "", "static": "", "guessedname": "timeAxisLabelFunction", "guessedtype": "function", "type": "function"}, "CLASS_CHART_LEGEND": {"description": "Classname for element containing the chart's legend.", "default": "\"yui-pv-chartlegend\"", "static": "", "guessedname": "CLASS_CHART_LEGEND", "guessedtype": "property", "type": "string", "public": ""}, "CLASS_REFRESH": {"description": "Classname for the \"refresh data\" button.", "default": "\"yui-pv-refresh\"", "static": "", "guessedname": "CLASS_REFRESH", "guessedtype": "property", "type": "string", "public": ""}, "CLASS_CHART_CONTAINER": {"description": "Classname for element containing the chart and chart\nlegend elements.", "default": "\"yui-pv-chartcontainer\"", "static": "", "guessedname": "CLASS_CHART_CONTAINER", "guessedtype": "property", "type": "string", "public": ""}, "percentAxisLabelFunction": {"description": "Function used to format percent numbers for chart; must\nbe publicly accessible, per Charts spec.", "private": "", "static": "", "guessedname": "percentAxisLabelFunction", "guessedtype": "function", "type": "function"}, "CLASS_DASHBOARD": {"description": "Classname for ProfilerViewer button dashboard.", "default": "\"yui-pv-dashboard\"", "static": "", "guessedname": "CLASS_DASHBOARD", "guessedtype": "property", "type": "string", "public": ""}, "STRINGS": {"description": "Strings used in the UI.", "default": "English language strings for UI.", "object": "", "static": "", "guessedname": "STRINGS", "guessedtype": "property", "public": ""}, "CLASS": {"description": "Classname for ProfilerViewer containing element.", "default": "\"yui-pv\"", "static": "", "guessedname": "CLASS", "guessedtype": "property", "type": "string", "public": ""}, "CLASS_TABLE": {"description": "Classname for element containing the datatable.", "default": "\"yui-pv-table\"", "static": "", "guessedname": "CLASS_TABLE", "guessedtype": "property", "type": "string", "public": ""}}, "description": "A widget to view YUI Profiler output."}, "YAHOO.util.DD": {"name": "YAHOO.util.DD", "constructors": [{"params": [{"type": "String", "name": "id", "description": " the id of the linked element"}, {"type": "String", "name": "sGroup", "description": " the group of related DragDrop items"}, {"type": "object", "name": "config", "description": " an object containing configurable attributes\nValid properties for DD: \nscroll"}], "description": "A DragDrop implementation where the linked element follows the \nmouse cursor during a drag."}], "namespace": "YAHOO.util", "module": "dragdrop", "events": {"startDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs after a mouse down and the drag threshold has been met. The drag threshold default is either 3 pixels of mouse movement or 1 full second of holding the mousedown."}, "mouseUpEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fired from inside DragDropMgr when the drag operation is finished."}, "dragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs every mousemove event while dragging."}, "dragOverEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires every mousemove event while over a drag and drop object."}, "dragOutEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when a dragged object is no longer over an object that had the onDragEnter fire."}, "b4EndDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the endDragEvent. Returning false will cancel."}, "b4StartDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the startDragEvent, returning false will cancel the startDrag Event."}, "b4DragOutEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragOutEvent"}, "endDragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires on the mouseup event after a drag has been initiated (startDrag fired)."}, "b4DragOverEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragOverEvent."}, "dragEnterEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Occurs when the dragged object first interacts with another targettable drag and drop object."}, "b4DragDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragDropEvent"}, "b4DragEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires before the dragEvent."}, "dragDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when the dragged objects is dropped on another."}, "mouseDownEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Provides access to the mousedown event. The mousedown does not always result in a drag operation."}, "invalidDropEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Fires when the dragged objects is dropped in a location that contains no drop targets."}, "b4MouseDownEvent": {"type": "YAHOO.util.CustomEvent See <a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for more information on listening for this event.", "description": "Provides access to the mousedown event, before the mouseDownEvent gets fired. Returning false will cancel the drag."}}, "guessedname": "DD", "methods": {"setDragElPos": {"params": [{"type": "int", "name": "iPageX", "description": " the X coordinate of the mousedown or drag event"}, {"type": "int", "name": "iPageY", "description": " the Y coordinate of the mousedown or drag event"}], "description": "Sets the drag element to the location of the mousedown or click event, \nmaintaining the cursor location relative to the location on the element \nthat was clicked. Override this if you want to place the element in a \nlocation other than where the cursor is.", "guessedname": "setDragElPos", "guessedtype": "function"}, "alignElWithMouse": {"params": [{"type": "HTMLElement", "name": "el", "description": " the element to move"}, {"type": "int", "name": "iPageX", "description": " the X coordinate of the mousedown or drag event"}, {"type": "int", "name": "iPageY", "description": " the Y coordinate of the mousedown or drag event"}], "description": "Sets the element to the location of the mousedown or click event, \nmaintaining the cursor location relative to the location on the element \nthat was clicked. Override this if you want to place the element in a \nlocation other than where the cursor is.", "guessedname": "alignElWithMouse", "guessedtype": "function"}, "autoOffset": {"params": [{"type": "int", "name": "iPageX", "description": " the X coordinate of the click"}, {"type": "int", "name": "iPageY", "description": " the Y coordinate of the click"}], "description": "Sets the pointer offset to the distance between the linked element's top \nleft corner and the location the element was clicked", "guessedname": "autoOffset", "guessedtype": "function"}, "autoScroll": {"guessedname": "autoScroll", "params": [{"type": "int", "name": "x", "description": " the drag element's x position"}, {"type": "int", "name": "y", "description": " the drag element's y position"}, {"type": "int", "name": "h", "description": " the height of the drag element"}, {"type": "int", "name": "w", "description": " the width of the drag element"}], "description": "Auto-scroll the window if the dragged object has been moved beyond the \nvisible window boundary.", "private": "", "guessedtype": "function"}, "setDelta": {"params": [{"type": "int", "name": "iDeltaX", "description": " the distance from the left"}, {"type": "int", "name": "iDeltaY", "description": " the distance from the top"}], "description": "Sets the pointer offset. You can call this directly to force the \noffset to be in a particular location (e.g., pass in 0,0 to set it \nto the center of the object, as done in YAHOO.widget.Slider)", "guessedname": "setDelta", "guessedtype": "function"}, "cachePosition": {"params": [{"type": "", "name": "iPageX", "description": " the current x position (optional, this just makes it so we\ndon't have to look it up again)"}, {"type": "", "name": "iPageY", "description": " the current y position (optional, this just makes it so we\ndon't have to look it up again)"}], "description": "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.", "guessedname": "cachePosition", "guessedtype": "function"}}, "extends": "YAHOO.util.DragDrop", "superclass": "YAHOO.util.DragDrop", "file": "DD.js", "guessedtype": "function", "shortname": "DD", "properties": {"scroll": {"type": "boolean", "description": "When set to true, the utility automatically tries to scroll the browser\nwindow when a drag and drop element is dragged near the viewport boundary.\nDefaults to true.", "guessedname": "scroll", "guessedtype": "property"}}, "description": "A DragDrop implementation where the linked element follows the \nmouse cursor during a drag."}, "YAHOO.widget.Paginator.ui.NextPageLink": {"properties": {"current": {"guessedname": "current", "type": "HTMLElement", "description": "Currently placed HTMLElement node", "private": "", "guessedtype": "property"}, "span": {"guessedname": "span", "type": "HTMLElement", "description": "Span node (inactive link)", "private": "", "guessedtype": "property"}, "link": {"guessedname": "link", "type": "HTMLElement", "description": "Link node", "private": "", "guessedtype": "property"}}, "name": "YAHOO.widget.Paginator.ui.NextPageLink", "for": "YAHOO.widget.Paginator", "innerClasses": ["YAHOO.widget.Paginator"], "constructors": [{"params": [{"type": "Pagintor", "name": "p", "description": " Paginator instance to attach to"}], "description": "ui Component to generate the link to jump to the next page."}], "namespace": "YAHOO.widget.Paginator.ui", "module": "paginator", "events": {"beforeNextPageLinkLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNextPageLinkLabelChange", "description": "Fires before the value for the configuration attribute 'nextPageLinkLabel' changes. Return false to cancel the attribute change."}, "beforeNextPageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNextPageLinkClassChange", "description": "Fires before the value for the configuration attribute 'nextPageLinkClass' changes. Return false to cancel the attribute change."}, "nextPageLinkClassChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "nextPageLinkClassChange", "description": "Fires when the value for the configuration attribute 'nextPageLinkClass' changes."}, "nextPageLinkLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "nextPageLinkLabelChange", "description": "Fires when the value for the configuration attribute 'nextPageLinkLabel' changes."}}, "guessedname": "NextPageLink", "methods": {"onClick": {"params": [{"type": "DOMEvent", "name": "e", "description": " The click event"}], "description": "Listener for the link's onclick event. Passes to setPage method.", "guessedname": "onClick", "guessedtype": "function"}, "destroy": {"private": "", "description": "Removes the link\/span node and clears event listeners", "guessedname": "destroy", "guessedtype": "function"}, "init": {"static": "", "params": [{"type": "Paginator", "name": "p", "description": " Paginator instance to decorate"}], "description": "Decorates Paginator instances with new attributes. Called during\nPaginator instantiation.", "guessedname": "init", "guessedtype": "function"}, "update": {"params": [{"type": "CustomEvent", "name": "e", "description": " The calling change event"}], "description": "Swap the link and span nodes if appropriate.", "guessedname": "update", "guessedtype": "function"}, "render": {"return": {"type": "HTMLElement", "description": ""}, "params": [{"type": "string", "name": "id_base", "description": " used to create unique ids for generated nodes"}], "description": "Generate the nodes and return the appropriate node given the current\npagination state.", "guessedname": "render", "guessedtype": "function"}}, "file": "NextPageLink.js", "guessedtype": "function", "shortname": "NextPageLink", "configs": {"nextPageLinkLabel": {"default": "'next >'", "description": "Used as innerHTML for the next page link\/span."}, "nextPageLinkClass": {"default": "'yui-pg-next'", "description": "CSS class assigned to the link\/span"}}, "description": "ui Component to generate the link to jump to the next page."}, "YAHOO.widget.CartesianChart": {"name": "YAHOO.widget.CartesianChart", "configs": {"yField": {"type": "String", "description": "The field in each item that corresponds to a value on the x axis."}, "xField": {"type": "String", "description": "The field in each item that corresponds to a value on the x axis."}, "xAxis": {"type": "Axis", "description": "A custom configuration for the horizontal x axis."}, "yAxis": {"type": "Axis", "description": "A custom configuration for the vertical y axis."}}, "constructors": [{"params": [{"type": "String", "name": "type", "description": " The char type. May be \"line\", \"column\", or \"bar\""}, {"type": "HTMLElement", "name": "containerId", "description": " Container element for the Flash Player instance."}, {"type": "YAHOO.util.DataSource", "name": "dataSource", "description": " DataSource instance."}, {"type": "object", "name": "attributes", "description": " (optional) Object literal of configuration values."}], "description": "CartesianChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "events": {"beforeYFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeYFieldChange", "description": "Fires before the value for the configuration attribute 'yField' changes. Return false to cancel the attribute change."}, "beforeXAxisChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeXAxisChange", "description": "Fires before the value for the configuration attribute 'xAxis' changes. Return false to cancel the attribute change."}, "xAxisChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "xAxisChange", "description": "Fires when the value for the configuration attribute 'xAxis' changes."}, "xFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "xFieldChange", "description": "Fires when the value for the configuration attribute 'xField' changes."}, "yFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "yFieldChange", "description": "Fires when the value for the configuration attribute 'yField' changes."}, "beforeYAxisChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeYAxisChange", "description": "Fires before the value for the configuration attribute 'yAxis' changes. Return false to cancel the attribute change."}, "yAxisChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "yAxisChange", "description": "Fires when the value for the configuration attribute 'yAxis' changes."}, "beforeXFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeXFieldChange", "description": "Fires before the value for the configuration attribute 'xField' changes. Return false to cancel the attribute change."}}, "guessedname": "CartesianChart", "methods": {"_setYAxis": {"private": "", "description": "Getter for the yAxis attribute.", "guessedname": "_setYAxis", "guessedtype": "function"}, "_getYField": {"private": "", "description": "Getter for the yField attribute.", "guessedname": "_getYField", "guessedtype": "function"}, "_initAttributes": {"private": "", "description": "Initializes the attributes.", "guessedname": "_initAttributes", "guessedtype": "function"}, "_setXAxis": {"private": "", "description": "Setter for the xAxis attribute.", "guessedname": "_setXAxis", "guessedtype": "function"}, "_getXField": {"private": "", "description": "Getter for the xField attribute.", "guessedname": "_getXField", "guessedtype": "function"}, "_setXField": {"private": "", "description": "Setter for the xField attribute.", "guessedname": "_setXField", "guessedtype": "function"}, "_setYField": {"private": "", "description": "Setter for the yField attribute.", "guessedname": "_setYField", "guessedtype": "function"}}, "uses": ["YAHOO.widget.Chart"], "file": "CartesianChart.js", "guessedtype": "function", "shortname": "CartesianChart", "properties": {"_yAxisLabelFunction": {"guessedname": "_yAxisLabelFunction", "type": "String", "description": "Stores a reference to the yAxis labelFunction created by\nYAHOO.widget.FlashAdapter.createProxyFunction()", "private": "", "guessedtype": "property"}, "_xAxisLabelFunction": {"guessedname": "_xAxisLabelFunction", "type": "String", "description": "Stores a reference to the xAxis labelFunction created by\nYAHOO.widget.FlashAdapter.createProxyFunction()", "private": "", "guessedtype": "property"}}, "description": "CartesianChart class for the YUI Charts widget."}, "YAHOO.widget.Button": {"name": "YAHOO.widget.Button", "configs": {"menualignment": {"default": "[\"tl\", \"bl\"]", "type": "Array", "description": "Array defining how the Button's Menu is aligned to the Button. \nThe default value of [\"tl\", \"bl\"] aligns the Menu's top left corner to the Button's \nbottom left corner."}, "srcelement": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>|String", "description": "Object reference to the HTML element (either \n<code><input><\/code> or <code><span><\/code>) \nused to create the button."}, "checked": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the button is checked. \nApplies only to buttons of type \"radio\" and \"checkbox.\""}, "name": {"default": "null", "type": "String", "description": "String specifying the name for the button."}, "title": {"default": "null", "type": "String", "description": "String specifying the title for the button."}, "menu": {"default": "null", "type": "<a href=\"YAHOO.widget.Menu.html\">YAHOO.widget.Menu<\/a>|<a \nhref=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a>|<a \nhref=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-58190037\">HTMLElement<\/a>|String|Array", "description": "Object specifying the menu for the button. \nThe value can be one of the following:\n<ul>\n<li>Object specifying a <a href=\"YAHOO.widget.Menu.html\">\nYAHOO.widget.Menu<\/a> instance.<\/li>\n<li>Object specifying a <a href=\"YAHOO.widget.Overlay.html\">\nYAHOO.widget.Overlay<\/a> instance.<\/li>\n<li>String specifying the id attribute of the <code><div>\n<\/code> element used to create the menu. By default the menu \nwill be created as an instance of \n<a href=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a>. \nIf the <a href=\"YAHOO.widget.Menu.html#CSS_CLASS_NAME\">\ndefault CSS class name for YAHOO.widget.Menu<\/a> is applied to \nthe <code><div><\/code> element, it will be created as an\ninstance of <a href=\"YAHOO.widget.Menu.html\">YAHOO.widget.Menu\n<\/a>.<\/li><li>String specifying the id attribute of the \n<code><select><\/code> element used to create the menu.\n<\/li><li>Object specifying the <code><div><\/code> element\nused to create the menu.<\/li>\n<li>Object specifying the <code><select><\/code> element\nused to create the menu.<\/li>\n<li>Array of object literals, each representing a set of \n<a href=\"YAHOO.widget.MenuItem.html\">YAHOO.widget.MenuItem<\/a> \nconfiguration attributes.<\/li>\n<li>Array of strings representing the text labels for each menu \nitem in the menu.<\/li>\n<\/ul>"}, "menuminscrollheight": {"default": "90", "type": "Number", "description": "Number defining the minimum threshold for the \"menumaxheight\" \nconfiguration attribute. When set this attribute is automatically applied \nto all submenus."}, "focusmenu": {"default": "true", "type": "Boolean", "description": "Boolean indicating whether or not the button's menu \nshould be focused when it is made visible."}, "value": {"default": "null", "type": "Object", "description": "Object specifying the value for the button."}, "label": {"default": "null", "type": "String", "description": "String specifying the button's text label \nor innerHTML."}, "disabled": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the button should be disabled. \n(Disabled buttons are dimmed and will not respond to user input \nor fire events. Does not apply to button's of type \"link.\")"}, "href": {"type": "String", "description": "String specifying the href for the button. Applies\nonly to buttons of type \"link.\""}, "selectedMenuItem": {"default": "null", "type": "Number", "description": "Object representing the item in the button's menu \nthat is currently selected."}, "onclick": {"default": "null", "type": "Object", "description": "Object literal representing the code to be executed \nwhen the button is clicked. Format:<br> <code> {<br> \n<strong>fn:<\/strong> Function, // The handler to call \nwhen the event fires.<br> <strong>obj:<\/strong> Object, \n// An object to pass back to the handler.<br> \n<strong>scope:<\/strong> Object // The object to use \nfor the scope of the handler.<br> } <\/code>"}, "target": {"type": "String", "description": "String specifying the target for the button. \nApplies only to buttons of type \"link.\""}, "container": {"default": "null", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>|String", "description": "HTML element reference or string specifying the id \nattribute of the HTML element that the button's markup should be \nrendered into."}, "lazyloadmenu": {"default": "true", "type": "Boolean", "description": "Boolean indicating the value to set for the \n<a href=\"YAHOO.widget.Menu.html#lazyLoad\">\"lazyload\"<\/a>\nconfiguration property of the button's menu. Setting \n\"lazyloadmenu\" to <code>true <\/code> will defer rendering of \nthe button's menu until the first time it is made visible. \nIf \"lazyloadmenu\" is set to <code>false<\/code>, the button's \nmenu will be rendered immediately if the button is in the \ndocument, or in response to the button's \"appendTo\" event if \nthe button is not yet in the document. In either case, the \nmenu is rendered into the button's parent HTML element. \n<em>This attribute does not apply if a \n<a href=\"YAHOO.widget.Menu.html\">YAHOO.widget.Menu<\/a> or \n<a href=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a> \ninstance is passed as the value of the button's \"menu\" \nconfiguration attribute. <a href=\"YAHOO.widget.Menu.html\">\nYAHOO.widget.Menu<\/a> or <a href=\"YAHOO.widget.Overlay.html\">\nYAHOO.widget.Overlay<\/a> instances should be rendered before \nbeing set as the value for the \"menu\" configuration \nattribute.<\/em>"}, "menuclassname": {"default": "\"yui-button-menu\"", "type": "String", "description": "String representing the CSS class name to be \napplied to the root element of the button's menu."}, "type": {"default": "\"push\"", "type": "String", "description": "String specifying the button's type. Possible \nvalues are: \"push,\" \"link,\" \"submit,\" \"reset,\" \"checkbox,\" \n\"radio,\" \"menu,\" and \"split.\""}, "menumaxheight": {"default": "0", "type": "Number", "description": "Number defining the maximum height (in pixels) for a menu's \nbody element (<code><div class=\"bd\"<<\/code>). Once a menu's body \nexceeds this height, the contents of the body are scrolled to maintain \nthis value. This value cannot be set lower than the value of the \n\"minscrollheight\" configuration property."}, "tabindex": {"default": "null", "type": "Number", "description": "Number specifying the tabindex for the button."}}, "constructors": [{"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><input><\/code>, <code><button><\/code>,\n<code><a><\/code>, or <code><span><\/code> element to \nbe used to create the button."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-6043025\">HTMLInputElement<\/a>|<a href=\"http:\/\/www.w3.org\n\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-34812697\">\nHTMLButtonElement<\/a>|<a href=\"\nhttp:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#\nID-33759296\">HTMLElement<\/a>", "name": "p_oElement", "description": " Object reference for the \n<code><input><\/code>, <code><button><\/code>, \n<code><a><\/code>, or <code><span><\/code> element to be \nused to create the button."}, {"type": "Object", "name": "p_oElement", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button."}, {"type": "Object", "name": "p_oAttributes", "description": " Optional. Object literal specifying a set \nof configuration attributes used to create the button."}], "description": "The Button class creates a rich, graphical button."}], "namespace": "YAHOO.widget", "module": "button", "events": {"beforeTitleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTitleChange", "description": "Fires before the value for the configuration attribute 'title' changes. Return false to cancel the attribute change."}, "focus": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the menu item receives focus. Passes back a \nsingle object representing the original DOM event object passed back by \nthe event utility (YAHOO.util.Event) when the event was fired. See \n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> \nfor more information on listening for this event."}, "beforeMenuclassnameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenuclassnameChange", "description": "Fires before the value for the configuration attribute 'menuclassname' changes. Return false to cancel the attribute change."}, "beforeDisabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeDisabledChange", "description": "Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change."}, "beforeNameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeNameChange", "description": "Fires before the value for the configuration attribute 'name' changes. Return false to cancel the attribute change."}, "beforeMenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenuChange", "description": "Fires before the value for the configuration attribute 'menu' changes. Return false to cancel the attribute change."}, "menuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menuChange", "description": "Fires when the value for the configuration attribute 'menu' changes."}, "beforeHrefChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeHrefChange", "description": "Fires before the value for the configuration attribute 'href' changes. Return false to cancel the attribute change."}, "option": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the user invokes the button's option. Passes \nback a single object representing the original DOM event (either \n\"mousedown\" or \"keydown\") that caused the \"option\" event to fire. See \n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> \nfor more information on listening for this event."}, "onclickChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "onclickChange", "description": "Fires when the value for the configuration attribute 'onclick' changes."}, "menumaxheightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menumaxheightChange", "description": "Fires when the value for the configuration attribute 'menumaxheight' changes."}, "hrefChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "hrefChange", "description": "Fires when the value for the configuration attribute 'href' changes."}, "menuminscrollheightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menuminscrollheightChange", "description": "Fires when the value for the configuration attribute 'menuminscrollheight' changes."}, "containerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "containerChange", "description": "Fires when the value for the configuration attribute 'container' changes."}, "blur": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the menu item loses the input focus. Passes back \na single object representing the original DOM event object passed back by \nthe event utility (YAHOO.util.Event) when the event was fired. See \n<a href=\"YAHOO.util.Element.html#addListener\">Element.addListener<\/a> for \nmore information on listening for this event."}, "beforeMenuminscrollheightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenuminscrollheightChange", "description": "Fires before the value for the configuration attribute 'menuminscrollheight' changes. Return false to cancel the attribute change."}, "typeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "typeChange", "description": "Fires when the value for the configuration attribute 'type' changes."}, "beforeLabelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLabelChange", "description": "Fires before the value for the configuration attribute 'label' changes. Return false to cancel the attribute change."}, "beforeTypeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTypeChange", "description": "Fires before the value for the configuration attribute 'type' changes. Return false to cancel the attribute change."}, "targetChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "targetChange", "description": "Fires when the value for the configuration attribute 'target' changes."}, "tabindexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "tabindexChange", "description": "Fires when the value for the configuration attribute 'tabindex' changes."}, "beforeSelectedMenuItemChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSelectedMenuItemChange", "description": "Fires before the value for the configuration attribute 'selectedMenuItem' changes. Return false to cancel the attribute change."}, "beforeOnclickChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeOnclickChange", "description": "Fires before the value for the configuration attribute 'onclick' changes. Return false to cancel the attribute change."}, "beforeMenualignmentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenualignmentChange", "description": "Fires before the value for the configuration attribute 'menualignment' changes. Return false to cancel the attribute change."}, "valueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "valueChange", "description": "Fires when the value for the configuration attribute 'value' changes."}, "beforeContainerChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeContainerChange", "description": "Fires before the value for the configuration attribute 'container' changes. Return false to cancel the attribute change."}, "labelChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "labelChange", "description": "Fires when the value for the configuration attribute 'label' changes."}, "focusmenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "focusmenuChange", "description": "Fires when the value for the configuration attribute 'focusmenu' changes."}, "nameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "nameChange", "description": "Fires when the value for the configuration attribute 'name' changes."}, "beforeTargetChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTargetChange", "description": "Fires before the value for the configuration attribute 'target' changes. Return false to cancel the attribute change."}, "disabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "disabledChange", "description": "Fires when the value for the configuration attribute 'disabled' changes."}, "lazyloadmenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "lazyloadmenuChange", "description": "Fires when the value for the configuration attribute 'lazyloadmenu' changes."}, "beforeValueChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeValueChange", "description": "Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change."}, "beforeTabindexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTabindexChange", "description": "Fires before the value for the configuration attribute 'tabindex' changes. Return false to cancel the attribute change."}, "beforeSrcelementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeSrcelementChange", "description": "Fires before the value for the configuration attribute 'srcelement' changes. Return false to cancel the attribute change."}, "menuclassnameChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menuclassnameChange", "description": "Fires when the value for the configuration attribute 'menuclassname' changes."}, "beforeMenumaxheightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeMenumaxheightChange", "description": "Fires before the value for the configuration attribute 'menumaxheight' changes. Return false to cancel the attribute change."}, "beforeFocusmenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeFocusmenuChange", "description": "Fires before the value for the configuration attribute 'focusmenu' changes. Return false to cancel the attribute change."}, "srcelementChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "srcelementChange", "description": "Fires when the value for the configuration attribute 'srcelement' changes."}, "selectedMenuItemChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "selectedMenuItemChange", "description": "Fires when the value for the configuration attribute 'selectedMenuItem' changes."}, "beforeLazyloadmenuChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeLazyloadmenuChange", "description": "Fires before the value for the configuration attribute 'lazyloadmenu' changes. Return false to cancel the attribute change."}, "menualignmentChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "menualignmentChange", "description": "Fires when the value for the configuration attribute 'menualignment' changes."}, "titleChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "titleChange", "description": "Fires when the value for the configuration attribute 'title' changes."}, "checkedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "checkedChange", "description": "Fires when the value for the configuration attribute 'checked' changes."}, "beforeCheckedChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeCheckedChange", "description": "Fires before the value for the configuration attribute 'checked' changes. Return false to cancel the attribute change."}}, "methods": {"_showMenu": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event) that triggered \nthe display of the menu."}], "description": "Shows the button's menu.", "guessedname": "_showMenu", "guessedtype": "function"}, "submitForm": {"protected": "", "return": {"type": "Boolean", "description": ""}, "description": "Submits the form to which the button belongs. Returns \ntrue if the form was submitted successfully, false if the submission \nwas cancelled.", "guessedname": "submitForm", "guessedtype": "function"}, "createInputElement": {"return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-6043025\">HTMLInputElement<\/a>", "description": ""}, "params": [{"type": "String", "name": "p_sType", "description": " String specifying the type of \n<code><input><\/code> element to create."}, {"type": "String", "name": "p_sName", "description": " String specifying the name of \n<code><input><\/code> element to create."}, {"type": "String", "name": "p_sValue", "description": " String specifying the value of \n<code><input><\/code> element to create."}, {"type": "String", "name": "p_bChecked", "description": " Boolean specifying if the \n<code><input><\/code> element is to be checked."}], "description": "Creates an <code><input><\/code> element of the \nspecified type.", "private": ""}, "createButtonElement": {"return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-58190037\">HTMLElement<\/a>", "description": ""}, "params": [{"type": "String", "name": "p_sType", "description": " String indicating the type of element \nto create."}], "description": "Creates the button's HTML elements.", "guessedname": "createButtonElement", "guessedtype": "function"}, "_isActivationKey": {"return": {"type": "Boolean", "description": ""}, "description": "Determines if the specified keycode is one that toggles \nthe button's \"active\" state.", "protected": "", "params": [{"type": "Number", "name": "p_nKeyCode", "description": " Number representing the keycode to \nbe evaluated."}], "guessedname": "_isActivationKey", "guessedtype": "function"}, "hasFocus": {"return": {"type": "Boolean", "description": ""}, "description": "Returns a boolean indicating whether or not the button \nhas focus.", "guessedname": "hasFocus", "guessedtype": "function"}, "getForm": {"return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-\n20000929\/level-one-html.html#ID-40002357\">HTMLFormElement<\/a>", "description": ""}, "description": "Returns a reference to the button's parent form.", "guessedname": "getForm", "guessedtype": "function"}, "_onFormReset": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event \nobject passed back by the event utility (YAHOO.util.Event)."}], "description": "\"reset\" event handler for the button's form.", "guessedname": "_onFormReset", "guessedtype": "function"}, "_addListenersToForm": {"protected": "", "description": "Adds event handlers to the button's form.", "guessedname": "_addListenersToForm", "guessedtype": "function"}, "_onMouseUp": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mouseup\" event handler for the button.", "guessedname": "_onMouseUp", "guessedtype": "function"}, "_onOption": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"option\" event handler for the button.", "guessedname": "_onOption", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "p_oAttributes", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button."}], "description": "Initializes all of the configuration attributes used to \ncreate the button.", "guessedname": "initAttributes", "guessedtype": "function"}, "_setTabIndex": {"protected": "", "params": [{"type": "Number", "name": "p_nTabIndex", "description": " Number indicating the value for the \nbutton's \"tabindex\" attribute."}], "description": "Sets the value of the button's \"tabindex\" attribute.", "guessedname": "_setTabIndex", "guessedtype": "function"}, "_onDocumentKeyUp": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"keyup\" event handler for the document.", "guessedname": "_onDocumentKeyUp", "guessedtype": "function"}, "_onClick": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"click\" event handler for the button.", "guessedname": "_onClick", "guessedtype": "function"}, "removeStateCSSClasses": {"description": "Removes state-specific CSS classes to the button's root \nDOM element.", "guessedname": "removeStateCSSClasses", "guessedtype": "function"}, "YAHOO.widget.Button.onFormKeyPress": {"params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object passed \nback by the event utility (YAHOO.util.Event)."}], "description": "\"keypress\" event handler for the button's form.", "guessedname": "onFormKeyPress", "guessedtype": "function"}, "YAHOO.widget.Button.addHiddenFieldsToForm": {"params": [{"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-40002357\">HTMLFormElement<\/a>", "name": "p_oForm", "description": " Object reference \nfor the form to search."}], "description": "Searches the specified form and adds hidden fields for \ninstances of YAHOO.widget.Button that are of type \"radio,\" \"checkbox,\" \n\"menu,\" and \"split.\"", "guessedname": "addHiddenFieldsToForm", "guessedtype": "function"}, "getHiddenFields": {"return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-6043025\">HTMLInputElement<\/a>|Array", "description": ""}, "description": "Returns an <code><input><\/code> element or \narray of form elements used to represent the button when its parent \nform is submitted.", "guessedname": "getHiddenFields", "guessedtype": "function"}, "YAHOO.widget.Button.getButton": {"return": {"type": "YAHOO.widget.Button", "description": ""}, "params": [{"type": "String", "name": "p_sId", "description": " String specifying the id of the root node of the \nHTML element representing the button to be retrieved."}], "description": "Returns a button with the specified id.", "guessedname": "getButton", "guessedtype": "function"}, "_setDisabled": {"protected": "", "params": [{"type": "Boolean", "name": "p_bDisabled", "description": " Boolean indicating the value for \nthe button's \"disabled\" attribute."}], "description": "Sets the value of the button's \"disabled\" attribute.", "guessedname": "_setDisabled", "guessedtype": "function"}, "getMenu": {"return": {"type": "<a href=\"YAHOO.widget.Overlay.html\">\nYAHOO.widget.Overlay<\/a>|<a \nhref=\"YAHOO.widget.Menu.html\">YAHOO.widget.Menu<\/a>", "description": ""}, "description": "Returns a reference to the button's menu.", "guessedname": "getMenu", "guessedtype": "function"}, "_setChecked": {"protected": "", "params": [{"type": "Boolean", "name": "p_bChecked", "description": " Boolean indicating the value for \nthe button's \"checked\" attribute."}], "description": "Sets the value of the button's \"target\" attribute.", "guessedname": "_setChecked", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "p_oElement", "description": " String specifying the id attribute of the \n<code><input><\/code>, <code><button><\/code>,\n<code><a><\/code>, or <code><span><\/code> element to \nbe used to create the button."}, {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-6043025\">HTMLInputElement<\/a>|<a href=\"http:\/\/\nwww.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html\n#ID-34812697\">HTMLButtonElement<\/a>|<a href=\"http:\/\/www.w3.org\/TR\n\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-33759296\">\nHTMLElement<\/a>", "name": "p_oElement", "description": " Object reference for the \n<code><input><\/code>, <code><button><\/code>, \n<code><a><\/code>, or <code><span><\/code> element to be \nused to create the button."}, {"type": "Object", "name": "p_oElement", "description": " Object literal specifying a set of \nconfiguration attributes used to create the button."}, {"type": "Object", "name": "p_oAttributes", "description": " Optional. Object literal specifying a \nset of configuration attributes used to create the button."}], "description": "The Button class's initialization method.", "guessedname": "init", "guessedtype": "function"}, "_onMenuItemAdded": {"guessedname": "_onMenuItemAdded", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event\nwas fired."}, {"type": "<a href=\"YAHOO.widget.MenuItem.html\">\nYAHOO.widget.MenuItem<\/a>", "name": "p_oItem", "description": " Object representing the menu \nitem that subscribed to the event."}], "description": "\"itemadded\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "_setTitle": {"protected": "", "params": [{"type": "String", "name": "p_nTabIndex", "description": " Number indicating the value for \nthe button's \"title\" attribute."}], "description": "Sets the value of the button's \"title\" attribute.", "guessedname": "_setTitle", "guessedtype": "function"}, "_setHref": {"protected": "", "params": [{"type": "String", "name": "p_sHref", "description": " String indicating the value for the button's \n\"href\" attribute."}], "description": "Sets the value of the button's \"href\" attribute.", "guessedname": "_setHref", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the button.", "guessedname": "toString", "guessedtype": "function"}, "isActive": {"return": {"type": "Boolean", "description": ""}, "description": "Returns a boolean indicating whether or not the button \nis active.", "guessedname": "isActive", "guessedtype": "function"}, "_onMouseDown": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mousedown\" event handler for the button.", "guessedname": "_onMouseDown", "guessedtype": "function"}, "destroy": {"description": "Removes the button's element from its parent element and \nremoves all event handlers.", "guessedname": "destroy", "guessedtype": "function"}, "_onMenuHide": {"guessedname": "_onMenuHide", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}], "description": "\"hide\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "_setMenu": {"protected": "", "params": [{"type": "Object", "name": "p_oMenu", "description": " Object indicating the value for the button's \n\"menu\" attribute."}], "description": "Sets the value of the button's \"menu\" attribute.", "guessedname": "_setMenu", "guessedtype": "function"}, "_onKeyUp": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"keyup\" event handler for the button.", "guessedname": "_onKeyUp", "guessedtype": "function"}, "_isSplitButtonOptionKey": {"return": {"type": "Boolean", "description": ""}, "description": "Determines if the specified keycode is one that toggles \nthe display of the split button's menu.", "protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "guessedname": "_isSplitButtonOptionKey", "guessedtype": "function"}, "_onAppendTo": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"appendTo\" event handler for the button.", "guessedname": "_onAppendTo", "guessedtype": "function"}, "_onDblClick": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"dblclick\" event handler for the button.", "guessedname": "_onDblClick", "guessedtype": "function"}, "_onFormSubmit": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event \nobject passed back by the event utility (YAHOO.util.Event)."}], "description": "\"submit\" event handler for the button's form.", "guessedname": "_onFormSubmit", "guessedtype": "function"}, "_onFocus": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"focus\" event handler for the button.", "guessedname": "_onFocus", "guessedtype": "function"}, "_setOnClick": {"protected": "", "params": [{"type": "Object", "name": "p_oObject", "description": " Object indicating the value for the button's \n\"onclick\" attribute."}], "description": "Sets the value of the button's \"onclick\" attribute.", "guessedname": "_setOnClick", "guessedtype": "function"}, "blur": {"description": "Causes the button to lose focus and fires the button's\n\"blur\" event.", "guessedname": "blur", "guessedtype": "function"}, "_onMenuShow": {"guessedname": "_onMenuShow", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}], "description": "\"show\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "setAttributesFromSrcElement": {"params": [{"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-\none-html.html#ID-6043025\">HTMLInputElement<\/a>|<a href=\"http:\/\/www.w3.org\/\nTR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html#ID-\n48250443\">HTMLAnchorElement<\/a>", "name": "p_oElement", "description": " Object reference to the HTML \nelement (either <code><input><\/code> or <code><span>\n<\/code>) used to create the button."}, {"type": "Object", "name": "p_oAttributes", "description": " Object reference for the collection of \nconfiguration attributes used to create the button."}], "description": "Gets the values for all the attributes of the source element \n(either <code><input><\/code> or <code><a><\/code>) that \nmap to Button configuration attributes and sets them into a collection \nthat is passed to the Button constructor.", "private": ""}, "focus": {"description": "Causes the button to receive the focus and fires the \nbutton's \"focus\" event.", "guessedname": "focus", "guessedtype": "function"}, "setFormElementProperties": {"description": "Gets the value of the attributes from the form element \nand sets them into the collection of configuration attributes used to \nconfigure the button.", "private": ""}, "_onMenuClick": {"guessedname": "_onMenuClick", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"click\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "_hideMenu": {"protected": "", "description": "Hides the button's menu.", "guessedname": "_hideMenu", "guessedtype": "function"}, "_setLabel": {"protected": "", "params": [{"type": "String", "name": "p_sLabel", "description": " String indicating the value for the button's \n\"label\" attribute."}], "description": "Sets the value of the button's \"label\" attribute.", "guessedname": "_setLabel", "guessedtype": "function"}, "_setType": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " String indicating the value for the button's \n\"type\" attribute."}], "description": "Sets the value of the button's \"type\" attribute.", "guessedname": "_setType", "guessedtype": "function"}, "_onMenuRender": {"guessedname": "_onMenuRender", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the \nevent thatwas fired."}], "description": "\"render\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "_onDocumentMouseDown": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mousedown\" event handler for the document.", "guessedname": "_onDocumentMouseDown", "guessedtype": "function"}, "_setSelectedMenuItem": {"protected": "", "params": [{"type": "Number", "name": "p_nIndex", "description": " Number representing the index of the item \nin the button's menu that is currently selected."}], "description": "Sets the value of the button's \n\"selectedMenuItem\" attribute.", "guessedname": "_setSelectedMenuItem", "guessedtype": "function"}, "_onMouseMove": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mousemove\" event handler for the button.", "guessedname": "_onMouseMove", "guessedtype": "function"}, "_onMenuKeyDown": {"guessedname": "_onMenuKeyDown", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"keydown\" event handler for the button's menu.", "private": "", "guessedtype": "function"}, "createHiddenFields": {"return": {"type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-6043025\">HTMLInputElement<\/a>|Array", "description": ""}, "description": "Creates the button's hidden form field and appends it \nto its parent form.", "guessedname": "createHiddenFields", "guessedtype": "function"}, "addStateCSSClasses": {"description": "Appends state-specific CSS classes to the button's root \nDOM element.", "guessedname": "addStateCSSClasses", "guessedtype": "function"}, "_onMenuItemSelected": {"guessedname": "_onMenuItemSelected", "params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}, {"type": "MenuItem", "name": "p_oItem", "description": " Object representing the menu item that\nsubscribed to the event."}], "description": "\"selectedchange\" event handler for each item in the \nbutton's menu.", "private": "", "guessedtype": "function"}, "_onMouseOver": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mouseover\" event handler for the button.", "guessedname": "_onMouseOver", "guessedtype": "function"}, "_onMouseOut": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mouseout\" event handler for the button.", "guessedname": "_onMouseOut", "guessedtype": "function"}, "initConfig": {"params": [{"type": "Object", "name": "Object", "description": " representing the button's set of \nconfiguration attributes."}], "description": "Initializes the set of configuration attributes that are \nused to instantiate the button.", "private": ""}, "_setTarget": {"protected": "", "params": [{"type": "String", "name": "p_sTarget", "description": " String indicating the value for the button's \n\"target\" attribute."}], "description": "Sets the value of the button's \"target\" attribute.", "guessedname": "_setTarget", "guessedtype": "function"}, "removeHiddenFields": {"description": "Removes the button's hidden form field(s) from its \nparent form.", "guessedname": "removeHiddenFields", "guessedtype": "function"}, "_onDocumentMouseUp": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"mouseup\" event handler for the button.", "guessedname": "_onDocumentMouseUp", "guessedtype": "function"}, "setAttributeFromDOMAttribute": {"params": [{"type": "String", "name": "p_sAttribute", "description": " String representing the name of the \nattribute to retrieve from the DOM element."}], "description": "Gets the value of the specified DOM attribute and sets it \ninto the collection of configuration attributes used to configure \nthe button.", "private": ""}, "_onKeyDown": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"keydown\" event handler for the button.", "guessedname": "_onKeyDown", "guessedtype": "function"}, "_onBlur": {"protected": "", "params": [{"type": "Event", "name": "p_oEvent", "description": " Object representing the DOM event object \npassed back by the event utility (YAHOO.util.Event)."}], "description": "\"blur\" event handler for the button.", "guessedname": "_onBlur", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "button.js", "shortname": "Button", "properties": {"RADIO_DEFAULT_TITLE": {"description": "String representing the default title applied to buttons \nof type \"radio.\"", "default": "\"Unchecked. Click to check.\"", "guessedname": "RADIO_DEFAULT_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "RADIO_CHECKED_TITLE": {"description": "String representing the title applied to buttons of \ntype \"radio\" when checked.", "default": "\"Checked. Click another button to uncheck\"", "guessedname": "RADIO_CHECKED_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "CHECKBOX_CHECKED_TITLE": {"description": "String representing the title applied to buttons of type \n\"checkbox\" when checked.", "default": "\"Checked. Click to uncheck.\"", "guessedname": "CHECKBOX_CHECKED_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "_nOptionRegionX": {"description": "Number representing the X coordinate of the leftmost edge of the Button's \noption region. Applies only to Buttons of type \"split\".", "default": "0", "protected": "", "guessedname": "_nOptionRegionX", "guessedtype": "property", "type": "Number"}, "SPLITBUTTON_OPTION_VISIBLE_TITLE": {"description": "String representing the title applied to buttons of type \n\"split\" when the button's menu is visible.", "default": "\"Menu expanded. Press Esc or Ctrl + Shift + M to hide \nthe menu.\"", "guessedname": "SPLITBUTTON_OPTION_VISIBLE_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "SUBMIT_TITLE": {"description": "String representing the title applied to buttons of \ntype \"submit.\"", "default": "\"Click to submit form.\"", "guessedname": "SUBMIT_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "ACTIVATION_KEYS": {"description": "Array of numbers representing keys that (when presed) \ntoggle the button's \"active\" state.", "default": "[13, 32]", "guessedname": "ACTIVATION_KEYS", "guessedtype": "property", "type": "Array", "final": ""}, "SPLITBUTTON_DEFAULT_TITLE": {"description": "String representing the default title applied to \nbuttons of type \"split.\"", "default": "\"Menu collapsed. Click inside option region or press \nCtrl + Shift + M to show the menu.\"", "guessedname": "SPLITBUTTON_DEFAULT_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "CSS_CLASS_NAME": {"description": "String representing the CSS class(es) to be applied to \nthe button's root element.", "default": "\"yui-button\"", "guessedname": "CSS_CLASS_NAME", "guessedtype": "property", "type": "String", "final": ""}, "_hiddenFields": {"description": "Object reference to the <code><input><\/code> \nelement, or array of HTML form elements used to represent the button\nwhen its parent form is submitted.", "default": "null", "protected": "", "guessedname": "_hiddenFields", "guessedtype": "property", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-6043025\">HTMLInputElement<\/a>|Array"}, "CHECKBOX_DEFAULT_TITLE": {"description": "String representing the default title applied to \nbuttons of type \"checkbox.\"", "default": "\"Unchecked. Click to check.\"", "guessedname": "CHECKBOX_DEFAULT_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "_activationButtonPressed": {"description": "Boolean indicating if the mouse button that toggles \nthe button's \"active\" state has been pressed.", "default": "false", "protected": "", "guessedname": "_activationButtonPressed", "guessedtype": "property", "type": "Boolean"}, "_button": {"description": "Object reference to the button's internal \n<code><a><\/code> or <code><button><\/code> element.", "default": "null", "protected": "", "guessedname": "_button", "guessedtype": "property", "type": "<a href=\"http:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/\nlevel-one-html.html#ID-48250443\">HTMLAnchorElement<\/a>|<a href=\"\nhttp:\/\/www.w3.org\/TR\/2000\/WD-DOM-Level-1-20000929\/level-one-html.html\n#ID-34812697\">HTMLButtonElement<\/a>"}, "MENUBUTTON_MENU_VISIBLE_TITLE": {"description": "String representing the title applied to buttons of type \n\"menu\" when the button's menu is visible.", "default": "\"Menu expanded. Click or press Esc to collapse.\"", "guessedname": "MENUBUTTON_MENU_VISIBLE_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "_hasKeyEventHandlers": {"description": "Boolean indicating if the button's \"blur\", \"keydown\" and \n\"keyup\" event handlers are assigned", "default": "false", "protected": "", "guessedname": "_hasKeyEventHandlers", "guessedtype": "property", "type": "Boolean"}, "MENUBUTTON_DEFAULT_TITLE": {"description": "String representing the default title applied to \nbuttons of type \"menu.\"", "default": "\"Menu collapsed. Click to expand.\"", "guessedname": "MENUBUTTON_DEFAULT_TITLE", "guessedtype": "property", "type": "String", "final": ""}, "_menu": {"description": "Object reference to the button's menu.", "default": "null", "protected": "", "guessedname": "_menu", "guessedtype": "property", "type": "{<a href=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a>|\n<a href=\"YAHOO.widget.Menu.html\">YAHOO.widget.Menu<\/a>}"}, "_onclickAttributeValue": {"description": "Object reference to the button's current value for the \n\"onclick\" configuration attribute.", "default": "null", "protected": "", "guessedname": "_onclickAttributeValue", "guessedtype": "property", "type": "Object"}, "NODE_NAME": {"description": "The name of the node to be used for the button's \nroot element.", "default": "\"SPAN\"", "guessedname": "NODE_NAME", "guessedtype": "property", "type": "String", "final": ""}, "_activationKeyPressed": {"description": "Boolean indicating if the key(s) that toggle the button's \n\"active\" state have been pressed.", "default": "false", "protected": "", "guessedname": "_activationKeyPressed", "guessedtype": "property", "type": "Boolean"}, "_hasMouseEventHandlers": {"description": "Boolean indicating if the button's \"mouseout,\" \n\"mousedown,\" and \"mouseup\" event handlers are assigned", "default": "false", "protected": "", "guessedname": "_hasMouseEventHandlers", "guessedtype": "property", "type": "Boolean"}, "CHECK_ACTIVATION_KEYS": {"description": "Array of numbers representing keys that (when pressed) \ntoggle the button's \"checked\" attribute.", "default": "[32]", "guessedname": "CHECK_ACTIVATION_KEYS", "guessedtype": "property", "type": "Array", "final": ""}, "OPTION_AREA_WIDTH": {"description": "Width (in pixels) of the area of a split button that \nwhen pressed will display a menu.", "default": "20", "guessedname": "OPTION_AREA_WIDTH", "guessedtype": "property", "type": "Number", "final": ""}}, "description": "The Button class creates a rich, graphical button."}, "YAHOO.widget.AutoComplete": {"name": "YAHOO.widget.AutoComplete", "constructors": [{"params": [{"type": "HTMLElement", "name": "elInput", "description": " DOM element reference of an input field."}, {"type": "String", "name": "elInput", "description": " String ID of an input field."}, {"type": "HTMLElement", "name": "elContainer", "description": " DOM element reference of an existing DIV."}, {"type": "String", "name": "elContainer", "description": " String ID of an existing DIV."}, {"type": "YAHOO.widget.DataSource", "name": "oDataSource", "description": " DataSource instance."}, {"type": "Object", "name": "oConfigs", "description": " (optional) Object literal of configuration params."}], "description": "The AutoComplete class provides the customizable functionality of a plug-and-play DHTML\nauto completion widget. Some key features:\n<ul>\n<li>Navigate with up\/down arrow keys and\/or mouse to pick a selection<\/li>\n<li>The drop down container can \"roll down\" or \"fly out\" via configurable\nanimation<\/li>\n<li>UI look-and-feel customizable through CSS, including container\nattributes, borders, position, fonts, etc<\/li>\n<\/ul>"}], "namespace": "YAHOO.widget", "module": "autocomplete", "events": {"dataErrorEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sQuery", "description": " The query string."}], "description": "Fired when the AutoComplete instance does not receive query results from the\nDataSource due to an error.", "guessedname": "dataErrorEvent", "guessedtype": "property"}, "dataReturnEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sQuery", "description": " The query string."}, {"type": "Object[]", "name": "aResults", "description": " Results array."}], "description": "Fired when the AutoComplete instance receives query results from the data\nsource.", "guessedname": "dataReturnEvent", "guessedtype": "property"}, "containerExpandEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sQuery", "description": " The query string."}, {"type": "Object[]", "name": "aResults", "description": " Results array."}], "description": "Fired when the results container is expanded.", "guessedname": "containerExpandEvent", "guessedtype": "property"}, "itemArrowToEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "HTMLElement", "name": "elItem", "description": " The <li> element item arrowed to."}], "description": "Fired when result item has been arrowed to.", "guessedname": "itemArrowToEvent", "guessedtype": "property"}, "itemArrowFromEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "HTMLElement", "name": "elItem", "description": " The <li> element item arrowed from."}], "description": "Fired when result item has been arrowed away from.", "guessedname": "itemArrowFromEvent", "guessedtype": "property"}, "containerPopulateEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired when the results container is populated.", "guessedname": "containerPopulateEvent", "guessedtype": "property"}, "textboxFocusEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired when the input field receives focus.", "guessedname": "textboxFocusEvent", "guessedtype": "property"}, "typeAheadEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sQuery", "description": " The query string."}, {"type": "String", "name": "sPrefill", "description": " The prefill string."}], "description": "Fired when the input field has been prefilled by the type-ahead\nfeature.", "guessedname": "typeAheadEvent", "guessedtype": "property"}, "itemSelectEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "HTMLElement", "name": "elItem", "description": " The selected <li> element item."}, {"type": "Object", "name": "oData", "description": " The data returned for the item, either as an object,\nor mapped from the schema into an array."}], "description": "Fired when an item is selected via mouse click, ENTER key, or TAB key.", "guessedname": "itemSelectEvent", "guessedtype": "property"}, "dataRequestEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sQuery", "description": " The query string."}, {"type": "Object", "name": "oRequest", "description": " The request."}], "description": "Fired when the AutoComplete instance makes a request to the DataSource.", "guessedname": "dataRequestEvent", "guessedtype": "property"}, "itemMouseOverEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "HTMLElement", "name": "elItem", "description": " The <li> element item moused to."}], "description": "Fired when result item has been moused over.", "guessedname": "itemMouseOverEvent", "guessedtype": "property"}, "_sLastTextboxValue": {"guessedname": "_sLastTextboxValue", "type": "String", "description": "Internal tracker to last known textbox value, used to determine whether or not\nto trigger a query via interval for certain IME users.", "private": "", "guessedtype": "property"}, "unmatchedItemSelectEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "String", "name": "sSelection", "description": " The selected string."}], "description": "Fired when a user selection does not match any of the displayed result items.", "guessedname": "unmatchedItemSelectEvent", "guessedtype": "property"}, "selectionEnforceEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired if forceSelection is enabled and the user's input has been cleared\nbecause it did not match one of the returned query results.", "guessedname": "selectionEnforceEvent", "guessedtype": "property"}, "textboxKeyEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "Number", "name": "nKeycode", "description": " The keycode number."}], "description": "Fired when the input field receives key input.", "guessedname": "textboxKeyEvent", "guessedtype": "property"}, "textboxBlurEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired when the input field loses focus.", "guessedname": "textboxBlurEvent", "guessedtype": "property"}, "containerCollapseEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired when the results container is collapsed.", "guessedname": "containerCollapseEvent", "guessedtype": "property"}, "textboxChangeEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Fired when the input field value has changed when it loses focus.", "guessedname": "textboxChangeEvent", "guessedtype": "property"}, "itemMouseOutEvent": {"params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}, {"type": "HTMLElement", "name": "elItem", "description": " The <li> element item moused from."}], "description": "Fired when result item has been moused out.", "guessedname": "itemMouseOutEvent", "guessedtype": "property"}}, "guessedname": "AutoComplete", "methods": {"_onTextboxKeyPress": {"guessedname": "_onTextboxKeyPress", "params": [{"type": "HTMLEvent", "name": "v", "description": " The keypress event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles textbox keypress events.", "private": "", "guessedtype": "function"}, "_selectText": {"guessedname": "_selectText", "params": [{"type": "HTMLElement", "name": "elTextbox", "description": " Text input box element in which to select text."}, {"type": "Number", "name": "nStart", "description": " Starting index of text string to select."}, {"type": "Number", "name": "nEnd", "description": " Ending index of text selection."}], "description": "Selects text in the input field.", "private": "", "guessedtype": "function"}, "_toggleContainerHelpers": {"guessedname": "_toggleContainerHelpers", "params": [{"type": "Boolean", "name": "bShow", "description": " True if container is expanded, false if collapsed"}], "description": "Syncs results container with its helpers.", "private": "", "guessedtype": "function"}, "_clearInterval": {"guessedname": "_clearInterval", "params": [{"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Cancels text input detection by intervals.", "private": "", "guessedtype": "function"}, "_onTextboxBlur": {"guessedname": "_onTextboxBlur", "params": [{"type": "HTMLEvent", "name": "v", "description": " The focus event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles text input box losing focus.", "private": "", "guessedtype": "function"}, "_typeAhead": {"guessedname": "_typeAhead", "params": [{"type": "HTMLElement", "name": "elListItem", "description": " The <li> element item whose data populates the input field."}, {"type": "String", "name": "sQuery", "description": " Query string."}], "description": "Updates in the text input box with the first query result as the user types,\nselecting the substring that the user has not typed.", "private": "", "guessedtype": "function"}, "_onItemMouseover": {"params": [{"type": "HTMLEvent", "name": "v", "description": " The mouseover event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles <li> element mouseover events in the container.", "private": ""}, "_toggleHighlight": {"guessedname": "_toggleHighlight", "params": [{"type": "HTMLElement", "name": "elNewListItem", "description": " The <li> element item to receive highlight behavior."}, {"type": "String", "name": "sType", "description": " Type \"mouseover\" will toggle highlight on, and \"mouseout\" will toggle highlight off."}], "description": "Toggles the highlight on or off for an item in the container, and also cleans\nup highlighting of any previous item.", "private": "", "guessedtype": "function"}, "_togglePrehighlight": {"guessedname": "_togglePrehighlight", "params": [{"type": "HTMLElement", "name": "elNewListItem", "description": " The <li> element item to receive highlight behavior."}, {"type": "String", "name": "sType", "description": " Type \"mouseover\" will toggle highlight on, and \"mouseout\" will toggle highlight off."}], "description": "Toggles the pre-highlight on or off for an item in the container.", "private": "", "guessedtype": "function"}, "_onTextboxFocus": {"guessedname": "_onTextboxFocus", "params": [{"type": "HTMLEvent", "name": "v", "description": " The focus event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles text input box receiving focus.", "private": "", "guessedtype": "function"}, "_isIgnoreKey": {"return": {"type": "Boolean", "description": "True if key should be ignored, false otherwise."}, "description": "Whether or not key is functional or should be ignored. Note that the right\narrow key is NOT an ignored key since it triggers queries for certain intl\ncharsets.", "private": "", "params": [{"type": "Number", "name": "nKeycode", "description": " Code of key pressed."}], "guessedname": "_isIgnoreKey", "guessedtype": "function"}, "getListItemIndex": {"return": {"type": "Number", "description": "Index."}, "params": [{"type": "HTMLElement", "name": "elListItem", "description": " Reference to <LI> element."}], "description": "Public accessor to the index of the associated with a given <li> result.", "guessedname": "getListItemIndex", "guessedtype": "function"}, "_onContainerMouseover": {"guessedname": "_onContainerMouseover", "params": [{"type": "HTMLEvent", "name": "v", "description": " The mouseover event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles container mouseover events.", "private": "", "guessedtype": "function"}, "_initContainerHelperEls": {"private": "", "description": "Initializes the results container helpers if they are enabled and do\nnot exist", "guessedname": "_initContainerHelperEls", "guessedtype": "function"}, "_onInterval": {"private": "", "description": "Enables query triggers based on text input detection by intervals (rather\nthan by key events).", "guessedname": "_onInterval", "guessedtype": "function"}, "setBody": {"params": [{"type": "String", "name": "sBody", "description": " HTML markup for results container body."}], "description": "Sets HTML markup for the results container body. This markup will be\ninserted within a <div> tag with a class of \"yui-ac-bd\".", "guessedname": "setBody", "guessedtype": "function"}, "filterResults": {"return": {"type": "Object", "description": "Filtered response object."}, "params": [{"type": "String", "name": "sQuery", "description": " Original request."}, {"type": "Object", "name": "oFullResponse", "description": " Full response object."}, {"type": "Object", "name": "oParsedResponse", "description": " Parsed response object."}, {"type": "Object", "name": "oCallback", "description": " Callback object."}], "description": "Executed by DataSource (within DataSource scope via doBeforeCallback()) to\nfilter results through a simple client-side matching algorithm.", "guessedname": "filterResults", "guessedtype": "function"}, "getListEl": {"return": {"type": "HTMLElement[]", "description": "Reference to <ul> element within the results container."}, "description": "Public accessor to the <ul> element that displays query results within the results container.", "guessedname": "getListEl", "guessedtype": "function"}, "_updateValue": {"guessedname": "_updateValue", "params": [{"type": "HTMLElement", "name": "elListItem", "description": " The <li> element item with which to update the value."}], "description": "Updates the text input box value with selected query result. If a delimiter\nhas been defined, then the value gets appended with the delimiter.", "private": "", "guessedtype": "function"}, "_populateList": {"guessedname": "_populateList", "params": [{"type": "String", "name": "sQuery", "description": " Original request."}, {"type": "Object", "name": "oResponse", "description": " Response object."}, {"type": "MIXED", "name": "oPayload", "description": " (optional) Additional argument(s)"}], "description": "Populates the array of <li> elements in the container with query\nresults.", "private": "", "guessedtype": "function"}, "doBeforeExpandContainer": {"return": {"type": "Boolean", "description": "Return true to continue expanding container, false to cancel the expand."}, "params": [{"type": "HTMLElement", "name": "elTextbox", "description": " The text input box."}, {"type": "HTMLElement", "name": "elContainer", "description": " The container element."}, {"type": "String", "name": "sQuery", "description": " The query string."}, {"type": "Object[]", "name": "aResults", "description": " An array of query results."}], "description": "Overridable method called before container expands allows implementers to access data\nand DOM elements.", "guessedname": "doBeforeExpandContainer", "guessedtype": "function"}, "_moveSelection": {"guessedname": "_moveSelection", "params": [{"type": "Number", "name": "nKeyCode", "description": " Code of key pressed."}], "description": "Triggered by up and down arrow keys, changes the current highlighted\n<li> element item. Scrolls container if necessary.", "private": "", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "Unique name of the AutoComplete instance."}, "description": "Public accessor to the unique name of the AutoComplete instance.", "guessedname": "toString", "guessedtype": "function"}, "isContainerOpen": {"return": {"type": "Boolean", "description": "Returns true if container is in an expanded state, false otherwise."}, "description": "Returns true if container is in an expanded state, false otherwise.", "guessedname": "isContainerOpen", "guessedtype": "function"}, "destroy": {"description": "Nulls out the entire AutoComplete instance and related objects, removes attached\nevent listeners, and clears out DOM elements inside the container. After\ncalling this method, the instance reference should be expliclitly nulled by\nimplementer, as in myDataTable = null. Use with caution!", "guessedname": "destroy", "guessedtype": "function"}, "AutoComplete._cloneObject": {"description": "Clones object literal or array of object literals.", "private": "", "static": "", "guessedname": "_cloneObject", "guessedtype": "function", "params": [{"type": "Object", "name": "o", "description": " Object."}]}, "_onItemMouseout": {"params": [{"type": "HTMLEvent", "name": "v", "description": " The mouseout event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles <li> element mouseout events in the container.", "private": ""}, "getListItemData": {"return": {"type": "Object", "description": "Result data."}, "params": [{"type": "HTMLElement", "name": "elListItem", "description": " Reference to <LI> element."}], "description": "Public accessor to the result data associated with a given <li> result.", "guessedname": "getListItemData", "guessedtype": "function"}, "generateRequest": {"params": [{"type": "String", "name": "sQuery", "description": " Query string"}], "description": "A function that converts an AutoComplete query into a request value which is then\npassed to the DataSource's sendRequest method in order to retrieve data for \nthe query. By default, returns a String with the syntax: \"query={query}\"\nImplementers can customize this method for custom request syntaxes.", "guessedname": "generateRequest", "guessedtype": "function"}, "_initListEl": {"private": "", "description": "Clears out contents of container body and creates up to\nYAHOO.widget.AutoComplete#maxResultsDisplayed <li> elements in an\n<ul> element.", "guessedname": "_initListEl", "guessedtype": "function"}, "_onContainerClick": {"guessedname": "_onContainerClick", "params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles container click events.", "private": "", "guessedtype": "function"}, "setFooter": {"params": [{"type": "String", "name": "sFooter", "description": " HTML markup for results container footer."}], "description": "Sets HTML markup for the results container footer. This markup will be\ninserted within a <div> tag with a class of \"yui-ac-ft\".", "guessedname": "setFooter", "guessedtype": "function"}, "_selectItem": {"guessedname": "_selectItem", "params": [{"type": "HTMLElement", "name": "elListItem", "description": " The selected <li> element item."}], "description": "Selects a result item from the container", "private": "", "guessedtype": "function"}, "_onWindowUnload": {"guessedname": "_onWindowUnload", "params": [{"type": "HTMLEvent", "name": "v", "description": " The unload event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles window unload event.", "private": "", "guessedtype": "function"}, "handleResponse": {"params": [{"type": "String", "name": "sQuery", "description": " Original request."}, {"type": "Object", "name": "oResponse", "description": " Response object."}, {"type": "MIXED", "name": "oPayload", "description": " (optional) Additional argument(s)"}], "description": "Handles response for display. This is the callback function method passed to\nYAHOO.util.DataSourceBase#sendRequest so results from the DataSource are\nreturned to the AutoComplete instance.", "guessedname": "handleResponse", "guessedtype": "function"}, "_enableIntervalDetection": {"guessedname": "_enableIntervalDetection", "re": "", "description": "Enables interval detection for IME support.", "private": "", "guessedtype": "function"}, "sendQuery": {"params": [{"type": "String", "name": "sQuery", "description": " Query string."}], "description": "Makes query request to the DataSource.", "guessedname": "sendQuery", "guessedtype": "function"}, "getContainerEl": {"return": {"type": "HTMLELement", "description": "DOM reference to container element."}, "description": "Returns DOM reference to container element.", "guessedname": "getContainerEl", "guessedtype": "function"}, "_onContainerMouseout": {"guessedname": "_onContainerMouseout", "params": [{"type": "HTMLEvent", "name": "v", "description": " The mouseout event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles container mouseout events.", "private": "", "guessedtype": "function"}, "_jumpSelection": {"private": "", "description": "If an item is highlighted in the container, the right arrow key jumps to the\nend of the textbox and selects the highlighted item, otherwise the container\nis closed.", "guessedname": "_jumpSelection", "guessedtype": "function"}, "_onContainerScroll": {"guessedname": "_onContainerScroll", "params": [{"type": "HTMLEvent", "name": "v", "description": " The scroll event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles container scroll events.", "private": "", "guessedtype": "function"}, "_sendQuery": {"guessedname": "_sendQuery", "params": [{"type": "String", "name": "sQuery", "description": " Query string."}], "description": "Makes query request to the DataSource.", "private": "", "guessedtype": "function"}, "_clearSelection": {"private": "", "description": "When forceSelection is true and the user attempts\nleave the text input box without selecting an item from the query results,\nthe user selection is cleared.", "guessedname": "_clearSelection", "guessedtype": "function"}, "__initProps": {"private": "", "description": "Updates and validates latest public config properties.", "guessedname": "_initProps", "guessedtype": "function"}, "doBeforeLoadData": {"return": {"type": "Boolean", "description": "Return true to continue loading data, false to cancel."}, "params": [{"type": "String", "name": "sQuery", "description": " Original request."}, {"type": "Object", "name": "oResponse", "description": " Response object."}, {"type": "MIXED", "name": "oPayload", "description": " (optional) Additional argument(s)"}], "description": "Overridable method called before container is loaded with result data.", "guessedname": "doBeforeLoadData", "guessedtype": "function"}, "preparseRawResponse": {"return": {"type": "Object", "description": "oParsedResponse or null."}, "params": [{"type": "String", "name": "sQuery", "description": " Query string."}], "description": "Executed by DataSource (within DataSource scope via doBeforeParseData()) to\nhandle responseStripAfter cleanup.", "guessedname": "preparseRawResponse", "guessedtype": "function"}, "_toggleContainer": {"guessedname": "_toggleContainer", "params": [{"type": "Boolean", "name": "bShow", "description": " True if container should be expanded, false if container should be collapsed"}], "description": "Animates expansion or collapse of the container.", "private": "", "guessedtype": "function"}, "formatResult": {"return": {"type": "String", "description": "HTML markup of formatted result data."}, "params": [{"type": "Object", "name": "oResultData", "description": " Result data object."}, {"type": "String", "name": "sQuery", "description": " The corresponding query string."}, {"type": "HTMLElement", "name": "sResultMatch", "description": " The current query string."}], "description": "Overridable method that returns HTML markup for one result to be populated\nas innerHTML of an <LI> element.", "guessedname": "formatResult", "guessedtype": "function"}, "_textMatchesOption": {"guessedname": "_textMatchesOption", "return": {"type": "HTMLElement", "description": "Matching list item element if user-input text matches\na result, null otherwise."}, "description": "Whether or not user-typed value in the text input box matches any of the\nquery results.", "private": "", "guessedtype": "function"}, "collapseContainer": {"description": "Collapses container.", "guessedname": "collapseContainer", "guessedtype": "function"}, "_onTextboxKeyDown": {"guessedname": "_onTextboxKeyDown", "params": [{"type": "HTMLEvent", "name": "v", "description": " The keydown event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles textbox keydown events of functional keys, mainly for UI behavior.", "private": "", "guessedtype": "function"}, "getListItems": {"deprecated": "Use getListEl().childNodes.", "guessedname": "getListItems", "guessedtype": "function"}, "_onItemMouseclick": {"params": [{"type": "HTMLEvent", "name": "v", "description": " The click event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles <li> element click events in the container.", "private": ""}, "getSubsetMatches": {"return": {"type": "Object", "description": "oParsedResponse or null."}, "params": [{"type": "String", "name": "sQuery", "description": " Query string."}], "description": "Handles subset matching for when queryMatchSubset is enabled.", "guessedname": "getSubsetMatches", "guessedtype": "function"}, "doBeforeSendQuery": {"deprecated": "Use generateRequest.", "guessedname": "doBeforeSendQuery", "guessedtype": "function"}, "_onTextboxKeyUp": {"guessedname": "_onTextboxKeyUp", "params": [{"type": "HTMLEvent", "name": "v", "description": " The keyup event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles textbox keyup events to trigger queries.", "private": "", "guessedtype": "function"}, "isFocused": {"return": {"type": "Boolean", "description": "Returns true if widget instance is currently focused."}, "description": "Returns true if widget instance is currently focused.", "guessedname": "isFocused", "guessedtype": "function"}, "getListItemMatch": {"return": {"type": "String", "description": "Matching string."}, "params": [{"type": "HTMLElement", "name": "elListItem", "description": " Reference to <LI> element."}], "description": "Public accessor to the matching string associated with a given <li> result.", "guessedname": "getListItemMatch", "guessedtype": "function"}, "_initContainerEl": {"private": "", "description": "Initializes the results container once at object creation", "guessedname": "_initContainerEl", "guessedtype": "function"}, "getInputEl": {"return": {"type": "HTMLELement", "description": "DOM reference to input element."}, "description": "Returns DOM reference to input element.", "guessedname": "getInputEl", "guessedtype": "function"}, "setHeader": {"params": [{"type": "String", "name": "sHeader", "description": " HTML markup for results container header."}], "description": "Sets HTML markup for the results container header. This markup will be\ninserted within a <div> tag with a class of \"yui-ac-hd\".", "guessedname": "setHeader", "guessedtype": "function"}, "_onContainerResize": {"guessedname": "_onContainerResize", "params": [{"type": "HTMLEvent", "name": "v", "description": " The resize event."}, {"type": "YAHOO.widget.AutoComplete", "name": "oSelf", "description": " The AutoComplete instance."}], "description": "Handles container resize events.", "private": "", "guessedtype": "function"}}, "file": "AutoComplete.js", "guessedtype": "function", "shortname": "AutoComplete", "properties": {"queryQuestionMark": {"default": "true", "type": "Boolean", "description": "For XHR DataSources, AutoComplete will automatically insert a \"?\" between the server URI and \nthe \"query\" param\/value pair. To prevent this behavior, implementers should\nset this value to false. To more fully customize the query syntax, implementers\nshould override the generateRequest() method.", "guessedname": "queryQuestionMark", "guessedtype": "property"}, "forceSelection": {"default": "false", "type": "Boolean", "description": "Whether or not to force the user's selection to match one of the query\nresults. Enabling this feature essentially transforms the input field into a\n<select> field. This feature is not recommended with delimiter character(s)\ndefined.", "guessedname": "forceSelection", "guessedtype": "property"}, "_elIFrame": {"guessedname": "_elIFrame", "type": "HTMLElement", "description": "Reference to iframe element within container element.", "private": "", "guessedtype": "property"}, "animHoriz": {"default": "false", "type": "Boolean", "description": "Whether or not to animate the expansion\/collapse of the results container in the\nhorizontal direction.", "guessedname": "animHoriz", "guessedtype": "property"}, "useShadow": {"default": "false", "type": "Boolean", "description": "Whether or not the results container should have a shadow.", "guessedname": "useShadow", "guessedtype": "property"}, "queryMatchSubset": {"default": "false", "type": "Boolean", "description": "Enables query subset matching. When the DataSource's cache is enabled and queryMatchSubset is\ntrue, substrings of queries will return matching cached results. For\ninstance, if the first query is for \"abc\" susequent queries that start with\n\"abc\", like \"abcd\", will be queried against the cache, and not the live data\nsource. Recommended only for DataSources that return comprehensive results\nfor queries with very few characters.", "guessedname": "queryMatchSubset", "guessedtype": "property"}, "supressInputUpdate": {"default": "false", "type": "Boolean", "description": "Whether or not the input field should be updated with selections.", "guessedname": "suppressInputUpdate", "guessedtype": "property"}, "useIFrame": {"default": "false", "type": "Boolean", "description": "Whether or not to use an iFrame to layer over Windows form elements in\nIE. Set to true only when the results container will be on top of a\n<select> field in IE and thus exposed to the IE z-index bug (i.e.,\n5.5 < IE < 7).", "guessedname": "useIFrame", "guessedtype": "property"}, "typeAheadDelay": {"default": "0.5", "type": "Number", "description": "If typeAhead is true, number of seconds to delay before updating input with\ntypeAhead value. In order to prevent certain race conditions, this value must\nalways be greater than the queryDelay.", "guessedname": "typeAheadDelay", "guessedtype": "property"}, "_elContainer": {"guessedname": "_elContainer", "type": "HTMLElement", "description": "Container DOM element.", "private": "", "guessedtype": "property"}, "_nDelayID": {"guessedname": "_nDelayID", "type": "Number", "description": "Delay timeout ID.", "private": "", "guessedtype": "property"}, "_oAnim": {"guessedname": "_oAnim", "type": "Boolean", "description": "Animation instance for container expand\/collapse.", "private": "", "guessedtype": "property"}, "_elFooter": {"guessedname": "_elFooter", "type": "HTMLElement", "description": "Reference to footer element within content element.", "private": "", "guessedtype": "property"}, "_queryInterval": {"guessedname": "_queryInterval", "type": "Object", "description": "For users typing via certain IMEs, queries must be triggered by intervals,\nsince key events yet supported across all browsers for all IMEs.", "private": "", "guessedtype": "property"}, "_sName": {"guessedname": "_sName", "type": "String", "description": "Name of AutoComplete instance.", "private": "", "guessedtype": "property"}, "_elShadow": {"guessedname": "_elShadow", "type": "HTMLElement", "description": "Reference to shadow element within container element.", "private": "", "guessedtype": "property"}, "applyLocalFilter": {"default": "true for local arrays and json, otherwise false", "type": "Boolean", "description": "By default, results from local DataSources will pass through the filterResults\nmethod to apply a client-side matching algorithm.", "guessedname": "applyLocalFilter", "guessedtype": "property"}, "queryMatchCase": {"default": "false", "type": "Boolean", "description": "When applyLocalFilter is true, the local filtering algorthim can have case sensitivity\nenabled.", "guessedname": "queryMatchCase", "guessedtype": "property"}, "_nKeyCode": {"guessedname": "_nKeyCode", "type": "Number", "description": "Key code of the last key pressed in textbox.", "private": "", "guessedtype": "property"}, "_sInitInputValue": {"guessedname": "_sInitInputValue", "type": "String", "description": "Stores initial input value used to determine if textboxChangeEvent should be fired.", "private": "", "guessedtype": "property"}, "typeAhead": {"default": "false", "type": "Boolean", "description": "If autohighlight is enabled, whether or not the input field should be automatically updated\nwith the first query result as the user types, auto-selecting the substring portion\nof the first result that the user has not yet typed.", "guessedname": "typeAhead", "guessedtype": "property"}, "_nDisplayedItems": {"guessedname": "_nDisplayedItems", "type": "Number", "description": "Number of <li> elements currently displayed in results container.", "private": "", "guessedtype": "property"}, "_sCurQuery": {"guessedname": "_sCurQuery", "type": "String", "description": "Current query string", "private": "", "guessedtype": "property"}, "delimChar": {"type": "String | String[]", "description": "Query delimiter. A single character separator for multiple delimited\nselections. Multiple delimiter characteres may be defined as an array of\nstrings. A null value or empty string indicates that query results cannot\nbe delimited. This feature is not recommended if you need forceSelection to\nbe true.", "guessedname": "delimChar", "guessedtype": "property"}, "_elContent": {"guessedname": "_elContent", "type": "HTMLElement", "description": "Reference to content element within container element.", "private": "", "guessedtype": "property"}, "alwaysShowContainer": {"default": "false", "type": "Boolean", "description": "Enabling this feature prevents the toggling of the container to a collapsed state.\nSetting to true does not automatically trigger the opening of the container.\nImplementers are advised to pre-load the container with an explicit \"sendQuery()\" call.", "guessedname": "alwaysShowContainer", "guessedtype": "property"}, "highlightClassName": {"default": "\"yui-ac-highlight\"", "type": "String", "description": "Class name of a highlighted item within results container.", "guessedname": "highlightClassName", "guessedtype": "property"}, "queryInterval": {"default": "500", "type": "Number", "description": "When IME usage is detected, AutoComplete will switch to querying the input\nvalue at the given interval rather than per key event.", "guessedname": "queryInterval", "guessedtype": "property"}, "resultTypeList": {"default": "true", "type": "Boolean", "description": "For backward compatibility to pre-2.6.0 formatResults() signatures, setting\nresultsTypeList to true will take each object literal result returned by\nDataSource and flatten into an array.", "guessedname": "resultTypeList", "guessedtype": "property"}, "minQueryLength": {"default": "1", "type": "Number", "description": "Number of characters that must be entered before querying for results. A negative value\neffectively turns off the widget. A value of 0 allows queries of null or empty string\nvalues.", "guessedname": "minQueryLength", "guessedtype": "property"}, "_bOverContainer": {"guessedname": "_bOverContainer", "type": "Boolean", "description": "Whether or not the mouse is currently over the results\ncontainer. This is necessary in order to prevent clicks on container items\nfrom being text input field blur events.", "private": "", "guessedtype": "property"}, "_bFocused": {"guessedname": "_bFocused", "type": "Boolean", "description": "Whether or not the input field is currently in focus. If query results come back\nbut the user has already moved on, do not proceed with auto complete behavior.", "private": "", "guessedtype": "property"}, "_nTypeAheadDelayID": {"guessedname": "_nTypeAheadDelayID", "type": "Number", "description": "TypeAhead delay timeout ID.", "private": "", "guessedtype": "property"}, "queryMatchContains": {"default": "false", "type": "Boolean", "description": "When applyLocalFilter is true, results can be locally filtered to return\nmatching strings that \"contain\" the query string rather than simply \"start with\"\nthe query string.", "guessedname": "queryMatchContains", "guessedtype": "property"}, "_bItemSelected": {"guessedname": "_bItemSelected", "type": "Boolean", "description": "Whether or not an item has been selected since the container was populated\nwith results. Reset to false by _populateList, and set to true when item is\nselected.", "private": "", "guessedtype": "property"}, "dataSource": {"type": "YAHOO.widget.DataSource", "description": "The DataSource object that encapsulates the data used for auto completion.\nThis object should be an inherited object from YAHOO.widget.DataSource.", "guessedname": "dataSource", "guessedtype": "property"}, "autoHighlight": {"default": "true", "type": "Boolean", "description": "Whether or not the first item in results container should be automatically highlighted\non expand.", "guessedname": "autoHighlight", "guessedtype": "property"}, "allowBrowserAutocomplete": {"default": "true", "type": "Boolean", "description": "Whether or not to allow browsers to cache user-typed input in the input\nfield. Disabling this feature will prevent the widget from setting the\nautocomplete=\"off\" on the input field. When autocomplete=\"off\"\nand users click the back button after form submission, user-typed input can\nbe prefilled by the browser from its cache. This caching of user input may\nnot be desired for sensitive data, such as credit card numbers, in which\ncase, implementers should consider setting allowBrowserAutocomplete to false.", "guessedname": "allowBrowserAutocomplete", "guessedtype": "property"}, "animVert": {"default": "true", "type": "Boolean", "description": "Whether or not to animate the expansion\/collapse of the results container in the\nvertical direction.", "guessedname": "animVert", "guessedtype": "property"}, "_sPastSelections": {"description": "Selections from previous queries (for saving delimited queries).", "default": "\"\"", "private": "", "guessedname": "_sPastSelections", "guessedtype": "property", "type": "String"}, "_nIndex": {"description": "Internal class variable to index multiple AutoComplete instances.", "default": "0", "private": "", "guessedname": "_nIndex", "guessedtype": "property", "type": "Number"}, "_elCurListItem": {"guessedname": "_elCurListItem", "type": "HTMLElement", "description": "Pointer to the currently highlighted <li> element in the container.", "private": "", "guessedtype": "property"}, "_bContainerOpen": {"guessedname": "_bContainerOpen", "type": "Boolean", "description": "Whether or not the results container is currently open.", "private": "", "guessedtype": "property"}, "animSpeed": {"default": "0.3", "type": "Number", "description": "Speed of container expand\/collapse animation, in seconds..", "guessedname": "animSpeed", "guessedtype": "property"}, "_elHeader": {"guessedname": "_elHeader", "type": "HTMLElement", "description": "Reference to header element within content element.", "private": "", "guessedtype": "property"}, "_elList": {"guessedname": "_elList", "type": "HTMLElement", "description": "Internal reference to <ul> elements that contains query results within the\nresults container.", "private": "", "guessedtype": "property"}, "_iFrameSrc": {"guessedname": "_iFrameSrc", "type": "String", "description": "Src to iFrame used when useIFrame = true. Supports implementations over SSL\nas well.", "private": "", "guessedtype": "property"}, "maxResultsDisplayed": {"default": "10", "type": "Number", "description": "Maximum number of results to display in results container.", "guessedname": "maxResultsDisplayed", "guessedtype": "property"}, "prehighlightClassName": {"type": "String", "description": "Class name of a pre-highlighted item within results container.", "guessedname": "prehighlightClassName", "guessedtype": "property"}, "queryDelay": {"default": "0.2", "type": "Number", "description": "Number of seconds to delay before submitting a query request. If a query\nrequest is received before a previous one has completed its delay, the\nprevious request is cancelled and the new request is set to the delay. If \ntypeAhead is also enabled, this value must always be less than the typeAheadDelay\nin order to avoid certain race conditions.", "guessedname": "queryDelay", "guessedtype": "property"}, "_elTextbox": {"guessedname": "_elTextbox", "type": "HTMLElement", "description": "Text input field DOM element.", "private": "", "guessedtype": "property"}, "_elBody": {"guessedname": "_elBody", "type": "HTMLElement", "description": "Reference to body element within content element.", "private": "", "guessedtype": "property"}}, "description": "The AutoComplete class provides the customizable functionality of a plug-and-play DHTML\nauto completion widget. Some key features:\n<ul>\n<li>Navigate with up\/down arrow keys and\/or mouse to pick a selection<\/li>\n<li>The drop down container can \"roll down\" or \"fly out\" via configurable\nanimation<\/li>\n<li>UI look-and-feel customizable through CSS, including container\nattributes, borders, position, fonts, etc<\/li>\n<\/ul>"}, "YAHOO.tool.TestCase": {"name": "YAHOO.tool.TestCase", "constructors": [{"params": [{"type": "", "name": "template", "description": " An object containing any number of test methods, other methods,\nan optional name, and anything else the test case needs."}], "description": "Test case containing various tests to run."}], "namespace": "YAHOO.tool", "module": "yuitest", "guessedname": "TestCase", "methods": {"tearDown": {"return": {"type": "Void", "description": ""}, "description": "Function to run after each test is executed.", "guessedname": "tearDown", "guessedtype": "function"}, "setUp": {"return": {"type": "Void", "description": ""}, "description": "Function to run before each test is executed.", "guessedname": "setUp", "guessedtype": "function"}, "wait": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Function", "name": "segment", "description": " (Optional) The function to run after the delay.\nIf omitted, the TestRunner will wait until resume() is called."}, {"type": "int", "name": "delay", "description": " (Optional) The number of milliseconds to wait before running\nthe function. If omitted, defaults to zero."}], "description": "Causes the test case to wait a specified amount of time and then\ncontinue executing the given code.", "guessedname": "wait", "guessedtype": "function"}, "resume": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Function", "name": "segment", "description": " (Optional) The function to run.\nIf omitted, the test automatically passes."}], "description": "Resumes a paused test and runs the given function.", "guessedname": "resume", "guessedtype": "function"}}, "file": "TestCase.js", "guessedtype": "function", "shortname": "TestCase", "description": "Test case containing various tests to run."}, "YAHOO.widget.EditorInfo": {"name": "YAHOO.widget.EditorInfo", "namespace": "YAHOO.widget", "module": "editor", "guessedname": "EditorInfo", "methods": {"toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the EditorInfo.", "guessedname": "toString", "guessedtype": "function"}, "getEditorById": {"return": {"type": "", "description": "Object <a href=\"YAHOO.widget.Editor.html\">YAHOO.widget.Editor<\/a>"}, "params": [{"type": "String\/HTMLElement", "name": "id", "description": " The id or reference of the textarea to return the Editor instance of"}], "description": "Returns a reference to the Editor object associated with the given textarea", "guessedname": "getEditorById", "guessedtype": "function"}}, "static": "", "file": "simple-editor.js", "guessedtype": "property", "shortname": "EditorInfo", "properties": {"blankImage": {"guessedname": "blankImage", "type": "String", "description": "A reference to the blankImage url", "private": "", "guessedtype": "property"}, "_instances": {"guessedname": "_instances", "type": "Object", "description": "A reference to all editors on the page.", "private": "", "guessedtype": "property"}, "window": {"guessedname": "window", "type": "Object <a href=\"YAHOO.widget.EditorWindow.html\">YAHOO.widget.EditorWindow<\/a>", "description": "A reference to the currently open window object in any editor on the page.", "private": "", "guessedtype": "property"}, "Dom": {"private": "", "guessedname": "Dom", "guessedtype": "property"}, "panel": {"guessedname": "panel", "type": "Object <a href=\"YAHOO.widget.Overlay.html\">YAHOO.widget.Overlay<\/a>", "description": "A reference to the currently open panel in any editor on the page.", "private": "", "guessedtype": "property"}}, "description": "Singleton object used to track the open window objects and panels across the various open editors"}, "YAHOO.util.UnexpectedValue": {"name": "YAHOO.util.UnexpectedValue", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}, {"type": "Object", "name": "unexpected", "description": " The unexpected value."}], "description": "UnexpectedValue is subclass of AssertionError that is thrown whenever\na value was unexpected in its scope. This typically means that a test\nwas performed to determine that a value was *not* equal to a certain\nvalue."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "UnexpectedValue", "methods": {"getMessage": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. The message\ncontains information about the unexpected value that was encountered.", "guessedname": "getMessage", "guessedtype": "function"}}, "extends": "YAHOO.util.AssertionError", "superclass": "YAHOO.util.AssertionError", "file": "Assert.js", "guessedtype": "function", "shortname": "UnexpectedValue", "properties": {"unexpected": {"type": "Object", "description": "The unexpected value."}, "name": {"type": "String", "description": "The name of the error that occurred."}}, "description": "UnexpectedValue is subclass of AssertionError that is thrown whenever\na value was unexpected in its scope. This typically means that a test\nwas performed to determine that a value was *not* equal to a certain\nvalue."}, "YAHOO.widget.ToolbarButtonAdvanced": {"name": "YAHOO.widget.ToolbarButtonAdvanced", "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The element to turn into a button."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "<p>Creates a rich custom Toolbar Button. Primarily used with the Rich Text Editor's Toolbar<\/p>"}], "namespace": "YAHOO.widget", "module": "editor", "methods": {"checkValue": {"params": [{"type": "String", "name": "value", "description": " The value of the option that we want to mark as selected"}], "description": "Select an option by value", "guessedname": "checkValue", "guessedtype": "function"}}, "beta": "", "file": "toolbar-button.js", "shortname": "ToolbarButtonAdvanced", "requires": "yahoo, dom, element, event, container_core, menu, button", "properties": {"buttonType": {"private": "", "description": "Tells if the Button is a Rich Button or a Simple Button", "guessedname": "buttonType", "guessedtype": "property"}}, "description": "<p>Creates a rich custom Toolbar Button. Primarily used with the Rich Text Editor's Toolbar<\/p>"}, "YAHOO.util.AssertionError": {"name": "YAHOO.util.AssertionError", "constructors": [{"params": [{"type": "String", "name": "message", "description": " The message to display when the error occurs."}], "description": "AssertionError is thrown whenever an assertion fails. It provides methods\nto more easily get at error information and also provides a base class\nfrom which more specific assertion errors can be derived."}], "namespace": "YAHOO.util", "module": "yuitest", "guessedname": "AssertionError", "methods": {"valueOf": {"return": {"type": "String", "description": "A primitive value version of the error."}, "description": "Returns a primitive value version of the error. Same as toString().", "guessedname": "valueOf", "guessedtype": "function"}, "getMessage": {"return": {"type": "String", "description": "A string describing the error."}, "description": "Returns a fully formatted error for an assertion failure. This should\nbe overridden by all subclasses to provide specific information.", "guessedname": "getMessage", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "A string representation of the error."}, "description": "Returns a string representation of the error.", "guessedname": "toString", "guessedtype": "function"}}, "extends": "Error", "superclass": "Error", "file": "Assert.js", "guessedtype": "function", "shortname": "AssertionError", "properties": {"name": {"type": "String", "description": "The name of the error that occurred."}}, "description": "AssertionError is thrown whenever an assertion fails. It provides methods\nto more easily get at error information and also provides a base class\nfrom which more specific assertion errors can be derived."}, "YAHOO.tool.TestReporter": {"name": "YAHOO.tool.TestReporter", "constructors": [{"params": [{"type": "String", "name": "url", "description": " The URL to submit the results to."}, {"type": "Function", "name": "format", "description": " (Optiona) A function that outputs the results in a specific format.\nDefault is YAHOO.tool.TestFormat.XML."}], "description": "An object capable of sending test results to a server."}], "namespace": "YAHOO.tool", "module": "yuitest", "guessedname": "TestReporter", "methods": {"report": {"return": {"type": "Void", "description": ""}, "params": [{"type": "Object", "name": "results", "description": " The results object created by TestRunner."}], "description": "Sends the report to the server.", "guessedname": "report", "guessedtype": "function"}, "destroy": {"return": {"type": "Void", "description": ""}, "description": "Cleans up the memory associated with the TestReporter, removing DOM elements\nthat were created.", "guessedname": "destroy", "guessedtype": "function"}, "_convertToISOString": {"return": {"type": "String", "description": "An ISO-formatted date string"}, "description": "Convert a date into ISO format.\nFrom Douglas Crockford's json2.js", "private": "", "params": [{"type": "Date", "name": "date", "description": " The date to convert."}], "guessedname": "_convertToISOString", "guessedtype": "function"}, "addField": {"return": {"type": "Void", "description": ""}, "params": [{"type": "String", "name": "name", "description": " The name of the field."}, {"type": "Variant", "name": "value", "description": " The value of the field."}], "description": "Adds a field to the form that submits the results.", "guessedname": "addField", "guessedtype": "function"}}, "file": "TestReporter.js", "guessedtype": "function", "shortname": "TestReporter", "properties": {"url": {"type": "String", "description": "The URL to submit the data to."}, "_form": {"type": "HTMLFormElement", "description": "The form element used to submit the results.", "private": ""}, "_fields": {"type": "Object", "description": "Extra fields to submit with the request.", "private": ""}, "_iframe": {"type": "HTMLIFrameElement", "description": "Iframe used as a target for form submission.", "private": ""}, "format": {"type": "Function", "description": "The formatting function to call when submitting the data."}}, "description": "An object capable of sending test results to a server."}, "YAHOO.widget.MenuNode": {"name": "YAHOO.widget.MenuNode", "constructors": [{"params": [{"type": "object", "name": "oData", "description": " a string or object containing the data that will\r\nbe used to render this node.\r\nProviding a string is the same as providing an object with a single property named label.\r\nAll values in the oData will be used to set equally named properties in the node\r\nas long as the node does have such properties, they are not undefined, private or functions.\r\nAll attributes are made available in noderef.data, which\r\ncan be used to store custom attributes. TreeView.getNode(s)ByProperty\r\ncan be used to retrieve a node by one of the attributes."}, {"type": "YAHOO.widget.Node", "name": "oParent", "description": " this node's parent node"}, {"type": "boolean", "name": "expanded", "description": " the initial expanded\/collapsed state (deprecated; use oData.expanded)"}], "description": "A menu-specific implementation that differs from TextNode in that only \r\none sibling can be expanded at a time."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "MenuNode", "extends": "YAHOO.widget.TextNode", "superclass": "YAHOO.widget.TextNode", "file": "MenuNode.js", "guessedtype": "function", "shortname": "MenuNode", "properties": {"_type": {"default": "\"MenuNode\"", "guessedname": "_type", "description": "The node type", "private": "", "guessedtype": "property"}}, "description": "A menu-specific implementation that differs from TextNode in that only \r\none sibling can be expanded at a time."}, "YAHOO.widget.Record": {"name": "YAHOO.widget.Record", "constructors": [{"params": [{"type": "Object", "name": "oConfigs", "description": " (optional) Object literal of key\/value pairs."}], "description": "The Record class defines a DataTable record."}], "namespace": "YAHOO.widget", "module": "datatable", "guessedname": "Record", "methods": {"getCount": {"return": {"type": "", "description": "Number"}, "description": "Returns unique count assigned at instantiation.", "guessedname": "getCount", "guessedtype": "function"}, "getData": {"return": {"type": "", "description": "Object"}, "params": [{"type": "String", "name": "sField", "description": " (Optional) The field from which to retrieve data value."}], "description": "Returns data for the Record for a field if given, or the entire object\nliteral otherwise.", "guessedname": "getData", "guessedtype": "function"}, "getId": {"return": {"type": "", "description": "String"}, "description": "Returns unique ID assigned at instantiation.", "guessedname": "getId", "guessedtype": "function"}, "setData": {"params": [{"type": "String", "name": "sKey", "description": " The key of the new value."}, {"type": "MIXED", "name": "oData", "description": " The new value."}], "description": "Sets given data at the given key. Use the RecordSet method setValue to trigger\nevents.", "guessedname": "setData", "guessedtype": "function"}}, "file": "RecordSet.js", "guessedtype": "function", "shortname": "Record", "properties": {"_sId": {"guessedname": "_sId", "type": "String", "description": "Immutable unique ID assigned at instantiation. Remains constant while a\nRecord's position index can change from sorting.", "private": "", "guessedtype": "property"}, "_nCount": {"guessedname": "_nCount", "type": "Number", "description": "Immutable unique count assigned at instantiation. Remains constant while a\nRecord's position index can change from sorting.", "private": "", "guessedtype": "property"}, "_oData": {"guessedname": "_oData", "type": "Object", "description": "Holds data for the Record in an object literal.", "private": "", "guessedtype": "property"}, "Record._nCount": {"guessedname": "_nCount", "type": "Number", "description": "Internal class variable to give unique IDs to Record instances.", "private": "", "guessedtype": "property"}}, "description": "The Record class defines a DataTable record."}, "YAHOO.widget.TabView": {"name": "YAHOO.widget.TabView", "configs": {"tabs": {"type": "Array", "description": "The Tabs belonging to the TabView instance."}, "activeIndex": {"type": "Int", "description": "The index of the tab currently active."}, "activeTab": {"type": "YAHOO.widget.Tab", "description": "The tab currently active."}, "orientation": {"default": "\"top\"", "type": "String", "description": "How the Tabs should be oriented relative to the TabView."}}, "constructors": [{"params": [{"type": "HTMLElement | String | Object", "name": "el(optional)", "description": " The html \nelement that represents the TabView, or the attribute object to use. \nAn element will be created if none provided."}, {"type": "Object", "name": "attr", "description": " (optional) A key map of the tabView's \ninitial attributes. Ignored if first arg is attributes object."}], "description": "A widget to control tabbed views."}], "namespace": "YAHOO.widget", "module": "tabview", "events": {"tabsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "tabsChange", "description": "Fires when the value for the configuration attribute 'tabs' changes."}, "orientationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "orientationChange", "description": "Fires when the value for the configuration attribute 'orientation' changes."}, "beforeOrientationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeOrientationChange", "description": "Fires before the value for the configuration attribute 'orientation' changes. Return false to cancel the attribute change."}, "activeIndexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "activeIndexChange", "description": "Fires when the value for the configuration attribute 'activeIndex' changes."}, "beforeActiveTabChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeActiveTabChange", "description": "Fires before the value for the configuration attribute 'activeTab' changes. Return false to cancel the attribute change."}, "beforeActiveIndexChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeActiveIndexChange", "description": "Fires before the value for the configuration attribute 'activeIndex' changes. Return false to cancel the attribute change."}, "activeTabChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "activeTabChange", "description": "Fires when the value for the configuration attribute 'activeTab' changes."}, "beforeTabsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "event", "description": "An object containing the previous attribute value and the new value."}], "name": "beforeTabsChange", "description": "Fires before the value for the configuration attribute 'tabs' changes. Return false to cancel the attribute change."}}, "guessedname": "TabView", "methods": {"getTabIndex": {"return": {"type": "", "description": "int"}, "params": [{"type": "YAHOO.widget.Tab", "name": "tab", "description": " The tab whose index will be returned."}], "description": "Returns the index of given tab.", "guessedname": "getTabIndex", "guessedtype": "function"}, "removeTab": {"return": {"type": "", "description": "void"}, "params": [{"type": "YAHOO.widget.Tab", "name": "item", "description": " The Tab instance to be removed."}], "description": "Removes the specified Tab from the TabView.", "guessedname": "removeTab", "guessedtype": "function"}, "contentTransition": {"description": "The transiton to use when switching between tabs.", "guessedname": "contentTransition", "guessedtype": "function"}, "initAttributes": {"params": [{"type": "Object", "name": "attr", "description": " Hash of initial attributes"}], "description": "setAttributeConfigs TabView specific properties.", "guessedname": "initAttributes", "guessedtype": "function"}, "toString": {"return": {"type": "", "description": "String"}, "description": "Provides a readable name for the TabView instance.", "guessedname": "toString", "guessedtype": "function"}, "DOMEventHandler": {"return": {"type": "", "description": "void"}, "params": [{"type": "event", "name": "e", "description": " The Dom event that is being handled."}], "description": "Routes childNode events.", "guessedname": "DOMEventHandler", "guessedtype": "function"}, "addTab": {"return": {"type": "", "description": "void"}, "params": [{"type": "YAHOO.widget.Tab", "name": "tab", "description": " A Tab instance to add."}, {"type": "Integer", "name": "index", "description": " The position to add the tab."}], "description": "Adds a Tab to the TabView instance. \nIf no index is specified, the tab is added to the end of the tab list.", "guessedname": "addTab", "guessedtype": "function"}, "initTabs": {"guessedname": "_initTabs", "return": {"type": "", "description": "void"}, "description": "Creates Tab instances from a collection of HTMLElements.", "private": "", "guessedtype": "function"}, "getTab": {"return": {"type": "", "description": "YAHOO.widget.Tab"}, "params": [{"type": "Integer", "name": "index", "description": " The position of the Tab."}], "description": "Returns the Tab instance at the specified index.", "guessedname": "getTab", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "TabView.js", "guessedtype": "function", "shortname": "TabView", "properties": {"CLASSNAME": {"default": "\"navset\"", "description": "The className to add when building from scratch.", "guessedname": "CLASSNAME", "guessedtype": "property"}, "TAB_PARENT_CLASSNAME": {"default": "\"nav\"", "description": "The className of the HTMLElement containing the TabView's tab elements\nto look for when building from existing markup, or to add when building\nfrom scratch. \nAll childNodes of the tab container are treated as Tabs when building\nfrom existing markup.", "guessedname": "TAB_PARENT_CLASSNAME", "guessedtype": "property"}, "CONTENT_PARENT_CLASSNAME": {"default": "\"nav-content\"", "description": "The className of the HTMLElement containing the TabView's label elements\nto look for when building from existing markup, or to add when building\nfrom scratch. \nAll childNodes of the content container are treated as content elements when\nbuilding from existing markup.", "guessedname": "CONTENT_PARENT_CLASSNAME", "guessedtype": "property"}, "_tabParent": {"guessedname": "_tabParent", "type": "HTMLElement", "description": "The container of the tabView's label elements.", "private": "", "guessedtype": "property"}, "_contentParent": {"guessedname": "_contentParent", "type": "HTMLElement", "description": "The container of the tabView's content elements.", "private": "", "guessedtype": "property"}}, "description": "A widget to control tabbed views."}, "YAHOO.widget.CalendarNavigator": {"name": "YAHOO.widget.CalendarNavigator", "constructors": [{"params": [{"type": "Calendar|CalendarGroup", "name": "cal", "description": " The instance of the Calendar or CalendarGroup to which this CalendarNavigator should be attached."}], "description": "The CalendarNavigator is used along with a Calendar\/CalendarGroup to \nprovide a Month\/Year popup navigation control, allowing the user to navigate \nto a specific month\/year in the Calendar\/CalendarGroup without having to \nscroll through months sequentially"}], "namespace": "YAHOO.widget", "module": "calendar", "guessedname": "CalendarNavigator", "methods": {"_getMonthFromUI": {"protected": "", "return": {"type": "Number", "description": "The month index, or 0 if a UI element for the month\nis not found"}, "description": "Returns the month value (index), from the month UI element", "guessedname": "_getMonthFromUI", "guessedtype": "function"}, "createNav": {"description": "Creates the navigator's containing HTMLElement, it's contents, and appends \nthe containg element to the Calendar\/CalendarGroup's container.", "guessedname": "createNav", "guessedtype": "function"}, "_update": {"protected": "", "params": [{"type": "", "name": "cal", "description": " The Calendar instance to update"}], "description": "Updates the Calendar rendered state, based on the state of the CalendarNavigator", "guessedname": "_update", "guessedtype": "function"}, "_handleDirectionKeys": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The DOM event being handled"}], "description": "Default Keyboard event handler to capture up\/down\/pgup\/pgdown\non the Navigator's year control (yearEl).", "guessedname": "_handleDirectionKeys", "guessedtype": "function"}, "render": {"description": "Renders the HTML for the navigator, adding it to the \ndocument and attaches event listeners if it has not \nalready been rendered.", "guessedname": "render", "guessedtype": "function"}, "show": {"description": "Displays the navigator and mask, updating the input controls to reflect the \ncurrently set month and year. The show method will invoke the render method\nif the navigator has not been renderered already, allowing for lazy rendering\nof the control.\nThe show method will fire the Calendar\/CalendarGroup's beforeShowNav and showNav events", "guessedname": "show", "guessedtype": "function"}, "erase": {"description": "Removes all renderered HTML elements for the Navigator from\nthe DOM, purges event listeners and clears (nulls) any property\nreferences to HTML references", "guessedname": "erase", "guessedtype": "function"}, "_handleShiftTabKey": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The DOM event being handled"}], "description": "Default Keyboard event handler to capture Shift-Tab \non the first control (firstCtrl) in the Navigator.", "guessedname": "_handleShiftTabKey", "guessedtype": "function"}, "cancel": {"description": "Hides the navigator and mask, without updating the Calendar\/CalendarGroup's state", "guessedname": "cancel", "guessedtype": "function"}, "applyKeyListeners": {"description": "Attaches DOM listeners for keyboard support. \nTab\/Shift-Tab looping, Enter Key Submit on Year element,\nUp\/Down\/PgUp\/PgDown year increment on Year element\n<p>\nNOTE: MacOSX Safari 2.x doesn't let you tab to buttons and \nMacOSX Gecko does not let you tab to buttons or select controls,\nso for these browsers, Tab\/Shift-Tab looping is limited to the \nelements which can be reached using the tab key.\n<\/p>", "guessedname": "applyKeyListeners", "guessedtype": "function"}, "setError": {"params": [{"type": "String", "name": "msg", "description": " The error message to display"}], "description": "Displays an error message in the Navigator's error panel", "guessedname": "setError", "guessedtype": "function"}, "hideMask": {"description": "Hides the navigator's mask element", "guessedname": "hideMask", "guessedtype": "function"}, "_updateMonthUI": {"protected": "", "description": "Updates the Navigator's month UI, based on the month value set on the Navigator object", "guessedname": "_updateMonthUI", "guessedtype": "function"}, "hide": {"description": "Hides the navigator and mask\nThe show method will fire the Calendar\/CalendarGroup's beforeHideNav event and hideNav events", "guessedname": "hide", "guessedtype": "function"}, "submit": {"description": "Updates the Calendar\/CalendarGroup's pagedate with the currently set month and year if valid.\n<p>\nIf the currently set month\/year is invalid, a validation error will be displayed and the \nCalendar\/CalendarGroup's pagedate will not be updated.\n<\/p>", "guessedname": "submit", "guessedtype": "function"}, "renderNavContents": {"return": {"type": "Array", "description": "A reference to the buffer passed in."}, "description": "Renders the contents of the navigator", "param": "{Array} html The HTML buffer to append the HTML to.", "params": [{"type": "Array", "name": "html", "description": " The HTML buffer to append the HTML to."}], "guessedname": "renderNavContents", "guessedtype": "function"}, "init": {"params": [{"type": "Calendar", "name": "cal", "description": " The instance of the Calendar or CalendarGroup to which this CalendarNavigator should be attached"}], "description": "Init lifecycle method called as part of construction", "guessedname": "init", "guessedtype": "function"}, "setYearError": {"description": "Displays the validation error UI for the year control", "guessedname": "setYearError", "guessedtype": "function"}, "_getYearFromUI": {"protected": "", "return": {"type": "Number", "description": "The year value set in the UI, if valid. null is returned if \nthe UI does not contain a valid year value."}, "description": "Returns the year value, from the Navitator's year UI element", "guessedname": "_getYearFromUI", "guessedtype": "function"}, "_syncMask": {"protected": "", "description": "Used to set the width\/height of the mask in pixels to match the Calendar Container.\nCurrently only used for IE6 and IE7 quirks mode. The other A-Grade browser are handled using CSS (width\/height 100%).\n<p>\nThe method is also registered as an HTMLElement resize listener on the Calendars container element.\n<\/p>", "guessedname": "_syncMask", "guessedtype": "function"}, "getYear": {"return": {"type": "Number", "description": "The Navigator's current year value"}, "description": "Returns the current year set on the navigator\nNote: This may not be the year set in the UI, if \nthe UI contains an invalid value.", "guessedname": "getYear", "guessedtype": "function"}, "destroy": {"description": "Destroys the Navigator object and any HTML references", "guessedname": "destroy", "guessedtype": "function"}, "getMonth": {"return": {"type": "Number", "description": "The Navigator's current month index"}, "description": "Returns the current month set on the navigator\nNote: This may not be the month set in the UI, if \nthe UI contains an invalid value.", "guessedname": "getMonth", "guessedtype": "function"}, "showMask": {"description": "Displays the navigator's mask element", "guessedname": "showMask", "guessedtype": "function"}, "renderButton": {"return": {"type": "String", "description": "The HTML created for the Button UI"}, "description": "Renders the submit\/cancel buttons for the navigator", "guessedname": "renderButtons", "guessedtype": "function"}, "clearErrors": {"description": "Clears all validation and error messages in the UI", "guessedname": "clearErrors", "guessedtype": "function"}, "applyListeners": {"description": "Attaches DOM event listeners to the rendered elements\n<p>\nThe method will call applyKeyListeners, to setup keyboard specific \nlisteners\n<\/p>", "guessedname": "applyListeners", "guessedtype": "function"}, "purgeListeners": {"description": "Removes\/purges DOM event listeners from the rendered elements", "guessedname": "purgeListeners", "guessedtype": "function"}, "clearYearError": {"description": "Removes the validation error UI for the year control", "guessedname": "clearYearError", "guessedtype": "function"}, "clearError": {"description": "Clears the navigator's error message and hides the error panel", "guessedname": "clearError", "guessedtype": "function"}, "validate": {"return": {"type": "Boolean", "description": "true, if the current UI state contains valid values, false if not"}, "description": "Validates the current state of the UI controls", "guessedname": "validate", "guessedtype": "function"}, "setMonth": {"params": [{"type": "Number", "name": "nMonth", "description": " The month index, from 0 (Jan) through 11 (Dec)."}], "description": "Sets the current month on the Navigator, and updates the UI", "guessedname": "setMonth", "guessedtype": "function"}, "_setFirstLastElements": {"protected": "", "description": "Sets up references to the first and last focusable element in the Navigator's UI\nin terms of tab order (Naviagator's firstEl and lastEl properties). The references\nare used to control modality by looping around from the first to the last control\nand visa versa for tab\/shift-tab navigation.\n<p>\nSee <a href=\"#applyKeyListeners\">applyKeyListeners<\/a>\n<\/p>", "guessedname": "_setFirstLastElements", "guessedtype": "function"}, "_show": {"protected": "", "description": "Protected implementation to handle how UI elements are \nhidden\/shown.", "guessedname": "_show", "guessedtype": "function"}, "setInitialFocus": {"description": "Sets the initial focus, based on the configured value", "guessedname": "setInitialFocus", "guessedtype": "function"}, "_handleEnterKey": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The DOM event being handled"}], "description": "Default Keyboard event handler to capture Enter \non the Navigator's year control (yearEl)", "guessedname": "_handleEnterKey", "guessedtype": "function"}, "__getCfg": {"return": {"type": "", "description": "The value of the configuration property"}, "description": "Retrieve Navigator configuration values from \nthe parent Calendar\/CalendarGroup's config value.\n<p>\nIf it has not been set in the user provided configuration, the method will \nreturn the default value of the configuration property, as set in _DEFAULT_CFG\n<\/p>", "private": "", "params": [{"type": "String", "name": "Case", "description": " sensitive property name."}, {"type": "Boolean", "name": "true,", "description": " if the property is a string property, false if not."}], "guessedname": "__getCfg", "guessedtype": "function"}, "setYear": {"params": [{"type": "Number", "name": "nYear", "description": " The full year value to set the Navigator to."}], "description": "Sets the current year on the Navigator, and updates the UI. If the \nprovided year is invalid, it will not be set.", "guessedname": "setYear", "guessedtype": "function"}, "_handleTabKey": {"protected": "", "params": [{"type": "Event", "name": "e", "description": " The DOM event being handled"}], "description": "Default Keyboard event handler to capture Tab \non the last control (lastCtrl) in the Navigator.", "guessedname": "_handleTabKey", "guessedtype": "function"}, "createMask": {"description": "Creates the Mask HTMLElement and appends it to the Calendar\/CalendarGroups\ncontainer.", "guessedname": "createMask", "guessedtype": "function"}, "purgeKeyListeners": {"description": "Removes\/purges DOM listeners for keyboard support", "guessedname": "purgeKeyListeners", "guessedtype": "function"}, "renderYear": {"return": {"type": "Array", "description": "A reference to the buffer passed in."}, "params": [{"type": "Array", "name": "html", "description": " The HTML buffer to append the HTML to."}], "description": "Renders the year label and control for the navigator", "guessedname": "renderYear", "guessedtype": "function"}, "_updateYearUI": {"protected": "", "description": "Updates the Navigator's year UI, based on the year value set on the Navigator object", "guessedname": "_updateYearUI", "guessedtype": "function"}}, "file": "CalendarNavigator.js", "guessedtype": "function", "shortname": "CalendarNavigator", "properties": {"_DEFAULT_CFG": {"description": "Object literal containing the default configuration values for the CalendarNavigator\nThe configuration object is expected to follow the format below, with the properties being\ncase sensitive.\n<dl>\n<dt>strings<\/dt>\n<dd><em>Object<\/em> : An object with the properties shown below, defining the string labels to use in the Navigator's UI\n<dl>\n<dt>month<\/dt><dd><em>String<\/em> : The string to use for the month label. Defaults to \"Month\".<\/dd>\n<dt>year<\/dt><dd><em>String<\/em> : The string to use for the year label. Defaults to \"Year\".<\/dd>\n<dt>submit<\/dt><dd><em>String<\/em> : The string to use for the submit button label. Defaults to \"Okay\".<\/dd>\n<dt>cancel<\/dt><dd><em>String<\/em> : The string to use for the cancel button label. Defaults to \"Cancel\".<\/dd>\n<dt>invalidYear<\/dt><dd><em>String<\/em> : The string to use for invalid year values. Defaults to \"Year needs to be a number\".<\/dd>\n<\/dl>\n<\/dd>\n<dt>monthFormat<\/dt><dd><em>String<\/em> : The month format to use. Either YAHOO.widget.Calendar.LONG, or YAHOO.widget.Calendar.SHORT. Defaults to YAHOO.widget.Calendar.LONG<\/dd>\n<dt>initialFocus<\/dt><dd><em>String<\/em> : Either \"year\" or \"month\" specifying which input control should get initial focus. Defaults to \"year\"<\/dd>\n<\/dl>", "protected": "", "static": "", "guessedname": "_DEFAULT_CFG", "guessedtype": "property", "type": "Object"}, "YAHOO.widget.CalendarNavigator.YR_PATTERN": {"type": "RegExp", "static": "", "description": "Regular expression used to validate the year input", "guessedname": "YR_PATTERN", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.UPDATE_DELAY": {"type": "Number", "static": "", "description": "Artificial delay (in ms) between the time the Navigator is hidden\nand the Calendar\/CalendarGroup state is updated. Allows the user\nthe see the Calendar\/CalendarGroup page changing. If set to 0\nthe Calendar\/CalendarGroup page will be updated instantly", "guessedname": "UPDATE_DELAY", "guessedtype": "property"}, "lastCtrl": {"type": "HTMLElement", "description": "Reference to the last focusable control in the navigator (by default cancelEl)", "guessedname": "lastCtrl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.MONTH_SUFFIX": {"description": "The suffix added to the Navigator's ID, to generate\na unique ID for the month control.", "static": "", "guessedname": "MONTH_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}, "errorEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to display validation errors", "guessedname": "errorEl", "guessedtype": "property"}, "submitEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to update the Calendar\/Calendar group\nwith the month\/year values", "guessedname": "submitEl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.DEFAULT": {"type": "String", "static": "", "description": "Class applied to default controls", "guessedname": "DEFAULT", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.ID_SUFFIX": {"description": "The suffix added to the Calendar\/CalendarGroup's ID, to generate\na unique ID for the Navigator and it's bounding box.", "static": "", "guessedname": "ID_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.CalendarNavigator.CLASSES.NAV_VISIBLE": {"type": "String", "static": "", "description": "Class applied to the Calendar\/CalendarGroup's bounding box to indicate\nthe Navigator is currently visible", "guessedname": "NAV_VISIBLE", "guessedtype": "property"}, "id": {"type": "String", "description": "The unique ID for this CalendarNavigator instance", "guessedname": "id", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.YEAR_SUFFIX": {"description": "The suffix added to the Navigator's ID, to generate\na unique ID for the year control.", "static": "", "guessedname": "YEAR_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}, "firstCtrl": {"type": "HTMLElement", "description": "Reference to the first focusable control in the navigator (by default monthEl)", "guessedname": "firstCtrl", "guessedtype": "property"}, "__isIEQuirks": {"private": "", "description": "Private flag, to identify IE6\/IE7 Quirks", "guessedname": "ie", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.TRIM": {"type": "RegExp", "static": "", "description": "Regular expression used to trim strings", "guessedname": "TRIM", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.MONTH": {"type": "String", "static": "", "description": "Class applied to the month label\/control bounding box", "guessedname": "MONTH", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.YR_MINOR_INC": {"type": "Number", "static": "", "description": "The amount by which to increment the current year value,\nwhen the arrow up\/down key is pressed on the year control", "guessedname": "YR_MINOR_INC", "guessedtype": "property"}, "navEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to render the navigator's bounding box", "guessedname": "navEl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.MASK": {"type": "String", "static": "", "description": "Class applied to the Navigator mask's bounding box", "guessedname": "MASK", "guessedtype": "property"}, "monthEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to input the month", "guessedname": "monthEl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.YR_MAJOR_INC": {"type": "Number", "static": "", "description": "The amount by which to increment the current year value,\nwhen the page up\/down key is pressed on the year control", "guessedname": "YR_MAJOR_INC", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES": {"type": "Object", "static": "", "description": "YAHOO.widget.CalendarNavigator.CLASSES contains constants\nfor the class values applied to the CalendarNaviatgator's \nDOM elements", "guessedname": "CLASSES", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.ERROR": {"type": "String", "static": "", "description": "Class applied to the validation error area's bounding box", "guessedname": "ERROR", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.NAV": {"type": "String", "static": "", "description": "Class applied to the Calendar Navigator's bounding box", "guessedname": "NAV", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.BUTTONS": {"type": "String", "static": "", "description": "Class applied to the submit\/cancel button's bounding box", "guessedname": "BUTTONS", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.INVALID": {"type": "String", "static": "", "description": "Class applied to controls with invalid data (e.g. a year input field with invalid an year)", "guessedname": "INVALID", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.ERROR_SUFFIX": {"description": "The suffix added to the Navigator's ID, to generate\na unique ID for the error bounding box.", "static": "", "guessedname": "ERROR_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.widget.CalendarNavigator.CLASSES.BUTTON": {"type": "String", "static": "", "description": "Class applied to buttons wrapping element", "guessedname": "BUTTON", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.YEAR_CTRL": {"type": "String", "static": "", "description": "Class applied to the year input control", "guessedname": "YEAR_CTRL", "guessedtype": "property"}, "_year": {"protected": "", "type": "Number", "description": "Internal state property for the current year displayed in the navigator", "guessedname": "_year", "guessedtype": "property"}, "maskEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to render the navigator's mask", "guessedname": "maskEl", "guessedtype": "property"}, "yearEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to input the year", "guessedname": "yearEl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.YEAR": {"type": "String", "static": "", "description": "Class applied to the year label\/control bounding box", "guessedname": "YEAR", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CANCEL_SUFFIX": {"description": "The suffix added to the Navigator's ID, to generate\na unique ID for the \"Cancel\" button.", "static": "", "guessedname": "CANCEL_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}, "__isMac": {"private": "", "description": "Private flag, to identify MacOS", "guessedname": "__isMac", "guessedtype": "property"}, "_doc": {"protected": "", "type": "HTMLDocument", "description": "The document containing the Calendar\/Calendar group instance", "guessedname": "_doc", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.CLASSES.MONTH_CTRL": {"type": "String", "static": "", "description": "Class applied to the month input control", "guessedname": "MONTH_CTRL", "guessedtype": "property"}, "_month": {"protected": "", "type": "Number", "description": "Internal state property for the current month index displayed in the navigator", "guessedname": "_month", "guessedtype": "property"}, "__rendered": {"guessedname": "__rendered", "type": "Boolean", "description": "Private internal state property which indicates whether or not the \nNavigator has been rendered.", "private": "", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.YR_MAX_DIGITS": {"type": "Number", "static": "", "description": "The number of digits to which the year input control is to be limited.", "guessedname": "YR_MAX_DIGITS", "guessedtype": "property"}, "cal": {"type": "{Calendar|CalendarGroup}", "description": "The Calendar\/CalendarGroup instance to which the navigator belongs", "guessedname": "cal", "guessedtype": "property"}, "cancelEl": {"type": "HTMLElement", "description": "Reference to the HTMLElement used to hide the navigator without updating the \nCalendar\/Calendar group", "guessedname": "cancelEl", "guessedtype": "property"}, "YAHOO.widget.CalendarNavigator.SUBMIT_SUFFIX": {"description": "The suffix added to the Navigator's ID, to generate\na unique ID for the \"Submit\" button.", "static": "", "guessedname": "SUBMIT_SUFFIX", "guessedtype": "property", "type": "String", "final": ""}}, "description": "The CalendarNavigator is used along with a Calendar\/CalendarGroup to \nprovide a Month\/Year popup navigation control, allowing the user to navigate \nto a specific month\/year in the Calendar\/CalendarGroup without having to \nscroll through months sequentially"}, "YAHOO.util.Selector": {"name": "YAHOO.util.Selector", "namespace": "YAHOO.util", "module": "selector", "guessedname": "Selector", "methods": {"test": {"return": {"type": "boolean", "description": "Whether or not the node matches the selector."}, "description": "Test if the supplied node matches the supplied selector.", "static": "", "guessedname": "test", "guessedtype": "function", "params": [{"type": "HTMLElement | String", "name": "node", "description": " An id or node reference to the HTMLElement being tested."}, {"type": "string", "name": "selector", "description": " The CSS Selector to test the node against."}]}, "filter": {"return": {"type": "array", "description": "An array of nodes from the supplied array that match the given selector."}, "description": "Filters a set of nodes based on a given CSS selector.", "static": "", "guessedname": "filter", "guessedtype": "function", "params": [{"type": "array", "name": "nodes", "description": " A set of nodes\/ids to filter."}, {"type": "string", "name": "selector", "description": " The selector used to test each node."}]}, "tokenize": {"description": "Break selector into token units per simple selector.\nCombinator is attached to left-hand selector.", "guessedname": "tokenize", "guessedtype": "function"}, "query": {"return": {"type": "Array", "description": "An array of nodes that match the given selector."}, "description": "Retrieves a set of nodes based on a given CSS selector.", "static": "", "guessedname": "query", "guessedtype": "function", "params": [{"type": "string", "name": "selector", "description": " The CSS Selector to test the node against."}, {"type": "HTMLElement | String", "name": "root", "description": " optional An id or HTMLElement to start the query from. Defaults to Selector.document."}, {"type": "Boolean", "name": "firstOnly", "description": " optional Whether or not to return only the first match."}]}}, "static": "", "file": "Selector.js", "guessedtype": "function", "shortname": "Selector", "properties": {"attrAliases": {"type": "object", "description": "Mapping of attributes to aliases, normally to work around HTMLAttributes\nthat conflict with JS reserved words.", "guessedname": "attrAliases", "guessedtype": "property"}, "operators": {"type": "object", "description": "List of operators and corresponding boolean functions. \nThese functions are passed the attribute and the current node's value of the attribute.", "guessedname": "operators", "guessedtype": "property"}, "document": {"default": "window.document", "type": "object", "description": "Default document for use queries", "guessedname": "document", "guessedtype": "property"}, "shorthand": {"type": "object", "description": "Mapping of shorthand tokens to corresponding attribute selector", "guessedname": "shorthand", "guessedtype": "property"}, "pseudos": {"type": "object", "description": "List of pseudo-classes and corresponding boolean functions. \nThese functions are called with the current node, and any value that was parsed with the pseudo regex.", "guessedname": "pseudos", "guessedtype": "property"}}, "description": "Provides helper methods for collecting and filtering DOM elements."}, "YAHOO.util.History": {"name": "YAHOO.util.History", "namespace": "YAHOO.util", "module": "history", "events": {"onLoadEvent": {"see": "onReady", "description": "Fired when the Browser History Manager is ready. If you subscribe to\nthis event after the Browser History Manager has been initialized,\nit will not fire. Therefore, it is recommended to use the onReady\nmethod instead.", "guessedname": "onLoadEvent", "guessedtype": "property"}}, "methods": {"getCurrentState": {"return": {"type": "string", "description": "The current state of the specified module."}, "description": "Returns the current state of the specified module.", "params": [{"type": "string", "name": "module", "description": " Non-empty string representing your module."}], "guessedname": "getCurrentState", "guessedtype": "function", "public": ""}, "_updateIFrame": {"return": {"type": "boolean", "description": "true if successful. false otherwise."}, "description": "Update the IFrame with our new state.", "private": ""}, "_handleFQStateChange": {"params": [{"type": "string", "name": "fqstate", "description": " Fully qualified state"}], "description": "Sets the new currentState attribute of all modules depending on the new\nfully qualified state. Also notifies the modules which current state has\nchanged.", "private": ""}, "onReady": {"see": "onLoadEvent", "params": [{"type": "function", "name": "fn", "description": " what to execute when the Browser History Manager is ready."}, {"type": "object", "name": "obj", "description": " an optional object to be passed back as a parameter to fn."}, {"type": "boolean|object", "name": "override", "description": " If true, the obj passed in becomes fn's execution scope."}], "description": "Executes the supplied callback when the Browser History Manager is\nready. This will execute immediately if called after the Browser\nHistory Manager onLoad event has fired.", "guessedname": "onReady", "guessedtype": "function"}, "navigate": {"return": {"type": "boolean", "description": "Indicates whether the new state was successfully added to the history."}, "description": "Call this method when you want to store a new entry in the browser's history.", "params": [{"type": "string", "name": "module", "description": " Non-empty string representing your module."}, {"type": "string", "name": "state", "description": " String representing the new state of the specified module."}], "guessedname": "navigate", "guessedtype": "function", "public": ""}, "_initialize": {"description": "Finish up the initialization of the Browser History Manager.", "private": ""}, "register": {"params": [{"type": "string", "name": "module", "description": " Non-empty string uniquely identifying the\nmodule you wish to register."}, {"type": "string", "name": "initialState", "description": " The initial state of the specified\nmodule corresponding to its earliest history entry."}, {"type": "function", "name": "onStateChange", "description": " Callback called when the\nstate of the specified module has changed."}, {"type": "object", "name": "obj", "description": " An arbitrary object that will be passed as a\nparameter to the handler."}, {"type": "boolean", "name": "override", "description": " If true, the obj passed in becomes the\nexecution scope of the listener."}], "description": "Registers a new module.", "guessedname": "register", "guessedtype": "function"}, "_checkIframeLoaded": {"description": "Periodically checks whether our internal IFrame is ready to be used.", "private": ""}, "getBookmarkedState": {"return": {"type": "string", "description": "The bookmarked state of the specified module."}, "description": "Returns the state of a module according to the URL fragment\nidentifier. This method is useful to initialize your modules\nif your application was bookmarked from a particular state.", "params": [{"type": "string", "name": "module", "description": " Non-empty string representing your module."}], "guessedname": "getBookmarkedState", "guessedtype": "function", "public": ""}, "initialize": {"public": "", "params": [{"type": "string|HTML Element", "name": "stateField", "description": " <input type=\"hidden\"> used\nto store application states. Must be in the static markup."}, {"type": "string|HTML Element", "name": "histFrame", "description": " IFrame used to store\nthe history (only required on Internet Explorer)"}], "description": "Initializes the Browser History Manager. Call this method\nfrom a script block located right after the opening body tag.", "guessedname": "initialize", "guessedtype": "function"}, "_storeStates": {"description": "Stores all the registered modules' initial state and current state.\nOn Safari, we also store all the fully qualified states visited by\nthe application within a single browser session. The storage takes\nplace in the form field specified during initialization.", "private": ""}, "getQueryStringParameter": {"return": {"type": "string", "description": "The value of the specified parameter, or null."}, "description": "Returns the value of the specified query string parameter.\nThis method is not used internally by the Browser History Manager.\nHowever, it is provided here as a helper since many applications\nusing the Browser History Manager will want to read the value of\nurl parameters to initialize themselves.", "params": [{"type": "string", "name": "paramName", "description": " Name of the parameter we want to look up."}, {"type": "string", "name": "queryString", "description": " Optional URL to look at. If not specified,\nthis method uses the URL in the address bar."}], "guessedname": "getQueryStringParameter", "guessedtype": "function", "public": ""}, "_getHash": {"return": {"type": "string", "description": "The hash portion of the document's location"}, "description": "location.hash is a bit buggy on Opera. I have seen instances where\nnavigating the history using the back\/forward buttons, and hence\nchanging the URL, would not change location.hash. That's ok, the\nimplementation of an equivalent is trivial.", "private": ""}, "multiNavigate": {"return": {"type": "boolean", "description": "Indicates whether the new state was successfully added to the history."}, "description": "Call this method when you want to store a new entry in the browser's history.", "params": [{"type": "object", "name": "states", "description": " Associative array of module-state pairs to set simultaneously."}], "guessedname": "multiNavigate", "guessedtype": "function", "public": ""}}, "file": "history.js", "shortname": "History", "properties": {"_histFrame": {"description": "Our hidden IFrame used to store the browsing history.", "default": "null", "private": "", "guessedname": "_histFrame", "guessedtype": "property", "type": "HTMLIFrameElement"}, "_initialized": {"description": "Flag used to tell whether YAHOO.util.History.initialize has been called.", "default": "false", "private": "", "guessedname": "_initialized", "guessedtype": "property", "type": "boolean"}, "_modules": {"description": "List of registered modules.", "default": "[]", "private": "", "guessedname": "_modules", "guessedtype": "property", "type": "array"}, "QUERY_STRING_REGEXP": {"guessedname": "QUERY_STRING_REGEXP", "type": "RegExp", "description": "Regular expression used to parse \"&\"-separated key-value pairs", "private": "", "guessedtype": "property"}, "_stateField": {"description": "INPUT field (with type=\"hidden\" or type=\"text\") or TEXTAREA.\nThis field keeps the value of the initial state, current state\nthe list of all states across pages within a single browser session.", "default": "null", "private": "", "guessedname": "_stateField", "guessedtype": "property", "type": "HTMLInputElement|HTMLTextAreaElement"}, "_fqstates": {"description": "List of fully qualified states. This is used only by Safari.", "default": "[]", "private": "", "guessedname": "_fqstates", "guessedtype": "property", "type": "array"}}, "description": "The History class provides the ability to use the back\/forward navigation\nbuttons in a DHTML application. It also allows a DHTML application to\nbe bookmarked in a specific state."}, "YAHOO.widget.DateNode": {"name": "YAHOO.widget.DateNode", "constructors": [{"params": [{"type": "object", "name": "oData", "description": " a string or object containing the data that will\r\nbe used to render this node.\r\nProviding a string is the same as providing an object with a single property named label.\r\nAll values in the oData will be used to set equally named properties in the node\r\nas long as the node does have such properties, they are not undefined, private nor functions.\r\nAll attributes are made available in noderef.data, which\r\ncan be used to store custom attributes. TreeView.getNode(s)ByProperty\r\ncan be used to retrieve a node by one of the attributes."}, {"type": "YAHOO.widget.Node", "name": "oParent", "description": " this node's parent node"}, {"type": "boolean", "name": "expanded", "description": " the initial expanded\/collapsed state (deprecated; use oData.expanded)"}], "description": "A Date-specific implementation that differs from TextNode in that it uses \r\nYAHOO.widget.Calendar as an in-line editor, if available\r\nIf Calendar is not available, it behaves as a plain TextNode."}], "namespace": "YAHOO.widget", "module": "treeview", "guessedname": "DateNode", "methods": {"fillEditorContainer": {"return": {"type": "", "description": "void"}, "params": [{"type": "YAHOO.widget.TreeView.editorData", "name": "editorData", "description": " a shortcut to the static object holding editing information"}], "description": "If YAHOO.widget.Calendar is available, it will pop up a Calendar to enter a new date. Otherwise, it falls back to a plain <input> textbox", "guessedname": "fillEditorContainer", "guessedtype": "function"}, "saveEditorValue": {"params": [{"type": "YAHOO.widget.TreeView.editorData", "name": "editorData", "description": " a shortcut to the static object holding editing information"}], "description": "Saves the date entered in the editor into the DateNode label property and displays it.\r\nOverrides Node.saveEditorValue", "guessedname": "saveEditorValue", "guessedtype": "function"}}, "extends": "YAHOO.widget.TextNode", "superclass": "YAHOO.widget.TextNode", "file": "DateNode.js", "guessedtype": "function", "shortname": "DateNode", "properties": {"_type": {"description": "The node type", "default": "\"DateNode\"", "private": "", "guessedname": "_type", "guessedtype": "property", "type": "string"}, "calendarConfig": {"description": "Configuration object for the Calendar editor, if used.\r\nSee <a href=\"http:\/\/developer.yahoo.com\/yui\/calendar\/#internationalization\">http:\/\/developer.yahoo.com\/yui\/calendar\/#internationalization<\/a>", "guessedname": "calendarConfig", "guessedtype": "property"}}, "description": "A Date-specific implementation that differs from TextNode in that it uses \r\nYAHOO.widget.Calendar as an in-line editor, if available\r\nIf Calendar is not available, it behaves as a plain TextNode."}, "YAHOO.widget.BarSeries": {"name": "YAHOO.widget.BarSeries", "constructors": [{"description": "BarSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "BarSeries", "file": "Series.js", "guessedtype": "function", "shortname": "BarSeries", "description": "BarSeries class for the YUI Charts widget."}, "YAHOO.tool.TestLogger": {"name": "YAHOO.tool.TestLogger", "constructors": [{"params": [{"type": "HTMLElement", "name": "element", "description": " (Optional) The element to create the logger in."}, {"type": "Object", "name": "config", "description": " (Optional) Configuration options for the logger."}], "description": "Displays test execution progress and results, providing filters based on\ndifferent key events."}], "namespace": "YAHOO.tool", "module": "yuitest", "guessedname": "TestLogger", "methods": {"_handleTestRunnerEvent": {"return": {"type": "Void", "description": ""}, "description": "Handles all TestRunner events, outputting appropriate data into the console.", "private": "", "params": [{"type": "Object", "name": "data", "description": " The event data object."}], "guessedname": "_handleTestRunnerEvent", "guessedtype": "function"}, "formatMsg": {"return": {"type": "String", "description": "HTML-formatted message for output to console."}, "description": "Formats message string to HTML for output to console.", "private": "", "params": [{"type": "Object", "name": "oLogMsg", "description": " Log message object."}], "guessedname": "formatMsg", "guessedtype": "function"}, "clearTestRunner": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Clears the reference to the TestRunner from previous operations. This \nunsubscribes all events and removes the object reference.", "guessedname": "clearTestRunner", "guessedtype": "function"}, "setTestRunner": {"return": {"type": "Void", "description": ""}, "description": "Sets the source test runner that the logger should monitor.", "static": "", "guessedname": "setTestRunner", "guessedtype": "function", "params": [{"type": "YAHOO.tool.TestRunner", "name": "testRunner", "description": " The TestRunner to observe."}]}}, "file": "TestLogger.js", "guessedtype": "function", "shortname": "TestLogger", "description": "Displays test execution progress and results, providing filters based on\ndifferent key events."}, "YAHOO.tool.TestManager": {"name": "YAHOO.tool.TestManager", "namespace": "YAHOO.tool", "module": "yuitest", "events": {"testmanagerbegin": {"static": "", "description": "Fires when the test manager starts running all test pages"}, "testmanagercomplete": {"static": "", "params": [{"type": " pages_passed: int, pages_failed: int, tests_passed: int\ntests_failed: int, passed: string[], failed: string[],\npage_results: {} ", "name": "obj", "description": ""}], "description": "Fires when the test manager finishes running all test pages. External\ntest runners should subscribe to this event in order to get the\naggregated test results."}, "testpagecomplete": {"static": "", "params": [{"type": "page: string, results: object", "name": "obj", "description": " the name of the\npage that was loaded, and the test suite results"}], "description": "Fires when a test page is complete"}, "testpagebegin": {"static": "", "params": [{"type": "string", "name": "curPage", "description": " the page being loaded"}], "description": "Fires when loading a test page"}}, "guessedname": "TestManager", "methods": {"load": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Signals that a test page has been loaded. This should be called from\nwithin the test page itself to notify the TestManager that it is ready.", "guessedname": "load", "guessedtype": "function"}, "_run": {"return": {"type": "Void", "description": ""}, "description": "Loads the next test page into the iframe.", "private": "", "static": "", "guessedname": "_run", "guessedtype": "function"}, "stop": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Stops the execution of tests.", "guessedname": "stop", "guessedtype": "function"}, "setPages": {"return": {"type": "Void", "description": ""}, "description": "Sets the pages to be loaded.", "static": "", "guessedname": "setPages", "guessedtype": "function", "params": [{"type": "String[]", "name": "pages", "description": " An array of URLs to load."}]}, "start": {"static": "", "return": {"type": "Void", "description": ""}, "description": "Begins the process of running the tests.", "guessedname": "start", "guessedtype": "function"}, "_processResults": {"return": {"type": "Void", "description": ""}, "description": "Processes the results of a test page run, outputting log messages\nfor failed tests.", "private": "", "static": "", "guessedname": "_processResults", "guessedtype": "function"}, "_handleTestRunnerComplete": {"return": {"type": "Void", "description": ""}, "description": "Handles TestRunner.COMPLETE_EVENT, storing the results and beginning\nthe loop again.", "private": "", "static": "", "guessedname": "_handleTestRunnerComplete", "guessedtype": "function", "params": [{"type": "Object", "name": "data", "description": " Data about the event."}]}}, "static": "", "file": "TestManager.js", "guessedtype": "property", "shortname": "TestManager", "properties": {"_pages": {"type": "String[]", "static": "", "description": "Array of pages to load.", "private": ""}, "TEST_MANAGER_COMPLETE_EVENT": {"static": "", "type": "string", "description": "Constant for the testmanagercomplete custom event", "final": ""}, "_timeoutId": {"type": "int", "static": "", "description": "The timeout ID for the next iteration through the tests.", "private": ""}, "_logger": {"description": "The logger used to output results from the various tests.", "private": "", "static": "", "guessedname": "_logger", "guessedtype": "property", "type": "YAHOO.tool.TestLogger"}, "TEST_PAGE_BEGIN_EVENT": {"static": "", "type": "string", "description": "Constant for the testpagebegin custom event", "final": ""}, "TEST_PAGE_COMPLETE_EVENT": {"static": "", "type": "string", "description": "Constant for the testpagecomplete custom event", "final": ""}, "_curPage": {"type": "String", "static": "", "description": "The URL of the page currently being executed.", "private": ""}, "_results": {"description": "Aggregated results", "private": "", "static": "", "guessedname": "_results", "guessedtype": "property", "type": "Object"}, "TEST_MANAGER_BEGIN_EVENT": {"static": "", "type": "string", "description": "Constant for the testmanagerbegin custom event", "final": ""}, "_frame": {"type": "Window", "static": "", "description": "The frame used to load and run tests.", "private": ""}}, "description": "Runs pages containing test suite definitions."}, "YAHOO.util.Point": {"name": "YAHOO.util.Point", "constructors": [{"params": [{"type": "Int", "name": "x", "description": " The X position of the point"}, {"type": "Int", "name": "y", "description": " The Y position of the point"}], "description": "A point is a region that is special in that it represents a single point on \nthe grid."}], "namespace": "YAHOO.util", "module": "dom", "guessedname": "Point", "extends": "YAHOO.util.Region", "superclass": "YAHOO.util.Region", "file": "Region.js", "guessedtype": "function", "shortname": "Point", "properties": {"y": {"type": "Int", "description": "The Y position of the point, which is also the top, bottom and index one (for Dom.getXY symmetry)", "guessedname": "y", "guessedtype": "property"}, "x": {"type": "Int", "description": "The X position of the point, which is also the right, left and index zero (for Dom.getXY symmetry)", "guessedname": "x", "guessedtype": "property"}}, "description": "A point is a region that is special in that it represents a single point on \nthe grid."}, "YAHOO.widget.Tooltip": {"name": "YAHOO.widget.Tooltip", "configs": {"container": {"default": "document.body", "type": "HTMLElement\/String", "description": "Specifies the container element that the Tooltip's markup \nshould be rendered into."}, "width": {"default": "null", "type": "String", "description": "String representing the width of the Tooltip. <em>Please note:\n<\/em> As of version 2.3 if either no value or a value of \"auto\" \nis specified, and the Toolip's \"container\" configuration property\nis set to something other than <code>document.body<\/code> or \nits \"context\" element resides outside the immediately visible \nportion of the document, the width of the Tooltip will be \ncalculated based on the offsetWidth of its root HTML and set just \nbefore it is made visible. The original value will be \nrestored when the Tooltip is hidden. This ensures the Tooltip is \nrendered at a usable width. For more information see \nSourceForge bug #1685496 and SourceForge \nbug #1735423."}, "text": {"default": "null", "type": "String", "description": "Specifies the Tooltip's text."}, "showdelay": {"default": "200", "type": "Number", "description": "The number of milliseconds to wait before showing a Tooltip \non mouseover."}, "disabled": {"default": "false", "type": "Boolean", "description": "Specifies whether or not the tooltip is disabled. Disabled tooltips\nwill not be displayed. If the tooltip is driven by the title attribute\nof the context element, the title attribute will still be removed for \ndisabled tooltips, to prevent default tooltip behavior."}, "preventoverlap": {"default": "true", "type": "Boolean", "description": "Specifies whether the Tooltip should be kept from overlapping \nits context element."}, "context": {"default": "null", "type": "HTMLElement[]\/String[]", "description": "Specifies the element or elements that the Tooltip should be \nanchored to on mouseover."}, "autodismissdelay": {"default": "5000", "type": "Number", "description": "The number of milliseconds to wait before automatically \ndismissing a Tooltip after the mouse has been resting on the \ncontext element."}, "hidedelay": {"default": "250", "type": "Number", "description": "The number of milliseconds to wait before hiding a Tooltip \nafter mouseout."}}, "constructors": [{"params": [{"type": "String", "name": "el", "description": " The element ID representing the Tooltip <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Tooltip"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal containing \nthe configuration that should be set for this Overlay. See configuration \ndocumentation for more details."}], "description": "Tooltip is an implementation of Overlay that behaves like an OS tooltip, \ndisplaying when the user mouses over a particular element, and \ndisappearing on mouse out."}], "namespace": "YAHOO.widget", "module": "container", "events": {"contextMouseOverEvent": {"params": [{"type": "HTMLElement", "name": "context", "description": " The context element which the user just moused over"}, {"type": "DOMEvent", "name": "e", "description": " The DOM event object, associated with the mouse over"}], "description": "CustomEvent fired when user mouses over a context element. Returning false from\na subscriber to this event will prevent the tooltip from being displayed for\nthe current context element.", "guessedname": "contextMouseOverEvent", "guessedtype": "property"}, "contextTriggerEvent": {"params": [{"type": "HTMLElement", "name": "context", "description": " The context element for which the tooltip is triggered"}], "description": "CustomEvent fired just before the tooltip is displayed for the current context.\n<p>\nYou can subscribe to this event if you need to set up the text for the \ntooltip based on the context element for which it is about to be displayed.\n<\/p>\n<p>This event differs from the beforeShow event in following respects:<\/p>\n<ol>\n<li>\nWhen moving from one context element to another, if the tooltip is not\nhidden (the <code>hidedelay<\/code> is not reached), the beforeShow and Show events will not\nbe fired when the tooltip is displayed for the new context since it is already visible.\nHowever the contextTrigger event is always fired before displaying the tooltip for\na new context.\n<\/li>\n<li>\nThe trigger event provides access to the context element, allowing you to \nset the text of the tooltip based on context element for which the tooltip is\ntriggered.\n<\/li>\n<\/ol>\n<p>\nIt is not possible to prevent the tooltip from being displayed\nusing this event. You can use the contextMouseOverEvent if you need to prevent\nthe tooltip from being displayed.\n<\/p>", "guessedname": "contextTriggerEvent", "guessedtype": "property"}, "contextMouseOutEvent": {"params": [{"type": "HTMLElement", "name": "context", "description": " The context element which the user just moused out of"}, {"type": "DOMEvent", "name": "e", "description": " The DOM event object, associated with the mouse out"}], "description": "CustomEvent fired when the user mouses out of a context element.", "guessedname": "contextMouseOutEvent", "guessedtype": "property"}}, "guessedname": "Tooltip", "methods": {"onContextMouseOver": {"params": [{"type": "DOMEvent", "name": "e", "description": " The current DOM event"}, {"type": "Object", "name": "obj", "description": " The object argument"}], "description": "The default event handler fired when the user mouses over the \ncontext element.", "guessedname": "onContextMouseOver", "guessedtype": "function"}, "onRender": {"params": [{"type": "String", "name": "p_sType", "description": " String representing the name of the event \nthat was fired."}, {"type": "Array", "name": "p_aArgs", "description": " Array of arguments sent when the event \nwas fired."}], "description": "\"render\" event handler for the Tooltip.", "guessedname": "onRender", "guessedtype": "function"}, "doShow": {"return": {"type": "Number", "description": "The process ID of the timeout function associated \nwith doShow"}, "params": [{"type": "DOMEvent", "name": "e", "description": " The current DOM event"}, {"type": "HTMLElement", "name": "context", "description": " The current context element"}], "description": "Processes the showing of the Tooltip by setting the timeout delay \nand offset of the Tooltip.", "guessedname": "doShow", "guessedtype": "function"}, "initEvents": {"description": "Initializes the custom events for Tooltip", "guessedname": "initEvents", "guessedtype": "function"}, "_removeEventListeners": {"protected": "", "description": "Removes all of the DOM event handlers from the HTML\nelement(s) that trigger the display of the tooltip.", "guessedname": "_removeEventListeners", "guessedtype": "function"}, "configContext": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers,\nthis will usually equal the owner."}], "description": "The default event handler fired when the \"context\" property \nis changed.", "guessedname": "configContext", "guessedtype": "function"}, "doHide": {"description": "Sets the timeout for the auto-dismiss delay, which by default is 5 \nseconds, meaning that a tooltip will automatically dismiss itself \nafter 5 seconds of being displayed.", "guessedname": "doHide", "guessedtype": "function"}, "onContextMouseOut": {"params": [{"type": "DOMEvent", "name": "e", "description": " The current DOM event"}, {"type": "Object", "name": "obj", "description": " The object argument"}], "description": "The default event handler fired when the user mouses out of \nthe context element.", "guessedname": "onContextMouseOut", "guessedtype": "function"}, "configContainer": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For \nconfiguration handlers, args[0] will equal the newly applied value \nfor the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers,\nthis will usually equal the owner."}], "description": "The default event handler fired when the \"container\" property \nis changed.", "guessedname": "configContainer", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "el", "description": " The element ID representing the Tooltip <em>OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Tooltip"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal \ncontaining the configuration that should be set for this Tooltip. \nSee configuration documentation for more details."}], "description": "The Tooltip initialization method. This method is automatically \ncalled by the constructor. A Tooltip is automatically rendered by \nthe init method, and it also is set to be invisible by default, \nand constrained to viewport by default as well.", "guessedname": "init", "guessedtype": "function"}, "onContextMouseMove": {"params": [{"type": "DOMEvent", "name": "e", "description": " The current DOM event"}, {"type": "Object", "name": "obj", "description": " The object argument"}], "description": "The default event handler fired when the user moves the mouse while \nover the context element.", "guessedname": "onContextMouseMove", "guessedtype": "function"}, "configText": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type (usually the property name)"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments. For configuration \nhandlers, args[0] will equal the newly applied value for the property."}, {"type": "Object", "name": "obj", "description": " The scope object. For configuration handlers, \nthis will usually equal the owner."}], "description": "The default event handler fired when the \"text\" property is changed.", "guessedname": "configText", "guessedtype": "function"}, "preventOverlay": {"params": [{"type": "Number", "name": "pageX", "description": " The x coordinate position of the mouse pointer"}, {"type": "Number", "name": "pageY", "description": " The y coordinate position of the mouse pointer"}], "description": "Fired when the Tooltip is moved, this event handler is used to \nprevent the Tooltip from overlapping with its context element.", "guessedname": "preventOverlap", "guessedtype": "function"}, "destroy": {"description": "Removes the Tooltip element from the DOM and sets all child \nelements to null.", "guessedname": "destroy", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The string representation of the Tooltip"}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be \nchanged using the Overlay's Config object (cfg).", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "extends": "YAHOO.widget.Overlay", "superclass": "YAHOO.widget.Overlay", "file": "Tooltip.js", "guessedtype": "function", "shortname": "Tooltip", "properties": {"showProcId": {"type": "int", "description": "The unique process ID associated with the thread responsible \nfor showing the Tooltip.", "guessedname": "showProcId", "guessedtype": "property"}, "YAHOO.widget.Tooltip.CSS_TOOLTIP": {"description": "Constant representing the Tooltip CSS class", "static": "", "guessedname": "CSS_TOOLTIP", "guessedtype": "property", "type": "String", "final": ""}, "EVENT_TYPES": {"description": "Constant representing the name of the Tooltip's events", "private": "", "guessedname": "EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "DEFAULT_CONFIG": {"description": "Constant representing the Tooltip's configuration properties", "private": "", "guessedname": "DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}}, "description": "Tooltip is an implementation of Overlay that behaves like an OS tooltip, \ndisplaying when the user mouses over a particular element, and \ndisappearing on mouse out."}}, "version": "2.6.0", "namespaces": ["YAHOO.util", "YAHOO.widget", "YAHOO.widget.Paginator.ui", "YAHOO.tool", "YAHOO.tool.TestCase", "YAHOO.tool.TestFormat"]}]]>