{"classmap": {"YAHOO.widget.Panel": {"name": "YAHOO.widget.Panel", "configs": {"keylisteners": {"default": "null", "type": "YAHOO.util.KeyListener[]", "description": "A KeyListener (or array of KeyListeners) that will be enabled \nwhen the Panel is shown, and disabled when the Panel is hidden."}, "draggable": {"default": "true", "type": "Boolean", "description": "Boolean specifying if the Panel should be draggable. The default \nvalue is \"true\" if the Drag and Drop utility is included, \notherwise it is \"false.\" PLEASE NOTE:<\/strong> There is a \nknown issue in IE 6 (Strict Mode and Quirks Mode) and IE 7 \n(Quirks Mode) where Panels that either don't have a value set for \ntheir \"width\" configuration property, or their \"width\" \nconfiguration property is set to \"auto\" will only be draggable by\nplacing the mouse on the text of the Panel's header element.\nTo fix this bug, draggable Panels missing a value for their \n\"width\" configuration property, or whose \"width\" configuration \nproperty is set to \"auto\" will have it set to the value of \ntheir root HTML element's offsetWidth before they are made \nvisible. The calculated width is then removed when the Panel is \nhidden. This fix is only applied to draggable Panels in IE 6 \n(Strict Mode and Quirks Mode) and IE 7 (Quirks Mode)<\/em>. For \nmore information on this issue see:\nSourceForge bugs #1726972 and #1589210."}, "dragOnly": {"default": "false", "type": "Boolean", "description": "Boolean specifying if the draggable Panel should be drag only, not interacting with drop \ntargets on the page.\n

\nWhen set to true, draggable Panels will not check to see if they are over drop targets,\nor fire the DragDrop events required to support drop target interaction (onDragEnter, \nonDragOver, onDragOut, onDragDrop etc.).\nIf the Panel is not designed to be dropped on any target elements on the page, then this \nflag can be set to true to improve performance.\n<\/p>\n

\nWhen set to false, all drop target related events will be fired.\n<\/p>\n

\nThe property is set to false by default to maintain backwards compatibility but should be \nset to true if drop target interaction is not required for the Panel, to improve performance.<\/p>"}, "modal": {"default": "false", "type": "Boolean", "description": "True if the Panel should be displayed in a modal fashion, \nautomatically creating a transparent mask over the document that\nwill not be removed until the Panel is dismissed."}, "close": {"default": "true", "type": "Boolean", "description": "True if the Panel should display a \"close\" button"}, "underlay": {"default": "shadow", "type": "String", "description": "Sets the type of underlay to display for the Panel. Valid values \nare \"shadow,\" \"matte,\" and \"none\". PLEASE NOTE:<\/strong> \nThe creation of the underlay element is deferred until the Panel \nis initially made visible. For Gecko-based browsers on Mac\nOS X the underlay elment is always created as it is used as a \nshim to prevent Aqua scrollbars below a Panel instance from poking \nthrough it (See SourceForge bug #836476)."}}, "constructors": [{"params": [{"type": "String", "name": "el", "description": " The element ID representing the Panel OR<\/em>"}, {"type": "HTMLElement", "name": "el", "description": " The element representing the Panel"}, {"type": "Object", "name": "userConfig", "description": " The configuration object literal containing \nthe configuration that should be set for this Panel. See configuration \ndocumentation for more details."}], "description": "Panel is an implementation of Overlay that behaves like an OS window, \nwith a draggable header and an optional close icon at the top right."}], "namespace": "YAHOO.widget", "module": "container", "events": {"showMaskEvent": {"description": "CustomEvent fired after the modality mask is shown", "guessedname": "showMaskEvent", "guessedtype": "property"}, "dragEvent": {"description": "CustomEvent when the Panel is dragged", "guessedname": "dragEvent", "guessedtype": "property"}, "hideMaskEvent": {"description": "CustomEvent fired after the modality mask is hidden", "guessedname": "hideMaskEvent", "guessedtype": "property"}}, "guessedname": "Panel", "methods": {"_removeFocusHandlers": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " Event type"}, {"type": "Array", "name": "p_aArgs", "description": " Event Arguments"}], "description": "\"hideMask\" event handler that removes all \"focus\" event handlers added \nby the \"addFocusEventHandlers\" method.", "guessedname": "_removeFocusHandlers", "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 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 \"close\" property is changed.\nThe method controls the appending or hiding of the close icon at the \ntop right of the Panel.", "guessedname": "configClose", "guessedtype": "function"}, "render": {"return": {"type": "boolean", "description": "Success or failure of the render"}, "params": [{"type": "String", "name": "appendToNode", "description": " The element id to which the Module \nshould be appended to prior to rendering OR<\/em>"}, {"type": "HTMLElement", "name": "appendToNode", "description": " The element to which the Module \nshould be appended to prior to rendering"}], "description": "Renders the Panel by inserting the elements that are not already in \nthe main Panel into their correct places. Optionally appends the \nPanel to the specified node prior to the render's execution. NOTE: \nFor Panels without existing markup, the appendToNode argument is \nREQUIRED. If this argument is ommitted and the current element is \nnot present in the document, the function will return false, \nindicating that the render was a failure.", "guessedname": "render", "guessedtype": "function"}, "stackMask": {"description": "Sets the zindex of the mask, if it exists, based on the zindex of \nthe Panel element. The zindex of the mask is set to be one less \nthan the Panel element's zindex.\n

NOTE: This method will not bump up the zindex of the Panel\nto ensure that the mask has a non-negative zindex. If you require the\nmask zindex to be 0 or higher, the zindex of the Panel \nshould be set to a value higher than 0, before this method is called.\n<\/p>", "guessedname": "stackMask", "guessedtype": "function"}, "hideMask": {"description": "Hides the modality mask.", "guessedname": "hideMask", "guessedtype": "function"}, "initEvents": {"description": "Initializes the custom events for Module which are fired \nautomatically at appropriate times by the Module class.", "guessedname": "initEvents", "guessedtype": "function"}, "configModal": {"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 \"modal\" property is \nchanged. This handler subscribes or unsubscribes to the show and hide\nevents to handle the display or hide of the modality mask.", "guessedname": "configModal", "guessedtype": "function"}, "configKeyListeners": {"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 \"keylisteners\" property \nis changed.", "guessedname": "configKeyListeners", "guessedtype": "function"}, "init": {"params": [{"type": "String", "name": "el", "description": " The element ID representing the Overlay 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"}, "toString": {"return": {"type": "String", "description": "The string representation of the Panel."}, "description": "Returns a String representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "buildWrapper": {"description": "Builds the wrapping container around the Panel that is used for \npositioning the shadow and matte underlays. The container element is \nassigned to a local instance variable called container, and the \nelement is reinserted inside of it.", "guessedname": "buildWrapper", "guessedtype": "function"}, "destroy": {"description": "Removes the Panel element from the DOM and sets all child elements\nto null.", "guessedname": "destroy", "guessedtype": "function"}, "removeMask": {"description": "Removes the modality mask.", "guessedname": "removeMask", "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"}, "registerDragDrop": {"description": "Registers the Panel's header for drag & drop capability.", "guessedname": "registerDragDrop", "guessedtype": "function"}, "showMask": {"description": "Shows the modality mask.", "guessedname": "showMask", "guessedtype": "function"}, "_onElementFocus": {"guessedname": "_onElementFocus", "params": [{"type": "Event", "name": "e", "description": " The DOM event object"}], "description": "\"focus\" event handler for a focuable element. Used to automatically \nblur the element when it receives focus to ensure that a Panel \ninstance's modality is not compromised.", "private": "", "guessedtype": "function"}, "_addFocusHandlers": {"protected": "", "params": [{"type": "String", "name": "p_sType", "description": " Custom event type"}, {"type": "Array", "name": "p_aArgs", "description": " Custom event arguments"}], "description": "\"showMask\" event handler that adds a \"focus\" event handler to all\nfocusable elements in the document to enforce a Panel instance's \nmodality from being compromised.", "guessedname": "_addFocusHandlers", "guessedtype": "function"}, "configUnderlay": {"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 \"underlay\" property \nis changed.", "guessedname": "configUnderlay", "guessedtype": "function"}, "buildMask": {"description": "Builds the mask that is laid over the document when the Panel is \nconfigured to be modal.", "guessedname": "buildMask", "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"}, "configDraggable": {"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 \"draggable\" property \nis changed.", "guessedname": "configDraggable", "guessedtype": "function"}, "sizeMask": {"description": "Sets the size of the modality mask to cover the entire scrollable \narea of the document", "guessedname": "sizeMask", "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"}, "sizeUnderlay": {"description": "Adjusts the size of the shadow based on the size of the element.", "guessedname": "sizeUnderlay", "guessedtype": "function"}, "initDefaultConfig": {"description": "Initializes the class's configurable properties which can be changed \nusing the Panel's Config object (cfg).", "guessedname": "initDefaultConfig", "guessedtype": "function"}}, "extends": "YAHOO.widget.Overlay", "superclass": "YAHOO.widget.Overlay", "file": "Panel.js", "guessedtype": "function", "shortname": "Panel", "properties": {"YAHOO.widget.Panel.FOCUSABLE": {"type": "Array", "static": "", "description": "Constant representing the default set of focusable elements \non the pagewhich Modal Panels will prevent access to, when\nthe modal mask is displayed", "guessedname": "FOCUSABLE", "guessedtype": "property"}, "YAHOO.widget.Panel.CSS_PANEL_CONTAINER": {"description": "Constant representing the default CSS class used for a Panel's \nwrapping container", "static": "", "guessedname": "CSS_PANEL_CONTAINER", "guessedtype": "property", "type": "String", "final": ""}, "EVENT_TYPES": {"description": "Constant representing the name of the Panel's events", "private": "", "guessedname": "EVENT_TYPES", "guessedtype": "property", "type": "Object", "final": ""}, "DEFAULT_CONFIG": {"description": "Constant representing the Panel's configuration properties", "private": "", "guessedname": "DEFAULT_CONFIG", "guessedtype": "property", "type": "Object", "final": ""}, "YAHOO.widget.Panel.CSS_PANEL": {"description": "Constant representing the default CSS class used for a Panel", "static": "", "guessedname": "CSS_PANEL", "guessedtype": "property", "type": "String", "final": ""}}, "description": "Panel is an implementation of Overlay that behaves like an OS window, \nwith a draggable header and an optional close icon at the top right."}, "YAHOO.util.KeyListener": {"name": "YAHOO.util.KeyListener", "knownissue": "the \"keypress\" event is completely broken in Safari 2.x and below.\nthe workaround is use \"keydown\" for key listening. However, if\nit is desired to prevent the default behavior of the keystroke,\nthat can only be done on the keypress event. This makes key\nhandling quite ugly.", "constructors": [{"params": [{"type": "HTMLElement", "name": "attachTo", "description": " The element or element ID to which the key \nevent should be attached"}, {"type": "String", "name": "attachTo", "description": " The element or element ID to which the key\nevent should be attached"}, {"type": "Object", "name": "keyData", "description": " The object literal representing the key(s) \nto detect. Possible attributes are \nshift(boolean), alt(boolean), ctrl(boolean) \nand keys(either an int or an array of ints \nrepresenting keycodes)."}, {"type": "Function", "name": "handler", "description": " The CustomEvent handler to fire when the \nkey event is detected"}, {"type": "Object", "name": "handler", "description": " An object literal representing the handler."}, {"type": "String", "name": "event", "description": " Optional. The event (keydown or keyup) to \nlisten for. Defaults automatically to keydown."}], "description": "KeyListener is a utility that provides an easy interface for listening for\nkeydown\/keyup events fired against DOM elements."}], "namespace": "YAHOO.util", "module": "event", "properties": {"YAHOO.util.KeyListener.KEYDOWN": {"description": "Constant representing the DOM \"keydown\" event.", "static": "", "guessedname": "KEYDOWN", "guessedtype": "property", "type": "String", "final": ""}, "YAHOO.util.KeyListener.KEYUP": {"description": "Constant representing the DOM \"keyup\" event.", "static": "", "guessedname": "KEYUP", "guessedtype": "property", "type": "String", "final": ""}, "enabled": {"type": "Boolean", "description": "Boolean indicating the enabled\/disabled state of the Tooltip", "guessedname": "enabled", "guessedtype": "property"}, "KEY": {"final": "", "static": "", "description": "keycode constants for a subset of the special keys", "guessedname": "KEY", "guessedtype": "property"}}, "guessedname": "KeyListener", "methods": {"handleKeyPress": {"params": [{"type": "DOMEvent", "name": "e", "description": " The keypress DOM event"}, {"type": "Object", "name": "obj", "description": " The DOM event scope object"}], "description": "Handles the key event when a key is pressed.", "private": ""}, "enable": {"description": "Enables the KeyListener by attaching the DOM event listeners to the \ntarget DOM element", "guessedname": "enable", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The string representation of the KeyListener"}, "description": "Returns a String representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "disable": {"description": "Disables the KeyListener by removing the DOM event listeners from the \ntarget DOM element", "guessedname": "disable", "guessedtype": "function"}}, "file": "KeyListener.js", "guessedtype": "function", "shortname": "KeyListener", "events": {"enabledEvent": {"params": [{"type": "Object", "name": "keyData", "description": " The object literal representing the key(s) to \ndetect. Possible attributes are shift(boolean), \nalt(boolean), ctrl(boolean) and keys(either an \nint or an array of ints representing keycodes)."}], "description": "The CustomEvent fired when the KeyListener is enabled via the enable() \nfunction", "guessedname": "enabledEvent", "guessedtype": "property"}, "disabledEvent": {"params": [{"type": "Object", "name": "keyData", "description": " The object literal representing the key(s) to \ndetect. Possible attributes are shift(boolean), \nalt(boolean), ctrl(boolean) and keys(either an \nint or an array of ints representing keycodes)."}], "description": "The CustomEvent fired when the KeyListener is disabled via the \ndisable() function", "guessedname": "disabledEvent", "guessedtype": "property"}, "keyEvent": {"guessedname": "keyEvent", "params": [{"type": "Object", "name": "keyData", "description": " The object literal representing the key(s) to \ndetect. Possible attributes are shift(boolean), \nalt(boolean), ctrl(boolean) and keys(either an \nint or an array of ints representing keycodes)."}], "description": "The CustomEvent fired internally when a key is pressed", "private": "", "guessedtype": "property"}}, "description": "KeyListener is a utility that provides an easy interface for listening for\nkeydown\/keyup events fired against DOM elements."}, "YAHOO.widget.Toolbar": {"name": "YAHOO.widget.Toolbar", "configs": {"disabled": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the toolbar should be disabled. It will also disable the draggable attribute if it is on."}, "grouplabels": {"default": "true", "type": "Boolean", "description": "Boolean indicating if the toolbar should show the group label's text string."}, "cont": {"type": "HTMLElement", "description": "The container for the toolbar."}, "collapse": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the the titlebar should have a collapse button.\nThe collapse button will not remove the toolbar, it will minimize it to the titlebar"}, "buttonType": {"type": "String", "description": "The buttonType to use (advanced or basic)"}, "buttons": {"type": "Array", "description": "Object specifying the buttons to include in the toolbar\nExample:\n

\n{\n{ id: 'b3', type: 'button', label: 'Underline', value: 'underline' },\n{ type: 'separator' },\n{ id: 'b4', type: 'menu', label: 'Align', value: 'align',\nmenu: [\n{ text: \"Left\", value: 'alignleft' },\n{ text: \"Center\", value: 'aligncenter' },\n{ text: \"Right\", value: 'alignright' }\n]\n}\n}\n<\/pre><\/code>"}, "draggable": {"default": "false", "type": "Boolean", "description": "Boolean indicating if the toolbar should be draggable."}, "titlebar": {"default": "false", "type": "Boolean or String", "description": "Boolean indicating if the toolbar should have a titlebar. If\npassed a string, it will use that as the titlebar text"}}, "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The element to turn into a toolbar."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "Provides a rich toolbar widget based on the button and menu widgets"}], "namespace": "YAHOO.widget", "module": "editor", "events": {"buttonsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "buttonsChange", "description": "Fires when the value for the configuration attribute 'buttons' changes."}, "beforeDraggableChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDraggableChange", "description": "Fires before the value for the configuration attribute 'draggable' changes. Return false to cancel the attribute change."}, "toolbarCollapsed": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the toolbar is collapsed via the collapse button. See Element.addListener<\/a> for more information on listening for this event."}, "grouplabelsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "grouplabelsChange", "description": "Fires when the value for the configuration attribute 'grouplabels' changes."}, "beforeTitlebarChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeTitlebarChange", "description": "Fires before the value for the configuration attribute 'titlebar' changes. Return false to cancel the attribute change."}, "beforeCollapseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "valueClick": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "Object", "name": "o", "description": " The object passed to this handler is the button config used to create the button."}], "description": "This is a special dynamic event that is created and dispatched based on the value property\nof the button config. See Element.addListener<\/a> for more information on listening for this event.\nExample:\n
\nbuttons : [\n{ type: 'button', value: 'test', value: 'testButton' }\n]<\/pre>\n<\/code>\nWith the valueClick event you could subscribe to this buttons click event with this:\ntbar.in('testButtonClick', function() { alert('test button clicked'); })"}, "buttonClick": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "Object", "name": "o", "description": " The object passed to this handler is the button config used to create the button."}], "description": "Fires when any botton receives a click event. Passes back a single object representing the buttons config object. See Element.addListener<\/a> for more information on listening for this event."}, "beforeDisabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "beforeButtonTypeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeButtonTypeChange", "description": "Fires before the value for the configuration attribute 'buttonType' changes. Return false to cancel the attribute change."}, "buttonTypeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "buttonTypeChange", "description": "Fires when the value for the configuration attribute 'buttonType' changes."}, "titlebarChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "titlebarChange", "description": "Fires when the value for the configuration attribute 'titlebar' changes."}, "toolbarExpanded": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the toolbar is expanded via the collapse button. See Element.addListener<\/a> for more information on listening for this event."}, "draggableChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "draggableChange", "description": "Fires when the value for the configuration attribute 'draggable' changes."}, "beforeButtonsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeButtonsChange", "description": "Fires before the value for the configuration attribute 'buttons' changes. Return false to cancel the attribute change."}, "beforeGrouplabelsChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeGrouplabelsChange", "description": "Fires before the value for the configuration attribute 'grouplabels' changes. Return false to cancel the attribute change."}, "disabledChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "collapseChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}}, "guessedname": "Toolbar", "methods": {"getButtons": {"return": {"type": "Array", "description": ""}, "description": "Returns an array of buttons in the current toolbar", "guessedname": "getButtons", "guessedtype": "function"}, "enableButton": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " Enable a button by it's id, index or value."}], "description": "Enables a button in the toolbar.", "guessedname": "enableButton", "guessedtype": "function"}, "destroyButton": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " Destroy a button by it's id or index."}], "description": "Destroy a button in the toolbar.", "guessedname": "destroyButton", "guessedtype": "function"}, "_navigateButtons": {"guessedname": "_navigateButtons", "params": [{"type": "Event", "name": "ev", "description": " The Key Event"}], "description": "Handles the navigation\/focus of toolbar buttons with the Arrow Keys", "private": "", "guessedtype": "function"}, "addButton": {"params": [{"type": "Object", "name": "oButton", "description": " Object literal reference to the Button's Config"}, {"type": "HTMLElement", "name": "after", "description": " Optional HTML element to insert this button after in the DOM."}], "description": "Add a new button to the toolbar. Buttons supported:\npush, split, menu, select, color, spin", "guessedname": "addButton", "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"}, "enableAllButtons": {"return": {"type": "Boolean", "description": ""}, "description": "Enables all buttons in the toolbar.", "guessedname": "enableAllButtons", "guessedtype": "function"}, "selectButton": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " Select a button by it's id, index or value."}, {"type": "String", "name": "value", "description": " If this is a Menu Button, check this item in the menu"}], "description": "Selects a button in the toolbar.", "guessedname": "selectButton", "guessedtype": "function"}, "_buttonClick": {"protected": "", "params": [{"type": "String", "name": "ev", "description": " The event that was passed in."}, {"type": "Object", "name": "info", "description": " Object literal of information about the button that was clicked."}], "description": "Click handler for all buttons in the toolbar.", "guessedname": "_buttonClick", "guessedtype": "function"}, "isSelected": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " A button by it's id, index or value."}], "description": "Tells if a button is selected or not.", "guessedname": "isSelected", "guessedtype": "function"}, "init": {"description": "The Toolbar class's initialization method", "guessedname": "init", "guessedtype": "function"}, "addButtonToGroup": {"params": [{"type": "Object", "name": "oButton", "description": " Object literal reference to the Button's Config"}, {"type": "String", "name": "group", "description": " The Group identifier passed into the initial config"}, {"type": "HTMLElement", "name": "after", "description": " Optional HTML element to insert this button after in the DOM."}], "description": "Add a new button to a toolbar group. Buttons supported:\npush, split, menu, select, color, spin", "guessedname": "addButtonToGroup", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the toolbar.", "guessedname": "toString", "guessedtype": "function"}, "_resetColorPicker": {"description": "Clears the currently selected color or mouseover color in the color picker.", "private": "", "guessedname": "_resetColorPicker", "guessedtype": "function"}, "destroy": {"return": {"type": "Boolean", "description": ""}, "description": "Destroys the toolbar, all of it's elements and objects.", "guessedname": "destroy", "guessedtype": "function"}, "_handleFocus": {"description": "Sets up the listeners for the arrow key navigation", "private": "", "guessedname": "_handleFocus", "guessedtype": "function"}, "collapse": {"params": [{"type": "Boolean", "name": "collapse", "description": " True to collapse, false to expand."}], "description": "Programatically collapse the toolbar.", "guessedname": "collapse", "guessedtype": "function"}, "addSeparator": {"params": [{"type": "HTMLElement", "name": "cont", "description": " Optional HTML element to insert this button into."}, {"type": "HTMLElement", "name": "after", "description": " Optional HTML element to insert this button after in the DOM."}], "description": "Add a new button separator to the toolbar.", "guessedname": "addSeparator", "guessedtype": "function"}, "getButtonByIndex": {"return": {"type": "YAHOO.widget.ToolbarButton<\/a>", "description": ""}, "params": [{"type": "Number", "name": "index", "description": " The index of the button in _buttonList."}], "description": "Gets a button instance from the toolbar by is index in _buttonList.", "guessedname": "getButtonByIndex", "guessedtype": "function"}, "getButtonById": {"return": {"type": "YAHOO.widget.ToolbarButton<\/a>", "description": ""}, "params": [{"type": "String", "name": "id", "description": " The Dom id to query for."}], "description": "Gets a button instance from the toolbar by is Dom id.", "guessedname": "getButtonById", "guessedtype": "function"}, "resetAllButtons": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "Object", "name": "_ex", "description": " Except these buttons"}], "description": "Resets all buttons to their initial state.", "guessedname": "resetAllButtons", "guessedtype": "function"}, "deselectAllButtons": {"return": {"type": "Boolean", "description": ""}, "description": "Deselects all buttons in the toolbar.", "guessedname": "deselectAllButtons", "guessedtype": "function"}, "disableButton": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " Disable a button by it's id, index or value."}], "description": "Disables a button in the toolbar.", "guessedname": "disableButton", "guessedtype": "function"}, "_addMenuClasses": {"params": [{"type": "String", "name": "ev", "description": " The event that fired."}, {"type": "Array", "name": "na", "description": " Array of event information."}, {"type": "Object", "name": "o", "description": " Button config object."}], "description": "This method is called from Menu's renderEvent to add a few more classes to the menu items", "private": ""}, "_makeSpinButton": {"guessedname": "_makeSpinButton", "params": [{"type": "Object", "name": "_button", "description": " YAHOO.widget.ToolbarButton<\/a> reference"}, {"type": "Object", "name": "oButton", "description": " Object literal containing the buttons initial config"}], "description": "Create a button similar to an OS Spin button.. It has an up\/down arrow combo to scroll through a range of int values.", "private": "", "guessedtype": "function"}, "deselectButton": {"return": {"type": "Boolean", "description": ""}, "params": [{"type": "String\/Number", "name": "id", "description": " Deselect a button by it's id, index or value."}], "description": "Deselects a button in the toolbar.", "guessedname": "deselectButton", "guessedtype": "function"}, "addButtonGroup": {"params": [{"type": "Object", "name": "oGroup", "description": " Object literal reference to the Groups Config (contains an array of button configs as well as the group label)"}], "description": "Add a new button group to the toolbar. (uses addButton)", "guessedname": "addButtonGroup", "guessedtype": "function"}, "_createColorPicker": {"guessedname": "_createColorPicker", "params": [{"type": "String", "name": "id", "description": " the id of the toolbar to prefix this DOM container with."}], "description": "Creates the core DOM reference to the color picker menu item.", "private": "", "guessedtype": "function"}, "_makeColorButton": {"guessedname": "_makeColorButton", "params": [{"type": "Object", "name": "_oButton", "description": " YAHOO.widget.ToolbarButton<\/a> reference"}], "description": "Called to turn a \"color\" button into a menu button with an Overlay for the menu.", "private": "", "guessedtype": "function"}, "disableAllButtons": {"return": {"type": "Boolean", "description": ""}, "description": "Disables all buttons in the toolbar.", "guessedname": "disableAllButtons", "guessedtype": "function"}, "getButtonByValue": {"return": {"type": "YAHOO.widget.ToolbarButton<\/a> or YAHOO.widget.MenuItem<\/a>", "description": ""}, "params": [{"type": "String", "name": "value", "description": " The button value to query for."}], "description": "Gets a button instance or a menuitem instance from the toolbar by it's value.", "guessedname": "getButtonByValue", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "toolbar.js", "guessedtype": "function", "shortname": "Toolbar", "properties": {"STR_SPIN_LABEL": {"type": "String", "description": "String for spinbutton dynamic label. Note the {VALUE} will be replaced with YAHOO.lang.substitute", "guessedname": "STR_SPIN_LABEL", "guessedtype": "property"}, "_toolbarConfigs": {"protected": "", "type": "Object", "guessedname": "_toolbarConfigs", "guessedtype": "property"}, "STR_SPIN_UP": {"type": "String", "description": "String for spinbutton up", "guessedname": "STR_SPIN_UP", "guessedtype": "property"}, "_buttonList": {"protected": "", "type": "Array", "description": "Internal property list of current buttons in the toolbar", "guessedname": "_buttonList", "guessedtype": "property"}, "_colorPicker": {"type": "HTMLElement", "description": "The HTML Element containing the colorPicker", "guessedname": "_colorPicker", "guessedtype": "property"}, "STR_COLLAPSE": {"type": "String", "description": "String for Toolbar Collapse Button", "guessedname": "STR_COLLAPSE", "guessedtype": "property"}, "_navCounter": {"guessedname": "_navCounter", "type": "Number", "description": "Internal counter for walking the buttons in the toolbar with the arrow keys", "private": "", "guessedtype": "property"}, "CLASS_PREFIX": {"protected": "", "type": "String", "description": "Default prefix for dynamically created class names", "guessedname": "CLASS_PREFIX", "guessedtype": "property"}, "CLASS_DRAGHANDLE": {"protected": "", "type": "String", "description": "Default CSS class to apply to the toolbar's drag handle element", "guessedname": "CLASS_DRAGHANDLE", "guessedtype": "property"}, "_colorData": {"type": "Object", "description": "Object reference containing colors hex and text values.", "guessedname": "_colorData", "guessedtype": "property"}, "_sepCount": {"protected": "", "type": "Number", "description": "Internal refernce for counting separators, so we can give them a useful class name for styling", "guessedname": "_sepCount", "guessedtype": "property"}, "dd": {"type": "Object", "description": "The DragDrop instance associated with the Toolbar", "guessedname": "dd", "guessedtype": "property"}, "_keyNav": {"guessedname": "_keyNav", "type": "Boolean", "description": "Flag to determine if the arrow nav listeners have been attached", "private": "", "guessedtype": "property"}, "_titlebar": {"type": "HTMLElement", "description": "Object reference to the titlebar", "guessedname": "_titlebar", "guessedtype": "property"}, "CLASS_CONTAINER": {"protected": "", "type": "String", "description": "Default CSS class to apply to the toolbar container element", "guessedname": "CLASS_CONTAINER", "guessedtype": "property"}, "_buttonGroupList": {"protected": "", "type": "Array", "description": "Internal property list of current button groups in the toolbar", "guessedname": "_buttonGroupList", "guessedtype": "property"}, "CLASS_DISABLED": {"protected": "", "type": "String", "description": "Default CSS class to apply when the toolbar is disabled", "guessedname": "CLASS_DISABLED", "guessedtype": "property"}, "buttonType": {"type": "Object", "description": "The default button to use", "guessedname": "buttonType", "guessedtype": "property"}, "_sep": {"protected": "", "type": "HTMLElement", "description": "Internal reference to the separator HTML Element for cloning", "guessedname": "_sep", "guessedtype": "property"}, "STR_SPIN_DOWN": {"type": "String", "description": "String for spinbutton down", "guessedname": "STR_SPIN_DOWN", "guessedtype": "property"}, "CLASS_SEPARATOR": {"protected": "", "type": "String", "description": "Default CSS class to apply to all separators in the toolbar", "guessedname": "CLASS_SEPARATOR", "guessedtype": "property"}, "draghandle": {"protected": "", "type": "HTMLElement", "guessedname": "_dragHandle", "guessedtype": "property"}, "browser": {"type": "Object", "description": "Standard browser detection", "guessedname": "browser", "guessedtype": "property"}}, "description": "Provides a rich toolbar widget based on the button and menu widgets"}, "YAHOO.widget.PieChart": {"name": "YAHOO.widget.PieChart", "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": "PieChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "events": {"beforeDataFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDataFieldChange", "description": "Fires before the value for the configuration attribute 'dataField' changes. Return false to cancel the attribute change."}, "dataFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "dataFieldChange", "description": "Fires when the value for the configuration attribute 'dataField' changes."}, "beforeCategoryFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeCategoryFieldChange", "description": "Fires before the value for the configuration attribute 'categoryField' changes. Return false to cancel the attribute change."}, "categoryFieldChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "categoryFieldChange", "description": "Fires when the value for the configuration attribute 'categoryField' changes."}}, "guessedname": "PieChart", "methods": {"_setDataField": {"private": "", "description": "Setter for the dataField attribute.", "guessedname": "_setDataField", "guessedtype": "function"}, "_setCategoryField": {"private": "", "description": "Setter for the categoryField attribute.", "guessedname": "_setCategoryField", "guessedtype": "function"}, "_getCategoryField": {"private": "", "description": "Getter for the categoryField attribute.", "guessedname": "_getCategoryField", "guessedtype": "function"}, "_initAttributes": {"private": "", "description": "Initializes the attributes.", "guessedname": "_initAttributes", "guessedtype": "function"}, "_getDataField": {"private": "", "description": "Getter for the dataField attribute.", "guessedname": "_getDataField", "guessedtype": "function"}}, "uses": ["YAHOO.widget.CartesianChart"], "file": "PieChart.js", "guessedtype": "function", "shortname": "PieChart", "configs": {"categoryField": {"type": "String", "description": "The field in each item that corresponds to the category value."}, "dataField": {"type": "String", "description": "The field in each item that corresponds to the data value."}}, "description": "PieChart class for the YUI Charts widget."}, "YAHOO.util.Resize": {"name": "YAHOO.util.Resize", "configs": {"maxX": {"type": "Number", "description": "The max x coord of the element"}, "maxY": {"type": "Number", "description": "The max y coord of the element"}, "maxWidth": {"type": "Number", "description": "The maximum width of the element"}, "animateEasing": {"type": "Object", "description": "The Easing to apply to the animation."}, "height": {"type": "Number", "description": "The height of the element"}, "yTicks": {"type": "Number or False", "description": "The number of y ticks to span the resize to."}, "wrap": {"type": "Boolean", "description": "Should we wrap the element"}, "animate": {"type": "Boolean", "description": "Should be use animation to resize the element (can only be used if we use proxy)."}, "knobHandles": {"type": "Boolean", "description": "Use the smaller handles, instead if the full size handles."}, "minWidth": {"type": "Number", "description": "The minimum width of the element"}, "ratio": {"type": "Boolean", "description": "Maintain the element's ratio when resizing."}, "width": {"type": "Number", "description": "The width of the element"}, "minX": {"type": "Number", "description": "The minimum x coord of the element"}, "minY": {"type": "Number", "description": "The minimum y coord of the element"}, "handles": {"type": "Array", "description": "The handles to use (any combination of): 't', 'b', 'r', 'l', 'bl', 'br', 'tl', 'tr'. Defaults to: ['r', 'b', 'br'].\nCan use a shortcut of All. Note: 8 way resizing should be done on an element that is absolutely positioned."}, "status": {"type": "Boolean", "description": "Show the status (new size) of the resize."}, "hover": {"type": "Boolean", "description": "Only show the handles when they are being moused over."}, "minHeight": {"type": "Number", "description": "The minimum height of the element"}, "xTicks": {"type": "Number or False", "description": "The number of x ticks to span the resize to."}, "proxy": {"type": "Boolean", "description": "Resize a proxy element instead of the real element."}, "hiddenHandles": {"type": "Boolean", "description": "Don't show the handles, just use the cursor to the user."}, "animateDuration": {"type": "Number", "description": "The Duration to apply to the animation."}, "ghost": {"type": "Boolean", "description": "Apply an opacity filter to the element being resized (only works with proxy)."}, "maxHeight": {"type": "Number", "description": "The maximum height of the element"}, "autoRatio": {"type": "Boolean", "description": "Using the shift key during a resize will toggle the ratio config."}, "draggable": {"type": "Boolean", "description": "A convienence method to make the element draggable"}, "setSize": {"type": "Boolean", "description": "Set the size of the resized element, if set to false the element will not be auto resized,\nthe resize event will contain the dimensions so the end user can resize it on their own.\nThis setting will only work with proxy set to true and animate set to false."}}, "constructors": [{"params": [{"type": "String\/HTMLElement", "name": "el", "description": " The element to make resizable."}, {"type": "Object", "name": "attrs", "description": " Object liternal containing configuration parameters."}], "description": "

Makes an element resizable<\/p>"}], "namespace": "YAHOO.util", "module": "resize", "events": {"beforeXTicksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeXTicksChange", "description": "Fires before the value for the configuration attribute 'xTicks' changes. Return false to cancel the attribute change."}, "proxyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "beforeAutoRatioChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeAutoRatioChange", "description": "Fires before the value for the configuration attribute 'autoRatio' changes. Return false to cancel the attribute change."}, "beforeGhostChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeGhostChange", "description": "Fires before the value for the configuration attribute 'ghost' changes. Return false to cancel the attribute change."}, "heightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "beforeProxyChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "beforeAnimateEasingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeAnimateEasingChange", "description": "Fires before the value for the configuration attribute 'animateEasing' changes. Return false to cancel the attribute change."}, "beforeMaxHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "minYChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "minYChange", "description": "Fires when the value for the configuration attribute 'minY' changes."}, "maxWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "maxYChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "maxYChange", "description": "Fires when the value for the configuration attribute 'maxY' changes."}, "ratioChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "ratioChange", "description": "Fires when the value for the configuration attribute 'ratio' changes."}, "animateDurationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "animateDurationChange", "description": "Fires when the value for the configuration attribute 'animateDuration' changes."}, "beforeRatioChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeRatioChange", "description": "Fires before the value for the configuration attribute 'ratio' changes. Return false to cancel the attribute change."}, "autoRatioChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "autoRatioChange", "description": "Fires when the value for the configuration attribute 'autoRatio' changes."}, "beforeHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "proxyResize": {"type": "YAHOO.util.CustomEvent", "description": "Fires on every proxy resize (only fires when used with proxy config setting)."}, "beforeHiddenHandlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeHiddenHandlesChange", "description": "Fires before the value for the configuration attribute 'hiddenHandles' changes. Return false to cancel the attribute change."}, "beforeMinWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "setSizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "setSizeChange", "description": "Fires when the value for the configuration attribute 'setSize' changes."}, "statusChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "statusChange", "description": "Fires when the value for the configuration attribute 'status' changes."}, "beforeMinHeightChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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": "eventInfo", "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."}, "beforeStatusChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeStatusChange", "description": "Fires before the value for the configuration attribute 'status' changes. Return false to cancel the attribute change."}, "beforeWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "hoverChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "draggableChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "draggableChange", "description": "Fires when the value for the configuration attribute 'draggable' changes."}, "beforeMaxXChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeMaxXChange", "description": "Fires before the value for the configuration attribute 'maxX' changes. Return false to cancel the attribute change."}, "minWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "beforeKnobHandlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeKnobHandlesChange", "description": "Fires before the value for the configuration attribute 'knobHandles' changes. Return false to cancel the attribute change."}, "ghostChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "ghostChange", "description": "Fires when the value for the configuration attribute 'ghost' changes."}, "hiddenHandlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "hiddenHandlesChange", "description": "Fires when the value for the configuration attribute 'hiddenHandles' changes."}, "xTicksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "xTicksChange", "description": "Fires when the value for the configuration attribute 'xTicks' changes."}, "startResize": {"type": "YAHOO.util.CustomEvent", "description": "Fires when when a resize action is started."}, "beforeHandlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeHandlesChange", "description": "Fires before the value for the configuration attribute 'handles' changes. Return false to cancel the attribute change."}, "animateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "beforeAnimateDurationChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeAnimateDurationChange", "description": "Fires before the value for the configuration attribute 'animateDuration' changes. Return false to cancel the attribute change."}, "dragEvent": {"type": "YAHOO.util.CustomEvent", "description": "Fires when the YAHOO.util.DragDrop<\/a> dragEvent is fired for the config option draggable."}, "beforeMinYChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeMinYChange", "description": "Fires before the value for the configuration attribute 'minY' changes. Return false to cancel the attribute change."}, "beforeWrapChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "beforeMinXChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeMinXChange", "description": "Fires before the value for the configuration attribute 'minX' changes. Return false to cancel the attribute change."}, "beforeDraggableChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeDraggableChange", "description": "Fires before the value for the configuration attribute 'draggable' changes. Return false to cancel the attribute change."}, "knobHandlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "knobHandlesChange", "description": "Fires when the value for the configuration attribute 'knobHandles' changes."}, "beforeResize": {"type": "YAHOO.util.CustomEvent", "description": "Fires before every element resize after the size calculations, returning false will stop the resize."}, "resize": {"type": "YAHOO.util.CustomEvent", "description": "Fires on every element resize (only fires once when used with proxy config setting)."}, "beforeSetSizeChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeSetSizeChange", "description": "Fires before the value for the configuration attribute 'setSize' changes. Return false to cancel the attribute change."}, "beforeAnimateChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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": "eventInfo", "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."}, "beforeHoverChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "beforeMaxWidthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current 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."}, "animateEasingChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "animateEasingChange", "description": "Fires when the value for the configuration attribute 'animateEasing' changes."}, "yTicksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "yTicksChange", "description": "Fires when the value for the configuration attribute 'yTicks' changes."}, "beforeMaxYChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeMaxYChange", "description": "Fires before the value for the configuration attribute 'maxY' changes. Return false to cancel the attribute change."}, "wrapChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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."}, "maxXChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "maxXChange", "description": "Fires when the value for the configuration attribute 'maxX' changes."}, "handlesChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "handlesChange", "description": "Fires when the value for the configuration attribute 'handles' changes."}, "beforeYTicksChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the current attribute value and the new value."}], "name": "beforeYTicksChange", "description": "Fires before the value for the configuration attribute 'yTicks' changes. Return false to cancel the attribute change."}, "minXChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "description": "An object containing the previous attribute value and the new value."}], "name": "minXChange", "description": "Fires when the value for the configuration attribute 'minX' changes."}, "widthChange": {"params": [{"type": "{oldValue: any, newValue: any}", "name": "eventInfo", "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": "Resize", "methods": {"_handle_for_bl": {"guessedname": "_handle_for_bl", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Bottom Left handle.", "private": "", "guessedtype": "function"}, "_setHeight": {"return": {"type": "Number", "description": "The new value"}, "description": "Calculated the height based on the mouse event.", "private": "", "params": [{"type": "Event", "name": "ev", "description": " The mouse event."}, {"type": "Boolean", "name": "flip", "description": " Argument to determine the direction of the movement."}], "guessedname": "_setHeight", "guessedtype": "function"}, "_handleStartDrag": {"guessedname": "_handleStartDrag", "params": [{"type": "Object", "name": "args", "description": " The args passed from the CustomEvent."}, {"type": "Object", "name": "dd", "description": " The YAHOO.util.DragDrop<\/a> object we are working with."}], "description": "Resizes the proxy, sets up the YAHOO.util.DragDrop<\/a> handlers, updates the status div and preps the cache", "private": "", "guessedtype": "function"}, "getProxyEl": {"return": {"type": "HTMLElement", "description": "The proxy element"}, "description": "Get the HTML reference for the proxy, returns null if no proxy.", "guessedname": "getProxyEl", "guessedtype": "function"}, "_handle_for_tl": {"guessedname": "_handle_for_tl", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Top Left handle.", "private": "", "guessedtype": "function"}, "_snapTick": {"return": {"type": "Number", "description": "the new snapped position"}, "description": "Adjusts the number based on the ticks used.", "private": "", "params": [{"type": "Number", "name": "size", "description": " The size to tick against."}, {"type": "Number", "name": "pix", "description": " The tick pixels."}], "guessedname": "_snapTick", "guessedtype": "function"}, "initAttributes": {"guessedname": "initAttributes", "params": [{"type": "Object", "name": "attr", "description": " Object literal specifying a set of \nconfiguration attributes used to create the utility."}], "description": "Initializes all of the configuration attributes used to create a resizable element.", "private": "", "guessedtype": "function"}, "_handle_for_tr": {"guessedname": "_handle_for_tr", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Top Right handle.", "private": "", "guessedtype": "function"}, "_handle_for_br": {"guessedname": "_handle_for_br", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Bottom Right handle.", "private": "", "guessedtype": "function"}, "getResizeById": {"static": "", "return": {"type": "Object", "description": "The Resize Object"}, "description": "Get's a resize object by the HTML id of the element associated with the Resize object.", "guessedname": "getResizeById", "guessedtype": "function"}, "_createProxy": {"description": "Creates the proxy element if the proxy config is true", "private": "", "guessedname": "_createProxy", "guessedtype": "function"}, "_setCache": {"description": "Sets up the this._cache hash table.", "private": "", "guessedname": "_setCache", "guessedtype": "function"}, "init": {"description": "The Resize class's initialization method", "private": "", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": ""}, "description": "Returns a string representing the Resize Object.", "guessedname": "toString", "guessedtype": "function"}, "_createHandles": {"description": "Creates the handles as specified in the config", "private": "", "guessedname": "_createHandles", "guessedtype": "function"}, "destroy": {"description": "Destroys the resize object and all of it's elements & listeners.", "guessedname": "destroy", "guessedtype": "function"}, "_setAutoRatio": {"guessedname": "_setAutoRatio", "params": [{"type": "Event", "name": "ev", "description": " A mouse event."}], "description": "This method checks to see if the \"autoRatio\" config is set. If it is, we will check to see if the \"Shift Key\" is pressed. If so, we will set the config ratio to true.", "private": "", "guessedtype": "function"}, "_ieSelectFix": {"description": "The function we use as the onselectstart handler when we start a drag in Internet Explorer", "private": "", "guessedname": "_ieSelectFix", "guessedtype": "function"}, "_checkWidth": {"return": {"type": "Number", "description": "the new value"}, "description": "Checks the value passed against the maxWidth and minWidth.", "private": "", "params": [{"type": "Number", "name": "w", "description": " The width to check."}], "guessedname": "_checkWidth", "guessedtype": "function"}, "_handleMouseDown": {"guessedname": "_handleMouseDown", "params": [{"type": "Event", "name": "ev", "description": " A mouse event."}], "description": "This method preps the autoRatio on MouseDown.", "private": "", "guessedtype": "function"}, "_createWrap": {"description": "Creates the wrap element if the wrap config is true. It will auto wrap the following element types: img, textarea, input, iframe, select", "private": "", "guessedname": "_createWrap", "guessedtype": "function"}, "getStatusEl": {"return": {"type": "HTMLElement", "description": "The status element"}, "description": "Get the HTML reference for the status element.", "guessedname": "getStatusEl", "guessedtype": "function"}, "getWrapEl": {"return": {"type": "HTMLElement", "description": "The wrap element"}, "description": "Get the HTML reference for the wrap element, returns the current element if not wrapped.", "guessedname": "getWrapEl", "guessedtype": "function"}, "_setupDragDrop": {"description": "Setup the YAHOO.util.DragDrop<\/a> instance on the element", "private": "", "guessedname": "_setupDragDrop", "guessedtype": "function"}, "_handleMouseOver": {"guessedname": "_handleMouseOver", "params": [{"type": "Event", "name": "ev", "description": " A mouse event."}], "description": "Adds CSS class names to the handles", "private": "", "guessedtype": "function"}, "resize": {"return": {"type": "YAHOO.util.Resize<\/a>", "description": "The Resize instance"}, "params": [{"type": "Event", "name": "ev", "description": " The mouse event."}, {"type": "Number", "name": "h", "description": " The new height setting."}, {"type": "Number", "name": "w", "description": " The new width setting."}, {"type": "Number", "name": "t", "description": " The new top setting."}, {"type": "Number", "name": "l", "description": " The new left setting."}, {"type": "Boolean", "name": "force", "description": " Resize the element (used for proxy resize)."}, {"type": "Boolean", "name": "silent", "description": " Don't fire the beforeResize Event."}], "description": "Resizes the element, wrapper or proxy based on the data from the handlers.", "guessedname": "resize", "guessedtype": "function"}, "_handleMouseUp": {"guessedname": "_handleMouseUp", "params": [{"type": "Event", "name": "ev", "description": " A mouse event."}], "description": "Cleans up listeners, hides proxy element and removes class names.", "private": "", "guessedtype": "function"}, "reset": {"return": {"type": "YAHOO.util.Resize<\/a>", "description": "The Resize instance"}, "description": "Resets the element to is start state.", "guessedname": "reset", "guessedtype": "function"}, "_setRatio": {"return": {"type": "Array", "description": "The new Height, Width, Top & Left settings"}, "description": "Using the Height, Width, Top & Left, it recalcuates them based on the original element size.", "private": "", "params": [{"type": "Number", "name": "h", "description": " The height offset."}, {"type": "Number", "name": "w", "description": " The with offset."}, {"type": "Number", "name": "t", "description": " The top offset."}, {"type": "Number", "name": "l", "description": " The left offset."}], "guessedname": "_setRatio", "guessedtype": "function"}, "_setWidth": {"return": {"type": "Number", "description": "The new value"}, "description": "Calculates the width based on the mouse event.", "private": "", "params": [{"type": "Event", "name": "ev", "description": " The mouse event."}, {"type": "Boolean", "name": "flip", "description": " Argument to determine the direction of the movement."}], "guessedname": "_setWidth", "guessedtype": "function"}, "_checkHeight": {"return": {"type": "Number", "description": "The new value"}, "description": "Checks the value passed against the maxHeight and minHeight.", "private": "", "params": [{"type": "Number", "name": "h", "description": " The height to check."}], "guessedname": "_checkHeight", "guessedtype": "function"}, "getActiveHandleEl": {"return": {"type": "HTMLElement", "description": "The handle element that is active"}, "description": "Get the HTML reference for the currently active resize handle.", "guessedname": "getActiveHandleEl", "guessedtype": "function"}, "_handle_for_r": {"guessedname": "_handle_for_r", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Right handle.", "private": "", "guessedtype": "function"}, "_handle_for_t": {"guessedname": "_handle_for_t", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Top handle.", "private": "", "guessedtype": "function"}, "_updateStatus": {"guessedname": "_updateStatus", "params": [{"type": "Number", "name": "h", "description": " The new height setting."}, {"type": "Number", "name": "w", "description": " The new width setting."}, {"type": "Number", "name": "t", "description": " The new top setting."}, {"type": "Number", "name": "l", "description": " The new left setting."}], "description": "Using the Height, Width, Top & Left, it updates the status element with the elements sizes.", "private": "", "guessedtype": "function"}, "isActive": {"return": {"type": "Boolean", "description": ""}, "description": "Returns true or false if a resize operation is currently active on the element.", "guessedname": "isActive", "guessedtype": "function"}, "_handle_for_l": {"guessedname": "_handle_for_l", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Left handle.", "private": "", "guessedtype": "function"}, "_handleMouseOut": {"guessedname": "_handleMouseOut", "params": [{"type": "Event", "name": "ev", "description": " A mouse event."}], "description": "Removes CSS class names to the handles", "private": "", "guessedtype": "function"}, "_handle_for_b": {"guessedname": "_handle_for_b", "params": [{"type": "Object", "name": "args", "description": " The arguments from the CustomEvent."}], "description": "Handles the sizes for the Bottom handle.", "private": "", "guessedtype": "function"}}, "extends": "YAHOO.util.Element", "superclass": "YAHOO.util.Element", "file": "resize.js", "guessedtype": "function", "shortname": "Resize", "properties": {"CSS_RESIZING": {"guessedname": "CSS_RESIZING", "type": "String", "description": "Class name given to the wrap element when a resize action is taking place.", "private": "", "guessedtype": "property"}, "_cache": {"guessedname": "_cache", "type": "Object", "description": "An lookup table containing key information for the element being resized. e.g. height, width, x position, y position, etc..", "private": "", "guessedtype": "property"}, "_dds": {"guessedname": "_dds", "type": "Object", "description": "An Object containing references to all of the YAHOO.util.DragDrop<\/a> instances used for the resize handles", "private": "", "guessedtype": "property"}, "CSS_HIDDEN": {"guessedname": "CSS_HIDDEN", "type": "String", "description": "Class name given to the wrap element to make all handles hidden", "private": "", "guessedtype": "property"}, "_handles": {"guessedname": "_handles", "type": "Object", "description": "An object containing references to all of the resize handles.", "private": "", "guessedtype": "property"}, "_ieSelectBack": {"private": "", "description": "We will hold a copy of the current \"onselectstart\" method on this property, and reset it after we are done using it.", "guessedname": "_ieSelectBack", "guessedtype": "property"}, "CSS_STATUS": {"guessedname": "CSS_STATUS", "type": "String", "description": "Class name given to the status element", "private": "", "guessedtype": "property"}, "CSS_RESIZE": {"guessedname": "CSS_RESIZE", "type": "String", "description": "Base CSS class name", "private": "", "guessedtype": "property"}, "CSS_WRAP": {"guessedname": "CSS_WRAP", "type": "String", "description": "Class name given to the wrap element", "private": "", "guessedtype": "property"}, "_instances": {"description": "Internal hash table for all resize instances", "private": "", "static": "", "guessedname": "_instances", "guessedtype": "property", "type": "Object"}, "CSS_DRAG": {"guessedname": "CSS_DRAG", "type": "String", "description": "Class name added when dragging is enabled", "private": "", "guessedtype": "property"}, "_resizeEvent": {"guessedname": "_resizeEvent", "type": "Event", "description": "The mouse event used to resize with", "private": "", "guessedtype": "property"}, "_proxy": {"guessedname": "_proxy", "type": "HTMLElement", "description": "The HTML reference of the element proxy", "private": "", "guessedtype": "property"}, "dd": {"guessedname": "dd", "type": "Object", "description": "The YAHOO.util.DragDrop<\/a> instance used if draggable is true", "private": "", "guessedtype": "property"}, "CSS_HANDLE": {"guessedname": "CSS_HANDLE", "type": "String", "description": "Class name given to all handles, used as a base for single handle names as well.. Handle \"t\" will get this.CSS_HANDLE + '-t' as well as this.CSS_HANDLE", "private": "", "guessedtype": "property"}, "CSS_PROXY": {"guessedname": "CSS_PROXY", "type": "String", "description": "Class name given to the proxy element", "private": "", "guessedtype": "property"}, "CSS_GHOST": {"guessedname": "CSS_GHOST", "type": "String", "description": "Class name given to the wrap element when the ghost property is active", "private": "", "guessedtype": "property"}, "CSS_HOVER": {"guessedname": "CSS_HOVER", "type": "String", "description": "Class name used for hover only handles", "private": "", "guessedtype": "property"}, "_positioned": {"guessedname": "_positioned", "type": "Boolean", "description": "A flag to show if the element is absolutely positioned", "private": "", "guessedtype": "property"}, "_currentHandle": {"guessedname": "_currentHandle", "type": "String", "description": "The string identifier of the currently active handle. e.g. 'r', 'br', 'tl'", "private": "", "guessedtype": "property"}, "_active": {"guessedname": "_active", "type": "Boolean", "description": "Flag to show if the resize is active. Used for events.", "private": "", "guessedtype": "property"}, "CSS_KNOB": {"guessedname": "CSS_KNOB", "type": "String", "description": "Class name used to make the knob style handles", "private": "", "guessedtype": "property"}, "_wrap": {"guessedname": "_wrap", "type": "HTMLElement", "description": "The HTML reference of the element wrapper", "private": "", "guessedtype": "property"}, "_currentDD": {"guessedname": "_currentDD", "type": "Object", "description": "A link to the currently active DD object", "private": "", "guessedtype": "property"}, "browser": {"guessedname": "browser", "type": "Object", "description": "A copy of the YAHOO.env.ua property", "private": "", "guessedtype": "property"}}, "description": "

Makes an element resizable<\/p>"}, "YAHOO.util.Config": {"name": "YAHOO.util.Config", "constructors": [{"params": [{"type": "Object", "name": "owner", "description": " The owner Object to which this Config Object belongs"}], "description": "Config is a utility used within an Object to allow the implementer to\nmaintain a list of local configuration properties and listen for changes \nto those properties dynamically using CustomEvent. The initial values are \nalso maintained so that the configuration can be reset at any given point \nto its initial state."}], "namespace": "YAHOO.util", "module": "container", "events": {"configChangedEvent": {"description": "Custom Event, notifying subscribers when Config properties are set \n(setProperty is called without the silent flag", "guessedname": "configChangedEvent", "guessedtype": "property"}}, "guessedname": "Config", "methods": {"fireQueue": {"description": "Fires the normalized list of queued property change events", "guessedname": "fireQueue", "guessedtype": "function"}, "YAHOO.util.Config.alreadySubscribed": {"return": {"type": "Boolean", "description": "true, if the function\/Object pair is already subscribed \nto the CustomEvent passed in"}, "description": "Checks to determine if a particular function\/Object pair are already \nsubscribed to the specified CustomEvent", "static": "", "guessedname": "alreadySubscribed", "guessedtype": "function", "params": [{"type": "YAHOO.util.CustomEvent", "name": "evt", "description": " The CustomEvent for which to check \nthe subscriptions"}, {"type": "Function", "name": "fn", "description": " The function to look for in the subscribers list"}, {"type": "Object", "name": "obj", "description": " The execution scope Object for the subscription"}]}, "getProperty": {"return": {"type": "Object", "description": "The value of the specified property"}, "params": [{"type": "String", "name": "key", "description": " The name of the property"}], "description": "Returns the value of specified property.", "guessedname": "getProperty", "guessedtype": "function"}, "addProperty": {"params": [{"type": "String", "name": "key", "description": " The configuration property's name"}, {"type": "Object", "name": "propertyObject", "description": " The Object containing all of this \nproperty's arguments"}], "description": "Adds a property to the Config Object's private config hash.", "guessedname": "addProperty", "guessedtype": "function"}, "queueProperty": {"return": {"type": "Boolean", "description": "true, if the set was successful, false if \nit failed."}, "params": [{"type": "String", "name": "key", "description": " The name of the property"}, {"type": "String", "name": "value", "description": " The value to set the property to"}], "description": "Sets the value of a property and queues its event to execute. If the \nevent is already scheduled to execute, it is\nmoved from its current position to the end of the queue.", "guessedname": "queueProperty", "guessedtype": "function"}, "checkNumber": {"return": {"type": "Boolean", "description": "true, if the value is valid"}, "params": [{"type": "Object", "name": "val", "description": " The value to validate"}], "description": "Validates that the value passed in is a number.", "guessedname": "checkNumber", "guessedtype": "function"}, "outputEventQueue": {"return": {"type": "String", "description": "The string list of CustomEvents currently queued \nfor execution"}, "description": "Returns a string representation of the Config object's current \nCustomEvent queue", "guessedname": "outputEventQueue", "guessedtype": "function"}, "resetProperty": {"return": {"type": "Boolean", "description": "True is the property was reset, false if not"}, "params": [{"type": "String", "name": "key", "description": " The name of the property"}], "description": "Resets the specified property's value to its initial value.", "guessedname": "resetProperty", "guessedtype": "function"}, "applyConfig": {"params": [{"type": "Object", "name": "userConfig", "description": " The configuration Object literal"}, {"type": "Boolean", "name": "init", "description": " When set to true, the initialConfig will \nbe set to the userConfig passed in, so that calling a reset will \nreset the properties to the passed values."}], "description": "Applies a key-value Object literal to the configuration, replacing \nany existing values, and queueing the property events.\nAlthough the values will be set, fireQueue() must be called for their \nassociated events to execute.", "guessedname": "applyConfig", "guessedtype": "function"}, "refresh": {"description": "Refires the events for all configuration properties using their \ncurrent values.", "guessedname": "refresh", "guessedtype": "function"}, "subscribeToConfigEvent": {"return": {"type": "Boolean", "description": "True, if the subscription was successful, \notherwise false."}, "params": [{"type": "String", "name": "key", "description": " The property name"}, {"type": "Function", "name": "handler", "description": " The handler function to use subscribe to \nthe property's event"}, {"type": "Object", "name": "obj", "description": " The Object to use for scoping the event handler \n(see CustomEvent documentation)"}, {"type": "Boolean", "name": "override", "description": " Optional. If true, will override \"this\" \nwithin the handler to map to the scope Object passed into the method."}], "description": "Subscribes an external handler to the change event for any \ngiven property.", "guessedname": "subscribeToConfigEvent", "guessedtype": "function"}, "checkBoolean": {"return": {"type": "Boolean", "description": "true, if the value is valid"}, "params": [{"type": "Object", "name": "val", "description": " The value to validate"}], "description": "Validates that the value passed in is a Boolean.", "guessedname": "checkBoolean", "guessedtype": "function"}, "init": {"params": [{"type": "Object", "name": "owner", "description": " The owner Object to which this Config \nObject belongs"}], "description": "Initializes the configuration Object and all of its local members.", "guessedname": "init", "guessedtype": "function"}, "toString": {"return": {"type": "String", "description": "The Config object in string format."}, "description": "Returns a string representation of the Config object", "guessedname": "toString", "guessedtype": "function"}, "refireEvent": {"params": [{"type": "String", "name": "key", "description": " The name of the property"}], "description": "Fires the event for a property using the property's current value.", "guessedname": "refireEvent", "guessedtype": "function"}, "getConfig": {"return": {"type": "Object", "description": "The current config, represented in a key-value map"}, "description": "Returns a key-value configuration map of the values currently set in \nthe Config Object.", "guessedname": "getConfig", "guessedtype": "function"}, "setProperty": {"return": {"type": "Boolean", "description": "True, if the set was successful, false if it failed."}, "params": [{"type": "String", "name": "key", "description": " The name of the property"}, {"type": "String", "name": "value", "description": " The value to set the property to"}, {"type": "Boolean", "name": "silent", "description": " Whether the value should be set silently, \nwithout firing the property event."}], "description": "Sets the value of a property. If the silent property is passed as \ntrue, the property's event will not be fired.", "guessedname": "setProperty", "guessedtype": "function"}, "destroy": {"description": "Sets all properties to null, unsubscribes all listeners from each \nproperty's change event and all listeners from the configChangedEvent.", "guessedname": "destroy", "guessedtype": "function"}, "fireEvent": {"guessedname": "fireEvent", "params": [{"type": "String", "name": "key", "description": " The configuration property's name"}, {"type": "value", "name": "Object", "description": " The value of the correct type for the property"}], "description": "Fires a configuration property event using the specified value.", "private": "", "guessedtype": "function"}, "unsubscribeFromConfigEvent": {"return": {"type": "Boolean", "description": "True, if the unsubscription was successful, \notherwise false."}, "params": [{"type": "String", "name": "key", "description": " The property name"}, {"type": "Function", "name": "handler", "description": " The handler function to use subscribe to \nthe property's event"}, {"type": "Object", "name": "obj", "description": " The Object to use for scoping the event \nhandler (see CustomEvent documentation)"}], "description": "Unsubscribes an external handler from the change event for any \ngiven property.", "guessedname": "unsubscribeFromConfigEvent", "guessedtype": "function"}}, "file": "Config.js", "guessedtype": "function", "shortname": "Config", "properties": {"YAHOO.util.Config.CONFIG_CHANGED_EVENT": {"description": "Constant representing the CustomEvent type for the config changed event.", "private": "", "static": "", "guessedname": "CONFIG_CHANGED_EVENT", "guessedtype": "property", "final": ""}, "eventQueue": {"guessedname": "eventQueue", "type": "Object", "description": "Maintains the local, normalized CustomEvent queue", "private": "", "guessedtype": "property"}, "owner": {"type": "Object", "description": "Object reference to the owner of this Config Object", "guessedname": "owner", "guessedtype": "property"}, "queueInProgress": {"type": "Boolean", "description": "Boolean flag that specifies whether a queue is currently \nbeing executed", "guessedname": "queueInProgress", "guessedtype": "property"}, "initialConfig": {"guessedname": "initialConfig", "type": "Object", "description": "Maintains the local collection of configuration property objects as \nthey were initially applied.\nThis object is used when resetting a property.", "private": "", "guessedtype": "property"}, "config": {"guessedname": "config", "type": "Object", "description": "Maintains the local collection of configuration property objects and \ntheir specified values", "private": "", "guessedtype": "property"}, "YAHOO.util.Config.BOOLEAN_TYPE": {"description": "Constant representing the boolean type string", "private": "", "static": "", "guessedname": "BOOLEAN_TYPE", "guessedtype": "property", "final": ""}}, "description": "Config is a utility used within an Object to allow the implementer to\nmaintain a list of local configuration properties and listen for changes \nto those properties dynamically using CustomEvent. The initial values are \nalso maintained so that the configuration can be reset at any given point \nto its initial state."}, "YAHOO.widget.Node": {"name": "YAHOO.widget.Node", "constructors": [{"params": [{"type": "object", "name": "oData", "description": " a string or object containing the data that will\nbe used to render this node, and any custom attributes that should be\nstored with the node (which is available in noderef.data)."}, {"type": "Node", "name": "oParent", "description": " this node's parent node"}, {"type": "boolean", "name": "expanded", "description": " the initial expanded\/collapsed state"}], "description": "The base class for all tree nodes. The node's presentation and behavior in\nresponse to mouse events is handled in Node subclasses."}], "namespace": "YAHOO.widget", "module": "treeview", "events": {"parentChange": {"type": "CustomEvent", "description": "The parentChange event is fired when a parent element is applied\nto the node. This is useful if you need to apply tree-level\nproperties to a tree that need to happen if a node is moved from\none tree to another."}}, "guessedname": "Node", "methods": {"appendChild": {"return": {"type": "Node", "description": "the child node"}, "description": "Appends a node to the child collection.", "private": "", "params": [{"type": "Node", "name": "childNode", "description": " the new node"}], "guessedname": "appendChild", "guessedtype": "function"}, "setDynamicLoad": {"params": [{"type": "function", "name": "fmDataLoader", "description": " the function that will be used to get the data."}, {"type": "int", "name": "iconMode", "description": " configures the icon that is displayed when a dynamic\nload node is expanded the first time without children. By default, the \n\"collapse\" icon will be used. If set to 1, the leaf node icon will be\ndisplayed."}], "description": "Configures this node for dynamically obtaining the child data\nwhen the node is first expanded. Calling it without the callback\nwill turn off dynamic load for the node.", "guessedname": "setDynamicLoad", "guessedtype": "function"}, "getChildrenEl": {"return": {"type": "HTMLElement", "description": "this node's children div"}, "description": "Returns the div that was generated for this node's children", "guessedname": "getChildrenEl", "guessedtype": "function"}, "toggle": {"description": "Expands if node is collapsed, collapses otherwise.", "guessedname": "toggle", "guessedtype": "function"}, "collapse\ntoggle style.": {"description": "Hides this nodes children (creating them if necessary), changes the", "guessedname": "collapse", "guessedtype": "function"}, "getToggleEl": {"return": {"type": "HTMLElement", "description": "this node's toggle html element"}, "description": "Returns the element that is being used for this node's toggle.", "guessedname": "getToggleEl", "guessedtype": "function"}, "getHtml": {"return": {"type": "string", "description": "the markup for this node and its expanded children."}, "description": "Returns the markup for this node and its children.", "guessedname": "getHtml", "guessedtype": "function"}, "insertBefore": {"return": {"type": "Node", "description": "the inserted node"}, "params": [{"type": "Node", "name": "node", "description": " the node to insert this node before"}], "description": "Inserts this node before this supplied node", "guessedname": "insertBefore", "guessedtype": "function"}, "hasChildren": {"return": {"type": "boolean", "description": "true if this has children or if it might and we are\nchecking for this condition."}, "params": [{"type": "boolean", "name": "checkForLazyLoad", "description": " should we check for unloaded children?"}], "description": "Checks if this node has children. If this node is lazy-loading and the\nchildren have not been rendered, we do not know whether or not there\nare actual children. In most cases, we need to assume that there are\nchildren (for instance, the toggle needs to show the expandable \npresentation state). In other times we want to know if there are rendered\nchildren. For the latter, \"checkForLazyLoad\" should be false.", "guessedname": "hasChildren", "guessedtype": "function"}, "isDynamic": {"return": {"type": "boolean", "description": "true if this node's children are to be loaded dynamically"}, "description": "Evaluates if this node's children should be loaded dynamically. Looks for\nthe property both in this instance and the root node. If the tree is\ndefined to load all children dynamically, the data callback function is\ndefined in the root node", "guessedname": "isDynamic", "guessedtype": "function"}, "init": {"params": [{"type": "object", "name": "oData", "description": " a string or object containing the data that will\nbe used to render this node"}, {"type": "Node", "name": "oParent", "description": " this node's parent node"}, {"type": "boolean", "name": "expanded", "description": " the initial expanded\/collapsed state"}], "description": "Initializes this node, gets some of the properties from the parent", "guessedname": "init", "guessedtype": "function"}, "getEl": {"return": {"type": "HTMLElement", "description": "the container html element"}, "description": "Returns this node's container html element", "guessedname": "getEl", "guessedtype": "function"}, "appendTo": {"return": {"type": "Node", "description": "The appended node"}, "params": [{"type": "Node", "name": "parentNode", "description": " the node to append to."}], "description": "Appends this node to the supplied node's child collection", "guessedname": "appendTo", "guessedtype": "function"}, "toString": {"return": {"type": "string", "description": "string representation of the node"}, "description": "Node toString", "guessedname": "toString", "guessedtype": "function"}, "showChildren": {"description": "Shows this node's children", "guessedname": "showChildren", "guessedtype": "function"}, "insertAfter": {"return": {"type": "Node", "description": "the inserted node"}, "params": [{"type": "Node", "name": "node", "description": " the node to insert after"}], "description": "Inserts this node after the supplied node", "guessedname": "insertAfter", "guessedtype": "function"}, "getChildrenElId": {"return": {"type": "string", "description": "the element id for this node's children div"}, "description": "Returns the id for this node's children div", "guessedname": "getChildrenElId", "guessedtype": "function"}, "getDepthStyle": {"return": {"type": "string", "description": "the css class for the spacer"}, "params": [{"type": "int", "name": "depth", "description": " the depth of the ancestor."}], "description": "Returns the css class for the spacer at the specified depth for\nthis node. If this node's ancestor at the specified depth\nhas a next sibling the presentation is different than if it\ndoes not have a next sibling", "guessedname": "getDepthStyle", "guessedtype": "function"}, "expandAll": {"description": "Recursively expands all of this node's children.", "guessedname": "expandAll", "guessedtype": "function"}, "getToggleLink": {"return": {"type": "string", "description": "the javascript url for toggling this node"}, "description": "Generates the link that will invoke this node's toggle method", "guessedname": "getToggleLink", "guessedtype": "function"}, "getSiblings": {"return": {"type": "", "description": "Node[]"}, "description": "Returns a node array of this node's siblings, null if none.", "guessedname": "getSiblings", "guessedtype": "function"}, "getStyle": {"return": {"type": "string", "description": "the css class for this node's toggle"}, "description": "Returns the css style name for the toggle", "guessedname": "getStyle", "guessedtype": "function"}, "getNodeHtml": {"return": {"type": "string", "description": "The HTML that will render this node."}, "description": "Get the markup for the node. This is designed to be overrided so that we can\nsupport different types of nodes.", "guessedname": "getNodeHtml", "guessedtype": "function"}, "getIconMode": {"return": {"type": "int", "description": "0 for collapse style, 1 for leaf node style"}, "description": "Returns the current icon mode. This refers to the way childless dynamic\nload nodes appear (this comes into play only after the initial dynamic\nload request produced no children).", "guessedname": "getIconMode", "guessedtype": "function"}, "hideChildren": {"description": "Hides this node's children", "guessedname": "hideChildren", "guessedtype": "function"}, "getAncestor": {"return": {"type": "Node", "description": "the ancestor"}, "params": [{"type": "int", "name": "depth", "description": " the depth of the ancestor."}], "description": "Returns this node's ancestor at the specified depth.", "guessedname": "getAncestor", "guessedtype": "function"}, "loadComplete": {"description": "Load complete is the callback function we pass to the data provider\nin dynamic load situations.", "guessedname": "loadComplete", "guessedtype": "function"}, "expand": {"description": "Shows this nodes children (creating them if necessary), changes the\ntoggle style, and collapses its siblings if multiExpand is not set.", "guessedname": "expand", "guessedtype": "function"}, "getElId": {"return": {"type": "string", "description": "the element id"}, "description": "Returns the id for this node's container div", "guessedname": "getElId", "guessedtype": "function"}, "isRoot": {"return": {"type": "boolean", "description": "true if this is the root node"}, "description": "Evaluates if this node is the root node of the tree", "guessedname": "isRoot", "guessedtype": "function"}, "completeRender": {"return": {"type": "string", "description": "children html"}, "description": "Called when we know we have all the child data.", "guessedname": "completeRender", "guessedtype": "function"}, "isChildOf": {"return": {"type": "boolean", "description": "The node index if this Node is a child of \nsupplied Node, else -1."}, "description": "Returns true if the Node is a child of supplied Node", "private": "", "params": [{"type": "Node", "name": "parentNode", "description": " the Node to check"}], "guessedname": "isChildOf", "guessedtype": "function"}, "getChildrenHtml": {"guessedname": "getChildrenHtml", "return": {"type": "string", "description": "the children container div html and any expanded children"}, "description": "Called when first rendering the tree. We always build the div that will\ncontain this nodes children, but we don't render the children themselves\nunless this node is expanded.", "private": "", "guessedtype": "function"}, "refresh": {"description": "Regenerates the html for this node and its children. To be used when the\nnode is expanded and new children have been added.", "guessedname": "refresh", "guessedtype": "function"}, "getToggleElId": {"return": {"type": "string", "description": "the toggel element id"}, "description": "Returns the id for this node's toggle element", "guessedname": "getToggleElId", "guessedtype": "function"}, "renderChildren": {"guessedname": "renderChildren", "return": {"type": "string", "description": "the html for this node's children"}, "description": "Generates the markup for the child nodes. This is not done until the node\nis expanded.", "private": "", "guessedtype": "function"}, "getHoverStyle": {"return": {"type": "string", "description": "the css class hover state"}, "description": "Returns the hover style for the icon", "guessedname": "getHoverStyle", "guessedtype": "function"}, "collapseAll": {"description": "Recursively collapses all of this node's children.", "guessedname": "collapseAll", "guessedtype": "function"}, "applyParent": {"return": {"type": "boolean", "description": "true if the application was successful"}, "params": [{"type": "Node", "name": "parentNode", "description": " this node's parent node"}], "description": "Certain properties for the node cannot be set until the parent\nis known. This is called after the node is inserted into a tree.\nthe parent is also applied to this node's children in order to\nmake it possible to move a branch from one tree to another.", "guessedname": "applyParent", "guessedtype": "function"}}, "uses": ["YAHOO.util.EventProvider"], "file": "Node.js", "guessedtype": "function", "shortname": "Node", "properties": {"childrenRendered": {"type": "boolean", "description": "This flag is set to true when the html is generated for this node's\nchildren, and set to false when new children are added.", "guessedname": "childrenRendered", "guessedtype": "property"}, "nextSibling": {"type": "Node", "description": "This node's next sibling", "guessedname": "nextSibling", "guessedtype": "property"}, "renderHidden": {"type": "boolean", "description": "Should we render children for a collapsed node? It is possible that the\nimplementer will want to render the hidden data... @todo verify that we \nneed this, and implement it if we do.", "guessedname": "renderHidden", "guessedtype": "property"}, "iconMode": {"type": "int", "description": "Used to configure what happens when a dynamic load node is expanded\nand we discover that it does not have children. By default, it is\ntreated as if it still could have children (plus\/minus icon). Set\niconMode to have it display like a leaf node instead.", "guessedname": "iconMode", "guessedtype": "property"}, "href": {"type": "string", "description": "The href for the node's label. If one is not specified, the href will\nbe set so that it toggles the node.", "guessedname": "href", "guessedtype": "property"}, "isLoading": {"type": "boolean", "description": "This is true for dynamically loading nodes while waiting for the\ncallback to return.", "guessedname": "isLoading", "guessedtype": "property"}, "nowrap": {"default": "false", "type": "boolean", "description": "Specifies whether or not the content area of the node should be allowed\nto wrap.", "guessedname": "nowrap", "guessedtype": "property"}, "children": {"type": "Node[]", "description": "This node's child node collection.", "guessedname": "children", "guessedtype": "property"}, "multiExpand": {"type": "boolean", "description": "Can multiple children be expanded at once?", "guessedname": "multiExpand", "guessedtype": "property"}, "index": {"type": "int", "description": "The index for this instance obtained from global counter in YAHOO.widget.TreeView.", "guessedname": "index", "guessedtype": "property"}, "_dynLoad": {"guessedname": "_dynLoad", "type": "boolean", "description": "We can set the node up to call an external method to get the child\ndata dynamically.", "private": "", "guessedtype": "property"}, "previousSibling": {"type": "Node", "description": "This node's previous sibling", "guessedname": "previousSibling", "guessedtype": "property"}, "_type": {"private": "", "description": "The node type", "guessedname": "_type", "guessedtype": "property"}, "parent": {"type": "Node", "description": "Parent node", "guessedname": "parent", "guessedtype": "property"}, "dataLoader": {"type": "function", "description": "Function to execute when we need to get this node's child data.", "guessedname": "dataLoader", "guessedtype": "property"}, "data": {"type": "object", "description": "The data linked to this node. This can be any object or primitive\nvalue, and the data can be used in getNodeHtml().", "guessedname": "data", "guessedtype": "property"}, "dynamicLoadComplete": {"type": "boolean", "description": "Dynamically loaded nodes only fetch the data the first time they are\nexpanded. This flag is set to true once the data has been fetched.", "guessedname": "dynamicLoadComplete", "guessedtype": "property"}, "isLeaf": {"default": "false", "type": "boolean", "description": "If true, the node will alway be rendered as a leaf node. This can be\nused to override the presentation when dynamically loading the entire\ntree. Setting this to true also disables the dynamic load call for the\nnode.", "guessedname": "isLeaf", "guessedtype": "property"}, "hasIcon": {"type": "boolean", "description": "The toggle\/branch icon will not show if this is set to false. This\ncould be useful if the implementer wants to have the child contain\nextra info about the parent, rather than an actual node.", "guessedname": "hasIcon", "guessedtype": "property"}, "target": {"type": "string", "description": "The label href target, defaults to current window", "guessedname": "target", "guessedtype": "property"}, "expanded": {"type": "boolean", "description": "The node's expanded\/collapsed state", "guessedname": "expanded", "guessedtype": "property"}, "tree": {"type": "TreeView", "description": "Tree instance this node is part of", "guessedname": "tree", "guessedtype": "property"}, "depth": {"type": "int", "description": "The depth of this node. We start at -1 for the root node.", "guessedname": "depth", "guessedtype": "property"}}, "description": "The base class for all tree nodes. The node's presentation and behavior in\nresponse to mouse events is handled in Node subclasses."}, "YAHOO.widget.ColumnSeries": {"name": "YAHOO.widget.ColumnSeries", "constructors": [{"description": "ColumnSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "ColumnSeries", "file": "Series.js", "guessedtype": "function", "shortname": "ColumnSeries", "description": "ColumnSeries class for the YUI Charts widget."}, "YAHOO.widget.ColumnChart": {"name": "YAHOO.widget.ColumnChart", "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": "ColumnChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "ColumnChart", "uses": ["YAHOO.widget.CartesianChart"], "file": "ChartTypes.js", "guessedtype": "function", "shortname": "ColumnChart", "description": "ColumnChart class for the YUI Charts widget."}, "YAHOO.util.Region": {"name": "YAHOO.util.Region", "constructors": [{"params": [{"type": "Int", "name": "t", "description": " the top extent"}, {"type": "Int", "name": "r", "description": " the right extent"}, {"type": "Int", "name": "b", "description": " the bottom extent"}, {"type": "Int", "name": "l", "description": " the left extent"}], "description": "A region is a representation of an object on a grid. It is defined\nby the top, right, bottom, left extents, so is rectangular by default. If \nother shapes are required, this class could be extended to support it."}], "namespace": "YAHOO.util", "module": "dom", "guessedname": "Region", "methods": {"getArea": {"return": {"type": "Int", "description": "the region's area"}, "description": "Returns the area of the region", "guessedname": "getArea", "guessedtype": "function"}, "getRegion": {"return": {"type": "Region", "description": "The region that the element occupies"}, "description": "Returns a region that is occupied by the DOM element", "static": "", "guessedname": "getRegion", "guessedtype": "function", "params": [{"type": "HTMLElement", "name": "el", "description": " The element"}]}, "contains": {"return": {"type": "Boolean", "description": "True if the region is contained with this region, \nelse false"}, "params": [{"type": "Region", "name": "region", "description": " The region to evaluate"}], "description": "Returns true if this region contains the region passed in", "guessedname": "contains", "guessedtype": "function"}, "union": {"return": {"type": "Region", "description": "The union region"}, "params": [{"type": "Region", "name": "region", "description": " The region that to create the union with"}], "description": "Returns the region representing the smallest region that can contain both\nthe passed in region and this region.", "guessedname": "union", "guessedtype": "function"}, "toString": {"return": {"type": "", "description": "string the region properties"}, "description": "toString", "guessedname": "toString", "guessedtype": "function"}, "intersect": {"return": {"type": "Region", "description": "The overlap region, or null if there is no overlap"}, "params": [{"type": "Region", "name": "region", "description": " The region that intersects"}], "description": "Returns the region where the passed in region overlaps with this one", "guessedname": "intersect", "guessedtype": "function"}}, "file": "Region.js", "guessedtype": "function", "shortname": "Region", "properties": {"right": {"type": "int", "description": "The region's right extent", "guessedname": "right", "guessedtype": "property"}, "bottom": {"type": "Int", "description": "The region's bottom extent", "guessedname": "bottom", "guessedtype": "property"}, "top": {"type": "Int", "description": "The region's top extent", "guessedname": "top", "guessedtype": "property"}, "1": {"type": "Int", "description": "The region's top extent as index, for symmetry with set\/getXY"}, "0": {"type": "Int", "description": "The region's left extent as index, for symmetry with set\/getXY"}, "left": {"type": "Int", "description": "The region's left extent", "guessedname": "left", "guessedtype": "property"}}, "description": "A region is a representation of an object on a grid. It is defined\nby the top, right, bottom, left extents, so is rectangular by default. If \nother shapes are required, this class could be extended to support it."}, "YAHOO.widget.ContainerEffect": {"name": "YAHOO.widget.ContainerEffect", "constructors": [{"params": [{"type": "YAHOO.widget.Overlay", "name": "overlay", "description": " The Overlay that the animation \nshould be associated with"}, {"type": "Object", "name": "attrIn", "description": " The object literal representing the animation \narguments to be used for the animate-in transition. The arguments for \nthis literal are: attributes(object, see YAHOO.util.Anim for description), \nduration(Number), and method(i.e. Easing.easeIn)."}, {"type": "Object", "name": "attrOut", "description": " The object literal representing the animation \narguments to be used for the animate-out transition. The arguments for \nthis literal are: attributes(object, see YAHOO.util.Anim for description), \nduration(Number), and method(i.e. Easing.easeIn)."}, {"type": "HTMLElement", "name": "targetElement", "description": " Optional. The target element that \nshould be animated during the transition. Defaults to overlay.element."}, {"type": "class", "name": "Optional.", "description": " The animation class to instantiate. Defaults to \nYAHOO.util.Anim. Other options include YAHOO.util.Motion."}], "description": "ContainerEffect encapsulates animation transitions that are executed when \nan Overlay is shown or hidden."}], "namespace": "YAHOO.widget", "module": "container", "guessedname": "ContainerEffect", "methods": {"handleTweenAnimateOut": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onTween handler for the out-animation.", "guessedname": "handleTweenAnimateOut", "guessedtype": "function"}, "handleStartAnimateIn": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onStart handler for the in-animation.", "guessedname": "handleStartAnimateIn", "guessedtype": "function"}, "handleStartAnimateOut": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onStart handler for the out-animation.", "guessedname": "handleStartAnimateOut", "guessedtype": "function"}, "animateOut": {"description": "Triggers the out-animation.", "guessedname": "animateOut", "guessedtype": "function"}, "handleCompleteAnimateOut": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onComplete handler for the out-animation.", "guessedname": "handleCompleteAnimateOut", "guessedtype": "function"}, "init": {"description": "Initializes the animation classes and events.", "guessedname": "init", "guessedtype": "function"}, "handleTweenAnimateIn": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onTween handler for the in-animation.", "guessedname": "handleTweenAnimateIn", "guessedtype": "function"}, "SLIDE": {"return": {"type": "YAHOO.widget.ContainerEffect", "description": "The configured ContainerEffect object"}, "description": "A pre-configured ContainerEffect instance that can be used for sliding an \noverlay in and out.", "static": "", "guessedname": "SLIDE", "guessedtype": "function", "params": [{"type": "YAHOO.widget.Overlay", "name": "overlay", "description": " The Overlay object to animate"}, {"type": "Number", "name": "dur", "description": " The duration of the animation"}]}, "toString": {"return": {"type": "String", "description": "The string representation of the ContainerEffect"}, "description": "Returns a string representation of the object.", "guessedname": "toString", "guessedtype": "function"}, "FADE": {"return": {"type": "YAHOO.widget.ContainerEffect", "description": "The configured ContainerEffect object"}, "description": "A pre-configured ContainerEffect instance that can be used for fading \nan overlay in and out.", "static": "", "guessedname": "FADE", "guessedtype": "function", "params": [{"type": "YAHOO.widget.Overlay", "name": "overlay", "description": " The Overlay object to animate"}, {"type": "Number", "name": "dur", "description": " The duration of the animation"}]}, "handleCompleteAnimateIn": {"params": [{"type": "String", "name": "type", "description": " The CustomEvent type"}, {"type": "Object[]", "name": "args", "description": " The CustomEvent arguments"}, {"type": "Object", "name": "obj", "description": " The scope object"}], "description": "The default onComplete handler for the in-animation.", "guessedname": "handleCompleteAnimateIn", "guessedtype": "function"}, "animateIn": {"description": "Triggers the in-animation.", "guessedname": "animateIn", "guessedtype": "function"}}, "file": "ContainerEffect.js", "guessedtype": "property", "shortname": "ContainerEffect", "properties": {"attrOut": {"type": "Object", "description": "The animation attributes to use when transitioning out of view", "guessedname": "attrOut", "guessedtype": "property"}, "animClass": {"type": "class", "description": "The animation class to use for animating the overlay", "guessedname": "animClass", "guessedtype": "property"}, "targetElement": {"type": "HTMLElement", "description": "The target element to be animated", "guessedname": "targetElement", "guessedtype": "property"}, "attrIn": {"type": "Object", "description": "The animation attributes to use when transitioning into view", "guessedname": "attrIn", "guessedtype": "property"}, "overlay": {"type": "YAHOO.widget.Overlay", "description": "The overlay to animate", "guessedname": "overlay", "guessedtype": "property"}}, "description": "ContainerEffect encapsulates animation transitions that are executed when \nan Overlay is shown or hidden."}, "YAHOO.util.Motion": {"name": "YAHOO.util.Motion", "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": "Anim subclass for moving elements along a path defined by the \"points\" \nmember of \"attributes\". All \"points\" are arrays with x, y coordinates.\n

Usage: var myAnim = new YAHOO.util.Motion(el, { points: { to: [800, 800] } }, 1, YAHOO.util.Easing.easeOut);<\/code><\/p>"}], "namespace": "YAHOO.util", "module": "animation", "guessedname": "Motion", "extends": "YAHOO.util.ColorAnim", "superclass": "YAHOO.util.ColorAnim", "file": "Motion.js", "guessedtype": "function", "shortname": "Motion", "requires": "YAHOO.util.Anim", "description": "Anim subclass for moving elements along a path defined by the \"points\" \nmember of \"attributes\". All \"points\" are arrays with x, y coordinates.\n

Usage: var myAnim = new YAHOO.util.Motion(el, { points: { to: [800, 800] } }, 1, YAHOO.util.Easing.easeOut);<\/code><\/p>"}, "YAHOO.widget.LineSeries": {"name": "YAHOO.widget.LineSeries", "constructors": [{"description": "LineSeries class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "LineSeries", "file": "Series.js", "guessedtype": "function", "shortname": "LineSeries", "description": "LineSeries class for the YUI Charts widget."}, "YAHOO.widget.BarChart": {"name": "YAHOO.widget.BarChart", "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": "BarChart class for the YUI Charts widget."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "BarChart", "uses": ["YAHOO.widget.CartesianChart"], "file": "ChartTypes.js", "guessedtype": "function", "shortname": "BarChart", "description": "BarChart class for the YUI Charts widget."}, "YAHOO.widget.TimeAxis": {"name": "YAHOO.widget.TimeAxis", "constructors": [{"description": "A type of axis whose units are measured in time-based values."}], "namespace": "YAHOO.widget", "module": "charts", "guessedname": "TimeAxis", "file": "TimeAxis.js", "guessedtype": "function", "shortname": "TimeAxis", "properties": {"majorTimeUnit": {"type": "String", "description": "The time unit used by the majorUnit.", "guessedname": "majorTimeUnit", "guessedtype": "property"}, "minimum": {"type": "Date", "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"}, "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"}, "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"}}, "description": "A type of axis whose units are measured in time-based values."}, "YAHOO.util.CustomEvent": {"name": "YAHOO.util.CustomEvent", "constructors": [{"params": [{"type": "String", "name": "type", "description": " The type of event, which is passed to the callback\nwhen the event fires"}, {"type": "Object", "name": "oScope", "description": " The context the event will fire from. \"this\" will\nrefer to this object in the callback. Default value: \nthe window object. The listener can override this."}, {"type": "boolean", "name": "silent", "description": " pass true to prevent the event from writing to\nthe debugsystem"}, {"type": "int", "name": "signature", "description": " the signature that the custom event subscriber\nwill receive. YAHOO.util.CustomEvent.LIST or \nYAHOO.util.CustomEvent.FLAT. The default is\nYAHOO.util.CustomEvent.LIST."}], "description": "The CustomEvent class lets you define events for your application\nthat can be subscribed to by one or more independent component."}], "namespace": "YAHOO.util", "module": "event", "events": {"subscribeEvent": {"type": "YAHOO.util.CustomEvent", "params": [{"type": "Function", "name": "fn", "description": " The function to execute"}, {"type": "Object", "name": "obj", "description": " An object to be passed along when the event \nfires"}, {"type": "boolean|Object", "name": "override", "description": " If true, the obj passed in becomes \nthe execution scope of the listener.\nif an object, that object becomes the\nthe execution scope."}], "description": "Custom events provide a custom event that fires whenever there is\na new subscriber to the event. This provides an opportunity to\nhandle the case where there is a non-repeating event that has\nalready fired has a new subscriber.", "guessedname": "subscribeEvent", "guessedtype": "property"}}, "guessedname": "CustomEvent", "methods": {"_delete": {"private": "", "guessedname": "_delete", "guessedtype": "function"}, "fire": {"return": {"type": "boolean", "description": "false if one of the subscribers returned false, \ntrue otherwise"}, "params": [{"type": "Object*", "name": "arguments", "description": " an arbitrary set of parameters to pass to \nthe handler."}], "description": "Notifies the subscribers. The callback functions will be executed\nfrom the scope specified when the event was created, and with the \nfollowing parameters:\n