{ "dijit": { "location": "dijit", "resources": [ "dijit\/BackgroundIframe.js", "dijit\/Calendar.js", "dijit\/CalendarLite.js", "dijit\/CheckedMenuItem.js", "dijit\/ColorPalette.js", "dijit\/Dialog.js", "dijit\/DialogUnderlay.js", "dijit\/DropDownMenu.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\/_BidiSupport.js", "dijit\/_Calendar.js", "dijit\/_Contained.js", "dijit\/_Container.js", "dijit\/_CssStateMixin.js", "dijit\/_DialogMixin.js", "dijit\/_FocusMixin.js", "dijit\/_HasDropDown.js", "dijit\/_KeyNavContainer.js", "dijit\/_MenuBase.js", "dijit\/_OnDijitClickMixin.js", "dijit\/_PaletteMixin.js", "dijit\/_Templated.js", "dijit\/_TemplatedMixin.js", "dijit\/_TimePicker.js", "dijit\/_Widget.js", "dijit\/_WidgetBase.js", "dijit\/_WidgetsInTemplateMixin.js", "dijit\/_base\/focus.js", "dijit\/_base\/manager.js", "dijit\/_base\/place.js", "dijit\/_base\/popup.js", "dijit\/_base\/scroll.js", "dijit\/_base\/sniff.js", "dijit\/_base\/typematic.js", "dijit\/_base\/wai.js", "dijit\/_base\/window.js", "dijit\/_base.js", "dijit\/_editor\/RichText.js", "dijit\/_editor\/_Plugin.js", "dijit\/_editor\/html.js", "dijit\/_editor\/plugins\/AlwaysShowToolbar.js", "dijit\/_editor\/plugins\/EnterKeyHandling.js", "dijit\/_editor\/plugins\/FontChoice.js", "dijit\/_editor\/plugins\/FullScreen.js", "dijit\/_editor\/plugins\/LinkDialog.js", "dijit\/_editor\/plugins\/NewPage.js", "dijit\/_editor\/plugins\/Print.js", "dijit\/_editor\/plugins\/TabIndent.js", "dijit\/_editor\/plugins\/TextColor.js", "dijit\/_editor\/plugins\/ToggleDir.js", "dijit\/_editor\/plugins\/ViewSource.js", "dijit\/_editor\/range.js", "dijit\/_editor\/selection.js", "dijit\/_tree\/dndSource.js", "dijit\/dijit-all.js", "dijit\/dijit.js", "dijit\/focus.js", "dijit\/form\/Button.js", "dijit\/form\/CheckBox.js", "dijit\/form\/ComboBox.js", "dijit\/form\/ComboBoxMixin.js", "dijit\/form\/ComboButton.js", "dijit\/form\/CurrencyTextBox.js", "dijit\/form\/DataList.js", "dijit\/form\/DateTextBox.js", "dijit\/form\/DropDownButton.js", "dijit\/form\/FilteringSelect.js", "dijit\/form\/Form.js", "dijit\/form\/HorizontalRule.js", "dijit\/form\/HorizontalRuleLabels.js", "dijit\/form\/HorizontalSlider.js", "dijit\/form\/MappedTextBox.js", "dijit\/form\/MultiSelect.js", "dijit\/form\/NumberSpinner.js", "dijit\/form\/NumberTextBox.js", "dijit\/form\/RadioButton.js", "dijit\/form\/RangeBoundTextBox.js", "dijit\/form\/Select.js", "dijit\/form\/SimpleTextarea.js", "dijit\/form\/Slider.js", "dijit\/form\/TextBox.js", "dijit\/form\/Textarea.js", "dijit\/form\/TimeTextBox.js", "dijit\/form\/ToggleButton.js", "dijit\/form\/ValidationTextBox.js", "dijit\/form\/VerticalRule.js", "dijit\/form\/VerticalRuleLabels.js", "dijit\/form\/VerticalSlider.js", "dijit\/form\/_AutoCompleterMixin.js", "dijit\/form\/_ButtonMixin.js", "dijit\/form\/_CheckBoxMixin.js", "dijit\/form\/_ComboBoxMenu.js", "dijit\/form\/_ComboBoxMenuMixin.js", "dijit\/form\/_DateTimeTextBox.js", "dijit\/form\/_ExpandingTextAreaMixin.js", "dijit\/form\/_FormMixin.js", "dijit\/form\/_FormSelectWidget.js", "dijit\/form\/_FormValueMixin.js", "dijit\/form\/_FormWidget.js", "dijit\/form\/_FormWidgetMixin.js", "dijit\/form\/_ListBase.js", "dijit\/form\/_ListMouseMixin.js", "dijit\/form\/_RadioButtonMixin.js", "dijit\/form\/_Spinner.js", "dijit\/form\/_TextBoxMixin.js", "dijit\/form\/_ToggleButtonMixin.js", "dijit\/hccss.js", "dijit\/layout\/AccordionContainer.js", "dijit\/layout\/AccordionPane.js", "dijit\/layout\/BorderContainer.js", "dijit\/layout\/ContentPane.js", "dijit\/layout\/LayoutContainer.js", "dijit\/layout\/LinkPane.js", "dijit\/layout\/ScrollingTabController.js", "dijit\/layout\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dijit\/layout\/StackController.js", "dijit\/layout\/TabContainer.js", "dijit\/layout\/TabController.js", "dijit\/layout\/_ContentPaneResizeMixin.js", "dijit\/layout\/_LayoutWidget.js", "dijit\/layout\/_TabContainerBase.js", "dijit\/main.js", "dijit\/place.js", "dijit\/popup.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", "dijit\/typematic.js" ], "provides": [ "dijit.BackgroundIframe", "dijit.Calendar", "dijit.CalendarLite", "dijit.CheckedMenuItem", "dijit.ColorPalette", "dijit.Dialog", "dijit.DialogUnderlay", "dijit.DropDownMenu", "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._BidiSupport", "dijit._Calendar", "dijit._Contained", "dijit._Container", "dijit._CssStateMixin", "dijit._DialogMixin", "dijit._FocusMixin", "dijit._HasDropDown", "dijit._KeyNavContainer", "dijit._MenuBase", "dijit._OnDijitClickMixin", "dijit._PaletteMixin", "dijit._Templated", "dijit._TemplatedMixin", "dijit._TimePicker", "dijit._Widget", "dijit._WidgetBase", "dijit._WidgetsInTemplateMixin", "dijit._base.focus", "dijit._base.manager", "dijit._base.place", "dijit._base.popup", "dijit._base.scroll", "dijit._base.sniff", "dijit._base.typematic", "dijit._base.wai", "dijit._base.window", "dijit._base", "dijit._editor.RichText", "dijit._editor._Plugin", "dijit._editor.html", "dijit._editor.plugins.AlwaysShowToolbar", "dijit._editor.plugins.EnterKeyHandling", "dijit._editor.plugins.FontChoice", "dijit._editor.plugins.FullScreen", "dijit._editor.plugins.LinkDialog", "dijit._editor.plugins.NewPage", "dijit._editor.plugins.Print", "dijit._editor.plugins.TabIndent", "dijit._editor.plugins.TextColor", "dijit._editor.plugins.ToggleDir", "dijit._editor.plugins.ViewSource", "dijit._editor.range", "dijit._editor.selection", "dijit._tree.dndSource", "dijit.dijit-all", "dijit.dijit", "dijit.focus", "dijit.form.Button", "dijit.form.CheckBox", "dijit.form.ComboBox", "dijit.form.ComboBoxMixin", "dijit.form.ComboButton", "dijit.form.CurrencyTextBox", "dijit.form.DataList", "dijit.form.DateTextBox", "dijit.form.DropDownButton", "dijit.form.FilteringSelect", "dijit.form.Form", "dijit.form.HorizontalRule", "dijit.form.HorizontalRuleLabels", "dijit.form.HorizontalSlider", "dijit.form.MappedTextBox", "dijit.form.MultiSelect", "dijit.form.NumberSpinner", "dijit.form.NumberTextBox", "dijit.form.RadioButton", "dijit.form.RangeBoundTextBox", "dijit.form.Select", "dijit.form.SimpleTextarea", "dijit.form.Slider", "dijit.form.TextBox", "dijit.form.Textarea", "dijit.form.TimeTextBox", "dijit.form.ToggleButton", "dijit.form.ValidationTextBox", "dijit.form.VerticalRule", "dijit.form.VerticalRuleLabels", "dijit.form.VerticalSlider", "dijit.form._AutoCompleterMixin", "dijit.form._ButtonMixin", "dijit.form._CheckBoxMixin", "dijit.form._ComboBoxMenu", "dijit.form._ComboBoxMenuMixin", "dijit.form._DateTimeTextBox", "dijit.form._ExpandingTextAreaMixin", "dijit.form._FormMixin", "dijit.form._FormSelectWidget", "dijit.form._FormValueMixin", "dijit.form._FormWidget", "dijit.form._FormWidgetMixin", "dijit.form._ListBase", "dijit.form._ListMouseMixin", "dijit.form._RadioButtonMixin", "dijit.form._Spinner", "dijit.form._TextBoxMixin", "dijit.form._ToggleButtonMixin", "dijit.hccss", "dijit.layout.AccordionContainer", "dijit.layout.AccordionPane", "dijit.layout.BorderContainer", "dijit.layout.ContentPane", "dijit.layout.LayoutContainer", "dijit.layout.LinkPane", "dijit.layout.ScrollingTabController", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dijit.layout.StackController", "dijit.layout.TabContainer", "dijit.layout.TabController", "dijit.layout._ContentPaneResizeMixin", "dijit.layout._LayoutWidget", "dijit.layout._TabContainerBase", "dijit.main", "dijit.place", "dijit.popup", "dijit.robot", "dijit.robotx", "dijit.tree.ForestStoreModel", "dijit.tree.TreeStoreModel", "dijit.tree._dndContainer", "dijit.tree._dndSelector", "dijit.tree.dndSource", "dijit.typematic" ], "properties": [ { "name": "typematic", "resources": [ "dijit\/typematic.js" ], "provides": [ "dijit.typematic" ], "scope": "normal", "type": "Object", "summary": "These functions are used to repetitively call a user specified callback\nmethod when a specific key or mouse click over a specific DOM node is\nheld down for a specific amount of time.\nOnly 1 such event is allowed to occur on the browser page at 1 time." }, { "name": "tree", "resources": [ "dijit\/tree\/ForestStoreModel.js", "dijit\/tree\/TreeStoreModel.js", "dijit\/tree\/_dndContainer.js", "dijit\/tree\/_dndSelector.js", "dijit\/tree\/dndSource.js" ], "provides": [ "dijit.tree.ForestStoreModel", "dijit.tree.TreeStoreModel", "dijit.tree._dndContainer", "dijit.tree._dndSelector", "dijit.tree.dndSource" ], "scope": "normal", "type": "Object" }, { "name": "registry", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "scope": "normal", "type": "Object", "summary": "A list of widgets on a page." }, { "name": "range", "resources": [ "dijit\/_editor\/range.js" ], "provides": [ "dijit._editor.range" ], "scope": "normal", "type": "Object" }, { "name": "popup", "resources": [ "dijit\/popup.js" ], "provides": [ "dijit.popup" ], "scope": "normal", "type": "Object", "summary": "Used to show drop downs (ex: the select list of a ComboBox)\nor popups (ex: right-click context menus).\n\nAccess via require(["dijit\/popup"], function(popup){ ... })." }, { "name": "place", "resources": [ "dijit\/place.js" ], "provides": [ "dijit.place" ], "scope": "normal", "type": "Object", "summary": "Code to place a DOMNode relative to another DOMNode.\nLoad using require(["dijit\/place"], function(place){ ... })." }, { "name": "layout", "resources": [ "dijit\/layout\/AccordionContainer.js", "dijit\/layout\/AccordionPane.js", "dijit\/layout\/BorderContainer.js", "dijit\/layout\/ContentPane.js", "dijit\/layout\/LayoutContainer.js", "dijit\/layout\/LinkPane.js", "dijit\/layout\/ScrollingTabController.js", "dijit\/layout\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dijit\/layout\/StackController.js", "dijit\/layout\/TabContainer.js", "dijit\/layout\/TabController.js", "dijit\/layout\/_ContentPaneResizeMixin.js", "dijit\/layout\/_LayoutWidget.js", "dijit\/layout\/_TabContainerBase.js", "dijit\/resources\/_modules.js" ], "provides": [ "dijit.layout.AccordionContainer", "dijit.layout.AccordionPane", "dijit.layout.BorderContainer", "dijit.layout.ContentPane", "dijit.layout.LayoutContainer", "dijit.layout.LinkPane", "dijit.layout.ScrollingTabController", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dijit.layout.StackController", "dijit.layout.TabContainer", "dijit.layout.TabController", "dijit.layout._ContentPaneResizeMixin", "dijit.layout._LayoutWidget", "dijit.layout._TabContainerBase" ], "scope": "normal", "type": "Object", "summary": "Layout related widgets" }, { "name": "form", "resources": [ "dijit\/form\/Button.js", "dijit\/form\/CheckBox.js", "dijit\/form\/ComboBox.js", "dijit\/form\/ComboBoxMixin.js", "dijit\/form\/ComboButton.js", "dijit\/form\/CurrencyTextBox.js", "dijit\/form\/DataList.js", "dijit\/form\/DateTextBox.js", "dijit\/form\/DropDownButton.js", "dijit\/form\/FilteringSelect.js", "dijit\/form\/Form.js", "dijit\/form\/HorizontalRule.js", "dijit\/form\/HorizontalRuleLabels.js", "dijit\/form\/HorizontalSlider.js", "dijit\/form\/MappedTextBox.js", "dijit\/form\/MultiSelect.js", "dijit\/form\/NumberSpinner.js", "dijit\/form\/NumberTextBox.js", "dijit\/form\/RadioButton.js", "dijit\/form\/RangeBoundTextBox.js", "dijit\/form\/Select.js", "dijit\/form\/SimpleTextarea.js", "dijit\/form\/Slider.js", "dijit\/form\/TextBox.js", "dijit\/form\/Textarea.js", "dijit\/form\/TimeTextBox.js", "dijit\/form\/ToggleButton.js", "dijit\/form\/ValidationTextBox.js", "dijit\/form\/VerticalRule.js", "dijit\/form\/VerticalRuleLabels.js", "dijit\/form\/VerticalSlider.js", "dijit\/form\/_AutoCompleterMixin.js", "dijit\/form\/_ButtonMixin.js", "dijit\/form\/_CheckBoxMixin.js", "dijit\/form\/_ComboBoxMenu.js", "dijit\/form\/_ComboBoxMenuMixin.js", "dijit\/form\/_DateTimeTextBox.js", "dijit\/form\/_ExpandingTextAreaMixin.js", "dijit\/form\/_FormMixin.js", "dijit\/form\/_FormSelectWidget.js", "dijit\/form\/_FormValueMixin.js", "dijit\/form\/_FormWidget.js", "dijit\/form\/_FormWidgetMixin.js", "dijit\/form\/_ListBase.js", "dijit\/form\/_ListMouseMixin.js", "dijit\/form\/_RadioButtonMixin.js", "dijit\/form\/_Spinner.js", "dijit\/form\/_TextBoxMixin.js", "dijit\/form\/_ToggleButtonMixin.js", "dijit\/resources\/_modules.js" ], "provides": [ "dijit.form.Button", "dijit.form.CheckBox", "dijit.form.ComboBox", "dijit.form.ComboBoxMixin", "dijit.form.ComboButton", "dijit.form.CurrencyTextBox", "dijit.form.DataList", "dijit.form.DateTextBox", "dijit.form.DropDownButton", "dijit.form.FilteringSelect", "dijit.form.Form", "dijit.form.HorizontalRule", "dijit.form.HorizontalRuleLabels", "dijit.form.HorizontalSlider", "dijit.form.MappedTextBox", "dijit.form.MultiSelect", "dijit.form.NumberSpinner", "dijit.form.NumberTextBox", "dijit.form.RadioButton", "dijit.form.RangeBoundTextBox", "dijit.form.Select", "dijit.form.SimpleTextarea", "dijit.form.Slider", "dijit.form.TextBox", "dijit.form.Textarea", "dijit.form.TimeTextBox", "dijit.form.ToggleButton", "dijit.form.ValidationTextBox", "dijit.form.VerticalRule", "dijit.form.VerticalRuleLabels", "dijit.form.VerticalSlider", "dijit.form._AutoCompleterMixin", "dijit.form._ButtonMixin", "dijit.form._CheckBoxMixin", "dijit.form._ComboBoxMenu", "dijit.form._ComboBoxMenuMixin", "dijit.form._DateTimeTextBox", "dijit.form._ExpandingTextAreaMixin", "dijit.form._FormMixin", "dijit.form._FormSelectWidget", "dijit.form._FormValueMixin", "dijit.form._FormWidget", "dijit.form._FormWidgetMixin", "dijit.form._ListBase", "dijit.form._ListMouseMixin", "dijit.form._RadioButtonMixin", "dijit.form._Spinner", "dijit.form._TextBoxMixin", "dijit.form._ToggleButtonMixin" ], "scope": "normal", "type": "Object", "summary": "Form and input related widgets" }, { "name": "_tree", "resources": [ "dijit\/_tree\/dndSource.js" ], "provides": [ "dijit._tree.dndSource" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_editor", "resources": [ "dijit\/_editor\/RichText.js", "dijit\/_editor\/_Plugin.js", "dijit\/_editor\/html.js", "dijit\/_editor\/plugins\/AlwaysShowToolbar.js", "dijit\/_editor\/plugins\/EnterKeyHandling.js", "dijit\/_editor\/plugins\/FontChoice.js", "dijit\/_editor\/plugins\/FullScreen.js", "dijit\/_editor\/plugins\/LinkDialog.js", "dijit\/_editor\/plugins\/NewPage.js", "dijit\/_editor\/plugins\/Print.js", "dijit\/_editor\/plugins\/TabIndent.js", "dijit\/_editor\/plugins\/TextColor.js", "dijit\/_editor\/plugins\/ToggleDir.js", "dijit\/_editor\/plugins\/ViewSource.js", "dijit\/_editor\/range.js", "dijit\/_editor\/selection.js" ], "provides": [ "dijit._editor.RichText", "dijit._editor._Plugin", "dijit._editor.html", "dijit._editor.plugins.AlwaysShowToolbar", "dijit._editor.plugins.EnterKeyHandling", "dijit._editor.plugins.FontChoice", "dijit._editor.plugins.FullScreen", "dijit._editor.plugins.LinkDialog", "dijit._editor.plugins.NewPage", "dijit._editor.plugins.Print", "dijit._editor.plugins.TabIndent", "dijit._editor.plugins.TextColor", "dijit._editor.plugins.ToggleDir", "dijit._editor.plugins.ViewSource", "dijit._editor.range", "dijit._editor.selection" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_base", "resources": [ "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" ], "provides": [ "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" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_DialogLevelManager", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "normal", "type": "Object", "private": true, "summary": "Controls the various active "levels" on the page, starting with the\nstuff initially visible on the page (at z-index 0), and then having an entry for\neach Dialog shown." } ], "methods": [ { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "unregisterWin", "scope": "normal", "summary": "Unregisters listeners on the specified window (either the main\nwindow or an iframe's window) according to handle returned from registerWin().\nAfter calling be sure to delete or null out the handle itself.", "parameters": [ { "name": "handle", "type": "Handle", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "unregisterIframe", "scope": "normal", "summary": "Unregisters listeners on the specified iframe created by registerIframe.\nAfter calling be sure to delete or null out the handle itself.", "parameters": [ { "name": "handle", "type": "Object", "usage": "required", "summary": "Handle returned by registerIframe()" } ] }, { "resources": [ "dijit\/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", "summary": "|| dijit.__Rectangle" }, { "name": "position", "type": "String[]", "usage": "optional" }, { "name": "rtl", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "setWaiState", "scope": "normal", "summary": "Sets a state on an element.", "description": "Sets an attribute called \"aria-\"+state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" }, { "name": "value", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "setWaiRole", "scope": "normal", "summary": "Sets the role on an element.", "description": "Replace existing role attribute with new role.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/form\/_TextBoxMixin.js" ], "provides": [ "dijit.form._TextBoxMixin" ], "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" } ] }, { "resources": [ "dijit\/_base\/scroll.js" ], "provides": [ "dijit._base.scroll" ], "name": "scrollIntoView", "scope": "normal", "summary": "Scroll the passed node into view, if it is not already.\nDeprecated, use `dojo.window.scrollIntoView` instead.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "pos", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "removeWaiState", "scope": "normal", "summary": "Removes a state from an element.", "description": "Sets an attribute called \"aria-\"+state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "removeWaiRole", "scope": "normal", "summary": "Removes the specified role from an element.\nRemoves role attribute if no specific role provided (for backwards compat.)", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "registerWin", "scope": "normal", "summary": "Registers listeners on the specified window (either the main\nwindow or an iframe's window) to detect when the user has clicked somewhere\nor focused somewhere.", "description": "Users should call registerIframe() instead of this method.", "return-description": "Handle to pass to unregisterWin()", "parameters": [ { "name": "targetWindow", "type": "Window", "usage": "optional", "summary": "If specified this is the window associated with the iframe,\ni.e. iframe.contentWindow." }, { "name": "effectiveNode", "type": "DomNode", "usage": "optional", "summary": "If specified, report any focus events inside targetWindow as\nan event on effectiveNode, rather than on evt.target." } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "registerIframe", "scope": "normal", "summary": "Registers listeners on the specified iframe so that any click\nor focus event on that iframe (or anything in it) is reported\nas a focus\/click event on the <iframe> itself.", "description": "Currently only used by editor.", "return-description": "Handle to pass to unregisterIframe()", "parameters": [ { "name": "iframe", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/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.\nDeprecated, new code should use dijit.place.around() instead.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "aroundRect", "type": null, "usage": "required" }, { "name": "aroundCorners", "type": null, "usage": "required" }, { "name": "layoutNode", "type": null, "usage": "required" } ] }, { "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.\nDeprecated, new code should use dijit.place.around() instead.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "aroundNode", "type": null, "usage": "required" }, { "name": "aroundCorners", "type": null, "usage": "required" }, { "name": "layoutNode", "type": null, "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.\nDeprecated, new code should use dijit.place.around() instead.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "aroundElement", "type": null, "usage": "required" }, { "name": "aroundCorners", "type": null, "usage": "required" }, { "name": "layoutNode", "type": null, "usage": "required" }, { "name": "aroundNode", "type": null, "usage": "required" } ] }, { "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.\nDeprecated, new code should use dijit.place.at() instead.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "pos", "type": null, "usage": "required" }, { "name": "corners", "type": null, "usage": "required" }, { "name": "padding", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "moveToBookmark", "scope": "normal", "summary": "Moves current selection to a bookmark", "parameters": [ { "name": "bookmark", "type": "Object", "usage": "required", "summary": "This should be a returned object from dijit.getBookmark()" } ] }, { "resources": [ "dijit\/_base\/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\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "isCollapsed", "scope": "normal", "summary": "Returns true if there is no text selected" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "hideTooltip", "scope": "normal", "summary": "Hide the tooltip", "parameters": [ { "name": "aroundNode", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "hasWaiState", "scope": "normal", "summary": "Determines if an element has a given state.", "description": "Checks for an attribute called \"aria-\"+state.", "return-description": "true if elem has a value for the given state and\nfalse if it does not.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "hasWaiRole", "scope": "normal", "summary": "Determines if an element has a particular role.", "return-description": "True if elem has the specific role attribute and false if not.\nFor backwards compatibility if role parameter not provided,\nreturns true if has a role", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "role", "type": "String", "usage": "optional" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "hasDefaultTabStop", "scope": "normal", "summary": "Tests if element is tab-navigable even without an explicit tabIndex setting", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiState", "scope": "normal", "summary": "Gets the value of a state on an element.", "description": "Checks for an attribute called \"aria-\"+state.", "return-description": "The value of the requested state on elem\nor an empty string if elem has no value for state.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" }, { "name": "state", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/wai.js" ], "provides": [ "dijit._base.wai" ], "name": "getWaiRole", "scope": "normal", "summary": "Gets the role for an element (which should be a wai role).", "return-description": "The role of elem or an empty string if elem\ndoes not have a role.", "parameters": [ { "name": "elem", "type": "Element", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/place.js" ], "provides": [ "dijit._base.place" ], "name": "getViewport", "scope": "normal", "summary": "Deprecated method to return the dimensions and scroll position of the viewable area of a browser window.\nNew code should use dojo.window.getBox()" }, { "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\/place.js" ], "provides": [ "dijit._base.place" ], "name": "getPopupAroundAlignment", "scope": "normal", "summary": "Deprecated method, unneeded when using dijit\/place directly.\nTransforms the passed array of preferred positions into a format suitable for\npassing as the aroundCorners argument to dijit.placeOnScreenAroundElement.", "parameters": [ { "name": "position", "type": "Array", "usage": "required", "summary": "String[] This variable controls the position of the drop down.\nIt's an array of strings with the following values:\n\n* before: places drop down to the left of the target node\/widget, or to the right in\nthe case of RTL scripts like Hebrew and Arabic\n* after: places drop down to the right of the target node\/widget, or to the left in\nthe case of RTL scripts like Hebrew and Arabic\n* above: drop down goes above target node\n* below: drop down goes below target node\n\nThe list is positions is tried, in order, until a position is found where the drop down fits\nwithin the viewport." }, { "name": "leftToRight", "type": "Boolean", "usage": "required", "summary": "Whether the popup will be displaying in leftToRight mode." } ] }, { "resources": [ "dijit\/_base\/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\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "getFocus", "scope": "normal", "summary": "Called as getFocus(), this returns an Object showing the current focus\nand selected text.\n\nCalled as getFocus(widget), where widget is a (widget representing) a button\nthat was just pressed, it returns where focus was before that button\nwas pressed. (Pressing the button may have either shifted focus to the button,\nor removed focus altogether.) In this case the selected text is not returned,\nsince it can't be accurately determined.", "return-description": "A handle to restore focus\/selection, to be passed to `dijit.focus`", "parameters": [ { "name": "menu", "type": "Widget", "usage": "optional", "summary": "dijit._Widget or {domNode: DomNode} structure\nThe button that was just pressed. If focus has disappeared or moved\nto this button, returns the previous focus. In this case the bookmark\ninformation is already lost, and null is returned." }, { "name": "openedForWindow", "type": "Window", "usage": "optional", "summary": "iframe in which menu was opened" } ] }, { "resources": [ "dijit\/_base\/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", "dojox\/mobile\/common.js" ], "provides": [ "dijit._base.manager", "dojox.mobile.common" ], "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\/window.js" ], "provides": [ "dijit._base.window" ], "name": "getDocumentWindow", "scope": "normal", "parameters": [ { "name": "doc", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_base\/focus.js" ], "provides": [ "dijit._base.focus" ], "name": "getBookmark", "scope": "normal", "summary": "Retrieves a bookmark that can be used with moveToBookmark to return to the same range", "return-types": [ { "type": "Object." }, { "type": "Object" } ] }, { "resources": [ "dijit\/focus.js" ], "provides": [ "dijit.focus" ], "name": "focus", "scope": "normal", "summary": "Tracks the currently focused node, and which widgets are currently "active".\nAccess via require(["dijit\/focus"], function(focus){ ... }).\n\nA widget is considered active if it or a descendant widget has focus,\nor if a non-focusable node of this widget or a descendant was recently clicked.\n\nCall focus.watch("curNode", callback) to track the current focused DOMNode,\nor focus.watch("activeStack", callback) to track the currently focused stack of widgets.\n\nCall focus.on("widget-blur", func) or focus.on("widget-focus", ...) to monitor when\nwhen widgets become active\/inactive\n\nFinally, focus(node) will focus a node, suppressing errors if the node doesn't exist.", "parameters": [ { "name": "node", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "findWidgets", "scope": "normal", "summary": "Search subtree under root returning widgets found.\nDoesn't search for nested widgets (ie, widgets inside other widgets).", "parameters": [ { "name": "root", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byNode", "scope": "normal", "summary": "Returns the widget corresponding to the given DOMNode", "parameters": [ { "name": "node", "type": "DOMNode", "usage": "required" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byId", "scope": "normal", "summary": "Returns a widget by it's id, or if passed a widget, no-op (like dojo.byId())", "parameters": [ { "name": "id", "type": "String|dijit._Widget", "usage": "required" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_underlay", "scope": "normal", "private": true, "summary": "A shared instance of a `dijit.DialogUnderlay`", "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\/form\/TextBox.js", "dijit\/form\/_TextBoxMixin.js" ], "provides": [ "dijit.form.TextBox", "dijit.form._TextBoxMixin" ], "name": "_setSelectionRange", "scope": "normal", "private": true, "parameters": [ { "name": "element", "type": "DomNode", "usage": "required" }, { "name": "start", "type": "Number", "usage": "optional" }, { "name": "stop", "type": "Number", "usage": "optional" } ] }, { "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": "_getTabNavigable", "scope": "normal", "private": true, "summary": "Finds descendants of the specified root node.", "description": "Finds the following descendants of the specified root node:\n* the first tab-navigable element in document order\nwithout a tabIndex or with tabIndex=\"0\"\n* the last tab-navigable element in document order\nwithout a tabIndex or with tabIndex=\"0\"\n* the first element in document order with the lowest\npositive tabIndex value\n* the last element in document order with the highest\npositive tabIndex value", "parameters": [ { "name": "root", "type": "DOMNode", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "_destroyAll", "scope": "normal", "private": true, "summary": "Code to destroy all widgets and do other cleanup on page unload" }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "_connectToDomNode", "scope": "normal", "private": true, "summary": "If user connects to a widget method === this function, then they will\ninstead actually be connecting the equivalent event on this.domNode", "parameters": [ { "name": "event", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetsInTemplateMixin.js" ], "provides": [ "dijit._WidgetsInTemplateMixin" ], "name": "_WidgetsInTemplateMixin", "scope": "normal", "summary": "Mixin to supplement _TemplatedMixin when template contains widgets" }, { "resources": [ "dijit\/_FocusMixin.js", "dijit\/_Templated.js", "dijit\/_TemplatedMixin.js", "dijit\/_WidgetBase.js", "dijit\/layout\/BorderContainer.js", "dijit\/layout\/LayoutContainer.js", "dijit\/layout\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dojox\/mobile\/common.js", "dojox\/mobile\/i18n.js", "dojox\/mvc\/Group.js", "dojox\/mvc\/Output.js", "dojox\/mvc\/_Container.js" ], "provides": [ "dijit._FocusMixin", "dijit._Templated", "dijit._TemplatedMixin", "dijit._WidgetBase", "dijit.layout.BorderContainer", "dijit.layout.LayoutContainer", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dojox.mobile.common", "dojox.mobile.i18n", "dojox.mvc.Group", "dojox.mvc.Output", "dojox.mvc._Container" ], "name": "_WidgetBase", "scope": "normal", "private": true, "summary": "Future base class for all Dijit widgets.", "description": "Future base class for all Dijit widgets.\n_Widget extends this class adding support for various features needed by desktop.\n\nProvides stubs for widget lifecycle methods for subclasses to extend, like postMixInProperties(), buildRendering(),\npostCreate(), startup(), and destroy(), and also public API methods like set(), get(), and watch().\n\nWidgets can provide custom setters\/getters for widget attributes, which are called automatically by set(name, value).\nFor an attribute XXX, define methods _setXXXAttr() and\/or _getXXXAttr().\n\n_setXXXAttr can also be a string\/hash\/array mapping from a widget attribute XXX to the widget's DOMNodes:\n\n- DOM node attribute\n\t\t_setFocusAttr: {node: \"focusNode\", type: \"attribute\"}\n\t\t_setFocusAttr: \"focusNode\"\t(shorthand)\n\t\t_setFocusAttr: \"\"\t\t(shorthand, maps to this.domNode)\nMaps this.focus to this.focusNode.focus, or (last example) this.domNode.focus\n\n- DOM node innerHTML\n\t\t_setTitleAttr: { node: \"titleNode\", type: \"innerHTML\" }\nMaps this.title to this.titleNode.innerHTML\n\n- DOM node innerText\n\t\t_setTitleAttr: { node: \"titleNode\", type: \"innerText\" }\nMaps this.title to this.titleNode.innerText\n\n- DOM node CSS class\n\t\t_setMyClassAttr: { node: \"domNode\", type: \"class\" }\nMaps this.myClass to this.domNode.className\n\nIf the value of _setXXXAttr is an array, then each element in the array matches one of the\nformats of the above list.\n\nIf the custom setter is null, no action is performed other than saving the new value\nin the widget (in this).\n\nIf no custom setter is defined for an attribute, then it will be copied\nto this.focusNode (if the widget defines a focusNode), or this.domNode otherwise.\nThat's only done though for attributes that match DOMNode attributes (title,\nalt, aria-labelledby, etc.)", "parameters": [ { "name": "params", "type": "Object", "usage": "optional" }, { "name": "srcNodeRef", "type": "DomNode|String", "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js", "dojox\/form\/manager\/_Mixin.js", "dojox\/layout\/GridContainerLite.js", "dojox\/layout\/RadioGroup.js", "dojox\/layout\/TableContainer.js", "dojox\/layout\/ToggleSplitter.js", "dojox\/mdnd\/AreaManager.js" ], "provides": [ "dijit._Widget", "dojox.form.manager._Mixin", "dojox.layout.GridContainerLite", "dojox.layout.RadioGroup", "dojox.layout.TableContainer", "dojox.layout.ToggleSplitter", "dojox.mdnd.AreaManager" ], "name": "_Widget", "scope": "normal", "summary": "Base class for all Dijit widgets.\n\nExtends _WidgetBase, adding support for:\n- declaratively\/programatically specifying widget initialization parameters like\nonMouseMove="foo" that call foo when this.domNode gets a mousemove event\n- ondijitclick\nSupport new dojoAttachEvent="ondijitclick: ..." that is triggered by a mouse click or a SPACE\/ENTER keypress\n- focus related functions\nIn particular, the onFocus()\/onBlur() callbacks. Driven internally by\ndijit\/_base\/focus.js.\n- deprecated methods\n- onShow(), onHide(), onClose()\n\nAlso, by loading code in dijit\/_base, turns on:\n- browser sniffing (putting browser id like .dj_ie on <html> node)\n- high contrast mode sniffing (add .dijit_a11y class to <body> if machine is in high contrast mode)", "parameters": [ { "name": "params", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_TreeNode", "scope": "normal", "summary": "Single node within a tree. This class is used internally\nby Tree and should not be accessed directly." }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_TimePicker", "scope": "normal", "summary": "A graphical time picker.\nThis widget is used internally by other widgets and is not available\nas a standalone widget due to lack of accessibility support." }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "_TemplatedMixin", "scope": "normal", "summary": "Mixin for widgets that are instantiated from a template" }, { "resources": [ "dijit\/_Templated.js" ], "provides": [ "dijit._Templated" ], "name": "_Templated", "scope": "normal", "summary": "Deprecated mixin for widgets that are instantiated from a template.\nWidgets should use _TemplatedMixin plus if necessary _WidgetsInTemplateMixin instead." }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_PaletteMixin", "scope": "normal", "summary": "A keyboard accessible palette, for picking a color\/emoticon\/etc.", "description": "A mixin for a grid showing various entities, so the user can pick a certain entity." }, { "resources": [ "dijit\/_OnDijitClickMixin.js" ], "provides": [ "dijit._OnDijitClickMixin" ], "name": "_OnDijitClickMixin", "scope": "normal" }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_MenuBase", "scope": "normal", "summary": "Base class for Menu and MenuBar" }, { "resources": [ "dijit\/MenuBarItem.js" ], "provides": [ "dijit.MenuBarItem" ], "name": "_MenuBarItemMixin", "scope": "normal" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_MasterTooltip", "scope": "normal", "summary": "Internal widget that holds the actual tooltip markup,\nwhich occurs once per page.\nCalled by Tooltip widgets which are just containers to hold\nthe markup" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_KeyNavContainer", "scope": "normal", "summary": "A _Container with keyboard navigation of its children.", "description": "To use this mixin, call connectKeyNavHandlers() in\npostCreate().\nIt provides normalized keyboard and focusing code for Container\nwidgets." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_InlineEditor", "scope": "normal", "summary": "Internal widget used by InlineEditBox, displayed when in editing mode\nto display the editor and maybe save\/cancel buttons. Calling code should\nconnect to save\/cancel methods to detect when editing is finished\n\nHas mainly the same parameters as InlineEditBox, plus these values:\n\nstyle: Object\nSet of CSS attributes of display node, to replicate in editor\n\nvalue: String\nValue as an HTML string or plain text string, depending on renderAsHTML flag" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_HasDropDown", "scope": "normal", "summary": "Mixin for widgets that need drop down ability." }, { "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "name": "_FocusMixin", "scope": "normal", "summary": "Mixin to widget to provide _onFocus() and _onBlur() methods that\nfire when a widget or it's descendants get\/lose focus" }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "_DialogMixin", "scope": "normal", "summary": "This provides functions useful to Dialog and TooltipDialog" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_DialogBase", "scope": "normal", "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();" ] }, { "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "name": "_CssStateMixin", "scope": "normal", "summary": "Mixin for widgets to set CSS classes on the widget DOM nodes depending on hover\/mouse press\/focus\nstate changes, and also higher-level state changes such becoming disabled or selected.", "description": "By mixing this class into your widget, and setting the this.baseClass attribute, it will automatically\nmaintain CSS classes on the widget root node (this.domNode) depending on hover,\nactive, focus, etc. state. Ex: with a baseClass of dijitButton, it will apply the classes\ndijitButtonHovered and dijitButtonActive, as the user moves the mouse over the widget and clicks it.\n\nIt also sets CSS like dijitButtonDisabled based on widget semantic state.\n\nBy setting the cssStateNodes attribute, a widget can also track events on subnodes (like buttons\nwithin the widget)." }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "_Container", "scope": "normal", "summary": "Mixin for widgets that contain a set of widget children.", "description": "Use this mixin for widgets that needs to know about and\nkeep track of their widget children. Suitable for widgets like BorderContainer\nand TabContainer which contain (only) a set of child widgets.\n\nIt's not suitable for widgets like ContentPane\nwhich contains mixed HTML (plain DOM nodes in addition to widgets),\nand where contained widgets are not necessarily directly below\nthis.containerNode. In that case calls like addChild(node, position)\nwouldn't make sense." }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "_Contained", "scope": "normal", "summary": "Mixin for widgets that are children of a container widget", "examples": { "example": " \t\/\/ make a basic custom widget that knows about it's parents\n\tdojo.declare(\"my.customClass\",[dijit._Widget,dijit._Contained],{});" } }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "_Color", "scope": "normal", "summary": "Object associated with each cell in a ColorPalette palette.\nImplements dijit.Dye.", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": "Number", "usage": "required" }, { "name": "col", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "WidgetSet", "scope": "normal", "summary": "A set of widgets indexed by id. A default instance of this class is\navailable as `dijit.registry`", "examples": [ "Create a small list of widgets:\n\tvar ws = new dijit.WidgetSet();\n\tws.add(dijit.byId(\"one\"));\n \tws.add(dijit.byId(\"two\"));\n\t\/\/ destroy both:\n\tws.forEach(function(w){ w.destroy(); });", "Using dijit.registry:\n\tdijit.registry.forEach(function(w){ \/* do something *\/ });" ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "Tree", "scope": "normal", "summary": "This widget displays hierarchical data from a store." }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "TooltipDialog", "scope": "normal", "summary": "Pops up a dialog that appears like a Tooltip" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "Tooltip", "scope": "normal", "summary": "Pops up a tooltip (a help message) when you hover over a node." }, { "resources": [ "dijit\/ToolbarSeparator.js" ], "provides": [ "dijit.ToolbarSeparator" ], "name": "ToolbarSeparator", "scope": "normal", "summary": "A spacer between two `dijit.Toolbar` items" }, { "resources": [ "dijit\/Toolbar.js" ], "provides": [ "dijit.Toolbar" ], "name": "Toolbar", "scope": "normal", "summary": "A Toolbar widget, used to hold things like `dijit.Editor` buttons" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "TitlePane", "scope": "normal", "summary": "A pane with a title on top, that can be expanded or collapsed.", "description": "An accessible container with a title Heading, and a content\nsection that slides open and closed. TitlePane is an extension to\n`dijit.layout.ContentPane`, providing all the useful content-control aspects from it.", "examples": [ " \t\/\/ load a TitlePane from remote file:\n\tvar foo = new dijit.TitlePane({ href: \"foobar.html\", title:\"Title\" });\n\tfoo.startup();", "\t\n\t
<\/div>", "\t\n \t
\n\t\t

I am content<\/p>\n\t<\/div>" ] }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "ProgressBar", "scope": "normal", "summary": "A progress indication widget, showing the amount completed\n(often the percentage completed) of a task.", "examples": { "example": "\t

\n\t<\/div>" } }, { "resources": [ "dijit\/PopupMenuItem.js" ], "provides": [ "dijit.PopupMenuItem" ], "name": "PopupMenuItem", "scope": "normal", "summary": "An item in a Menu that spawn a drop down (usually a drop down menu)" }, { "resources": [ "dijit\/PopupMenuBarItem.js" ], "provides": [ "dijit.PopupMenuBarItem" ], "name": "PopupMenuBarItem", "scope": "normal", "summary": "Item in a MenuBar like "File" or "Edit", that spawns a submenu when pressed (or hovered)" }, { "resources": [ "dijit\/MenuSeparator.js" ], "provides": [ "dijit.MenuSeparator" ], "name": "MenuSeparator", "scope": "normal", "summary": "A line between two menu items" }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "MenuItem", "scope": "normal", "summary": "A line item in a Menu Widget" }, { "resources": [ "dijit\/MenuBarItem.js" ], "provides": [ "dijit.MenuBarItem" ], "name": "MenuBarItem", "scope": "normal", "summary": "Item in a MenuBar that's clickable, and doesn't spawn a submenu when pressed (or hovered)" }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "MenuBar", "scope": "normal", "summary": "A menu bar, listing menu choices horizontally, like the "File" menu in most desktop applications" }, { "resources": [ "dijit\/Menu.js", "dojox\/widget\/PlaceholderMenuItem.js" ], "provides": [ "dijit.Menu", "dojox.widget.PlaceholderMenuItem" ], "name": "Menu", "scope": "normal", "summary": "A context menu you can assign to multiple elements" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "InlineEditBox", "scope": "normal", "summary": "An element with in-line edit capabilities", "description": "Behavior for an existing node (`

`, `

`, ``, etc.) so that\nwhen you click it, an editor shows up in place of the original\ntext. Optionally, Save and Cancel button are displayed below the edit widget.\nWhen Save is clicked, the text is pulled from the edit\nwidget and redisplayed and the edit widget is again hidden.\nBy default a plain Textarea widget is used as the editor (or for\ninline values a TextBox), but you can specify an editor such as\ndijit.Editor (for editing HTML) or a Slider (for adjusting a number).\nAn edit widget must support the following API to be used:\n- displayedValue or value as initialization parameter,\nand available through set('displayedValue') \/ set('value')\n- void focus()\n- DOM-node focusNode = node containing editable text" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "Editor", "scope": "normal", "summary": "A rich text Editing widget", "description": "This widget provides basic WYSIWYG editing features, based on the browser's\nunderlying rich text editing capability, accompanied by a toolbar (`dijit.Toolbar`).\nA plugin model is available to extend the editor's capabilities as well as the\nthe options available in the toolbar. Content generation may vary across\nbrowsers, and clipboard operations may have different results, to name\na few limitations. Note: this widget should not be used with the HTML\n<TEXTAREA> tag -- see dijit._editor.RichText for details." }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "Dye", "scope": "normal", "summary": "Interface for the JS Object associated with a palette cell (i.e. DOMNode)", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": null, "usage": "required" }, { "name": "col", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/DropDownMenu.js" ], "provides": [ "dijit.DropDownMenu" ], "name": "DropDownMenu", "scope": "normal", "summary": "A menu, without features for context menu (Meaning, drop down menu)" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "DialogUnderlay", "scope": "normal", "summary": "The component that blocks the screen behind a `dijit.Dialog`", "description": "A component used to block input behind a `dijit.Dialog`. Only a single\ninstance of this widget is created by `dijit.Dialog`, and saved as\na reference to be shared between all Dialogs as `dijit._underlay`\n\nThe underlay itself can be styled based on and id:\n\t#myDialog_underlay { background-color:red; }\n\nIn the case of `dijit.Dialog`, this id is based on the id of the Dialog,\nsuffixed with _underlay." }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "Dialog", "scope": "normal" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "ColorPalette", "scope": "normal", "summary": "A keyboard accessible color-picking widget", "description": "Grid showing various colors, so the user can pick a certain color.\nCan be used standalone, or as a popup.", "examples": [ "\t
<\/div>", "\tvar picker = new dijit.ColorPalette({ },srcNode);\n\tpicker.startup();" ] }, { "resources": [ "dijit\/CheckedMenuItem.js" ], "provides": [ "dijit.CheckedMenuItem" ], "name": "CheckedMenuItem", "scope": "normal", "summary": "A checkbox-like menu item for toggling on and off" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "CalendarLite", "scope": "normal", "summary": "Lightweight version of Calendar widget aimed towards mobile use", "description": "A simple GUI for choosing a date in the context of a monthly calendar.\nThis widget can't be used in a form because it doesn't serialize the date to an\n`` field. For a form element, use dijit.form.DateTextBox instead.\n\nNote that the parser takes all dates attributes passed in the\n[RFC 3339 format](http:\/\/www.faqs.org\/rfcs\/rfc3339.html), e.g. `2005-06-30T08:05:00-07:00`\nso that they are serializable and locale-independent.\n\nAlso note that this widget isn't keyboard accessible; use dijit.Calendar for that", "examples": [ "\tvar calendar = new dijit.CalendarLite({}, dojo.byId(\"calendarNode\"));", "\t
<\/div>" ], "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "Calendar", "scope": "normal", "summary": "A simple GUI for choosing a date in the context of a monthly calendar.", "description": "See CalendarLite for general description. Calendar extends CalendarLite, adding:\n- month drop down list\n- keyboard navigation\n- CSS classes for hover\/mousepress on date, month, and year nodes\n- support of deprecated methods (will be removed in 2.0)" }, { "resources": [ "dijit\/BackgroundIframe.js" ], "provides": [ "dijit.BackgroundIframe" ], "name": "BackgroundIframe", "scope": "normal", "summary": "For IE\/FF z-index schenanigans. id attribute is required.", "description": "new dijit.BackgroundIframe(node)\nMakes a background iframe as a child of node, that fills\narea (and position) of node", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] } ] }, "dijit.BackgroundIframe": { "location": "dijit.BackgroundIframe", "resources": [ "dijit\/BackgroundIframe.js" ], "provides": [ "dijit.BackgroundIframe" ], "type": "Function", "classlike": true, "summary": "For IE\/FF z-index schenanigans. id attribute is required.", "description": "new dijit.BackgroundIframe(node)\nMakes a background iframe as a child of node, that fills\narea (and position) of node", "methods": [ { "constructor": "constructor", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/BackgroundIframe.js" ], "provides": [ "dijit.BackgroundIframe" ], "name": "resize", "scope": "prototype", "summary": "Resize the iframe so it's the same size as node.\nNeeded on IE6 and IE\/quirks because height:100% doesn't work right.", "parameters": [ { "name": "node", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/BackgroundIframe.js" ], "provides": [ "dijit.BackgroundIframe" ], "name": "destroy", "scope": "prototype", "summary": "destroy the iframe" } ] }, "dijit.BackgroundIframe.destroy": { "location": "dijit.BackgroundIframe.destroy", "resources": [ "dijit\/BackgroundIframe.js" ], "provides": [ "dijit.BackgroundIframe" ], "type": "Function", "classlike": true, "summary": "destroy the iframe", "methods": [ { "constructor": "constructor" } ] }, "dijit.Calendar": { "location": "dijit.Calendar", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "type": "Function", "classlike": true, "superclass": "dijit.CalendarLite", "summary": "A simple GUI for choosing a date in the context of a monthly calendar.", "description": "See CalendarLite for general description. Calendar extends CalendarLite, adding:\n- month drop down list\n- keyboard navigation\n- CSS classes for hover\/mousepress on date, month, and year nodes\n- support of deprecated methods (will be removed in 2.0)", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.CalendarLite" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "cssStateNodes", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "setValue", "scope": "prototype", "summary": "Deprecated. Use set('value', ...) instead.", "parameters": [ { "name": "value", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onValueSelected", "scope": "prototype", "summary": "Deprecated. Notification that a date cell was selected. It may be the same as the previous value.", "description": "Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)\nto get notification when the user has clicked a date. Now onExecute() (above) is used.", "parameters": [ { "name": "date", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onChange", "scope": "prototype", "parameters": [ { "name": "value", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "handleKey", "scope": "prototype", "summary": "Provides keyboard navigation of calendar.", "description": "Called from _onKeyPress() to handle keypress on a stand alone Calendar,\nand also from `dijit.form._DateTimeTextBox` to pass a keypress event\nfrom the `dijit.form.DateTextBox` to be handled in this widget", "return-description": "False if the key was recognized as a navigation key,\nto indicate that the event was handled by Calendar and shouldn't be propogated", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "getClassForDate", "scope": "prototype", "tags": "extension", "summary": "May be overridden to return CSS classes to associate with the date entry for the given dateObject,\nfor example to indicate a holiday in specified locale.", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onKeyPress", "scope": "prototype", "private": true, "summary": "For handling keypress events on a stand alone calendar", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseUp", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseOver", "scope": "prototype", "summary": "Handler for mouse over events on days, sets hovered style", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseOut", "scope": "prototype", "summary": "Handler for mouse out events on days, clears hovered style", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onDayMouseDown", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_createMonthWidget", "scope": "prototype", "private": true, "summary": "Creates the drop down button that displays the current month and lets user pick a new one" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_MonthDropDownButton", "scope": "normal", "summary": "DropDownButton for the current month. Displays name of current month\nand a list of month names in the drop down" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_MonthDropDown", "scope": "normal", "summary": "The list-of-months drop down from the MonthDropDownButton" } ] }, "dijit.Calendar.cssStateNodes": { "location": "dijit.Calendar.cssStateNodes", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ] }, "dijit.Calendar._MonthDropDownButton": { "location": "dijit.Calendar._MonthDropDownButton", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "type": "Function", "classlike": true, "superclass": "dijit.form.DropDownButton", "summary": "DropDownButton for the current month. Displays name of current month\nand a list of month names in the drop down", "mixins": { "instance": [ { "scope": "instance", "location": "dijit.form.DropDownButton" } ] }, "properties": [ { "name": "containerNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onMonthSelect", "scope": "prototype" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setMonthAttr", "scope": "prototype", "private": true, "summary": "Set the current month to display as a label", "parameters": [ { "name": "month", "type": null, "usage": "required" } ] } ] }, "dijit.Calendar._MonthDropDownButton.containerNode": { "location": "dijit.Calendar._MonthDropDownButton.containerNode", "type": null }, "dijit.Calendar._MonthDropDown": { "location": "dijit.Calendar._MonthDropDown", "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "The list-of-months drop down from the MonthDropDownButton", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "properties": [ { "name": "domNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "onChange", "scope": "prototype", "summary": "Callback when month is selected from drop down", "parameters": [ { "name": "month", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_setMonthsAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "months", "type": "String[]", "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onMenuHover", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Calendar.js" ], "provides": [ "dijit.Calendar" ], "name": "_onClick", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] } ] }, "dijit.Calendar._MonthDropDown.domNode": { "location": "dijit.Calendar._MonthDropDown.domNode", "type": null }, "dijit.CalendarLite": { "location": "dijit.CalendarLite", "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "type": "Function", "classlike": true, "superclass": "dijit._WidgetBase", "summary": "Lightweight version of Calendar widget aimed towards mobile use", "description": "A simple GUI for choosing a date in the context of a monthly calendar.\nThis widget can't be used in a form because it doesn't serialize the date to an\n`` field. For a form element, use dijit.form.DateTextBox instead.\n\nNote that the parser takes all dates attributes passed in the\n[RFC 3339 format](http:\/\/www.faqs.org\/rfcs\/rfc3339.html), e.g. `2005-06-30T08:05:00-07:00`\nso that they are serializable and locale-independent.\n\nAlso note that this widget isn't keyboard accessible; use dijit.Calendar for that", "examples": [ "\tvar calendar = new dijit.CalendarLite({}, dojo.byId(\"calendarNode\"));", "\t
<\/div>" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._WidgetBase" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "methods": [ { "constructor": "constructor", "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "onChange", "scope": "prototype", "summary": "Called only when the selected date has changed", "parameters": [ { "name": "date", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "isDisabledDate", "scope": "prototype", "tags": "extension", "summary": "May be overridden to disable certain dates in the calendar e.g. `isDisabledDate=dojo.date.locale.isWeekend`", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "goToToday", "scope": "prototype", "summary": "Sets calendar's value to today's date" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "getClassForDate", "scope": "prototype", "tags": "extension", "summary": "May be overridden to return CSS classes to associate with the date entry for the given dateObject,\nfor example to indicate a holiday in specified locale.", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "focus", "scope": "prototype", "summary": "Focus the calendar by focusing one of the calendar cells" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "constructor", "scope": "prototype", "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_setValueAttr", "scope": "prototype", "summary": "Support set("value", ...)", "description": "Set the current date and update the UI. If the date is disabled, the value will\nnot change, but the display will change to the corresponding month.", "parameters": [ { "name": "value", "type": "Date|Number", "usage": "required", "summary": "Either a Date or the number of seconds since 1970." }, { "name": "priorityChange", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_setText", "scope": "prototype", "private": true, "summary": "This just sets the content of node to the specified text.\nCan't do "node.innerHTML=text" because of an IE bug w\/tables, see #3434.", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "text", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_setCurrentFocusAttr", "scope": "prototype", "private": true, "summary": "If the calendar currently has focus, then focuses specified date,\nchanging the currently displayed month\/year if necessary.\nIf the calendar doesn't have focus, updates currently\ndisplayed month\/year, and sets the cell that will get focus.", "parameters": [ { "name": "date", "type": "Date", "usage": "required" }, { "name": "forceFocus", "type": "Boolean", "usage": "required", "summary": "If true, will focus() the cell even if calendar itself doesn't have focus" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_populateGrid", "scope": "prototype", "private": true, "summary": "Fills in the calendar grid with each day (1-31)" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_onMonthSelect", "scope": "prototype", "summary": "Handler for when user selects a month from the drop down list", "parameters": [ { "name": "newMonth", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_onDayClick", "scope": "prototype", "summary": "Handler for day clicks, selects the date if appropriate", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_isValidDate", "scope": "prototype", "private": true, "summary": "Runs various tests on the value, checking that it's a valid date, rather\nthan blank or NaN.", "parameters": [ { "name": "value", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_isSelectedDate", "scope": "prototype", "tags": "extension", "summary": "Extension point so developers can subclass Calendar to\nsupport multiple (concurrently) selected dates", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ] }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_getValueAttr", "scope": "prototype", "private": true, "summary": "Support get('value')" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_createMonthWidget", "scope": "prototype", "private": true, "summary": "Creates the drop down button that displays the current month and lets user pick a new one" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_MonthWidget", "scope": "normal", "summary": "Displays name of current month padded to the width of the month\nw\/the longest name, so that changing months doesn't change width.\n\nCreate as new dijit.Calendar._MonthWidget({\nlang: ...,\ndateLocaleModule: ...\n})" } ] }, "dijit.CalendarLite._MonthWidget": { "location": "dijit.CalendarLite._MonthWidget", "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "type": "Function", "classlike": true, "superclass": "dijit._WidgetBase", "summary": "Displays name of current month padded to the width of the month\nw\/the longest name, so that changing months doesn't change width.\n\nCreate as new dijit.Calendar._MonthWidget({\nlang: ...,\ndateLocaleModule: ...\n})", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._WidgetBase" } ] }, "properties": [ { "name": "domNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/CalendarLite.js" ], "provides": [ "dijit.CalendarLite" ], "name": "_setMonthAttr", "scope": "prototype", "private": true, "summary": "Set the current month to display as a label", "parameters": [ { "name": "month", "type": null, "usage": "required" } ] } ] }, "dijit.CalendarLite._MonthWidget.domNode": { "location": "dijit.CalendarLite._MonthWidget.domNode", "type": null }, "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" } ] }, "methods": [ { "constructor": "constructor" }, { "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": "_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": "_onClick", "scope": "prototype", "private": true, "summary": "Clicking this item just toggles its state", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] } ] }, "dijit.ColorPalette": { "location": "dijit.ColorPalette", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A keyboard accessible color-picking widget", "description": "Grid showing various colors, so the user can pick a certain color.\nCan be used standalone, or as a popup.", "examples": [ "\t
<\/div>", "\tvar picker = new dijit.ColorPalette({ },srcNode);\n\tpicker.startup();" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._PaletteMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._PaletteMixin" } ] }, "properties": [ { "name": "_palettes", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Map", "summary": "This represents the value of the colors.\nThe first level is a hashmap of the different palettes available.\nThe next two dimensions represent the columns and rows of colors." } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "buildRendering", "scope": "prototype" } ] }, "dijit.ColorPalette._palettes": { "location": "dijit.ColorPalette._palettes", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Map", "summary": "This represents the value of the colors.\nThe first level is a hashmap of the different palettes available.\nThe next two dimensions represent the columns and rows of colors." }, "dijit._Color": { "location": "dijit._Color", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Function", "classlike": true, "superclass": "dojo.Color", "summary": "Object associated with each cell in a ColorPalette palette.\nImplements dijit.Dye.", "mixins": { "instance": [ { "scope": "instance", "location": "dojo.Color" } ] }, "properties": [ { "name": "_imagePaths", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "scope": "prototype", "type": "Map", "summary": "This is stores the path to the palette images used for high-contrast mode display" } ], "methods": [ { "constructor": "constructor", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": "Number", "usage": "required" }, { "name": "col", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "getValue", "scope": "prototype", "summary": "Note that although dijit._Color is initialized with a value like "white" getValue() always\nreturns a hex value" }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "fillCell", "scope": "prototype", "parameters": [ { "name": "cell", "type": "DOMNode", "usage": "required" }, { "name": "blankGif", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "name": "constructor", "scope": "prototype", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": "Number", "usage": "required" }, { "name": "col", "type": "Number", "usage": "required" } ] } ] }, "dijit._Color._imagePaths": { "location": "dijit._Color._imagePaths", "resources": [ "dijit\/ColorPalette.js" ], "provides": [ "dijit.ColorPalette" ], "type": "Map", "summary": "This is stores the path to the palette images used for high-contrast mode display" }, "dijit._DialogBase": { "location": "dijit._DialogBase", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "type": "Function", "classlike": true, "superclass": "dijit._TemplatedMixin", "summary": "A modal dialog Widget", "description": "Pops up a modal dialog window, blocking access to the screen\nand also graying out the screen Dialog is extended from\nContentPane so it supports all the same parameters (href, etc.)", "examples": [ "\t
<\/div>", "\tvar foo = new dijit.Dialog({ title: \"test dialog\", content: \"test content\" };\n\tdojo.body().appendChild(foo.domNode);\n\tfoo.startup();" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit.form._FormMixin.prototype" }, { "scope": "prototype", "location": "dijit._DialogMixin.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit.form._FormMixin" }, { "scope": "instance", "location": "dijit._DialogMixin" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "cssStateNodes", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "show", "scope": "prototype", "summary": "Display the dialog", "return-description": "dojo.Deferred\nDeferred object that resolves when the display animation is complete" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "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`)\nbut should *not* be overridden." }, { "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": "hide", "scope": "prototype", "summary": "Hide the dialog", "return-description": "dojo.Deferred\nDeferred object that resolves when the hide animation is complete" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_size", "scope": "prototype", "private": true, "summary": "If necessary, shrink dialog contents so dialog fits in viewport" }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "_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": "_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": "_endDrag", "scope": "prototype", "private": true, "summary": "Called after dragging the Dialog. Saves the position of the dialog in the viewport,\nand also adjust position to be fully within the viewport, so user doesn't lose access to handle" } ] }, "dijit._DialogBase.cssStateNodes": { "location": "dijit._DialogBase.cssStateNodes", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ] }, "dijit._DialogBase._singleChild.domNode.style": { "location": "dijit._DialogBase._singleChild.domNode.style", "type": null }, "dijit.Dialog": { "location": "dijit.Dialog", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "type": "Function", "classlike": true, "superclass": "dijit.layout.ContentPane", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._DialogBase.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.layout.ContentPane" }, { "scope": "instance", "location": "dijit._DialogBase" } ] }, "methods": [ { "constructor": "constructor" } ] }, "dijit._DialogLevelManager": { "location": "dijit._DialogLevelManager", "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "private": true, "summary": "Controls the various active "levels" on the page, starting with the\nstuff initially visible on the page (at z-index 0), and then having an entry for\neach Dialog shown.", "methods": [ { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "show", "scope": "normal", "summary": "Call right before fade-in animation for new dialog.\nSaves current focus, displays\/adjusts underlay for new dialog,\nand sets the z-index of the dialog itself.\n\nNew dialog will be displayed on top of all currently displayed dialogs.\n\nCaller is responsible for setting focus in new dialog after the fade-in\nanimation completes.", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" }, { "name": "underlayAttrs", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "isTop", "scope": "normal", "summary": "Returns true if specified Dialog is the top in the task", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Dialog.js" ], "provides": [ "dijit.Dialog" ], "name": "hide", "scope": "normal", "summary": "Called when the specified dialog is hidden\/destroyed, after the fade-out\nanimation ends, in order to reset page focus, fix the underlay, etc.\nIf the specified dialog isn't open then does nothing.\n\nCaller is responsible for either setting display:none on the dialog domNode,\nor calling dijit.popup.hide(), or removing it from the page DOM.", "parameters": [ { "name": "dialog", "type": "dijit._Widget", "usage": "required" } ] } ] }, "dijit.DialogUnderlay": { "location": "dijit.DialogUnderlay", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "The component that blocks the screen behind a `dijit.Dialog`", "description": "A component used to block input behind a `dijit.Dialog`. Only a single\ninstance of this widget is created by `dijit.Dialog`, and saved as\na reference to be shared between all Dialogs as `dijit._underlay`\n\nThe underlay itself can be styled based on and id:\n\t#myDialog_underlay { background-color:red; }\n\nIn the case of `dijit.Dialog`, this id is based on the id of the Dialog,\nsuffixed with _underlay.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "properties": [ { "name": "node", "scope": "normal", "type": null }, { "name": "domNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "show", "scope": "prototype", "summary": "Show the dialog underlay" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "postCreate", "scope": "prototype", "summary": "Append the underlay to the body" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "layout", "scope": "prototype", "private": true, "summary": "Sets the background to the size of the viewport", "description": "Sets the background to the size of the viewport (rather than the size\nof the document) since we need to cover the whole browser window, even\nif the document is only a few lines long." }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "hide", "scope": "prototype", "summary": "Hides the dialog underlay" }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "_setDialogIdAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "id", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "name": "_setClassAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "clazz", "type": null, "usage": "required" } ] } ] }, "dijit.DialogUnderlay.node": { "location": "dijit.DialogUnderlay.node", "type": null, "properties": [ { "name": "style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": null } ] }, "dijit.DialogUnderlay.domNode": { "location": "dijit.DialogUnderlay.domNode", "type": null, "properties": [ { "name": "style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "scope": "prototype", "type": null } ] }, "dijit.DialogUnderlay.domNode.style": { "location": "dijit.DialogUnderlay.domNode.style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": null }, "dijit.DialogUnderlay.node.style": { "location": "dijit.DialogUnderlay.node.style", "resources": [ "dijit\/DialogUnderlay.js" ], "provides": [ "dijit.DialogUnderlay" ], "type": null }, "dijit.DropDownMenu": { "location": "dijit.DropDownMenu", "resources": [ "dijit\/DropDownMenu.js" ], "provides": [ "dijit.DropDownMenu" ], "type": "Function", "classlike": true, "superclass": "dijit._MenuBase", "summary": "A menu, without features for context menu (Meaning, drop down menu)", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._OnDijitClickMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._MenuBase" }, { "scope": "instance", "location": "dijit._OnDijitClickMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/DropDownMenu.js" ], "provides": [ "dijit.DropDownMenu" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/DropDownMenu.js" ], "provides": [ "dijit.DropDownMenu" ], "name": "_onKeyPress", "scope": "prototype", "summary": "Handle keyboard based menu navigation.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] } ] }, "dijit.Editor": { "location": "dijit.Editor", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "type": "Function", "classlike": true, "superclass": "dijit._editor.RichText", "summary": "A rich text Editing widget", "description": "This widget provides basic WYSIWYG editing features, based on the browser's\nunderlying rich text editing capability, accompanied by a toolbar (`dijit.Toolbar`).\nA plugin model is available to extend the editor's capabilities as well as the\nthe options available in the toolbar. Content generation may vary across\nbrowsers, and clipboard operations may have different results, to name\na few limitations. Note: this widget should not be used with the HTML\n<TEXTAREA> tag -- see dijit._editor.RichText for details.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._editor.RichText" } ] }, "properties": [ { "name": "document", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "undo", "scope": "prototype", "tags": "console.log('undo');", "private": true, "summary": "Handler for editor undo (ex: ctrl-z) operation" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "startup", "scope": "prototype", "tags": "console.log('startup',arguments);", "summary": "Exists to make Editor work as a child of a layout widget.\nDevelopers don't need to call this method." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "resize", "scope": "prototype", "summary": "Resize the editor to the specified size, see `dijit.layout._LayoutWidget.resize`", "parameters": [ { "name": "size", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "replaceValue", "scope": "prototype", "summary": "over-ride of replaceValue to support custom undo and stack maintainence.", "parameters": [ { "name": "html", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "redo", "scope": "prototype", "tags": "console.log('redo');", "private": true, "summary": "Handler for editor redo (ex: ctrl-y) operation" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "queryCommandEnabled", "scope": "prototype", "summary": "Returns true if specified editor command is enabled.\nUsed by the plugins to know when to highlight\/not highlight buttons.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "postMixInProperties", "scope": "prototype", "summary": "Extension to make sure a deferred is in place before certain functions\nexecute, like making sure all the plugins are properly inserted." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onKeyDown", "scope": "prototype", "private": true, "summary": "Handler for onkeydown event.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onClick", "scope": "prototype", "summary": "Handler for when editor is clicked" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onBeforeDeactivate", "scope": "prototype", "private": true, "summary": "Called on IE right before focus is lost. Saves the selected range.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "onBeforeActivate", "scope": "prototype", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "layout", "scope": "prototype", "summary": "Called from `dijit.layout._LayoutWidget.resize`. This shouldn't be called directly" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "execCommand", "scope": "prototype", "summary": "Main handler for executing any commands to the editor, like paste, bold, etc.\nCalled by plugins, but not meant to be called by end users.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "endEditing", "scope": "prototype", "private": true, "summary": "Called to note that the user has stopped typing alphanumeric characters, if it's not already noted.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "ignore_caret", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "constructor", "scope": "prototype", "private": true, "summary": "Runs on widget initialization to setup arrays etc." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "beginEditing", "scope": "prototype", "private": true, "summary": "Called to note that the user has started typing alphanumeric characters, if it's not already noted.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "addPlugin", "scope": "prototype", "summary": "takes a plugin name as a string or a plugin instance and\nadds it to the toolbar and associates it with this editor\ninstance. The resulting plugin is added to the Editor's\nplugins array. If index is passed, it's placed in the plugins\narray at that index. No big magic, but a nice helper for\npassing in plugin names via markup.", "parameters": [ { "name": "plugin", "type": "String||Object", "usage": "required", "summary": "String, args object or plugin instance\n\nargs:\nThis object will be passed to the plugin constructor" }, { "name": "index", "type": "Integer", "usage": "optional", "summary": "Used when creating an instance from\nsomething already in this.plugins. Ensures that the new\ninstance is assigned to this.plugins at that index." } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_setStateClass", "scope": "prototype", "private": true }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "value", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_saveSelection", "scope": "prototype", "private": true, "summary": "Save the currently selected text in _savedSelection attribute" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_restoreSelection", "scope": "prototype", "private": true, "summary": "Re-select the text specified in _savedSelection attribute;\nsee _saveSelection()." }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_pasteImpl", "scope": "prototype", "tags": "Protected", "private": true, "summary": "Over-ride of paste command control to make execCommand cleaner" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_onIEMouseDown", "scope": "prototype", "private": true, "summary": "IE only to prevent 2 clicks to focus", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_onBlur", "scope": "prototype", "summary": "Called from focus manager when focus has moved away from this editor" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_moveToBookmark", "scope": "prototype", "private": true, "summary": "Selects the text specified in bookmark b", "parameters": [ { "name": "b", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_getBookmark", "scope": "prototype", "summary": "Get the currently selected text" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_endEditing", "scope": "prototype", "tags": "Avoid filtering to make sure selections restore.", "private": true, "summary": "Called when the user stops typing alphanumeric characters.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "ignore_caret", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_cutImpl", "scope": "prototype", "tags": "Protected", "private": true, "summary": "Over-ride of cut command control to make execCommand cleaner" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_copyImpl", "scope": "prototype", "tags": "Protected", "private": true, "summary": "Over-ride of copy command control to make execCommand cleaner" }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_clipboardCommand", "scope": "prototype", "tags": "Private", "private": true, "summary": "Function to handle processing clipboard commands (or at least try to).", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_changeToStep", "scope": "prototype", "private": true, "summary": "Reverts editor to "to" setting, from the undo stack.", "parameters": [ { "name": "from", "type": null, "usage": "required" }, { "name": "to", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "name": "_beginEditing", "scope": "prototype", "private": true, "summary": "Called when the user starts typing alphanumeric characters.\nDeals with saving undo; see editActionInterval parameter.", "parameters": [ { "name": "cmd", "type": null, "usage": "required" } ] } ] }, "dijit.Editor.editingArea.style": { "location": "dijit.Editor.editingArea.style", "type": null }, "dijit.Editor.iframe.style": { "location": "dijit.Editor.iframe.style", "type": null }, "dijit.Editor.document": { "location": "dijit.Editor.document", "type": null, "properties": [ { "name": "body", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "scope": "prototype", "type": null } ] }, "dijit.Editor.document.body": { "location": "dijit.Editor.document.body", "resources": [ "dijit\/Editor.js" ], "provides": [ "dijit.Editor" ], "type": null }, "dijit.InlineEditBox": { "location": "dijit.InlineEditBox", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "An element with in-line edit capabilities", "description": "Behavior for an existing node (`

`, `

`, ``, etc.) so that\nwhen you click it, an editor shows up in place of the original\ntext. Optionally, Save and Cancel button are displayed below the edit widget.\nWhen Save is clicked, the text is pulled from the edit\nwidget and redisplayed and the edit widget is again hidden.\nBy default a plain Textarea widget is used as the editor (or for\ninline values a TextBox), but you can specify an editor such as\ndijit.Editor (for editing HTML) or a Slider (for adjusting a number).\nAn edit widget must support the following API to be used:\n- displayedValue or value as initialization parameter,\nand available through set('displayedValue') \/ set('value')\n- void focus()\n- DOM-node focusNode = node containing editable text", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._Widget" } ] }, "properties": [ { "name": "wrapperWidget", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": "Object" }, { "name": "displayNode", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "scope": "prototype", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "setValue", "scope": "prototype", "summary": "Deprecated. Use set('value', ...) instead.", "parameters": [ { "name": "val", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "setDisabled", "scope": "prototype", "summary": "Deprecated. Use set('disabled', ...) instead.", "parameters": [ { "name": "disabled", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "save", "scope": "prototype", "private": true, "summary": "Save the contents of the editor and revert to display mode.", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required", "summary": "Focus on the display mode text" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "onChange", "scope": "prototype", "tags": "callback", "summary": "Set this handler to be notified of changes to value.", "parameters": [ { "name": "value", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "onCancel", "scope": "prototype", "tags": "callback", "summary": "Set this handler to be notified when editing is cancelled." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "getValue", "scope": "prototype", "summary": "Deprecated. Use get('value') instead." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "edit", "scope": "prototype", "private": true, "summary": "Display the editor widget in place of the original (read only) markup." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "constructor", "scope": "prototype", "private": true, "summary": "Sets up private arrays etc." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "cancel", "scope": "prototype", "private": true, "summary": "Revert to display mode, discarding any changes made in the editor", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_showText", "scope": "prototype", "private": true, "summary": "Revert to display mode, and optionally focus on display node", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_setValueAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("value", ...) work.\nInserts specified HTML value into this node, or an "input needed" character if node is blank.", "parameters": [ { "name": "val", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("disabled", ...) work.\nSet disabled state of widget.", "parameters": [ { "name": "disabled", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onMouseOver", "scope": "prototype", "private": true, "summary": "Handler for onmouseover and onfocus event." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onMouseOut", "scope": "prototype", "private": true, "summary": "Handler for onmouseout and onblur event." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Handler for onclick event.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onBlur", "scope": "prototype", "private": true, "summary": "Called when focus moves outside the InlineEditBox.\nPerforms garbage collection." } ] }, "dijit.InlineEditBox.displayNode": { "location": "dijit.InlineEditBox.displayNode", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": null }, "dijit.InlineEditBox.wrapperWidget": { "location": "dijit.InlineEditBox.wrapperWidget", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ] }, "dijit._InlineEditor": { "location": "dijit._InlineEditor", "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Internal widget used by InlineEditBox, displayed when in editing mode\nto display the editor and maybe save\/cancel buttons. Calling code should\nconnect to save\/cancel methods to detect when editing is finished\n\nHas mainly the same parameters as InlineEditBox, plus these values:\n\nstyle: Object\nSet of CSS attributes of display node, to replicate in editor\n\nvalue: String\nValue as an HTML string or plain text string, depending on renderAsHTML flag", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._WidgetsInTemplateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._WidgetsInTemplateMixin" } ] }, "properties": [ { "name": "inlineEditBox", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "getValue", "scope": "prototype", "summary": "Return the [display] value of the edit widget" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "focus", "scope": "prototype", "summary": "Focus the edit widget." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "enableSave", "scope": "prototype", "tags": "extension", "summary": "User overridable function returning a Boolean to indicate\nif the Save button should be enabled or not - usually due to invalid conditions" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onKeyPress", "scope": "prototype", "private": true, "summary": "Handler for keypress in the edit box in autoSave mode.", "description": "For autoSave widgets, if Esc\/Enter, call cancel\/save.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onIntermediateChange", "scope": "prototype", "private": true, "summary": "Called for editor widgets that support the intermediateChanges=true flag as a way\nto detect when to enable\/disabled the save button", "parameters": [ { "name": "val", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onChange", "scope": "prototype", "private": true, "summary": "Called when the underlying widget fires an onChange event,\nsuch as when the user selects a value from the drop down list of a ComboBox,\nwhich means that the user has finished entering the value and we should save." }, { "resources": [ "dijit\/InlineEditBox.js" ], "provides": [ "dijit.InlineEditBox" ], "name": "_onBlur", "scope": "prototype", "private": true, "summary": "Called when focus moves outside the editor" } ] }, "dijit._InlineEditor.inlineEditBox": { "location": "dijit._InlineEditor.inlineEditBox", "type": null }, "dijit._InlineEditor.domNode.style": { "location": "dijit._InlineEditor.domNode.style", "type": null }, "dijit.Menu": { "location": "dijit.Menu", "resources": [ "dijit\/Menu.js", "dojox\/widget\/PlaceholderMenuItem.js" ], "provides": [ "dijit.Menu", "dojox.widget.PlaceholderMenuItem" ], "type": "Function", "classlike": true, "superclass": "dijit.DropDownMenu", "summary": "A context menu you can assign to multiple elements", "mixins": { "instance": [ { "scope": "instance", "location": "dijit.DropDownMenu" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "uninitialize", "scope": "prototype" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "unBindDomNode", "scope": "prototype", "summary": "Detach menu from given node", "parameters": [ { "name": "nodeName", "type": "String|DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dojox\/widget\/PlaceholderMenuItem.js" ], "provides": [ "dojox.widget.PlaceholderMenuItem" ], "name": "getPlaceholders", "scope": "prototype", "summary": "Returns an array of placeholders with the given label. There\ncan be multiples.", "return-description": "An array of placeholders that match the given label", "parameters": [ { "name": "label", "type": "String", "usage": "optional", "summary": "Label to search for - if not specified, then all placeholders\nare returned" } ], "return-types": [ { "type": "dojox.widget.PlaceholderMenuItem[]" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "bindDomNode", "scope": "prototype", "summary": "Attach menu to given node", "parameters": [ { "name": "node", "type": "String|DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_scheduleOpen", "scope": "prototype", "private": true, "summary": "Set timer to display myself. Using a timer rather than displaying immediately solves\ntwo problems:\n\n1. IE: without the delay, focus work in "open" causes the system\ncontext menu to appear in spite of stopEvent.\n\n2. Avoid double-shows on linux, where shift-F10 generates an oncontextmenu event\neven after a dojo.stopEvent(e). (Shift-F10 on windows doesn't generate the\noncontextmenu event.)", "parameters": [ { "name": "target", "type": "DomNode", "usage": "optional" }, { "name": "iframe", "type": "DomNode", "usage": "optional" }, { "name": "coords", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_openMyself", "scope": "prototype", "private": true, "summary": "Internal function for opening myself when the user does a right-click or something similar.", "parameters": [ { "name": "args", "type": "This", "usage": "required", "summary": "is an Object containing:\n* target:\nThe node that is being clicked\n* iframe:\nIf an <iframe> is being clicked, iframe points to that iframe\n* coords:\nPut menu at specified x\/y position in viewport, or if iframe is\nspecified, then relative to iframe.\n\n_openMyself() formerly took the event object, and since various code references\nevt.target (after connecting to _openMyself()), using an Object for parameters\n(so that old code still works)." } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_onBlur", "scope": "prototype", "private": true }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_iframeContentWindow", "scope": "prototype", "private": true, "summary": "Returns the window reference of the passed iframe", "parameters": [ { "name": "iframe_el", "type": "HTMLIFrameElement", "usage": "required" } ] }, { "resources": [ "dijit\/Menu.js" ], "provides": [ "dijit.Menu" ], "name": "_iframeContentDocument", "scope": "prototype", "summary": "Returns a reference to the document object inside iframe_el", "parameters": [ { "name": "iframe_el", "type": "HTMLIFrameElement", "usage": "required" } ], "return-types": [ { "type": "W3" } ] } ] }, "dijit.MenuBar": { "location": "dijit.MenuBar", "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "type": "Function", "classlike": true, "superclass": "dijit._MenuBase", "summary": "A menu bar, listing menu choices horizontally, like the "File" menu in most desktop applications", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._MenuBase" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "onItemClick", "scope": "prototype", "private": true, "summary": "Handle clicks on an item. Cancels a dropdown if already open.", "parameters": [ { "name": "item", "type": "dijit._Widget", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "focusChild", "scope": "prototype", "parameters": [ { "name": "item", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/MenuBar.js" ], "provides": [ "dijit.MenuBar" ], "name": "_onKeyPress", "scope": "prototype", "summary": "Handle keyboard based menu navigation.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] } ] }, "dijit._MenuBarItemMixin": { "location": "dijit._MenuBarItemMixin", "resources": [ "dijit\/MenuBarItem.js" ], "provides": [ "dijit.MenuBarItem" ], "type": "Function", "classlike": true, "methods": [ { "constructor": "constructor" } ] }, "dijit.MenuBarItem": { "location": "dijit.MenuBarItem", "resources": [ "dijit\/MenuBarItem.js" ], "provides": [ "dijit.MenuBarItem" ], "type": "Function", "classlike": true, "superclass": "dijit.MenuItem", "summary": "Item in a MenuBar that's clickable, and doesn't spawn a submenu when pressed (or hovered)", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._MenuBarItemMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.MenuItem" }, { "scope": "instance", "location": "dijit._MenuBarItemMixin" } ] }, "methods": [ { "constructor": "constructor" } ] }, "dijit.MenuItem": { "location": "dijit.MenuItem", "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A line item in a Menu Widget", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._Contained.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._Contained" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "accelKeyNode", "scope": "normal", "type": null }, { "name": "_setLabelAttr", "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_setIconClassAttr", "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "scope": "prototype", "type": "Object", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "setLabel", "scope": "prototype", "summary": "Deprecated. Use set('label', ...) instead.", "parameters": [ { "name": "content", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "setDisabled", "scope": "prototype", "summary": "Deprecated. Use set('disabled', bool) instead.", "parameters": [ { "name": "disabled", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "onClick", "scope": "prototype", "tags": "callback", "summary": "User defined function to handle clicks", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "focus", "scope": "prototype", "summary": "Focus on this MenuItem" }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_setSelected", "scope": "prototype", "private": true, "summary": "Indicate that this node is the currently selected one", "parameters": [ { "name": "selected", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_setDisabledAttr", "scope": "prototype", "private": true, "summary": "Hook for attr('disabled', ...) to work.\nEnable or disable this menu item.", "parameters": [ { "name": "value", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_setAccelKeyAttr", "scope": "prototype", "private": true, "summary": "Hook for attr('accelKey', ...) to work.\nSet accelKey on this menu item.", "parameters": [ { "name": "value", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_onUnhover", "scope": "prototype", "summary": "Handler when mouse is moved off of menu item,\npossibly to a child menu, or maybe to a sibling\nmenuitem or somewhere else entirely." }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_onHover", "scope": "prototype", "summary": "Handler when mouse is moved onto menu item" }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_onFocus", "scope": "prototype", "summary": "This is called by the focus manager when focus\ngoes to this MenuItem or a child menu." }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Internal handler for click events on MenuItem.", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "name": "_fillContent", "scope": "prototype", "private": true, "parameters": [ { "name": "source", "type": "DomNode", "usage": "required" } ] } ] }, "dijit.MenuItem._setLabelAttr": { "location": "dijit.MenuItem._setLabelAttr", "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "private": true }, "dijit.MenuItem._setIconClassAttr": { "location": "dijit.MenuItem._setIconClassAttr", "resources": [ "dijit\/MenuItem.js" ], "provides": [ "dijit.MenuItem" ], "private": true }, "dijit.MenuItem.accelKeyNode.style": { "location": "dijit.MenuItem.accelKeyNode.style", "type": null }, "dijit.MenuItem.accelKeyNode": { "location": "dijit.MenuItem.accelKeyNode", "type": null, "properties": [ { "name": "style", "scope": "normal", "type": null } ] }, "dijit.MenuSeparator": { "location": "dijit.MenuSeparator", "resources": [ "dijit\/MenuSeparator.js" ], "provides": [ "dijit.MenuSeparator" ], "type": "Function", "classlike": true, "superclass": "dijit._WidgetBase", "summary": "A line between two menu items", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._Contained.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._WidgetBase" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._Contained" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/MenuSeparator.js" ], "provides": [ "dijit.MenuSeparator" ], "name": "isFocusable", "scope": "prototype", "summary": "Override to always return false", "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/MenuSeparator.js" ], "provides": [ "dijit.MenuSeparator" ], "name": "buildRendering", "scope": "prototype" } ] }, "dijit.PopupMenuBarItem": { "location": "dijit.PopupMenuBarItem", "resources": [ "dijit\/PopupMenuBarItem.js" ], "provides": [ "dijit.PopupMenuBarItem" ], "type": "Function", "classlike": true, "superclass": "dijit.PopupMenuItem", "summary": "Item in a MenuBar like "File" or "Edit", that spawns a submenu when pressed (or hovered)", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._MenuBarItemMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.PopupMenuItem" }, { "scope": "instance", "location": "dijit._MenuBarItemMixin" } ] }, "methods": [ { "constructor": "constructor" } ] }, "dijit.PopupMenuItem": { "location": "dijit.PopupMenuItem", "resources": [ "dijit\/PopupMenuItem.js" ], "provides": [ "dijit.PopupMenuItem" ], "type": "Function", "classlike": true, "superclass": "dijit.MenuItem", "summary": "An item in a Menu that spawn a drop down (usually a drop down menu)", "mixins": { "instance": [ { "scope": "instance", "location": "dijit.MenuItem" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/PopupMenuItem.js" ], "provides": [ "dijit.PopupMenuItem" ], "name": "startup", "scope": "prototype" }, { "resources": [ "dijit\/PopupMenuItem.js" ], "provides": [ "dijit.PopupMenuItem" ], "name": "destroyDescendants", "scope": "prototype" }, { "resources": [ "dijit\/PopupMenuItem.js" ], "provides": [ "dijit.PopupMenuItem" ], "name": "_fillContent", "scope": "prototype", "summary": "When Menu is declared in markup, this code gets the menu label and\nthe popup widget from the srcNodeRef.", "description": "srcNodeRefinnerHTML contains both the menu item text and a popup widget\nThe first part holds the menu item text and the second part is the popup", "examples": { "example": "\t
\n\t\tpick me<\/span>\n\t\t ... <\/popup>\n\t<\/div>" } } ] }, "dijit.PopupMenuItem.popup.domNode.style": { "location": "dijit.PopupMenuItem.popup.domNode.style", "type": null }, "dijit.ProgressBar": { "location": "dijit.ProgressBar", "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A progress indication widget, showing the amount completed\n(often the percentage completed) of a task.", "examples": { "example": "\t
\n\t<\/div>" }, "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "properties": [ { "name": "labelNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "update", "scope": "prototype", "private": true, "summary": "Internal method to change attributes of ProgressBar, similar to set(hash). Users should call\nset("value", ...) rather than calling this method directly.", "examples": { "example": "\tmyProgressBar.update({'indeterminate': true});\n\tmyProgressBar.update({'progress': 80});\n\tmyProgressBar.update({'indeterminate': true, label:\"Loading ...\" })" }, "parameters": [ { "name": "attributes", "type": "Object", "usage": "optional", "summary": "May provide progress and\/or maximum properties on this parameter;\nsee attribute specs for details." } ] }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "report", "scope": "prototype", "tags": "extension", "summary": "Generates message to show inside progress bar (normally indicating amount of task completed).\nMay be overridden.", "parameters": [ { "name": "percent", "type": "float", "usage": "required" } ] }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "onChange", "scope": "prototype", "tags": "extension", "summary": "Callback fired when progress updates." }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "_setValueAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "v", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "_setLabelAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "label", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/ProgressBar.js" ], "provides": [ "dijit.ProgressBar" ], "name": "_setIndeterminateAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "indeterminate", "type": null, "usage": "required" } ] } ] }, "dijit.ProgressBar.labelNode": { "location": "dijit.ProgressBar.labelNode", "type": null }, "dijit.ProgressBar.internalProgress.style": { "location": "dijit.ProgressBar.internalProgress.style", "type": null }, "dijit.TitlePane": { "location": "dijit.TitlePane", "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "type": "Function", "classlike": true, "superclass": "dijit.layout.ContentPane", "summary": "A pane with a title on top, that can be expanded or collapsed.", "description": "An accessible container with a title Heading, and a content\nsection that slides open and closed. TitlePane is an extension to\n`dijit.layout.ContentPane`, providing all the useful content-control aspects from it.", "examples": [ " \t\/\/ load a TitlePane from remote file:\n\tvar foo = new dijit.TitlePane({ href: \"foobar.html\", title:\"Title\" });\n\tfoo.startup();", "\t\n\t
<\/div>", "\t\n \t
\n\t\t

I am content<\/p>\n\t<\/div>" ], "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit.layout.ContentPane" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "arrowNodeInner", "scope": "normal", "type": null }, { "name": "_setTooltipAttr", "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_setTitleAttr", "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "scope": "prototype", "type": "Object", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "toggle", "scope": "prototype", "private": true, "summary": "Switches between opened and closed state" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "setTitle", "scope": "prototype", "summary": "Deprecated. Use set('title', ...) instead.", "parameters": [ { "name": "title", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_setToggleableAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("toggleable", boolean) work.", "parameters": [ { "name": "canToggle", "type": "Boolean", "usage": "required", "summary": "True to allow user to open\/close pane by clicking title bar." } ] }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_setOpenAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("open", boolean) control the open\/closed state of the pane.", "parameters": [ { "name": "open", "type": "Boolean", "usage": "required", "summary": "True if you want to open the pane, false if you want to close it." }, { "name": "animate", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_setCss", "scope": "prototype", "private": true, "summary": "Set the open\/close css state for the TitlePane" }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_setContentAttr", "scope": "prototype", "private": true, "summary": "Hook to make set("content", ...) work.\nTypically called when an href is loaded. Our job is to make the animation smooth.", "parameters": [ { "name": "content", "type": "String|DomNode|Nodelist", "usage": "required" } ] }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_onTitleKey", "scope": "prototype", "private": true, "summary": "Handler for when user hits a key", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "name": "_onTitleClick", "scope": "prototype", "private": true, "summary": "Handler when user clicks the title bar" } ] }, "dijit.TitlePane._setTitleAttr": { "location": "dijit.TitlePane._setTitleAttr", "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "private": true }, "dijit.TitlePane._setTooltipAttr": { "location": "dijit.TitlePane._setTooltipAttr", "resources": [ "dijit\/TitlePane.js" ], "provides": [ "dijit.TitlePane" ], "private": true }, "dijit.TitlePane.hideNode.style": { "location": "dijit.TitlePane.hideNode.style", "type": null }, "dijit.TitlePane.wipeNode.style": { "location": "dijit.TitlePane.wipeNode.style", "type": null }, "dijit.TitlePane.arrowNodeInner": { "location": "dijit.TitlePane.arrowNodeInner", "type": null }, "dijit.Toolbar": { "location": "dijit.Toolbar", "resources": [ "dijit\/Toolbar.js" ], "provides": [ "dijit.Toolbar" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A Toolbar widget, used to hold things like `dijit.Editor` buttons", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._KeyNavContainer.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._KeyNavContainer" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Toolbar.js" ], "provides": [ "dijit.Toolbar" ], "name": "postCreate", "scope": "prototype" } ] }, "dijit.ToolbarSeparator": { "location": "dijit.ToolbarSeparator", "resources": [ "dijit\/ToolbarSeparator.js" ], "provides": [ "dijit.ToolbarSeparator" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A spacer between two `dijit.Toolbar` items", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/ToolbarSeparator.js" ], "provides": [ "dijit.ToolbarSeparator" ], "name": "isFocusable", "scope": "prototype", "summary": "This widget isn't focusable, so pass along that fact." }, { "resources": [ "dijit\/ToolbarSeparator.js" ], "provides": [ "dijit.ToolbarSeparator" ], "name": "buildRendering", "scope": "prototype" } ] }, "dijit._MasterTooltip": { "location": "dijit._MasterTooltip", "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Internal widget that holds the actual tooltip markup,\nwhich occurs once per page.\nCalled by Tooltip widgets which are just containers to hold\nthe markup", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "properties": [ { "name": "domNode", "scope": "normal", "type": null }, { "name": "containerNode", "scope": "normal", "type": null }, { "name": "connectorNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "show", "scope": "prototype", "summary": "Display tooltip w\/specified contents to right of specified node\n(To left if there's no space on the right, or if rtl == true)", "parameters": [ { "name": "innerHTML", "type": "String", "usage": "required" }, { "name": "aroundNode", "type": "DomNode", "usage": "required", "summary": "|| dijit.__Rectangle" }, { "name": "position", "type": "String[]", "usage": "optional" }, { "name": "rtl", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "orient", "scope": "prototype", "summary": "Private function to set CSS for tooltip node based on which position it's in.\nThis is called by the dijit popup code. It will also reduce the tooltip's\nwidth to whatever width is available", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "aroundCorner", "type": "String", "usage": "required" }, { "name": "tooltipCorner", "type": "String", "usage": "required" }, { "name": "spaceAvailable", "type": "Object", "usage": "required" }, { "name": "aroundNodeCoords", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "hide", "scope": "prototype", "summary": "Hide the tooltip", "parameters": [ { "name": "aroundNode", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onShow", "scope": "prototype", "summary": "Called at end of fade-in operation" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onHide", "scope": "prototype", "summary": "Called at end of fade-out operation" } ] }, "dijit._MasterTooltip.domNode": { "location": "dijit._MasterTooltip.domNode", "type": null, "properties": [ { "name": "style", "scope": "normal", "type": null } ] }, "dijit._MasterTooltip.containerNode": { "location": "dijit._MasterTooltip.containerNode", "type": null, "properties": [ { "name": "style", "scope": "normal", "type": null } ] }, "dijit._MasterTooltip.connectorNode.style": { "location": "dijit._MasterTooltip.connectorNode.style", "type": null }, "dijit._MasterTooltip.domNode.style": { "location": "dijit._MasterTooltip.domNode.style", "type": null }, "dijit._MasterTooltip.containerNode.style": { "location": "dijit._MasterTooltip.containerNode.style", "type": null }, "dijit._MasterTooltip.connectorNode": { "location": "dijit._MasterTooltip.connectorNode", "type": null, "properties": [ { "name": "style", "scope": "normal", "type": null } ] }, "dijit.Tooltip": { "location": "dijit.Tooltip", "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Pops up a tooltip (a help message) when you hover over a node.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._Widget" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "uninitialize", "scope": "prototype" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "startup", "scope": "prototype" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "removeTarget", "scope": "prototype", "summary": "Detach tooltip from specified node", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required", "summary": "|| String" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "open", "scope": "prototype", "private": true, "summary": "Display the tooltip; usually not called directly.", "parameters": [ { "name": "target", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "onShow", "scope": "prototype", "tags": "callback", "summary": "Called when the tooltip is shown", "parameters": [ { "name": "target", "type": null, "usage": "required" }, { "name": "position", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "onHide", "scope": "prototype", "tags": "callback", "summary": "Called when the tooltip is hidden" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "close", "scope": "prototype", "private": true, "summary": "Hide the tooltip or cancel timer for show of tooltip" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "addTarget", "scope": "prototype", "summary": "Attach tooltip to specified node if it's not already connected", "parameters": [ { "name": "node", "type": "DOMNODE", "usage": "required", "summary": "|| String" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_setConnectIdAttr", "scope": "prototype", "private": true, "summary": "Connect to node(s) (specified by id)", "parameters": [ { "name": "newId", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onUnHover", "scope": "prototype", "private": true, "summary": "Despite the name of this method, it actually handles both mouseleave and blur\nevents on the target node, hiding the tooltip.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onTargetMouseLeave", "scope": "prototype", "private": true, "summary": "Handler for mouseleave event on the target node", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onTargetMouseEnter", "scope": "prototype", "private": true, "summary": "Handler for mouseenter event on the target node", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onTargetFocus", "scope": "prototype", "private": true, "summary": "Handler for focus event on the target node", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onTargetBlur", "scope": "prototype", "private": true, "summary": "Handler for blur event on the target node", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tooltip.js" ], "provides": [ "dijit.Tooltip" ], "name": "_onHover", "scope": "prototype", "private": true, "summary": "Despite the name of this method, it actually handles both hover and focus\nevents on the target node, setting a timer to show the tooltip.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] } ] }, "dijit.TooltipDialog": { "location": "dijit.TooltipDialog", "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "type": "Function", "classlike": true, "superclass": "dijit.layout.ContentPane", "summary": "Pops up a dialog that appears like a Tooltip", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.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._TemplatedMixin" }, { "scope": "instance", "location": "dijit.form._FormMixin" }, { "scope": "instance", "location": "dijit._DialogMixin" } ] }, "properties": [ { "name": "containerNode", "scope": "normal", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "orient", "scope": "prototype", "summary": "Configure widget to be displayed in given position relative to the button.\nThis is called from the dijit.popup code, and should not be called\ndirectly.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" }, { "name": "aroundCorner", "type": "String", "usage": "required" }, { "name": "corner", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "onOpen", "scope": "prototype", "summary": "Called when dialog is displayed.\nThis is called from the dijit.popup code, and should not be called directly.", "parameters": [ { "name": "pos", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "onClose", "scope": "prototype", "summary": "Called when dialog is hidden.\nThis is called from the dijit.popup code, and should not be called directly." }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "focus", "scope": "prototype", "summary": "Focus on first field" }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "_setTitleAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "title", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/TooltipDialog.js" ], "provides": [ "dijit.TooltipDialog" ], "name": "_onKey", "scope": "prototype", "private": true, "summary": "Handler for keyboard events", "description": "Keep keyboard focus in dialog; close dialog on escape key", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] } ] }, "dijit.TooltipDialog.containerNode": { "location": "dijit.TooltipDialog.containerNode", "type": null }, "dijit._TreeNode": { "location": "dijit._TreeNode", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Single node within a tree. This class is used internally\nby Tree and should not be accessed directly.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._Container.prototype" }, { "scope": "prototype", "location": "dijit._Contained.prototype" }, { "scope": "prototype", "location": "dijit._CssStateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._Container" }, { "scope": "instance", "location": "dijit._Contained" }, { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "properties": [ { "name": "tree", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "scope": "prototype", "type": null }, { "name": "expandoNodeText", "scope": "normal", "type": null }, { "name": "cssStateNodes", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "scope": "prototype", "type": "Object" }, { "name": "_setTooltipAttr", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "scope": "prototype", "type": "Object", "private": true }, { "name": "_setLabelAttr", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "scope": "prototype", "type": "Object", "private": true } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "unmarkProcessing", "scope": "prototype", "private": true, "summary": "Clear markup from markProcessing() call" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "setSelected", "scope": "prototype", "summary": "A Tree has a (single) currently selected node.\nMark that this node is\/isn't that currently selected node.", "description": "In particular, setting a node as selected involves setting tabIndex\nso that when user tabs to the tree, focus will go to that node (only).", "parameters": [ { "name": "selected", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "setFocusable", "scope": "prototype", "summary": "A Tree has a (single) node that's focusable.\nMark that this node is\/isn't that currently focsuable node.", "description": "In particular, setting a node as selected involves setting tabIndex\nso that when user tabs to the tree, focus will go to that node (only).", "parameters": [ { "name": "selected", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "setChildItems", "scope": "prototype", "summary": "Sets the child items of this node, removing\/adding nodes\nfrom current children to match specified items[] array.\nAlso, if this.persist == true, expands any children that were previously\nopened.", "return-description": "Deferred object that fires after all previously opened children\nhave been expanded again (or fires instantly if there are no such children).", "parameters": [ { "name": "items", "type": "Object[]", "usage": "required" } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "removeChild", "scope": "prototype", "parameters": [ { "name": "node", "type": "treeNode", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "markProcessing", "scope": "prototype", "private": true, "summary": "Visually denote that tree is loading data, etc." }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "makeExpandable", "scope": "prototype", "summary": "if this node wasn't already showing the expando node,\nturn it into one and call _setExpando()" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getTreePath", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getIdentity", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "expand", "scope": "prototype", "summary": "Show my children", "return-description": "Deferred that fires when expansion is complete", "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "collapse", "scope": "prototype", "summary": "Collapse this node (if it's expanded)" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_updateLayout", "scope": "prototype", "private": true, "summary": "Set appropriate CSS classes for this.domNode" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_updateItemClasses", "scope": "prototype", "private": true, "summary": "Set appropriate CSS classes for icon and label dom node\n(used to allow for item updates to change respective CSS)", "parameters": [ { "name": "item", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setIndentAttr", "scope": "prototype", "private": true, "summary": "Tell this node how many levels it should be indented", "description": "0 for top level nodes, 1 for their children, 2 for their\ngrandchildren, etc.", "parameters": [ { "name": "indent", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setExpando", "scope": "prototype", "private": true, "summary": "Set the right image for the expando node", "parameters": [ { "name": "processing", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onMouseLeave", "scope": "prototype", "private": true, "summary": "Handler for onmouseenter event on a node", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onMouseEnter", "scope": "prototype", "private": true, "summary": "Handler for onmouseenter event on a node", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onLabelFocus", "scope": "prototype", "private": true, "summary": "Called when this row is focused (possibly programatically)\nNote that we aren't using _onFocus() builtin to dijit\nbecause it's called when focus is moved to a descendant TreeNode.", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onDblClick", "scope": "prototype", "private": true, "summary": "Handler for ondblclick event on a node", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Handler for onclick event on a node", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_applyClassAndStyle", "scope": "prototype", "private": true, "summary": "Set the appropriate CSS classes and styles for labels, icons and rows.", "parameters": [ { "name": "item", "type": "The", "usage": "required", "summary": "data item." }, { "name": "lower", "type": "The", "usage": "required", "summary": "lower case attribute to use, e.g. 'icon', 'label' or 'row'." }, { "name": "upper", "type": "The", "usage": "required", "summary": "upper case attribute to use, e.g. 'Icon', 'Label' or 'Row'." } ] } ] }, "dijit._TreeNode._setLabelAttr": { "location": "dijit._TreeNode._setLabelAttr", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "private": true }, "dijit._TreeNode.cssStateNodes": { "location": "dijit._TreeNode.cssStateNodes", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ] }, "dijit._TreeNode._setTooltipAttr": { "location": "dijit._TreeNode._setTooltipAttr", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "private": true }, "dijit._TreeNode.tree": { "location": "dijit._TreeNode.tree", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "type": null }, "dijit._TreeNode.expandoNodeText": { "location": "dijit._TreeNode.expandoNodeText", "type": null }, "dijit.Tree": { "location": "dijit.Tree", "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "This widget displays hierarchical data from a store.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "resize", "scope": "prototype", "parameters": [ { "name": "changeSize", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onOpen", "scope": "prototype", "tags": "callback", "summary": "Callback when a node is opened", "parameters": [ { "name": "item", "type": "dojo.data", "usage": "required" }, { "name": "node", "type": "TreeNode", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onLoad", "scope": "prototype", "tags": "callback", "summary": "Called when tree finishes loading and expanding.", "description": "If persist == true the loading may encompass many levels of fetches\nfrom the data store, each asynchronous. Waits for all to finish." }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onDndDrop", "scope": "prototype", "summary": "Parameter to dndController, see `dijit.tree.dndSource.onDndDrop`.\nGenerally this doesn't need to be set." }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onDndCancel", "scope": "prototype", "summary": "Parameter to dndController, see `dijit.tree.dndSource.onDndCancel`.\nGenerally this doesn't need to be set." }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onDblClick", "scope": "prototype", "tags": "callback", "summary": "Callback when a tree node is double-clicked", "parameters": [ { "name": "item", "type": "dojo.data", "usage": "required" }, { "name": "node", "type": "TreeNode", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onClose", "scope": "prototype", "tags": "callback", "summary": "Callback when a node is closed", "parameters": [ { "name": "item", "type": "dojo.data", "usage": "required" }, { "name": "node", "type": "TreeNode", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "onClick", "scope": "prototype", "tags": "callback", "summary": "Callback when a tree node is clicked", "parameters": [ { "name": "item", "type": "dojo.data", "usage": "required" }, { "name": "node", "type": "TreeNode", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "mayHaveChildren", "scope": "prototype", "summary": "Deprecated. This should be specified on the model itself.\n\nOverridable function to tell if an item has or may have children.\nControls whether or not +\/- expando icon is shown.\n(For efficiency reasons we may not want to check if an element actually\nhas children until user clicks the expando node)", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "itemCreator", "scope": "prototype", "tags": "extension", "summary": "Returns objects passed to `Tree.model.newItem()` based on DnD nodes\ndropped onto the tree. Developer must override this method to enable\ndropping from external sources onto this Tree, unless the Tree.model's items\nhappen to look like {id: 123, name: "Apple" } with no other attributes.", "description": "For each node in nodes[], which came from source, create a hash of name\/value\npairs to be passed to Tree.model.newItem(). Returns array of those hashes.", "return-description": "Object[]\nArray of name\/value hashes for each new item to be added to the Tree, like:\n\t[\n\t\t{ id: 123, label: \"apple\", foo: \"bar\" },\n\t\t{ id: 456, label: \"pear\", zaz: \"bam\" }\n\t]", "parameters": [ { "name": "nodes", "type": "DomNode[]", "usage": "required", "summary": "The DOMNodes dragged from the source container" }, { "name": "target", "type": "DomNode", "usage": "required", "summary": "The target TreeNode.rowNode" }, { "name": "source", "type": "dojo.dnd.Source", "usage": "required", "summary": "The source container the nodes were dragged from, perhaps another Tree or a plain dojo.dnd.Source" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "isExpandoNode", "scope": "prototype", "summary": "check whether a dom node is the expandoNode for a particular TreeNode widget", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "widget", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getTooltip", "scope": "prototype", "tags": "extension", "summary": "Overridable function to get the tooltip for a tree node (given the item)", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getRowStyle", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS styles to display row", "return-description": "Object suitable for input to dojo.style() like {background-color: \"#bbb\"}", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getRowClass", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS class name to display row", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getNodesByItem", "scope": "prototype", "summary": "Returns all tree nodes that refer to an item", "return-description": "Array of tree nodes that refer to passed item", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required", "summary": "or id" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getLabelStyle", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS styles to display label", "return-description": "Object suitable for input to dojo.style() like {color: \"red\", background: \"green\"}", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getLabelClass", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS class name to display label", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getLabel", "scope": "prototype", "tags": "extension", "summary": "Overridable function to get the label for a tree node (given the item)", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getItemChildren", "scope": "prototype", "summary": "Deprecated. This should be specified on the model itself.\n\nOverridable function that return array of child items of given parent item,\nor if parentItem==null then return top items in tree", "parameters": [ { "name": "parentItem", "type": "dojo.data.Item", "usage": "required" }, { "name": "onComplete", "type": "function(items)", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getIconStyle", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS styles to display icon", "return-description": "Object suitable for input to dojo.style() like {backgroundImage: \"url(...)\"}", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "getIconClass", "scope": "prototype", "tags": "extension", "summary": "Overridable function to return CSS class name to display icon", "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required" }, { "name": "opened", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "focusNode", "scope": "prototype", "summary": "Focus on the specified node (which must be visible)", "parameters": [ { "name": "node", "type": "_tree.Node", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "destroyRecursive", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "checkItemAcceptance", "scope": "prototype", "tags": "extension", "summary": "Stub function to be overridden if one wants to check for the ability to drop at the node\/item level", "description": "In the base case, this is called to check if target can become a child of source.\nWhen betweenThreshold is set, position=\"before\" or \"after\" means that we\nare asking if the source node can be dropped before\/after the target node.", "parameters": [ { "name": "target", "type": "DOMNode", "usage": "required", "summary": "The dijitTreeRoot DOM node inside of the TreeNode that we are dropping on to\nUse dijit.getEnclosingWidget(target) to get the TreeNode." }, { "name": "source", "type": "dijit.tree.dndSource", "usage": "required", "summary": "The (set of) nodes we are dropping" }, { "name": "position", "type": "String", "usage": "required", "summary": ""over", "before", or "after"" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "checkAcceptance", "scope": "prototype", "tags": "extension", "summary": "Checks if the Tree itself can accept nodes from this source", "parameters": [ { "name": "source", "type": "dijit.tree._dndSource", "usage": "required", "summary": "The source which provides items" }, { "name": "nodes", "type": "DOMNode[]", "usage": "required", "summary": "Array of DOM nodes corresponding to nodes being dropped, dijitTreeRow nodes if\nsource is a dijit.Tree." } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_store2model", "scope": "prototype", "private": true, "summary": "User specified a store&query rather than model, so create model from store\/query" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_state", "scope": "prototype", "private": true, "summary": "Query or set expanded state for an node", "parameters": [ { "name": "node", "type": null, "usage": "required" }, { "name": "expanded", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setSelectedNodesAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "nodes", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setSelectedNodeAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "node", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setSelectedItemsAttr", "scope": "prototype", "private": true, "summary": "Select tree nodes related to passed items.\nWARNING: if model use multi-parented items or desired tree node isn't already loaded\nbehavior is undefined. Use set('paths', ...) instead.", "parameters": [ { "name": "items", "type": "dojo.data.Items", "usage": "required", "summary": "or ids" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setSelectedItemAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "item", "type": "dojo.data.Item", "usage": "required", "summary": "or id" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setPathsAttr", "scope": "prototype", "private": true, "summary": "Select the tree nodes identified by passed paths.", "return-description": "Deferred to indicate when the set is complete", "parameters": [ { "name": "paths", "type": "Item[][]", "usage": "required", "summary": "Array of arrays of items or item id's" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_setPathAttr", "scope": "prototype", "private": true, "summary": "Singular variant of _setPathsAttr", "parameters": [ { "name": "path", "type": "Item[]", "usage": "required", "summary": "|| String[]" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_publish", "scope": "prototype", "private": true, "summary": "Publish a message for this widget\/topic", "parameters": [ { "name": "topicName", "type": "String", "usage": "required" }, { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onUpArrow", "scope": "prototype", "private": true, "summary": "Up arrow pressed; move to previous visible node", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onRightArrow", "scope": "prototype", "private": true, "summary": "Right arrow pressed; go to child node", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onNodeMouseLeave", "scope": "prototype", "private": true, "summary": "Called when mouse leaves a node (onmouseleave event),\nthis is monitored by the DND code", "parameters": [ { "name": "node", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onNodeMouseEnter", "scope": "prototype", "private": true, "summary": "Called when mouse is over a node (onmouseenter event),\nthis is monitored by the DND code", "parameters": [ { "name": "node", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onNodeFocus", "scope": "prototype", "private": true, "summary": "Called when a TreeNode gets focus, either by user clicking\nit, or programatically by arrow key handling code.", "description": "It marks that the current node is the selected one, and the previously\nselected node no longer is.", "parameters": [ { "name": "node", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onLetterKeyNav", "scope": "prototype", "private": true, "summary": "Called when user presses a prinatable key; search for node starting with recently typed letters.", "parameters": [ { "name": "message", "type": "Object", "usage": "required", "summary": "Like { node: TreeNode, key: 'a' } where key is the key the user pressed." } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onLeftArrow", "scope": "prototype", "private": true, "summary": "Left arrow pressed.\nIf not collapsed, collapse, else move to parent.", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onKeyPress", "scope": "prototype", "private": true, "summary": "Translates keypress events into commands for the controller", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onItemDelete", "scope": "prototype", "private": true, "summary": "Processes notification of a deletion of an item", "parameters": [ { "name": "item", "type": "Item", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onItemChildrenChange", "scope": "prototype", "private": true, "summary": "Processes notification of a change to an item's children", "parameters": [ { "name": "parent", "type": "dojo.data.Item", "usage": "required" }, { "name": "newChildrenList", "type": "dojo.data.Item[]", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onItemChange", "scope": "prototype", "private": true, "summary": "Processes notification of a change to an item's scalar values like label", "parameters": [ { "name": "item", "type": "Item", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onHomeKey", "scope": "prototype", "private": true, "summary": "Home key pressed; get first visible node, and set focus there" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onExpandoClick", "scope": "prototype", "private": true, "summary": "User clicked the +\/- icon; expand or collapse my children.", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onEnterKey", "scope": "prototype", "private": true, "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onEndKey", "scope": "prototype", "private": true, "summary": "End key pressed; go to last visible node.", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onDownArrow", "scope": "prototype", "private": true, "summary": "down arrow pressed; get next visible node, set focus there", "parameters": [ { "name": "message", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onDblClick", "scope": "prototype", "private": true, "summary": "Translates double-click events into commands for the controller to process", "parameters": [ { "name": "nodeWidget", "type": "TreeNode", "usage": "required" }, { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_onClick", "scope": "prototype", "private": true, "summary": "Translates click events into commands for the controller to process", "parameters": [ { "name": "nodeWidget", "type": "TreeNode", "usage": "required" }, { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_load", "scope": "prototype", "private": true, "summary": "Initial load of the tree.\nLoad root node (possibly hidden) and it's children." }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_initState", "scope": "prototype", "private": true, "summary": "Load in which nodes should be opened automatically" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_getRootOrFirstNode", "scope": "prototype", "private": true, "summary": "Get first visible node" }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_getNextNode", "scope": "prototype", "private": true, "summary": "Get next visible node", "parameters": [ { "name": "node", "type": null, "usage": "required" } ], "return-types": [ { "type": "_TreeNode" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_expandNode", "scope": "prototype", "private": true, "summary": "Called when the user has requested to expand the node", "return-description": "Deferred that fires when the node is loaded and opened and (if persist=true) all it's descendants\nthat were previously opened too", "parameters": [ { "name": "node", "type": "_TreeNode", "usage": "required" }, { "name": "recursive", "type": "Boolean", "usage": "optional", "summary": "Internal flag used when _expandNode() calls itself, don't set." } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_createTreeNode", "scope": "prototype", "private": true, "summary": "creates a TreeNode", "description": "Developers can override this method to define their own TreeNode class;\nHowever it will probably be removed in a future release in favor of a way\nof just specifying a widget for the label, rather than one that contains\nthe children too.", "parameters": [ { "name": "args", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/Tree.js" ], "provides": [ "dijit.Tree" ], "name": "_collapseNode", "scope": "prototype", "private": true, "summary": "Called when the user has requested to collapse the node", "parameters": [ { "name": "node", "type": "_TreeNode", "usage": "required" } ] } ] }, "_WidgetBase": { "location": "_WidgetBase", "resources": [ "dijit\/_BidiSupport.js" ], "provides": [ "dijit._BidiSupport" ], "type": "Function", "classlike": true, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_BidiSupport.js" ], "provides": [ "dijit._BidiSupport" ], "name": "getTextDir", "scope": "prototype", "tags": "protected.", "summary": "Gets the right direction of text.", "description": "If textDir is ltr or rtl returns the value.\nIf it's auto, calls to another function that responsible\nfor checking the value, and defining the direction.", "parameters": [ { "name": "text", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_BidiSupport.js" ], "provides": [ "dijit._BidiSupport" ], "name": "applyTextDir", "scope": "prototype", "tags": "protected.", "summary": "Set element.dir according to this.textDir", "description": "If textDir is ltr or rtl returns the value.\nIf it's auto, calls to another function that responsible\nfor checking the value, and defining the direction.", "parameters": [ { "name": "element", "type": "Object", "usage": "required", "summary": "The text element to be set. Should have dir property." }, { "name": "text", "type": "String", "usage": "required", "summary": "Used in case this.textDir is "auto", for calculating the right transformation" } ] }, { "resources": [ "dijit\/_BidiSupport.js" ], "provides": [ "dijit._BidiSupport" ], "name": "_checkContextual", "scope": "prototype", "tags": "private.", "private": true, "summary": "Finds the first strong (directional) character, return ltr if isLatin\nor rtl if isBidiChar.", "parameters": [ { "name": "text", "type": null, "usage": "required" } ] } ] }, "dijit._Contained": { "location": "dijit._Contained", "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "type": "Function", "classlike": true, "summary": "Mixin for widgets that are children of a container widget", "examples": { "example": " \t\/\/ make a basic custom widget that knows about it's parents\n\tdojo.declare(\"my.customClass\",[dijit._Widget,dijit._Contained],{});" }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "getPreviousSibling", "scope": "prototype", "summary": "Returns null if this is the first child of the parent,\notherwise returns the next element sibling to the "left".", "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "getParent", "scope": "prototype", "summary": "Returns the parent widget of this widget, assuming the parent\nspecifies isContainer" }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "getNextSibling", "scope": "prototype", "summary": "Returns null if this is the last child of the parent,\notherwise returns the next element sibling to the "right".", "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "getIndexInParent", "scope": "prototype", "summary": "Returns the index of this widget within its container parent.\nIt returns -1 if the parent does not exist, or if the parent\nis not a dijit._Container", "return-types": [ { "type": "int" } ] }, { "resources": [ "dijit\/_Contained.js" ], "provides": [ "dijit._Contained" ], "name": "_getSibling", "scope": "prototype", "private": true, "summary": "Returns next or previous sibling", "parameters": [ { "name": "which", "type": "String", "usage": "required", "summary": "Either "next" or "previous"" } ], "return-types": [ { "type": "dijit._Widget" } ] } ] }, "dijit._Container": { "location": "dijit._Container", "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "type": "Function", "classlike": true, "summary": "Mixin for widgets that contain a set of widget children.", "description": "Use this mixin for widgets that needs to know about and\nkeep track of their widget children. Suitable for widgets like BorderContainer\nand TabContainer which contain (only) a set of child widgets.\n\nIt's not suitable for widgets like ContentPane\nwhich contains mixed HTML (plain DOM nodes in addition to widgets),\nand where contained widgets are not necessarily directly below\nthis.containerNode. In that case calls like addChild(node, position)\nwouldn't make sense.", "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "startup", "scope": "prototype", "summary": "Called after all the widgets have been instantiated and their\ndom nodes have been inserted somewhere under dojo.doc.body.\n\nWidgets should override this method to do any initialization\ndependent on other widgets existing, and then call\nthis superclass method to finish things off.\n\nstartup() in subclasses shouldn't do anything\nsize related because the size of the widget hasn't been set yet." }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "removeChild", "scope": "prototype", "summary": "Removes the passed widget instance from this widget but does\nnot destroy it. You can also pass in an integer indicating\nthe index within the container to remove", "parameters": [ { "name": "widget", "type": "Widget|int", "usage": "required" } ] }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "hasChildren", "scope": "prototype", "summary": "Returns true if widget has children, i.e. if this.containerNode contains something.", "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "getIndexOfChild", "scope": "prototype", "summary": "Gets the index of the child in this container or -1 if not found", "parameters": [ { "name": "child", "type": "dijit._Widget", "usage": "required" } ], "return-types": [ { "type": "int" } ] }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "destroyDescendants", "scope": "prototype", "summary": "Destroys all the widgets inside this.containerNode,\nbut not this widget itself", "parameters": [ { "name": "preserveDom", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "addChild", "scope": "prototype", "summary": "Makes the given widget a child of this widget.", "description": "Inserts specified child widget's dom node as a child of this widget's\ncontainer node, and possibly does other processing (such as layout).", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required" }, { "name": "insertIndex", "type": "int", "usage": "optional" } ] }, { "resources": [ "dijit\/_Container.js" ], "provides": [ "dijit._Container" ], "name": "_getSiblingOfChild", "scope": "prototype", "private": true, "summary": "Get the next or previous widget sibling of child", "parameters": [ { "name": "child", "type": "dijit._Widget", "usage": "required" }, { "name": "dir", "type": "int", "usage": "required", "summary": "if 1, get the next sibling\nif -1, get the previous sibling" } ], "return-types": [ { "type": "dijit._Widget" } ] } ] }, "dijit._CssStateMixin": { "location": "dijit._CssStateMixin", "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "type": "Function", "classlike": true, "summary": "Mixin for widgets to set CSS classes on the widget DOM nodes depending on hover\/mouse press\/focus\nstate changes, and also higher-level state changes such becoming disabled or selected.", "description": "By mixing this class into your widget, and setting the this.baseClass attribute, it will automatically\nmaintain CSS classes on the widget root node (this.domNode) depending on hover,\nactive, focus, etc. state. Ex: with a baseClass of dijitButton, it will apply the classes\ndijitButtonHovered and dijitButtonActive, as the user moves the mouse over the widget and clicks it.\n\nIt also sets CSS like dijitButtonDisabled based on widget semantic state.\n\nBy setting the cssStateNodes attribute, a widget can also track events on subnodes (like buttons\nwithin the widget).", "properties": [ { "name": "stateNode", "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "name": "_trackMouseState", "scope": "prototype", "private": true, "summary": "Track mouse\/focus events on specified node and set CSS class on that node to indicate\ncurrent state. Usually not called directly, but via cssStateNodes attribute.", "description": "Given class=foo, will set the following CSS class on the node\n- fooActive: if the user is currently pressing down the mouse button while over the node\n- fooHover: if the user is hovering the mouse over the node, but not pressing down a button\n- fooFocus: if the node is focused\n\nNote that it won't set any classes if the widget is disabled.", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required", "summary": "Should be a sub-node of the widget, not the top node (this.domNode), since the top node\nis handled specially and automatically just by mixing in this class." }, { "name": "clazz", "type": "String", "usage": "required", "summary": "CSS class name (ex: dijitSliderUpArrow)." } ] }, { "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "name": "_setStateClass", "scope": "prototype", "private": true, "summary": "Update the visual state of the widget by setting the css classes on this.domNode\n(or this.stateNode if defined) by combining this.baseClass with\nvarious suffixes that represent the current widget state(s).", "description": "In the case where a widget has multiple\nstates, it sets the class based on all possible\ncombinations. For example, an invalid form widget that is being hovered\nwill be \"dijitInput dijitInputInvalid dijitInputHover dijitInputInvalidHover\".\n\nThe widget may have one or more of the following states, determined\nby this.state, this.checked, this.valid, and this.selected:\n- Error - ValidationTextBox sets this.state to \"Error\" if the current input value is invalid\n- Incomplete - ValidationTextBox sets this.state to \"Incomplete\" if the current input value is not finished yet\n- Checked - ex: a checkmark or a ToggleButton in a checked state, will have this.checked==true\n- Selected - ex: currently selected tab will have this.selected==true\n\nIn addition, it may have one or more of the following states,\nbased on this.disabled and flags set in _onMouse (this.active, this.hovering) and from focus manager (this.focused):\n- Disabled\t- if the widget is disabled\n- Active\t\t- if the mouse (or space\/enter key?) is being pressed down\n- Focused\t\t- if the widget has focus\n- Hover\t\t- if the mouse is over the widget" }, { "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "name": "_cssMouseEvent", "scope": "prototype", "private": true, "summary": "Sets hovering and active properties depending on mouse state,\nwhich triggers _setStateClass() to set appropriate CSS classes for this.domNode.", "parameters": [ { "name": "event", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ], "name": "_applyAttributes", "scope": "prototype", "private": true } ] }, "dijit._CssStateMixin.stateNode": { "location": "dijit._CssStateMixin.stateNode", "resources": [ "dijit\/_CssStateMixin.js" ], "provides": [ "dijit._CssStateMixin" ] }, "dijit._DialogMixin": { "location": "dijit._DialogMixin", "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "type": "Function", "classlike": true, "summary": "This provides functions useful to Dialog and TooltipDialog", "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "onExecute", "scope": "prototype", "summary": "Called when user has pressed the dialog's OK button, to notify container.", "description": "Developer shouldn't override or connect to this method;\nit's a private communication device between the TooltipDialog\nand the thing that opened it (ex: `dijit.form.DropDownButton`)\ntype:\nprotected" }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "onCancel", "scope": "prototype", "summary": "Called when user has pressed the Dialog's cancel button, to notify container.", "description": "Developer shouldn't override or connect to this method;\nit's a private communication device between the TooltipDialog\nand the thing that opened it (ex: `dijit.form.DropDownButton`)\ntype:\nprotected" }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "execute", "scope": "prototype", "summary": "Callback when the user hits the submit button.\nOverride this method to handle Dialog execution.", "description": "After the user has pressed the submit button, the Dialog\nfirst calls onExecute() to notify the container to hide the\ndialog and restore focus to wherever it used to be.\n\n*Then* this method is called.\ntype:\ncallback", "parameters": [ { "name": "formContents", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "_onSubmit", "scope": "prototype", "private": true, "summary": "Callback when user hits submit button\ntype:\nprotected" }, { "resources": [ "dijit\/_DialogMixin.js" ], "provides": [ "dijit._DialogMixin" ], "name": "_getFocusItems", "scope": "prototype", "summary": "Finds focusable items in dialog,\nand sets this._firstFocusItem and this._lastFocusItem" } ] }, "dijit._WidgetBase": { "location": "dijit._WidgetBase", "resources": [ "dijit\/_FocusMixin.js", "dijit\/_Templated.js", "dijit\/_TemplatedMixin.js", "dijit\/_WidgetBase.js", "dijit\/layout\/BorderContainer.js", "dijit\/layout\/LayoutContainer.js", "dijit\/layout\/SplitContainer.js", "dijit\/layout\/StackContainer.js", "dojox\/mobile\/common.js", "dojox\/mobile\/i18n.js", "dojox\/mvc\/Group.js", "dojox\/mvc\/Output.js", "dojox\/mvc\/_Container.js" ], "provides": [ "dijit._FocusMixin", "dijit._Templated", "dijit._TemplatedMixin", "dijit._WidgetBase", "dijit.layout.BorderContainer", "dijit.layout.LayoutContainer", "dijit.layout.SplitContainer", "dijit.layout.StackContainer", "dojox.mobile.common", "dojox.mobile.i18n", "dojox.mvc.Group", "dojox.mvc.Output", "dojox.mvc._Container" ], "type": "Function", "classlike": true, "superclass": "dojo.Stateful", "private": true, "summary": "Future base class for all Dijit widgets.", "description": "Future base class for all Dijit widgets.\n_Widget extends this class adding support for various features needed by desktop.\n\nProvides stubs for widget lifecycle methods for subclasses to extend, like postMixInProperties(), buildRendering(),\npostCreate(), startup(), and destroy(), and also public API methods like set(), get(), and watch().\n\nWidgets can provide custom setters\/getters for widget attributes, which are called automatically by set(name, value).\nFor an attribute XXX, define methods _setXXXAttr() and\/or _getXXXAttr().\n\n_setXXXAttr can also be a string\/hash\/array mapping from a widget attribute XXX to the widget's DOMNodes:\n\n- DOM node attribute\n\t\t_setFocusAttr: {node: \"focusNode\", type: \"attribute\"}\n\t\t_setFocusAttr: \"focusNode\"\t(shorthand)\n\t\t_setFocusAttr: \"\"\t\t(shorthand, maps to this.domNode)\nMaps this.focus to this.focusNode.focus, or (last example) this.domNode.focus\n\n- DOM node innerHTML\n\t\t_setTitleAttr: { node: \"titleNode\", type: \"innerHTML\" }\nMaps this.title to this.titleNode.innerHTML\n\n- DOM node innerText\n\t\t_setTitleAttr: { node: \"titleNode\", type: \"innerText\" }\nMaps this.title to this.titleNode.innerText\n\n- DOM node CSS class\n\t\t_setMyClassAttr: { node: \"domNode\", type: \"class\" }\nMaps this.myClass to this.domNode.className\n\nIf the value of _setXXXAttr is an array, then each element in the array matches one of the\nformats of the above list.\n\nIf the custom setter is null, no action is performed other than saving the new value\nin the widget (in this).\n\nIf no custom setter is defined for an attribute, then it will be copied\nto this.focusNode (if the widget defines a focusNode), or this.domNode otherwise.\nThat's only done though for attributes that match DOMNode attributes (title,\nalt, aria-labelledby, etc.)", "mixins": { "instance": [ { "scope": "instance", "location": "dojo.Stateful" } ] }, "properties": [ { "name": "prototype", "scope": "normal", "type": null }, { "name": "constructor", "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "scope": "prototype", "type": null }, { "name": "_setClassAttr", "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "scope": "prototype", "type": "Object", "private": true } ], "methods": [ { "constructor": "constructor", "parameters": [ { "name": "params", "type": "Object", "usage": "optional" }, { "name": "srcNodeRef", "type": "DomNode|String", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "unsubscribe", "scope": "prototype", "summary": "Unsubscribes handle created by this.subscribe.\nAlso removes handle from this widget's list of subscriptions", "parameters": [ { "name": "handle", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "uninitialize", "scope": "prototype", "summary": "Stub function. Override to implement custom widget tear-down\nbehavior." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "toString", "scope": "prototype", "summary": "Returns a string that represents the widget", "description": "When a widget is cast to a string, this method will be used to generate the\noutput. Currently, it does not implement any sort of reversible\nserialization.", "return-types": [ { "type": "String" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "subscribe", "scope": "prototype", "summary": "Subscribes to the specified topic and calls the specified method\nof this object and registers for unsubscribe() on widget destroy.", "description": "Provide widget-specific analog to dojo.subscribe, except with the\nimplicit use of this widget as the target object.", "examples": { "example": "\tvar btn = new dijit.form.Button();\n\t\/\/ when \/my\/topic is published, this button changes its label to\n \/\/ be the parameter of the topic.\n\tbtn.subscribe(\"\/my\/topic\", function(v){\n\t\tthis.set(\"label\", v);\n\t});" }, "parameters": [ { "name": "topic", "type": "String", "usage": "required" }, { "name": "method", "type": "String|Function", "usage": "required" } ], "return-types": [ { "type": "_Widget.Handle" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "startup", "scope": "prototype", "summary": "Processing after the DOM fragment is added to the document", "description": "Called after a widget and its children have been created and added to the page,\nand all related widgets have finished their create() cycle, up through postCreate().\nThis is useful for composite widgets that need to control or layout sub-widgets.\nMany layout widgets can use this as a wiring phase." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "set", "scope": "prototype", "summary": "Set a property on a widget", "description": "Sets named properties on a widget which may potentially be handled by a\nsetter in the widget.\nFor example, if the widget has a properties \"foo\"\nand \"bar\" and a method named \"_setFooAttr\", calling:\n\tmyWidget.set(\"foo\", \"Howdy!\");\nwould be equivalent to writing:\n\twidget._setFooAttr(\"Howdy!\");\nand:\n\tmyWidget.set(\"bar\", 3);\nwould be equivalent to writing:\n\twidget.bar = 3;\n\nset() may also be called with a hash of name\/value pairs, ex:\n\tmyWidget.set({\n\t\tfoo: \"Howdy\",\n\t\tbar: 3\n\t})\nThis is equivalent to calling set(foo, \"Howdy\") and set(bar, 3)", "parameters": [ { "name": "name", "type": "The", "usage": "required", "summary": "property to set." }, { "name": "value", "type": "The", "usage": "required", "summary": "value to set in the property." } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "postscript", "constructor": "postscript", "scope": "prototype", "private": true, "summary": "Kicks off widget instantiation. See create() for details.", "parameters": [ { "name": "params", "type": "Object", "usage": "optional" }, { "name": "srcNodeRef", "type": "DomNode|String", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "postMixInProperties", "scope": "prototype", "summary": "Called after the parameters to the widget have been read-in,\nbut before the widget template is instantiated. Especially\nuseful to set properties that are referenced in the widget\ntemplate." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "postCreate", "scope": "prototype", "summary": "Processing after the DOM fragment is created", "description": "Called after the DOM fragment has been created, but not necessarily\nadded to the document. Do not include any operations which rely on\nnode dimensions or placement." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "placeAt", "scope": "prototype", "summary": "Place this widget's domNode reference somewhere in the DOM based\non standard dojo.place conventions, or passing a Widget reference that\ncontains and addChild member.", "description": "A convenience function provided in all _Widgets, providing a simple\nshorthand mechanism to put an existing (or newly created) Widget\nsomewhere in the dom, and allow chaining.", "examples": [ " \t\/\/ create a Button with no srcNodeRef, and place it in the body:\n \tvar button = new dijit.form.Button({ label:\"click\" }).placeAt(dojo.body());\n \t\/\/ now, 'button' is still the widget reference to the newly created button\n \tdojo.connect(button, \"onClick\", function(e){ console.log('click'); });", "\t\/\/ create a button out of a node with id=\"src\" and append it to id=\"wrapper\":\n \tvar button = new dijit.form.Button({},\"src\").placeAt(\"wrapper\");", "\t\/\/ place a new button as the first element of some div\n\tvar button = new dijit.form.Button({ label:\"click\" }).placeAt(\"wrapper\",\"first\");", "\t\/\/ create a contentpane and add it to a TabContainer\n\tvar tc = dijit.byId(\"myTabs\");\n\tnew dijit.layout.ContentPane({ href:\"foo.html\", title:\"Wow!\" }).placeAt(tc)" ], "return-description": "dijit._Widget\nProvides a useful return of the newly created dijit._Widget instance so you\ncan \"chain\" this function by instantiating, placing, then saving the return value\nto a variable.", "parameters": [ { "name": "reference", "type": "String|DomNode|_Widget", "usage": "required", "summary": "The String id of a domNode, a domNode reference, or a reference to a Widget possessing\nan addChild method." }, { "name": "position", "type": "String|Int", "usage": "optional", "summary": "If passed a string or domNode reference, the position argument\naccepts a string just as dojo.place does, one of: "first", "last",\n"before", or "after".\n\nIf passed a _Widget reference, and that widget reference has an ".addChild" method,\nit will be called passing this widget instance into that method, supplying the optional\nposition index passed." } ] }, { "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "name": "onFocus", "scope": "prototype", "tags": "callback", "summary": "Called when the widget becomes "active" because\nit or a widget inside of it either has focus, or has recently\nbeen clicked." }, { "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "name": "onBlur", "scope": "prototype", "tags": "callback", "summary": "Called when the widget stops being "active" because\nfocus moved to something outside of it, or the user\nclicked somewhere outside of it, or the widget was\nhidden." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "on", "scope": "prototype", "summary": "Call specified function when event "type" occurs, ex: myWidget.on("click", function(){ ... }).", "description": "Call specified function when event \"type\" occurs, ex: myWidget.on(\"click\", function(){ ... }).\nIt's also implicitly called from dojo.connect(myWidget, \"onClick\", ...).\nNote that the function is not run in any particular scope, so if (for example) you want it to run in the\nwidget's scope you must do myWidget.on(\"click\", dojo.hitch(myWidget, func)).", "parameters": [ { "name": "type", "type": "String", "usage": "required" }, { "name": "func", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "isLeftToRight", "scope": "prototype", "summary": "Return this widget's explicit or implicit orientation (true for LTR, false for RTL)", "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "isFocusable", "scope": "prototype", "summary": "Return true if this widget can currently be focused\nand false if not" }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "getTextDir", "scope": "prototype", "tags": "protected.", "summary": "Return direction of the text.\nThe function overridden in the _BidiSupport module,\nits main purpose is to calculate the direction of the\ntext, if was defined by the programmer through textDir.", "parameters": [ { "name": "text", "type": "String", "usage": "required" }, { "name": "originalDir", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "getDescendants", "scope": "prototype", "summary": "Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.\nThis method should generally be avoided as it returns widgets declared in templates, which are\nsupposed to be internal\/hidden, but it's left here for back-compat reasons.", "return-types": [ { "type": "dijit._Widget[]" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "getChildren", "scope": "prototype", "summary": "Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode.\nDoes not return nested widgets, nor widgets that are part of this widget's template.", "return-types": [ { "type": "dijit._Widget[]" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "get", "scope": "prototype", "summary": "Get a property from a widget.", "description": "Get a named property from a widget. The property may\npotentially be retrieved via a getter method. If no getter is defined, this\njust retrieves the object's property.\nFor example, if the widget has a properties \"foo\"\nand \"bar\" and a method named \"_getFooAttr\", calling:\n\tmyWidget.get(\"foo\");\nwould be equivalent to writing:\n\twidget._getFooAttr();\nand:\n\tmyWidget.get(\"bar\");\nwould be equivalent to writing:\n\twidget.bar;", "parameters": [ { "name": "name", "type": "The", "usage": "required", "summary": "property to get." } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "disconnect", "scope": "prototype", "summary": "Disconnects handle created by `connect`.\nAlso removes handle from this widget's list of connects.", "parameters": [ { "name": "handle", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "destroyRendering", "scope": "prototype", "summary": "Destroys the DOM nodes associated with this widget", "parameters": [ { "name": "preserveDom", "type": "Boolean", "usage": "optional", "summary": "If true, this method will leave the original DOM structure alone\nduring tear-down. Note: this will not work with _Templated\nwidgets yet." } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "destroyRecursive", "scope": "prototype", "summary": "Destroy this widget and its descendants", "description": "This is the generic \"destructor\" function that all widget users\nshould call to cleanly discard with a widget. Once a widget is\ndestroyed, it is removed from the manager object.", "parameters": [ { "name": "preserveDom", "type": "Boolean", "usage": "optional", "summary": "If true, this method will leave the original DOM structure\nalone of descendant Widgets. Note: This will NOT work with\ndijit._Templated widgets." } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "destroyDescendants", "scope": "prototype", "summary": "Recursively destroy the children of this widget and their\ndescendants.", "parameters": [ { "name": "preserveDom", "type": "Boolean", "usage": "optional", "summary": "If true, the preserveDom attribute is passed to all descendant\nwidget's .destroy() method. Not for use with _Templated\nwidgets." } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "destroy", "scope": "prototype", "summary": "Destroy this widget, but not its descendants.\nThis method will, however, destroy internal widgets such as those used within a template.", "parameters": [ { "name": "preserveDom", "type": "Boolean", "usage": "required", "summary": "If true, this method will leave the original DOM structure alone.\nNote: This will not yet work with _Templated widgets" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "create", "scope": "prototype", "private": true, "summary": "Kick off the life-cycle of a widget", "description": "Create calls a number of widget methods (postMixInProperties, buildRendering, postCreate,\netc.), some of which of you'll want to override. See http:\/\/docs.dojocampus.org\/dijit\/_Widget\nfor a discussion of the widget creation lifecycle.\n\nOf course, adventurous developers could override create entirely, but this should\nonly be done as a last resort.", "parameters": [ { "name": "params", "type": "Object", "usage": "optional", "summary": "Hash of initialization parameters for widget, including\nscalar values (like title, duration etc.) and functions,\ntypically callbacks like onClick." }, { "name": "srcNodeRef", "type": "DomNode|String", "usage": "optional", "summary": "If a srcNodeRef (DOM node) is specified:\n- use srcNodeRef.innerHTML as my contents\n- if this is a behavioral widget then apply behavior\nto that srcNodeRef\n- otherwise, replace srcNodeRef with my generated DOM\ntree" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "connect", "scope": "prototype", "summary": "Connects specified obj\/event to specified method of this object\nand registers for disconnect() on widget destroy.", "description": "Provide widget-specific analog to dojo.connect, except with the\nimplicit use of this widget as the target object.\nEvents connected with `this.connect` are disconnected upon\ndestruction.", "examples": { "example": "\tvar btn = new dijit.form.Button();\n\t\/\/ when foo.bar() is called, call the listener we're going to\n\t\/\/ provide in the scope of btn\n\tbtn.connect(foo, \"bar\", function(){\n\t\tconsole.debug(this.toString());\n\t});" }, "return-description": "A handle that can be passed to `disconnect` in order to disconnect before\nthe widget is destroyed.", "parameters": [ { "name": "obj", "type": "Object|null", "usage": "required" }, { "name": "event", "type": "String|Function", "usage": "required" }, { "name": "method", "type": "String|Function", "usage": "required" } ], "return-types": [ { "type": "_Widget.Handle" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "buildRendering", "scope": "prototype", "summary": "Construct the UI for this widget, setting this.domNode.\nMost widgets will mixin `dijit._TemplatedMixin`, which implements this method." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "applyTextDir", "scope": "prototype", "tags": "protected.", "summary": "The function overridden in the _BidiSupport module,\noriginally used for setting element.dir according to this.textDir.\nIn this case does nothing.", "parameters": [ { "name": "element", "type": "Object", "usage": "required" }, { "name": "text", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "_setStyleAttr", "scope": "prototype", "summary": "Sets the style attribute of the widget according to value,\nwhich is either a hash like {height: "5px", width: "3px"}\nor a plain string", "description": "Determines which node to set the style on based on style setting\nin attributeMap.", "parameters": [ { "name": "value", "type": "String||Object", "usage": "required" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "_set", "scope": "prototype", "private": true, "summary": "Helper function to set new value for specified attribute, and call handlers\nregistered with watch() if the value has changed.", "parameters": [ { "name": "name", "type": "String", "usage": "required" }, { "name": "value", "type": "anything", "usage": "required" } ] }, { "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "name": "_onFocus", "scope": "prototype", "summary": "This is where widgets do processing for when they are active,\nsuch as changing CSS classes. See onFocus() for more details.", "parameters": [ { "name": "e", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "name": "_onBlur", "scope": "prototype", "summary": "This is where widgets do processing for when they stop being active,\nsuch as changing CSS classes. See onBlur() for more details." }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "_getAttrNames", "scope": "prototype", "private": true, "summary": "Helper function for get() and set().\nCaches attribute name values so we don't do the string ops every time.", "parameters": [ { "name": "name", "type": null, "usage": "required" } ] }, { "resources": [ "dojox\/mobile\/common.js", "dojox\/mobile\/i18n.js" ], "provides": [ "dojox.mobile.common", "dojox.mobile.i18n" ], "name": "_cv", "scope": "prototype", "private": true, "parameters": [ { "name": "s", "type": null, "usage": "required" } ], "return-types": [ { "type": "convert the given string" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "_attrToDom", "scope": "prototype", "private": true, "summary": "Reflect a widget attribute (title, tabIndex, duration etc.) to\nthe widget DOM, as specified by commands parameter.\nIf commands isn't specified then it's looked up from attributeMap.\nNote some attributes like "type"\ncannot be processed this way as they are not mutable.", "parameters": [ { "name": "attr", "type": "String", "usage": "required" }, { "name": "value", "type": "String", "usage": "required" }, { "name": "commands", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "name": "_applyAttributes", "scope": "prototype", "private": true, "summary": "Step during widget creation to copy widget attributes to the\nDOM according to attributeMap and _setXXXAttr objects, and also to call\ncustom _setXXXAttr() methods.\n\nSkips over blank\/false attribute values, unless they were explicitly specified\nas parameters to the widget, since those are the default anyway,\nand setting tabIndex="" is different than not setting tabIndex at all.\n\nFor backwards-compatibility reasons attributeMap overrides _setXXXAttr when\n_setXXXAttr is a hash\/string\/array, but _setXXXAttr as a functions override attributeMap." } ] }, "dijit._FocusMixin": { "location": "dijit._FocusMixin", "resources": [ "dijit\/_FocusMixin.js" ], "provides": [ "dijit._FocusMixin" ], "type": "Function", "classlike": true, "summary": "Mixin to widget to provide _onFocus() and _onBlur() methods that\nfire when a widget or it's descendants get\/lose focus", "methods": [ { "constructor": "constructor" } ] }, "dijit._HasDropDown": { "location": "dijit._HasDropDown", "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "type": "Function", "classlike": true, "superclass": "dijit._FocusMixin", "summary": "Mixin for widgets that need drop down ability.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._FocusMixin" } ] }, "properties": [ { "name": "dropDownPosition", "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "scope": "prototype", "type": "String[]", "tags": "const", "summary": "This variable controls the position of the drop down.\nIt's an array of strings with the following values:\n\n* before: places drop down to the left of the target node\/widget, or to the right in\nthe case of RTL scripts like Hebrew and Arabic\n* after: places drop down to the right of the target node\/widget, or to the left in\nthe case of RTL scripts like Hebrew and Arabic\n* above: drop down goes above target node\n* below: drop down goes below target node\n\nThe list is positions is tried, in order, until a position is found where the drop down fits\nwithin the viewport." }, { "name": "dropDown", "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "scope": "prototype", "type": "Widget", "summary": "The widget to display as a popup. This widget *must* be\ndefined before the startup function is called." } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "toggleDropDown", "scope": "prototype", "summary": "Callback when the user presses the down arrow button or presses\nthe down arrow key to open\/close the drop down.\nToggle the drop-down widget; if it is up, close it, if not, open it" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "postCreate", "scope": "prototype", "summary": "set up nodes and connect our mouse and keypress events" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "openDropDown", "scope": "prototype", "summary": "Opens the dropdown for this widget. To be called only when this.dropDown\nhas been created and is ready to display (ie, it's data is loaded).", "return-description": "return value of dijit.popup.open()" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "loadDropDown", "scope": "prototype", "summary": "Loads the data for the dropdown, and at some point, calls\nthe given callback. This is basically a callback when the\nuser presses the down arrow button to open the drop down.", "parameters": [ { "name": "loadCallback", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "isLoaded", "scope": "prototype", "summary": "Returns whether or not the dropdown is loaded. This can\nbe overridden in order to force a call to loadDropDown()." }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "destroy", "scope": "prototype" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "closeDropDown", "scope": "prototype", "summary": "Closes the drop down on this widget", "parameters": [ { "name": "focus", "type": "Boolean", "usage": "required", "summary": "If true, refocuses the button widget" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "buildRendering", "scope": "prototype" }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onKeyUp", "scope": "prototype", "private": true }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onKey", "scope": "prototype", "private": true, "summary": "Callback when the user presses a key while focused on the button node", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onDropDownMouseUp", "scope": "prototype", "private": true, "summary": "Callback when the user lifts their mouse after mouse down on the arrow icon.\nIf the drop down is a simple menu and the mouse is over the menu, we execute it, otherwise, we focus our\ndrop down widget. If the event is missing, then we are not\na mouseup event.\n\nThis is useful for the common mouse movement pattern\nwith native browser <select> nodes:\n1. mouse down on the select node (probably on the arrow)\n2. move mouse to a menu item while holding down the mouse button\n3. mouse up. this selects the menu item as though the user had clicked it.", "parameters": [ { "name": "e", "type": "Event", "usage": "optional" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onDropDownMouseDown", "scope": "prototype", "private": true, "summary": "Callback when the user mousedown's on the arrow icon", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onDropDownClick", "scope": "prototype", "private": true, "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "name": "_onBlur", "scope": "prototype", "private": true, "summary": "Called magically when focus has shifted away from this widget and it's dropdown" } ] }, "dijit._HasDropDown.dropDownPosition": { "location": "dijit._HasDropDown.dropDownPosition", "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "type": "String[]", "tags": "const", "summary": "This variable controls the position of the drop down.\nIt's an array of strings with the following values:\n\n* before: places drop down to the left of the target node\/widget, or to the right in\nthe case of RTL scripts like Hebrew and Arabic\n* after: places drop down to the right of the target node\/widget, or to the left in\nthe case of RTL scripts like Hebrew and Arabic\n* above: drop down goes above target node\n* below: drop down goes below target node\n\nThe list is positions is tried, in order, until a position is found where the drop down fits\nwithin the viewport." }, "dijit._HasDropDown.dropDown": { "location": "dijit._HasDropDown.dropDown", "resources": [ "dijit\/_HasDropDown.js" ], "provides": [ "dijit._HasDropDown" ], "type": "Widget", "summary": "The widget to display as a popup. This widget *must* be\ndefined before the startup function is called." }, "dijit._KeyNavContainer": { "location": "dijit._KeyNavContainer", "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "type": "Function", "classlike": true, "superclass": "dijit._Container", "summary": "A _Container with keyboard navigation of its children.", "description": "To use this mixin, call connectKeyNavHandlers() in\npostCreate().\nIt provides normalized keyboard and focusing code for Container\nwidgets.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._FocusMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Container" }, { "scope": "instance", "location": "dijit._FocusMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "startupKeyNavChildren", "scope": "prototype" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "startup", "scope": "prototype" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focusPrev", "scope": "prototype", "summary": "Focus the last focusable node in the previous widget\n(ex: go to the ComboButton icon section rather than button section)" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focusNext", "scope": "prototype", "summary": "Focus the next widget" }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focusLastChild", "scope": "prototype", "summary": "Focus the last focusable child in the container." }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focusFirstChild", "scope": "prototype", "summary": "Focus the first focusable child in the container." }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focusChild", "scope": "prototype", "summary": "Focus specified child widget.", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required", "summary": "Reference to container's child widget" }, { "name": "last", "type": "Boolean", "usage": "required", "summary": "If true and if widget has multiple focusable nodes, focus the\nlast one instead of the first one" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "focus", "scope": "prototype", "summary": "Default focus() implementation: focus the first child." }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "connectKeyNavHandlers", "scope": "prototype", "summary": "Call in postCreate() to attach the keyboard handlers\nto the container.\npreKeyCodes: dojo.keys[]\nKey codes for navigating to the previous child.", "parameters": [ { "name": "prevKeyCodes", "type": "dojo.keys[]", "usage": "required" }, { "name": "nextKeyCodes", "type": "dojo.keys[]", "usage": "required", "summary": "Key codes for navigating to the next child." } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "addChild", "scope": "prototype", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required" }, { "name": "insertIndex", "type": "int", "usage": "optional" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_startupChild", "scope": "prototype", "private": true, "summary": "Setup for each child widget", "description": "Sets tabIndex=-1 on each child, so that the tab key will\nleave the container rather than visiting each child.", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_onContainerKeypress", "scope": "prototype", "private": true, "summary": "When a key is pressed, if it's an arrow key etc. then\nit's handled here.", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_onContainerFocus", "scope": "prototype", "private": true, "summary": "Handler for when the container gets focus", "description": "Initially the container itself has a tabIndex, but when it gets\nfocus, switch focus to first child...", "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_onChildBlur", "scope": "prototype", "summary": "Called when focus leaves a child widget to go\nto a sibling widget.\nUsed by MenuBase.js (TODO: move code there)", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_onBlur", "scope": "prototype", "private": true, "parameters": [ { "name": "evt", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_getNextFocusableChild", "scope": "prototype", "private": true, "summary": "Returns the next or previous focusable child, compared\nto "child"", "parameters": [ { "name": "child", "type": "Widget", "usage": "required", "summary": "The current widget" }, { "name": "dir", "type": "Integer", "usage": "required", "summary": "* 1 = after\n* -1 = before" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_getLastFocusableChild", "scope": "prototype", "private": true, "summary": "Returns last child that can be focused", "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_KeyNavContainer.js" ], "provides": [ "dijit._KeyNavContainer" ], "name": "_getFirstFocusableChild", "scope": "prototype", "private": true, "summary": "Returns first child that can be focused", "return-types": [ { "type": "dijit._Widget" } ] } ] }, "dijit._MenuBase": { "location": "dijit._MenuBase", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "Base class for Menu and MenuBar", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" }, { "scope": "prototype", "location": "dijit._KeyNavContainer.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._KeyNavContainer" } ] }, "properties": [ { "name": "focusedChild", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "scope": "prototype", "type": "Object" }, { "name": "currentPopup", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "scope": "prototype", "type": "Object" } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onOpen", "scope": "prototype", "private": true, "summary": "Callback when this menu is opened.\nThis is called by the popup manager as notification that the menu\nwas opened.", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onItemUnhover", "scope": "prototype", "summary": "Callback fires when mouse exits a MenuItem", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onItemHover", "scope": "prototype", "summary": "Called when cursor is over a MenuItem.", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onItemClick", "scope": "prototype", "private": true, "summary": "Handle clicks on an item.", "parameters": [ { "name": "item", "type": "dijit._Widget", "usage": "required" }, { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onExecute", "scope": "prototype", "summary": "Attach point for notification about when a menu item has been executed.\nThis is an internal mechanism used for Menus to signal to their parent to\nclose them, because they are about to execute the onClick handler. In\ngeneral developers should not attach to or override this method." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onClose", "scope": "prototype", "private": true, "summary": "Callback when this menu is closed.\nThis is called by the popup manager as notification that the menu\nwas closed." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "onCancel", "scope": "prototype", "summary": "Attach point for notification about when the user cancels the current menu\nThis is an internal mechanism used for Menus to signal to their parent to\nclose them. In general developers should not attach to or override this method.", "parameters": [ { "name": "closeAll", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_stopPopupTimer", "scope": "prototype", "private": true, "summary": "Cancels the popup timer because the user has stop hovering\non the MenuItem, etc." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_stopPendingCloseTimer", "scope": "prototype", "private": true, "summary": "Cancels the pending-close timer because the close has been preempted", "parameters": [ { "name": "popup", "type": "dijit._Widget", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_stopFocusTimer", "scope": "prototype", "private": true, "summary": "Cancels the pending-focus timer because the menu was closed before focus occured" }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_openPopup", "scope": "prototype", "summary": "Open the popup to the side of\/underneath the current menu item", "return-types": [ { "type": "the focused child lost focus since the timer was started" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_onPopupHover", "scope": "prototype", "private": true, "summary": "This handler is called when the mouse moves over the popup.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_onItemFocus", "scope": "prototype", "private": true, "summary": "Called when child of this Menu gets focus from:\n1) clicking it\n2) tabbing into it\n3) being opened by a parent menu.\nThis is not called just from mouse hover.", "parameters": [ { "name": "item", "type": "MenuItem", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_onChildBlur", "scope": "prototype", "private": true, "summary": "Called when a child MenuItem becomes inactive because focus\nhas been removed from the MenuItem *and* it's descendant menus.", "parameters": [ { "name": "item", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_onBlur", "scope": "prototype", "summary": "Called when focus is moved away from this Menu and it's submenus." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_moveToPopup", "scope": "prototype", "private": true, "summary": "This handles the right arrow key (left arrow key on RTL systems),\nwhich will either open a submenu, or move to the next item in the\nancestor MenuBar", "parameters": [ { "name": "evt", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_markInactive", "scope": "prototype", "private": true, "summary": "Mark this menu's state as inactive." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_markActive", "scope": "prototype", "private": true, "summary": "Mark this menu's state as active.\nCalled when this Menu gets focus from:\n1) clicking it (mouse or via space\/arrow key)\n2) being opened by a parent menu.\nThis is not called just from mouse hover.\nFocusing a menu via TAB does NOT automatically set isActive\nsince TAB is a navigation operation and not a selection one.\nFor Windows apps, pressing the ALT key focuses the menubar\nmenus (similar to TAB navigation) but the menu is not active\n(ie no dropdown) until an item is clicked." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_getTopMenu", "scope": "prototype", "private": true, "summary": "Returns the top menu in this chain of Menus" }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_closeChild", "scope": "prototype", "private": true, "summary": "Called when submenu is clicked or focus is lost. Close hierarchy of menus." }, { "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "name": "_cleanUp", "scope": "prototype", "private": true, "summary": "Called when the user is done with this menu. Closes hierarchy of menus." } ] }, "dijit._MenuBase.currentPopup": { "location": "dijit._MenuBase.currentPopup", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "properties": [ { "name": "parentMenu", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "scope": "prototype", "type": null } ] }, "dijit._MenuBase.currentPopup.parentMenu": { "location": "dijit._MenuBase.currentPopup.parentMenu", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "type": null }, "dijit._MenuBase.focusedChild": { "location": "dijit._MenuBase.focusedChild", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "properties": [ { "name": "popup", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "scope": "prototype", "type": null } ] }, "dijit._MenuBase.focusedChild.popup": { "location": "dijit._MenuBase.focusedChild.popup", "resources": [ "dijit\/_MenuBase.js" ], "provides": [ "dijit._MenuBase" ], "type": null }, "dijit._OnDijitClickMixin": { "location": "dijit._OnDijitClickMixin", "resources": [ "dijit\/_OnDijitClickMixin.js" ], "provides": [ "dijit._OnDijitClickMixin" ], "type": "Function", "classlike": true, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_OnDijitClickMixin.js" ], "provides": [ "dijit._OnDijitClickMixin" ], "name": "connect", "scope": "prototype", "summary": "Connects specified obj\/event to specified method of this object\nand registers for disconnect() on widget destroy.", "description": "Provide widget-specific analog to dojo.connect, except with the\nimplicit use of this widget as the target object.\nThis version of connect also provides a special \"ondijitclick\"\nevent which triggers on a click or space or enter keyup.\nEvents connected with `this.connect` are disconnected upon\ndestruction.", "examples": { "example": "\tvar btn = new dijit.form.Button();\n\t\/\/ when foo.bar() is called, call the listener we're going to\n\t\/\/ provide in the scope of btn\n\tbtn.connect(foo, \"bar\", function(){\n\t\tconsole.debug(this.toString());\n\t});" }, "return-description": "A handle that can be passed to `disconnect` in order to disconnect before\nthe widget is destroyed.", "parameters": [ { "name": "obj", "type": "Object|null", "usage": "required" }, { "name": "event", "type": "String|Function", "usage": "required" }, { "name": "method", "type": "String|Function", "usage": "required" } ] } ] }, "dijit._PaletteMixin": { "location": "dijit._PaletteMixin", "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "type": "Function", "classlike": true, "superclass": "dijit._CssStateMixin", "summary": "A keyboard accessible palette, for picking a color\/emoticon\/etc.", "description": "A mixin for a grid showing various entities, so the user can pick a certain entity.", "mixins": { "instance": [ { "scope": "instance", "location": "dijit._CssStateMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "onChange", "scope": "prototype", "summary": "Callback when a cell is selected.", "parameters": [ { "name": "value", "type": "String", "usage": "required", "summary": "Value corresponding to cell." } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "focus", "scope": "prototype", "summary": "Focus this widget. Puts focus on the most recently focused cell." }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_setValueAttr", "scope": "prototype", "summary": "This selects a cell. It triggers the onChange event.", "parameters": [ { "name": "value", "type": "String", "usage": "required", "summary": "value of the cell to select" }, { "name": "priorityChange", "type": "Optional", "usage": "required", "summary": "parameter used to tell the select whether or not to fire\nonChange event." } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_setCurrent", "scope": "prototype", "summary": "Sets which node is the focused cell.", "description": "At any point in time there's exactly one\ncell with tabIndex != -1. If focus is inside the palette then\nfocus is on that cell.\n\nAfter calling this method, arrow key handlers and mouse click handlers\nshould focus the cell in a setTimeout().", "parameters": [ { "name": "node", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_preparePalette", "scope": "prototype", "private": true, "summary": "Subclass must call _preparePalette() from postCreate(), passing in the tooltip\nfor each cell", "parameters": [ { "name": "choices", "type": "String[][]", "usage": "required", "summary": "id's for each cell of the palette, used to create Dye JS object for each cell" }, { "name": "titles", "type": "String[]", "usage": "required", "summary": "Localized tooltip for each cell" }, { "name": "dyeClassObj", "type": "Constructor", "usage": "optional", "summary": "If specified, use this constructor rather than this.dyeClass" } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_onCellClick", "scope": "prototype", "private": true, "summary": "Handler for click, enter key & space key. Selects the cell.", "parameters": [ { "name": "evt", "type": "Event", "usage": "required", "summary": "The event." } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_navigateByKey", "scope": "prototype", "private": true, "summary": "This is the callback for typematic.\nIt changes the focus and the highlighed cell.", "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." } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "_getDye", "scope": "prototype", "private": true, "summary": "Get JS object for given cell DOMNode", "parameters": [ { "name": "cell", "type": "DomNode", "usage": "required" } ] } ] }, "dijit.Dye": { "location": "dijit.Dye", "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "type": "Function", "classlike": true, "summary": "Interface for the JS Object associated with a palette cell (i.e. DOMNode)", "methods": [ { "constructor": "constructor", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": null, "usage": "required" }, { "name": "col", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "getValue", "scope": "prototype", "summary": "Return "value" of cell; meaning of "value" varies by subclass.", "description": "For example color hex value, emoticon ascii value etc, entity hex value." }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "fillCell", "scope": "prototype", "summary": "Add cell DOMNode inner structure", "parameters": [ { "name": "cell", "type": "DomNode", "usage": "required", "summary": "The surrounding cell" }, { "name": "blankGif", "type": "String", "usage": "required", "summary": "URL for blank cell image" } ] }, { "resources": [ "dijit\/_PaletteMixin.js" ], "provides": [ "dijit._PaletteMixin" ], "name": "constructor", "scope": "prototype", "summary": "Initialize according to value or alias like "white"", "parameters": [ { "name": "alias", "type": "String", "usage": "required" }, { "name": "row", "type": null, "usage": "required" }, { "name": "col", "type": null, "usage": "required" } ] } ] }, "dijit._Templated": { "location": "dijit._Templated", "resources": [ "dijit\/_Templated.js" ], "provides": [ "dijit._Templated" ], "type": "Function", "classlike": true, "superclass": "dijit._TemplatedMixin", "summary": "Deprecated mixin for widgets that are instantiated from a template.\nWidgets should use _TemplatedMixin plus if necessary _WidgetsInTemplateMixin instead.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._WidgetsInTemplateMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._TemplatedMixin" }, { "scope": "instance", "location": "dijit._WidgetsInTemplateMixin" } ] }, "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_Templated.js" ], "provides": [ "dijit._Templated" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/_Templated.js" ], "provides": [ "dijit._Templated" ], "name": "_attachTemplateNodes", "scope": "prototype", "private": true, "parameters": [ { "name": "rootNode", "type": null, "usage": "required" }, { "name": "getAttrFunc", "type": null, "usage": "required" } ] } ] }, "dijit._TemplatedMixin": { "location": "dijit._TemplatedMixin", "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "type": "Function", "classlike": true, "summary": "Mixin for widgets that are instantiated from a template", "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "getCachedTemplate", "scope": "normal", "summary": "Static method to get a template based on the templatePath or\ntemplateString key", "return-description": "Mixed\nEither string (if there are ${} variables that need to be replaced) or just\na DOM tree (if the node can be cloned directly)", "parameters": [ { "name": "templateString", "type": "String", "usage": "required", "summary": "The template" }, { "name": "alwaysUseString", "type": "Boolean", "usage": "required", "summary": "Don't cache the DOM tree for this template, even if it doesn't have any variables" } ], "return-types": [ { "type": "String" }, { "type": "Node" } ] }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "destroyRendering", "scope": "prototype" }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "buildRendering", "scope": "prototype", "summary": "Construct the UI for this widget from a template, setting this.domNode." }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "_stringRepl", "scope": "prototype", "private": true, "summary": "Does substitution of ${foo} type properties in template string", "parameters": [ { "name": "tmpl", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "_fillContent", "scope": "prototype", "summary": "Relocate source contents to templated container node.\nthis.containerNode must be able to receive children, or exceptions will be thrown.", "parameters": [ { "name": "source", "type": "DomNode", "usage": "required" } ] }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "_beforeFillContent", "scope": "prototype", "private": true }, { "resources": [ "dijit\/_TemplatedMixin.js" ], "provides": [ "dijit._TemplatedMixin" ], "name": "_attachTemplateNodes", "scope": "prototype", "private": true, "summary": "Iterate through the template and attach functions and nodes accordingly.\nAlternately, if rootNode is an array of widgets, then will process dojoAttachPoint\netc. for those widgets.", "description": "Map widget properties and functions to the handlers specified in\nthe dom node and it's descendants. This function iterates over all\nnodes and looks for these properties:\n* dojoAttachPoint\/data-dojo-attach-point\n* dojoAttachEvent\/data-dojo-attach-event", "parameters": [ { "name": "rootNode", "type": "DomNode|Widget[]", "usage": "required", "summary": "the node to search for properties. All children will be searched." }, { "name": "getAttrFunc", "type": "Function", "usage": "required", "summary": "a function which will be used to obtain property for a given\nDomNode\/Widget" } ] } ] }, "dijit._TimePicker": { "location": "dijit._TimePicker", "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "type": "Function", "classlike": true, "superclass": "dijit._Widget", "summary": "A graphical time picker.\nThis widget is used internally by other widgets and is not available\nas a standalone widget due to lack of accessibility support.", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._TemplatedMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._Widget" }, { "scope": "instance", "location": "dijit._TemplatedMixin" } ] }, "properties": [ { "name": "timeMenu", "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "scope": "prototype", "type": null } ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "setValue", "scope": "prototype", "summary": "Deprecated. Used set('value') instead.", "parameters": [ { "name": "value", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "serialize", "scope": "prototype", "summary": "User overridable function used to convert the attr('value') result to a String", "parameters": [ { "name": "val", "type": "Date", "usage": "required", "summary": "The current value" }, { "name": "options", "type": "Object", "usage": "optional" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "postMixInProperties", "scope": "prototype" }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "onmouseover", "scope": "prototype", "private": true, "summary": "Handler for onmouseover event", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "onmouseout", "scope": "prototype", "private": true, "summary": "Handler for onmouseout event", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "onChange", "scope": "prototype", "tags": "public", "summary": "Notification that a time was selected. It may be the same as the previous value.", "parameters": [ { "name": "time", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "isDisabledDate", "scope": "prototype", "summary": "May be overridden to disable certain dates in the TimePicker e.g. `isDisabledDate=dojo.date.locale.isWeekend`\ntype:\nextension", "parameters": [ { "name": "dateObject", "type": "Date", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "handleKey", "scope": "prototype", "summary": "Called from `dijit.form._DateTimeTextBox` to pass a keypress event\nfrom the `dijit.form.TimeTextBox` to be handled in this widget", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ], "return-types": [ { "type": "true means don't call stopEvent()" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_showText", "scope": "prototype", "private": true, "summary": "Displays the relevant choices in the drop down list" }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_setValueAttr", "scope": "prototype", "summary": "Hook so set('value', ...) works.", "description": "Set the value of the TimePicker.\nRedraws the TimePicker around the new date.", "parameters": [ { "name": "date", "type": "Date", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_setFilterStringAttr", "scope": "prototype", "private": true, "summary": "Called by TimeTextBox to filter the values shown in my list", "parameters": [ { "name": "val", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_setConstraintsAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "constraints", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_onOptionSelected", "scope": "prototype", "private": true, "summary": "Called when user clicks an option in the drop down list", "parameters": [ { "name": "tgt", "type": "Object", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_onArrowUp", "scope": "prototype", "private": true, "summary": "Handler for up arrow key.", "description": "Removes the bottom time and add one to the top", "parameters": [ { "name": "count", "type": null, "usage": "required" } ], "return-types": [ { "type": "typematic end" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_onArrowDown", "scope": "prototype", "private": true, "summary": "Handler for up arrow key.", "description": "Remove the top time and add one to the bottom", "parameters": [ { "name": "count", "type": null, "usage": "required" } ], "return-types": [ { "type": "typematic end" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_mouseWheeled", "scope": "prototype", "private": true, "summary": "Handle the mouse wheel events", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_highlightOption", "scope": "prototype", "private": true, "summary": "Turns on\/off highlight effect on a node based on mouse out\/over event", "parameters": [ { "name": "node", "type": "node", "usage": "required" }, { "name": "highlight", "type": "Boolean", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_getFilteredNodes", "scope": "prototype", "private": true, "summary": "Returns an array of nodes with the filter applied. At most maxNum nodes\nwill be returned - but fewer may be returned as well. If the\nbefore parameter is set to true, then it will return the elements\nbefore the given index", "parameters": [ { "name": "start", "type": "number", "usage": "required" }, { "name": "maxNum", "type": "number", "usage": "required" }, { "name": "before", "type": "Boolean", "usage": "required" }, { "name": "lastNode", "type": "DOMnode", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_createOption", "scope": "prototype", "private": true, "summary": "Creates a clickable time option", "parameters": [ { "name": "index", "type": "Number", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "_buttonMouse", "scope": "prototype", "private": true, "summary": "Handler for hover (and unhover) on up\/down arrows", "parameters": [ { "name": "e", "type": "Event", "usage": "required" } ] }, { "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "name": "__Constraints", "scope": "normal", "private": true } ] }, "dijit._TimePicker.__Constraints": { "location": "dijit._TimePicker.__Constraints", "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "type": "Function", "classlike": true, "superclass": "dojo.date.locale.__FormatOptions", "private": true, "mixins": { "instance": [ { "scope": "instance", "location": "dojo.date.locale.__FormatOptions" } ] }, "methods": [ { "constructor": "constructor" } ] }, "dijit._TimePicker.timeMenu": { "location": "dijit._TimePicker.timeMenu", "resources": [ "dijit\/_TimePicker.js" ], "provides": [ "dijit._TimePicker" ], "type": null }, "dijit._TimePicker.timeMenu.childNodes.0": { "location": "dijit._TimePicker.timeMenu.childNodes.0", "type": null }, "dijit._Widget": { "location": "dijit._Widget", "resources": [ "dijit\/_Widget.js", "dojox\/form\/manager\/_Mixin.js", "dojox\/layout\/GridContainerLite.js", "dojox\/layout\/RadioGroup.js", "dojox\/layout\/TableContainer.js", "dojox\/layout\/ToggleSplitter.js", "dojox\/mdnd\/AreaManager.js" ], "provides": [ "dijit._Widget", "dojox.form.manager._Mixin", "dojox.layout.GridContainerLite", "dojox.layout.RadioGroup", "dojox.layout.TableContainer", "dojox.layout.ToggleSplitter", "dojox.mdnd.AreaManager" ], "type": "Function", "classlike": true, "superclass": "dijit._WidgetBase", "summary": "Base class for all Dijit widgets.\n\nExtends _WidgetBase, adding support for:\n- declaratively\/programatically specifying widget initialization parameters like\nonMouseMove="foo" that call foo when this.domNode gets a mousemove event\n- ondijitclick\nSupport new dojoAttachEvent="ondijitclick: ..." that is triggered by a mouse click or a SPACE\/ENTER keypress\n- focus related functions\nIn particular, the onFocus()\/onBlur() callbacks. Driven internally by\ndijit\/_base\/focus.js.\n- deprecated methods\n- onShow(), onHide(), onClose()\n\nAlso, by loading code in dijit\/_base, turns on:\n- browser sniffing (putting browser id like .dj_ie on <html> node)\n- high contrast mode sniffing (add .dijit_a11y class to <body> if machine is in high contrast mode)", "mixins": { "prototype": [ { "scope": "prototype", "location": "dijit._OnDijitClickMixin.prototype" }, { "scope": "prototype", "location": "dijit._FocusMixin.prototype" } ], "instance": [ { "scope": "instance", "location": "dijit._WidgetBase" }, { "scope": "instance", "location": "dijit._OnDijitClickMixin" }, { "scope": "instance", "location": "dijit._FocusMixin" } ] }, "methods": [ { "constructor": "constructor", "parameters": [ { "name": "params", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "setAttribute", "scope": "prototype", "summary": "Deprecated. Use set() instead.", "parameters": [ { "name": "attr", "type": "String", "usage": "required" }, { "name": "value", "type": "anything", "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "postCreate", "scope": "prototype" }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onShow", "scope": "prototype", "tags": "callback", "summary": "Called when this widget becomes the selected pane in a\n`dijit.layout.TabContainer`, `dijit.layout.StackContainer`,\n`dijit.layout.AccordionContainer`, etc.\n\nAlso called to indicate display of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`." }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseUp", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse button is released.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseOver", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseOut", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseMove", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseLeave", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse moves off of this widget.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseEnter", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse moves onto this widget.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onMouseDown", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of when the mouse button is pressed down.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onKeyUp", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of keys being released.", "parameters": [ { "name": "event", "type": "key", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onKeyPress", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of printable keys being typed.", "parameters": [ { "name": "event", "type": "key", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onKeyDown", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of keys being pressed down.", "parameters": [ { "name": "event", "type": "key", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onHide", "scope": "prototype", "tags": "callback", "summary": "Called when another widget becomes the selected pane in a\n`dijit.layout.TabContainer`, `dijit.layout.StackContainer`,\n`dijit.layout.AccordionContainer`, etc.\n\nAlso called to indicate hide of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`." }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onDblClick", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of mouse double click events.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onClose", "scope": "prototype", "tags": "extension", "summary": "Called when this widget is being displayed as a popup (ex: a Calendar popped\nup from a DateTextBox), and it is hidden.\nThis is called from the dijit.popup code, and should not be called directly.\n\nAlso used as a parameter for children of `dijit.layout.StackContainer` or subclasses.\nCallback if a user tries to close the child. Child will be closed if this function returns true.", "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "onClick", "scope": "prototype", "tags": "callback", "summary": "Connect to this function to receive notifications of mouse click events.", "parameters": [ { "name": "event", "type": "mouse", "usage": "required", "summary": "Event" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "on", "scope": "prototype", "parameters": [ { "name": "type", "type": "String", "usage": "required" }, { "name": "func", "type": "Function", "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "constructor", "scope": "prototype", "parameters": [ { "name": "params", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "attr", "scope": "prototype", "summary": "Set or get properties on a widget instance.", "description": "This method is deprecated, use get() or set() directly.", "parameters": [ { "name": "name", "type": "String|Object", "usage": "required", "summary": "The property to get or set. If an object is passed here and not\na string, its keys are used as names of attributes to be set\nand the value of the object as values to set in the widget." }, { "name": "value", "type": "Object", "usage": "optional", "summary": "Optional. If provided, attr() operates as a setter. If omitted,\nthe current value of the named property is returned." } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "_setFocusedAttr", "scope": "prototype", "private": true, "parameters": [ { "name": "val", "type": null, "usage": "required" } ] }, { "resources": [ "dijit\/_Widget.js" ], "provides": [ "dijit._Widget" ], "name": "_onShow", "scope": "prototype", "private": true, "summary": "Internal method called when this widget is made visible.\nSee `onShow` for details." } ] }, "dijit._WidgetBase._setClassAttr": { "location": "dijit._WidgetBase._setClassAttr", "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "private": true }, "dijit._WidgetBase.constructor": { "location": "dijit._WidgetBase.constructor", "resources": [ "dijit\/_WidgetBase.js" ], "provides": [ "dijit._WidgetBase" ], "type": null }, "dijit._WidgetBase.domNode.style": { "location": "dijit._WidgetBase.domNode.style", "type": null }, "dijit._WidgetsInTemplateMixin": { "location": "dijit._WidgetsInTemplateMixin", "resources": [ "dijit\/_WidgetsInTemplateMixin.js" ], "provides": [ "dijit._WidgetsInTemplateMixin" ], "type": "Function", "classlike": true, "summary": "Mixin to supplement _TemplatedMixin when template contains widgets", "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_WidgetsInTemplateMixin.js" ], "provides": [ "dijit._WidgetsInTemplateMixin" ], "name": "startup", "scope": "prototype" }, { "resources": [ "dijit\/_WidgetsInTemplateMixin.js" ], "provides": [ "dijit._WidgetsInTemplateMixin" ], "name": "_beforeFillContent", "scope": "prototype", "private": true } ] }, "focus": { "location": "focus", "type": null, "methods": [ { "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" } ] } ] }, "dijit._base": { "location": "dijit._base", "resources": [ "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" ], "provides": [ "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" ], "private": true }, "dijit.WidgetSet": { "location": "dijit.WidgetSet", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "type": "Function", "classlike": true, "summary": "A set of widgets indexed by id. A default instance of this class is\navailable as `dijit.registry`", "examples": [ "Create a small list of widgets:\n\tvar ws = new dijit.WidgetSet();\n\tws.add(dijit.byId(\"one\"));\n \tws.add(dijit.byId(\"two\"));\n\t\/\/ destroy both:\n\tws.forEach(function(w){ w.destroy(); });", "Using dijit.registry:\n\tdijit.registry.forEach(function(w){ \/* do something *\/ });" ], "methods": [ { "constructor": "constructor" }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "toArray", "scope": "prototype", "summary": "Convert this WidgetSet into a true Array", "examples": { "example": "Work with the widget .domNodes in a real Array\n\tdojo.map(dijit.registry.toArray(), function(w){ return w.domNode; });" }, "return-types": [ { "type": "dijit._Widget[]" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "some", "scope": "prototype", "summary": "A synthetic clone of `dojo.some` acting explictly on this WidgetSet", "parameters": [ { "name": "func", "type": "Function", "usage": "required", "summary": "A callback function run for every widget in this list. Exits loop\nwhen the first true return is encountered." }, { "name": "thisObj", "type": "Object", "usage": "optional", "summary": "Optional scope parameter to use for the callback" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "remove", "scope": "prototype", "summary": "Remove a widget from this WidgetSet. Does not destroy the widget; simply\nremoves the reference.", "parameters": [ { "name": "id", "type": "String", "usage": "required" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "map", "scope": "prototype", "summary": "Create a new Array from this WidgetSet, following the same rules as `dojo.map`", "examples": { "example": "\tvar nodes = dijit.registry.map(function(w){ return w.domNode; });" }, "return-description": "A new array of the returned values.", "parameters": [ { "name": "func", "type": "Function", "usage": "required" }, { "name": "thisObj", "type": "Object", "usage": "optional" } ], "return-types": [ { "type": "Array" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "forEach", "scope": "prototype", "summary": "Call specified function for each widget in this set.", "examples": { "example": "Using the default `dijit.registry` instance:\n\tdijit.registry.forEach(function(widget){\n\t\tconsole.log(widget.declaredClass);\n\t});" }, "return-description": "Returns self, in order to allow for further chaining.", "parameters": [ { "name": "func", "type": "Function", "usage": "required", "summary": "A callback function to run for each item. Is passed the widget, the index\nin the iteration, and the full hash, similar to `dojo.forEach`." }, { "name": "thisObj", "type": "Object", "usage": "optional", "summary": "An optional scope parameter" } ], "return-types": [ { "type": "dijit.WidgetSet" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "filter", "scope": "prototype", "summary": "Filter down this WidgetSet to a smaller new WidgetSet\nWorks the same as `dojo.filter` and `dojo.NodeList.filter`", "examples": { "example": "Arbitrary: select the odd widgets in this list\n\tdijit.registry.filter(function(w, i){\n\t\treturn i % 2 == 0;\n\t}).forEach(function(w){ \/* odd ones *\/ });" }, "parameters": [ { "name": "filter", "type": "Function", "usage": "required", "summary": "Callback function to test truthiness. Is passed the widget\nreference and the pseudo-index in the object." }, { "name": "thisObj", "type": "Object", "usage": "optional", "summary": "Option scope to use for the filter function." } ], "return-types": [ { "type": "dijit.WidgetSet" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "every", "scope": "prototype", "summary": "A synthetic clone of `dojo.every` acting explicitly on this WidgetSet", "parameters": [ { "name": "func", "type": "Function", "usage": "required", "summary": "A callback function run for every widget in this list. Exits loop\nwhen the first false return is encountered." }, { "name": "thisObj", "type": "Object", "usage": "optional", "summary": "Optional scope parameter to use for the callback" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "constructor", "scope": "prototype" }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byId", "scope": "prototype", "summary": "Find a widget in this list by it's id.", "examples": { "example": "Test if an id is in a particular WidgetSet\n var ws = new dijit.WidgetSet();\n ws.add(dijit.byId(\"bar\"));\n var t = ws.byId(\"bar\") \/\/ returns a widget\n var x = ws.byId(\"foo\"); \/\/ returns undefined" }, "parameters": [ { "name": "id", "type": "String", "usage": "required" } ], "return-types": [ { "type": "dijit._Widget" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "byClass", "scope": "prototype", "summary": "Reduce this widgetset to a new WidgetSet of a particular `declaredClass`", "examples": { "example": "Find all `dijit.TitlePane`s in a page:\n\tdijit.registry.byClass(\"dijit.TitlePane\").forEach(function(tp){ tp.close(); });" }, "parameters": [ { "name": "cls", "type": "String", "usage": "required", "summary": "The Class to scan for. Full dot-notated string." } ], "return-types": [ { "type": "dijit.WidgetSet" } ] }, { "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "name": "add", "scope": "prototype", "summary": "Add a widget to this list. If a duplicate ID is detected, a error is thrown.", "parameters": [ { "name": "widget", "type": "dijit._Widget", "usage": "required", "summary": "Any dijit._Widget subclass." } ] } ] }, "dijit.registry": { "location": "dijit.registry", "resources": [ "dijit\/_base\/manager.js" ], "provides": [ "dijit._base.manager" ], "summary": "A list of widgets on a page.", "description": "Is an instance of `dijit.WidgetSet`" }, "dojo": { "location": "dojo", "resources": [ "dojo\/AdapterRegistry.js", "dojo\/DeferredList.js", "dojo\/NodeList-data.js", "dojo\/NodeList-fx.js", "dojo\/NodeList-html.js", "dojo\/NodeList-manipulate.js", "dojo\/NodeList-traverse.js", "dojo\/Stateful.js", "dojo\/_base\/Color.js", "dojo\/_base\/Deferred.js", "dojo\/_base\/NodeList.js", "dojo\/_base\/array.js", "dojo\/_base\/browser.js", "dojo\/_base\/config.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\/kernel.js", "dojo\/_base\/lang.js", "dojo\/_base\/loader.js", "dojo\/_base\/unload.js", "dojo\/_base\/url.js", "dojo\/_base\/window.js", "dojo\/_base\/xhr.js", "dojo\/_firebug\/firebug.js", "dojo\/aspect.js", "dojo\/back.js", "dojo\/behavior.js", "dojo\/cache.js", "dojo\/cldr\/monetary.js", "dojo\/cldr\/supplemental.js", "dojo\/colors.js", "dojo\/cookie.js", "dojo\/currency.js", "dojo\/data\/ItemFileReadStore.js", "dojo\/data\/ItemFileWriteStore.js", "dojo\/data\/ObjectStore.js", "dojo\/data\/api\/Identity.js", "dojo\/data\/api\/Notification.js", "dojo\/data\/api\/Read.js", "dojo\/data\/api\/Request.js", "dojo\/data\/api\/Write.js", "dojo\/data\/util\/filter.js", "dojo\/data\/util\/simpleFetch.js", "dojo\/data\/util\/sorter.js", "dojo\/date\/locale.js", "dojo\/date\/stamp.js", "dojo\/date.js", "dojo\/dnd\/Avatar.js", "dojo\/dnd\/Container.js", "dojo\/dnd\/Manager.js", "dojo\/dnd\/Moveable.js", "dojo\/dnd\/Mover.js", "dojo\/dnd\/Selector.js", "dojo\/dnd\/Source.js", "dojo\/dnd\/TimedMoveable.js", "dojo\/dnd\/autoscroll.js", "dojo\/dnd\/common.js", "dojo\/dnd\/move.js", "dojo\/dom-class.js", "dojo\/dom-construct.js", "dojo\/dom-geometry.js", "dojo\/dom-prop.js", "dojo\/dom-style.js", "dojo\/dom.js", "dojo\/domReady.js", "dojo\/fx\/Toggler.js", "dojo\/fx\/easing.js", "dojo\/fx.js", "dojo\/gears.js", "dojo\/gesture\/swipe.js", "dojo\/gesture\/tap.js", "dojo\/gesture.js", "dojo\/has.js", "dojo\/hash.js", "dojo\/html.js", "dojo\/i18n.js", "dojo\/io\/iframe.js", "dojo\/io\/script.js", "dojo\/jaxer.js", "dojo\/json.js", "dojo\/main.js", "dojo\/mouse.js", "dojo\/number.js", "dojo\/on.js", "dojo\/parser.js", "dojo\/query.js", "dojo\/ready.js", "dojo\/regexp.js", "dojo\/robot.js", "dojo\/robotx.js", "dojo\/rpc\/JsonService.js", "dojo\/rpc\/JsonpService.js", "dojo\/rpc\/RpcService.js", "dojo\/selector\/_loader.js", "dojo\/selector\/acme.js", "dojo\/selector\/lite.js", "dojo\/store\/Cache.js", "dojo\/store\/DataStore.js", "dojo\/store\/JsonRest.js", "dojo\/store\/Memory.js", "dojo\/store\/Observable.js", "dojo\/store\/api\/Store.js", "dojo\/store\/util\/QueryResults.js", "dojo\/store\/util\/SimpleQueryEngine.js", "dojo\/string.js", "dojo\/text.js", "dojo\/touch.js", "dojo\/uacss.js", "dojo\/window.js", "dojox\/charting\/widget\/Sparkline.js", "dojox\/fx\/style.js", "dojox\/gfx\/canvas.js", "dojox\/gfx\/canvasWithEvents.js", "dojox\/gfx\/fx.js", "dojox\/gfx\/gradient.js", "dojox\/gfx\/gradutils.js", "dojox\/gfx\/silverlight.js", "dojox\/gfx\/svg.js", "dojox\/gfx\/utils.js", "dojox\/gfx\/vml.js", "dojox\/image\/_base.js", "dojox\/lang\/aspect.js", "dojox\/lang\/async\/event.js", "dojox\/lang\/async\/timeout.js", "dojox\/lang\/async\/topic.js", "dojox\/lang\/async.js", "dojox\/lang\/functional\/array.js", "dojox\/lang\/functional\/fold.js", "dojox\/lang\/functional\/object.js", "dojox\/lang\/functional\/reversed.js", "dojox\/lang\/functional\/scan.js", "dojox\/lang\/functional\/sequence.js", "dojox\/mobile\/scrollable.js", "dojox\/widget\/TitleGroup.js" ], "provides": [ "dojo.AdapterRegistry", "dojo.DeferredList", "dojo.NodeList-data", "dojo.NodeList-fx", "dojo.NodeList-html", "dojo.NodeList-manipulate", "dojo.NodeList-traverse", "dojo.Stateful", "dojo._base.Color", "dojo._base.Deferred", "dojo._base.NodeList", "dojo._base.array", "dojo._base.browser", "dojo._base.config", "dojo._base.connect", "dojo._base.declare", "dojo._base.event", "dojo._base.fx", "dojo._base.html", "dojo._base.json", "dojo._base.kernel", "dojo._base.lang", "dojo._base.loader", "dojo._base.unload", "dojo._base.url", "dojo._base.window", "dojo._base.xhr", "dojo._firebug.firebug", "dojo.aspect", "dojo.back", "dojo.behavior", "dojo.cache", "dojo.cldr.monetary", "dojo.cldr.supplemental", "dojo.colors", "dojo.cookie", "dojo.currency", "dojo.data.ItemFileReadStore", "dojo.data.ItemFileWriteStore", "dojo.data.ObjectStore", "dojo.data.api.Identity", "dojo.data.api.Notification", "dojo.data.api.Read", "dojo.data.api.Request", "dojo.data.api.Write", "dojo.data.util.filter", "dojo.data.util.simpleFetch", "dojo.data.util.sorter", "dojo.date.locale", "dojo.date.stamp", "dojo.date", "dojo.dnd.Avatar", "dojo.dnd.Container", "dojo.dnd.Manager", "dojo.dnd.Moveable", "dojo.dnd.Mover", "dojo.dnd.Selector", "dojo.dnd.Source", "dojo.dnd.TimedMoveable", "dojo.dnd.autoscroll", "dojo.dnd.common", "dojo.dnd.move", "dojo.dom-class", "dojo.dom-construct", "dojo.dom-geometry", "dojo.dom-prop", "dojo.dom-style", "dojo.dom", "dojo.domReady", "dojo.fx.Toggler", "dojo.fx.easing", "dojo.fx", "dojo.gears", "dojo.gesture.swipe", "dojo.gesture.tap", "dojo.gesture", "dojo.has", "dojo.hash", "dojo.html", "dojo.i18n", "dojo.io.iframe", "dojo.io.script", "dojo.jaxer", "dojo.json", "dojo.main", "dojo.mouse", "dojo.number", "dojo.on", "dojo.parser", "dojo.query", "dojo.ready", "dojo.regexp", "dojo.robot", "dojo.robotx", "dojo.rpc.JsonService", "dojo.rpc.JsonpService", "dojo.rpc.RpcService", "dojo.selector._loader", "dojo.selector.acme", "dojo.selector.lite", "dojo.store.Cache", "dojo.store.DataStore", "dojo.store.JsonRest", "dojo.store.Memory", "dojo.store.Observable", "dojo.store.api.Store", "dojo.store.util.QueryResults", "dojo.store.util.SimpleQueryEngine", "dojo.string", "dojo.text", "dojo.touch", "dojo.uacss", "dojo.window", "dojox.charting.widget.Sparkline", "dojox.fx.style", "dojox.gfx.canvas", "dojox.gfx.canvasWithEvents", "dojox.gfx.fx", "dojox.gfx.gradient", "dojox.gfx.gradutils", "dojox.gfx.silverlight", "dojox.gfx.svg", "dojox.gfx.utils", "dojox.gfx.vml", "dojox.image._base", "dojox.lang.aspect", "dojox.lang.async.event", "dojox.lang.async.timeout", "dojox.lang.async.topic", "dojox.lang.async", "dojox.lang.functional.array", "dojox.lang.functional.fold", "dojox.lang.functional.object", "dojox.lang.functional.reversed", "dojox.lang.functional.scan", "dojox.lang.functional.sequence", "dojox.widget.TitleGroup" ], "properties": [ { "name": "window", "resources": [ "dojo\/window.js" ], "provides": [ "dojo.window" ], "scope": "normal", "type": "Object" }, { "name": "touch", "resources": [ "dojo\/touch.js" ], "provides": [ "dojo.touch" ], "scope": "normal", "type": "Object" }, { "name": "string", "resources": [ "dojo\/string.js" ], "provides": [ "dojo.string" ], "scope": "normal", "type": "Object", "summary": "String utilities for Dojo" }, { "name": "store", "resources": [ "dojo\/store\/Cache.js", "dojo\/store\/DataStore.js", "dojo\/store\/JsonRest.js", "dojo\/store\/Memory.js", "dojo\/store\/Observable.js", "dojo\/store\/api\/Store.js", "dojo\/store\/util\/QueryResults.js", "dojo\/store\/util\/SimpleQueryEngine.js" ], "provides": [ "dojo.store.Cache", "dojo.store.DataStore", "dojo.store.JsonRest", "dojo.store.Memory", "dojo.store.Observable", "dojo.store.api.Store", "dojo.store.util.QueryResults", "dojo.store.util.SimpleQueryEngine" ], "scope": "normal", "type": "Object" }, { "name": "selector", "resources": [ "dojo\/selector\/_loader.js", "dojo\/selector\/acme.js", "dojo\/selector\/lite.js" ], "provides": [ "dojo.selector._loader", "dojo.selector.acme", "dojo.selector.lite" ], "scope": "normal", "type": "Object" }, { "name": "rpc", "resources": [ "dojo\/resources\/_modules.js", "dojo\/rpc\/JsonService.js", "dojo\/rpc\/JsonpService.js", "dojo\/rpc\/RpcService.js" ], "provides": [ "dojo.rpc.JsonService", "dojo.rpc.JsonpService", "dojo.rpc.RpcService" ], "scope": "normal", "type": "Object", "summary": "Dojo remote-procedure-call resources" }, { "name": "regexp", "resources": [ "dojo\/regexp.js" ], "provides": [ "dojo.regexp" ], "scope": "normal", "type": "Object", "summary": "Regular expressions and Builder resources" }, { "name": "number", "resources": [ "dojo\/number.js" ], "provides": [ "dojo.number" ], "scope": "normal", "type": "Object", "summary": "localized formatting and parsing routines for Number" }, { "name": "mouseButtons", "resources": [ "dojo\/mouse.js" ], "provides": [ "dojo.mouse" ], "scope": "normal", "type": "Object" }, { "name": "keys", "resources": [ "dojo\/_base\/connect.js" ], "provides": [ "dojo._base.connect" ], "scope": "normal", "type": "Object", "summary": "Definitions for common key values\n\n\nthe apple key on macs\n\n\nvirtual key mapping" }, { "name": "io", "resources": [ "dojo\/io\/iframe.js", "dojo\/io\/script.js", "dojo\/resources\/_modules.js" ], "provides": [ "dojo.io.iframe", "dojo.io.script" ], "scope": "normal", "type": "Object", "summary": "Additional I\/O transports (Ajax)" }, { "name": "html", "resources": [ "dojo\/html.js" ], "provides": [ "dojo.html" ], "scope": "normal", "type": "Object" }, { "name": "global", "resources": [ "dojox\/mobile\/scrollable.js", "util\/buildscripts\/jslib\/buildUtil.js" ], "scope": "normal", "type": "Object" }, { "name": "gesture", "resources": [ "dojo\/gesture\/swipe.js", "dojo\/gesture\/tap.js", "dojo\/gesture.js" ], "provides": [ "dojo.gesture.swipe", "dojo.gesture.tap", "dojo.gesture" ], "scope": "normal", "type": "Object" }, { "name": "gears", "resources": [ "dojo\/gears.js" ], "provides": [ "dojo.gears" ], "scope": "normal", "type": "Object" }, { "name": "fx", "resources": [ "dojo\/fx\/Toggler.js", "dojo\/fx\/easing.js", "dojo\/fx.js" ], "provides": [ "dojo.fx.Toggler", "dojo.fx.easing", "dojo.fx" ], "scope": "normal", "type": "Object", "summary": "Effects library on top of Base animations" }, { "name": "doc", "resources": [ "dojo\/_base\/window.js", "dojox\/mobile\/scrollable.js" ], "provides": [ "dojo._base.window" ], "scope": "normal", "type": "Object", "summary": "Alias for the current document. 'dojo.doc' can be modified\nfor temporary context shifting. Also see dojo.withDoc()." }, { "name": "dnd", "resources": [ "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\/resources\/_modules.js" ], "provides": [ "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" ], "scope": "normal", "type": "Object", "summary": "Drag and Drop resources" }, { "name": "date", "resources": [ "dojo\/date\/locale.js", "dojo\/date\/stamp.js", "dojo\/date.js" ], "provides": [ "dojo.date.locale", "dojo.date.stamp", "dojo.date" ], "scope": "normal", "type": "Object", "summary": "Date manipulation utilities" }, { "name": "data", "resources": [ "dojo\/data\/ItemFileReadStore.js", "dojo\/data\/ItemFileWriteStore.js", "dojo\/data\/ObjectStore.js", "dojo\/data\/api\/Identity.js", "dojo\/data\/api\/Notification.js", "dojo\/data\/api\/Read.js", "dojo\/data\/api\/Request.js", "dojo\/data\/api\/Write.js", "dojo\/data\/util\/filter.js", "dojo\/data\/util\/simpleFetch.js", "dojo\/data\/util\/sorter.js", "dojo\/resources\/_modules.js" ], "provides": [ "dojo.data.ItemFileReadStore", "dojo.data.ItemFileWriteStore", "dojo.data.ObjectStore", "dojo.data.api.Identity", "dojo.data.api.Notification", "dojo.data.api.Read", "dojo.data.api.Request", "dojo.data.api.Write", "dojo.data.util.filter", "dojo.data.util.simpleFetch", "dojo.data.util.sorter" ], "scope": "normal", "type": "Object", "summary": "A uniform data access layer" }, { "name": "currency", "resources": [ "dojo\/currency.js" ], "provides": [ "dojo.currency" ], "scope": "normal", "type": "Object", "summary": "localized formatting and parsing routines for currencies" }, { "name": "contentHandlers", "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "scope": "normal", "type": "Object", "summary": "A map of availble XHR transport handle types. Name matches the\n`handleAs` attribute passed to XHR calls." }, { "name": "config", "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "scope": "normal", "type": null }, { "name": "colors", "resources": [ "dojo\/colors.js" ], "provides": [ "dojo.colors" ], "scope": "normal", "type": "Object", "summary": "Color utilities, extending Base dojo.Color" }, { "name": "cldr", "resources": [ "dojo\/cldr\/monetary.js", "dojo\/cldr\/supplemental.js", "dojo\/resources\/_modules.js" ], "provides": [ "dojo.cldr.monetary", "dojo.cldr.supplemental" ], "scope": "normal", "type": "Object", "summary": "transformation of relevant pieces of the Unicode.org Common Locale Data Repository\n(see http:\/\/unicode.org\/cldr) to JSON from the original XML with associated utility classes" }, { "name": "back", "resources": [ "dojo\/back.js" ], "provides": [ "dojo.back" ], "scope": "normal", "type": "Object", "summary": "Browser history management resources" }, { "name": "aspect", "resources": [ "dojo\/aspect.js" ], "provides": [ "dojo.aspect" ], "scope": "normal", "type": "Object", "summary": "provides aspect oriented programming functionality, allowing for\none to add before, around, or after advice on existing methods." }, { "name": "_firebug", "resources": [ "dojo\/_firebug\/firebug.js" ], "provides": [ "dojo._firebug.firebug" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_extraNames", "resources": [ "dojox\/lang\/oo\/mixin.js", "dojox\/lang\/oo\/rearrange.js" ], "provides": [ "dojox.lang.oo.mixin", "dojox.lang.oo.rearrange" ], "scope": "normal", "type": null, "private": true }, { "name": "_contentHandlers", "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "scope": "normal", "type": "Object", "private": true }, { "name": "_base", "resources": [ "dojo\/_base\/Color.js", "dojo\/_base\/Deferred.js", "dojo\/_base\/NodeList.js", "dojo\/_base\/array.js", "dojo\/_base\/browser.js", "dojo\/_base\/config.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\/kernel.js", "dojo\/_base\/lang.js", "dojo\/_base\/loader.js", "dojo\/_base\/unload.js", "dojo\/_base\/url.js", "dojo\/_base\/window.js", "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.Color", "dojo._base.Deferred", "dojo._base.NodeList", "dojo._base.array", "dojo._base.browser", "dojo._base.config", "dojo._base.connect", "dojo._base.declare", "dojo._base.event", "dojo._base.fx", "dojo._base.html", "dojo._base.json", "dojo._base.kernel", "dojo._base.lang", "dojo._base.loader", "dojo._base.unload", "dojo._base.url", "dojo._base.window", "dojo._base.xhr" ], "scope": "normal", "type": "Object", "private": true } ], "methods": [ { "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "name": "xhrPut", "scope": "normal", "summary": "Sends an HTTP PUT request to the server. In addtion to the properties\nlisted for the dojo.__XhrArgs type, the following property is allowed:\nputData:\nString. Send raw data in the body of the PUT request.", "parameters": [ { "name": "args", "type": "dojo.__XhrArgs", "usage": "required" } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "name": "xhrPost", "scope": "normal", "summary": "Sends an HTTP POST request to the server. In addtion to the properties\nlisted for the dojo.__XhrArgs type, the following property is allowed:\npostData:\nString. Send raw data in the body of the POST request.", "parameters": [ { "name": "args", "type": "dojo.__XhrArgs", "usage": "required" } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "name": "xhrGet", "scope": "normal", "summary": "Sends an HTTP GET request to the server.", "parameters": [ { "name": "args", "type": "dojo.__XhrArgs", "usage": "required" } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dojo\/_base\/xhr.js" ], "provides": [ "dojo._base.xhr" ], "name": "xhrDelete", "scope": "normal", "summary": "Sends an HTTP DELETE request to the server.", "parameters": [ { "name": "args", "type": "dojo.__XhrArgs", "usage": "required" } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dojo\/_base\/xhr.js", "dojox\/rpc\/Client.js" ], "provides": [ "dojo._base.xhr", "dojox.rpc.Client" ], "name": "xhr", "scope": "normal", "summary": "Sends an HTTP request with the given method.", "description": "Sends an HTTP request with the given method.\nSee also dojo.xhrGet(), xhrPost(), xhrPut() and dojo.xhrDelete() for shortcuts\nfor those HTTP methods. There are also methods for \"raw\" PUT and POST methods\nvia dojo.rawXhrPut() and dojo.rawXhrPost() respectively.", "parameters": [ { "name": "method", "type": "String", "usage": "required", "summary": "HTTP method to be used, such as GET, POST, PUT, DELETE. Should be uppercase." }, { "name": "args", "type": "dojo.__XhrArgs", "usage": "required" }, { "name": "hasBody", "type": "Boolean", "usage": "optional", "summary": "If the request has an HTTP body, then pass true for hasBody." } ], "return-types": [ { "type": "dojo.Deferred" } ] }, { "resources": [ "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "name": "withGlobal", "scope": "normal", "summary": "Invoke callback with globalObject as dojo.global and\nglobalObject.document as dojo.doc.", "description": "Invoke callback with globalObject as dojo.global and\nglobalObject.document as dojo.doc. If provided, globalObject\nwill be executed in the context of object thisObject\nWhen callback() returns or throws an error, the dojo.global\nand dojo.doc will be restored to its previous state.", "parameters": [ { "name": "globalObject", "type": "Object", "usage": "required" }, { "name": "callback", "type": "Function", "usage": "required" }, { "name": "thisObject", "type": "Object", "usage": "optional" }, { "name": "cbArguments", "type": "Array", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "name": "withDoc", "scope": "normal", "summary": "Invoke callback with documentObject as dojo.doc.", "description": "Invoke callback with documentObject as dojo.doc. If provided,\ncallback will be executed in the context of object thisObject\nWhen callback() returns or throws an error, the dojo.doc will\nbe restored to its previous state.", "parameters": [ { "name": "documentObject", "type": "DocumentElement", "usage": "required" }, { "name": "callback", "type": "Function", "usage": "required" }, { "name": "thisObject", "type": "Object", "usage": "optional" }, { "name": "cbArguments", "type": "Array", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/configFirefoxExtension.js", "dojo\/_base\/unload.js" ], "provides": [ "dojo._base.unload" ], "name": "windowUnloaded", "scope": "normal", "summary": "signal fired by impending window destruction. You may use\ndojo.addOnWindowUnload() to register a listener for this\nevent. NOTE: if you wish to dojo.connect() to this method\nto perform page\/application cleanup, be aware that this\nevent WILL NOT fire if no handler has been registered with\ndojo.addOnWindowUnload. This behavior started in Dojo 1.3.\nPrevious versions always triggered dojo.windowUnloaded. See\ndojo.addOnWindowUnload for more info." }, { "resources": [ "dojo\/_base\/Deferred.js" ], "provides": [ "dojo._base.Deferred" ], "name": "when", "scope": "normal", "summary": "This provides normalization between normal synchronous values and\nasynchronous promises, so you can interact with them in a common way", "examples": { "example": "\tfunction printFirstAndList(items){\n\t\tdojo.when(findFirst(items), console.log);\n\t\tdojo.when(findLast(items), console.log);\n\t}\n\tfunction findFirst(items){\n\t\treturn dojo.when(items, function(items){\n\t\t\treturn items[0];\n\t\t});\n\t}\n\tfunction findLast(items){\n\t\treturn dojo.when(items, function(items){\n\t\t\treturn items[items.length];\n\t\t});\n\t}\nAnd now all three of his functions can be used sync or async.\n\tprintFirstAndLast([1,2,3,4]) will work just as well as\n\tprintFirstAndLast(dojo.xhrGet(...));" }, "parameters": [ { "name": "promiseOrValue", "type": null, "usage": "required" }, { "name": "callback", "type": "Function", "usage": "optional" }, { "name": "errback", "type": "Function", "usage": "optional" }, { "name": "progressHandler", "type": "Function", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/lang.js", "dojo\/selector\/acme.js" ], "provides": [ "dojo._base.lang", "dojo.selector.acme" ], "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": [ "dojo\/dom-class.js" ], "provides": [ "dojo.dom-class" ], "name": "toggleClass", "scope": "normal", "summary": "Adds a class to node if not present, or removes if present.\nPass a boolean condition if you want to explicitly add or remove.\nReturns the condition that was specified directly or indirectly.", "examples": [ "\tdojo.toggleClass(\"someNode\", \"hovered\");", "Forcefully add a class\n\tdojo.toggleClass(\"someNode\", \"hovered\", true);", "Available in `dojo.NodeList()` for multiple toggles\n\tdojo.query(\".toggleMe\").toggleClass(\"toggleMe\");" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required" }, { "name": "classStr", "type": "String|Array", "usage": "required" }, { "name": "condition", "type": "Boolean", "usage": "optional", "summary": "If passed, true means to add the class, false means to remove." } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/_base\/json.js" ], "provides": [ "dojo._base.json" ], "name": "toJson", "scope": "normal", "summary": "Returns a [JSON](http:\/\/json.org) serialization of an object.", "description": "Returns a [JSON](http:\/\/json.org) serialization of an object.\nNote that this doesn't check for infinite recursion, so don't do that!\nIt is recommend that you use dojo\/json's stringify function for an lighter\nand faster implementation that matches the native JSON API and uses the\nnative JSON serializer when available.", "examples": [ "simple serialization of a trivial object\n\tvar jsonStr = dojo.toJson({ howdy: \"stranger!\", isStrange: true });\n\tdoh.is('{\"howdy\":\"stranger!\",\"isStrange\":true}', jsonStr);", "a custom serializer for an objects of a particular class:\n\tdojo.declare(\"Furby\", null, {\n\t\tfurbies: \"are strange\",\n\t\tfurbyCount: 10,\n\t\t__json__: function(){\n\t\t},\n\t});" ], "parameters": [ { "name": "it", "type": "Object", "usage": "required", "summary": "an object to be serialized. Objects may define their own\nserialization via a special "__json__" or "json" function\nproperty. If a specialized serializer has been defined, it will\nbe used as a fallback.\nNote that in 1.6, toJson would serialize undefined, but this no longer supported\nsince it is not supported by native JSON serializer." }, { "name": "prettyPrint", "type": "Boolean", "usage": "optional", "summary": "if true, we indent objects and arrays to make the output prettier.\nThe variable `dojo.toJsonIndentStr` is used as the indent string --\nto use something other than the default (tab), change that variable\nbefore calling dojo.toJson().\nNote that if native JSON support is available, it will be used for serialization,\nand native implementations vary on the exact spacing used in pretty printing." }, { "name": "_indentStr", "type": "String", "usage": "optional", "summary": "private variable for recursive calls when pretty printing, do not use." } ] }, { "resources": [ "dojo\/dom-construct.js" ], "provides": [ "dojo.dom-construct" ], "name": "toDom", "scope": "normal", "summary": "instantiates an HTML fragment returning the corresponding DOM.", "examples": { "example": "Create a table row:\n\tvar tr = dojo.toDom(\"First!<\/td><\/tr>\");" }, "return-description": "DocumentFragment", "parameters": [ { "name": "frag", "type": "String", "usage": "required", "summary": "the HTML fragment" }, { "name": "doc", "type": "DocumentNode", "usage": "optional", "summary": "optional document to use when creating DOM nodes, defaults to\ndojo.doc if not specified." } ] }, { "resources": [ "dijit\/_base\/manager.js", "dojo\/dom-style.js" ], "provides": [ "dijit._base.manager", "dojo.dom-style" ], "name": "style", "scope": "normal", "summary": "Accesses styles on a node. If 2 arguments are\npassed, acts as a getter. If 3 arguments are passed, acts\nas a setter.", "description": "Getting the style value uses the computed style for the node, so the value\nwill be a calculated value, not just the immediate node.style value.\nAlso when getting values, use specific style names,\nlike \"borderBottomWidth\" instead of \"border\" since compound values like\n\"border\" are not necessarily reflected as expected.\nIf you want to get node dimensions, use `dojo.marginBox()`,\n`dojo.contentBox()` or `dojo.position()`.", "examples": [ "Passing only an ID or node returns the computed style object of\nthe node:\n\tdojo.style(\"thinger\");", "Passing a node and a style property returns the current\nnormalized, computed value for that property:\n\tdojo.style(\"thinger\", \"opacity\"); \/\/ 1 by default", "Passing a node, a style property, and a value changes the\ncurrent display of the node and returns the new computed value\n\tdojo.style(\"thinger\", \"opacity\", 0.5); \/\/ == 0.5", "Passing a node, an object-style style property sets each of the values in turn and returns the computed style object of the node:\n\tdojo.style(\"thinger\", {\n\t\t\"opacity\": 0.5,\n\t\t\"border\": \"3px solid black\",\n\t\t\"height\": \"300px\"\n\t});", "When the CSS style property is hyphenated, the JavaScript property is camelCased.\nfont-size becomes fontSize, and so on.\n\tdojo.style(\"thinger\",{\n\t\tfontSize:\"14pt\",\n\t\tletterSpacing:\"1.2em\"\n\t});", "dojo.NodeList implements .style() using the same syntax, omitting the \"node\" parameter, calling\ndojo.style() on every element of the list. See: `dojo.query()` and `dojo.NodeList()`\n\tdojo.query(\".someClassName\").style(\"visibility\",\"hidden\");\n\t\/\/ or\n\tdojo.query(\"#baz > div\").style({\n\t\topacity:0.75,\n\t\tfontSize:\"13pt\"\n\t});" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to node to get\/set style for" }, { "name": "style", "type": "String|Object", "usage": "optional", "summary": "the style property to set in DOM-accessor format\n("borderWidth", not "border-width") or an object with key\/value\npairs suitable for setting each property." }, { "name": "value", "type": "String", "usage": "optional", "summary": "If passed, sets value on the node for style, handling\ncross-browser concerns. When setting a pixel value,\nbe sure to include "px" in the value. For instance, top: "200px".\nOtherwise, in some cases, some browsers will not apply the style." } ] }, { "resources": [ "dojo\/_base\/event.js" ], "provides": [ "dojo._base.event" ], "name": "stopEvent", "scope": "normal", "summary": "prevents propagation and clobbers the default action of the\npassed event", "parameters": [ { "name": "evt", "type": "Event", "usage": "required", "summary": "The event object. If omitted, window.event is used on IE." } ] }, { "resources": [ "dojo\/_base\/array.js", "dojox\/lang\/async.js" ], "provides": [ "dojo._base.array", "dojox.lang.async" ], "name": "some", "scope": "normal", "summary": "Determines whether or not any item in arr satisfies the\ncondition implemented by callback.", "description": "This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when\nrun over sparse arrays, this implemenation passes the \"holes\" in the sparse array to\nthe callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.\nFor more details, see:\nhttps:\/\/developer.mozilla.org\/en\/Core_JavaScript_1.5_Reference\/Objects\/Array\/some", "examples": [ " \/\/ is true\n dojo.some([1, 2, 3, 4], function(item){ return item>1; });", " \/\/ is false\n dojo.some([1, 2, 3, 4], function(item){ return item<1; });" ], "parameters": [ { "name": "arr", "type": "Array|String", "usage": "required", "summary": "the array to iterate over. If a string, operates on individual characters." }, { "name": "callback", "type": "Function|String", "usage": "required", "summary": "a function is invoked with three arguments: item, index,\nand array and returns true if the condition is met." }, { "name": "thisObject", "type": "Object", "usage": "optional", "summary": "may be used to scope the call to callback" } ], "return-types": [ { "type": "Boolean" } ] }, { "resources": [ "dojo\/dom.js" ], "provides": [ "dojo.dom" ], "name": "setSelectable", "scope": "normal", "summary": "Enable or disable selection on a node", "examples": [ "Make the node id=\"bar\" unselectable\n\tdojo.setSelectable(\"bar\");", "Make the node id=\"bar\" selectable\n\tdojo.setSelectable(\"bar\", true);" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to node" }, { "name": "selectable", "type": "Boolean", "usage": "required", "summary": "state to put the node in. false indicates unselectable, true\nallows selection." } ] }, { "resources": [ "dojo\/_base\/window.js" ], "provides": [ "dojo._base.window" ], "name": "setContext", "scope": "normal", "summary": "changes the behavior of many core Dojo functions that deal with\nnamespace and DOM lookup, changing them to work in a new global\ncontext (e.g., an iframe). The varibles dojo.global and dojo.doc\nare modified as a result of calling this function and the result of\n`dojo.body()` likewise differs.", "parameters": [ { "name": "globalObject", "type": "Object", "usage": "required" }, { "name": "globalDocument", "type": "DocumentElement", "usage": "required" } ] }, { "resources": [ "dojo\/_base\/declare.js" ], "provides": [ "dojo._base.declare" ], "name": "safeMixin", "scope": "normal", "summary": "Mix in properties skipping a constructor and decorating functions\nlike it is done by dojo.declare.", "description": "This function is used to mix in properties like dojo._mixin does,\nbut it skips a constructor property and decorates functions like\ndojo.declare does.\n\nIt is meant to be used with classes and objects produced with\ndojo.declare. Functions mixed in with dojo.safeMixin can use\nthis.inherited() like normal methods.\n\nThis function is used to implement extend() method of a constructor\nproduced with dojo.declare().", "examples": { "example": "\tvar A = dojo.declare(null, {\n\t\tm1: function(){\n\t\t\tconsole.log(\"A.m1\");\n\t\t},\n\t\tm2: function(){\n\t\t\tconsole.log(\"A.m2\");\n\t\t}\n\t});\n\tvar B = dojo.declare(A, {\n\t\tm1: function(){\n\t\t\tthis.inherited(arguments);\n\t\t\tconsole.log(\"B.m1\");\n\t\t}\n\t});\n\tB.extend({\n\t\tm2: function(){\n\t\t\tthis.inherited(arguments);\n\t\t\tconsole.log(\"B.m2\");\n\t\t}\n\t});\n\tvar x = new B();\n\tdojo.safeMixin(x, {\n\t\tm1: function(){\n\t\t\tthis.inherited(arguments);\n\t\t\tconsole.log(\"X.m1\");\n\t\t},\n\t\tm2: function(){\n\t\t\tthis.inherited(arguments);\n\t\t\tconsole.log(\"X.m2\");\n\t\t}\n\t});\n\tx.m2();\n\t\/\/ prints:\n\t\/\/ A.m1\n\t\/\/ B.m1\n\t\/\/ X.m1" }, "parameters": [ { "name": "target", "type": "Object", "usage": "required", "summary": "Target object to accept new properties." }, { "name": "source", "type": "Object", "usage": "required", "summary": "Source object for new properties." } ] }, { "resources": [ "dojo\/_base\/loader.js", "util\/buildscripts\/jslib\/i18nUtil.js" ], "provides": [ "dojo._base.loader" ], "name": "requireLocalization", "scope": "normal", "parameters": [ { "name": "moduleName", "type": "String", "usage": "required" }, { "name": "bundleName", "type": "String", "usage": "required" }, { "name": "locale", "type": "String", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/loader.js" ], "provides": [ "dojo._base.loader" ], "name": "requireIf", "scope": "normal" }, { "resources": [ "dojo\/_base\/loader.js" ], "provides": [ "dojo._base.loader" ], "name": "requireAfterIf", "scope": "normal", "summary": "If the condition is true then call `dojo.require()` for the specified\nresource", "examples": { "example": "\tdojo.requireIf(dojo.isBrowser, \"my.special.Module\");" }, "parameters": [ { "name": "condition", "type": "Boolean", "usage": "required" }, { "name": "moduleName", "type": "String", "usage": "required" }, { "name": "omitModuleCheck", "type": "Boolean", "usage": "optional" } ] }, { "resources": [ "dojo\/_base\/loader.js", "dojox\/lang\/docs.js" ], "provides": [ "dojo._base.loader", "dojox.lang.docs" ], "name": "require", "scope": "normal", "parameters": [ { "name": "moduleName", "type": null, "usage": "required" }, { "name": "omitModuleCheck", "type": null, "usage": "required" } ] }, { "resources": [ "dojo\/dom-class.js" ], "provides": [ "dojo.dom-class" ], "name": "replaceClass", "scope": "normal", "summary": "Replaces one or more classes on a node if not present.\nOperates more quickly than calling dojo.removeClass and dojo.addClass", "examples": [ "\tdojo.replaceClass(\"someNode\", \"add1 add2\", \"remove1 remove2\");", "Replace all classes with addMe\n\tdojo.replaceClass(\"someNode\", \"addMe\");", "Available in `dojo.NodeList()` for multiple toggles\n\tdojo.query(\".findMe\").replaceClass(\"addMe\", \"removeMe\");" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "String ID or DomNode reference to remove the class from." }, { "name": "addClassStr", "type": "String|Array", "usage": "required", "summary": "A String class name to add, or several space-separated class names,\nor an array of class names." }, { "name": "removeClassStr", "type": "String|Array", "usage": "optional", "summary": "A String class name to remove, or several space-separated class names,\nor an array of class names." } ] }, { "resources": [ "dojo\/_base\/lang.js" ], "provides": [ "dojo._base.lang" ], "name": "replace", "scope": "normal", "summary": "Performs parameterized substitutions on a string. Throws an\nexception if any parameter is unmatched.", "examples": [ "\t\/\/ uses a dictionary for substitutions:\n\tdojo.replace(\"Hello, {name.first} {name.last} AKA {nick}!\",\n\t\t{\n\t\t\tnick: \"Bob\",\n\t\t\tname: {\n\t\t\t\tfirst:\t\"Robert\",\n\t\t\t\tmiddle: \"X\",\n\t\t\t\tlast:\t\t\"Cringely\"\n\t\t\t}\n\t\t});\n\t\/\/ returns: Hello, Robert Cringely AKA Bob!", "\t\/\/ uses an array for substitutions:\n\tdojo.replace(\"Hello, {0} {2}!\",\n\t\t[\"Robert\", \"X\", \"Cringely\"]);\n\t\/\/ returns: Hello, Robert Cringely!", "\t\/\/ uses a function for substitutions:\n\tfunction sum(a){\n\t\tvar t = 0;\n\t\tdojo.forEach(a, function(x){ t += x; });\n\t\treturn t;\n\t}\n\tdojo.replace(\n\t\t\"{count} payments averaging {avg} USD per payment.\",\n\t\tdojo.hitch(\n\t\t\t{ payments: [11, 16, 12] },\n\t\t\tfunction(_, key){\n\t\t\t\tswitch(key){\n\t\t\t\t\tcase \"count\": return this.payments.length;\n\t\t\t\t\tcase \"min\":\t\treturn Math.min.apply(Math, this.payments);\n\t\t\t\t\tcase \"max\":\t\treturn Math.max.apply(Math, this.payments);\n\t\t\t\t\tcase \"sum\":\t\treturn sum(this.payments);\n\t\t\t\t\tcase \"avg\":\t\treturn sum(this.payments) \/ this.payments.length;\n\t\t\t\t}\n\t\t\t}\n\t\t)\n\t);\n\t\/\/ prints: 3 payments averaging 13 USD per payment.", "\t\/\/ uses an alternative PHP-like pattern for substitutions:\n\tdojo.replace(\"Hello, ${0} ${2}!\",\n\t\t[\"Robert\", \"X\", \"Cringely\"], \/\\$\\{([^\\}]+)\\}\/g);\n\t\/\/ returns: Hello, Robert Cringely!" ], "return-description": "String\nReturns the substituted string.", "parameters": [ { "name": "tmpl", "type": "String", "usage": "required", "summary": "String to be used as a template." }, { "name": "map", "type": "Object|Function", "usage": "required", "summary": "If an object, it is used as a dictionary to look up substitutions.\nIf a function, it is called for every substitution with following\nparameters: a whole match, a name, an offset, and the whole template\nstring (see https:\/\/developer.mozilla.org\/en\/Core_JavaScript_1.5_Reference\/Global_Objects\/String\/replace\nfor more details)." }, { "name": "pattern", "type": "RegEx", "usage": "optional", "summary": "Optional regular expression objects that overrides the default pattern.\nMust be global and match one item. The default is: \/\\{([^\\}]+)\\}\/g,\nwhich matches patterns like that: "{xxx}", where "xxx" is any sequence\nof characters, which doesn't include "}"." } ], "return-types": [ { "type": "String" } ] }, { "resources": [ "dojo\/dom-class.js" ], "provides": [ "dojo.dom-class" ], "name": "removeClass", "scope": "normal", "summary": "Removes the specified classes from node. No `dojo.hasClass`\ncheck is required.", "examples": [ "Remove a class from some node:\n\tdojo.removeClass(\"someNode\", \"firstClass\");", "Remove two classes from some node:\n\tdojo.removeClass(\"someNode\", \"firstClass secondClass\");", "Remove two classes from some node (using array):\n\tdojo.removeClass(\"someNode\", [\"firstClass\", \"secondClass\"]);", "Remove all classes from some node:\n\tdojo.removeClass(\"someNode\");", "Available in `dojo.NodeList()` for multiple removal\n\tdojo.query(\".foo\").removeClass(\"foo\");" ], "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "String ID or DomNode reference to remove the class from." }, { "name": "classStr", "type": "String|Array", "usage": "optional", "summary": "An optional String class name to remove, or several space-separated\nclass names, or an array of class names. If omitted, all class names\nwill be deleted." } ] }, { "resources": [ "dojo\/dom-prop.js" ], "provides": [ "dojo.dom-prop" ], "name": "removeAttr", "scope": "normal", "summary": "Removes an attribute from an HTML element.", "parameters": [ { "name": "node", "type": "DomNode|String", "usage": "required", "summary": "id or reference to the element to remove the attribute from" }, { "name": "name", "type": "String", "usage": "required", "summary": "the name of the attribute to remove" } ] }, { "resources": [ "dojo\/_base\/loader.js" ], "provides": [ "dojo._base.loader" ], "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