diff --git a/types/dojo/dijit.d.ts b/types/dojo/dijit.d.ts index e476d66edd..b22742b85d 100644 --- a/types/dojo/dijit.d.ts +++ b/types/dojo/dijit.d.ts @@ -11,7 +11,7 @@ declare module dijit { * * Deprecated module for enabling textdir support in the dijit widgets. New code should just define * has("dojo-bidi") to return true, rather than manually requiring this module. - * + * */ interface _BidiSupport{(): void} /** @@ -19,24 +19,24 @@ declare module dijit { * * For IE/FF z-index shenanigans. id attribute is required. * new dijit.BackgroundIframe(node). - * + * * Makes a background iframe as a child of node, that fills * area (and position) of node - * - * @param node + * + * @param node */ interface BackgroundIframe{(node: HTMLElement): void} module BackgroundIframe { /** * destroy the iframe - * + * */ interface destroy{(): void} /** * Resize the iframe so it's the same size as node. * Needed on IE6 and IE/quirks because height:100% doesn't work right. - * - * @param node + * + * @param node */ interface resize{(node: any): void} } @@ -46,7 +46,7 @@ declare module dijit { * * Test if computer is in high contrast mode, and sets dijit_a11y flag on if it is. * Deprecated, use dojo/hccss instead. - * + * */ interface hccss{(): void} /** @@ -54,39 +54,39 @@ declare module dijit { * * Mixin for widgets to attach to dom nodes and setup events via * convenient data-dojo-attach-point and data-dojo-attach-event DOM attributes. - * + * * Superclass of _TemplatedMixin, and can also be used standalone when templates are pre-rendered on the * server. - * + * * Does not [yet] handle widgets like ContentPane with this.containerNode set. It should skip * scanning for data-dojo-attach-point and data-dojo-attach-event inside this.containerNode, but it * doesn't. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _AttachMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * Search descendants of this.containerNode for data-dojo-attach-point and data-dojo-attach-event. * Should generally be left false (the default value) both for performance and to avoid failures when * this.containerNode holds other _AttachMixin instances with their own attach points and events. - * + * */ "searchContainerNode": boolean; /** * Attach to DOM nodes marked with special attributes. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; } @@ -94,7 +94,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_Container.html * * Mixin for widgets that contain HTML and/or a set of widget children. - * + * */ class _Container { constructor(); @@ -102,40 +102,40 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** - * + * */ buildRendering(): void; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; @@ -144,7 +144,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_Contained.html * * Mixin for widgets that are children of a container widget - * + * */ class _Contained { constructor(); @@ -152,19 +152,19 @@ declare module dijit { * Returns the index of this widget within its container parent. * It returns -1 if the parent does not exist, or if the parent * is not a dijit/_Container - * + * */ getIndexInParent(): any; /** * Returns null if this is the last child of the parent, * otherwise returns the next element sibling to the "right". - * + * */ getNextSibling(): any; /** * Returns null if this is the first child of the parent, * otherwise returns the next element sibling to the "left". - * + * */ getPreviousSibling(): any; } @@ -172,7 +172,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_DialogMixin.html * * This provides functions useful to Dialog and TooltipDialog - * + * */ class _DialogMixin { constructor(); @@ -182,10 +182,10 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** @@ -193,7 +193,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** @@ -201,7 +201,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; } @@ -214,40 +214,40 @@ declare module dijit { * maintain CSS classes on the widget root node (this.domNode) depending on hover, * active, focus, etc. state. Ex: with a baseClass of dijitButton, it will apply the classes * dijitButtonHovered and dijitButtonActive, as the user moves the mouse over the widget and clicks it. - * + * * It also sets CSS like dijitButtonDisabled based on widget semantic state. - * + * * By setting the cssStateNodes attribute, a widget can also track events on subnodes (like buttons * within the widget). - * + * */ class _CssStateMixin { constructor(); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; /** * True if cursor is over this widget - * + * */ "hovering": boolean; } @@ -256,7 +256,7 @@ declare module dijit { * * Mixin to widget to provide _onFocus() and _onBlur() methods that * fire when a widget or its descendants get/lose focus - * + * */ class _FocusMixin { constructor(); @@ -265,7 +265,7 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_HasDropDown.html * * Mixin for widgets that need drop down ability. - * + * */ class _HasDropDown extends dijit._FocusMixin { constructor(); @@ -273,19 +273,19 @@ declare module dijit { * Set to true to make the drop down at least as wide as this * widget. Set to false if the drop down should just be its * default width. - * + * */ "autoWidth": boolean; /** * The widget to display as a popup. This widget must be * defined before the startup function is called. - * + * */ "dropDown": Object; /** * This variable controls the position of the drop down. * It's an array of strings with the following values: - * + * * before: places drop down to the left of the target node/widget, or to the right in * the case of RTL scripts like Hebrew and Arabic * after: places drop down to the right of the target node/widget, or to the left in @@ -294,40 +294,40 @@ declare module dijit { * below: drop down goes below target node * The list is positions is tried, in order, until a position is found where the drop down fits * within the viewport. - * + * */ "dropDownPosition": Object; /** * Set to true to make the drop down exactly as wide as this * widget. Overrides autoWidth. - * + * */ "forceWidth": boolean; /** * The max height for our dropdown. * Any dropdown taller than this will have scrollbars. * Set to 0 for no max height, or -1 to limit height to available space in viewport - * + * */ "maxHeight": number; /** - * + * */ buildRendering(): void; /** * Closes the drop down on this widget - * - * @param focus If true, refocuses the button widget + * + * @param focus If true, refocuses the button widget */ closeDropDown(focus: boolean): void; /** - * + * */ destroy(): void; /** * Returns true if the dropdown exists and it's data is loaded. This can * be overridden in order to force a call to loadDropDown(). - * + * */ isLoaded(): boolean; /** @@ -335,33 +335,33 @@ declare module dijit { * if there's an href and it hasn't been loaded yet, and * then opens the drop down. This is basically a callback when the * user presses the down arrow button to open the drop down. - * + * */ loadAndOpenDropDown(): any; /** * Creates the drop down if it doesn't exist, loads the data * if there's an href and it hasn't been loaded yet, and then calls * the given callback. - * - * @param loadCallback + * + * @param loadCallback */ loadDropDown(loadCallback: Function): void; /** * Opens the dropdown for this widget. To be called only when this.dropDown * has been created and is ready to display (ie, it's data is loaded). - * + * */ openDropDown(): any; /** * set up nodes and connect our mouse and keyboard events - * + * */ postCreate(): void; /** * Callback when the user presses the down arrow button or presses * the down arrow key to open/close the drop down. * Toggle the drop-down widget; if it is up, close it, if not, open it - * + * */ toggleDropDown(): void; } @@ -371,9 +371,9 @@ declare module dijit { * A mixin to allow arrow key and letter key navigation of child or descendant widgets. * It can be used by dijit/_Container based widgets with a flat list of children, * or more complex widgets like dijit/Tree. - * + * * To use this mixin, the subclass must: - * + * * - Implement _getNext(), _getFirst(), _getLast(), _onLeftArrow(), _onRightArrow() * _onDownArrow(), _onUpArrow() methods to handle home/end/left/right/up/down keystrokes. * Next and previous in this context refer to a linear ordering of the descendants used @@ -382,7 +382,7 @@ declare module dijit { * descendants added later, by for example addChild() * - Define childSelector to a function or string that identifies focusable descendant widgets * Also, child widgets must implement a focus() method. - * + * */ class _KeyNavMixin extends dijit._FocusMixin { constructor(); @@ -390,65 +390,65 @@ declare module dijit { * Selector (passed to on.selector()) used to identify what to treat as a child widget. Used to monitor * focus events and set this.focusedChild. Must be set by implementing class. If this is a string * (ex: "> *") then the implementing class must require dojo/query. - * + * */ "childSelector": any; /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; /** * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; /** * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** - * + * */ postCreate(): void; /** * When a key is pressed that matches a child item, * this method is called so that a widget can take appropriate action is necessary. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit._WidgetBase, evt: Event, searchString: String, numMatches: number): void; } @@ -459,136 +459,136 @@ declare module dijit { * Provides normalized keyboard and focusing code for Container widgets. * To use this mixin, call connectKeyNavHandlers() in postCreate(). * Also, child widgets must implement a focus() method. - * + * */ class _KeyNavContainer extends dijit._FocusMixin implements dijit._KeyNavMixin, dijit._Container { constructor(); /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; /** * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; /** * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** - * + * */ buildRendering(): void; /** - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** - * + * */ postCreate(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * When a key is pressed that matches a child item, * this method is called so that a widget can take appropriate action is necessary. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit._WidgetBase, evt: Event, searchString: String, numMatches: number): void; } @@ -596,26 +596,26 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_OnDijitClickMixin.html * * Deprecated. New code should access the dijit/a11yclick event directly, ex: - * + * * this.own(on(node, a11yclick, function(){ ... })); * Mixing in this class will make _WidgetBase.connect(node, "ondijitclick", ...) work. * It also used to be necessary to make templates with ondijitclick work, but now you can just require * dijit/a11yclick. - * + * */ class _OnDijitClickMixin { constructor(); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: any, method: any): any; } @@ -625,35 +625,35 @@ declare module dijit { * * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ interface a11yclick { /** * Logical click operation for mouse, touch, or keyboard (space/enter key) - * - * @param node - * @param listener + * + * @param node + * @param listener */ click(node: any, listener: any): void; /** * Mouse cursor or a finger is dragged over the given node. - * - * @param node - * @param listener + * + * @param node + * @param listener */ move(node: any, listener: any): void; /** * Mousedown (left button), touchstart, or keydown (space or enter) corresponding to logical click operation. - * - * @param node - * @param listener + * + * @param node + * @param listener */ press(node: any, listener: any): void; /** * Mouseup (left button), touchend, or keyup (space or enter) corresponding to logical click operation. - * - * @param node - * @param listener + * + * @param node + * @param listener */ release(node: any, listener: any): void; } @@ -664,83 +664,83 @@ declare module dijit { * * A keyboard accessible palette, for picking a color/emoticon/etc. * A mixin for a grid showing various entities, so the user can pick a certain entity. - * + * */ class _PaletteMixin extends dijit._CssStateMixin { constructor(); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * CSS class applied to each cell in the palette - * + * */ "cellClass": string; /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; /** * Number of milliseconds before a held key or button becomes typematic - * + * */ "defaultTimeout": number; /** * Constructor for Object created for each cell of the palette. * dyeClass should implement the dijit/_PaletteMixin.__Dye interface. - * + * */ "dyeClass": Object; /** * True if cursor is over this widget - * + * */ "hovering": boolean; /** * Widget tab index. - * + * */ "tabIndex": string; /** * Fraction of time used to change the typematic timer between events * 1.0 means that each typematic event fires at defaultTimeout intervals * Less than 1.0 means that each typematic event fires at an increasing faster rate - * + * */ "timeoutChangeRate": number; /** * Currently selected color/emoticon/etc. - * + * */ "value": string; /** * Focus this widget. Puts focus on the most recently focused cell. - * + * */ focus(): void; /** - * + * */ postCreate(): void; /** * Callback when a cell is selected. - * - * @param value Value corresponding to cell. + * + * @param value Value corresponding to cell. */ onChange(value: String): void; } @@ -749,24 +749,24 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_PaletteMixin.__Dye.html * * Interface for the JS Object associated with a palette cell (i.e. DOMNode) - * - * @param alias - * @param row - * @param col + * + * @param alias + * @param row + * @param col */ class __Dye { constructor(alias: String, row: any, col: any); /** * Add cell DOMNode inner structure - * - * @param cell The surrounding cell - * @param blankGif URL for blank cell image + * + * @param cell The surrounding cell + * @param blankGif URL for blank cell image */ fillCell(cell: HTMLElement, blankGif: String): void; /** * Return "value" of cell; meaning of "value" varies by subclass. * For example color hex value, emoticon ascii value etc, entity hex value. - * + * */ getValue(): void; } @@ -776,50 +776,50 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TemplatedMixin.html * * Mixin for widgets that are instantiated from a template - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _TemplatedMixin extends dijit._AttachMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** - * + * */ "searchContainerNode": boolean; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; /** * Static method to get a template based on the templatePath or * templateString key - * - * @param templateString The template - * @param alwaysUseString Don't cache the DOM tree for this template, even if it doesn't have any variables - * @param doc OptionalThe target document. Defaults to document global if unspecified. + * + * @param templateString The template + * @param alwaysUseString Don't cache the DOM tree for this template, even if it doesn't have any variables + * @param doc OptionalThe target document. Defaults to document global if unspecified. */ getCachedTemplate(templateString: String, alwaysUseString: boolean, doc?: HTMLDocument): any; } @@ -827,7 +827,7 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TemplatedMixin._templateCache.html * - * + * */ interface _templateCache { } @@ -838,55 +838,55 @@ declare module dijit { * * Deprecated mixin for widgets that are instantiated from a template. * Widgets should use _TemplatedMixin plus if necessary _WidgetsInTemplateMixin instead. - * + * */ class _Templated extends dijit._TemplatedMixin implements dijit._WidgetsInTemplateMixin { constructor(); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** - * + * */ "searchContainerNode": boolean; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; /** * Should we parse the template to find widgets that might be * declared in markup inside it? False by default. - * + * */ "widgetsInTemplate": boolean; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** - * + * */ destroyRendering(): void; /** - * + * */ startup(): void; /** @@ -900,9 +900,9 @@ declare module dijit { * * Abstract base class for Menu and MenuBar. * Subclass should implement _onUpArrow(), _onDownArrow(), _onLeftArrow(), and _onRightArrow(). - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MenuBase extends dijit._Widget implements dijit._TemplatedMixin, dijit._KeyNavContainer, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); @@ -912,7 +912,7 @@ declare module dijit { * since TAB is a navigation operation and not a selection one. * For Windows apps, pressing the ALT key focuses the menubar menus (similar to TAB navigation) but the * menu is not active (ie no dropdown) until an item is clicked. - * + * */ "activated": boolean; set(property:"activated", value: boolean): void; @@ -920,7 +920,7 @@ declare module dijit { watch(property:"activated", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -929,7 +929,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -938,44 +938,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -984,7 +984,7 @@ declare module dijit { /** * A toggle to control whether or not a Menu gets focused when opened as a drop down from a MenuBar * or DropDownButton/ComboButton. Note though that it always get focused when opened via the keyboard. - * + * */ "autoFocus": boolean; set(property:"autoFocus", value: boolean): void; @@ -993,14 +993,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -1010,24 +1010,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -1036,18 +1036,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -1057,7 +1057,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -1068,7 +1068,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -1077,7 +1077,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -1085,7 +1085,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; set(property:"focusedChild", value: Object): void; @@ -1093,7 +1093,7 @@ declare module dijit { watch(property:"focusedChild", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -1104,7 +1104,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -1115,7 +1115,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -1125,10 +1125,10 @@ declare module dijit { * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; set(property:"multiCharSearchDuration", value: number): void; @@ -1137,7 +1137,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -1145,7 +1145,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to menu that displayed me - * + * */ "parentMenu": Object; set(property:"parentMenu", value: Object): void; @@ -1154,7 +1154,7 @@ declare module dijit { /** * For a passive (unclicked) Menu, number of milliseconds before hovering (without clicking) will cause * the popup to open. Default is Infinity, meaning you need to click the menu to open it. - * + * */ "passivePopupDelay": number; set(property:"passivePopupDelay", value: number): void; @@ -1163,14 +1163,14 @@ declare module dijit { /** * After a menu has been activated (by clicking on it etc.), number of milliseconds before hovering * (without clicking) another MenuItem causes that MenuItem's popup to automatically open. - * + * */ "popupDelay": number; set(property:"popupDelay", value: number): void; get(property:"popupDelay"): number; watch(property:"popupDelay", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -1181,7 +1181,7 @@ declare module dijit { * If a submenu is open, will be set to MenuItem that displayed the submenu. OTOH, if * this Menu is in passive mode (i.e. hasn't been clicked yet), will be null, because * "selected" is not merely "hovered". - * + * */ "selected": Object; set(property:"selected", value: Object): void; @@ -1189,7 +1189,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -1197,7 +1197,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -1207,7 +1207,7 @@ declare module dijit { * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -1216,7 +1216,7 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; @@ -1225,7 +1225,7 @@ declare module dijit { /** * A string that represents the widget template. * Use in conjunction with dojo.cache() to load from a file. - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -1233,14 +1233,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -1249,210 +1249,210 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; get(property:"tooltip"): string; watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Selector (passed to on.selector()) used to identify MenuItem child widgets, but exclude inert children * like MenuSeparator. If subclass overrides to a string (ex: "> *"), the subclass must require dojo/query. - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -1460,69 +1460,69 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** @@ -1530,15 +1530,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -1546,65 +1546,65 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(...args: any[]): any[]; /** @@ -1613,9 +1613,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -1624,9 +1624,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -1635,9 +1635,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -1646,9 +1646,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -1657,9 +1657,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -1668,13 +1668,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -1682,82 +1682,82 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -1765,29 +1765,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -1800,27 +1800,27 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Attach point for notification about when the user cancels the current menu * This is an internal mechanism used for Menus to signal to their parent to * close them. In general developers should not attach to or override this method. - * - * @param closeAll + * + * @param closeAll */ onCancel(closeAll: boolean): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** @@ -1828,114 +1828,114 @@ declare module dijit { * This is an internal mechanism used for Menus to signal to their parent to * close them, because they are about to execute the onClick handler. In * general developers should not attach to or override this method. - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Called when cursor is over a MenuItem. - * - * @param item + * + * @param item */ onItemHover(item: dijit.MenuItem): void; /** * Callback fires when mouse exits a MenuItem - * - * @param item + * + * @param item */ onItemUnhover(item: dijit.MenuItem): void; /** * Attach point for notification about when a menu item has been searched for * via the keyboard search mechanism. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit.MenuItem, evt: Event, searchString: String, numMatches: number): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -1943,24 +1943,24 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/_WidgetsInTemplateMixin.html * * Mixin to supplement _TemplatedMixin when template contains widgets - * + * */ class _WidgetsInTemplateMixin { constructor(); /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; /** - * + * */ startup(): void; } @@ -1970,90 +1970,90 @@ declare module dijit { * Future base class for all Dijit widgets. * Future base class for all Dijit widgets. * _Widget extends this class adding support for various features needed by desktop. - * + * * Provides stubs for widget lifecycle methods for subclasses to extend, like postMixInProperties(), buildRendering(), * postCreate(), startup(), and destroy(), and also public API methods like set(), get(), and watch(). - * + * * Widgets can provide custom setters/getters for widget attributes, which are called automatically by set(name, value). * For an attribute XXX, define methods _setXXXAttr() and/or _getXXXAttr(). - * + * * _setXXXAttr can also be a string/hash/array mapping from a widget attribute XXX to the widget's DOMNodes: - * + * * DOM node attribute * _setFocusAttr: {node: "focusNode", type: "attribute"} * _setFocusAttr: "focusNode" (shorthand) * _setFocusAttr: "" (shorthand, maps to this.domNode) * Maps this.focus to this.focusNode.focus, or (last example) this.domNode.focus - * + * * DOM node innerHTML * _setTitleAttr: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * _setTitleAttr: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * _setMyClassAttr: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value of _setXXXAttr is an array, then each element in the array matches one of the * formats of the above list. - * + * * If the custom setter is null, no action is performed other than saving the new value * in the widget (in this). - * + * * If no custom setter is defined for an attribute, then it will be copied * to this.focusNode (if the widget defines a focusNode), or this.domNode otherwise. * That's only done though for attributes that match DOMNode attributes (title, * alt, aria-labelledby, etc.) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _WidgetBase extends dojo.Stateful implements dijit.Destroyable { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -2062,14 +2062,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -2079,24 +2079,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -2106,7 +2106,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -2117,7 +2117,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -2126,7 +2126,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -2137,7 +2137,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -2148,7 +2148,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -2157,7 +2157,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -2165,7 +2165,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -2173,7 +2173,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": Object; set(property:"style", value: Object): void; @@ -2181,14 +2181,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -2197,7 +2197,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -2206,165 +2206,165 @@ declare module dijit { /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -2372,36 +2372,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -2409,15 +2409,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -2425,33 +2425,33 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * + * */ isValid: any; /** @@ -2459,9 +2459,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): {remove:{():void}}; /** @@ -2469,15 +2469,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): {remove:{():void}}; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(handle:any): any; /** @@ -2486,9 +2486,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -2497,9 +2497,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -2508,9 +2508,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -2519,9 +2519,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -2530,9 +2530,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -2541,9 +2541,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -2551,7 +2551,7 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** @@ -2559,55 +2559,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -2615,29 +2615,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -2645,14 +2645,14 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; } @@ -2661,9 +2661,9 @@ declare module dijit { * * Old base class for widgets. New widgets should extend dijit/_WidgetBase instead * Old Base class for Dijit widgets. - * + * * Extends _WidgetBase, adding support for: - * + * * declaratively/programatically specifying widget initialization parameters like * onMouseMove="foo" that call foo when this.domNode gets a mousemove event * ondijitclick: @@ -2674,62 +2674,62 @@ declare module dijit { * deprecated methods * onShow(), onHide(), onClose() * Also, by loading code in dijit/_base, turns on: - * + * * browser sniffing (putting browser class like dj_ie on node) * high contrast mode sniffing (add dijit_a11y class to if machine is in high contrast mode) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _Widget extends dijit._WidgetBase implements dijit._OnDijitClickMixin, dijit._FocusMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -2738,14 +2738,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -2755,24 +2755,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -2782,7 +2782,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -2790,7 +2790,7 @@ declare module dijit { watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Defines a type of widget. - * + * */ "dndType": string; set(property:"dndType", value: string): void; @@ -2801,7 +2801,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -2810,7 +2810,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -2821,7 +2821,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -2832,14 +2832,14 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; get(property:"lang"): string; watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "observer": string; set(property:"observer", value: string): void; @@ -2848,18 +2848,18 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * A parameter needed by RadioGroupSlide only. An optional parameter to force + * A parameter needed by RadioGroupSlide only. An optional paramter to force * the ContentPane to slide in from a set direction. Defaults * to "random", or specify one of "top", "left", "right", "bottom" * to slideFrom top, left, right, or bottom. - * + * */ "slideFrom": string; set(property:"slideFrom", value: string): void; @@ -2867,7 +2867,7 @@ declare module dijit { watch(property:"slideFrom", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -2875,7 +2875,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": Object; set(property:"style", value: Object): void; @@ -2883,14 +2883,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -2899,7 +2899,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -2907,180 +2907,180 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -3088,36 +3088,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -3125,15 +3125,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -3141,54 +3141,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -3197,9 +3197,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -3208,9 +3208,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -3219,9 +3219,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -3230,9 +3230,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -3241,9 +3241,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -3252,13 +3252,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -3266,62 +3266,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -3329,29 +3329,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -3359,114 +3359,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -3475,53 +3475,53 @@ declare module dijit { * * A time picker dropdown, used by dijit/form/TimeTextBox. * This widget is not available as a standalone widget due to lack of accessibility support. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class _TimePicker extends dijit._WidgetBase implements dijit.form._ListMouseMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -3529,14 +3529,14 @@ declare module dijit { watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * The root className to use for the various states of this widget - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -3548,7 +3548,7 @@ declare module dijit { * Set in local time, without a time zone. * Example: T00:15:00 creates 15 minute increments * Must divide dijit/_TimePicker.visibleIncrement evenly - * + * */ "clickableIncrement": string; set(property:"clickableIncrement", value: string): void; @@ -3556,7 +3556,7 @@ declare module dijit { watch(property:"clickableIncrement", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Specifies valid range of times (start time, end time) - * + * */ "constraints": Object; set(property:"constraints", value: Object): void; @@ -3566,24 +3566,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -3593,7 +3593,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -3604,7 +3604,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -3612,7 +3612,7 @@ declare module dijit { watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * The string to filter by - * + * */ "filterString": string; set(property:"filterString", value: string): void; @@ -3621,7 +3621,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -3632,7 +3632,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -3643,7 +3643,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -3652,7 +3652,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -3660,7 +3660,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * currently selected node - * + * */ "selected": HTMLElement; set(property:"selected", value: HTMLElement): void; @@ -3668,7 +3668,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -3676,7 +3676,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -3684,14 +3684,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -3700,7 +3700,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -3720,7 +3720,7 @@ declare module dijit { * T10:00:00Z becomes T05:00:00-05:00 (5 hour difference between Zulu and local time) * yyyy-mm-ddThh:mm:ss is the format to set the date and time * Example: 2007-06-01T09:00:00 - * + * */ "value": string; set(property:"value", value: string): void; @@ -3731,172 +3731,172 @@ declare module dijit { * every element with a visible time in the time picker increases. * Set in local time, without a time zone. * Example: T01:00:00 creates text in every 1 hour increment - * + * */ "visibleIncrement": string; set(property:"visibleIncrement", value: string): void; get(property:"visibleIncrement"): string; watch(property:"visibleIncrement", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -3904,36 +3904,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -3941,15 +3941,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -3957,43 +3957,43 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Called from dijit/form/_DateTimeTextBox to pass a keypress event * from the dijit/form/TimeTextBox to be handled in this widget - * - * @param e + * + * @param e */ handleKey(e: Event): any; /** * May be overridden to disable certain dates in the TimePicker e.g. isDisabledDate=locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -4001,9 +4001,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -4011,15 +4011,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -4028,9 +4028,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -4039,9 +4039,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -4050,9 +4050,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -4061,9 +4061,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -4072,9 +4072,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -4083,9 +4083,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -4093,34 +4093,34 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** * Select the first displayed item in the list. - * + * */ selectFirstNode(): void; /** * Select the last displayed item in the list - * + * */ selectLastNode(): void; /** * Select the item just below the current selection. * If nothing selected, select first node. - * + * */ selectNextNode(): void; /** * Select the item just above the current selection. * If nothing selected, select last node (if * you select Previous and try to keep scrolling up the list). - * + * */ selectPreviousNode(): void; /** @@ -4128,63 +4128,63 @@ declare module dijit { * When options.selector is omitted, output follows RFC3339 * The local time zone is included as an offset from GMT, except when selector=='time' (time without a date) * Does not check bounds. Only years between 100 and 9999 are supported. - * - * @param dateObject A Date object - * @param options OptionalAn object with the following properties:selector (String): "date" or "time" for partial formatting of the Date object.Both date and time will be formatted by default.zulu (Boolean): if true, UTC/GMT is used for a timezonemilliseconds (Boolean): if true, output milliseconds + * + * @param dateObject A Date object + * @param options OptionalAn object with the following properties:selector (String): "date" or "time" for partial formatting of the Date object.Both date and time will be formatted by default.zulu (Boolean): if true, UTC/GMT is used for a timezonemilliseconds (Boolean): if true, output milliseconds */ serialize(dateObject: Date, options?: Object): any; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Used set('value') instead. - * - * @param value + * + * @param value */ setValue(value: Date): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -4192,29 +4192,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -4222,49 +4222,49 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Notification that a time was selected. It may be the same as the previous value. - * - * @param time + * + * @param time */ onChange(time: Date): void; /** - * - * @param node + * + * @param node */ onClick(node: HTMLElement): void; /** - * - * @param node + * + * @param node */ onDeselect(node: HTMLElement): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** - * - * @param node + * + * @param node */ onHover(node: HTMLElement): void; /** - * + * */ onOpen(): void; /** - * - * @param node + * + * @param node */ onSelect(node: HTMLElement): void; /** - * - * @param node + * + * @param node */ onUnhover(node: HTMLElement): void; } @@ -4272,58 +4272,58 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/_TimePicker.__Constraints.html * - * + * */ class __Constraints { constructor(); /** * override strings for am in times - * + * */ "am": string; /** * See dijit/_TimePicker.clickableIncrement - * + * */ "clickableIncrement": string; /** * override pattern with this string - * + * */ "datePattern": string; /** * choice of long, short, medium or full (plus any custom additions). Defaults to 'short' - * + * */ "formatLength": string; /** * (format only) use 4 digit years whenever 2 digit years are called for - * + * */ "fullYear": boolean; /** * override the locale used to determine formatting rules - * + * */ "locale": string; /** * override strings for pm in times - * + * */ "pm": string; /** * choice of 'time','date' (default: date and time) - * + * */ "selector": string; /** * (parse only) strict parsing, off by default - * + * */ "strict": boolean; /** * override pattern with this string - * + * */ "timePattern": string; } @@ -4336,20 +4336,20 @@ declare module dijit { * Call this.own(...) on list of handles (returned from dojo/aspect, dojo/on, * dojo/Stateful::watch, or any class (including widgets) with a destroyRecursive() or destroy() method. * Then call destroy() later to destroy this instance and release the resources. - * + * */ class Destroyable { constructor(); /** * Destroy this class, releasing any resources registered via own(). - * - * @param preserveDom + * + * @param preserveDom */ destroy(preserveDom?: boolean): void; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(handle:any): any; } @@ -4360,22 +4360,22 @@ declare module dijit { * A simple GUI for choosing a date in the context of a monthly calendar. * This widget can't be used in a form because it doesn't serialize the date to an * field. For a form element, use dijit/form/DateTextBox instead. - * + * * Note that the parser takes all dates attributes passed in the * RFC 3339 format, e.g. 2005-06-30T08:05:00-07:00 * so that they are serializable and locale-independent. - * + * * Also note that this widget isn't keyboard accessible; use dijit.Calendar for that - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class CalendarLite extends dijit._WidgetBase implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -4384,58 +4384,58 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -4445,24 +4445,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -4472,7 +4472,7 @@ declare module dijit { * Date object containing the currently focused date, or the date which would be focused * if the calendar itself was focused. Also indicates which year and month to display, * i.e. the current "page" the calendar is on. - * + * */ "currentFocus": Date; set(property:"currentFocus", value: Date): void; @@ -4481,14 +4481,14 @@ declare module dijit { /** * JavaScript namespace to find calendar routines. If unspecified, uses Gregorian calendar routines * at dojo/date and dojo/date/locale. - * + * */ "datePackage": string; set(property:"datePackage", value: string): void; get(property:"datePackage"): string; watch(property:"datePackage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "dateTemplateString": string; set(property:"dateTemplateString", value: string): void; @@ -4496,7 +4496,7 @@ declare module dijit { watch(property:"dateTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * How to represent the days of the week in the calendar header. See locale - * + * */ "dayWidth": string; set(property:"dayWidth", value: string): void; @@ -4506,7 +4506,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -4517,14 +4517,14 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; get(property:"domNode"): HTMLElement; watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "dowTemplateString": string; set(property:"dowTemplateString", value: string): void; @@ -4535,7 +4535,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -4546,7 +4546,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -4555,14 +4555,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -4570,7 +4570,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -4578,7 +4578,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -4586,7 +4586,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -4595,14 +4595,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -4610,14 +4610,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -4626,7 +4626,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -4634,179 +4634,179 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The currently selected Date, initially set to invalid date to indicate no selection. - * + * */ "value": Date; set(property:"value", value: Date): void; get(property:"value"): Date; watch(property:"value", callback:{(property?:string, oldValue?:Date, newValue?: Date):void}) :{unwatch():void} /** - * + * */ "weekTemplateString": string; set(property:"weekTemplateString", value: string): void; get(property:"weekTemplateString"): string; watch(property:"weekTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -4814,41 +4814,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus the calendar by focusing one of the calendar cells - * + * */ focus(): void; /** @@ -4856,15 +4856,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -4872,49 +4872,49 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * May be overridden to return CSS classes to associate with the date entry for the given dateObject, * for example to indicate a holiday in specified locale. - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ getClassForDate(dateObject: Date, locale?: String): String; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Sets calendar's value to today's date - * + * */ goToToday(): void; /** * May be overridden to disable certain dates in the calendar e.g. isDisabledDate=dojo.date.locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -4922,9 +4922,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -4932,15 +4932,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -4949,9 +4949,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -4960,9 +4960,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -4971,9 +4971,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -4982,9 +4982,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -4993,9 +4993,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -5004,13 +5004,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -5018,55 +5018,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -5074,29 +5074,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -5106,8 +5106,8 @@ declare module dijit { getCachedTemplate(): any; /** * Called only when the selected date has changed - * - * @param date + * + * @param date */ onChange(date: Date): void; } @@ -5117,60 +5117,60 @@ declare module dijit { * * Displays name of current month padded to the width of the month * w/the longest name, so that changing months doesn't change width. - * + * * Create as: - * + * * new Calendar._MonthWidget({ * lang: ..., * dateLocaleModule: ... * }) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthWidget extends dijit._WidgetBase { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -5179,14 +5179,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -5196,24 +5196,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -5223,7 +5223,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -5234,7 +5234,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -5245,7 +5245,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -5256,7 +5256,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -5265,7 +5265,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -5273,7 +5273,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -5281,7 +5281,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -5289,14 +5289,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -5305,7 +5305,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -5314,165 +5314,165 @@ declare module dijit { /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -5480,36 +5480,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -5517,15 +5517,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -5533,29 +5533,29 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -5563,9 +5563,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -5573,15 +5573,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -5590,9 +5590,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -5601,9 +5601,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -5612,9 +5612,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -5623,9 +5623,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -5634,9 +5634,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -5645,9 +5645,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** @@ -5655,7 +5655,7 @@ declare module dijit { * Called after the DOM fragment has been created, but not necessarily * added to the document. Do not include any operations which rely on * node dimensions or placement. - * + * */ postCreate(): void; /** @@ -5663,55 +5663,55 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -5719,29 +5719,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; } @@ -5752,53 +5752,53 @@ declare module dijit { * * The Declaration widget allows a developer to declare new widget * classes directly from a snippet of markup. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Declaration extends dijit._Widget { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -5807,14 +5807,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -5824,31 +5824,31 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "defaults": Object; set(property:"defaults", value: Object): void; @@ -5858,7 +5858,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -5869,7 +5869,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -5878,7 +5878,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -5889,7 +5889,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -5900,7 +5900,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -5909,7 +5909,7 @@ declare module dijit { /** * List containing the prototype for this widget, and also any mixins, * ex: ["dijit._Widget", "dijit._Container"] - * + * */ "mixins": Object; set(property:"mixins", value: Object): void; @@ -5918,7 +5918,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -5926,7 +5926,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -5934,7 +5934,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -5942,14 +5942,14 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -5958,7 +5958,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -5966,7 +5966,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Name of class being declared, ex: "acme.myWidget" - * + * */ "widgetClass": string; set(property:"widgetClass", value: string): void; @@ -5974,178 +5974,178 @@ declare module dijit { watch(property:"widgetClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -6153,36 +6153,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -6190,15 +6190,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -6206,54 +6206,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -6262,9 +6262,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -6273,9 +6273,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -6284,9 +6284,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -6295,9 +6295,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -6306,9 +6306,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -6317,13 +6317,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -6331,62 +6331,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -6394,29 +6394,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -6424,114 +6424,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -6540,26 +6540,26 @@ declare module dijit { * * A simple GUI for choosing a date in the context of a monthly calendar. * See CalendarLite for general description. Calendar extends CalendarLite, adding: - * + * * month drop down list * keyboard navigation * CSS classes for hover/mousepress on date, month, and year nodes * support of deprecated methods (will be removed in 2.0) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree */ class Calendar extends dijit.CalendarLite implements dijit._Widget, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Custom press, release, and click synthetic events * which trigger on a left mouse click, touch, or space/enter keyup. - * + * */ "a11yclick": Object; /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -6568,7 +6568,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -6577,58 +6577,58 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -6638,31 +6638,31 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -6672,7 +6672,7 @@ declare module dijit { * Date object containing the currently focused date, or the date which would be focused * if the calendar itself was focused. Also indicates which year and month to display, * i.e. the current "page" the calendar is on. - * + * */ "currentFocus": Date; set(property:"currentFocus", value: Date): void; @@ -6681,14 +6681,14 @@ declare module dijit { /** * JavaScript namespace to find calendar routines. If unspecified, uses Gregorian calendar routines * at dojo/date and dojo/date/locale. - * + * */ "datePackage": string; set(property:"datePackage", value: string): void; get(property:"datePackage"): string; watch(property:"datePackage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "dateTemplateString": string; set(property:"dateTemplateString", value: string): void; @@ -6696,7 +6696,7 @@ declare module dijit { watch(property:"dateTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * How to represent the days of the week in the calendar header. See locale - * + * */ "dayWidth": string; set(property:"dayWidth", value: string): void; @@ -6706,7 +6706,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -6717,14 +6717,14 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; get(property:"domNode"): HTMLElement; watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "dowTemplateString": string; set(property:"dowTemplateString", value: string): void; @@ -6732,7 +6732,7 @@ declare module dijit { watch(property:"dowTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Defines a type of widget. - * + * */ "dndType": string; set(property:"dndType", value: string): void; @@ -6741,7 +6741,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -6749,7 +6749,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -6760,7 +6760,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -6771,14 +6771,14 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; get(property:"lang"): string; watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "observer": string; set(property:"observer", value: string): void; @@ -6787,25 +6787,25 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; get(property:"searchContainerNode"): boolean; watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * A parameter needed by RadioGroupSlide only. An optional parameter to force + * A parameter needed by RadioGroupSlide only. An optional paramter to force * the ContentPane to slide in from a set direction. Defaults * to "random", or specify one of "top", "left", "right", "bottom" * to slideFrom top, left, right, or bottom. - * + * */ "slideFrom": string; set(property:"slideFrom", value: string): void; @@ -6813,7 +6813,7 @@ declare module dijit { watch(property:"slideFrom", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -6821,7 +6821,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -6829,7 +6829,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -6838,14 +6838,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -6853,14 +6853,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -6869,7 +6869,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -6877,14 +6877,14 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The currently selected Date, initially set to invalid date to indicate no selection. - * + * */ "value": Date; set(property:"value", value: Date): void; get(property:"value"): Date; watch(property:"value", callback:{(property?:string, oldValue?:Date, newValue?: Date):void}) :{unwatch():void} /** - * + * */ "weekTemplateString": string; set(property:"weekTemplateString", value: string): void; @@ -6892,178 +6892,178 @@ declare module dijit { watch(property:"weekTemplateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -7071,41 +7071,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus the calendar by focusing one of the calendar cells - * + * */ focus(): void; /** @@ -7113,15 +7113,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -7129,38 +7129,38 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * May be overridden to return CSS classes to associate with the date entry for the given dateObject, * for example to indicate a holiday in specified locale. - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ getClassForDate(dateObject: Date, locale: String): String; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Sets calendar's value to today's date - * + * */ goToToday(): void; /** @@ -7168,26 +7168,26 @@ declare module dijit { * Called from _onKeyDown() to handle keydown on a stand alone Calendar, * and also from dijit/form/_DateTimeTextBox to pass a keydown event * from the dijit/form/DateTextBox to be handled in this widget - * - * @param evt + * + * @param evt */ handleKey(evt: Event): any; /** * May be overridden to disable certain dates in the calendar e.g. isDisabledDate=dojo.date.locale.isWeekend - * - * @param dateObject - * @param locale Optional + * + * @param dateObject + * @param locale Optional */ isDisabledDate(dateObject: Date, locale?: String): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** @@ -7195,9 +7195,9 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: String, func: Function): any; /** @@ -7205,15 +7205,15 @@ declare module dijit { * Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). * Note that the function is not run in any particular scope, so if (for example) you want it to run in the * widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)). - * - * @param type Name of event (ex: "click") or extension event like touch.press. - * @param func + * + * @param type Name of event (ex: "click") or extension event like touch.press. + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -7222,9 +7222,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -7233,9 +7233,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -7244,9 +7244,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -7255,9 +7255,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -7266,9 +7266,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -7277,13 +7277,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -7291,68 +7291,68 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('value', ...) instead. - * - * @param value + * + * @param value */ setValue(value: Date): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -7360,29 +7360,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -7395,127 +7395,127 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** - * - * @param value + * + * @param value */ onChange(value: any): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Deprecated. Notification that a date cell was selected. It may be the same as the previous value. * Formerly used by dijit/form/_DateTimeTextBox (and thus dijit/form/DateTextBox) * to get notification when the user has clicked a date. Now onExecute() (above) is used. - * - * @param date + * + * @param date */ onValueSelected(date: Date): void; } @@ -7524,16 +7524,16 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/Calendar._MonthDropDown.html * * The list-of-months drop down from the MonthDropDownButton - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthDropDown extends dijit._Widget implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -7542,44 +7542,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -7588,14 +7588,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -7605,24 +7605,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -7632,7 +7632,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -7643,7 +7643,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -7652,7 +7652,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -7663,7 +7663,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -7674,7 +7674,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -7683,7 +7683,7 @@ declare module dijit { /** * List of names of months, possibly w/some undefined entries for Hebrew leap months * (ex: ["January", "February", undefined, "April", ...]) - * + * */ "months": Object; set(property:"months", value: Object): void; @@ -7692,14 +7692,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -7707,7 +7707,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -7715,7 +7715,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -7724,14 +7724,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -7739,14 +7739,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -7755,7 +7755,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -7763,180 +7763,180 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -7944,36 +7944,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -7981,15 +7981,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -7997,54 +7997,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -8053,9 +8053,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -8064,9 +8064,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -8075,9 +8075,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -8086,9 +8086,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -8097,9 +8097,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -8108,13 +8108,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -8122,62 +8122,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -8185,29 +8185,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -8220,120 +8220,120 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when month is selected from drop down - * - * @param month + * + * @param month */ onChange(month: number): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -8342,15 +8342,15 @@ declare module dijit { * * DropDownButton for the current month. Displays name of current month * and a list of month names in the drop down - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class _MonthDropDownButton extends dijit.form.DropDownButton { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -8358,14 +8358,14 @@ declare module dijit { watch(property:"active", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "alt": string; set(property:"alt", value: string): void; get(property:"alt"): string; watch(property:"alt", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "aria-label": string; set(property:"aria-label", value: string): void; @@ -8374,7 +8374,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -8383,44 +8383,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -8430,21 +8430,21 @@ declare module dijit { * Set to true to make the drop down at least as wide as this * widget. Set to false if the drop down should just be its * default width. - * + * */ "autoWidth": boolean; set(property:"autoWidth", value: boolean): void; get(property:"autoWidth"): boolean; watch(property:"autoWidth", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -8454,24 +8454,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -8480,18 +8480,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -8501,7 +8501,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -8510,7 +8510,7 @@ declare module dijit { /** * Should this widget respond to user input? * In markup, this is specified as "disabled='disabled'", or just "disabled". - * + * */ "disabled": boolean; set(property:"disabled", value: boolean): void; @@ -8521,7 +8521,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -8530,7 +8530,7 @@ declare module dijit { /** * The widget to display as a popup. This widget must be * defined before the startup function is called. - * + * */ "dropDown": Object; set(property:"dropDown", value: Object): void; @@ -8539,7 +8539,7 @@ declare module dijit { /** * This variable controls the position of the drop down. * It's an array of strings with the following values: - * + * * before: places drop down to the left of the target node/widget, or to the right in * the case of RTL scripts like Hebrew and Arabic * after: places drop down to the right of the target node/widget, or to the left in @@ -8548,7 +8548,7 @@ declare module dijit { * below: drop down goes below target node * The list is positions is tried, in order, until a position is found where the drop down fits * within the viewport. - * + * */ "dropDownPosition": Object; set(property:"dropDownPosition", value: Object): void; @@ -8557,7 +8557,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -8566,7 +8566,7 @@ declare module dijit { /** * Set to true to make the drop down exactly as wide as this * widget. Overrides autoWidth. - * + * */ "forceWidth": boolean; set(property:"forceWidth", value: boolean): void; @@ -8574,7 +8574,7 @@ declare module dijit { watch(property:"forceWidth", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -8582,7 +8582,7 @@ declare module dijit { watch(property:"hovering", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Class to apply to DOMNode in button to make it display an icon - * + * */ "iconClass": string; set(property:"iconClass", value: string): void; @@ -8593,7 +8593,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -8601,7 +8601,7 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Fires onChange for each value change or only on demand - * + * */ "intermediateChanges": boolean; set(property:"intermediateChanges", value: boolean): void; @@ -8609,7 +8609,7 @@ declare module dijit { watch(property:"intermediateChanges", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Content to display in button. - * + * */ "label": string; set(property:"label", value: string): void; @@ -8620,7 +8620,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -8630,7 +8630,7 @@ declare module dijit { * The max height for our dropdown. * Any dropdown taller than this will have scrollbars. * Set to 0 for no max height, or -1 to limit height to available space in viewport - * + * */ "maxHeight": number; set(property:"maxHeight", value: number): void; @@ -8638,7 +8638,7 @@ declare module dijit { watch(property:"maxHeight", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Name used when submitting form; same as "name" attribute or plain HTML elements - * + * */ "name": string; set(property:"name", value: string): void; @@ -8647,7 +8647,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -8655,14 +8655,14 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * On focus, should this widget scroll into view? - * + * */ "scrollOnFocus": boolean; set(property:"scrollOnFocus", value: boolean): void; get(property:"scrollOnFocus"): boolean; watch(property:"scrollOnFocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -8673,10 +8673,10 @@ declare module dijit { * (If showLabel=false then iconClass must be specified.) * Especially useful for toolbars. * If showLabel=true, the label will become the title (a.k.a. tooltip/hint) of the icon. - * + * * The exception case is for computers in high-contrast mode, where the label * will still be displayed, since the icon doesn't appear. - * + * */ "showLabel": boolean; set(property:"showLabel", value: boolean): void; @@ -8684,7 +8684,7 @@ declare module dijit { watch(property:"showLabel", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -8692,7 +8692,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -8700,7 +8700,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Order fields are traversed when user hits the tab key - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -8709,14 +8709,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -8724,14 +8724,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -8740,7 +8740,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -8748,7 +8748,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "type": string; set(property:"type", value: string): void; @@ -8756,7 +8756,7 @@ declare module dijit { watch(property:"type", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Corresponds to the native HTML element's attribute. - * + * */ "value": string; set(property:"value", value: string): void; @@ -8766,200 +8766,200 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Closes the drop down on this widget - * - * @param focus If true, refocuses the button widget + * + * @param focus If true, refocuses the button widget */ closeDropDown(focus: boolean): void; /** * Compare 2 values (as returned by get('value') for this widget). - * - * @param val1 - * @param val2 + * + * @param val1 + * @param val2 */ compare(val1: any, val2: any): number; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -8967,41 +8967,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Put focus on this widget - * + * */ focus(): void; /** @@ -9009,15 +9009,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -9025,54 +9025,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Deprecated. Use get('value') instead. - * + * */ getValue(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * + * */ isLoaded(): boolean; /** @@ -9080,36 +9080,36 @@ declare module dijit { * if there's an href and it hasn't been loaded yet, and * then opens the drop down. This is basically a callback when the * user presses the down arrow button to open the drop down. - * + * */ loadAndOpenDropDown(): any; /** - * - * @param callback + * + * @param callback */ loadDropDown(callback: Function): void; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Opens the dropdown for this widget. To be called only when this.dropDown * has been created and is ready to display (ie, it's data is loaded). - * + * */ openDropDown(): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -9118,9 +9118,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -9129,9 +9129,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -9140,9 +9140,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -9151,9 +9151,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -9162,9 +9162,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -9173,105 +9173,105 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('disabled', ...) instead. - * - * @param disabled + * + * @param disabled */ setDisabled(disabled: boolean): void; /** * Deprecated. Use set('label', ...) instead. - * - * @param content + * + * @param content */ setLabel(content: String): void; /** * Deprecated. Use set('value', ...) instead. - * - * @param value + * + * @param value */ setValue(value: String): void; /** - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** * Callback when the user presses the down arrow button or presses * the down arrow key to open/close the drop down. * Toggle the drop-down widget; if it is up, close it, if not, open it - * + * */ toggleDropDown(): void; /** @@ -9279,29 +9279,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -9314,124 +9314,124 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when this widget's value is changed. - * - * @param newValue + * + * @param newValue */ onChange(newValue: any): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): boolean; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** - * + * */ onMonthSelect(): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -9441,19 +9441,19 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/CheckedMenuItem.html * * A checkbox-like menu item for toggling on and off - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class CheckedMenuItem extends dijit.MenuItem { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Text for the accelerator (shortcut) key combination, a control, alt, etc. modified keystroke meant to * execute the menu item regardless of where the focus is on the page. - * + * * Note that although Menu can display accelerator keys, there is no infrastructure to actually catch and * execute those accelerators. - * + * */ "accelKey": string; set(property:"accelKey", value: string): void; @@ -9461,7 +9461,7 @@ declare module dijit { watch(property:"accelKey", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -9470,7 +9470,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -9479,51 +9479,51 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -9531,7 +9531,7 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Our checked state - * + * */ "checked": boolean; set(property:"checked", value: boolean): void; @@ -9539,14 +9539,14 @@ declare module dijit { watch(property:"checked", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Character (or string) used in place of checkbox icon when display in high contrast mode - * + * */ "checkedChar": string; set(property:"checkedChar", value: string): void; get(property:"checkedChar"): string; watch(property:"checkedChar", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -9556,24 +9556,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -9582,18 +9582,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -9603,7 +9603,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -9612,7 +9612,7 @@ declare module dijit { /** * If true, the menu item is disabled. * If false, the menu item is enabled. - * + * */ "disabled": boolean; set(property:"disabled", value: boolean): void; @@ -9623,7 +9623,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -9632,7 +9632,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -9640,14 +9640,14 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; get(property:"hovering"): boolean; watch(property:"hovering", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "iconClass": string; set(property:"iconClass", value: string): void; @@ -9658,7 +9658,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -9666,7 +9666,7 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Menu text as HTML - * + * */ "label": string; set(property:"label", value: string): void; @@ -9677,7 +9677,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -9686,21 +9686,21 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "role": string; set(property:"role", value: string): void; get(property:"role"): string; watch(property:"role", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -9711,7 +9711,7 @@ declare module dijit { * also known as a mnemonic. * This is denoted in the label by surrounding the single character with {}. * For example, if label="{F}ile", then shortcutKey="F". - * + * */ "shortcutKey": string; set(property:"shortcutKey", value: string): void; @@ -9719,7 +9719,7 @@ declare module dijit { watch(property:"shortcutKey", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -9727,7 +9727,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -9736,14 +9736,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -9751,14 +9751,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -9767,7 +9767,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -9775,178 +9775,178 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -9954,41 +9954,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus on this MenuItem - * + * */ focus(): void; /** @@ -9996,15 +9996,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -10012,73 +10012,73 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the index of this widget within its container parent. * It returns -1 if the parent does not exist, or if the parent * is not a dijit/_Container - * + * */ getIndexInParent(): any; /** * Returns null if this is the last child of the parent, * otherwise returns the next element sibling to the "right". - * + * */ getNextSibling(): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns null if this is the first child of the parent, * otherwise returns the next element sibling to the "left". - * + * */ getPreviousSibling(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -10087,9 +10087,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -10098,9 +10098,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -10109,9 +10109,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -10120,9 +10120,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -10131,9 +10131,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -10142,13 +10142,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -10156,74 +10156,74 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('disabled', bool) instead. - * - * @param disabled + * + * @param disabled */ setDisabled(disabled: boolean): void; /** * Deprecated. Use set('label', ...) instead. - * - * @param content + * + * @param content */ setLabel(content: String): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -10231,29 +10231,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -10266,119 +10266,119 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * User defined function to handle check/uncheck events - * - * @param checked + * + * @param checked */ onChange(checked: boolean): void; /** * User defined function to handle clicks - * + * */ onClick(): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -10386,26 +10386,26 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/DialogUnderlay.html * * A component used to block input behind a dijit/Dialog. - * + * * Normally this class should not be instantiated directly, but rather shown and hidden via * DialogUnderlay.show() and DialogUnderlay.hide(). And usually the module is not accessed directly * at all, since the underlay is shown and hidden by Dialog.DialogLevelManager. - * + * * The underlay itself can be styled based on and id: - * + * * #myDialog_underlay { background-color:red; } * In the case of dijit.Dialog, this id is based on the id of the Dialog, * suffixed with _underlay. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class DialogUnderlay extends dijit._Widget implements dijit._TemplatedMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -10414,44 +10414,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -10460,14 +10460,14 @@ declare module dijit { /** * Root CSS class of the widget (ex: dijitTextBox), used to construct CSS classes to indicate * widget state. - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -10477,24 +10477,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -10502,7 +10502,7 @@ declare module dijit { watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * Id of the dialog.... DialogUnderlay's id is based on this id - * + * */ "dialogId": string; set(property:"dialogId", value: string): void; @@ -10512,7 +10512,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -10523,7 +10523,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -10532,7 +10532,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -10543,7 +10543,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -10554,7 +10554,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -10563,14 +10563,14 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; get(property:"ownerDocument"): Object; watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -10578,7 +10578,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -10586,7 +10586,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -10595,14 +10595,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -10610,14 +10610,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -10626,7 +10626,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -10634,170 +10634,170 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -10805,36 +10805,36 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -10842,15 +10842,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -10858,59 +10858,59 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Hide the underlay. - * + * */ hide(): void; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -10919,9 +10919,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -10930,9 +10930,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -10941,9 +10941,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -10952,9 +10952,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -10963,9 +10963,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -10974,13 +10974,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -10988,75 +10988,75 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Show the dialog underlay - * + * */ show(): void; /** * Display the underlay with the given attributes set. If the underlay is already displayed, * then adjust it's attributes as specified. - * - * @param attrs The parameters to create DialogUnderlay with. - * @param zIndex zIndex of the underlay + * + * @param attrs The parameters to create DialogUnderlay with. + * @param zIndex zIndex of the underlay */ show(attrs: Object, zIndex: number): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -11064,29 +11064,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -11099,114 +11099,114 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -11214,38 +11214,38 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.10/dijit/_ConfirmDialogMixin.html * * Mixin for Dialog/TooltipDialog with OK/Cancel buttons. - * + * */ class _ConfirmDialogMixin extends dijit._WidgetsInTemplateMixin { constructor(); /** - * + * */ "actionBarTemplate": Object; /** * Label of cancel button - * + * */ "buttonCancel": string; /** * Label of OK button - * + * */ "buttonOk": string; /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; /** - * + * */ startup(): void; } @@ -11253,9 +11253,9 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.10/dijit/ConfirmDialog.html * * A Dialog with OK/Cancel buttons. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class ConfirmDialog extends dijit.Dialog implements dijit._ConfirmDialogMixin { constructor(params: Object, srcNodeRef?: HTMLElement); @@ -11265,7 +11265,7 @@ declare module dijit { /** * HTML snippet to show the action bar (gray bar with OK/cancel buttons). * Blank by default, but used by ConfirmDialog/ConfirmTooltipDialog subclasses. - * + * */ "actionBarTemplate": string; set(property:"actionBarTemplate", value: string): void; @@ -11273,7 +11273,7 @@ declare module dijit { watch(property:"actionBarTemplate", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -11282,7 +11282,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -11291,44 +11291,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -11338,14 +11338,14 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; set(property:"autofocus", value: boolean): void; get(property:"autofocus"): boolean; watch(property:"autofocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -11353,7 +11353,7 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Label of cancel button - * + * */ "buttonCancel": string; set(property:"buttonCancel", value: string): void; @@ -11361,14 +11361,14 @@ declare module dijit { watch(property:"buttonCancel", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Label of OK button - * + * */ "buttonOk": string; set(property:"buttonOk", value: string): void; get(property:"buttonOk"): string; watch(property:"buttonOk", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -11376,7 +11376,7 @@ declare module dijit { watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; set(property:"closable", value: boolean): void; @@ -11386,24 +11386,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -11413,7 +11413,7 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; @@ -11422,14 +11422,14 @@ declare module dijit { /** * Used to provide a context require to the dojo/parser in order to be * able to use relative MIDs (e.g. ./Widget) in the widget's template. - * + * */ "contextRequire": Function; set(property:"contextRequire", value: Function): void; get(property:"contextRequire"): Function; watch(property:"contextRequire", callback:{(property?:string, oldValue?:Function, newValue?: Function):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -11439,17 +11439,17 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; get(property:"dir"): string; watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * * false - don't adjust size of children * true - if there is a single visible child widget, set it's size to however big the ContentPane is - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -11460,7 +11460,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -11470,7 +11470,7 @@ declare module dijit { * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; set(property:"draggable", value: boolean): void; @@ -11478,7 +11478,7 @@ declare module dijit { watch(property:"draggable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -11486,7 +11486,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -11495,7 +11495,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -11504,7 +11504,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -11512,7 +11512,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -11523,7 +11523,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -11534,7 +11534,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -11542,9 +11542,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -11553,7 +11553,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -11563,10 +11563,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -11577,7 +11577,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -11585,7 +11585,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -11593,7 +11593,7 @@ declare module dijit { watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; set(property:"maxRatio", value: number): void; @@ -11604,10 +11604,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -11615,7 +11615,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -11624,7 +11624,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -11632,7 +11632,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -11643,7 +11643,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -11651,7 +11651,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -11659,7 +11659,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -11669,7 +11669,7 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; set(property:"refocus", value: boolean): void; @@ -11677,14 +11677,14 @@ declare module dijit { watch(property:"refocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -11692,7 +11692,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -11702,14 +11702,14 @@ declare module dijit { * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; set(property:"state", value: string): void; get(property:"state"): string; watch(property:"state", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -11717,7 +11717,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -11726,14 +11726,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -11741,14 +11741,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -11757,7 +11757,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -11766,7 +11766,7 @@ declare module dijit { /** * Should we parse the template to find widgets that might be * declared in markup inside it? (Remove for 2.0 and assume true) - * + * */ "widgetsInTemplate": boolean; set(property:"widgetsInTemplate", value: boolean): void; @@ -11776,232 +11776,232 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -12010,14 +12010,14 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** @@ -12025,15 +12025,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -12041,93 +12041,93 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** - * + * */ getValues(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Hide the dialog - * + * */ hide(): any; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -12136,9 +12136,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -12147,9 +12147,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -12158,9 +12158,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position: String): any; /** @@ -12169,9 +12169,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -12180,9 +12180,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -12191,17 +12191,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, DocumentFragment, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -12209,124 +12209,124 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ reset(): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -12334,38 +12334,38 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -12378,7 +12378,7 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** @@ -12386,58 +12386,58 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -12445,7 +12445,7 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** @@ -12453,113 +12453,113 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -12571,15 +12571,15 @@ declare module dijit { * Pops up a modal dialog window, blocking access to the screen * and also graying out the screen Dialog is extended from * ContentPane so it supports all the same parameters (href, etc.). - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Dialog extends dijit.layout.ContentPane implements dijit._TemplatedMixin, dijit.form._FormMixin, dijit._DialogMixin, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -12588,7 +12588,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -12597,44 +12597,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -12644,21 +12644,21 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; set(property:"autofocus", value: boolean): void; get(property:"autofocus"): boolean; watch(property:"autofocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -12666,7 +12666,7 @@ declare module dijit { watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; set(property:"closable", value: boolean): void; @@ -12676,24 +12676,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -12703,14 +12703,14 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; get(property:"content"): string; watch(property:"content", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -12720,17 +12720,17 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; get(property:"dir"): string; watch(property:"dir", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * * false - don't adjust size of children * true - if there is a single visible child widget, set it's size to however big the ContentPane is - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -12741,7 +12741,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -12751,7 +12751,7 @@ declare module dijit { * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; set(property:"draggable", value: boolean): void; @@ -12759,7 +12759,7 @@ declare module dijit { watch(property:"draggable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -12767,7 +12767,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -12776,7 +12776,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -12785,7 +12785,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -12793,7 +12793,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -12804,7 +12804,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -12815,7 +12815,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -12823,9 +12823,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -12834,7 +12834,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -12844,10 +12844,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -12858,7 +12858,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -12866,7 +12866,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -12874,7 +12874,7 @@ declare module dijit { watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; set(property:"maxRatio", value: number): void; @@ -12885,10 +12885,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -12896,7 +12896,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -12905,7 +12905,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -12913,7 +12913,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -12924,7 +12924,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -12932,7 +12932,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -12940,7 +12940,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -12950,7 +12950,7 @@ declare module dijit { * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; set(property:"refocus", value: boolean): void; @@ -12958,14 +12958,14 @@ declare module dijit { watch(property:"refocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -12973,7 +12973,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -12983,14 +12983,14 @@ declare module dijit { * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; set(property:"state", value: string): void; get(property:"state"): string; watch(property:"state", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -12998,7 +12998,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -13007,14 +13007,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -13022,14 +13022,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -13038,7 +13038,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -13048,232 +13048,232 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom?: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -13282,14 +13282,14 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** @@ -13297,15 +13297,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -13313,93 +13313,93 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** - * + * */ getValues(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Hide the dialog - * + * */ hide(): any; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -13408,9 +13408,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -13419,9 +13419,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -13430,9 +13430,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -13441,9 +13441,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -13452,9 +13452,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -13463,17 +13463,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -13481,124 +13481,124 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** - * + * */ reset(): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -13606,38 +13606,38 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -13650,7 +13650,7 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** @@ -13658,58 +13658,58 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -13717,7 +13717,7 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** @@ -13725,113 +13725,113 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -13839,41 +13839,41 @@ declare module dijit { /** * Permalink: http://dojotoolkit.org/api/1.9/dijit/Dialog._DialogBase.html * - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified, replace srcNodeRef with my generated DOM tree. */ class _DialogBase extends dijit._TemplatedMixin implements dijit.form._FormMixin, dijit._DialogMixin, dijit._CssStateMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; /** * A Toggle to modify the default focus behavior of a Dialog, which * is to focus on the first dialog element after opening the dialog. * False will disable autofocusing. Default: true - * + * */ "autofocus": boolean; /** - * + * */ "baseClass": string; /** * Dialog show [x] icon to close itself, and ESC key will close the dialog. - * + * */ "closable": boolean; /** - * + * */ "cssStateNodes": Object; /** @@ -13881,88 +13881,88 @@ declare module dijit { * This ContentPane parameter doesn't make sense for Dialog, since Dialog * is never a child of a layout container, nor can you specify the size of * Dialog in order to control the size of an inner widget. - * + * */ "doLayout": boolean; /** * Toggles the movable aspect of the Dialog. If true, Dialog * can be dragged by it's title. If false it will remain centered * in the viewport. - * + * */ "draggable": boolean; /** * The time in milliseconds it takes the dialog to fade in and out - * + * */ "duration": number; /** * True if cursor is over this widget - * + * */ "hovering": boolean; /** * Maximum size to allow the dialog to expand to, relative to viewport size - * + * */ "maxRatio": number; /** * True if Dialog is currently displayed on screen. - * + * */ "open": boolean; /** * A Toggle to modify the default focus behavior of a Dialog, which * is to re-focus the element which had focus before being opened. * False will disable refocusing. Default: true - * + * */ "refocus": boolean; /** - * + * */ "searchContainerNode": boolean; /** * Will be "Error" if one or more of the child widgets has an invalid value, * "Incomplete" if not all of the required child widgets are filled in. Otherwise, "", * which indicates that the form is ready to be submitted. - * + * */ "state": string; /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; /** - * + * */ "templateString": string; /** * Construct the UI for this widget from a template, setting this.domNode. - * + * */ buildRendering(): void; /** * You can call this function directly, ex. in the event that you * programmatically add a widget to the form after the form has been * initialized. - * - * @param inStartup + * + * @param inStartup */ connectChildren(inStartup: boolean): void; /** - * + * */ destroy(): void; /** - * + * */ destroyRendering(): void; /** * Deprecated method. Applications no longer need to call this. Remove for 2.0. - * + * */ disconnectChildren(): void; /** @@ -13971,64 +13971,64 @@ declare module dijit { * After the user has pressed the submit button, the Dialog * first calls onExecute() to notify the container to hide the * dialog and restore focus to wherever it used to be. - * + * * Then this method is called. - * - * @param formContents + * + * @param formContents */ execute(formContents: Object): void; /** - * + * */ focus(): void; /** - * + * */ getValues(): any; /** * Hide the dialog - * + * */ hide(): any; /** * Returns true if all of the widgets are valid. * Deprecated, will be removed in 2.0. Use get("state") instead. - * + * */ isValid: {(): boolean}; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** - * + * */ reset(): void; /** - * - * @param val + * + * @param val */ setValues(val: any): any; /** * Display the dialog - * + * */ show(): any; /** - * + * */ startup(): void; /** * returns if the form is valid - same as isValid - but * provides a few additional (ui-specific) features: - * + * * it will highlight any sub-widgets that are not valid * it will call focus() on the first invalid sub-widget - * + * */ validate(): any; /** @@ -14041,7 +14041,7 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onCancel(): void; /** @@ -14049,24 +14049,24 @@ declare module dijit { * Developer shouldn't override or connect to this method; * it's a private communication device between the TooltipDialog * and the thing that opened it (ex: dijit/form/DropDownButton) - * + * */ onExecute(): void; /** * Called when data has been loaded from an href. * Unlike most other callbacks, this function can be connected to (via dojo.connect) * but should not be overridden. - * + * */ onLoad(): void; /** * Stub function to connect to if you want to do something * (like disable/enable a submit button) when the valid * state changes on the form as a whole. - * + * * Deprecated. Will be removed in 2.0. Use watch("state", ...) instead. - * - * @param isValid + * + * @param isValid */ onValidStateChange(isValid: boolean): void; } @@ -14076,38 +14076,38 @@ declare module dijit { * Controls the various active "levels" on the page, starting with the * stuff initially visible on the page (at z-index 0), and then having an entry for * each Dialog shown. - * + * */ interface _DialogLevelManager { /** * Called when the specified dialog is hidden/destroyed, after the fade-out * animation ends, in order to reset page focus, fix the underlay, etc. * If the specified dialog isn't open then does nothing. - * + * * Caller is responsible for either setting display:none on the dialog domNode, * or calling dijit/popup.hide(), or removing it from the page DOM. - * - * @param dialog + * + * @param dialog */ hide(dialog: dijit._WidgetBase): void; /** * Returns true if specified Dialog is the top in the task - * - * @param dialog + * + * @param dialog */ isTop(dialog: dijit._WidgetBase): boolean; /** * Call right before fade-in animation for new dialog. * Saves current focus, displays/adjusts underlay for new dialog, * and sets the z-index of the dialog itself. - * + * * New dialog will be displayed on top of all currently displayed dialogs. - * + * * Caller is responsible for setting focus in new dialog after the fade-in * animation completes. - * - * @param dialog - * @param underlayAttrs + * + * @param dialog + * @param underlayAttrs */ show(dialog: dijit._WidgetBase, underlayAttrs: Object): void; } @@ -14119,15 +14119,15 @@ declare module dijit { * A keyboard accessible color-picking widget * Grid showing various colors, so the user can pick a certain color. * Can be used standalone, or as a popup. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class ColorPalette extends dijit._Widget implements dijit._TemplatedMixin, dijit._PaletteMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -14136,7 +14136,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -14145,51 +14145,51 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; get(property:"attributeMap"): Object; watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; @@ -14197,14 +14197,14 @@ declare module dijit { watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * CSS class applied to each cell in the palette - * + * */ "cellClass": string; set(property:"cellClass", value: string): void; get(property:"cellClass"): string; watch(property:"cellClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -14214,24 +14214,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -14240,18 +14240,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -14259,7 +14259,7 @@ declare module dijit { watch(property:"cssStateNodes", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Number of milliseconds before a held key or button becomes typematic - * + * */ "defaultTimeout": number; set(property:"defaultTimeout", value: number): void; @@ -14269,7 +14269,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -14280,7 +14280,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -14289,7 +14289,7 @@ declare module dijit { /** * Constructor for Object created for each cell of the palette. * dyeClass should implement the dijit/_PaletteMixin.__Dye interface. - * + * */ "dyeClass": Function; set(property:"dyeClass", value: Function): void; @@ -14298,7 +14298,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -14306,7 +14306,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -14317,7 +14317,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -14328,7 +14328,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -14337,7 +14337,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -14345,14 +14345,14 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Size of grid, either "7x10" or "3x4". - * + * */ "palette": string; set(property:"palette", value: string): void; get(property:"palette"): string; watch(property:"palette", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -14360,7 +14360,7 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -14368,7 +14368,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -14376,7 +14376,7 @@ declare module dijit { watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Widget tab index. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -14385,7 +14385,7 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; @@ -14393,7 +14393,7 @@ declare module dijit { watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The template of this widget. - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -14403,7 +14403,7 @@ declare module dijit { * Fraction of time used to change the typematic timer between events * 1.0 means that each typematic event fires at defaultTimeout intervals * Less than 1.0 means that each typematic event fires at an increasing faster rate - * + * */ "timeoutChangeRate": number; set(property:"timeoutChangeRate", value: number): void; @@ -14411,14 +14411,14 @@ declare module dijit { watch(property:"timeoutChangeRate", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -14427,7 +14427,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -14435,7 +14435,7 @@ declare module dijit { watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Currently selected color/emoticon/etc. - * + * */ "value": string; set(property:"value", value: string): void; @@ -14443,178 +14443,178 @@ declare module dijit { watch(property:"value", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -14622,41 +14622,41 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Focus this widget. Puts focus on the most recently focused cell. - * + * */ focus(): void; /** @@ -14664,15 +14664,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -14680,54 +14680,54 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -14736,9 +14736,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -14747,9 +14747,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -14758,9 +14758,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -14769,9 +14769,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -14780,9 +14780,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -14791,13 +14791,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -14805,62 +14805,62 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -14868,29 +14868,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -14903,120 +14903,120 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Callback when a cell is selected. - * - * @param value Value corresponding to cell. + * + * @param value Value corresponding to cell. */ onChange(value: String): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -15026,104 +15026,104 @@ declare module dijit { * * Object associated with each cell in a ColorPalette palette. * Implements dijit/Dye. - * - * @param alias English name of the color. - * @param row Vertical position in grid. - * @param col - * @param title Localized name of the color. + * + * @param alias English name of the color. + * @param row Vertical position in grid. + * @param col + * @param title Localized name of the color. */ class _Color extends dojo._base.Color { constructor(alias: String, row: number, col: any, title: String); /** - * + * */ "a": number; /** - * + * */ "b": number; /** - * + * */ "g": number; /** - * + * */ "hcTemplate": string; /** - * + * */ "r": number; /** - * + * */ "template": string; /** - * - * @param cell - * @param blankGif + * + * @param cell + * @param blankGif */ fillCell(cell: HTMLElement, blankGif: String): void; /** * Note that although dijit._Color is initialized with a value like "white" getValue() always * returns a hex value - * + * */ getValue(): any; /** * makes sure that the object has correct attributes - * + * */ sanitize(): void; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: any[]): Function; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: String): Function; /** * Takes a named string, hex string, array of rgb or rgba values, * an object with r, g, b, and a properties, or another Color object * and sets this color instance to that value. - * - * @param color + * + * @param color */ setColor(color: Object): Function; /** * Returns a css color string in rgb(a) representation - * - * @param includeAlpha Optional + * + * @param includeAlpha Optional */ toCss(includeAlpha: boolean): String; /** * Returns a CSS color string in hexadecimal representation - * + * */ toHex(): String; /** * Returns 3 component array of rgb values - * + * */ toRgb(): any[]; /** * Returns a 4 component array of rgba values from the color * represented by this object. - * + * */ toRgba(): any[]; /** * Returns a visual representation of the color - * + * */ toString(): any; } @@ -15134,15 +15134,15 @@ declare module dijit { * * An accessible fieldset that can be expanded or collapsed via * its legend. Fieldset extends dijit.TitlePane. - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class Fieldset extends dijit.TitlePane { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -15151,7 +15151,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -15160,44 +15160,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -15205,14 +15205,14 @@ declare module dijit { watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * The root className to use for the various states of this widget - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -15222,24 +15222,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -15249,7 +15249,7 @@ declare module dijit { * The innerHTML of the ContentPane. * Note that the initialization parameter / argument to set("content", ...) * can be a String, DomNode, Nodelist, or _Widget. - * + * */ "content": string; set(property:"content", value: string): void; @@ -15258,18 +15258,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -15279,7 +15279,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -15290,7 +15290,7 @@ declare module dijit { * This ContentPane parameter doesn't make sense for TitlePane, since TitlePane * is never a child of a layout container, nor should TitlePane try to control * the size of an inner widget. - * + * */ "doLayout": boolean; set(property:"doLayout", value: boolean): void; @@ -15301,7 +15301,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -15309,7 +15309,7 @@ declare module dijit { watch(property:"domNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * Time in milliseconds to fade in/fade out - * + * */ "duration": number; set(property:"duration", value: number): void; @@ -15317,7 +15317,7 @@ declare module dijit { watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * Message that shows if an error occurs - * + * */ "errorMessage": string; set(property:"errorMessage", value: string): void; @@ -15326,7 +15326,7 @@ declare module dijit { /** * Extract visible content from inside of .... . * I.e., strip and (and it's contents) from the href - * + * */ "extractContent": boolean; set(property:"extractContent", value: boolean): void; @@ -15335,7 +15335,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -15343,7 +15343,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -15354,7 +15354,7 @@ declare module dijit { * Set this at construction if you want to load data externally when the * pane is shown. (Set preload=true to load it immediately.) * Changing href after creation doesn't have any effect; Use set('href', ...); - * + * */ "href": string; set(property:"href", value: string): void; @@ -15365,7 +15365,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -15373,9 +15373,9 @@ declare module dijit { watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Parameters to pass to xhrGet() request, for example: - * + * *
- * + * */ "ioArgs": Object; set(property:"ioArgs", value: Object): void; @@ -15384,7 +15384,7 @@ declare module dijit { /** * Indicates that this widget will call resize() on it's child widgets * when they become visible. - * + * */ "isLayoutContainer": boolean; set(property:"isLayoutContainer", value: boolean): void; @@ -15394,10 +15394,10 @@ declare module dijit { * True if the ContentPane has data in it, either specified * during initialization (via href or inline content), or set * via set('content', ...) / set('href', ...) - * + * * False if it doesn't have any content, or if ContentPane is * still in the process of downloading href. - * + * */ "isLoaded": boolean; set(property:"isLoaded", value: boolean): void; @@ -15408,7 +15408,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -15416,7 +15416,7 @@ declare module dijit { watch(property:"lang", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Message that shows while downloading - * + * */ "loadingMessage": string; set(property:"loadingMessage", value: string): void; @@ -15427,10 +15427,10 @@ declare module dijit { * Calling onLoadDeferred.then() registers your * callback to be called only once, when the prior set('href', ...) call or * the initial href parameter to the constructor finishes loading. - * + * * This is different than an onLoad() handler which gets called any time any href * or content is loaded. - * + * */ "onLoadDeferred": Object; set(property:"onLoadDeferred", value: Object): void; @@ -15438,7 +15438,7 @@ declare module dijit { watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Whether fieldset is opened or closed. - * + * */ "open": boolean; set(property:"open", value: boolean): void; @@ -15447,7 +15447,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -15455,7 +15455,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * Parse content and create the widgets, if any. - * + * */ "parseOnLoad": boolean; set(property:"parseOnLoad", value: boolean): void; @@ -15466,7 +15466,7 @@ declare module dijit { * will search for data-dojo-type (or dojoType). For backwards compatibility * reasons defaults to dojo._scopeName (which is "dojo" except when * multi-version support is used, when it will be something like dojo16, dojo20, etc.) - * + * */ "parserScope": string; set(property:"parserScope", value: string): void; @@ -15474,7 +15474,7 @@ declare module dijit { watch(property:"parserScope", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Force load of data on initialization even if pane is hidden. - * + * */ "preload": boolean; set(property:"preload", value: boolean): void; @@ -15482,7 +15482,7 @@ declare module dijit { watch(property:"preload", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Prevent caching of data from href's by appending a timestamp to the href. - * + * */ "preventCache": boolean; set(property:"preventCache", value: boolean): void; @@ -15490,14 +15490,14 @@ declare module dijit { watch(property:"preventCache", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * Refresh (re-download) content when pane goes from hidden to shown - * + * */ "refreshOnShow": boolean; set(property:"refreshOnShow", value: boolean): void; get(property:"refreshOnShow"): boolean; watch(property:"refreshOnShow", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -15505,14 +15505,14 @@ declare module dijit { watch(property:"searchContainerNode", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; get(property:"srcNodeRef"): HTMLElement; watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** - * + * */ "stopParser": boolean; set(property:"stopParser", value: boolean): void; @@ -15520,7 +15520,7 @@ declare module dijit { watch(property:"stopParser", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -15529,7 +15529,7 @@ declare module dijit { /** * Tabindex setting for the title (so users can tab to the title then * use space/enter to open/close the title pane) - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -15538,14 +15538,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -15553,7 +15553,7 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Content of the legend tag. Overrides tag if not empty. - * + * */ "title": string; set(property:"title", value: string): void; @@ -15561,7 +15561,7 @@ declare module dijit { watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Whether pane can be opened or closed by clicking the title bar. - * + * */ "toggleable": boolean; set(property:"toggleable", value: boolean): void; @@ -15570,7 +15570,7 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; @@ -15580,219 +15580,219 @@ declare module dijit { * Makes the given widget a child of this widget. * Inserts specified child widget's dom node as a child of this widget's * container node, and possibly does other processing (such as layout). - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** - * + * */ buildRendering(): void; /** * Cancels an in-flight download of content - * + * */ cancel(): void; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** - * - * @param params - * @param srcNodeRef + * + * @param params + * @param srcNodeRef */ create(params: any, srcNodeRef: any): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** - * + * */ destroy(): void; /** * Destroy all the widgets inside the ContentPane and empty containerNode - * - * @param preserveDom + * + * @param preserveDom */ destroyDescendants(preserveDom?: boolean): void; /** * Destroy the ContentPane and its contents - * - * @param preserveDom + * + * @param preserveDom */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** @@ -15800,15 +15800,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -15816,78 +15816,78 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Function that should grab the content specified via href. - * - * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. + * + * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published. */ ioMethod(args: Object): any; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param params - * @param node - * @param ctor + * + * @param params + * @param node + * @param ctor */ markupFactory(params: any, node: any, ctor: any): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -15896,9 +15896,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -15907,9 +15907,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -15918,9 +15918,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -15929,9 +15929,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -15940,9 +15940,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -15951,17 +15951,17 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** - * + * */ postMixInProperties(): void; /** @@ -15969,116 +15969,116 @@ declare module dijit { * cancels any currently in-flight requests * posts "loading..." message * sends XHR to download new data - * + * */ refresh(): any; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * See dijit/layout/_LayoutWidget.resize() for description. * Although ContentPane doesn't extend _LayoutWidget, it does implement * the same API. - * - * @param changeSize - * @param resultSize + * + * @param changeSize + * @param resultSize */ resize(changeSize: any, resultSize: any): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: String): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: HTMLElement): void; /** * Deprecated. Use set('content', ...) instead. - * - * @param data + * + * @param data */ setContent(data: NodeList): void; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: String): any; /** * Deprecated. Use set('href', ...) instead. - * - * @param href + * + * @param href */ setHref(href: URL): any; /** * Deprecated. Use set('title', ...) instead. - * - * @param title + * + * @param title */ setTitle(title: String): void; /** * Call startup() on all children including non _Widget ones like dojo/dnd/Source objects - * + * */ startup(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -16086,29 +16086,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -16121,58 +16121,58 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Called when this widget is being displayed as a popup (ex: a Calendar popped * up from a DateTextBox), and it is hidden. * This is called from the dijit.popup code, and should not be called directly. - * + * * Also used as a parameter for children of dijit/layout/StackContainer or subclasses. * Callback if a user tries to close the child. Child will be closed if this function returns true. - * + * */ onClose(): boolean; /** * Called on DOM faults, require faults etc. in content. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * By default (if this method is not overriden), it returns * nothing, so the error message is just printed to the console. - * - * @param error + * + * @param error */ onContentError(error: Error): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** * Called when download is finished. - * + * */ onDownloadEnd(): void; /** * Called when download error occurs. - * + * * In order to display an error message in the pane, return * the error message from this method, as an HTML string. - * + * * Default behavior (if this method is not overriden) is to display * the error message inside the pane. - * - * @param error + * + * @param error */ onDownloadError(error: Error): any; /** @@ -16180,103 +16180,103 @@ declare module dijit { * The string returned by this function will be the html * that tells the user we are loading something. * Override with your own function if you want to change text. - * + * */ onDownloadStart(): any; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Event hook, is called after everything is loaded and widgetified - * - * @param data + * + * @param data */ onLoad(data: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; /** * Event hook, is called before old content is cleared - * + * */ onUnload(): void; } @@ -16284,9 +16284,9 @@ declare module dijit { * Permalink: http://dojotoolkit.org/api/1.9/dijit/DropDownMenu.html * * A menu, without features for context menu (Meaning, drop down menu) - * - * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. - * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree + * + * @param params Hash of initialization parameters for widget, including scalar values (like title, duration etc.)and functions, typically callbacks like onClick.The hash can contain any of the widget's properties, excluding read-only properties. + * @param srcNodeRef OptionalIf a srcNodeRef (DOM node) is specified:use srcNodeRef.innerHTML as my contentsif this is a behavioral widget then apply behavior to that srcNodeRefotherwise, replace srcNodeRef with my generated DOM tree */ class DropDownMenu extends dijit._MenuBase implements dijit._OnDijitClickMixin { constructor(params?: Object, srcNodeRef?: HTMLElement); @@ -16296,7 +16296,7 @@ declare module dijit { * since TAB is a navigation operation and not a selection one. * For Windows apps, pressing the ALT key focuses the menubar menus (similar to TAB navigation) but the * menu is not active (ie no dropdown) until an item is clicked. - * + * */ "activated": boolean; set(property:"activated", value: boolean): void; @@ -16304,7 +16304,7 @@ declare module dijit { watch(property:"activated", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * True if mouse was pressed while over this widget, and hasn't been released yet - * + * */ "active": boolean; set(property:"active", value: boolean): void; @@ -16313,7 +16313,7 @@ declare module dijit { /** * Object to which attach points and events will be scoped. Defaults * to 'this'. - * + * */ "attachScope": Object; set(property:"attachScope", value: Object): void; @@ -16322,44 +16322,44 @@ declare module dijit { /** * Deprecated. Instead of attributeMap, widget should have a _setXXXAttr attribute * for each XXX attribute to be mapped to the DOM. - * + * * attributeMap sets up a "binding" between attributes (aka properties) * of the widget and the widget's DOM. * Changes to widget attributes listed in attributeMap will be * reflected into the DOM. - * + * * For example, calling set('title', 'hello') * on a TitlePane will automatically cause the TitlePane's DOM to update * with the new title. - * + * * attributeMap is a hash where the key is an attribute of the widget, * and the value reflects a binding to a: - * + * * DOM node attribute * focus: {node: "focusNode", type: "attribute"} * Maps this.focus to this.focusNode.focus - * + * * DOM node innerHTML * title: { node: "titleNode", type: "innerHTML" } * Maps this.title to this.titleNode.innerHTML - * + * * DOM node innerText * title: { node: "titleNode", type: "innerText" } * Maps this.title to this.titleNode.innerText - * + * * DOM node CSS class * myClass: { node: "domNode", type: "class" } * Maps this.myClass to this.domNode.className - * + * * If the value is an array, then each element in the array matches one of the * formats of the above list. - * + * * There are also some shorthands for backwards compatibility: - * + * * string --> { node: string, type: "attribute" }, for example: * "focusNode" ---> { node: "focusNode", type: "attribute" } * "" --> { node: "domNode", type: "attribute" } - * + * */ "attributeMap": Object; set(property:"attributeMap", value: Object): void; @@ -16368,21 +16368,21 @@ declare module dijit { /** * A toggle to control whether or not a Menu gets focused when opened as a drop down from a MenuBar * or DropDownButton/ComboButton. Note though that it always get focused when opened via the keyboard. - * + * */ "autoFocus": boolean; set(property:"autoFocus", value: boolean): void; get(property:"autoFocus"): boolean; watch(property:"autoFocus", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** - * + * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "class": string; set(property:"class", value: string): void; @@ -16392,24 +16392,24 @@ declare module dijit { * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: - * + * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: - * + * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. - * + * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. - * + * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; @@ -16418,18 +16418,18 @@ declare module dijit { /** * Subclasses may define a cssStateNodes property that lists sub-nodes within the widget that * need CSS classes applied on mouse hover/press and focus. - * + * * Each entry in this optional hash is a an attach-point name (like "upArrowButton") mapped to a CSS class name * (like "dijitUpArrowButton"). Example: - * + * * { * "upArrowButton": "dijitUpArrowButton", * "downArrowButton": "dijitDownArrowButton" * } * The above will set the CSS class dijitUpArrowButton to the this.upArrowButton DOMNode when it - * + * * is hovered, etc. - * + * */ "cssStateNodes": Object; set(property:"cssStateNodes", value: Object): void; @@ -16439,7 +16439,7 @@ declare module dijit { * Bi-directional support, as defined by the HTML DIR * attribute. Either left-to-right "ltr" or right-to-left "rtl". If undefined, widgets renders in page's * default direction. - * + * */ "dir": string; set(property:"dir", value: string): void; @@ -16450,7 +16450,7 @@ declare module dijit { * Nodes may by assigned to other properties, usually through the * template system's data-dojo-attach-point syntax, but the domNode * property is the canonical "top level" node in widget UI. - * + * */ "domNode": HTMLElement; set(property:"domNode", value: HTMLElement): void; @@ -16459,7 +16459,7 @@ declare module dijit { /** * This widget or a widget it contains has focus, or is "active" because * it was recently clicked. - * + * */ "focused": boolean; set(property:"focused", value: boolean): void; @@ -16467,7 +16467,7 @@ declare module dijit { watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * The currently focused child widget, or null if there isn't one - * + * */ "focusedChild": Object; set(property:"focusedChild", value: Object): void; @@ -16475,7 +16475,7 @@ declare module dijit { watch(property:"focusedChild", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * True if cursor is over this widget - * + * */ "hovering": boolean; set(property:"hovering", value: boolean): void; @@ -16486,7 +16486,7 @@ declare module dijit { * system. If the developer passes an ID which is known not to be * unique, the specified ID is ignored and the system-generated ID is * used instead. - * + * */ "id": string; set(property:"id", value: string): void; @@ -16497,7 +16497,7 @@ declare module dijit { * as defined by the HTML LANG attribute. * Value must be among the list of locales specified during by the Dojo bootstrap, * formatted according to RFC 3066 (like en-us). - * + * */ "lang": string; set(property:"lang", value: string): void; @@ -16507,10 +16507,10 @@ declare module dijit { * If multiple characters are typed where each keystroke happens within * multiCharSearchDuration of the previous keystroke, * search for nodes matching all the keystrokes. - * + * * For example, typing "ab" will search for entries starting with * "ab" unless the delay between "a" and "b" is greater than multiCharSearchDuration. - * + * */ "multiCharSearchDuration": number; set(property:"multiCharSearchDuration", value: number): void; @@ -16519,7 +16519,7 @@ declare module dijit { /** * The document this widget belongs to. If not specified to constructor, will default to * srcNodeRef.ownerDocument, or if no sourceRef specified, then to the document global - * + * */ "ownerDocument": Object; set(property:"ownerDocument", value: Object): void; @@ -16527,7 +16527,7 @@ declare module dijit { watch(property:"ownerDocument", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to menu that displayed me - * + * */ "parentMenu": Object; set(property:"parentMenu", value: Object): void; @@ -16536,7 +16536,7 @@ declare module dijit { /** * For a passive (unclicked) Menu, number of milliseconds before hovering (without clicking) will cause * the popup to open. Default is Infinity, meaning you need to click the menu to open it. - * + * */ "passivePopupDelay": number; set(property:"passivePopupDelay", value: number): void; @@ -16545,14 +16545,14 @@ declare module dijit { /** * After a menu has been activated (by clicking on it etc.), number of milliseconds before hovering * (without clicking) another MenuItem causes that MenuItem's popup to automatically open. - * + * */ "popupDelay": number; set(property:"popupDelay", value: number): void; get(property:"popupDelay"): number; watch(property:"popupDelay", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** - * + * */ "searchContainerNode": boolean; set(property:"searchContainerNode", value: boolean): void; @@ -16563,7 +16563,7 @@ declare module dijit { * If a submenu is open, will be set to MenuItem that displayed the submenu. OTOH, if * this Menu is in passive mode (i.e. hasn't been clicked yet), will be null, because * "selected" is not merely "hovered". - * + * */ "selected": Object; set(property:"selected", value: Object): void; @@ -16571,7 +16571,7 @@ declare module dijit { watch(property:"selected", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * pointer to original DOM node - * + * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; @@ -16579,7 +16579,7 @@ declare module dijit { watch(property:"srcNodeRef", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * HTML style attributes as cssText string or name/value hash - * + * */ "style": string; set(property:"style", value: string): void; @@ -16589,7 +16589,7 @@ declare module dijit { * Tab index of the container; same as HTML tabIndex attribute. * Note then when user tabs into the container, focus is immediately * moved to the first item in the container. - * + * */ "tabIndex": string; set(property:"tabIndex", value: string): void; @@ -16598,14 +16598,14 @@ declare module dijit { /** * Path to template (HTML file) for this widget relative to dojo.baseUrl. * Deprecated: use templateString with require([... "dojo/text!..."], ...) instead - * + * */ "templatePath": string; set(property:"templatePath", value: string): void; get(property:"templatePath"): string; watch(property:"templatePath", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * + * */ "templateString": string; set(property:"templateString", value: string): void; @@ -16613,14 +16613,14 @@ declare module dijit { watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * HTML title attribute. - * + * * For form widgets this specifies a tooltip to display when hovering over * the widget (just like the native HTML title attribute). - * + * * For TitlePane or for when this widget is a child of a TabContainer, AccordionContainer, * etc., it's used to specify the tab label, accordion pane title, etc. In this case it's * interpreted as HTML. - * + * */ "title": string; set(property:"title", value: string): void; @@ -16629,210 +16629,210 @@ declare module dijit { /** * When this widget's title attribute is used to for a tab label, accordion pane title, etc., * this specifies the tooltip to appear when the mouse is hovered over that text. - * + * */ "tooltip": string; set(property:"tooltip", value: string): void; get(property:"tooltip"): string; watch(property:"tooltip", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** - * - * @param widget - * @param insertIndex Optional + * + * @param widget + * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex?: number): void; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: String, value?: Object): any; /** * This method is deprecated, use get() or set() directly. - * - * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. - * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. + * + * @param name The property to get or set. If an object is passed here and nota string, its keys are used as names of attributes to be setand the value of the object as values to set in the widget. + * @param value OptionalOptional. If provided, attr() operates as a setter. If omitted,the current value of the named property is returned. */ attr(name: Object, value?: Object): any; /** * Construct the UI for this widget, setting this.domNode. * Most widgets will mixin dijit._TemplatedMixin, which implements this method. - * + * */ buildRendering(): void; /** * Selector (passed to on.selector()) used to identify MenuItem child widgets, but exclude inert children * like MenuSeparator. If subclass overrides to a string (ex: "> *"), the subclass must require dojo/query. - * - * @param node + * + * @param node */ childSelector(node: HTMLElement): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: String): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: String, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: Object, event: Function, method: Function): any; /** * Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead. - * + * * Connects specified obj/event to specified method of this object * and registers for disconnect() on widget destroy. - * + * * Provide widget-specific analog to dojo.connect, except with the * implicit use of this widget as the target object. * Events connected with this.connect are disconnected upon * destruction. - * - * @param obj - * @param event - * @param method + * + * @param obj + * @param event + * @param method */ connect(obj: any, event: Function, method: Function): any; /** * Deprecated. You can call this in postCreate() to attach the keyboard handlers to the container, * but the preferred method is to override _onLeftArrow() and _onRightArrow(), or * _onUpArrow() and _onDownArrow(), to call focusPrev() and focusNext(). - * - * @param prevKeyCodes Key codes for navigating to the previous child. - * @param nextKeyCodes Key codes for navigating to the next child. + * + * @param prevKeyCodes Key codes for navigating to the previous child. + * @param nextKeyCodes Key codes for navigating to the next child. */ connectKeyNavHandlers(prevKeyCodes: dojo.keys, nextKeyCodes: dojo.keys): void; /** * Wrapper to setTimeout to avoid deferred functions executing * after the originating widget has been destroyed. * Returns an object handle with a remove method (that returns null) (replaces clearTimeout). - * - * @param fcn Function reference. - * @param delay OptionalDelay, defaults to 0. + * + * @param fcn Function reference. + * @param delay OptionalDelay, defaults to 0. */ defer(fcn: Function, delay?: number): Object; /** * Destroy this widget, but not its descendants. Descendants means widgets inside of * this.containerNode. Will also destroy any resources (including widgets) registered via this.own(). - * + * * This method will also destroy internal widgets such as those created from a template, * assuming those widgets exist inside of this.domNode but outside of this.containerNode. - * + * * For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not * depend on the current ability to destroy a widget without destroying its descendants. Generally * they should use destroyRecursive() for widgets with children. - * - * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets + * + * @param preserveDom If true, this method will leave the original DOM structure alone.Note: This will not yet work with _TemplatedMixin widgets */ destroy(preserveDom?: boolean): void; /** * Recursively destroy the children of this widget and their * descendants. - * - * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. + * + * @param preserveDom OptionalIf true, the preserveDom attribute is passed to all descendantwidget's .destroy() method. Not for use with _Templatedwidgets. */ destroyDescendants(preserveDom?: boolean): void; /** @@ -16840,69 +16840,69 @@ declare module dijit { * This is the generic "destructor" function that all widget users * should call to cleanly discard with a widget. Once a widget is * destroyed, it is removed from the manager object. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structurealone of descendant Widgets. Note: This will NOT work withdijit._TemplatedMixin widgets. */ destroyRecursive(preserveDom?: boolean): void; /** * Destroys the DOM nodes associated with this widget. - * - * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. + * + * @param preserveDom OptionalIf true, this method will leave the original DOM structure aloneduring tear-down. Note: this will not work with _Templatedwidgets yet. */ destroyRendering(preserveDom?: boolean): void; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Disconnects handle created by connect. - * - * @param handle + * + * @param handle */ disconnect(handle: any): void; /** * Used by widgets to signal that a synthetic event occurred, ex: - * + * * myWidget.emit("attrmodified-selectedChildWidget", {}). * Emits an event on this.domNode named type.toLowerCase(), based on eventObj. * Also calls onType() method, if present, and returns value from that method. * By default passes eventObj to callback, but will pass callbackArgs instead, if specified. * Modifies eventObj by adding missing parameters (bubbles, cancelable, widget). - * - * @param type - * @param eventObj Optional - * @param callbackArgs Optional + * + * @param type + * @param eventObj Optional + * @param callbackArgs Optional */ emit(type: String, eventObj?: Object, callbackArgs?: any[]): any; /** * Default focus() implementation: focus the first child. - * + * */ focus(): void; /** * Focus specified child widget. - * - * @param widget Reference to container's child widget - * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one + * + * @param widget Reference to container's child widget + * @param last If true and if widget has multiple focusable nodes, focus thelast one instead of the first one */ focusChild(widget: dijit._WidgetBase, last: boolean): void; /** * Focus the first focusable child in the container. - * + * */ focusFirstChild(): void; /** * Focus the last focusable child in the container. - * + * */ focusLastChild(): void; /** * Focus the next widget - * + * */ focusNext(): void; /** * Focus the last focusable node in the previous widget * (ex: go to the ComboButton icon section rather than button section) - * + * */ focusPrev(): void; /** @@ -16910,15 +16910,15 @@ declare module dijit { * Get a named property from a widget. The property may * potentially be retrieved via a getter method. If no getter is defined, this * just retrieves the object's property. - * + * * For example, if the widget has properties foo and bar * and a method named _getFooAttr(), calling: * myWidget.get("foo") would be equivalent to calling * widget._getFooAttr() and myWidget.get("bar") * would be equivalent to the expression * widget.bar2 - * - * @param name The property to get. + * + * @param name The property to get. */ get(name: any): any; /** @@ -16926,65 +16926,65 @@ declare module dijit { * is this widget. Note that it does not return all descendants, but rather just direct children. * Analogous to Node.childNodes, * except containing widgets rather than DOMNodes. - * + * * The result intentionally excludes internally created widgets (a.k.a. supporting widgets) * outside of this.containerNode. - * + * * Note that the array returned is a simple array. Application code should not assume * existence of methods like forEach(). - * + * */ getChildren(): any[]; /** * Returns all the widgets contained by this, i.e., all widgets underneath this.containerNode. * This method should generally be avoided as it returns widgets declared in templates, which are * supposed to be internal/hidden, but it's left here for back-compat reasons. - * + * */ getDescendants(): any[]; /** * Gets the index of the child in this container or -1 if not found - * - * @param child + * + * @param child */ getIndexOfChild(child: dijit._WidgetBase): any; /** * Returns the parent widget of this widget. - * + * */ getParent(): any; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. - * + * */ hasChildren(): boolean; /** * Return true if this widget can currently be focused * and false if not - * + * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) - * + * */ isLeftToRight(): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: String, func: Function): any; /** - * - * @param type protected - * @param func + * + * @param type protected + * @param func */ on(type: Function, func: Function): any; /** * Track specified handles and remove/destroy them when this instance is destroyed, unless they were * already removed/destroyed manually. - * + * */ own(): any; /** @@ -16993,9 +16993,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: String): any; /** @@ -17004,9 +17004,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: String): any; /** @@ -17015,9 +17015,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: String): any; /** @@ -17026,9 +17026,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: String, position?: number): any; /** @@ -17037,9 +17037,9 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: HTMLElement, position?: number): any; /** @@ -17048,13 +17048,13 @@ declare module dijit { * A convenience function provided in all _Widgets, providing a simple * shorthand mechanism to put an existing (or newly created) Widget * somewhere in the dom, and allow chaining. - * - * @param reference Widget, DOMNode, or id of widget or DOMNode - * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). + * + * @param reference Widget, DOMNode, or id of widget or DOMNode + * @param position OptionalIf reference is a widget (or id of widget), and that widget has an ".addChild" method,it will be called passing this widget instance into that method, supplying the optionalposition index passed. In this case position (if specified) should be an integer.If reference is a DOMNode (or id matching a DOMNode but not a widget),the position argument can be a numeric index or a string"first", "last", "before", or "after", same as dojo/dom-construct::place(). */ placeAt(reference: dijit._WidgetBase, position?: number): any; /** - * + * */ postCreate(): void; /** @@ -17062,82 +17062,82 @@ declare module dijit { * but before the widget template is instantiated. Especially * useful to set properties that are referenced in the widget * template. - * + * */ postMixInProperties(): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * Removes the passed widget instance from this widget but does * not destroy it. You can also pass in an integer indicating * the index within the container to remove (ie, removeChild(5) removes the sixth widget). - * - * @param widget + * + * @param widget */ removeChild(widget: number): void; /** * Set a property on a widget * Sets named properties on a widget which may potentially be handled by a * setter in the widget. - * + * * For example, if the widget has properties foo and bar * and a method named _setFooAttr(), calling * myWidget.set("foo", "Howdy!") would be equivalent to calling * widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) * would be equivalent to the statement widget.bar = 3; - * + * * set() may also be called with a hash of name/value pairs, ex: - * + * * myWidget.set({ * foo: "Howdy", * bar: 3 * }); * This is equivalent to calling set(foo, "Howdy") and set(bar, 3) - * - * @param name The property to set. - * @param value The value to set in the property. + * + * @param name The property to set. + * @param value The value to set in the property. */ set(name: any, value: any): any; /** * Deprecated. Use set() instead. - * - * @param attr - * @param value + * + * @param attr + * @param value */ setAttribute(attr: String, value: any): void; /** * Processing after the DOM fragment is added to the document * Called after a widget and its children have been created and added to the page, * and all related widgets have finished their create() cycle, up through postCreate(). - * + * * Note that startup() may be called while the widget is still hidden, for example if the widget is * inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. * For widgets that need to do layout, it's best to put that layout code inside resize(), and then * extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible. - * + * */ startup(): void; /** - * + * */ startupKeyNavChildren(): void; /** * Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead. - * + * * Subscribes to the specified topic and calls the specified method * of this object and registers for unsubscribe() on widget destroy. - * + * * Provide widget-specific analog to dojo.subscribe, except with the * implicit use of this widget as the target object. - * - * @param t The topic - * @param method The callback + * + * @param t The topic + * @param method The callback */ subscribe(t: String, method: Function): any; /** @@ -17145,29 +17145,29 @@ declare module dijit { * When a widget is cast to a string, this method will be used to generate the * output. Currently, it does not implement any sort of reversible * serialization. - * + * */ toString(): string; /** * Deprecated. Override destroy() instead to implement custom widget tear-down * behavior. - * + * */ uninitialize(): boolean; /** * Deprecated, will be removed in 2.0, use handle.remove() instead. - * + * * Unsubscribes handle created by this.subscribe. * Also removes handle from this widget's list of subscriptions - * - * @param handle + * + * @param handle */ unsubscribe(handle: Object): void; /** * Watches a property for changes - * - * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched - * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. + * + * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched + * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value. */ watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void}; /** @@ -17180,27 +17180,27 @@ declare module dijit { * focus moved to something outside of it, or the user * clicked somewhere outside of it, or the widget was * hidden. - * + * */ onBlur(): void; /** * Attach point for notification about when the user cancels the current menu * This is an internal mechanism used for Menus to signal to their parent to * close them. In general developers should not attach to or override this method. - * - * @param closeAll + * + * @param closeAll */ onCancel(closeAll: boolean): void; /** * Connect to this function to receive notifications of mouse click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onClick(event: any): void; /** * Connect to this function to receive notifications of mouse double click events. - * - * @param event mouse Event + * + * @param event mouse Event */ onDblClick(event: any): void; /** @@ -17208,114 +17208,114 @@ declare module dijit { * This is an internal mechanism used for Menus to signal to their parent to * close them, because they are about to execute the onClick handler. In * general developers should not attach to or override this method. - * + * */ onExecute(): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. - * + * */ onFocus(): void; /** * Called when another widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate hide of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onHide(): void; /** * Called when cursor is over a MenuItem. - * - * @param item + * + * @param item */ onItemHover(item: dijit.MenuItem): void; /** * Callback fires when mouse exits a MenuItem - * - * @param item + * + * @param item */ onItemUnhover(item: dijit.MenuItem): void; /** * Attach point for notification about when a menu item has been searched for * via the keyboard search mechanism. - * - * @param item - * @param evt - * @param searchString - * @param numMatches + * + * @param item + * @param evt + * @param searchString + * @param numMatches */ onKeyboardSearch(item: dijit.MenuItem, evt: Event, searchString: String, numMatches: number): void; /** * Connect to this function to receive notifications of keys being pressed down. - * - * @param event key Event + * + * @param event key Event */ onKeyDown(event: any): void; /** * Connect to this function to receive notifications of printable keys being typed. - * - * @param event key Event + * + * @param event key Event */ onKeyPress(event: any): void; /** * Connect to this function to receive notifications of keys being released. - * - * @param event key Event + * + * @param event key Event */ onKeyUp(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is pressed down. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseDown(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseEnter(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseLeave(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseMove(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOut(event: any): void; /** * Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseOver(event: any): void; /** * Connect to this function to receive notifications of when the mouse button is released. - * - * @param event mouse Event + * + * @param event mouse Event */ onMouseUp(event: any): void; /** * Called when this widget becomes the selected pane in a * dijit/layout/TabContainer, dijit/layout/StackContainer, * dijit/layout/AccordionContainer, etc. - * + * * Also called to indicate display of a dijit.Dialog, dijit.TooltipDialog, or dijit.TitlePane. - * + * */ onShow(): void; } @@ -17330,15 +17330,15 @@ declare module dijit { * browsers, and clipboard operations may have different results, to name * a few limitations. Note: this widget should not be used with the HTML *