{ "dijit": { "location": "dijit", "resources": [ "dijit\/Calendar.js", "dijit\/CheckedMenuItem.js", "dijit\/ColorPalette.js", "dijit\/Declaration.js", "dijit\/Dialog.js", "dijit\/DialogUnderlay.js", "dijit\/Editor.js", "dijit\/InlineEditBox.js", "dijit\/Menu.js", "dijit\/MenuBar.js", "dijit\/MenuBarItem.js", "dijit\/MenuItem.js", "dijit\/MenuSeparator.js", "dijit\/PopupMenuBarItem.js", "dijit\/PopupMenuItem.js", "dijit\/ProgressBar.js", "dijit\/TitlePane.js", "dijit\/Toolbar.js", "dijit\/ToolbarSeparator.js", "dijit\/Tooltip.js", "dijit\/TooltipDialog.js", "dijit\/Tree.js", "dijit\/_Calendar.js", "dijit\/_Contained.js", "dijit\/_Container.js", "dijit\/_CssStateMixin.js", "dijit\/_DialogMixin.js", "dijit\/_HasDropDown.js", "dijit\/_KeyNavContainer.js", "dijit\/_PaletteMixin.js", "dijit\/_Templated.js", "dijit\/_TimePicker.js", "dijit\/_Widget.js", "dijit\/_WidgetBase.js", "dijit\/_base\/focus.js", "dijit\/_base\/manager.js", "dijit\/_base\/place.js", "dijit\/_base\/popup.js", "dijit\/_base\/scroll.js", "dijit\/_base\/sniff.js", "dijit\/_base\/typematic.js", "dijit\/_base\/wai.js", "dijit\/_base\/window.js", "dijit\/_base.js", "dijit\/_editor\/RichText.js", "dijit\/_editor\/_Plugin.js", "dijit\/_editor\/html.js", "dijit\/_editor\/plugins\/AlwaysShowToolbar.js", "dijit\/_editor\/plugins\/EnterKeyHandling.js", "dijit\/_editor\/plugins\/FontChoice.js", "dijit\/_editor\/plugins\/FullScreen.js", "dijit\/_editor\/plugins\/LinkDialog.js", "dijit\/_editor\/plugins\/NewPage.js", "dijit\/_editor\/plugins\/Print.js", "dijit\/_editor\/plugins\/TabIndent.js", "dijit\/_editor\/plugins\/TextColor.js", "dijit\/_editor\/plugins\/ToggleDir.js", "dijit\/_editor\/plugins\/ViewSource.js", "dijit\/_editor\/range.js", "dijit\/_editor\/selection.js", "dijit\/_tree\/dndSource.js", "dijit\/dijit-all.js", "dijit\/dijit.js", "dijit\/form\/Button.js", "dijit\/form\/CheckBox.js", "dijit\/form\/ComboBox.js", "dijit\/form\/ComboButton.js", "dijit\/form\/CurrencyTextBox.js", "dijit\/form\/DateTextBox.js", "dijit\/form\/DropDownButton.js", "dijit\/form\/FilteringSelect.js", "dijit\/form\/Form.js", "dijit\/form\/HorizontalRule.js", "dijit\/form\/HorizontalRuleLabels.js", "dijit\/form\/HorizontalSlider.js", "dijit\/form\/MappedTextBox.js", "dijit\/form\/MultiSelect.js", "dijit\/form\/NumberSpinner.js", "dijit\/form\/NumberTextBox.js", "dijit\/form\/RadioButton.js", "dijit\/form\/RangeBoundTextBox.js", "dijit\/form\/Select.js", "dijit\/form\/SimpleTextarea.js", "dijit\/form\/Slider.js", "dijit\/form\/TextBox.js", "dijit\/form\/Textarea.js", "dijit\/form\/TimeTextBox.js", "dijit\/form\/ToggleButton.js", "dijit\/form\/ValidationTextBox.js", "dijit\/form\/VerticalRule.js", "dijit\/form\/VerticalRuleLabels.js", "dijit\/form\/VerticalSlider.js", "dijit\/form\/_DateTimeTextBox.js", "dijit\/form\/_FormMixin.js", "dijit\/form\/_FormSelectWidget.js", "dijit\/form\/_FormWidget.js", "dijit\/form\/_Spinner.js", "dijit\/layout\/AccordionContainer.js", "dijit\/layout\/AccordionPane.js", "dijit\/layout\/BorderContainer.js", "dijit\/layout\/ContentPane.js", "dijit\/layout\/LayoutContainer.js", "dijit\/layout\/LinkPane.js", "dijit\/layout\/ScrollingTabController.js", "dijit\/layout\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dijit\/layout\/StackController.js", "dijit\/layout\/TabContainer.js", "dijit\/layout\/TabController.js", "dijit\/layout\/_ContentPaneResizeMixin.js", "dijit\/layout\/_LayoutWidget.js", "dijit\/layout\/_TabContainerBase.js", "dijit\/robot.js", "dijit\/robotx.js", "dijit\/tree\/ForestStoreModel.js", "dijit\/tree\/TreeStoreModel.js", "dijit\/tree\/_dndContainer.js", "dijit\/tree\/_dndSelector.js", "dijit\/tree\/dndSource.js" ], "provides": [ "dijit.Calendar", "dijit.CheckedMenuItem", "dijit.ColorPalette", "dijit.Declaration", "dijit.Dialog", "dijit.DialogUnderlay", "dijit.Editor", "dijit.InlineEditBox", "dijit.Menu", "dijit.MenuBar", "dijit.MenuBarItem", "dijit.MenuItem", "dijit.MenuSeparator", "dijit.PopupMenuBarItem", "dijit.PopupMenuItem", "dijit.ProgressBar", "dijit.TitlePane", "dijit.Toolbar", "dijit.ToolbarSeparator", "dijit.Tooltip", "dijit.TooltipDialog", "dijit.Tree", "dijit._Calendar", "dijit._Contained", "dijit._Container", "dijit._CssStateMixin", "dijit._DialogMixin", "dijit._HasDropDown", "dijit._KeyNavContainer", "dijit._PaletteMixin", "dijit._Templated", "dijit._TimePicker", "dijit._Widget", "dijit._WidgetBase", "dijit._base.focus", "dijit._base.manager", "dijit._base.place", "dijit._base.popup", "dijit._base.scroll", "dijit._base.sniff", "dijit._base.typematic", "dijit._base.wai", "dijit._base.window", "dijit._base", "dijit._editor.RichText", "dijit._editor._Plugin", "dijit._editor.html", "dijit._editor.plugins.AlwaysShowToolbar", "dijit._editor.plugins.EnterKeyHandling", "dijit._editor.plugins.FontChoice", "dijit._editor.plugins.FullScreen", "dijit._editor.plugins.LinkDialog", "dijit._editor.plugins.NewPage", "dijit._editor.plugins.Print", "dijit._editor.plugins.TabIndent", "dijit._editor.plugins.TextColor", "dijit._editor.plugins.ToggleDir", "dijit._editor.plugins.ViewSource", "dijit._editor.range", "dijit._editor.selection", "dijit._tree.dndSource", "dijit.dijit-all", "dijit.dijit", "dijit.form.Button", "dijit.form.CheckBox", "dijit.form.ComboBox", "dijit.form.ComboButton", "dijit.form.CurrencyTextBox", "dijit.form.DateTextBox", "dijit.form.DropDownButton", "dijit.form.FilteringSelect", "dijit.form.Form", "dijit.form.HorizontalRule", "dijit.form.HorizontalRuleLabels", "dijit.form.HorizontalSlider", "dijit.form.MappedTextBox", "dijit.form.MultiSelect", "dijit.form.NumberSpinner", "dijit.form.NumberTextBox", "dijit.form.RadioButton", "dijit.form.RangeBoundTextBox", "dijit.form.Select", "dijit.form.SimpleTextarea", "dijit.form.Slider", "dijit.form.TextBox", "dijit.form.Textarea", "dijit.form.TimeTextBox", "dijit.form.ToggleButton", "dijit.form.ValidationTextBox", "dijit.form.VerticalRule", "dijit.form.VerticalRuleLabels", "dijit.form.VerticalSlider", "dijit.form._DateTimeTextBox", "dijit.form._FormMixin", "dijit.form._FormSelectWidget", "dijit.form._FormWidget", "dijit.form._Spinner", "dijit.layout.AccordionContainer", "dijit.layout.AccordionPane", "dijit.layout.BorderContainer", "dijit.layout.ContentPane", "dijit.layout.LayoutContainer", "dijit.layout.LinkPane", "dijit.layout.ScrollingTabController", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dijit.layout.StackController", "dijit.layout.TabContainer", "dijit.layout.TabController", "dijit.layout._ContentPaneResizeMixin", "dijit.layout._LayoutWidget", "dijit.layout._TabContainerBase", "dijit.robot", "dijit.robotx", "dijit.tree.ForestStoreModel", "dijit.tree.TreeStoreModel", "dijit.tree._dndContainer", "dijit.tree._dndSelector", "dijit.tree.dndSource" ], "properties": [ { "name": "_dialogStack", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_masterTT", "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_Calendar", "resources": [ "dijit\/_Calendar.js" ], "provides": [ "dijit._Calendar" ], "scope": "normal", "type": null, "private": true }, { "name": "_lastKeyDownNode", "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_curFocus", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "DomNode", "private": true, "summary": "Currently focused item on screen" }, { "name": "_prevFocus", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "DomNode", "private": true, "summary": "Previously focused item on screen" }, { "name": "_activeStack", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "dijit._Widget[]", "private": true, "summary": "List of currently active widgets (focused widget and it's ancestors)" }, { "name": "defaultDuration", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "scope": "normal", "type": "Integer", "summary": "The default animation speed (in ms) to use for all Dijit\ntransitional animations, unless otherwise specified\non a per-instance basis. Defaults to 200, overrided by\ndjConfig.defaultDuration<\/code>" }, { "name": "placementRegistry", "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "scope": "normal", "type": "Object" }, { "name": "_frames", "resources": [ "dijit\/_base\/popup.js" ], "provides": [ "dijit._base.popup" ], "scope": "normal", "type": "Object", "private": true }, { "name": "dijit-all", "resources": [ "dijit\/dijit-all.js" ], "provides": [ "dijit.dijit-all" ], "scope": "normal", "type": "Object", "summary": "A rollup that includes every dijit. You probably don't need this." }, { "name": "dijit", "resources": [ "dijit\/dijit.js" ], "provides": [ "dijit.dijit" ], "scope": "normal", "type": "Object", "summary": "A roll-up for common dijit methods" }, { "name": "demos", "resources": [ "dijit\/resources\/_modules.js" ], "scope": "normal", "type": "Object", "summary": "Home of the official dijit demo code" }, { "name": "robot", "resources": [ "dijit\/robot.js" ], "provides": [ "dijit.robot" ], "scope": "normal", "type": "Object" }, { "name": "robotx", "resources": [ "dijit\/robotx.js" ], "provides": [ "dijit.robotx" ], "scope": "normal", "type": "Object" } ], "methods": [ { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_underlay", "scope": "normal", "private": true, "summary": "A shared instance of a dijit.DialogUnderlay<\/code>", "description": "A shared instance of a `dijit.DialogUnderlay` created and\nused by `dijit.Dialog`, though never created until some Dialog\nor subclass thereof is shown.", "parameters": [ { "name": "kwArgs", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "showTooltip", "scope": "normal", "summary": "Display tooltip w\/specified contents in specified position.\nSee description of dijit.Tooltip.defaultPosition for details on position parameter.\nIf position is not specified then dijit.Tooltip.defaultPosition is used.", "parameters": [ { "name": "innerHTML", "type": "String", "usage": "required" }, { "name": "aroundNode", "type": "DomNode", "usage": "required" }, { "name": "position", "type": "String[]", "usage": "optional" }, { "name": "rtl", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "hideTooltip", "scope": "normal", "summary": "Hide the tooltip", "parameters": [ { "name": "aroundNode", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "_connectOnUseEventHandler", "scope": "normal", "private": true, "parameters": [ { "name": "event", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "isCollapsed", "scope": "normal", "summary": "Returns true if there is no text selected" }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "getBookmark", "scope": "normal", "summary": "Retrieves a bookmark that can be used with moveToBookmark to return to the same range", "return-types": [ { "type": "Object." }, { "type": "Object" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "moveToBookmark", "scope": "normal", "summary": "Moves current selection to a bookmark", "parameters": [ { "name": "bookmark", "type": "Object", "usage": "required", "summary": "This should be a returned object from dijit.getBookmark()" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "getFocus", "scope": "normal", "summary": "Called as getFocus(), this returns an Object showing the current focus\nand selected text.\n\nCalled as getFocus(widget), where widget is a (widget representing) a button\nthat was just pressed, it returns where focus was before that button\nwas pressed. (Pressing the button may have either shifted focus to the button,\nor removed focus altogether.) In this case the selected text is not returned,\nsince it can't be accurately determined.", "return-description": "A handle to restore focus\/selection, to be passed to `dijit.focus`", "parameters": [ { "name": "menu", "type": "Widget", "usage": "optional", "summary": "dijit._Widget or {domNode: DomNode} structure\nThe button that was just pressed. If focus has disappeared or moved\nto this button, returns the previous focus. In this case the bookmark\ninformation is already lost, and null is returned." }, { "name": "openedForWindow", "type": "Window", "usage": "optional", "summary": "iframe in which menu was opened" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "focus", "scope": "normal", "summary": "Sets the focused node and the selection according to argument.\nTo set focus to an iframe's content, pass in the iframe itself.", "parameters": [ { "name": "handle", "type": "Object", "usage": "required", "summary": "object returned by get(), or a DomNode" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "registerIframe", "scope": "normal", "summary": "Registers listeners on the specified iframe so that any click\nor focus event on that iframe (or anything in it) is reported\nas a focus\/click event on the <iframe> itself.", "description": "Currently only used by editor.", "return-description": "Handle to pass to unregisterIframe()", "parameters": [ { "name": "iframe", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "unregisterIframe", "scope": "normal", "summary": "Unregisters listeners on the specified iframe created by registerIframe.\nAfter calling be sure to delete or null out the handle itself.", "parameters": [ { "name": "handle", "type": "Object", "usage": "required", "summary": "Handle returned by registerIframe()" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "registerWin", "scope": "normal", "summary": "Registers listeners on the specified window (either the main\nwindow or an iframe's window) to detect when the user has clicked somewhere\nor focused somewhere.", "description": "Users should call registerIframe() instead of this method.", "return-description": "Handle to pass to unregisterWin()", "parameters": [ { "name": "targetWindow", "type": "Window", "usage": "optional", "summary": "If specified this is the window associated with the iframe,\ni.e. iframe.contentWindow." }, { "name": "effectiveNode", "type": "DomNode", "usage": "optional", "summary": "If specified, report any focus events inside targetWindow as\nan event on effectiveNode, rather than on evt.target." } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "unregisterWin", "scope": "normal", "summary": "Unregisters listeners on the specified window (either the main\nwindow or an iframe's window) according to handle returned from registerWin().\nAfter calling be sure to delete or null out the handle itself.", "parameters": [ { "name": "handle", "type": "Handle", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "_onBlurNode", "scope": "normal", "private": true, "summary": "Called when focus leaves a node.\nUsually ignored, _unless_ it *isn't* follwed by touching another node,\nwhich indicates that we tabbed off the last field on the page,\nin which case every widget is marked inactive", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "_onTouchNode", "scope": "normal", "private": true, "summary": "Callback when node is focused or mouse-downed", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required", "summary": "The node that was touched." }, { "name": "by", "type": "String", "usage": "required", "summary": ""mouse" if the focus\/touch was caused by a mouse down event" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "_onFocusNode", "scope": "normal", "private": true, "summary": "Callback when node is focused", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "_setStack", "scope": "normal", "private": true, "summary": "The stack of active widgets has changed. Send out appropriate events and records new stack.", "parameters": [ { "name": "newStack", "type": "String[]", "usage": "required", "summary": "array of widget id's, starting from the top (outermost) widget" }, { "name": "by", "type": "String", "usage": "required", "summary": ""mouse" if the focus\/touch was caused by a mouse down event" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byId", "scope": "normal", "summary": "Returns a widget by it's id, or if passed a widget, no-op (like dojo.byId())", "parameters": [ { "name": "id", "type": "String|dijit._Widget", "usage": "required" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "getUniqueId", "scope": "normal", "summary": "Generates a unique id for a given widgetType", "parameters": [ { "name": "widgetType", "type": "String", "usage": "required" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "findWidgets", "scope": "normal", "summary": "Search subtree under root returning widgets found.\nDoesn't search for nested widgets (ie, widgets inside other widgets).", "parameters": [ { "name": "root", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "_destroyAll", "scope": "normal", "private": true, "summary": "Code to destroy all widgets and do other cleanup on page unload" }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byNode", "scope": "normal", "summary": "Returns the widget corresponding to the given DOMNode", "parameters": [ { "name": "node", "type": "DOMNode", "usage": "required" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_base\/manager.js", "dojox\/mobile\/_base.js" ], "provides": [ "dijit._base.manager", "dojox.mobile._base" ], "name": "getEnclosingWidget", "scope": "normal", "summary": "Returns the widget whose DOM tree contains the specified DOMNode, or null if\nthe node is not contained within the DOM tree of any widget", "parameters": [ { "name": "node", "type": "DOMNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "_isElementShown", "scope": "normal", "private": true, "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "hasDefaultTabStop", "scope": "normal", "summary": "Tests if element is tab-navigable even without an explicit tabIndex setting", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "isTabNavigable", "scope": "normal", "summary": "Tests if an element is tab-navigable", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ], "return-types": [ { "type": "boolean" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "_getTabNavigable", "scope": "normal", "private": true, "summary": "Finds descendants of the specified root node.", "description": "Finds the following descendants of the specified root node:\n* the first tab-navigable element in document order\nwithout a tabIndex or with tabIndex=\"0\"\n* the last tab-navigable element in document order\nwithout a tabIndex or with tabIndex=\"0\"\n* the first element in document order with the lowest\npositive tabIndex value\n* the last element in document order with the highest\npositive tabIndex value", "parameters": [ { "name": "root", "type": "DOMNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "getFirstInTabbingOrder", "scope": "normal", "summary": "Finds the descendant of the specified root node\nthat is first in the tabbing order", "parameters": [ { "name": "root", "type": "String|DOMNode", "usage": "required" } ], "return-types": [ { "type": "DomNode" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "getLastInTabbingOrder", "scope": "normal", "summary": "Finds the descendant of the specified root node\nthat is last in the tabbing order", "parameters": [ { "name": "root", "type": "String|DOMNode", "usage": "required" } ], "return-types": [ { "type": "DomNode" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "getViewport", "scope": "normal", "summary": "Returns the dimensions and scroll position of the viewable area of a browser window" }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "placeOnScreen", "scope": "normal", "summary": "Positions one of the node's corners at specified position\nsuch that node is fully visible in viewport.", "description": "NOTE: node is assumed to be absolutely or relatively positioned.", "examples": { "example": "Try to place node's top right corner at (10,20).\nIf that makes node go (partially) off screen, then try placing\nbottom left corner at (10,20).\n\tplaceOnScreen(node, {x: 10, y: 20}, [\"TR\", \"BL\"])" }, "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "pos", "type": "dijit.__Position", "usage": "required", "summary": "Object like {x: 10, y: 20}" }, { "name": "corners", "type": "String[]", "usage": "required", "summary": "Array of Strings representing order to try corners in, like ["TR", "BL"].\nPossible values are:\n* "BL" - bottom left\n* "BR" - bottom right\n* "TL" - top left\n* "TR" - top right" }, { "name": "padding", "type": "dijit.__Position", "usage": "optional", "summary": "set padding to put some buffer around the element you want to position." } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "_place", "scope": "normal", "private": true, "summary": "Given a list of spots to put node, put it at the first spot where it fits,\nof if it doesn't fit anywhere then the place with the least overflow", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "choices", "type": "Array", "usage": "required", "summary": "Array of elements like: {corner: 'TL', pos: {x: 10, y: 20} }\nAbove example says to put the top-left corner of the node at (10,20)" }, { "name": "layoutNode", "type": "Function(node,", "usage": "required", "summary": "aroundNodeCorner, nodeCorner, size)\nfor things like tooltip, they are displayed differently (and have different dimensions)\nbased on their orientation relative to the parent. This adjusts the popup based on orientation.\nIt also passes in the available size for the popup, which is useful for tooltips to\ntell them that their width is limited to a certain amount. layoutNode() may return a value expressing\nhow much the popup had to be modified to fit into the available space. This is used to determine\nwhat the best placement is." }, { "name": "aroundNodeCoords", "type": "Object", "usage": "required", "summary": "Size of aroundNode, ex: {w: 200, h: 50}" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "placeOnScreenAroundNode", "scope": "normal", "summary": "Position node adjacent or kitty-corner to aroundNode\nsuch that it's fully visible in viewport.", "description": "Place node such that corner of node touches a corner of\naroundNode, and that node is fully visible.", "examples": { "example": "\tdijit.placeOnScreenAroundNode(node, aroundNode, {'BL':'TL', 'TR':'BR'});\nThis will try to position node such that node's top-left corner is at the same position\nas the bottom left corner of the aroundNode (ie, put node below\naroundNode, with left edges aligned). If that fails it will try to put\nthe bottom-right corner of node where the top right corner of aroundNode is\n(ie, put node above aroundNode, with right edges aligned)" }, "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "aroundNode", "type": "DomNode", "usage": "required" }, { "name": "aroundCorners", "type": "Object", "usage": "required", "summary": "Ordered list of pairs of corners to try matching up.\nEach pair of corners is represented as a key\/value in the hash,\nwhere the key corresponds to the aroundNode's corner, and\nthe value corresponds to the node's corner:\n\n\t{ aroundNodeCorner1: nodeCorner1, aroundNodeCorner2: nodeCorner2, ...}\n\nThe following strings are used to represent the four corners:\n* "BL" - bottom left\n* "BR" - bottom right\n* "TL" - top left\n* "TR" - top right" }, { "name": "layoutNode", "type": "Function", "usage": "optional", "summary": "Function(node, aroundNodeCorner, nodeCorner)\nFor things like tooltip, they are displayed differently (and have different dimensions)\nbased on their orientation relative to the parent. This adjusts the popup based on orientation." } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "placeOnScreenAroundRectangle", "scope": "normal", "summary": "Like dijit.placeOnScreenAroundNode(), except that the "around"\nparameter is an arbitrary rectangle on the screen (x, y, width, height)\ninstead of a dom node.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "aroundRect", "type": "dijit.__Rectangle", "usage": "required" }, { "name": "aroundCorners", "type": "Object", "usage": "required" }, { "name": "layoutNode", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "_placeOnScreenAroundRect", "scope": "normal", "private": true, "summary": "Like dijit.placeOnScreenAroundNode(), except it accepts coordinates\nof a rectangle to place node adjacent to.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "x", "type": "Number", "usage": "required" }, { "name": "y", "type": "Number", "usage": "required" }, { "name": "width", "type": "Number", "usage": "required" }, { "name": "height", "type": "Number", "usage": "required" }, { "name": "aroundCorners", "type": "Object", "usage": "required" }, { "name": "layoutNode", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "placeOnScreenAroundElement", "scope": "normal", "summary": "Like dijit.placeOnScreenAroundNode(), except it accepts an arbitrary object\nfor the "around" argument and finds a proper processor to place a node.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "aroundElement", "type": "Object", "usage": "required" }, { "name": "aroundCorners", "type": "Object", "usage": "required" }, { "name": "layoutNode", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "getPopupAroundAlignment", "scope": "normal", "summary": "Transforms the passed array of preferred positions into a format suitable for passing as the aroundCorners argument to dijit.placeOnScreenAroundElement.", "parameters": [ { "name": "position", "type": "Array", "usage": "required", "summary": "String[] This variable controls the position of the drop down.\nIt's an array of strings with the following values:\n\n* before: places drop down to the left of the target node\/widget, or to the right in\nthe case of RTL scripts like Hebrew and Arabic\n* after: places drop down to the right of the target node\/widget, or to the left in\nthe case of RTL scripts like Hebrew and Arabic\n* above: drop down goes above target node\n* below: drop down goes below target node\n\nThe list is positions is tried, in order, until a position is found where the drop down fits\nwithin the viewport." }, { "name": "leftToRight", "type": "Boolean", "usage": "required", "summary": "Whether the popup will be displaying in leftToRight mode." } ] }, { "resources": [ "dijit\/_base\/scroll.js" ], "provides": [ "dijit._base.scroll" ], "name": "scrollIntoView", "scope": "normal", "summary": "Scroll the passed node into view, if it is not already.\nDeprecated, use dojo.window.scrollIntoView<\/code> instead.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "pos", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "hasWaiRole", "scope": "normal", "summary": "Determines if an element has a particular role.", "return-description": "True if elem has the specific role attribute and false if not.\nFor backwards compatibility if role parameter not provided,\nreturns true if has a role", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "optional" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiRole", "scope": "normal", "summary": "Gets the role for an element (which should be a wai role).", "return-description": "The role of elem or an empty string if elem\ndoes not have a role.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "setWaiRole", "scope": "normal", "summary": "Sets the role on an element.", "description": "Replace existing role attribute with new role.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "removeWaiRole", "scope": "normal", "summary": "Removes the specified role from an element.\nRemoves role attribute if no specific role provided (for backwards compat.)", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "hasWaiState", "scope": "normal", "summary": "Determines if an element has a given state.", "description": "Checks for an attribute called \"aria-\"+state.", "return-description": "true if elem has a value for the given state and\nfalse if it does not.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiState", "scope": "normal", "summary": "Gets the value of a state on an element.", "description": "Checks for an attribute called \"aria-\"+state.", "return-description": "The value of the requested state on elem\nor an empty string if elem has no value for state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "setWaiState", "scope": "normal", "summary": "Sets a state on an element.", "description": "Sets an attribute called \"aria-\"+state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" }, { "name": "value", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "removeWaiState", "scope": "normal", "summary": "Removes a state from an element.", "description": "Sets an attribute called \"aria-\"+state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/window.js" ], "provides": [ "dijit._base.window" ], "name": "getDocumentWindow", "scope": "normal", "parameters": [ { "name": "doc", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/form\/TextBox.js" ], "provides": [ "dijit.form.TextBox" ], "name": "selectInputText", "scope": "normal", "summary": "Select text in the input element argument, from start (default 0), to stop (default end).", "parameters": [ { "name": "element", "type": "DomNode", "usage": "required" }, { "name": "start", "type": "Number", "usage": "optional" }, { "name": "stop", "type": "Number", "usage": "optional" } ] } ] }, "dijit.Calendar": { "location": "dijit.Calendar", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A simple GUI for choosing a date in the context of a monthly calendar.", "description": "A simple GUI for choosing a date in the context of a monthly calendar.\nThis widget can't be used in a form because it doesn't serialize the date to an\n`` field. For a form element, use dijit.form.DateTextBox instead.\n\nNote that the parser takes all dates attributes passed in the\n[RFC 3339 format](http:\/\/www.faqs.org\/rfcs\/rfc3339.html), e.g. `2005-06-30T08:05:00-07:00`\nso that they are serializable and locale-independent.", "examples": [ "\tvar calendar = new dijit.Calendar({}, dojo.byId(\"calendarNode\"));", "\t
<\/div>" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object" }, { "name": "widgetsInTemplate", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object" }, { "name": "value", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Date", "summary": "The currently selected Date, initially set to invalid date to indicate no selection.\n\n\nTODO: for 2.0 make this a string (ISO format) rather than a Date" }, { "name": "datePackage", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "instance-prototype", "type": "String", "summary": "JavaScript namespace to find Calendar routines. Uses Gregorian Calendar routines\nat dojo.date by default." }, { "name": "dayWidth", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "String", "summary": "How to represent the days of the week in the calendar header. See dojo.date.locale" }, { "name": "tabIndex", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Integer", "summary": "Order fields are traversed when user hits the tab key" }, { "name": "currentFocus", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Date", "summary": "Date object containing the currently focused date, or the date which would be focused\nif the calendar itself was focused. Also indicates which year and month to display,\ni.e. the current "page" the calendar is on." }, { "name": "baseClass", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "String" }, { "name": "_currentNode", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "dateClassObj", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "instance", "type": "Object" }, { "name": "dateFuncObj", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "instance", "type": "Object" }, { "name": "dateLocaleModule", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "instance", "type": "Object" } ], "methods": [ { "constructor": "constructor", "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_isValidDate", "scope": "prototype", "private": true, "summary": "Runs various tests on the value, checking that it's a valid date, rather\nthan blank or NaN.", "parameters": [ { "name": "value", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "setValue", "scope": "prototype", "summary": "Deprecated. Use set('value', ...) instead.", "parameters": [ { "name": "value", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_getValueAttr", "scope": "prototype", "private": true, "summary": "Support get('value')" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setValueAttr", "scope": "prototype", "summary": "Support set("value", ...)", "description": "Set the current date and update the UI. If the date is disabled, the value will\nnot change, but the display will change to the corresponding month.", "parameters": [ { "name": "value", "type": "Date|Number", "usage": "required", "summary": "Either a Date or the number of seconds since 1970." }, { "name": "priorityChange", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setText", "scope": "prototype", "private": true, "summary": "This just sets the content of node to the specified text.\nCan't do "node.innerHTML=text" because of an IE bug w\/tables, see #3434.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "text", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_populateGrid", "scope": "prototype", "private": true, "summary": "Fills in the calendar grid with each day (1-31)" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "goToToday", "scope": "prototype", "summary": "Sets calendar's value to today's date" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "constructor", "scope": "prototype", "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_adjustDisplay", "scope": "prototype", "private": true, "summary": "Moves calendar forwards or backwards by months or years", "parameters": [ { "name": "part", "type": "String", "usage": "required", "summary": ""month" or "year"" }, { "name": "amount", "type": "int", "usage": "required", "summary": "Number of months or years" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setCurrentFocusAttr", "scope": "prototype", "private": true, "summary": "If the calendar currently has focus, then focuses specified date,\nchanging the currently displayed month\/year if necessary.\nIf the calendar doesn't have focus, updates currently\ndisplayed month\/year, and sets the cell that will get focus.", "parameters": [ { "name": "date", "type": "Date", "usage": "required" }, { "name": "forceFocus", "type": "Boolean", "usage": "required", "summary": "If true, will focus() the cell even if calendar itself doesn't have focus" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "focus", "scope": "prototype", "summary": "Focus the calendar by focusing one of the calendar cells" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onMonthSelect", "scope": "prototype", "summary": "Handler for when user selects a month from the drop down list", "parameters": [ { "name": "newMonth", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayClick", "scope": "prototype", "summary": "Handler for day clicks, selects the date if appropriate", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseOver", "scope": "prototype", "summary": "Handler for mouse over events on days, sets hovered style", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseOut", "scope": "prototype", "summary": "Handler for mouse out events on days, clears hovered style", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseDown", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseUp", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "handleKey", "scope": "prototype", "summary": "Provides keyboard navigation of calendar.", "description": "Called from _onKeyPress() to handle keypress on a stand alone Calendar,\nand also from `dijit.form._DateTimeTextBox` to pass a keypress event\nfrom the `dijit.form.DateTextBox` to be handled in this widget", "return-description": "False if the key was recognized as a navigation key,\nto indicate that the event was handled by Calendar and shouldn't be propogated", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onKeyPress", "scope": "prototype", "private": true, "summary": "For handling keypress events on a stand alone calendar", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onValueSelected", "scope": "prototype", "summary": "Notification that a date cell was selected. It may be the same as the previous value.", "description": "Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)\nto get notification when the user has clicked a date. Now onExecute() (above) is used.", "parameters": [ { "name": "date", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onChange", "scope": "prototype", "summary": "Called only when the selected date has changed", "parameters": [ { "name": "date", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_isSelectedDate", "scope": "prototype", "tags": "extension", "summary": "Extension point so developers can subclass Calendar to\nsupport multiple (concurrently) selected dates", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "isDisabledDate", "scope": "prototype", "tags": "extension", "summary": "May be overridden to disable certain dates in the calendar e.g. isDisabledDate=dojo.date.locale.isWeekend<\/code>", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "getClassForDate", "scope": "prototype", "tags": "extension", "summary": "May be overridden to return CSS classes to associate with the date entry for the given dateObject,\nfor example to indicate a holiday in specified locale.", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "String" } ] } ] }, "dijit.Calendar.cssStateNodes": { "location": "dijit.Calendar.cssStateNodes", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "properties": [ { "name": "decrementMonth", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "normal", "type": "String" }, { "name": "incrementMonth", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "normal", "type": "String" }, { "name": "previousYearLabelNode", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "normal", "type": "String" }, { "name": "nextYearLabelNode", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "normal", "type": "String" } ] }, "dijit.Calendar.monthDropDownButton.containerNode": { "location": "dijit.Calendar.monthDropDownButton.containerNode", "type": null, "properties": [ { "name": "innerHTML", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "String" } ] }, "dijit.Calendar.monthDropDownButton": { "location": "dijit.Calendar.monthDropDownButton", "type": null, "properties": [ { "name": "dropDown", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object" } ] }, "dijit.Calendar._MonthDropDown": { "location": "dijit.Calendar._MonthDropDown", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "The month drop down", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" } ] }, "properties": [ { "name": "months", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "String[]", "summary": "List of names of months, possibly w\/some undefined entries for Hebrew leap months\n(ex: ["January", "February", undefined, "April", ...])" }, { "name": "templateString", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "String" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setMonthsAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "months", "type": "String[]", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onClick", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onChange", "scope": "prototype", "summary": "Callback when month is selected from drop down", "parameters": [ { "name": "month", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onMenuHover", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] } ] }, "dijit.Calendar._MonthDropDown.domNode": { "location": "dijit.Calendar._MonthDropDown.domNode", "type": null, "properties": [ { "name": "innerHTML", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object" } ] }, "dijit.CheckedMenuItem": { "location": "dijit.CheckedMenuItem", "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "type": "Function", "classlike": true, "superclass": "dijit.MenuItem", "summary": "A checkbox-like menu item for toggling on and off", "mixins": { "instance": [ { "scope": "instance", "location": "dijit.MenuItem" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "scope": "prototype", "type": "Object" }, { "name": "checked", "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "scope": "prototype", "type": "Boolean", "summary": "Our checked state" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "name": "_setCheckedAttr", "scope": "prototype", "private": true, "summary": "Hook so attr('checked', bool) works.\nSets the class and state for the check box.", "parameters": [ { "name": "checked", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "name": "onChange", "scope": "prototype", "tags": "callback", "summary": "User defined function to handle check\/uncheck events", "parameters": [ { "name": "checked", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Clicking this item just toggles its state", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] } ] }, "dijit.ColorPalette": { "location": "dijit.ColorPalette", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A keyboard accessible color-picking widget", "description": "Grid showing various colors, so the user can pick a certain color.\nCan be used standalone, or as a popup.", "examples": [ "\t
<\/div>", "\tvar picker = new dijit.ColorPalette({ },srcNode);\n\tpicker.startup();" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" }, { "scope": "prototype", "location": "dijit._PaletteMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" }, { "scope": "instance", "location": "dijit._PaletteMixin" } ] }, "properties": [ { "name": "palette", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "tags": "const", "summary": "Size of grid, either "7x10" or "3x4"." }, { "name": "templateString", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "summary": "The template of this widget." }, { "name": "baseClass", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String" }, { "name": "dyeClass", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "buildRendering", "scope": "prototype" } ] }, "dijit.ColorPalette._palettes": { "location": "dijit.ColorPalette._palettes", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Map", "summary": "This represents the value of the colors.\nThe first level is a hashmap of the different palettes available.\nThe next two dimensions represent the columns and rows of colors.", "properties": [ { "name": "7x10", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Array", "privateparent": true }, { "name": "3x4", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Array", "privateparent": true } ] }, "dijit.ColorPalette._imagePaths": { "location": "dijit.ColorPalette._imagePaths", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Map", "summary": "This is stores the path to the palette images", "properties": [ { "name": "7x10", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Object", "privateparent": true }, { "name": "3x4", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Object", "privateparent": true }, { "name": "7x10-rtl", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Object", "privateparent": true }, { "name": "3x4-rtl", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Object", "privateparent": true } ] }, "dijit._Color": { "location": "dijit._Color", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Function", "classlike": true, "superclass": "dojo.Color", "mixins": { "instance": [ { "scope": "instance", "location": "dojo.Color" } ] }, "properties": [ { "name": "_alias", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "instance", "type": null, "private": true } ], "methods": [ { "constructor": "constructor", "parameters": [ { "name": "alias", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "constructor", "scope": "prototype", "parameters": [ { "name": "alias", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "getValue", "scope": "prototype", "summary": "Note that although dijit._Color is initialized with a value like "white" getValue() always\nreturns a hex value" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "fillCell", "scope": "prototype", "parameters": [ { "name": "cell", "type": "DOMNode", "usage": "required" }, { "name": "blankGif", "type": "String", "usage": "required" } ] } ] }, "dijit.Declaration": { "location": "dijit.Declaration", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "The Declaration widget allows a developer to declare new widget\nclasses directly from a snippet of markup.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._Widget" } ] }, "properties": [ { "name": "_noScript", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "Boolean", "private": true, "summary": "Flag to parser to leave alone the script tags contained inside of me" }, { "name": "stopParser", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "Boolean", "private": true, "summary": "Flag to parser to not try and parse widgets declared inside of me" }, { "name": "widgetClass", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "String", "tags": "const", "summary": "Name of class being declared, ex: "acme.myWidget"" }, { "name": "mixins", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "String[]", "tags": "const", "summary": "List containing the prototype for this widget, and also any mixins,\nex: ["dijit._Widget", "dijit._Container"]" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "name": "buildRendering", "scope": "prototype" } ] }, "dijit.Declaration.defaults": { "location": "dijit.Declaration.defaults", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "properties": [ { "name": "widgetsInTemplate", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "Object" }, { "name": "_skipNodeCache", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "templateString", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "String" } ] }, "dijit._DialogBase": { "location": "dijit._DialogBase", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "type": "Function", "classlike": true, "superclass": "dijit._Templated", "summary": "A modal dialog Widget", "description": "Pops up a modal dialog window, blocking access to the screen\nand also graying out the screen Dialog is extended from\nContentPane so it supports all the same parameters (href, etc.)", "examples": [ "\t
<\/div>", "\tvar foo = new dijit.Dialog({ title: \"test dialog\", content: \"test content\" };\n\tdojo.body().appendChild(foo.domNode);\n\tfoo.startup();" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit.form._FormMixin.prototype" }, { "scope": "prototype", "location": "dijit._DialogMixin.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Templated" }, { "scope": "instance", "location": "dijit.form._FormMixin" }, { "scope": "instance", "location": "dijit._DialogMixin" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object" }, { "name": "baseClass", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "String" }, { "name": "attributeMap", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object" }, { "name": "open", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "tags": "readonly", "summary": "True if Dialog is currently displayed on screen." }, { "name": "duration", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "normal", "type": "Integer", "summary": "The time in milliseconds it takes the dialog to fade in and out" }, { "name": "refocus", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "summary": "A Toggle to modify the default focus behavior of a Dialog, which\nis to re-focus the element which had focus before being opened.\nFalse will disable refocusing. Default: true" }, { "name": "autofocus", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "summary": "A Toggle to modify the default focus behavior of a Dialog, which\nis to focus on the first dialog element after opening the dialog.\nFalse will disable autofocusing. Default: true" }, { "name": "_firstFocusItem", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "DomNode", "tags": "readonly", "private": true, "summary": "The pointer to the first focusable node in the dialog.\nSet by dijit._DialogMixin._getFocusItems<\/code>." }, { "name": "_lastFocusItem", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "DomNode", "tags": "readonly", "private": true, "summary": "The pointer to which node has focus prior to our dialog.\nSet by dijit._DialogMixin._getFocusItems<\/code>." }, { "name": "doLayout", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "summary": "Don't change this parameter from the default value.\nThis ContentPane parameter doesn't make sense for Dialog, since Dialog\nis never a child of a layout container, nor can you specify the size of\nDialog in order to control the size of an inner widget." }, { "name": "draggable", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "summary": "Toggles the moveable aspect of the Dialog. If true, Dialog\ncan be dragged by it's title. If false it will remain centered\nin the viewport." }, { "name": "aria-describedby", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "String", "summary": "Allows the user to add an aria-describedby attribute onto the dialog. The value should\nbe the id of the container element of text that describes the dialog purpose (usually\nthe first text in the dialog).\n<div dojoType="dijit.Dialog" aria-describedby="intro" .....>\n<div id="intro">Introductory text<\/div>\n<div>rest of dialog contents<\/div>\n<\/div>" }, { "name": "_modalconnects", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Array", "private": true }, { "name": "_relativePosition", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "domNode", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": null }, { "name": "_moveable", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": null, "private": true }, { "name": "_dndListener", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "underlayAttrs", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object" }, { "name": "_singleChildOriginalStyle", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": null, "private": true }, { "name": "_alreadyInitialized", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_fadeInDeferred", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_fadeOutDeferred", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_scrollConnected", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "bool", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "onLoad", "scope": "prototype", "tags": "callback", "summary": "Called when data has been loaded from an href.\nUnlike most other callbacks, this function can be connected to (via dojo.connect<\/code>)\nbut should *not* be overridden." }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_endDrag", "scope": "prototype", "private": true, "summary": "Called after dragging the Dialog. Saves the position of the dialog in the viewport.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_setup", "scope": "prototype", "private": true, "summary": "Stuff we need to do before showing the Dialog for the first\ntime (but we defer it until right beforehand, for\nperformance reasons)." }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_size", "scope": "prototype", "private": true, "summary": "If necessary, shrink dialog contents so dialog fits in viewport" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_position", "scope": "prototype", "private": true, "summary": "Position modal dialog in the viewport. If no relative offset\nin the viewport has been determined (by dragging, for instance),\ncenter the node. Otherwise, use the Dialog's stored relative offset,\nand position the node to top: left: values based on the viewport." }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_onKey", "scope": "prototype", "private": true, "summary": "Handles the keyboard events for accessibility reasons", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ], "return-types": [ { "type": "just let it go" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "show", "scope": "prototype", "summary": "Display the dialog", "return-description": "dojo.Deferred\nDeferred object that resolves when the display animation is complete" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "hide", "scope": "prototype", "summary": "Hide the dialog", "return-description": "dojo.Deferred\nDeferred object that resolves when the hide animation is complete" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "layout", "scope": "prototype", "private": true, "summary": "Position the Dialog and the underlay" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "destroy", "scope": "prototype" } ] }, "dijit._DialogBase.cssStateNodes": { "location": "dijit._DialogBase.cssStateNodes", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "properties": [ { "name": "closeButtonNode", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "normal", "type": "String" } ] }, "dijit._DialogBase._singleChild.domNode.style": { "location": "dijit._DialogBase._singleChild.domNode.style", "type": null, "properties": [ { "name": "cssText", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": null, "privateparent": true } ] }, "dijit.Dialog": { "location": "dijit.Dialog", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "type": "Function", "classlike": true, "superclass": "dijit.layout.ContentPane", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._DialogBase.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.layout.ContentPane" }, { "scope": "instance", "location": "dijit._DialogBase" } ] }, "methods": [ { "constructor": "constructor" } ] }, "dijit._DialogLevelManager": { "location": "dijit._DialogLevelManager", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "private": true, "summary": "Controls the various active "levels" on the page, starting with the\nstuff initially visible on the page (at z-index 0), and then having an entry for\neach Dialog shown.", "methods": [ { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "show", "scope": "normal", "summary": "Call right before fade-in animation for new dialog.\nSaves current focus, displays\/adjusts underlay for new dialog,\nand sets the z-index of the dialog itself.\n\nNew dialog will be displayed on top of all currently displayed dialogs.\n\nCaller is responsible for setting focus in new dialog after the fade-in\nanimation completes.", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" }, { "name": "underlayAttrs", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "hide", "scope": "normal", "summary": "Called when the specified dialog is hidden\/destroyed, after the fade-out\nanimation ends, in order to reset page focus, fix the underlay, etc.\nIf the specified dialog isn't open then does nothing.\n\nCaller is responsible for either setting display:none on the dialog domNode,\nor calling dijit.popup.hide(), or removing it from the page DOM.", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "isTop", "scope": "normal", "summary": "Returns true if specified Dialog is the top in the task", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" } ] } ] }, "dijit.DialogUnderlay": { "location": "dijit.DialogUnderlay", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "The component that blocks the screen behind a dijit.Dialog<\/code>", "description": "A component used to block input behind a `dijit.Dialog`. Only a single\ninstance of this widget is created by `dijit.Dialog`, and saved as\na reference to be shared between all Dialogs as `dijit._underlay`\n\nThe underlay itself can be styled based on and id:\n\t#myDialog_underlay { background-color:red; }\n\nIn the case of `dijit.Dialog`, this id is based on the id of the Dialog,\nsuffixed with _underlay.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" }, { "name": "dialogId", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String", "summary": "Id of the dialog.... DialogUnderlay's id is based on this id" }, { "name": "class", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String", "summary": "This class name is used on the DialogUnderlay node, in addition to dijitDialogUnderlay" }, { "name": "bgIframe", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "_setDialogIdAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "id", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "_setClassAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "clazz", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "postCreate", "scope": "prototype", "summary": "Append the underlay to the body" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "layout", "scope": "prototype", "private": true, "summary": "Sets the background to the size of the viewport", "description": "Sets the background to the size of the viewport (rather than the size\nof the document) since we need to cover the whole browser window, even\nif the document is only a few lines long." }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "show", "scope": "prototype", "summary": "Show the dialog underlay" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "hide", "scope": "prototype", "summary": "Hides the dialog underlay" } ] }, "dijit.DialogUnderlay.attributeMap": { "location": "dijit.DialogUnderlay.attributeMap", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "properties": [ { "name": "id", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "normal", "type": "String" } ] }, "dijit.DialogUnderlay.node": { "location": "dijit.DialogUnderlay.node", "type": null, "properties": [ { "name": "className", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" } ] }, "dijit.DialogUnderlay.domNode": { "location": "dijit.DialogUnderlay.domNode", "type": null }, "dijit.DialogUnderlay.domNode.style": { "location": "dijit.DialogUnderlay.domNode.style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": null, "properties": [ { "name": "display", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" }, { "name": "top", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" }, { "name": "left", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" } ] }, "dijit.DialogUnderlay.node.style": { "location": "dijit.DialogUnderlay.node.style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": null, "properties": [ { "name": "width", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" }, { "name": "height", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": "String" } ] }, "dijit.Editor": { "location": "dijit.Editor", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "type": "Function", "classlike": true, "superclass": "dijit._editor.RichText", "summary": "A rich text Editing widget", "description": "This widget provides basic WYSIWYG editing features, based on the browser's\nunderlying rich text editing capability, accompanied by a toolbar (`dijit.Toolbar`).\nA plugin model is available to extend the editor's capabilities as well as the\nthe options available in the toolbar. Content generation may vary across\nbrowsers, and clipboard operations may have different results, to name\na few limitations. Note: this widget should not be used with the HTML\n<TEXTAREA> tag -- see dijit._editor.RichText for details.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._editor.RichText" } ] }, "properties": [ { "name": "plugins", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "instance-prototype", "type": "Object[]", "tags": "const", "summary": "A list of plugin names (as strings) or instances (as objects)\nfor this widget.\n\nWhen declared in markup, it might look like:\n\tplugins="['bold',{name:'dijit._editor.plugins.FontChoice', command:'fontName', generic:true}]"" }, { "name": "extraPlugins", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object[]", "tags": "const", "summary": "A list of extra plugin names which will be appended to plugins array\n\n\nthe following 3 functions are required to make the editor play nice under a layout widget, see #4070" }, { "name": "setValueDeferred", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object" }, { "name": "_steps", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Array", "private": true }, { "name": "_undoedSteps", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Array", "private": true }, { "name": "commands", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object" }, { "name": "toolbar", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object" }, { "name": "_plugins", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "instance-prototype", "type": "Array", "private": true }, { "name": "_layoutMode", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "customUndo", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Boolean", "summary": "Whether we shall use custom undo\/redo support instead of the native\nbrowser support. By default, we now use custom undo. It works better\nthan native browser support and provides a consistent behavior across\nbrowsers with a minimal performance hit. We already had the hit on\nthe slowest browser, IE, anyway." }, { "name": "editActionInterval", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Integer", "summary": "When using customUndo, not every keystroke will be saved as a step.\nInstead typing (including delete) will be grouped together: after\na user stops typing for editActionInterval seconds, a step will be\nsaved; if a user resume typing within editActionInterval seconds,\nthe timeout will be restarted. By default, editActionInterval is 3\nseconds." }, { "name": "_inEditing", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "bool", "private": true }, { "name": "_editTimer", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_undoRedoActive", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_savedSelection", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_editInterval", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "instance", "type": "Number", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "constructor", "scope": "prototype", "private": true, "summary": "Runs on widget initialization to setup arrays etc." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "postMixInProperties", "scope": "prototype", "summary": "Extension to make sure a deferred is in place before certain functions\nexecute, like making sure all the plugins are properly inserted." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "addPlugin", "scope": "prototype", "summary": "takes a plugin name as a string or a plugin instance and\nadds it to the toolbar and associates it with this editor\ninstance. The resulting plugin is added to the Editor's\nplugins array. If index is passed, it's placed in the plugins\narray at that index. No big magic, but a nice helper for\npassing in plugin names via markup.", "parameters": [ { "name": "plugin", "type": "String||Object", "usage": "required", "summary": "String, args object or plugin instance\n\nargs:\nThis object will be passed to the plugin constructor" }, { "name": "index", "type": "Integer", "usage": "optional", "summary": "Used when creating an instance from\nsomething already in this.plugins. Ensures that the new\ninstance is assigned to this.plugins at that index." } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "startup", "scope": "prototype", "tags": "console.log('startup',arguments);", "summary": "Exists to make Editor work as a child of a layout widget.\nDevelopers don't need to call this method." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "resize", "scope": "prototype", "summary": "Resize the editor to the specified size, see dijit.layout._LayoutWidget.resize<\/code>", "parameters": [ { "name": "size", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "layout", "scope": "prototype", "summary": "Called from dijit.layout._LayoutWidget.resize<\/code>. This shouldn't be called directly" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_onIEMouseDown", "scope": "prototype", "private": true, "summary": "IE only to prevent 2 clicks to focus", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onBeforeActivate", "scope": "prototype", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onBeforeDeactivate", "scope": "prototype", "private": true, "summary": "Called on IE right before focus is lost. Saves the selected range.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "beginEditing", "scope": "prototype", "private": true, "summary": "Called to note that the user has started typing alphanumeric characters, if it's not already noted.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "execCommand", "scope": "prototype", "summary": "Main handler for executing any commands to the editor, like paste, bold, etc.\nCalled by plugins, but not meant to be called by end users.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "queryCommandEnabled", "scope": "prototype", "summary": "Returns true if specified editor command is enabled.\nUsed by the plugins to know when to highlight\/not highlight buttons.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_moveToBookmark", "scope": "prototype", "private": true, "summary": "Selects the text specified in bookmark b", "parameters": [ { "name": "b", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_changeToStep", "scope": "prototype", "private": true, "summary": "Reverts editor to "to" setting, from the undo stack.", "parameters": [ { "name": "from", "type": null, "usage": "required" }, { "name": "to", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "undo", "scope": "prototype", "tags": "console.log('undo');", "private": true, "summary": "Handler for editor undo (ex: ctrl-z) operation" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "redo", "scope": "prototype", "tags": "console.log('redo');", "private": true, "summary": "Handler for editor redo (ex: ctrl-y) operation" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "endEditing", "scope": "prototype", "private": true, "summary": "Called to note that the user has stopped typing alphanumeric characters, if it's not already noted.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "ignore_caret", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_getBookmark", "scope": "prototype", "summary": "Get the currently selected text" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_beginEditing", "scope": "prototype", "private": true, "summary": "Called when the user starts typing alphanumeric characters.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_endEditing", "scope": "prototype", "tags": "Avoid filtering to make sure selections restore.", "private": true, "summary": "Called when the user stops typing alphanumeric characters.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "ignore_caret", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onKeyDown", "scope": "prototype", "private": true, "summary": "Handler for onkeydown event.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_onBlur", "scope": "prototype", "summary": "Called from focus manager when focus has moved away from this editor" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_saveSelection", "scope": "prototype", "private": true, "summary": "Save the currently selected text in _savedSelection attribute" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_restoreSelection", "scope": "prototype", "private": true, "summary": "Re-select the text specified in _savedSelection attribute;\nsee _saveSelection()." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onClick", "scope": "prototype", "summary": "Handler for when editor is clicked" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "replaceValue", "scope": "prototype", "summary": "over-ride of replaceValue to support custom undo and stack maintainence.", "parameters": [ { "name": "html", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "value", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_setStateClass", "scope": "prototype", "private": true } ] }, "dijit.Editor.editingArea.style": { "location": "dijit.Editor.editingArea.style", "type": null, "properties": [ { "name": "height", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "String" } ] }, "dijit.Editor.iframe.style": { "location": "dijit.Editor.iframe.style", "type": null, "properties": [ { "name": "height", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": "String" } ] }, "dijit.Editor.document": { "location": "dijit.Editor.document", "type": null }, "dijit.Editor.document.body": { "location": "dijit.Editor.document.body", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "type": null, "properties": [ { "name": "clientWidth", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null }, { "name": "clientHeight", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null }, { "name": "clientLeft", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null }, { "name": "offsetWidth", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null }, { "name": "offsetHeight", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null }, { "name": "offsetLeft", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null } ] }, "dijit._editor": { "location": "dijit._editor", "resources": [ "dijit\/_editor\/RichText.js", "dijit\/_editor\/_Plugin.js", "dijit\/_editor\/html.js", "dijit\/_editor\/plugins\/AlwaysShowToolbar.js", "dijit\/_editor\/plugins\/EnterKeyHandling.js", "dijit\/_editor\/plugins\/FontChoice.js", "dijit\/_editor\/plugins\/FullScreen.js", "dijit\/_editor\/plugins\/LinkDialog.js", "dijit\/_editor\/plugins\/NewPage.js", "dijit\/_editor\/plugins\/Print.js", "dijit\/_editor\/plugins\/TabIndent.js", "dijit\/_editor\/plugins\/TextColor.js", "dijit\/_editor\/plugins\/ToggleDir.js", "dijit\/_editor\/plugins\/ViewSource.js", "dijit\/_editor\/range.js", "dijit\/_editor\/selection.js" ], "provides": [ "dijit._editor.RichText", "dijit._editor._Plugin", "dijit._editor.html", "dijit._editor.plugins.AlwaysShowToolbar", "dijit._editor.plugins.EnterKeyHandling", "dijit._editor.plugins.FontChoice", "dijit._editor.plugins.FullScreen", "dijit._editor.plugins.LinkDialog", "dijit._editor.plugins.NewPage", "dijit._editor.plugins.Print", "dijit._editor.plugins.TabIndent", "dijit._editor.plugins.TextColor", "dijit._editor.plugins.ToggleDir", "dijit._editor.plugins.ViewSource", "dijit._editor.range", "dijit._editor.selection" ], "private": true, "properties": [ { "name": "html", "resources": [ "dijit\/_editor\/html.js" ], "provides": [ "dijit._editor.html" ], "scope": "normal", "type": "Object", "privateparent": true }, { "name": "range", "resources": [ "dijit\/_editor\/range.js" ], "provides": [ "dijit._editor.range" ], "scope": "normal", "type": "Object", "privateparent": true } ], "methods": [ { "resources": [ "dijit\/_editor\/html.js" ], "provides": [ "dijit._editor.html" ], "name": "escapeXml", "scope": "normal", "privateparent": true, "summary": "Adds escape sequences for special characters in XML: &<>"'\nOptionally skips escapes for single quotes", "parameters": [ { "name": "str", "type": "String", "usage": "required" }, { "name": "noSingleQuotes", "type": "Boolean", "usage": "optional" } ], "return-types": [ { "type": "string" } ] }, { "resources": [ "dijit\/_editor\/html.js" ], "provides": [ "dijit._editor.html" ], "name": "getNodeHtml", "scope": "normal", "privateparent": true, "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/html.js" ], "provides": [ "dijit._editor.html" ], "name": "getChildrenHtml", "scope": "normal", "privateparent": true, "summary": "Returns the html content of a DomNode and children", "parameters": [ { "name": "dom", "type": "DomNode", "usage": "required" } ], "return-types": [ { "type": "String" } ] } ] }, "dijit._editor._Plugin": { "location": "dijit._editor._Plugin", "resources": [ "dijit\/Editor.js", "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit.Editor", "dijit._editor._Plugin" ], "type": "Function", "classlike": true, "private": true, "privateparent": true, "properties": [ { "name": "editor", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "dijit.Editor", "tags": "const", "privateparent": true, "summary": "Points to the parent editor" }, { "name": "iconClassPrefix", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "String", "tags": "const", "privateparent": true, "summary": "The CSS class name for the button node is formed from iconClassPrefix<\/code> and command<\/code>" }, { "name": "button", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "dijit._Widget", "privateparent": true, "summary": "Pointer to dijit.form.Button<\/code> or other widget (ex: dijit.form.FilteringSelect<\/code>)\nthat is added to the toolbar to control this plugin.\nIf not specified, will be created on initialization according to buttonClass<\/code>" }, { "name": "command", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "String", "privateparent": true, "summary": "String like "insertUnorderedList", "outdent", "justifyCenter", etc. that represents an editor command.\nPassed to editor.execCommand() if useDefaultCommand<\/code> is true." }, { "name": "useDefaultCommand", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "Boolean", "privateparent": true, "summary": "If true, this plugin executes by calling Editor.execCommand() with the argument specified in command<\/code>." }, { "name": "buttonClass", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "normal", "type": "Widget", "privateparent": true, "summary": "Class\nClass of widget (ex: dijit.form.Button or dijit.form.FilteringSelect)\nthat is added to the toolbar to control this plugin.\nThis is used to instantiate the button, unless button<\/code> itself is specified directly." }, { "name": "disabled", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": "Boolean", "privateparent": true, "summary": "Flag to indicate if this plugin has been disabled and should do nothing\nhelps control button state, among other things. Set via the setter api." }, { "name": "enabled", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": null, "privateparent": true }, { "name": "checked", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "prototype", "type": null, "privateparent": true }, { "name": "_attrPairNames", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "instance-prototype", "type": "Object", "private": true, "privateparent": true }, { "name": "params", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "instance", "type": "Object", "privateparent": true }, { "name": "_connects", "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "scope": "instance", "type": "Array", "private": true, "privateparent": true } ], "methods": [ { "constructor": "constructor", "parameters": [ { "name": "args", "type": "Object", "usage": "optional" }, { "name": "node", "type": "DomNode", "usage": "optional" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "constructor", "scope": "prototype", "privateparent": true, "parameters": [ { "name": "args", "type": "Object", "usage": "optional" }, { "name": "node", "type": "DomNode", "usage": "optional" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "getLabel", "scope": "prototype", "private": true, "privateparent": true, "summary": "Returns the label to use for the button", "parameters": [ { "name": "key", "type": "String", "usage": "required" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "_initButton", "scope": "prototype", "tags": "extension", "privateparent": true, "summary": "Initialize the button or other widget that will control this plugin.\nThis code only works for plugins controlling built-in commands in the editor." }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "destroy", "scope": "prototype", "privateparent": true, "summary": "Destroy this plugin" }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "connect", "scope": "prototype", "privateparent": true, "summary": "Make a dojo.connect() that is automatically disconnected when this plugin is destroyed.\nSimilar to dijit._Widget.connect<\/code>.", "parameters": [ { "name": "o", "type": null, "usage": "required" }, { "name": "f", "type": null, "usage": "required" }, { "name": "tf", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "updateState", "scope": "prototype", "privateparent": true, "summary": "Change state of the plugin to respond to events in the editor.", "description": "This is called on meaningful events in the editor, such as change of selection\nor caret position (but not simple typing of alphanumeric keys). It gives the\nplugin a chance to update the CSS of its button.\n\nFor example, the \"bold\" plugin will highlight\/unhighlight the bold button depending on whether the\ncharacters next to the caret are bold or not.\n\nOnly makes sense when `useDefaultCommand` is true, as it calls Editor.queryCommandEnabled(`command`)." }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "setEditor", "scope": "prototype", "privateparent": true, "summary": "Tell the plugin which Editor it is associated with.", "parameters": [ { "name": "editor", "type": "dijit.Editor", "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "setToolbar", "scope": "prototype", "privateparent": true, "summary": "Tell the plugin to add it's controller widget (often a button)\nto the toolbar. Does nothing if there is no controller widget.", "parameters": [ { "name": "toolbar", "type": "dijit.Toolbar", "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "set", "scope": "prototype", "privateparent": true, "summary": "Set a property on a plugin", "description": "Sets named properties on a plugin which may potentially be handled by a\nsetter in the plugin.\nFor example, if the plugin has a properties \"foo\"\nand \"bar\" and a method named \"_setFooAttr\", calling:\n\tplugin.set(\"foo\", \"Howdy!\");\nwould be equivalent to writing:\n\tplugin._setFooAttr(\"Howdy!\");\nand:\n\tplugin.set(\"bar\", 3);\nwould be equivalent to writing:\n\tplugin.bar = 3;\n\nset() may also be called with a hash of name\/value pairs, ex:\n\tplugin.set({\n\t\tfoo: \"Howdy\",\n\t\tbar: 3\n\t})\nThis is equivalent to calling set(foo, \"Howdy\") and set(bar, 3)", "parameters": [ { "name": "name", "type": "attribute", "usage": "required", "summary": "The property to set." }, { "name": "value", "type": "anything", "usage": "required", "summary": "The value to set in the property." } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "get", "scope": "prototype", "privateparent": true, "summary": "Get a property from a plugin.", "description": "Get a named property from a plugin. The property may\npotentially be retrieved via a getter method. If no getter is defined, this\njust retrieves the object's property.\nFor example, if the plugin has a properties \"foo\"\nand \"bar\" and a method named \"_getFooAttr\", calling:\n\tplugin.get(\"foo\");\nwould be equivalent to writing:\n\tplugin._getFooAttr();\nand:\n\tplugin.get(\"bar\");\nwould be equivalent to writing:\n\tplugin.bar;", "parameters": [ { "name": "name", "type": "The", "usage": "required", "summary": "property to get." } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "privateparent": true, "summary": "Function to set the plugin state and call updateState to make sure the\nbutton is updated appropriately.", "parameters": [ { "name": "disabled", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "_getAttrNames", "scope": "prototype", "private": true, "privateparent": true, "summary": "Helper function for get() and set().\nCaches attribute name values so we don't do the string ops every time.", "parameters": [ { "name": "name", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_editor\/_Plugin.js" ], "provides": [ "dijit._editor._Plugin" ], "name": "_set", "scope": "prototype", "private": true, "privateparent": true, "summary": "Helper function to set new value for specified attribute", "parameters": [ { "name": "name", "type": "String", "usage": "required" }, { "name": "value", "type": "anything", "usage": "required" } ] } ] }, "dijit.InlineEditBox": { "location": "dijit.InlineEditBox", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "An element with in-line edit capabilites", "description": "Behavior for an existing node (`

`, `

`, ``, etc.) so that\nwhen you click it, an editor shows up in place of the original\ntext. Optionally, Save and Cancel button are displayed below the edit widget.\nWhen Save is clicked, the text is pulled from the edit\nwidget and redisplayed and the edit widget is again hidden.\nBy default a plain Textarea widget is used as the editor (or for\ninline values a TextBox), but you can specify an editor such as\ndijit.Editor (for editing HTML) or a Slider (for adjusting a number).\nAn edit widget must support the following API to be used:\n- displayedValue or value as initialization parameter,\nand available through set('displayedValue') \/ set('value')\n- void focus()\n- DOM-node focusNode = node containing editable text", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._Widget" } ] }, "properties": [ { "name": "editing", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Boolean", "tags": "readonly", "summary": "Is the node currently in edit mode?" }, { "name": "autoSave", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Boolean", "summary": "Changing the value automatically saves it; don't have to push save button\n(and save button isn't even displayed)" }, { "name": "buttonSave", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String", "summary": "Save button label" }, { "name": "buttonCancel", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String", "summary": "Cancel button label" }, { "name": "renderAsHtml", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Boolean", "summary": "Set this to true if the specified Editor's value should be interpreted as HTML\nrather than plain text (ex: dijit.Editor<\/code>)" }, { "name": "editor", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String|Function", "summary": "Class name (or reference to the Class) for Editor widget" }, { "name": "editorWrapper", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String|Function", "summary": "Class name (or reference to the Class) for widget that wraps the editor widget, displaying save\/cancel\nbuttons." }, { "name": "editorParams", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "instance-prototype", "type": "Object", "summary": "Set of parameters for editor, like {required: true}" }, { "name": "disabled", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Boolean", "summary": "If true, clicking the InlineEditBox to edit it will have no effect." }, { "name": "width", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String", "summary": "Width of editor. By default it's width=100% (ie, block mode)." }, { "name": "value", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String", "summary": "The display value of the widget in read-only mode" }, { "name": "noValueIndicator", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String", "tags": "const", "summary": "The text that gets displayed when there is no value (so that the user has a place to click to edit)" }, { "name": "_savedPosition", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_savedOpacity", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_savedTabIndex", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "onChange", "scope": "prototype", "tags": "callback", "summary": "Set this handler to be notified of changes to value.", "parameters": [ { "name": "value", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "onCancel", "scope": "prototype", "tags": "callback", "summary": "Set this handler to be notified when editing is cancelled." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "constructor", "scope": "prototype", "private": true, "summary": "Sets up private arrays etc." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "setDisabled", "scope": "prototype", "summary": "Deprecated. Use set('disabled', ...) instead.", "parameters": [ { "name": "disabled", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("disabled", ...) work.\nSet disabled state of widget.", "parameters": [ { "name": "disabled", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onMouseOver", "scope": "prototype", "private": true, "summary": "Handler for onmouseover and onfocus event." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onMouseOut", "scope": "prototype", "private": true, "summary": "Handler for onmouseout and onblur event." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Handler for onclick event.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "edit", "scope": "prototype", "private": true, "summary": "Display the editor widget in place of the original (read only) markup." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onBlur", "scope": "prototype", "private": true, "summary": "Called when focus moves outside the InlineEditBox.\nPerforms garbage collection." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_showText", "scope": "prototype", "private": true, "summary": "Revert to display mode, and optionally focus on display node", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "save", "scope": "prototype", "private": true, "summary": "Save the contents of the editor and revert to display mode.", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required", "summary": "Focus on the display mode text" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "setValue", "scope": "prototype", "summary": "Deprecated. Use set('value', ...) instead.", "parameters": [ { "name": "val", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_setValueAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("value", ...) work.\nInserts specified HTML value into this node, or an "input needed" character if node is blank.", "parameters": [ { "name": "val", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "getValue", "scope": "prototype", "summary": "Deprecated. Use get('value') instead." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "cancel", "scope": "prototype", "private": true, "summary": "Revert to display mode, discarding any changes made in the editor", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required" } ] } ] }, "dijit.InlineEditBox.displayNode": { "location": "dijit.InlineEditBox.displayNode", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": null, "properties": [ { "name": "innerHTML", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" } ] }, "dijit.InlineEditBox.wrapperWidget": { "location": "dijit.InlineEditBox.wrapperWidget", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "properties": [ { "name": "editWidget", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": null } ] }, "dijit._InlineEditor": { "location": "dijit._InlineEditor", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Internal widget used by InlineEditBox, displayed when in editing mode\nto display the editor and maybe save\/cancel buttons. Calling code should\nconnect to save\/cancel methods to detect when editing is finished\n\nHas mainly the same parameters as InlineEditBox, plus these values:\n\nstyle: Object\nSet of CSS attributes of display node, to replicate in editor\n\nvalue: String\nValue as an HTML string or plain text string, depending on renderAsHTML flag", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" }, { "name": "widgetsInTemplate", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" }, { "name": "messages", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" }, { "name": "sourceStyle", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": null }, { "name": "editWidget", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onIntermediateChange", "scope": "prototype", "private": true, "summary": "Called for editor widgets that support the intermediateChanges=true flag as a way\nto detect when to enable\/disabled the save button", "parameters": [ { "name": "val", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "getValue", "scope": "prototype", "summary": "Return the [display] value of the edit widget" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onKeyPress", "scope": "prototype", "private": true, "summary": "Handler for keypress in the edit box in autoSave mode.", "description": "For autoSave widgets, if Esc\/Enter, call cancel\/save.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onBlur", "scope": "prototype", "private": true, "summary": "Called when focus moves outside the editor" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onChange", "scope": "prototype", "private": true, "summary": "Called when the underlying widget fires an onChange event,\nsuch as when the user selects a value from the drop down list of a ComboBox,\nwhich means that the user has finished entering the value and we should save." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "enableSave", "scope": "prototype", "tags": "extension", "summary": "User overridable function returning a Boolean to indicate\nif the Save button should be enabled or not - usually due to invalid conditions" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "focus", "scope": "prototype", "summary": "Focus the edit widget." } ] }, "dijit._InlineEditor.inlineEditBox": { "location": "dijit._InlineEditor.inlineEditBox", "type": null, "properties": [ { "name": "width", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": null } ] }, "dijit._InlineEditor.domNode.style": { "location": "dijit._InlineEditor.domNode.style", "type": null, "properties": [ { "name": "display", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "String" } ] }, "dijit._MenuBase": { "location": "dijit._MenuBase", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Base class for Menu and MenuBar", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" }, { "scope": "prototype", "location": "dijit._KeyNavContainer.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" }, { "scope": "instance", "location": "dijit._KeyNavContainer" } ] }, "properties": [ { "name": "parentMenu", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Widget", "tags": "readonly", "summary": "pointer to menu that displayed me" }, { "name": "popupDelay", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Integer", "summary": "number of milliseconds before hovering (without clicking) causes the popup to automatically open." }, { "name": "hover_timer", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object" }, { "name": "_hoveredChild", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_focus_timer", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "isActive", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "bool" }, { "name": "isShowingNow", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "bool" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "startup", "scope": "prototype" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onExecute", "scope": "prototype", "summary": "Attach point for notification about when a menu item has been executed.\nThis is an internal mechanism used for Menus to signal to their parent to\nclose them, because they are about to execute the onClick handler. In\ngeneral developers should not attach to or override this method." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onCancel", "scope": "prototype", "summary": "Attach point for notification about when the user cancels the current menu\nThis is an internal mechanism used for Menus to signal to their parent to\nclose them. In general developers should not attach to or override this method.", "parameters": [ { "name": "closeAll", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_moveToPopup", "scope": "prototype", "private": true, "summary": "This handles the right arrow key (left arrow key on RTL systems),\nwhich will either open a submenu, or move to the next item in the\nancestor MenuBar", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onPopupHover", "scope": "prototype", "private": true, "summary": "This handler is called when the mouse moves over the popup.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onItemHover", "scope": "prototype", "summary": "Called when cursor is over a MenuItem.", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onChildBlur", "scope": "prototype", "private": true, "summary": "Called when a child MenuItem becomes inactive because focus\nhas been removed from the MenuItem *and* it's descendant menus.", "parameters": [ { "name": "item", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onItemUnhover", "scope": "prototype", "summary": "Callback fires when mouse exits a MenuItem", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_stopPopupTimer", "scope": "prototype", "private": true, "summary": "Cancels the popup timer because the user has stop hovering\non the MenuItem, etc." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_stopPendingCloseTimer", "scope": "prototype", "private": true, "summary": "Cancels the pending-close timer because the close has been preempted", "parameters": [ { "name": "popup", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_stopFocusTimer", "scope": "prototype", "private": true, "summary": "Cancels the pending-focus timer because the menu was closed before focus occured" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_getTopMenu", "scope": "prototype", "private": true, "summary": "Returns the top menu in this chain of Menus" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onItemClick", "scope": "prototype", "private": true, "summary": "Handle clicks on an item.", "parameters": [ { "name": "item", "type": "dijit._Widget", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_openPopup", "scope": "prototype", "summary": "Open the popup to the side of\/underneath the current menu item", "return-types": [ { "type": "the focused child lost focus since the timer was started" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_markActive", "scope": "prototype", "private": true, "summary": "Mark this menu's state as active.\nCalled when this Menu gets focus from:\n1) clicking it (mouse or via space\/arrow key)\n2) being opened by a parent menu.\nThis is not called just from mouse hover.\nFocusing a menu via TAB does NOT automatically set isActive\nsince TAB is a navigation operation and not a selection one.\nFor Windows apps, pressing the ALT key focuses the menubar\nmenus (similar to TAB navigation) but the menu is not active\n(ie no dropdown) until an item is clicked." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onOpen", "scope": "prototype", "private": true, "summary": "Callback when this menu is opened.\nThis is called by the popup manager as notification that the menu\nwas opened.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_markInactive", "scope": "prototype", "private": true, "summary": "Mark this menu's state as inactive." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "onClose", "scope": "prototype", "private": true, "summary": "Callback when this menu is closed.\nThis is called by the popup manager as notification that the menu\nwas closed." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_closeChild", "scope": "prototype", "private": true, "summary": "Called when submenu is clicked or focus is lost. Close hierarchy of menus." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onItemFocus", "scope": "prototype", "private": true, "summary": "Called when child of this Menu gets focus from:\n1) clicking it\n2) tabbing into it\n3) being opened by a parent menu.\nThis is not called just from mouse hover.", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onBlur", "scope": "prototype", "summary": "Called when focus is moved away from this Menu and it's submenus." }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_cleanUp", "scope": "prototype", "private": true, "summary": "Called when the user is done with this menu. Closes hierarchy of menus." } ] }, "dijit._MenuBase.currentPopup": { "location": "dijit._MenuBase.currentPopup", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ] }, "dijit._MenuBase.currentPopup.parentMenu": { "location": "dijit._MenuBase.currentPopup.parentMenu", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "type": null, "properties": [ { "name": "focusedChild", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": null } ] }, "dijit._MenuBase.focusedChild": { "location": "dijit._MenuBase.focusedChild", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ] }, "dijit._MenuBase.focusedChild.popup": { "location": "dijit._MenuBase.focusedChild.popup", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "type": null, "properties": [ { "name": "parentMenu", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object" }, { "name": "from_item", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": null }, { "name": "_focus_timer", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object", "private": true } ] }, "dijit.Menu": { "location": "dijit.Menu", "resources": [ "dijit\/Menu.js", "dojox\/widget\/PlaceholderMenuItem.js" ], "provides": [ "dijit.Menu", "dojox.widget.PlaceholderMenuItem" ], "type": "Function", "classlike": true, "superclass": "dijit._MenuBase", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._MenuBase" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object" }, { "name": "baseClass", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "String" }, { "name": "targetNodeIds", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "String[]", "tags": "const", "summary": "Array of dom node ids of nodes to attach to.\nFill this with nodeIds upon widget creation and it becomes context menu for those nodes." }, { "name": "contextMenuForWindow", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Boolean", "tags": "const", "summary": "If true, right clicking anywhere on the window will cause this context menu to open.\nIf false, must specify targetNodeIds." }, { "name": "leftClickToOpen", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Boolean", "tags": "const", "summary": "If true, menu will open on left click instead of right click, similiar to a file menu." }, { "name": "refocus", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Boolean", "summary": "When this menu closes, re-focus the element which had focus before it was opened." }, { "name": "_openSubMenuKey", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": null, "private": true }, { "name": "_closeSubMenuKey", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": null, "private": true }, { "name": "_openTimer", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_bindings", "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "scope": "instance", "type": "Array", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onKeyPress", "scope": "prototype", "summary": "Handle keyboard based menu navigation.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_iframeContentWindow", "scope": "prototype", "private": true, "summary": "Returns the window reference of the passed iframe", "parameters": [ { "name": "iframe_el", "type": "HTMLIFrameElement", "usage": "required" } ], "return-types": [ { "type": "Window" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_iframeContentDocument", "scope": "prototype", "summary": "Returns a reference to the document object inside iframe_el", "parameters": [ { "name": "iframe_el", "type": "HTMLIFrameElement", "usage": "required" } ], "return-types": [ { "type": "HTMLDocument" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "bindDomNode", "scope": "prototype", "summary": "Attach menu to given node", "parameters": [ { "name": "node", "type": "String|DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "unBindDomNode", "scope": "prototype", "summary": "Detach menu from given node", "parameters": [ { "name": "nodeName", "type": "String|DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_scheduleOpen", "scope": "prototype", "private": true, "summary": "Set timer to display myself. Using a timer rather than displaying immediately solves\ntwo problems:\n\n1. IE: without the delay, focus work in "open" causes the system\ncontext menu to appear in spite of stopEvent.\n\n2. Avoid double-shows on linux, where shift-F10 generates an oncontextmenu event\neven after a dojo.stopEvent(e). (Shift-F10 on windows doesn't generate the\noncontextmenu event.)", "parameters": [ { "name": "target", "type": "DomNode", "usage": "optional" }, { "name": "iframe", "type": "DomNode", "usage": "optional" }, { "name": "coords", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_openMyself", "scope": "prototype", "private": true, "summary": "Internal function for opening myself when the user does a right-click or something similar.", "parameters": [ { "name": "args", "type": "This", "usage": "required", "summary": "is an Object containing:\n* target:\nThe node that is being clicked\n* iframe:\nIf an <iframe> is being clicked, iframe points to that iframe\n* coords:\nPut menu at specified x\/y position in viewport, or if iframe is\nspecified, then relative to iframe.\n\n_openMyself() formerly took the event object, and since various code references\nevt.target (after connecting to _openMyself()), using an Object for parameters\n(so that old code still works)." } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onBlur", "scope": "prototype", "private": true }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "uninitialize", "scope": "prototype" }, { "resources": [ "dojox\/widget\/PlaceholderMenuItem.js" ], "provides": [ "dojox.widget.PlaceholderMenuItem" ], "name": "getPlaceholders", "scope": "prototype", "summary": "Returns an array of placeholders with the given label. There\ncan be multiples.", "return-description": "An array of placeholders that match the given label", "parameters": [ { "name": "label", "type": "String", "usage": "optional", "summary": "Label to search for - if not specified, then all placeholders\nare returned" } ], "return-types": [ { "type": "dojox.widget.PlaceholderMenuItem[]" } ] } ] }, "dijit.MenuBar": { "location": "dijit.MenuBar", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "type": "Function", "classlike": true, "superclass": "dijit._MenuBase", "summary": "A menu bar, listing menu choices horizontally, like the "File" menu in most desktop applications", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._MenuBase" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "scope": "prototype", "type": "Object" }, { "name": "baseClass", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "scope": "prototype", "type": "String" }, { "name": "_isMenuBar", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "scope": "prototype", "type": "Boolean", "summary": "This is a MenuBar widget, not a (vertical) Menu widget." }, { "name": "_orient", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "focusedChild", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "scope": "prototype", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "focusChild", "scope": "prototype", "parameters": [ { "name": "item", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "_onKeyPress", "scope": "prototype", "summary": "Handle keyboard based menu navigation.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "onItemClick", "scope": "prototype", "private": true, "summary": "Handle clicks on an item. Cancels a dropdown if already open.", "parameters": [ { "name": "item", "type": "dijit._Widget", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] } ] }, "dojo": { "location": "dojo", "resources": [ "dojo\/AdapterRegistry.js", "dojo\/DeferredList.js", "dojo\/NodeList-data.js", "dojo\/NodeList-fx.js", "dojo\/NodeList-html.js", "dojo\/NodeList-manipulate.js", "dojo\/NodeList-traverse.js", "dojo\/Stateful.js", "dojo\/_base\/Color.js", "dojo\/_base\/Deferred.js", "dojo\/_base\/NodeList.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/loader.js", "dojo\/_base\/_loader\/loader_debug.js", "dojo\/_base\/_loader\/loader_xd.js", "dojo\/_base\/array.js", "dojo\/_base\/connect.js", "dojo\/_base\/declare.js", "dojo\/_base\/event.js", "dojo\/_base\/fx.js", "dojo\/_base\/html.js", "dojo\/_base\/json.js", "dojo\/_base\/lang.js", "dojo\/_base\/query-sizzle.js", "dojo\/_base\/query.js", "dojo\/_base\/window.js", "dojo\/_base\/xhr.js", "dojo\/_firebug\/firebug.js", "dojo\/back.js", "dojo\/behavior.js", "dojo\/cache.js", "dojo\/cldr\/monetary.js", "dojo\/cldr\/supplemental.js", "dojo\/colors.js", "dojo\/cookie.js", "dojo\/currency.js", "dojo\/data\/ItemFileReadStore.js", "dojo\/data\/ItemFileWriteStore.js", "dojo\/data\/ObjectStore.js", "dojo\/data\/api\/Identity.js", "dojo\/data\/api\/Notification.js", "dojo\/data\/api\/Read.js", "dojo\/data\/api\/Request.js", "dojo\/data\/api\/Write.js", "dojo\/data\/util\/filter.js", "dojo\/data\/util\/simpleFetch.js", "dojo\/data\/util\/sorter.js", "dojo\/date\/locale.js", "dojo\/date\/stamp.js", "dojo\/date.js", "dojo\/dnd\/Avatar.js", "dojo\/dnd\/Container.js", "dojo\/dnd\/Manager.js", "dojo\/dnd\/Moveable.js", "dojo\/dnd\/Mover.js", "dojo\/dnd\/Selector.js", "dojo\/dnd\/Source.js", "dojo\/dnd\/TimedMoveable.js", "dojo\/dnd\/autoscroll.js", "dojo\/dnd\/common.js", "dojo\/dnd\/move.js", "dojo\/fx\/Toggler.js", "dojo\/fx\/easing.js", "dojo\/fx.js", "dojo\/gears.js", "dojo\/hash.js", "dojo\/html.js", "dojo\/io\/iframe.js", "dojo\/io\/script.js", "dojo\/jaxer.js", "dojo\/number.js", "dojo\/parser.js", "dojo\/regexp.js", "dojo\/robot.js", "dojo\/robotx.js", "dojo\/rpc\/JsonService.js", "dojo\/rpc\/JsonpService.js", "dojo\/rpc\/RpcService.js", "dojo\/store\/Cache.js", "dojo\/store\/DataStore.js", "dojo\/store\/JsonRest.js", "dojo\/store\/Memory.js", "dojo\/store\/Observable.js", "dojo\/store\/util\/QueryResults.js", "dojo\/store\/util\/SimpleQueryEngine.js", "dojo\/string.js", "dojo\/uacss.js", "dojo\/window.js", "dojox\/charting\/widget\/Chart.js", "dojox\/charting\/widget\/Sparkline.js", "dojox\/fx\/style.js", "dojox\/gfx\/canvas.js", "dojox\/gfx\/fx.js", "dojox\/gfx\/gradient.js", "dojox\/gfx\/gradutils.js", "dojox\/gfx\/silverlight.js", "dojox\/gfx\/svg.js", "dojox\/gfx\/utils.js", "dojox\/gfx\/vml.js", "dojox\/grid\/TreeGrid.js", "dojox\/lang\/aspect.js", "dojox\/lang\/async\/event.js", "dojox\/lang\/async\/timeout.js", "dojox\/lang\/async\/topic.js", "dojox\/lang\/async.js", "dojox\/lang\/functional\/array.js", "dojox\/lang\/functional\/fold.js", "dojox\/lang\/functional\/object.js", "dojox\/lang\/functional\/reversed.js", "dojox\/lang\/functional\/scan.js", "dojox\/lang\/functional\/sequence.js", "dojox\/mobile\/parser.js", "dojox\/mobile\/scrollable.js", "dojox\/xml\/widgetParser.js" ], "provides": [ "dojo.AdapterRegistry", "dojo.DeferredList", "dojo.NodeList-data", "dojo.NodeList-fx", "dojo.NodeList-html", "dojo.NodeList-manipulate", "dojo.NodeList-traverse", "dojo.Stateful", "dojo._base.Color", "dojo._base.Deferred", "dojo._base.NodeList", "dojo._base._loader.loader_debug", "dojo._base._loader.loader_xd", "dojo._base.array", "dojo._base.connect", "dojo._base.declare", "dojo._base.event", "dojo._base.fx", "dojo._base.html", "dojo._base.json", "dojo._base.lang", "dojo._base.query", "dojo._base.window", "dojo._base.xhr", "dojo._firebug.firebug", "dojo.back", "dojo.behavior", "dojo.cache", "dojo.cldr.monetary", "dojo.cldr.supplemental", "dojo.colors", "dojo.cookie", "dojo.currency", "dojo.data.ItemFileReadStore", "dojo.data.ItemFileWriteStore", "dojo.data.ObjectStore", "dojo.data.api.Identity", "dojo.data.api.Notification", "dojo.data.api.Read", "dojo.data.api.Request", "dojo.data.api.Write", "dojo.data.util.filter", "dojo.data.util.simpleFetch", "dojo.data.util.sorter", "dojo.date.locale", "dojo.date.stamp", "dojo.date", "dojo.dnd.Avatar", "dojo.dnd.Container", "dojo.dnd.Manager", "dojo.dnd.Moveable", "dojo.dnd.Mover", "dojo.dnd.Selector", "dojo.dnd.Source", "dojo.dnd.TimedMoveable", "dojo.dnd.autoscroll", "dojo.dnd.common", "dojo.dnd.move", "dojo.fx.Toggler", "dojo.fx.easing", "dojo.fx", "dojo.gears", "dojo.hash", "dojo.html", "dojo.io.iframe", "dojo.io.script", "dojo.jaxer", "dojo.number", "dojo.parser", "dojo.regexp", "dojo.robot", "dojo.robotx", "dojo.rpc.JsonService", "dojo.rpc.JsonpService", "dojo.rpc.RpcService", "dojo.store.Cache", "dojo.store.DataStore", "dojo.store.JsonRest", "dojo.store.Memory", "dojo.store.Observable", "dojo.store.util.QueryResults", "dojo.store.util.SimpleQueryEngine", "dojo.string", "dojo.uacss", "dojo.window", "dojox.charting.widget.Chart", "dojox.charting.widget.Sparkline", "dojox.fx.style", "dojox.gfx.canvas", "dojox.gfx.fx", "dojox.gfx.gradient", "dojox.gfx.gradutils", "dojox.gfx.silverlight", "dojox.gfx.svg", "dojox.gfx.utils", "dojox.gfx.vml", "dojox.grid.TreeGrid", "dojox.lang.aspect", "dojox.lang.async.event", "dojox.lang.async.timeout", "dojox.lang.async.topic", "dojox.lang.async", "dojox.lang.functional.array", "dojox.lang.functional.fold", "dojox.lang.functional.object", "dojox.lang.functional.reversed", "dojox.lang.functional.scan", "dojox.lang.functional.sequence", "dojox.mobile.scrollable", "dojox.xml.widgetParser" ], "properties": [ { "name": "_nodeDataCache", "resources": [ "dojo\/NodeList-data.js" ], "provides": [ "dojo.NodeList-data" ], "scope": "normal", "type": "Object", "private": true, "summary": "An alias to the private dataCache for NodeList-data. NEVER USE THIS!\nThis private is only exposed for the benefit of unit testing, and is\nremoved during the build process." }, { "name": "NodeList-data", "resources": [ "dojo\/NodeList-data.js" ], "provides": [ "dojo.NodeList-data" ], "scope": "normal", "type": "Object" }, { "name": "NodeList-fx", "resources": [ "dojo\/NodeList-fx.js" ], "provides": [ "dojo.NodeList-fx" ], "scope": "normal", "type": "Object", "summary": "Adds dojo.fx animation support to dojo.query()" }, { "name": "NodeList-html", "resources": [ "dojo\/NodeList-html.js" ], "provides": [ "dojo.NodeList-html" ], "scope": "normal", "type": "Object", "summary": "Adds a chainable html method to dojo.query() \/ Nodelist instances for setting\/replacing node content" }, { "name": "NodeList-manipulate", "resources": [ "dojo\/NodeList-manipulate.js" ], "provides": [ "dojo.NodeList-manipulate" ], "scope": "normal", "type": "Object", "summary": "Adds a chainable methods to dojo.query() \/ Nodelist instances for manipulating HTML\nand DOM nodes and their properties." }, { "name": "NodeList-traverse", "resources": [ "dojo\/NodeList-traverse.js" ], "provides": [ "dojo.NodeList-traverse" ], "scope": "normal", "type": "Object", "summary": "Adds a chainable methods to dojo.query() \/ Nodelist instances for traversing the DOM" }, { "name": "_NodeListCtor", "resources": [ "dojo\/_base\/NodeList.js" ], "provides": [ "dojo._base.NodeList" ], "scope": "normal", "type": null, "private": true }, { "name": "isBrowser", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "Object" }, { "name": "_name", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/_loader\/hostenv_spidermonkey.js" ], "scope": "normal", "type": "String", "private": true }, { "name": "baseUrl", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/_loader\/hostenv_spidermonkey.js", "dojo\/_base\/_loader\/loader_xd.js", "dojo\/resources\/_modules.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "String", "summary": "The root relative path to dojo.js (as a string)" }, { "name": "isMozilla", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": null }, { "name": "isMoz", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": null }, { "name": "isFF", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/uacss.js" ], "provides": [ "dojo.uacss" ], "scope": "normal", "type": "Object" }, { "name": "isQuirks", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "scope": "normal", "type": "bool" }, { "name": "locale", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js" ], "scope": "normal", "type": "Object" }, { "name": "_windowUnloaders", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_defaultContext", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_initFired", "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "bool", "private": true }, { "name": "isRhino", "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js" ], "scope": "normal", "type": "Object" }, { "name": "_timeouts", "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "isSpidermonkey", "resources": [ "dojo\/_base\/_loader\/hostenv_spidermonkey.js" ], "scope": "normal", "type": "Object", "summary": "Detect spidermonkey" }, { "name": "_loadedModules", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_inFlightCount", "resources": [ "dojo\/_base\/_loader\/loader.js", "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Number", "private": true }, { "name": "_hasResource", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_loadedUrls", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_postLoad", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "bool", "private": true }, { "name": "_loaders", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_unloaders", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_loadNotifying", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "bool", "private": true }, { "name": "_global_omit_module_check", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": "bool", "private": true }, { "name": "requireAfterIf", "resources": [ "dojo\/_base\/_loader\/loader.js" ], "scope": "normal", "type": null }, { "name": "nonDebugProvide", "resources": [ "dojo\/_base\/_loader\/loader_debug.js" ], "provides": [ "dojo._base._loader.loader_debug" ], "scope": "normal", "type": null }, { "name": "_xdDebugScopeChecked", "resources": [ "dojo\/_base\/_loader\/loader_debug.js" ], "provides": [ "dojo._base._loader.loader_debug" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_isXDomain", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "bool", "private": true }, { "name": "_xdInFlight", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_xdOrderedReqs", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_xdDepMap", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_xdContents", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_xdTimer", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Number", "private": true }, { "name": "_xdCharSet", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "String", "private": true }, { "name": "_xdStartTime", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_headElement", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": null, "private": true }, { "name": "_xdReqLoc", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": null, "private": true }, { "name": "_xdBundleMap", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_xdRealRequireLocalization", "resources": [ "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "scope": "normal", "type": null, "private": true }, { "name": "_topics", "resources": [ "dojo\/_base\/connect.js" ], "provides": [ "dojo._base.connect" ], "scope": "normal", "type": "Object", "private": true }, { "name": "subscribe", "scope": "normal", "type": null }, { "name": "unsubscribe", "scope": "normal", "type": null }, { "name": "publish", "scope": "normal", "type": null }, { "name": "_mixin", "resources": [ "dojo\/_base\/declare.js", "dojo\/_base\/fx.js" ], "provides": [ "dojo._base.declare", "dojo._base.fx" ], "scope": "normal", "type": null, "private": true }, { "name": "_ieListenersName", "resources": [ "dojo\/_base\/event.js" ], "provides": [ "dojo._base.event" ], "scope": "normal", "type": "String", "private": true }, { "name": "_Animation", "resources": [ "dojo\/_base\/fx.js" ], "provides": [ "dojo._base.fx" ], "scope": "normal", "type": null, "private": true }, { "name": "boxModel", "resources": [ "dojo\/_base\/html.js" ], "provides": [ "dojo._base.html" ], "scope": "normal", "type": "String" }, { "name": "toJsonIndentStr", "resources": [ "dojo\/_base\/json.js" ], "provides": [ "dojo._base.json" ], "scope": "normal", "type": "String" }, { "name": "_delegate", "resources": [ "dojo\/_base\/lang.js" ], "provides": [ "dojo._base.lang" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_bodyLtr", "resources": [ "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "scope": "normal", "type": null, "private": true }, { "name": "_blockAsync", "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "scope": "normal", "type": "bool", "private": true }, { "name": "jaxer", "resources": [ "dojo\/jaxer.js" ], "provides": [ "dojo.jaxer" ], "scope": "normal", "type": "Object" }, { "name": "robot", "resources": [ "dojo\/robot.js" ], "provides": [ "dojo.robot" ], "scope": "normal", "type": "Object" }, { "name": "robotx", "resources": [ "dojo\/robotx.js" ], "provides": [ "dojo.robotx" ], "scope": "normal", "type": "Object" }, { "name": "tests", "resources": [ "dojo\/tests.js" ], "scope": "normal", "type": "Object", "summary": "D.O.H. Test files for Dojo unit testing." }, { "name": "isIE", "resources": [ "dojo\/uacss.js", "dojo\/window.js" ], "provides": [ "dojo.uacss", "dojo.window" ], "scope": "normal", "type": null }, { "name": "isOpera", "resources": [ "dojo\/uacss.js" ], "provides": [ "dojo.uacss" ], "scope": "normal", "type": null }, { "name": "uacss", "resources": [ "dojo\/uacss.js" ], "provides": [ "dojo.uacss" ], "scope": "normal", "type": "Object" }, { "name": "isWebKit", "resources": [ "dojo\/window.js", "dojox\/mobile\/scrollable.js" ], "provides": [ "dojo.window", "dojox.mobile.scrollable" ], "scope": "normal", "type": "bool" }, { "name": "isBB", "resources": [ "dojox\/mobile\/_base.js" ], "provides": [ "dojox.mobile._base" ], "scope": "normal", "type": null }, { "name": "_oldConnect", "resources": [ "dojox\/mobile\/app\/_event.js" ], "provides": [ "dojox.mobile.app._event" ], "scope": "normal", "type": null, "private": true }, { "name": "_defaultXhr", "resources": [ "dojox\/rpc\/Client.js" ], "provides": [ "dojox.rpc.Client" ], "scope": "normal", "type": null, "private": true } ], "methods": [ { "resources": [ "dijit\/_base\/manager.js", "dojo\/_base\/html.js" ], "provides": [ "dijit._base.manager", "dojo._base.html" ], "name": "attr", "scope": "normal", "summary": "Gets or sets an attribute on an HTML element.", "description": "Handles normalized getting and setting of attributes on DOM\nNodes. If 2 arguments are passed, and a the second argumnt is a\nstring, acts as a getter.\n\nIf a third argument is passed, or if the second argument is a\nmap of attributes, acts as a setter.\n\nWhen passing functions as values, note that they will not be\ndirectly assigned to slots on the node, but rather the default\nbehavior will be removed and the new behavior will be added\nusing `dojo.connect()`, meaning that event handler properties\nwill be normalized and that some caveats with regards to\nnon-standard behaviors for onsubmit apply. Namely that you\nshould cancel form submission using `dojo.stopEvent()` on the\npassed event object instead of returning a boolean value from\nthe handler itself.", "examples": [ "\t\/\/ get the current value of the \"foo\" attribute on a node\n\tdojo.attr(dojo.byId(\"nodeId\"), \"foo\");\n\t\/\/ or we can just pass the id:\n\tdojo.attr(\"nodeId\", \"foo\");", "\t\/\/ use attr() to set the tab index\n\tdojo.attr(\"nodeId\", \"tabIndex\", 3);", "Set multiple values at once, including event handlers:\n\tdojo.attr(\"formId\", {\n\t\t\"foo\": \"bar\",\n\t\t\"tabIndex\": -1,\n\t\t\"method\": \"POST\",\n\t\t\"onsubmit\": function(e){\n\t\t\t\/\/ stop submitting the form. Note that the IE behavior\n\t\t\t\/\/ of returning true or false will have no effect here\n\t\t\t\/\/ since our handler is connect()ed to the built-in\n\t\t\t\/\/ onsubmit behavior and so we need to use\n\t\t\t\/\/ dojo.stopEvent() to ensure that the submission\n\t\t\t\/\/ doesn't proceed.\n\t\t\tdojo.stopEvent(e);\n\n\t\t\t\/\/ submit the form with Ajax\n\t\t\tdojo.xhrPost({ form: \"formId\" });\n\t\t}\n\t});", "Style is s special case: Only set with an object hash of styles\n\tdojo.attr(\"someNode\",{\n\t\tid:\"bar\",\n\t\tstyle:{\n\t\t\twidth:\"200px\", height:\"100px\", color:\"#000\"\n\t\t}\n\t});", "Again, only set style as an object hash of styles:\n\tvar obj = { color:\"#fff\", backgroundColor:\"#000\" };\n\tdojo.attr(\"someNode\", \"style\", obj);\n\n\t\/\/ though shorter to use `dojo.style()` in this case:\n\tdojo.style(\"someNode\", obj);" ], "return-description": "when used as a getter, the value of the requested attribute\nor null if that attribute does not have a specified or\ndefault value;\n\nwhen used as a setter, the DOM node", "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to the element to get or set the attribute on" }, { "name": "name", "type": "String|Object", "usage": "required", "summary": "the name of the attribute to get or set." }, { "name": "value", "type": "String", "usage": "optional", "summary": "The value to set for the attribute" } ], "return-types": [ { "type": "DomNode" }, { "type": "Anything" } ] }, { "resources": [ "dijit\/_base\/manager.js", "dojo\/_base\/html.js" ], "provides": [ "dijit._base.manager", "dojo._base.html" ], "name": "hasAttr", "scope": "normal", "summary": "Returns true if the requested attribute is specified on the\ngiven element, and false otherwise.", "return-description": "true if the requested attribute is specified on the\ngiven element, and false otherwise", "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to the element to check" }, { "name": "name", "type": "String", "usage": "required", "summary": "the name of the attribute" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_base\/manager.js", "dojo\/_base\/html.js", "dojox\/html\/ext-dojo\/style.js", "dojox\/mobile\/scrollable.js" ], "provides": [ "dijit._base.manager", "dojo._base.html", "dojox.html.ext-dojo.style", "dojox.mobile.scrollable" ], "name": "style", "scope": "normal", "summary": "Accesses styles on a node. If 2 arguments are\npassed, acts as a getter. If 3 arguments are passed, acts\nas a setter.", "description": "Getting the style value uses the computed style for the node, so the value\nwill be a calculated value, not just the immediate node.style value.\nAlso when getting values, use specific style names,\nlike \"borderBottomWidth\" instead of \"border\" since compound values like\n\"border\" are not necessarily reflected as expected.\nIf you want to get node dimensions, use `dojo.marginBox()`,\n`dojo.contentBox()` or `dojo.position()`.", "examples": [ "Passing only an ID or node returns the computed style object of\nthe node:\n\tdojo.style(\"thinger\");", "Passing a node and a style property returns the current\nnormalized, computed value for that property:\n\tdojo.style(\"thinger\", \"opacity\"); \/\/ 1 by default", "Passing a node, a style property, and a value changes the\ncurrent display of the node and returns the new computed value\n\tdojo.style(\"thinger\", \"opacity\", 0.5); \/\/ == 0.5", "Passing a node, an object-style style property sets each of the values in turn and returns the computed style object of the node:\n\tdojo.style(\"thinger\", {\n\t\t\"opacity\": 0.5,\n\t\t\"border\": \"3px solid black\",\n\t\t\"height\": \"300px\"\n\t});", "When the CSS style property is hyphenated, the JavaScript property is camelCased.\nfont-size becomes fontSize, and so on.\n\tdojo.style(\"thinger\",{\n\t\tfontSize:\"14pt\",\n\t\tletterSpacing:\"1.2em\"\n\t});", "dojo.NodeList implements .style() using the same syntax, omitting the \"node\" parameter, calling\ndojo.style() on every element of the list. See: `dojo.query()` and `dojo.NodeList()`\n\tdojo.query(\".someClassName\").style(\"visibility\",\"hidden\");\n\t\/\/ or\n\tdojo.query(\"#baz > div\").style({\n\t\topacity:0.75,\n\t\tfontSize:\"13pt\"\n\t});" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to node to get\/set style for" }, { "name": "style", "type": "String|Object", "usage": "optional", "summary": "the style property to set in DOM-accessor format\n("borderWidth", not "border-width") or an object with key\/value\npairs suitable for setting each property." }, { "name": "value", "type": "String", "usage": "optional", "summary": "If passed, sets value on the node for style, handling\ncross-browser concerns. When setting a pixel value,\nbe sure to include "px" in the value. For instance, top: "200px".\nOtherwise, in some cases, some browsers will not apply the style." } ] }, { "resources": [ "dojo\/NodeList-data.js" ], "provides": [ "dojo.NodeList-data" ], "name": "_nodeData", "scope": "normal", "private": true, "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "key", "type": null, "usage": "required" }, { "name": "value", "type": null, "usage": "required" } ], "return-types": [ { "type": "Object" }, { "type": "Anything" }, { "type": "Nothing" } ] }, { "resources": [ "dojo\/NodeList-data.js" ], "provides": [ "dojo.NodeList-data" ], "name": "_removeNodeData", "scope": "normal", "private": true, "summary": "Remove some data from this node", "parameters": [ { "name": "node", "type": "String|DomNode", "usage": "required", "summary": "The node reference to remove data from" }, { "name": "key", "type": "String", "usage": "optional", "summary": "If omitted, remove all data in this dataset.\nIf passed, remove only the passed key<\/code> in the associated dataset" } ] }, { "resources": [ "dojo\/NodeList-data.js" ], "provides": [ "dojo.NodeList-data" ], "name": "_gcNodeData", "scope": "normal", "private": true, "summary": "super expensive: GC all data in the data for nodes that no longer exist in the dom.", "description": "super expensive: GC all data in the data for nodes that no longer exist in the dom.\nMUCH safer to do this yourself, manually, on a per-node basis (via `NodeList.removeData()`)\nprovided as a stop-gap for exceptionally large\/complex applications with constantly changing\ncontent regions (eg: a dijit.layout.ContentPane with replacing data)\nThere is NO automatic GC going on. If you dojo.destroy() a node, you should _removeNodeData\nprior to destruction." }, { "resources": [ "dojo\/_base\/Color.js" ], "provides": [ "dojo._base.Color" ], "name": "blendColors", "scope": "normal", "summary": "Blend colors end and start with weight from 0 to 1, 0.5 being a 50\/50 blend,\ncan reuse a previously allocated dojo.Color object for the result", "parameters": [ { "name": "start", "type": "dojo.Color", "usage": "required" }, { "name": "end", "type": "dojo.Color", "usage": "required" }, { "name": "weight", "type": "Number", "usage": "required" }, { "name": "obj", "type": "dojo.Color", "usage": "optional" } ], "return-types": [ { "type": "dojo.Color" } ] }, { "resources": [ "dojo\/_base\/Color.js", "dojo\/colors.js" ], "provides": [ "dojo._base.Color", "dojo.colors" ], "name": "colorFromRgb", "scope": "normal", "summary": "get rgb(a) array from css-style color declarations", "description": "this function can handle all 4 CSS3 Color Module formats: rgb,\nrgba, hsl, hsla, including rgb(a) with percentage values.", "return-description": "A dojo.Color object. If obj is passed, it will be the return value.", "parameters": [ { "name": "color", "type": "String", "usage": "required" }, { "name": "obj", "type": "dojo.Color", "usage": "optional" } ], "return-types": [ { "type": "dojo.Color" } ] }, { "resources": [ "dojo\/_base\/Color.js" ], "provides": [ "dojo._base.Color" ], "name": "colorFromHex", "scope": "normal", "summary": "Converts a hex string with a '#' prefix to a color object.\nSupports 12-bit #rgb shorthand. Optionally accepts a\ndojo.Color<\/code> object to update with the parsed value.", "examples": [ " var thing = dojo.colorFromHex(\"#ededed\"); \/\/ grey, longhand", " var thing = dojo.colorFromHex(\"#000\"); \/\/ black, shorthand" ], "return-description": "A dojo.Color object. If obj is passed, it will be the return value.", "parameters": [ { "name": "color", "type": "String", "usage": "required" }, { "name": "obj", "type": "dojo.Color", "usage": "optional" } ], "return-types": [ { "type": "dojo.Color" } ] }, { "resources": [ "dojo\/_base\/Color.js" ], "provides": [ "dojo._base.Color" ], "name": "colorFromArray", "scope": "normal", "summary": "Builds a dojo.Color<\/code> from a 3 or 4 element array, mapping each\nelement in sequence to the rgb(a) values of the color.", "examples": { "example": " var myColor = dojo.colorFromArray([237,237,237,0.5]); \/\/ grey, 50% alpha" }, "return-description": "A dojo.Color object. If obj is passed, it will be the return value.", "parameters": [ { "name": "a", "type": "Array", "usage": "required" }, { "name": "obj", "type": "dojo.Color", "usage": "optional" } ], "return-types": [ { "type": "dojo.Color" } ] }, { "resources": [ "dojo\/_base\/Color.js" ], "provides": [ "dojo._base.Color" ], "name": "colorFromString", "scope": "normal", "summary": "Parses str<\/code> for a color value. Accepts hex, rgb, and rgba\nstyle color values.", "description": "Acceptable input values for str may include arrays of any form\naccepted by dojo.colorFromArray, hex strings such as \"#aaaaaa\", or\nrgb or rgba strings such as \"rgb(133, 200, 16)\" or \"rgba(10, 10,\n10, 50)\"", "return-description": "A dojo.Color object. If obj is passed, it will be the return value.", "parameters": [ { "name": "str", "type": "String", "usage": "required" }, { "name": "obj", "type": "dojo.Color", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/Deferred.js" ], "provides": [ "dojo._base.Deferred" ], "name": "when", "scope": "normal", "summary": "This provides normalization between normal synchronous values and\nasynchronous promises, so you can interact with them in a common way", "examples": { "example": "\tfunction printFirstAndList(items){\n\t\tdojo.when(findFirst(items), console.log);\n\t\tdojo.when(findLast(items), console.log);\n\t}\n\tfunction findFirst(items){\n\t\treturn dojo.when(items, function(items){\n\t\t\treturn items[0];\n\t\t});\n\t}\n\tfunction findLast(items){\n\t\treturn dojo.when(items, function(items){\n\t\t\treturn items[items.length];\n\t\t});\n\t}\nAnd now all three of his functions can be used sync or async.\n\tprintFirstAndLast([1,2,3,4]) will work just as well as\n\tprintFirstAndLast(dojo.xhrGet(...));" }, "parameters": [ { "name": "promiseOrValue", "type": null, "usage": "required" }, { "name": "callback", "type": "Function", "usage": "optional" }, { "name": "errback", "type": "Function", "usage": "optional" }, { "name": "progressHandler", "type": "Function", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojox\/io\/proxy\/xip.js", "dojox\/jq.js" ], "provides": [ "dojox.io.proxy.xip", "dojox.jq" ], "name": "_xhrObj", "scope": "normal", "private": true, "parameters": [ { "name": "args", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/_loader\/hostenv_spidermonkey.js", "dojo\/_base\/_loader\/loader.js", "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "name": "_loadUri", "scope": "normal", "private": true, "summary": "Internal xd loader function. Overrides loadUri() from loader.js.\nxd loading requires slightly different behavior from loadPath().", "description": "Wanted to override getText(), but it is used by\nthe widget code in too many, synchronous ways right now.", "parameters": [ { "name": "uri", "type": "String", "usage": "required", "summary": "a uri which points at the script to be loaded" }, { "name": "cb", "type": "Function", "usage": "required", "summary": "a callback function to process the result of evaluating the script\nas an expression, typically used by the resource bundle loader to\nload JSON-style resources" }, { "name": "currentIsXDomain", "type": "boolean", "usage": "required" }, { "name": "module", "type": "String", "usage": "required" } ], "return-types": [ { "type": "Boolean" }, { "type": "Boolean: contents? true : false" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "_isDocumentOk", "scope": "normal", "private": true, "parameters": [ { "name": "http", "type": null, "usage": "required" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js" ], "name": "_getText", "scope": "normal", "private": true, "summary": "Read the contents of the specified uri and return those contents.", "return-description": "The response text. null is returned when there is a\nfailure and failure is okay (an exception otherwise)", "parameters": [ { "name": "uri", "type": "URI", "usage": "required", "summary": "A relative or absolute uri." }, { "name": "fail_ok", "type": "Boolean", "usage": "required", "summary": "Default false. If fail_ok and loading fails, return null\ninstead of throwing." } ], "return-types": [ { "type": "null" }, { "type": "String" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "windowUnloaded", "scope": "normal", "summary": "signal fired by impending window destruction. You may use\ndojo.addOnWIndowUnload() or dojo.connect() to this method to perform\npage\/application cleanup methods. See dojo.addOnWindowUnload for more info." }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "addOnWindowUnload", "scope": "normal", "summary": "registers a function to be triggered when window.onunload fires.\nBe careful trying to modify the DOM or access JavaScript properties\nduring this phase of page unloading: they may not always be available.\nConsider dojo.addOnUnload() if you need to modify the DOM or do heavy\nJavaScript work.", "examples": { "example": "\tdojo.addOnWindowUnload(functionPointer)\n\tdojo.addOnWindowUnload(object, \"functionName\")\n\tdojo.addOnWindowUnload(object, function(){ \/* ... *\/});" }, "parameters": [ { "name": "obj", "type": "Object", "usage": "optional" }, { "name": "functionName", "type": "String|Function", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "pushContext", "scope": "normal", "summary": "causes subsequent calls to Dojo methods to assume the\npassed object and, optionally, document as the default\nscopes to use. A 2-element array of the previous global and\ndocument are returned.", "description": "dojo.pushContext treats contexts as a stack. The\nauto-detected contexts which are initially provided using\ndojo.setContext() require authors to keep state in order to\n\"return\" to a previous context, whereas the\ndojo.pushContext and dojo.popContext methods provide a more\nnatural way to augment blocks of code to ensure that they\nexecute in a different window or frame without issue. If\ncalled without any arguments, the default context (the\ncontext when Dojo is first loaded) is instead pushed into\nthe stack. If only a single string is passed, a node in the\nintitial context's document is looked up and its\ncontextWindow and contextDocument properties are used as\nthe context to push. This means that iframes can be given\nan ID and code can be executed in the scope of the iframe's\ndocument in subsequent calls easily.", "parameters": [ { "name": "g", "type": "Object|String", "usage": "optional", "summary": "The global context. If a string, the id of the frame to\nsearch for a context and document." }, { "name": "d", "type": "MDocumentElement", "usage": "optional", "summary": "The document element to execute subsequent code with." } ], "return-types": [ { "type": "Array" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "popContext", "scope": "normal", "summary": "If the context stack contains elements, ensure that\nsubsequent code executes in the *previous* context to the\ncurrent context. The current context set ([global,\ndocument]) is returned." }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "name": "_inContext", "scope": "normal", "private": true, "parameters": [ { "name": "g", "type": null, "usage": "required" }, { "name": "d", "type": null, "usage": "required" }, { "name": "f", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/jaxer.js" ], "provides": [ "dojo.jaxer" ], "name": "_loadInit", "scope": "normal", "private": true, "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/html.js" ], "provides": [ "dojo._base.html" ], "name": "byId", "scope": "normal", "summary": "Returns DOM node with matching id<\/code> attribute or null<\/code>\nif not found. If id<\/code> is a DomNode, this function is a no-op.", "examples": [ "Look up a node by ID:\n\tvar n = dojo.byId(\"foo\");", "Check if a node exists, and use it.\n\tvar n = dojo.byId(\"bar\");\n\tif(n){ doStuff() ... }", "Allow string or DomNode references to be passed to a custom function:\n\tvar foo = function(nodeOrId){\n\t\tnodeOrId = dojo.byId(nodeOrId);\n\t\t\/\/ ... more stuff\n\t}" ], "parameters": [ { "name": "id", "type": "String|DOMNode", "usage": "required", "summary": "A string to match an HTML id attribute or a reference to a DOM Node" }, { "name": "doc", "type": "Document", "usage": "required", "summary": "Document to work in. Defaults to the current value of\ndojo.doc. Can be used to retrieve\nnode references from other documents." } ], "return-types": [ { "type": "assume it's a node" }, { "type": "DomNode" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js" ], "name": "_isLocalUrl", "scope": "normal", "private": true, "summary": "determines if URI is local or not.", "parameters": [ { "name": "uri", "type": "String", "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/_loader\/hostenv_spidermonkey.js" ], "name": "exit", "scope": "normal", "parameters": [ { "name": "exitcode", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "name": "body", "scope": "normal", "summary": "Return the body element of the document\nreturn the body object associated with dojo.doc", "examples": { "example": "\tdojo.body().appendChild(dojo.doc.createElement('div'));" }, "return-types": [ { "type": "Node" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_spidermonkey.js" ], "name": "_spidermonkeyCurrentFile", "scope": "normal", "private": true, "parameters": [ { "name": "depth", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_moduleHasPrefix", "scope": "normal", "private": true, "summary": "checks to see if module has been established", "parameters": [ { "name": "module", "type": "String", "usage": "required" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_getModulePrefix", "scope": "normal", "private": true, "summary": "gets the prefix associated with module", "parameters": [ { "name": "module", "type": "String", "usage": "required" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js", "dojo\/_base\/_loader\/loader_xd.js" ], "provides": [ "dojo._base._loader.loader_xd" ], "name": "_loadPath", "scope": "normal", "private": true, "summary": "Internal xd loader function. Overrides loadPath() from loader.js.\nxd loading requires slightly different behavior from loadPath().", "description": "Loads and interprets the script located at relpath, which is\nrelative to the script root directory. If the script is found but\nits interpretation causes a runtime exception, that exception is\nnot caught by us, so the caller will see it. We return a true\nvalue if and only if the script is found.", "parameters": [ { "name": "relpath", "type": "String", "usage": "required", "summary": "A relative path to a script (no leading '\/', and typically ending\nin '.js')." }, { "name": "module", "type": "String", "usage": "optional", "summary": "A module whose existance to check for after loading a path. Can be\nused to determine success or failure of the load." }, { "name": "cb", "type": "Function", "usage": "optional", "summary": "a callback function to pass the result of evaluating the script" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_loadUriAndCheck", "scope": "normal", "private": true, "summary": "calls loadUri then findModule and returns true if both succeed", "parameters": [ { "name": "uri", "type": "String", "usage": "required" }, { "name": "moduleName", "type": "String", "usage": "required" }, { "name": "cb", "type": "Function", "usage": "optional" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "loaded", "scope": "normal", "summary": "signal fired when initial environment and package loading is\ncomplete. You should use dojo.addOnLoad() instead of doing a\ndirect dojo.connect() to this method in order to handle\ninitialization tasks that require the environment to be\ninitialized. In a browser host,\tdeclarative widgets will\nbe constructed when this function finishes runing." }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "unloaded", "scope": "normal", "summary": "signal fired by impending environment destruction. You should use\ndojo.addOnUnload() instead of doing a direct dojo.connect() to this\nmethod to perform page\/application cleanup methods. See\ndojo.addOnUnload for more info." }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_onto", "scope": "normal", "private": true, "parameters": [ { "name": "arr", "type": null, "usage": "required" }, { "name": "obj", "type": null, "usage": "required" }, { "name": "fn", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "ready", "scope": "normal" }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "addOnLoad", "scope": "normal", "summary": "Registers a function to be triggered after the DOM and dojo.require() calls\nhave finished loading.", "description": "Registers a function to be triggered after the DOM has finished\nloading and `dojo.require` modules have loaded. Widgets declared in markup\nhave been instantiated if `djConfig.parseOnLoad` is true when this fires.\n\nImages and CSS files may or may not have finished downloading when\nthe specified function is called. (Note that widgets' CSS and HTML\ncode is guaranteed to be downloaded before said widgets are\ninstantiated, though including css resouces BEFORE any script elements\nis highly recommended).", "examples": [ "Register an anonymous function to run when everything is ready\n\tdojo.addOnLoad(function(){ doStuff(); });", "Register a function to run when everything is ready by pointer:\n\tvar init = function(){ doStuff(); }\n\tdojo.addOnLoad(init);", "Register a function to run scoped to `object`, either by name or anonymously:\n\tdojo.addOnLoad(object, \"functionName\");\n\tdojo.addOnLoad(object, function(){ doStuff(); });" ], "parameters": [ { "name": "obj", "type": "Object", "usage": "required" }, { "name": "functionName", "type": "String|Function", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_modulesLoaded", "scope": "normal", "private": true }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_callLoaded", "scope": "normal", "private": true }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_getModuleSymbols", "scope": "normal", "private": true, "summary": "Converts a module name in dotted JS notation to an array\nrepresenting the path in the source tree", "parameters": [ { "name": "modulename", "type": "String", "usage": "required" } ], "return-types": [ { "type": "Array" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "loadInit", "scope": "normal", "summary": "Executes a function that needs to be executed for the loader's dojo.requireIf\nresolutions to work. This is needed mostly for the xdomain loader case where\na function needs to be executed to set up the possible values for a dojo.requireIf\ncall.", "description": "This function is mainly a marker for the xdomain loader to know parts of\ncode that needs be executed outside the function wrappper that is placed around modules.\nThe init function could be executed more than once, and it should make no assumptions\non what is loaded, or what modules are available. Only the functionality in Dojo Base\nis allowed to be used. Avoid using this method. For a valid use case,\nsee the source for dojox.gfx.", "parameters": [ { "name": "init", "type": "Function", "usage": "required", "summary": "a function reference. Executed immediately." } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "_loadModule", "scope": "normal", "private": true }, { "resources": [ "dojo\/_base\/_loader\/loader.js", "dojox\/lang\/docs.js" ], "provides": [ "dojox.lang.docs" ], "name": "require", "scope": "normal", "summary": "loads a Javascript module from the appropriate URI", "description": "Modules are loaded via dojo.require by using one of two loaders: the normal loader\nand the xdomain loader. The xdomain loader is used when dojo was built with a\ncustom build that specified loader=xdomain and the module lives on a modulePath\nthat is a whole URL, with protocol and a domain. The versions of Dojo that are on\nthe Google and AOL CDNs use the xdomain loader.\n\nIf the module is loaded via the xdomain loader, it is an asynchronous load, since\nthe module is added via a dynamically created script tag. This\nmeans that dojo.require() can return before the module has loaded. However, this\nshould only happen in the case where you do dojo.require calls in the top-level\nHTML page, or if you purposely avoid the loader checking for dojo.require\ndependencies in your module by using a syntax like dojo[\"require\"] to load the module.\n\nSometimes it is useful to not have the loader detect the dojo.require calls in the\nmodule so that you can dynamically load the modules as a result of an action on the\npage, instead of right at module load time.\n\nAlso, for script blocks in an HTML page, the loader does not pre-process them, so\nit does not know to download the modules before the dojo.require calls occur.\n\nSo, in those two cases, when you want on-the-fly module loading or for script blocks\nin the HTML page, special care must be taken if the dojo.required code is loaded\nasynchronously. To make sure you can execute code that depends on the dojo.required\nmodules, be sure to add the code that depends on the modules in a dojo.addOnLoad()\ncallback. dojo.addOnLoad waits for all outstanding modules to finish loading before\nexecuting.\n\nThis type of syntax works with both xdomain and normal loaders, so it is good\npractice to always use this idiom for on-the-fly code loading and in HTML script\nblocks. If at some point you change loaders and where the code is loaded from,\nit will all still work.\n\nMore on how dojo.require\n`dojo.require(\"A.B\")` first checks to see if symbol A.B is\ndefined. If it is, it is simply returned (nothing to do).\n\nIf it is not defined, it will look for `A\/B.js` in the script root\ndirectory.\n\n`dojo.require` throws an exception if it cannot find a file\nto load, or if the symbol `A.B` is not defined after loading.\n\nIt returns the object `A.B`, but note the caveats above about on-the-fly loading and\nHTML script blocks when the xdomain loader is loading a module.\n\n`dojo.require()` does nothing about importing symbols into\nthe current namespace. It is presumed that the caller will\ntake care of that.", "examples": [ "To use dojo.require in conjunction with dojo.ready:\n\n\tdojo.require(\"foo\");\n\tdojo.require(\"bar\");\n\tdojo.addOnLoad(function(){\n\t\t\/\/you can now safely do something with foo and bar\n\t});", "For example, to import all symbols into a local block, you might write:\n\n\twith (dojo.require(\"A.B\")) {\n\t\t...\n\t}\n\nAnd to import just the leaf symbol to a local variable:\n\n\tvar B = dojo.require(\"A.B\");\n\t..." ], "return-description": "the required namespace object", "parameters": [ { "name": "moduleName", "type": "String", "usage": "required", "summary": "module name to load, using periods for separators,\ne.g. "dojo.date.locale". Module paths are de-referenced by dojo's\ninternal mapping of locations to names and are disambiguated by\nlongest prefix. See dojo.registerModulePath()<\/code> for details on\nregistering new modules." }, { "name": "omitModuleCheck", "type": "Boolean", "usage": "optional", "summary": "if true<\/code>, omitModuleCheck skips the step of ensuring that the\nloaded file actually defines the symbol it is referenced by.\nFor example if it called as dojo.require("a.b.c")<\/code> and the\nfile located at a\/b\/c.js<\/code> does not define an object a.b.c<\/code>,\nand exception will be throws whereas no exception is raised\nwhen called as dojo.require("a.b.c", true)<\/code>" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js", "dojo\/_base\/_loader\/loader_debug.js" ], "provides": [ "dojo._base._loader.loader_debug" ], "name": "provide", "scope": "normal", "summary": "Register a resource with the package system. Works in conjunction with dojo.require<\/code>", "description": "Each javascript source file is called a resource. When a\nresource is loaded by the browser, `dojo.provide()` registers\nthat it has been loaded.\n\nEach javascript source file must have at least one\n`dojo.provide()` call at the top of the file, corresponding to\nthe file name. For example, `js\/dojo\/foo.js` must have\n`dojo.provide(\"dojo.foo\");` before any calls to\n`dojo.require()` are made.\n\nFor backwards compatibility reasons, in addition to registering\nthe resource, `dojo.provide()` also ensures that the javascript\nobject for the module exists. For example,\n`dojo.provide(\"dojox.data.FlickrStore\")`, in addition to\nregistering that `FlickrStore.js` is a resource for the\n`dojox.data` module, will ensure that the `dojox.data`\njavascript object exists, so that calls like\n`dojo.data.foo = function(){ ... }` don't fail.\n\nIn the case of a build where multiple javascript source files\nare combined into one bigger file (similar to a .lib or .jar\nfile), that file may contain multiple dojo.provide() calls, to\nnote that it includes multiple resources.", "examples": { "example": "Safely create a `my` object, and make dojo.require(\"my.CustomModule\") work\n\tdojo.provide(\"my.CustomModule\");" }, "parameters": [ { "name": "resourceName", "type": "String", "usage": "required", "summary": "A dot-sperated string identifying a resource." } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "platformRequire", "scope": "normal", "summary": "require one or more modules based on which host environment\nDojo is currently operating in", "description": "This method takes a \"map\" of arrays which one can use to\noptionally load dojo modules. The map is indexed by the\npossible dojo.name_ values, with two additional values:\n\"default\" and \"common\". The items in the \"default\" array will\nbe loaded if none of the other items have been choosen based on\ndojo.name_, set by your host environment. The items in the\n\"common\" array will *always* be loaded, regardless of which\nlist is chosen.", "examples": { "example": "\tdojo.platformRequire({\n\t\tbrowser: [\n\t\t\t\"foo.sample\", \/\/ simple module\n\t\t\t\"foo.test\",\n\t\t\t[\"foo.bar.baz\", true] \/\/ skip object check in _loadModule (dojo.require)\n\t\t],\n\t\tdefault: [ \"foo.sample._base\" ],\n\t\tcommon: [ \"important.module.common\" ]\n\t});" }, "parameters": [ { "name": "modMap", "type": "Object", "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "requireIf", "scope": "normal", "summary": "If the condition is true then call dojo.require()<\/code> for the specified\nresource", "examples": { "example": "\tdojo.requireIf(dojo.isBrowser, \"my.special.Module\");" }, "parameters": [ { "name": "condition", "type": "Boolean", "usage": "required" }, { "name": "resourceName", "type": "String", "usage": "required" } ] }, { "resources": [ "dojo\/_base\/_loader\/loader.js" ], "name": "registerModulePath", "scope": "normal", "summary": "Maps a module name to a path", "description": "An unregistered module is given the default path of ..\/[module],\nrelative to Dojo root. For example, module acme is mapped to\n..\/acme. If you want to use a different module name, use\ndojo.registerModulePath.", "examples": { "example": "If your dojo.js is located at this location in the web root:\n\t\/myapp\/js\/dojo\/dojo\/dojo.js\nand your modules are located at:\n\t\/myapp\/js\/foo\/bar.js\n\t\/myapp\/js\/foo\/baz.js\n\t\/myapp\/js\/foo\/thud\/xyzzy.js\nYour application can tell Dojo to locate the \"foo\" namespace by calling:\n\tdojo.registerModulePath(\"foo\", \"..\/..\/foo\");\nAt which point you can then use dojo.require() to load the\nmodules (assuming they provide() the same things which are\nrequired). The full code might be:\n\t