{ "dijit": { "location": "dijit", "resources": [ "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\/_DialogMixin.js", "dijit\/_KeyNavContainer.js", "dijit\/_Templated.js", "dijit\/_TimePicker.js", "dijit\/_Widget.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\/LinkDialog.js", "dijit\/_editor\/plugins\/TabIndent.js", "dijit\/_editor\/plugins\/TextColor.js", "dijit\/_editor\/plugins\/ToggleDir.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\/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\/_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\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dijit\/layout\/StackController.js", "dijit\/layout\/TabContainer.js", "dijit\/layout\/TabController.js", "dijit\/layout\/_LayoutWidget.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.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._DialogMixin", "dijit._KeyNavContainer", "dijit._Templated", "dijit._TimePicker", "dijit._Widget", "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.LinkDialog", "dijit._editor.plugins.TabIndent", "dijit._editor.plugins.TextColor", "dijit._editor.plugins.ToggleDir", "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.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._FormWidget", "dijit.form._Spinner", "dijit.layout.AccordionContainer", "dijit.layout.AccordionPane", "dijit.layout.BorderContainer", "dijit.layout.ContentPane", "dijit.layout.LayoutContainer", "dijit.layout.LinkPane", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dijit.layout.StackController", "dijit.layout.TabContainer", "dijit.layout.TabController", "dijit.layout._LayoutWidget", "dijit.robot", "dijit.robotx", "dijit.tree.ForestStoreModel", "dijit.tree.TreeStoreModel", "dijit.tree._dndContainer", "dijit.tree._dndSelector", "dijit.tree.dndSource" ], "properties": [ { "name": "_masterTT", "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_curFocus", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": null, "private": true }, { "name": "_prevFocus", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": null, "private": true }, { "name": "_activeStack", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_justMouseDowned", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "bool", "private": true }, { "name": "_clearActiveWidgetsTimer", "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "scope": "normal", "type": "Object", "private": true }, { "name": "defaultDuration", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "scope": "normal", "type": "Number" }, { "name": "registry", "resources": [ "dijit\/_base\/manager.js", "dijit\/robotx.js" ], "provides": [ "dijit._base.manager", "dijit.robotx" ], "scope": "normal", "type": "Object", "summary": "A list of widgets on a page." }, { "name": "_widgetTypeCtr", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "scope": "normal", "type": "Object", "private": true }, { "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": "_XhtmlRoles", "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "scope": "normal", "type": "RegExp", "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" } ] }, { "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", "return-types": [ { "type": "Boolean" } ] }, { "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": "Array" } ] }, { "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 dojo.html.selection.getBookmark()" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "getFocus", "scope": "normal", "summary": "Returns the current focus and selection.\nCalled when a popup appears (either a top level menu or a dialog),\nor when a toolbar\/menubar receives focus", "return-description": "A handle to restore focus\/selection", "parameters": [ { "name": "menu", "type": "Widget", "usage": "optional", "summary": "The menu that's being opened" }, { "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.", "parameters": [ { "name": "iframe", "type": "DomNode", "usage": "required" } ] }, { "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.", "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": "_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" } ] }, { "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": null, "usage": "required" } ] }, { "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, putting found widgets in outAry.\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": "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|Widget", "usage": "required" } ], "return-types": [ { "type": "Widget" } ] }, { "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": "Widget" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "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": "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:\nthe first tab-navigable element in document order\nwithout a tabindex or with tabindex=\"0\"\nthe last tab-navigable element in document order\nwithout a tabindex or with tabindex=\"0\"\nthe first element in document order with the lowest\npositive tabindex value\nthe 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": "__Position", "scope": "normal", "private": true }, { "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", "usage": "required", "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": "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": "__Rectangle", "scope": "normal", "private": true }, { "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\/scroll.js" ], "provides": [ "dijit._base.scroll" ], "name": "scrollIntoView", "scope": "normal", "summary": "Scroll the passed node into view, if it is not.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ], "return-types": [ { "type": "TODO: handle without native call" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "hasWaiRole", "scope": "normal", "summary": "Determines if an element has a particular non-XHTML role.", "return-description": "True if elem has the specific non-XHTML role attribute and false if not.\nFor backwards compatibility if role parameter not provided,\nreturns true if has non XHTML role", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiRole", "scope": "normal", "summary": "Gets the non-XHTML role for an element (which should be a wai role).", "return-description": "The non-XHTML 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": "In other than FF2 replace existing role attribute with new role.\nFF3 supports XHTML and ARIA roles so\nif elem already has an XHTML role, append this role to XHTML role\nand remove other ARIA roles.\nOn Firefox 2 and below, \"wairole:\" is\nprepended to the provided role value.", "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 non-XHTML 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": "On Firefox 2 and below, we check for an attribute in namespace\n\"http:\/\/www.w3.org\/2005\/07\/aaa\" with a name of the given state.\nOn all other browsers, we check for an attribute\ncalled \"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" } ], "return-types": [ { "type": "www.w3.org\/2005\/07\/aaa\", state);" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiState", "scope": "normal", "summary": "Gets the value of a state on an element.", "description": "On Firefox 2 and below, we check for an attribute in namespace\n\"http:\/\/www.w3.org\/2005\/07\/aaa\" with a name of the given state.\nOn all other browsers, we check for an attribute called\n\"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" } ], "return-types": [ { "type": "www.w3.org\/2005\/07\/aaa\", state);" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "setWaiState", "scope": "normal", "summary": "Sets a state on an element.", "description": "On Firefox 2 and below, we set an attribute in namespace\n\"http:\/\/www.w3.org\/2005\/07\/aaa\" with a name of the given state.\nOn all other browsers, we set an attribute called\n\"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": "On Firefox 2 and below, we remove the attribute in namespace\n\"http:\/\/www.w3.org\/2005\/07\/aaa\" with a name of the given state.\nOn all other browsers, we remove the attribute called\n\"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", "summary": "Get window object associated with document doc", "parameters": [ { "name": "doc", "type": null, "usage": "required" } ], "return-types": [ { "type": "Window" } ] }, { "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.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": "templatePath", "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>", " var picker = new dijit.ColorPalette({ },srcNode);\n\tpicker.startup();" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._Templated.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._Templated" } ] }, "properties": [ { "name": "defaultTimeout", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Number", "summary": "Number of milliseconds before a held key or button becomes typematic" }, { "name": "timeoutChangeRate", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Number", "summary": "Fraction of time used to change the typematic timer between events\n1.0 means that each typematic event fires at defaultTimeout intervals\n< 1.0 means that each typematic event fires at an increasing faster rate" }, { "name": "palette", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "summary": "Size of grid, either "7x10" or "3x4"." }, { "name": "value", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "summary": "The value of the selected color." }, { "name": "_currentFocus", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Integer", "private": true, "summary": "Index of the currently focused color." }, { "name": "_xDim", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Integer", "summary": "This is the number of colors horizontally across." }, { "name": "_yDim", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Integer", "summary": "\/\t\tThis is the number of colors vertically down." }, { "name": "templatePath", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "summary": "Path to the template of this widget." }, { "name": "tabIndex", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "String", "summary": "Widget tab index." } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "focus", "scope": "prototype", "summary": "Focus this ColorPalette. Puts focus on the first swatch." }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "onChange", "scope": "prototype", "summary": "Callback when a color is selected.", "parameters": [ { "name": "color", "type": "String", "usage": "required", "summary": "Hex value corresponding to color.\nconsole.debug("Color selected is: "+color);" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_focusFirst", "scope": "prototype", "private": true, "summary": "Focus the first cell in the color picker,\nor the previously selected cell, if there is one" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onDivNodeFocus", "scope": "prototype", "private": true, "summary": "Handler for when focus goes to the ColorPalette itself.\nShifts focus to the first color or the previously selected\ncolor.", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onFocus", "scope": "prototype", "summary": "Handler for when the ColorPalette or a color cell inside of it get focus" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onBlur", "scope": "prototype", "summary": "Handler for when the ColorPalette and the color cell inside of it lose focus" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onCellDijitclick", "scope": "prototype", "private": true, "summary": "Handler for click, enter key & space key. Selects the color.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required", "summary": "The event." } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onCellMouseEnter", "scope": "prototype", "private": true, "summary": "Handler for onMouseOver. Put focus on the color under the mouse.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required", "summary": "The mouse event." } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onCellFocus", "scope": "prototype", "private": true, "summary": "Handler for onFocus of a cell. Removes highlight of\nthe color that just lost focus, and highlights\nthe new color.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required", "summary": "The focus event." } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_setCurrent", "scope": "prototype", "summary": "Called when a color is hovered or focused.", "description": "Removes highlight of the old color, and highlights\nthe new color.", "parameters": [ { "name": "node", "type": "Node", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_onCellBlur", "scope": "prototype", "private": true, "summary": "needed for Firefox 2 on Mac OS X", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_removeCellHighlight", "scope": "prototype", "private": true, "summary": "Removes the hover CSS class for the specified cell", "parameters": [ { "name": "index", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_selectColor", "scope": "prototype", "private": true, "summary": "This selects a color. It triggers the onChange event\narea:\nThe area node that covers the color being selected.", "parameters": [ { "name": "selectNode", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_navigateByKey", "scope": "prototype", "private": true, "summary": "This is the callback for typematic.\nIt changes the focus and the highlighed color.", "parameters": [ { "name": "increment", "type": "How", "usage": "required", "summary": "much the key is navigated." }, { "name": "typeCount", "type": "How", "usage": "required", "summary": "many times typematic has fired." } ] } ] }, "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 arrays 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 } ] }, "dijit.ColorPalette._paletteCoords": { "location": "dijit.ColorPalette._paletteCoords", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Map", "summary": "This is a map that is used to calculate the coordinates of the\nimages that make up the palette.", "properties": [ { "name": "leftOffset", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Number", "privateparent": true }, { "name": "topOffset", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Number", "privateparent": true }, { "name": "cWidth", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Number", "privateparent": true }, { "name": "cHeight", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "Number", "privateparent": true } ] }, "dijit.ColorPalette._paletteDims": { "location": "dijit.ColorPalette._paletteDims", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "summary": "Size of the supported palettes for alignment purposes." }, "dijit.ColorPalette._paletteDims.7x10": { "location": "dijit.ColorPalette._paletteDims.7x10", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "privateparent": true, "properties": [ { "name": "width", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "String", "privateparent": true }, { "name": "height", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "String", "privateparent": true } ] }, "dijit.ColorPalette._paletteDims.3x4": { "location": "dijit.ColorPalette._paletteDims.3x4", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "privateparent": true, "properties": [ { "name": "width", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "String", "privateparent": true }, { "name": "height", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "normal", "type": "String", "privateparent": true } ] }, "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": "widgetClass", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "String", "summary": "Name of class being declared, ex: "acme.myWidget"" }, { "name": "defaults", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": null }, { "name": "mixins", "resources": [ "dijit\/Declaration.js" ], "provides": [ "dijit.Declaration" ], "scope": "prototype", "type": "String[]", "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.Dialog": { "location": "dijit.Dialog", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "type": "Function", "classlike": true, "superclass": "dijit.layout.ContentPane", "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._Templated.prototype" }, { "scope": "prototype", "location": "dijit.form._FormMixin.prototype" }, { "scope": "prototype", "location": "dijit._DialogMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.layout.ContentPane" }, { "scope": "instance", "location": "dijit._Templated" }, { "scope": "instance", "location": "dijit.form._FormMixin" }, { "scope": "instance", "location": "dijit._DialogMixin" } ] }, "properties": [ { "name": "templateString", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": null }, { "name": "templatePath", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object" }, { "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", "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": "[readonly]", "private": true, "summary": "DomNode\nThe 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": "[readonly]", "private": true, "summary": "DomNode\nThe 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": "_fixSizes", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Boolean", "private": true, "summary": "Does this Dialog attempt to restore the width and height after becoming too small?" } ], "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 overriden." }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_endDrag", "scope": "prototype", "private": true, "summary": "Called after dragging the Dialog. Calculates the relative offset\nof the Dialog in relation to 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": "uninitialize", "scope": "prototype" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_size", "scope": "prototype", "private": true, "summary": "Make sure the dialog is small enough to fit 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" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "hide", "scope": "prototype", "summary": "Hide the dialog" }, { "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" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_onCloseEnter", "scope": "prototype", "private": true, "summary": "Called when user hovers over close icon" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_onCloseLeave", "scope": "prototype", "private": true, "summary": "Called when user stops hovering over close icon" } ] }, "dojo": { "location": "dojo", "resources": [ "dijit\/_Widget.js", "dijit\/_base\/sniff.js", "dojo\/AdapterRegistry.js", "dojo\/DeferredList.js", "dojo\/NodeList-fx.js", "dojo\/NodeList-html.js", "dojo\/_base\/Color.js", "dojo\/_base\/Deferred.js", "dojo\/_base\/NodeList.js", "dojo\/_base\/_loader\/bootstrap.js", "dojo\/_base\/_loader\/hostenv_browser.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\/browser.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\/_base.js", "dojo\/_firebug\/firebug.js", "dojo\/back.js", "dojo\/behavior.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\/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\/html.js", "dojo\/i18n.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\/string.js", "dojox\/charting\/widget\/Chart2D.js", "dojox\/charting\/widget\/Sparkline.js", "dojox\/data\/FlickrStore.js", "dojox\/fx\/style.js", "dojox\/gfx\/fx.js", "dojox\/gfx\/utils.js", "dojox\/grid\/_Grid.js", "dojox\/grid\/cells\/_base.js", "dojox\/grid\/cells\/dijit.js", "dojox\/grid\/compat\/Grid.js", "dojox\/lang\/aspect.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\/lang\/oo\/declare.js", "dojox\/xml\/widgetParser.js" ], "provides": [ "dijit._Widget", "dijit._base.sniff", "dojo.AdapterRegistry", "dojo.DeferredList", "dojo.NodeList-fx", "dojo.NodeList-html", "dojo._base.Color", "dojo._base.Deferred", "dojo._base.NodeList", "dojo._base._loader.loader_debug", "dojo._base._loader.loader_xd", "dojo._base.array", "dojo._base.browser", "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._base", "dojo._firebug.firebug", "dojo.back", "dojo.behavior", "dojo.cldr.monetary", "dojo.cldr.supplemental", "dojo.colors", "dojo.cookie", "dojo.currency", "dojo.data.ItemFileReadStore", "dojo.data.ItemFileWriteStore", "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.html", "dojo.i18n", "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.string", "dojox.charting.widget.Chart2D", "dojox.charting.widget.Sparkline", "dojox.data.FlickrStore", "dojox.fx.style", "dojox.gfx.fx", "dojox.gfx.utils", "dojox.grid._Grid", "dojox.grid.cells._base", "dojox.grid.cells.dijit", "dojox.grid.compat.Grid", "dojox.lang.aspect", "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.lang.oo.declare", "dojox.xml.widgetParser" ], "properties": [ { "name": "global", "resources": [ "dijit\/_base\/focus.js", "dijit\/_editor\/selection.js", "dijit\/form\/TextBox.js", "dijit\/robotx.js", "dojo\/_base\/_loader\/bootstrap.js", "dojo\/_base\/html.js", "dojo\/_base\/window.js", "dojo\/robotx.js", "dojox\/atom\/io\/Connection.js", "dojox\/data\/AppStore.js" ], "provides": [ "dijit._base.focus", "dijit._editor.selection", "dijit.form.TextBox", "dijit.robotx", "dojo._base.html", "dojo._base.window", "dojo.robotx", "dojox.atom.io.Connection", "dojox.data.AppStore" ], "scope": "normal", "type": "Object", "summary": "Alias for the global scope\n(e.g. the window object in a browser)." }, { "name": "isIE", "resources": [ "dijit\/_base\/scroll.js", "dijit\/_base\/sniff.js", "dojo\/_base\/_loader\/hostenv_browser.js" ], "provides": [ "dijit._base.scroll", "dijit._base.sniff" ], "scope": "normal", "type": "Number" }, { "name": "isOpera", "resources": [ "dijit\/_base\/sniff.js", "dojo\/_base\/_loader\/hostenv_browser.js" ], "provides": [ "dijit._base.sniff" ], "scope": "normal", "type": "Number" }, { "name": "isFF", "resources": [ "dijit\/_base\/sniff.js", "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "provides": [ "dijit._base.sniff" ], "scope": "normal", "type": "Number" }, { "name": "isWebKit", "resources": [ "dijit\/_editor\/RichText.js", "dojo\/_base\/_loader\/hostenv_browser.js", "dojox\/dtl\/dom.js" ], "provides": [ "dijit._editor.RichText", "dojox.dtl.dom" ], "scope": "normal", "type": "Number" }, { "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": "_scopeArgs", "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "locale", "resources": [ "dojo\/_base\/_loader\/bootstrap.js", "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js" ], "scope": "normal", "type": "Object", "summary": "the locale as defined by Dojo (read-only)" }, { "name": "isBrowser", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "bool" }, { "name": "isKhtml", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "scope": "normal", "type": "Number" }, { "name": "isMozilla", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "Number" }, { "name": "isSafari", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "scope": "normal", "type": "Number" }, { "name": "isChrome", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "scope": "normal", "type": "Number" }, { "name": "baseUrl", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/_loader\/hostenv_spidermonkey.js", "dojo\/resources\/_modules.js", "dojox\/flash\/_base.js" ], "provides": [ "dojox.flash._base" ], "scope": "normal", "type": "String", "summary": "The root relative path to dojo.js (as a string)" }, { "name": "isAIR", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "scope": "normal", "type": "Number" }, { "name": "isMoz", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": null }, { "name": "isQuirks", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "bool" }, { "name": "_XMLHTTP_PROGIDS", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "scope": "normal", "type": "Array", "private": true }, { "name": "_windowUnloaders", "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js" ], "scope": "normal", "type": "Array", "private": true }, { "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": "_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": "bool" }, { "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": "bool", "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" ], "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": "_xdDebugQueue", "resources": [ "dojo\/_base\/_loader\/loader_debug.js" ], "provides": [ "dojo._base._loader.loader_debug" ], "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", "dojo\/robotx.js" ], "provides": [ "dojo._base.connect", "dojo.robotx" ], "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": "_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": "_bodyLtr", "resources": [ "dojo\/_base\/html.js", "dojo\/_base\/window.js" ], "provides": [ "dojo._base.html", "dojo._base.window" ], "scope": "normal", "type": "bool", "private": true }, { "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": "_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": "parser", "resources": [ "dojo\/parser.js" ], "provides": [ "dojo.parser" ], "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": "_defaultXhr", "resources": [ "dojox\/rpc\/Client.js" ], "provides": [ "dojox.rpc.Client" ], "scope": "normal", "type": null, "private": true } ], "methods": [ { "resources": [ "dijit\/_Templated.js", "dojo\/_base\/lang.js", "dojox\/dtl\/contrib\/dijit.js" ], "provides": [ "dijit._Templated", "dojo._base.lang", "dojox.dtl.contrib.dijit" ], "name": "trim", "scope": "normal", "summary": "Trims whitespace from both sides of the string", "description": "This version of trim() was selected for inclusion into the base due\nto its compact size and relatively good performance\n(see [Steven Levithan's blog](http:\/\/blog.stevenlevithan.com\/archives\/faster-trim-javascript)\nUses String.prototype.trim instead, if available.\nThe fastest but longest version of this function is located at\ndojo.string.trim()", "return-description": "String\nReturns the trimmed string", "parameters": [ { "name": "str", "type": "String", "usage": "required", "summary": "String to be trimmed" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/_Widget.js", "dojo\/_base\/connect.js", "dojo\/_base\/event.js" ], "provides": [ "dijit._Widget", "dojo._base.connect", "dojo._base.event" ], "name": "_connect", "scope": "normal", "private": true, "parameters": [ { "name": "obj", "type": null, "usage": "required" }, { "name": "event", "type": null, "usage": "required" }, { "name": "context", "type": null, "usage": "required" }, { "name": "method", "type": null, "usage": "required" }, { "name": "dontFix", "type": null, "usage": "required" } ], "return-types": [ { "type": "Handle" } ] }, { "resources": [ "dijit\/_base\/typematic.js", "dojo\/_base\/connect.js" ], "provides": [ "dijit._base.typematic", "dojo._base.connect" ], "name": "connect", "scope": "normal", "summary": "Create a link that calls one function when another executes.", "description": "Connects method to event, so that after event fires, method\ndoes too. All connected functions are passed the same arguments as\nthe event function was initially called with. You may connect as\nmany methods to event as needed.\n\nevent must be a string. If obj is null, dojo.global is used.\n\nnull arguments may simply be omitted.\n\nobj[event] can resolve to a function or undefined (null).\nIf obj[event] is null, it is assigned a function.\n\nThe return value is a handle that is needed to\nremove this connection with dojo.disconnect.", "examples": [ "When obj.onchange(), do ui.update():\n\tdojo.connect(obj, \"onchange\", ui, \"update\");\n\tdojo.connect(obj, \"onchange\", ui, ui.update); \/\/ same", "Using return value for disconnect:\n\tvar link = dojo.connect(obj, \"onchange\", ui, \"update\");\n\t...\n\tdojo.disconnect(link);", "When onglobalevent executes, watcher.handler is invoked:\n\tdojo.connect(null, \"onglobalevent\", watcher, \"handler\");", "When ob.onCustomEvent executes, customEventHandler is invoked:\n\tdojo.connect(ob, \"onCustomEvent\", null, \"customEventHandler\");\n\tdojo.connect(ob, \"onCustomEvent\", \"customEventHandler\"); \/\/ same", "When ob.onCustomEvent executes, customEventHandler is invoked\nwith the same scope (this):\n\tdojo.connect(ob, \"onCustomEvent\", null, customEventHandler);\n\tdojo.connect(ob, \"onCustomEvent\", customEventHandler); \/\/ same", "When globalEvent executes, globalHandler is invoked\nwith the same scope (this):\n\tdojo.connect(null, \"globalEvent\", null, globalHandler);\n\tdojo.connect(\"globalEvent\", globalHandler); \/\/ same" ], "parameters": [ { "name": "obj", "type": "Object|null", "usage": "required", "summary": "The source object for the event function.\nDefaults to dojo.global if null.\nIf obj is a DOM node, the connection is delegated\nto the DOM event manager (unless dontFix is true)." }, { "name": "event", "type": "String", "usage": "required", "summary": "name of the event function in obj.\nI.e. identifies a property obj[event]." }, { "name": "context", "type": "Object|null", "usage": "required", "summary": "The object that method will receive as "this".\n\nIf context is null and method is a function, then method\ninherits the context of event.\n\nIf method is a string then context must be the source\nobject object for method (context[method]). If context is null,\ndojo.global is used." }, { "name": "method", "type": "String|Function", "usage": "required", "summary": "A function reference, or name of a function in context.\nThe function identified by method fires after event does.\nmethod receives the same arguments as the event.\nSee context argument comments for information on method's scope." }, { "name": "dontFix", "type": "Boolean", "usage": "required", "summary": "If obj is a DOM node, set dontFix to true to prevent delegation\nof this connection to the DOM event manager." } ] }, { "resources": [ "dijit\/_editor\/plugins\/AlwaysShowToolbar.js", "dojo\/_base\/_loader\/hostenv_rhino.js", "dojo\/_base\/window.js" ], "provides": [ "dijit._editor.plugins.AlwaysShowToolbar", "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\/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.", "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.", "examples": [ " var thing = dojo.colorFromHex(\"#ededed\"); \/\/ grey, longhand", " var thing = dojo.colorFromHex(\"#000\"); \/\/ black, shorthand" ], "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 color from 1, 2, 3, or 4 element array", "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 for a color value.", "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\/_loader\/bootstrap.js", "dojo\/_base\/fx.js" ], "provides": [ "dojo._base.fx" ], "name": "_mixin", "scope": "normal", "private": true, "summary": "Adds all properties and methods of props to obj. This addition\nis "prototype extension safe", so that instances of objects\nwill not pass along prototype defaults.", "parameters": [ { "name": "obj", "type": "Object", "usage": "required" }, { "name": "props", "type": "Object", "usage": "required" } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "mixin", "scope": "normal", "summary": "Adds all properties and methods of props to obj and returns the\n(now modified) obj.", "description": "`dojo.mixin` can mix multiple source objects into a\ndestionation object which is then returned. Unlike regular\n`for...in` iteration, `dojo.mixin` is also smart about avoiding\nextensions which other toolkits may unwisely add to the root\nobject prototype", "examples": [ "make a shallow copy of an object\n\tvar copy = dojo.mixin({}, source);", "many class constructors often take an object which specifies\nvalues to be configured on the object. In this case, it is\noften simplest to call `dojo.mixin` on the `this` object:\n\tdojo.declare(\"acme.Base\", null, {\n\t\tconstructor: function(properties){\n\t\t\t\/\/ property configuration:\n\t\t\tdojo.mixin(this, properties);\n\n\t\t\tconsole.log(this.quip);\n\t\t\t\/\/ ...\n\t\t},\n\t\tquip: \"I wasn't born yesterday, you know - I've seen movies.\",\n\t\t\/\/ ...\n\t});\n\n\t\/\/ create an instance of the class and configure it\n\tvar b = new acme.Base({quip: \"That's what it does!\" });", "copy in properties from multiple objects\n\tvar flattened = dojo.mixin(\n\t\t{\n\t\t\tname: \"Frylock\",\n\t\t\tbraces: true\n\t\t},\n\t\t{\n\t\t\tname: \"Carl Brutanananadilewski\"\n\t\t}\n\t);\n\n\t\/\/ will print \"Carl Brutanananadilewski\"\n\tconsole.log(flattened.name);\n\t\/\/ will print \"true\"\n\tconsole.log(flattened.braces);" ], "parameters": [ { "name": "obj", "type": "Object", "usage": "required", "summary": "The object to mix properties into. Also the return value." }, { "name": "props", "type": "Object", "usage": "one-or-more", "summary": "One or more objects whose values are successively copied into\nobj. If more than one of these objects contain the same value,\nthe one specified last in the function call will "win"." } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "_getProp", "scope": "normal", "private": true, "parameters": [ { "name": "parts", "type": "Array", "usage": "required" }, { "name": "create", "type": "Boolean", "usage": "required" }, { "name": "context", "type": "Object", "usage": "required" } ], "return-types": [ { "type": "mixed" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "setObject", "scope": "normal", "summary": "Set a property from a dot-separated string, such as "A.B.C"", "description": "Useful for longer api chains where you have to test each object in\nthe chain, or when you have an object reference in string format.\nObjects are created as needed along `path`. Returns the passed\nvalue if setting is successful or `undefined` if not.", "examples": [ "set the value of `foo.bar.baz`, regardless of whether\nintermediate objects already exist:\n\tdojo.setObject(\"foo.bar.baz\", value);", "without `dojo.setObject`, we often see code like this:\n\t\/\/ ensure that intermediate objects are available\n\tif(!obj[\"parent\"]){ obj.parent = {}; }\n\tif(!obj.parent[\"child\"]){ obj.parent.child= {}; }\n\t\/\/ now we can safely set the property\n\tobj.parent.child.prop = \"some value\";\nwheras with `dojo.setObject`, we can shorten that to:\n\tdojo.setObject(\"parent.child.prop\", \"some value\", obj);" ], "parameters": [ { "name": "name", "type": "String", "usage": "required", "summary": "Path to a property, in the form "A.B.C"." }, { "name": "value", "type": "Object", "usage": "required" }, { "name": "context", "type": "Object", "usage": "optional", "summary": "Optional. Object to use as root of path. Defaults to\ndojo.global<\/code>." } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "getObject", "scope": "normal", "summary": "Get a property from a dot-separated string, such as "A.B.C"", "description": "Useful for longer api chains where you have to test each object in\nthe chain, or when you have an object reference in string format.", "parameters": [ { "name": "name", "type": "String", "usage": "required", "summary": "Path to an property, in the form "A.B.C"." }, { "name": "create", "type": "Boolean", "usage": "optional", "summary": "Optional. Defaults to false<\/code>. If true<\/code>, Objects will be\ncreated at any point along the 'path' that is undefined." }, { "name": "context", "type": "Object", "usage": "optional", "summary": "Optional. Object to use as root of path. Defaults to\n'dojo.global'. Null may be passed." } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "exists", "scope": "normal", "summary": "determine if an object supports a given method", "description": "useful for longer api chains where you have to test each object in\nthe chain. Useful only for object and method detection.\nNot useful for testing generic properties on an object.\nIn particular, dojo.exists(\"foo.bar\") when foo.bar = \"\"\nwill return false. Use (\"bar\" in foo) to test for those cases.", "examples": { "example": "\t\/\/ define an object\n\tvar foo = {\n\t\tbar: { }\n\t};\n\n\t\/\/ search the global scope\n\tdojo.exists(\"foo.bar\"); \/\/ true\n\tdojo.exists(\"foo.bar.baz\"); \/\/ false\n\n\t\/\/ search from a particular scope\n\tdojo.exists(\"bar\", foo); \/\/ true\n\tdojo.exists(\"bar.baz\", foo); \/\/ false" }, "parameters": [ { "name": "name", "type": "String", "usage": "required", "summary": "Path to an object, in the form "A.B.C"." }, { "name": "obj", "type": "Object", "usage": "optional", "summary": "to use as root of path. Defaults to\n'dojo.global'. Null may be passed." } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js" ], "name": "eval", "scope": "normal", "summary": "Perform an evaluation in the global scope. Use this rather than\ncalling 'eval()' directly.", "description": "Placed in a separate function to minimize size of trapped\nexceptions. Calling eval() directly from some other scope may\ncomplicate tracebacks on some platforms.", "return-description": "The result of the evaluation. Often `undefined`", "parameters": [ { "name": "scriptFragment", "type": "String", "usage": "required" } ], "return-types": [ { "type": "Object" } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js", "dojo\/_firebug\/firebug.js" ], "provides": [ "dojo._firebug.firebug" ], "name": "deprecated", "scope": "normal", "summary": "Log a debug message to indicate that a behavior has been\ndeprecated.", "examples": { "example": "\tdojo.deprecated(\"myApp.getTemp()\", \"use myApp.getLocaleTemp() instead\", \"1.0\");" }, "parameters": [ { "name": "behaviour", "type": "String", "usage": "required", "summary": "The API or behavior being deprecated. Usually in the form\nof "myApp.someFunction()"." }, { "name": "extra", "type": "String", "usage": "optional", "summary": "Text to append to the message." }, { "name": "removal", "type": "String", "usage": "optional", "summary": "Text to indicate when in the future the behavior will be removed." } ] }, { "resources": [ "dojo\/_base\/_loader\/bootstrap.js", "dojo\/_firebug\/firebug.js" ], "provides": [ "dojo._firebug.firebug" ], "name": "experimental", "scope": "normal", "summary": "Marks code as experimental.", "description": "This can be used to mark a function, file, or module as\nexperimental. Experimental code is not ready to be used, and the\nAPIs are subject to change without notice. Experimental code may be\ncompleted deleted without going through the normal deprecation\nprocess.", "examples": [ "\tdojo.experimental(\"dojo.data.Result\");", "\tdojo.experimental(\"dojo.weather.toKelvin()\", \"PENDING approval from NOAA\");" ], "parameters": [ { "name": "moduleName", "type": "String", "usage": "required", "summary": "The name of a module, or the name of a module file or a specific\nfunction" }, { "name": "extra", "type": "String", "usage": "optional", "summary": "some additional message for the user" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.js", "dojox\/io\/proxy\/xip.js", "dojox\/io\/xhrPlugins.js" ], "provides": [ "dojox.io.proxy.xip", "dojox.io.xhrPlugins" ], "name": "_xhrObj", "scope": "normal", "private": true, "summary": "does the work of portably generating a new XMLHTTPRequest object.", "return-types": [ { "type": "XMLHTTPRequest instance" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js", "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_browser.js", "dojo\/_base\/_loader\/hostenv_ff_ext.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. If absolute, it still must be in\nthe same "domain" as we are." }, { "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_browser.js", "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_browser.js", "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.", "description": "The first time that addOnWindowUnload is called Dojo\nwill register a page listener to trigger your unload\nhandler with. Note that registering these handlers may\ndestory \"fastback\" page caching in browsers that support\nit. Be careful trying to modify the DOM or access\nJavaScript properties during this phase of page unloading:\nthey may not always be available. Consider\ndojo.addOnUnload() if you need to modify the DOM or do\nheavy JavaScript work since it fires at the eqivalent of\nthe page's \"onbeforeunload\" event.", "examples": [ "\tdojo.addOnWindowUnload(functionPointer)\n\tdojo.addOnWindowUnload(object, \"functionName\");\n\tdojo.addOnWindowUnload(object, function(){ \/* ... *\/});", "\tdojo.addOnWindowUnload(functionPointer)\n\tdojo.addOnWindowUnload(object, \"functionName\")\n\tdojo.addOnWindowUnload(object, function(){ \/* ... *\/});" ], "parameters": [ { "name": "obj", "type": "Object|Function", "usage": "optional" }, { "name": "functionName", "type": "String|Function", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/_loader\/hostenv_browser.js" ], "name": "addOnUnload", "scope": "normal", "summary": "registers a function to be triggered when the page unloads.", "description": "The first time that addOnUnload is called Dojo will\nregister a page listener to trigger your unload handler\nwith.\n\nIn a browser enviroment, the functions will be triggered\nduring the window.onbeforeunload event. Be careful of doing\ntoo much work in an unload handler. onbeforeunload can be\ntriggered if a link to download a file is clicked, or if\nthe link is a javascript: link. In these cases, the\nonbeforeunload event fires, but the document is not\nactually destroyed. So be careful about doing destructive\noperations in a dojo.addOnUnload callback.\n\nFurther note that calling dojo.addOnUnload will prevent\nbrowsers from using a \"fast back\" cache to make page\nloading via back button instantaneous.", "examples": { "example": "\tdojo.addOnUnload(functionPointer)\n\tdojo.addOnUnload(object, \"functionName\")\n\tdojo.addOnUnload(object, function(){ \/* ... *\/});" }, "parameters": [ { "name": "obj", "type": "Object|Function", "usage": "optional" }, { "name": "functionName", "type": "String|Function", "usage": "optional" } ] }, { "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" } ] }, { "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", "parameters": [ { "name": "id", "type": null, "usage": "required" }, { "name": "doc", "type": null, "usage": "required" } ], "return-types": [ { "type": "assume it's a node" }, { "type": "DomNode" } ] }, { "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" ], "name": "_rhinoCurrentScriptViaJava", "scope": "normal", "private": true, "parameters": [ { "name": "depth", "type": null, "usage": "required" } ] }, { "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\tfinishes 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": "addOnLoad", "scope": "normal", "summary": "Registers a function to be triggered after the DOM has finished\nloading and widgets declared in markup have been instantiated.\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.)", "examples": { "example": "\tdojo.addOnLoad(functionPointer);\n\tdojo.addOnLoad(object, \"functionName\");\n\tdojo.addOnLoad(object, function(){ \/* ... *\/});" }, "parameters": [ { "name": "obj", "type": "Object", "usage": "optional" }, { "name": "functionName", "type": "String|Function", "usage": "required" } ] }, { "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\/help\/_base.js", "dojox\/lang\/docs.js" ], "provides": [ "dojox.help._base", "dojox.lang.docs" ], "name": "require", "scope": "normal", "summary": "loads a Javascript module from the appropriate URI", "description": "`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 excpetion 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`.\n\n`dojo.require()` does nothing about importing symbols into\nthe current namespace. It is presumed that the caller will\ntake care of that. For example, to import all symbols into a\nlocal 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": "Each javascript source file must have at least one\ndojo.provide()<\/code> call at the top of the file, corresponding to\nthe file name. For example, js\/dojo\/foo.js<\/code> must have\ndojo.provide("dojo.foo");<\/code> before any calls to\ndojo.require()<\/code> are made.", "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\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.", "parameters": [ { "name": "resourceName", "type": "String", "usage": "required" } ], "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() for the specified\nresource", "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