mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
11510 lines
564 KiB
TypeScript
11510 lines
564 KiB
TypeScript
// Type definitions for Dojo v1.9
|
|
// Project: http://dojotoolkit.org
|
|
// Definitions by: Michael Van Sickle <https://github.com/vansimke>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
|
|
|
|
declare namespace dojox {
|
|
|
|
namespace layout {
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/ContentPane.html
|
|
*
|
|
* An extended version of dijit.layout.ContentPane.
|
|
* Supports infile scripts and external ones declared by <script src=''...>
|
|
* relative path adjustments (content fetched from a different folder)
|
|
* <style> and <link rel='stylesheet' href='..'> tags,
|
|
* css paths inside cssText is adjusted (if you set adjustPaths = true)
|
|
*
|
|
* NOTE that dojo.require in script in the fetched file isn't recommended
|
|
* Many widgets need to be required at page load to work properly
|
|
*
|
|
* @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 ContentPane extends dijit.layout.ContentPane {
|
|
constructor(params?: Object, srcNodeRef?: HTMLElement);
|
|
/**
|
|
* Adjust relative paths in html string content to point to this page.
|
|
* Only useful if you grab content from a another folder then the current one
|
|
*
|
|
*/
|
|
"adjustPaths": boolean;
|
|
set(property:"adjustPaths", value: boolean): void;
|
|
get(property:"adjustPaths"): boolean;
|
|
watch(property:"adjustPaths", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Cleans content to make it less likely to generate DOM/JS errors.
|
|
* Useful if you send ContentPane a complete page, instead of a html fragment
|
|
* scans for:
|
|
*
|
|
* title Node, remove
|
|
* DOCTYPE tag, remove
|
|
*
|
|
*/
|
|
"cleanContent": boolean;
|
|
set(property:"cleanContent", value: boolean): void;
|
|
get(property:"cleanContent"): boolean;
|
|
watch(property:"cleanContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* Message that shows if an error occurs
|
|
*
|
|
*/
|
|
"errorMessage": string;
|
|
set(property:"errorMessage", value: string): void;
|
|
get(property:"errorMessage"): string;
|
|
watch(property:"errorMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Execute (eval) scripts that is found in the content
|
|
*
|
|
*/
|
|
"executeScripts": boolean;
|
|
set(property:"executeScripts", value: boolean): void;
|
|
get(property:"executeScripts"): boolean;
|
|
watch(property:"executeScripts", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Extract visible content from inside of <body> .... </body>.
|
|
* I.e., strip <html> and <head> (and it's contents) from the href
|
|
*
|
|
*/
|
|
"extractContent": boolean;
|
|
set(property:"extractContent", value: boolean): void;
|
|
get(property:"extractContent"): boolean;
|
|
watch(property:"extractContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* The href of the content that displays now.
|
|
* 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;
|
|
get(property:"href"): string;
|
|
watch(property:"href", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"ioArgs": Object;
|
|
set(property:"ioArgs", value: Object): void;
|
|
get(property:"ioArgs"): Object;
|
|
watch(property:"ioArgs", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget will call resize() on it's child widgets
|
|
* when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"isLoaded"): boolean;
|
|
watch(property:"isLoaded", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Message that shows while downloading
|
|
*
|
|
*/
|
|
"loadingMessage": string;
|
|
set(property:"loadingMessage", value: string): void;
|
|
get(property:"loadingMessage"): string;
|
|
watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* This is the dojo.Deferred returned by set('href', ...) and refresh().
|
|
* 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;
|
|
get(property:"onLoadDeferred"): Object;
|
|
watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Parse content and create the widgets, if any.
|
|
*
|
|
*/
|
|
"parseOnLoad": boolean;
|
|
set(property:"parseOnLoad", value: boolean): void;
|
|
get(property:"parseOnLoad"): boolean;
|
|
watch(property:"parseOnLoad", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Flag passed to parser. Root for attribute names to search for. If scopeName is dojo,
|
|
* 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;
|
|
get(property:"parserScope"): string;
|
|
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;
|
|
get(property:"preload"): boolean;
|
|
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;
|
|
get(property:"preventCache"): boolean;
|
|
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}
|
|
/**
|
|
* trigger/load styles in the content
|
|
*
|
|
*/
|
|
"renderStyles": boolean;
|
|
set(property:"renderStyles", value: boolean): void;
|
|
get(property:"renderStyles"): boolean;
|
|
watch(property:"renderStyles", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* replace keyword 'container' in scripts with 'dijit.byId(this.id)'
|
|
* NOTE this name might change in the near future
|
|
*
|
|
*/
|
|
"scriptHasHooks": boolean;
|
|
set(property:"scriptHasHooks", value: boolean): void;
|
|
get(property:"scriptHasHooks"): boolean;
|
|
watch(property:"scriptHasHooks", 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;
|
|
get(property:"stopParser"): boolean;
|
|
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;
|
|
get(property:"style"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
connect(obj: any, event: Function, method: Function): any;
|
|
/**
|
|
*
|
|
* @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.
|
|
*/
|
|
defer(fcn: Function, delay: number): Object;
|
|
/**
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Destroy all the widgets inside the ContentPane and empty containerNode
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy the ContentPane and its contents
|
|
*
|
|
* @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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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
|
|
*/
|
|
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;
|
|
/**
|
|
* Sends an HTTP GET request to the server.
|
|
*
|
|
* @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
|
|
*/
|
|
markupFactory(params: any, node: any, ctor: any): any;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
*
|
|
*/
|
|
postMixInProperties(): void;
|
|
/**
|
|
* [Re]download contents of href and display
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: String): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: HTMLElement): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: NodeList): void;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: String): any;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: URL): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
onContentError(error: Error): void;
|
|
/**
|
|
* Connect to this function to receive notifications of mouse double click events.
|
|
*
|
|
* @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
|
|
*/
|
|
onDownloadError(error: Error): any;
|
|
/**
|
|
* Called before download starts.
|
|
* 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;
|
|
/**
|
|
* event callback, called on script error or on java handler error
|
|
* override and return your own html string if you want a some text
|
|
* displayed within the ContentPane
|
|
*
|
|
* @param e
|
|
*/
|
|
onExecError(e: Event): 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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyUp(event: any): void;
|
|
/**
|
|
* Event hook, is called after everything is loaded and widgetified
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/Dock.html
|
|
*
|
|
* A widget that attaches to a node and keeps track of incoming / outgoing FloatingPanes
|
|
* and handles layout
|
|
*
|
|
* @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 Dock 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;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
*
|
|
*/
|
|
"autoPosition": boolean;
|
|
set(property:"autoPosition", value: boolean): void;
|
|
get(property:"autoPosition"): boolean;
|
|
watch(property:"autoPosition", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Insert a dockNode reference into the dock
|
|
*
|
|
* @param refNode
|
|
*/
|
|
addNode(refNode: any): 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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;
|
|
/**
|
|
* Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).
|
|
* 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
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
* Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).
|
|
* 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
|
|
*/
|
|
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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
* Processing after the DOM fragment is created
|
|
* 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;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
*
|
|
*/
|
|
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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/DragPane.html
|
|
*
|
|
* Makes a pane's content draggable by/within it's surface
|
|
* A small widget which takes a node with overflow:auto and
|
|
* allows dragging to position the content. Useful with images,
|
|
* or for just adding "something" to a overflow-able div.
|
|
*
|
|
* @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 DragPane 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;
|
|
get(property:"attributeMap"): Object;
|
|
watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Naturally, the behavior is to invert the axis of the drag.
|
|
* Setting invert:false will make the pane drag in the same
|
|
* direction as the mouse.
|
|
*
|
|
*/
|
|
"invert": boolean;
|
|
set(property:"invert", value: boolean): void;
|
|
get(property:"invert"): boolean;
|
|
watch(property:"invert", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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;
|
|
get(property:"observer"): string;
|
|
watch(property:"observer", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/ExpandoPane.html
|
|
*
|
|
* An experimental collapsing-pane for dijit.layout.BorderContainer
|
|
* Works just like a ContentPane inside of a borderContainer. Will expand/collapse on
|
|
* command, and supports having Layout Children as direct descendants
|
|
*
|
|
* @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 ExpandoPane extends dijit.layout.ContentPane implements dijit._TemplatedMixin, dijit._Contained, dijit._Container {
|
|
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;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* duration to run show/hide animations
|
|
*
|
|
*/
|
|
"duration": number;
|
|
set(property:"duration", value: number): void;
|
|
get(property:"duration"): number;
|
|
watch(property:"duration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* easing function use to show pane
|
|
*
|
|
*/
|
|
"easeIn": string;
|
|
set(property:"easeIn", value: string): void;
|
|
get(property:"easeIn"): string;
|
|
watch(property:"easeIn", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* easing function used to hide pane
|
|
*
|
|
*/
|
|
"easeOut": string;
|
|
set(property:"easeOut", value: string): void;
|
|
get(property:"easeOut"): string;
|
|
watch(property:"easeOut", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Message that shows if an error occurs
|
|
*
|
|
*/
|
|
"errorMessage": string;
|
|
set(property:"errorMessage", value: string): void;
|
|
get(property:"errorMessage"): string;
|
|
watch(property:"errorMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Extract visible content from inside of <body> .... </body>.
|
|
* I.e., strip <html> and <head> (and it's contents) from the href
|
|
*
|
|
*/
|
|
"extractContent": boolean;
|
|
set(property:"extractContent", value: boolean): void;
|
|
get(property:"extractContent"): boolean;
|
|
watch(property:"extractContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* The href of the content that displays now.
|
|
* 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;
|
|
get(property:"href"): string;
|
|
watch(property:"href", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Parameters to pass to xhrGet() request, for example:
|
|
*
|
|
* <div data-dojo-type="dijit/layout/ContentPane" data-dojo-props="href: './bar', ioArgs: {timeout: 500}">
|
|
*
|
|
*/
|
|
"ioArgs": Object;
|
|
set(property:"ioArgs", value: Object): void;
|
|
get(property:"ioArgs"): Object;
|
|
watch(property:"ioArgs", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget will call resize() on it's child widgets
|
|
* when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"isLoaded"): boolean;
|
|
watch(property:"isLoaded", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Message that shows while downloading
|
|
*
|
|
*/
|
|
"loadingMessage": string;
|
|
set(property:"loadingMessage", value: string): void;
|
|
get(property:"loadingMessage"): string;
|
|
watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* This is the dojo.Deferred returned by set('href', ...) and refresh().
|
|
* 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;
|
|
get(property:"onLoadDeferred"): Object;
|
|
watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Parse content and create the widgets, if any.
|
|
*
|
|
*/
|
|
"parseOnLoad": boolean;
|
|
set(property:"parseOnLoad", value: boolean): void;
|
|
get(property:"parseOnLoad"): boolean;
|
|
watch(property:"parseOnLoad", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Flag passed to parser. Root for attribute names to search for. If scopeName is dojo,
|
|
* 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;
|
|
get(property:"parserScope"): string;
|
|
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;
|
|
get(property:"preload"): boolean;
|
|
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;
|
|
get(property:"preventCache"): boolean;
|
|
watch(property:"preventCache", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* If true, will override the default behavior of a double-click calling a full toggle.
|
|
* If false, a double-click will cause the preview to popup
|
|
*
|
|
*/
|
|
"previewOnDblClick": boolean;
|
|
set(property:"previewOnDblClick", value: boolean): void;
|
|
get(property:"previewOnDblClick"): boolean;
|
|
watch(property:"previewOnDblClick", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A value from 0 .. 1 indicating the opacity to use on the container
|
|
* when only showing a preview
|
|
*
|
|
*/
|
|
"previewOpacity": number;
|
|
set(property:"previewOpacity", value: number): void;
|
|
get(property:"previewOpacity"): number;
|
|
watch(property:"previewOpacity", callback:{(property?:string, oldValue?:number, newValue?: number):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;
|
|
get(property:"searchContainerNode"): boolean;
|
|
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}
|
|
/**
|
|
* Does this widget start in an open (true) or closed (false) state
|
|
*
|
|
*/
|
|
"startExpanded": boolean;
|
|
set(property:"startExpanded", value: boolean): void;
|
|
get(property:"startExpanded"): boolean;
|
|
watch(property:"startExpanded", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"stopParser": boolean;
|
|
set(property:"stopParser", value: boolean): void;
|
|
get(property:"stopParser"): boolean;
|
|
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;
|
|
get(property:"style"): string;
|
|
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;
|
|
get(property:"tabIndex"): string;
|
|
watch(property:"tabIndex", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
connect(obj: any, event: Function, method: Function): any;
|
|
/**
|
|
*
|
|
* @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.
|
|
*/
|
|
defer(fcn: Function, delay: number): Object;
|
|
/**
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Destroy all the widgets inside the ContentPane and empty containerNode
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy the ContentPane and its contents
|
|
*
|
|
* @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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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;
|
|
/**
|
|
* Gets the index of the child in this container or -1 if not found
|
|
*
|
|
* @param child
|
|
*/
|
|
getIndexOfChild(child: dijit._WidgetBase): 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;
|
|
/**
|
|
* 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.
|
|
*/
|
|
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
|
|
*/
|
|
markupFactory(params: any, node: any, ctor: any): any;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
*
|
|
*/
|
|
postMixInProperties(): void;
|
|
/**
|
|
* Expand this pane in preview mode (does not affect surrounding layout)
|
|
*
|
|
*/
|
|
preview(): void;
|
|
/**
|
|
* [Re]download contents of href and display
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* we aren't a layout widget, but need to act like one.
|
|
*
|
|
* @param newSize OptionalThe size object to resize to
|
|
*/
|
|
resize(newSize: Object): 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: String): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: HTMLElement): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: NodeList): void;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: String): any;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: URL): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Toggle this pane's visibility
|
|
*
|
|
*/
|
|
toggle(): void;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
onContentError(error: Error): void;
|
|
/**
|
|
* Connect to this function to receive notifications of mouse double click events.
|
|
*
|
|
* @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
|
|
*/
|
|
onDownloadError(error: Error): any;
|
|
/**
|
|
* Called before download starts.
|
|
* 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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyUp(event: any): void;
|
|
/**
|
|
* Event hook, is called after everything is loaded and widgetified
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/FloatingPane.html
|
|
*
|
|
* A non-modal Floating window.
|
|
* Makes a dojox.layout.ContentPane float and draggable by it's title [similar to TitlePane]
|
|
* and over-rides onClick to onDblClick for wipeIn/Out of containerNode
|
|
* provides minimize(dock) / show() and hide() methods, and resize [almost]
|
|
*
|
|
* @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 FloatingPane extends dojox.layout.ContentPane implements dijit._TemplatedMixin {
|
|
constructor(params?: Object, srcNodeRef?: HTMLElement);
|
|
/**
|
|
* Adjust relative paths in html string content to point to this page.
|
|
* Only useful if you grab content from a another folder then the current one
|
|
*
|
|
*/
|
|
"adjustPaths": boolean;
|
|
set(property:"adjustPaths", value: boolean): void;
|
|
get(property:"adjustPaths"): boolean;
|
|
watch(property:"adjustPaths", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Object to which attach points and events will be scoped. Defaults
|
|
* to 'this'.
|
|
*
|
|
*/
|
|
"attachScope": Object;
|
|
set(property:"attachScope", value: Object): void;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Cleans content to make it less likely to generate DOM/JS errors.
|
|
* Useful if you send ContentPane a complete page, instead of a html fragment
|
|
* scans for:
|
|
*
|
|
* title Node, remove
|
|
* DOCTYPE tag, remove
|
|
*
|
|
*/
|
|
"cleanContent": boolean;
|
|
set(property:"cleanContent", value: boolean): void;
|
|
get(property:"cleanContent"): boolean;
|
|
watch(property:"cleanContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Allow closure of this Node
|
|
*
|
|
*/
|
|
"closable": boolean;
|
|
set(property:"closable", value: boolean): void;
|
|
get(property:"closable"): boolean;
|
|
watch(property:"closable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* The className to give to the inner node which has the content
|
|
*
|
|
*/
|
|
"contentClass": string;
|
|
set(property:"contentClass", value: string): void;
|
|
get(property:"contentClass"): string;
|
|
watch(property:"contentClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Allow minimizing of pane if true
|
|
*
|
|
*/
|
|
"dockable": boolean;
|
|
set(property:"dockable", value: boolean): void;
|
|
get(property:"dockable"): boolean;
|
|
watch(property:"dockable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* if empty, will create private layout.Dock that scrolls with viewport
|
|
* on bottom span of viewport.
|
|
*
|
|
*/
|
|
"dockTo": Object;
|
|
set(property:"dockTo", value: Object): void;
|
|
get(property:"dockTo"): Object;
|
|
watch(property:"dockTo", callback:{(property?:string, oldValue?:Object, newValue?: Object):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;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* Time is MS to spend toggling in/out node
|
|
*
|
|
*/
|
|
"duration": number;
|
|
set(property:"duration", value: number): void;
|
|
get(property:"duration"): number;
|
|
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;
|
|
get(property:"errorMessage"): string;
|
|
watch(property:"errorMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Execute (eval) scripts that is found in the content
|
|
*
|
|
*/
|
|
"executeScripts": boolean;
|
|
set(property:"executeScripts", value: boolean): void;
|
|
get(property:"executeScripts"): boolean;
|
|
watch(property:"executeScripts", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Extract visible content from inside of <body> .... </body>.
|
|
* I.e., strip <html> and <head> (and it's contents) from the href
|
|
*
|
|
*/
|
|
"extractContent": boolean;
|
|
set(property:"extractContent", value: boolean): void;
|
|
get(property:"extractContent"): boolean;
|
|
watch(property:"extractContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
focusNode: HTMLElement;
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* The href of the content that displays now.
|
|
* 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;
|
|
get(property:"href"): string;
|
|
watch(property:"href", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* [not implemented yet] will be either icon in titlepane to left
|
|
* of Title, and/or icon show when docked in a fisheye-like dock
|
|
* or maybe dockIcon would be better?
|
|
*
|
|
*/
|
|
"iconSrc": string;
|
|
set(property:"iconSrc", value: string): void;
|
|
get(property:"iconSrc"): string;
|
|
watch(property:"iconSrc", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"ioArgs": Object;
|
|
set(property:"ioArgs", value: Object): void;
|
|
get(property:"ioArgs"): Object;
|
|
watch(property:"ioArgs", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget will call resize() on it's child widgets
|
|
* when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"isLoaded"): boolean;
|
|
watch(property:"isLoaded", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Message that shows while downloading
|
|
*
|
|
*/
|
|
"loadingMessage": string;
|
|
set(property:"loadingMessage", value: string): void;
|
|
get(property:"loadingMessage"): string;
|
|
watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Horrible param name for "Can you maximize this floating pane?"
|
|
*
|
|
*/
|
|
"maxable": boolean;
|
|
set(property:"maxable", value: boolean): void;
|
|
get(property:"maxable"): boolean;
|
|
watch(property:"maxable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is the dojo.Deferred returned by set('href', ...) and refresh().
|
|
* 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;
|
|
get(property:"onLoadDeferred"): Object;
|
|
watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Parse content and create the widgets, if any.
|
|
*
|
|
*/
|
|
"parseOnLoad": boolean;
|
|
set(property:"parseOnLoad", value: boolean): void;
|
|
get(property:"parseOnLoad"): boolean;
|
|
watch(property:"parseOnLoad", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Flag passed to parser. Root for attribute names to search for. If scopeName is dojo,
|
|
* 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;
|
|
get(property:"parserScope"): string;
|
|
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;
|
|
get(property:"preload"): boolean;
|
|
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;
|
|
get(property:"preventCache"): boolean;
|
|
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}
|
|
/**
|
|
* trigger/load styles in the content
|
|
*
|
|
*/
|
|
"renderStyles": boolean;
|
|
set(property:"renderStyles", value: boolean): void;
|
|
get(property:"renderStyles"): boolean;
|
|
watch(property:"renderStyles", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Allow resizing of pane true if true
|
|
*
|
|
*/
|
|
"resizable": boolean;
|
|
set(property:"resizable", value: boolean): void;
|
|
get(property:"resizable"): boolean;
|
|
watch(property:"resizable", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* One of: x | xy | y to limit pane's sizing direction
|
|
*
|
|
*/
|
|
"resizeAxis": string;
|
|
set(property:"resizeAxis", value: string): void;
|
|
get(property:"resizeAxis"): string;
|
|
watch(property:"resizeAxis", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* replace keyword 'container' in scripts with 'dijit.byId(this.id)'
|
|
* NOTE this name might change in the near future
|
|
*
|
|
*/
|
|
"scriptHasHooks": boolean;
|
|
set(property:"scriptHasHooks", value: boolean): void;
|
|
get(property:"scriptHasHooks"): boolean;
|
|
watch(property:"scriptHasHooks", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):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}
|
|
/**
|
|
* 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;
|
|
get(property:"stopParser"): boolean;
|
|
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;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
watch(property:"templateString", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Title to use in the header
|
|
*
|
|
*/
|
|
"title": string;
|
|
set(property:"title", value: string): void;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
attr(name: Object, value: Object): any;
|
|
/**
|
|
* bring this FloatingPane above all other panes
|
|
*
|
|
*/
|
|
bringToTop(): void;
|
|
/**
|
|
*
|
|
*/
|
|
buildRendering(): void;
|
|
/**
|
|
* Cancels an in-flight download of content
|
|
*
|
|
*/
|
|
cancel(): void;
|
|
/**
|
|
* Close and destroy this widget
|
|
*
|
|
*/
|
|
close(): 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
connect(obj: any, event: Function, method: Function): any;
|
|
/**
|
|
*
|
|
* @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.
|
|
*/
|
|
defer(fcn: Function, delay: number): Object;
|
|
/**
|
|
* Destroy this FloatingPane completely
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Destroy all the widgets inside the ContentPane and empty containerNode
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy the ContentPane and its contents
|
|
*
|
|
* @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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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
|
|
*/
|
|
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;
|
|
/**
|
|
* Close, but do not destroy this FloatingPane
|
|
*
|
|
* @param callback Optional
|
|
*/
|
|
hide(callback: Function): void;
|
|
/**
|
|
* Sends an HTTP GET request to the server.
|
|
*
|
|
* @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
|
|
*/
|
|
markupFactory(params: any, node: any, ctor: any): any;
|
|
/**
|
|
* Make this FloatingPane full-screen (viewport)
|
|
*
|
|
*/
|
|
maximize(): void;
|
|
/**
|
|
* Hide and dock the FloatingPane
|
|
*
|
|
*/
|
|
minimize(): void;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
*
|
|
*/
|
|
postMixInProperties(): void;
|
|
/**
|
|
* [Re]download contents of href and display
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* Size the FloatingPane and place accordingly
|
|
*
|
|
* @param dim
|
|
*/
|
|
resize(dim: Object): 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: String): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: HTMLElement): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: NodeList): void;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: String): any;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: URL): any;
|
|
/**
|
|
* Update the Title bar with a new string
|
|
*
|
|
* @param title
|
|
*/
|
|
setTitle(title: String): void;
|
|
/**
|
|
* Show the FloatingPane
|
|
*
|
|
* @param callback Optional
|
|
*/
|
|
show(callback?: Function): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
onContentError(error: Error): void;
|
|
/**
|
|
* Connect to this function to receive notifications of mouse double click events.
|
|
*
|
|
* @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
|
|
*/
|
|
onDownloadError(error: Error): any;
|
|
/**
|
|
* Called before download starts.
|
|
* 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;
|
|
/**
|
|
* event callback, called on script error or on java handler error
|
|
* override and return your own html string if you want a some text
|
|
* displayed within the ContentPane
|
|
*
|
|
* @param e
|
|
*/
|
|
onExecError(e: Event): 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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyUp(event: any): void;
|
|
/**
|
|
* Event hook, is called after everything is loaded and widgetified
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/GridContainer.html
|
|
*
|
|
* A grid containing any kind of objects and acting like web portals.
|
|
* This component inherits of all features of gridContainerLite plus :
|
|
*
|
|
* Resize colums
|
|
* Add / remove columns
|
|
* Fix columns at left or at right.
|
|
*
|
|
* @param props
|
|
* @param node
|
|
*/
|
|
class GridContainer extends dojox.layout.GridContainerLite {
|
|
constructor(props: Object, node: HTMLElement);
|
|
/**
|
|
* The GridContainer will only accept the children that fit to the types.
|
|
*
|
|
*/
|
|
"acceptTypes": any[];
|
|
set(property:"acceptTypes", value: any[]): void;
|
|
get(property:"acceptTypes"): any[];
|
|
watch(property:"acceptTypes", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void}
|
|
/**
|
|
* Object to which attach points and events will be scoped. Defaults
|
|
* to 'this'.
|
|
*
|
|
*/
|
|
"attachScope": Object;
|
|
set(property:"attachScope", value: Object): void;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Enable the refresh of registered areas on drag start.
|
|
*
|
|
*/
|
|
"autoRefresh": boolean;
|
|
set(property:"autoRefresh", value: boolean): void;
|
|
get(property:"autoRefresh"): boolean;
|
|
watch(property:"autoRefresh", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This class name is applied to the widget's domNode
|
|
* and also may be used to generate names for sub nodes,
|
|
* for example dijitTabContainer-content.
|
|
*
|
|
*/
|
|
"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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A comma separated list of column widths. If the column widths do not add up
|
|
* to 100, the remaining columns split the rest of the width evenly
|
|
* between them.
|
|
*
|
|
*/
|
|
"colWidths": string;
|
|
set(property:"colWidths", value: string): void;
|
|
get(property:"colWidths"): string;
|
|
watch(property:"colWidths", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* If true, change the size of my currently displayed child to match my size.
|
|
*
|
|
*/
|
|
"doLayout": boolean;
|
|
set(property:"doLayout", value: boolean): void;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* CSS class enabling a drag handle on a child.
|
|
*
|
|
*/
|
|
"dragHandleClass": any[];
|
|
set(property:"dragHandleClass", value: any[]): void;
|
|
get(property:"dragHandleClass"): any[];
|
|
watch(property:"dragHandleClass", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Allow or not resizing of columns by a grip handle.
|
|
*
|
|
*/
|
|
"hasResizableColumns": boolean;
|
|
set(property:"hasResizableColumns", value: boolean): void;
|
|
get(property:"hasResizableColumns"): boolean;
|
|
watch(property:"hasResizableColumns", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* If true, widgets are organized automatically,
|
|
* else the attribute colum of child will define the right column.
|
|
*
|
|
*/
|
|
"isAutoOrganized": boolean;
|
|
set(property:"isAutoOrganized", value: boolean): void;
|
|
get(property:"isAutoOrganized"): boolean;
|
|
watch(property:"isAutoOrganized", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget is going to call resize() on its
|
|
* children widgets, setting their size, when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Define if the last left column is fixed.
|
|
* Used when you add or remove columns by calling setColumns method.
|
|
*
|
|
*/
|
|
"isLeftFixed": boolean;
|
|
set(property:"isLeftFixed", value: boolean): void;
|
|
get(property:"isLeftFixed"): boolean;
|
|
watch(property:"isLeftFixed", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Define if the last right column is fixed.
|
|
* Used when you add or remove columns by calling setColumns method.
|
|
*
|
|
*/
|
|
"isRightFixed": boolean;
|
|
set(property:"isRightFixed", value: boolean): void;
|
|
get(property:"isRightFixed"): boolean;
|
|
watch(property:"isRightFixed", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Specifies whether columns resize as you drag (true) or only upon mouseup (false)
|
|
*
|
|
*/
|
|
"liveResizeColumns": boolean;
|
|
set(property:"liveResizeColumns", value: boolean): void;
|
|
get(property:"liveResizeColumns"): boolean;
|
|
watch(property:"liveResizeColumns", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Minimum children width in pixel (only used for IE6 which doesn't handle min-width css property)
|
|
*
|
|
*/
|
|
"minChildWidth": number;
|
|
set(property:"minChildWidth", value: number): void;
|
|
get(property:"minChildWidth"): number;
|
|
watch(property:"minChildWidth", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* Minimum column width in percentage.
|
|
*
|
|
*/
|
|
"minColWidth": number;
|
|
set(property:"minColWidth", value: number): void;
|
|
get(property:"minColWidth"): number;
|
|
watch(property:"minColWidth", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* Location to add/remove columns, must be set to 'left' or 'right' (default).
|
|
*
|
|
*/
|
|
"mode": string;
|
|
set(property:"mode", value: string): void;
|
|
get(property:"mode"): string;
|
|
watch(property:"mode", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* The number of dropped zones, by default 1.
|
|
*
|
|
*/
|
|
"nbZones": number;
|
|
set(property:"nbZones", value: number): void;
|
|
get(property:"nbZones"): number;
|
|
watch(property:"nbZones", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* template of gridContainer.
|
|
*
|
|
*/
|
|
"templateString": string;
|
|
set(property:"templateString", value: string): void;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Add a child in a specific column of the GridContainer widget.
|
|
*
|
|
* @param child widget to insert
|
|
* @param column Optionalcolumn number
|
|
* @param p Optionalplace in the zone (first = 0)
|
|
*/
|
|
addChild(child: dijit._WidgetBase, column: number, p: number): any;
|
|
/**
|
|
*
|
|
* @param child
|
|
* @param column Optional
|
|
* @param p Optional
|
|
*/
|
|
addService(child: Object, column: number, p: 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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Disable the Drag And Drop for children of GridContainer.
|
|
*
|
|
*/
|
|
disableDnd(): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Enable the Drag And Drop for children of GridContainer.
|
|
*
|
|
*/
|
|
enableDnd(): void;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* A specific method which returns children after they were placed in zones.
|
|
*
|
|
*/
|
|
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;
|
|
/**
|
|
* Gets the index of the child in this container or -1 if not found
|
|
*
|
|
* @param child
|
|
*/
|
|
getIndexOfChild(child: dijit._WidgetBase): 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;
|
|
/**
|
|
* 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;
|
|
/**
|
|
* Resize of each child
|
|
*
|
|
*/
|
|
layout(): void;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* Resize the GridContainer widget and columns.
|
|
* Replace grips if it's necessary.
|
|
*
|
|
*/
|
|
resize(): void;
|
|
/**
|
|
* Resize the GridContainerLite inner table only if the drag source
|
|
* is a child of this gridContainer.
|
|
*
|
|
* @param node domNode of dragged widget.
|
|
* @param sourceArea AreaManager Object containing information of sourceArea
|
|
* @param indexChild Index where the dragged widget has been placed
|
|
*/
|
|
resizeChildAfterDragStart(node: HTMLElement, sourceArea: Object, indexChild: number): boolean;
|
|
/**
|
|
* Call when a child is dropped.
|
|
* Allow to resize and put grips
|
|
*
|
|
* @param node domNode of dropped widget.
|
|
* @param targetArea AreaManager Object containing information of targetArea
|
|
* @param indexChild Index where the dropped widget has been placed
|
|
*/
|
|
resizeChildAfterDrop(node: HTMLElement, targetArea: Object, indexChild: 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Set the number of columns.
|
|
*
|
|
* @param nbColumns Number of columns
|
|
*/
|
|
setColumns(nbColumns: number): void;
|
|
/**
|
|
* Call the startup of GridContainerLite and place grips
|
|
* if user has chosen the hasResizableColumns attribute to true.
|
|
*
|
|
*/
|
|
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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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;
|
|
/**
|
|
* Disabled the Drag And Drop if it's necessary.
|
|
*
|
|
*/
|
|
onHide(): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being pressed down.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @param event mouse Event
|
|
*/
|
|
onMouseUp(event: any): void;
|
|
/**
|
|
* Place grips in the right place when the GridContainer becomes visible.
|
|
*
|
|
*/
|
|
onShow(): void;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/GridContainerLite.html
|
|
*
|
|
* The GridContainerLite is a container of child elements that are placed in a kind of grid.
|
|
* GridContainerLite displays the child elements by column
|
|
* (ie: the children widths are fixed by the column width of the grid but
|
|
* the children heights are free).
|
|
* Each child is movable by drag and drop inside the GridContainer.
|
|
* The position of other children is automatically calculated when a child is moved.
|
|
*
|
|
* @param props
|
|
* @param node
|
|
*/
|
|
class GridContainerLite extends dijit.layout._LayoutWidget implements dijit._TemplatedMixin {
|
|
constructor(props: Object, node: HTMLElement);
|
|
/**
|
|
* The GridContainer will only accept the children that fit to the types.
|
|
*
|
|
*/
|
|
"acceptTypes": any[];
|
|
set(property:"acceptTypes", value: any[]): void;
|
|
get(property:"acceptTypes"): any[];
|
|
watch(property:"acceptTypes", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void}
|
|
/**
|
|
* Object to which attach points and events will be scoped. Defaults
|
|
* to 'this'.
|
|
*
|
|
*/
|
|
"attachScope": Object;
|
|
set(property:"attachScope", value: Object): void;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Enable the refresh of registered areas on drag start.
|
|
*
|
|
*/
|
|
"autoRefresh": boolean;
|
|
set(property:"autoRefresh", value: boolean): void;
|
|
get(property:"autoRefresh"): boolean;
|
|
watch(property:"autoRefresh", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This class name is applied to the widget's domNode
|
|
* and also may be used to generate names for sub nodes,
|
|
* for example dijitTabContainer-content.
|
|
*
|
|
*/
|
|
"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}
|
|
/**
|
|
* Properties set on children of a GridContainerLite
|
|
*
|
|
*/
|
|
"ChildWidgetProperties": Object;
|
|
set(property:"ChildWidgetProperties", value: Object): void;
|
|
get(property:"ChildWidgetProperties"): Object;
|
|
watch(property:"ChildWidgetProperties", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"class": string;
|
|
set(property:"class", value: string): void;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A comma separated list of column widths. If the column widths do not add up
|
|
* to 100, the remaining columns split the rest of the width evenly
|
|
* between them.
|
|
*
|
|
*/
|
|
"colWidths": string;
|
|
set(property:"colWidths", value: string): void;
|
|
get(property:"colWidths"): string;
|
|
watch(property:"colWidths", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* If true, change the size of my currently displayed child to match my size.
|
|
*
|
|
*/
|
|
"doLayout": boolean;
|
|
set(property:"doLayout", value: boolean): void;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* CSS class enabling a drag handle on a child.
|
|
*
|
|
*/
|
|
"dragHandleClass": any[];
|
|
set(property:"dragHandleClass", value: any[]): void;
|
|
get(property:"dragHandleClass"): any[];
|
|
watch(property:"dragHandleClass", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* If true, widgets are organized automatically,
|
|
* else the attribute colum of child will define the right column.
|
|
*
|
|
*/
|
|
"isAutoOrganized": boolean;
|
|
set(property:"isAutoOrganized", value: boolean): void;
|
|
get(property:"isAutoOrganized"): boolean;
|
|
watch(property:"isAutoOrganized", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget is going to call resize() on its
|
|
* children widgets, setting their size, when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* The number of dropped zones, by default 1.
|
|
*
|
|
*/
|
|
"nbZones": number;
|
|
set(property:"nbZones", value: number): void;
|
|
get(property:"nbZones"): number;
|
|
watch(property:"nbZones", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* template of gridContainer.
|
|
*
|
|
*/
|
|
"templateString": string;
|
|
set(property:"templateString", value: string): void;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Add a child in a specific column of the GridContainer widget.
|
|
*
|
|
* @param child widget to insert
|
|
* @param column Optionalcolumn number
|
|
* @param p Optionalplace in the zone (first = 0)
|
|
*/
|
|
addChild(child: dijit._WidgetBase, column: number, p?: number): any;
|
|
/**
|
|
*
|
|
* @param child
|
|
* @param column Optional
|
|
* @param p Optional
|
|
*/
|
|
addService(child: Object, column: number, p: 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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Disable the Drag And Drop for children of GridContainer.
|
|
*
|
|
*/
|
|
disableDnd(): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Enable the Drag And Drop for children of GridContainer.
|
|
*
|
|
*/
|
|
enableDnd(): void;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* A specific method which returns children after they were placed in zones.
|
|
*
|
|
*/
|
|
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;
|
|
/**
|
|
* Gets the index of the child in this container or -1 if not found
|
|
*
|
|
* @param child
|
|
*/
|
|
getIndexOfChild(child: dijit._WidgetBase): 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;
|
|
/**
|
|
* 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;
|
|
/**
|
|
* Resize of each child
|
|
*
|
|
*/
|
|
layout(): void;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* Call this to resize a widget, or after its size has changed.
|
|
* Change size mode:
|
|
* When changeSize is specified, changes the marginBox of this widget
|
|
* and forces it to re-layout its contents accordingly.
|
|
* changeSize may specify height, width, or both.
|
|
*
|
|
* If resultSize is specified it indicates the size the widget will
|
|
* become after changeSize has been applied.
|
|
*
|
|
* Notification mode:
|
|
* When changeSize is null, indicates that the caller has already changed
|
|
* the size of the widget, or perhaps it changed because the browser
|
|
* window was resized. Tells widget to re-layout its contents accordingly.
|
|
*
|
|
* If resultSize is also specified it indicates the size the widget has
|
|
* become.
|
|
*
|
|
* In either mode, this method also:
|
|
*
|
|
* Sets this._borderBox and this._contentBox to the new size of
|
|
* the widget. Queries the current domNode size if necessary.
|
|
* Calls layout() to resize contents (and maybe adjust child widgets).
|
|
*
|
|
* @param changeSize OptionalSets the widget to this margin-box size and position.May include any/all of the following properties:{w: int, h: int, l: int, t: int}
|
|
* @param resultSize OptionalThe margin-box size of this widget after applying changeSize (ifchangeSize is specified). If caller knows this size andpasses it in, we don't need to query the browser to get the size.{w: int, h: int}
|
|
*/
|
|
resize(changeSize: Object, resultSize: Object): void;
|
|
/**
|
|
* Resize the GridContainerLite inner table only if the drag source
|
|
* is a child of this gridContainer.
|
|
*
|
|
* @param node domNode of dragged widget.
|
|
* @param sourceArea AreaManager Object containing information of sourceArea
|
|
* @param indexChild Index where the dragged widget has been placed
|
|
*/
|
|
resizeChildAfterDragStart(node: HTMLElement, sourceArea: Object, indexChild: number): boolean;
|
|
/**
|
|
* Resize the GridContainerLite inner table and the dropped widget.
|
|
* These components are resized only if the targetArea.node is a
|
|
* child of this instance of gridContainerLite.
|
|
* To be resized, the dropped node must have also a method resize.
|
|
*
|
|
* @param node domNode of dropped widget.
|
|
* @param targetArea AreaManager Object containing information of targetArea
|
|
* @param indexChild Index where the dropped widget has been placed
|
|
*/
|
|
resizeChildAfterDrop(node: HTMLElement, targetArea: Object, indexChild: number): 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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;
|
|
/**
|
|
* Disabled the Drag And Drop if it's necessary.
|
|
*
|
|
*/
|
|
onHide(): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being pressed down.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @param event mouse Event
|
|
*/
|
|
onMouseUp(event: any): void;
|
|
/**
|
|
* Enabled the Drag And Drop if it's necessary.
|
|
*
|
|
*/
|
|
onShow(): void;
|
|
}
|
|
namespace GridContainerLite {
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/GridContainerLite.ChildWidgetProperties.html
|
|
*
|
|
* Properties set on children of a GridContainerLite
|
|
*
|
|
*/
|
|
interface ChildWidgetProperties {
|
|
/**
|
|
* Column of the grid to place the widget.
|
|
* Defined only if dojo.require("dojox.layout.GridContainerLite") is done.
|
|
*
|
|
*/
|
|
column: string;
|
|
/**
|
|
* If true, the widget can not be draggable.
|
|
* Defined only if dojo.require("dojox.layout.GridContainerLite") is done.
|
|
*
|
|
*/
|
|
dragRestriction: boolean;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/RotatorContainer.html
|
|
*
|
|
* Extends a StackContainer to automatically transition between children
|
|
* and display navigation in the form of tabs or a pager.
|
|
* The RotatorContainer cycles through the children with a transition.
|
|
*
|
|
* published topics:
|
|
* [widgetId]-update - Notifies pager(s) that a child has changed.
|
|
* Parameters:
|
|
*
|
|
* /boolean/ playing - true if playing, false if paused
|
|
* /int/ current - current selected child
|
|
* /int/ total - total number of children
|
|
*
|
|
* @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 RotatorContainer extends dijit.layout.StackContainer implements dijit._Templated {
|
|
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;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Starts the timer to transition children upon creation.
|
|
*
|
|
*/
|
|
"autoStart": boolean;
|
|
set(property:"autoStart", value: boolean): void;
|
|
get(property:"autoStart"): boolean;
|
|
watch(property:"autoStart", 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Number of cycles before pausing.
|
|
*
|
|
*/
|
|
"cycles": number;
|
|
set(property:"cycles", value: number): void;
|
|
get(property:"cycles"): number;
|
|
watch(property:"cycles", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* If true, change the size of my currently displayed child to match my size
|
|
*
|
|
*/
|
|
"doLayout": boolean;
|
|
set(property:"doLayout", value: boolean): void;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget is going to call resize() on its
|
|
* children widgets, setting their size, when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* The declared Class of the Pager used for this Widget
|
|
*
|
|
*/
|
|
"pagerClass": string;
|
|
set(property:"pagerClass", value: string): void;
|
|
get(property:"pagerClass"): string;
|
|
watch(property:"pagerClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* ID the pager widget.
|
|
*
|
|
*/
|
|
"pagerId": string;
|
|
set(property:"pagerId", value: string): void;
|
|
get(property:"pagerId"): string;
|
|
watch(property:"pagerId", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Pause the rotator when the tab is changed or the pager's next/previous
|
|
* buttons are clicked.
|
|
*
|
|
*/
|
|
"pauseOnManualChange": boolean;
|
|
set(property:"pauseOnManualChange", value: boolean): void;
|
|
get(property:"pauseOnManualChange"): boolean;
|
|
watch(property:"pauseOnManualChange", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Remembers the selected child across sessions
|
|
*
|
|
*/
|
|
"persist": boolean;
|
|
set(property:"persist", value: boolean): void;
|
|
get(property:"persist"): boolean;
|
|
watch(property:"persist", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Causes the rotator to rotate in reverse order.
|
|
*
|
|
*/
|
|
"reverse": boolean;
|
|
set(property:"reverse", value: boolean): void;
|
|
get(property:"reverse"): boolean;
|
|
watch(property:"reverse", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):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}
|
|
/**
|
|
* References the currently selected child widget, if any.
|
|
* Adjust selected child with selectChild() method.
|
|
*
|
|
*/
|
|
"selectedChildWidget": Object;
|
|
set(property:"selectedChildWidget", value: Object): void;
|
|
get(property:"selectedChildWidget"): Object;
|
|
watch(property:"selectedChildWidget", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* Sets the display of the tabs. The tabs are actually a StackController.
|
|
* The child's title is used for the tab's label.
|
|
*
|
|
*/
|
|
"showTabs": boolean;
|
|
set(property:"showTabs", value: boolean): void;
|
|
get(property:"showTabs"): boolean;
|
|
watch(property:"showTabs", 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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Pause the rotator when the mouse hovers over it.
|
|
*
|
|
*/
|
|
"suspendOnHover": boolean;
|
|
set(property:"suspendOnHover", value: boolean): void;
|
|
get(property:"suspendOnHover"): boolean;
|
|
watch(property:"suspendOnHover", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* The type of transition to perform when switching children.
|
|
* A null transition will transition instantly.
|
|
*
|
|
*/
|
|
"transition": string;
|
|
set(property:"transition", value: string): void;
|
|
get(property:"transition"): string;
|
|
watch(property:"transition", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* The delay in milliseconds before transitioning to the next child.
|
|
*
|
|
*/
|
|
"transitionDelay": number;
|
|
set(property:"transitionDelay", value: number): void;
|
|
get(property:"transitionDelay"): number;
|
|
watch(property:"transitionDelay", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* The duration of the transition in milliseconds.
|
|
*
|
|
*/
|
|
"transitionDuration": number;
|
|
set(property:"transitionDuration", value: number): void;
|
|
get(property:"transitionDuration"): number;
|
|
watch(property:"transitionDuration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* Should we parse the template to find widgets that might be
|
|
* declared in markup inside it? False by default.
|
|
*
|
|
*/
|
|
"widgetsInTemplate": boolean;
|
|
set(property:"widgetsInTemplate", value: boolean): void;
|
|
get(property:"widgetsInTemplate"): boolean;
|
|
watch(property:"widgetsInTemplate", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
* @param child
|
|
* @param insertIndex Optional
|
|
*/
|
|
addChild(child: 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.
|
|
*/
|
|
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.
|
|
*/
|
|
attr(name: Object, value: Object): any;
|
|
/**
|
|
* Go back to previous page.
|
|
*
|
|
*/
|
|
back(): 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
defer(fcn: Function, delay: number): Object;
|
|
/**
|
|
* Unsubscribe to all of our topics
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Advance to next page.
|
|
*
|
|
*/
|
|
forward(): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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;
|
|
/**
|
|
* Gets the index of the child in this container or -1 if not found
|
|
*
|
|
* @param child
|
|
*/
|
|
getIndexOfChild(child: dijit._WidgetBase): 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;
|
|
/**
|
|
* 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;
|
|
/**
|
|
*
|
|
*/
|
|
layout(): void;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
* Initializes the DOM nodes, tabs, and transition stuff.
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
*
|
|
*/
|
|
resize(): void;
|
|
/**
|
|
* Show the given widget (which must be one of my children)
|
|
*
|
|
* @param page Reference to child widget or id of child widget
|
|
* @param animate
|
|
*/
|
|
selectChild(page: dijit._WidgetBase , animate: boolean): any;
|
|
/**
|
|
* Show the given widget (which must be one of my children)
|
|
*
|
|
* @param page Reference to child widget or id of child widget
|
|
* @param animate
|
|
*/
|
|
selectChild(page: String, animate: boolean): 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Initializes the pagers.
|
|
*
|
|
*/
|
|
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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/ResizeHandle.html
|
|
*
|
|
* A draggable handle used to resize an attached node.
|
|
* The handle on the bottom-right corner of FloatingPane or other widgets that allows
|
|
* the widget to be resized.
|
|
* Typically not used directly.
|
|
*
|
|
* @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 ResizeHandle extends dijit._Widget implements dijit._TemplatedMixin {
|
|
constructor(params?: Object, srcNodeRef?: HTMLElement);
|
|
/**
|
|
* if true, node will size realtime with mouse movement,
|
|
* if false, node will create virtual node, and only resize target on mouseUp
|
|
*
|
|
*/
|
|
"activeResize": boolean;
|
|
set(property:"activeResize", value: boolean): void;
|
|
get(property:"activeResize"): boolean;
|
|
watch(property:"activeResize", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* css class applied to virtual resize node.
|
|
*
|
|
*/
|
|
"activeResizeClass": string;
|
|
set(property:"activeResizeClass", value: string): void;
|
|
get(property:"activeResizeClass"): string;
|
|
watch(property:"activeResizeClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* time in MS to run sizing animation. if animateMethod="chain", total animation
|
|
* playtime is 2*animateDuration
|
|
*
|
|
*/
|
|
"animateDuration": number;
|
|
set(property:"animateDuration", value: number): void;
|
|
get(property:"animateDuration"): number;
|
|
watch(property:"animateDuration", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* one of "chain" or "combine" ... visual effect only. combine will "scale"
|
|
* node to size, "chain" will alter width, then height
|
|
*
|
|
*/
|
|
"animateMethod": string;
|
|
set(property:"animateMethod", value: string): void;
|
|
get(property:"animateMethod"): string;
|
|
watch(property:"animateMethod", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* only applicable if activeResize = false. onMouseup, animate the node to the
|
|
* new size
|
|
*
|
|
*/
|
|
"animateSizing": boolean;
|
|
set(property:"animateSizing", value: boolean): void;
|
|
get(property:"animateSizing"): boolean;
|
|
watch(property:"animateSizing", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Object to which attach points and events will be scoped. Defaults
|
|
* to 'this'.
|
|
*
|
|
*/
|
|
"attachScope": Object;
|
|
set(property:"attachScope", value: Object): void;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Toggle if this widget cares about the maxHeight and maxWidth
|
|
* parameters.
|
|
*
|
|
*/
|
|
"constrainMax": boolean;
|
|
set(property:"constrainMax", value: boolean): void;
|
|
get(property:"constrainMax"): boolean;
|
|
watch(property:"constrainMax", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* The name of the topic this resizehandle publishes when resize is complete
|
|
*
|
|
*/
|
|
"endTopic": string;
|
|
set(property:"endTopic", value: string): void;
|
|
get(property:"endTopic"): string;
|
|
watch(property:"endTopic", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Toggle to enable this widget to maintain the aspect
|
|
* ratio of the attached node.
|
|
*
|
|
*/
|
|
"fixedAspect": boolean;
|
|
set(property:"fixedAspect", value: boolean): void;
|
|
get(property:"fixedAspect"): boolean;
|
|
watch(property:"fixedAspect", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Toggle to enable/disable this widget from firing onResize
|
|
* events at every step of a resize. If activeResize is true,
|
|
* and this is false, onResize only fires after the drop
|
|
* operation. Animated resizing is not affected by this setting.
|
|
*
|
|
*/
|
|
"intermediateChanges": boolean;
|
|
set(property:"intermediateChanges", value: boolean): void;
|
|
get(property:"intermediateChanges"): boolean;
|
|
watch(property:"intermediateChanges", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Largest height size in px the resize node can become.
|
|
*
|
|
*/
|
|
"maxHeight": number;
|
|
set(property:"maxHeight", value: number): void;
|
|
get(property:"maxHeight"): number;
|
|
watch(property:"maxHeight", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* Largest width size in px the resize node can become.
|
|
*
|
|
*/
|
|
"maxWidth": number;
|
|
set(property:"maxWidth", value: number): void;
|
|
get(property:"maxWidth"): number;
|
|
watch(property:"maxWidth", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* smallest height in px resized node can be
|
|
*
|
|
*/
|
|
"minHeight": number;
|
|
set(property:"minHeight", value: number): void;
|
|
get(property:"minHeight"): number;
|
|
watch(property:"minHeight", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* smallest width in px resize node can be
|
|
*
|
|
*/
|
|
"minWidth": number;
|
|
set(property:"minWidth", value: number): void;
|
|
get(property:"minWidth"): number;
|
|
watch(property:"minWidth", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* one of: x|y|xy limit resizing to a single axis, default to xy ...
|
|
*
|
|
*/
|
|
"resizeAxis": string;
|
|
set(property:"resizeAxis", value: string): void;
|
|
get(property:"resizeAxis"): string;
|
|
watch(property:"resizeAxis", callback:{(property?:string, oldValue?:string, newValue?: string):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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* The name of the topic this resizehandle publishes when resize is starting
|
|
*
|
|
*/
|
|
"startTopic": string;
|
|
set(property:"startTopic", value: string): void;
|
|
get(property:"startTopic"): string;
|
|
watch(property:"startTopic", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* over-ride targetId and attch this handle directly to a reference of a DomNode
|
|
*
|
|
*/
|
|
"targetContainer": HTMLElement;
|
|
set(property:"targetContainer", value: HTMLElement): void;
|
|
get(property:"targetContainer"): HTMLElement;
|
|
watch(property:"targetContainer", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void}
|
|
/**
|
|
* id of the Widget OR DomNode that I will size
|
|
*
|
|
*/
|
|
"targetId": string;
|
|
set(property:"targetId", value: string): void;
|
|
get(property:"targetId"): string;
|
|
watch(property:"targetId", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
* setup our one major listener upon creation
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @param event mouse Event
|
|
*/
|
|
onMouseUp(event: any): void;
|
|
/**
|
|
* Stub fired when sizing is done. Fired once
|
|
* after resize, or often when intermediateChanges is
|
|
* set to true.
|
|
*
|
|
* @param e
|
|
*/
|
|
onResize(e: 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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/ScrollPane.html
|
|
*
|
|
* A pane that "scrolls" its content based on the mouse poisition inside
|
|
* A sizable container that takes it's content's natural size and creates
|
|
* a scroll effect based on the relative mouse position. It is an interesting
|
|
* way to display lists of data, or blocks of content, within a confined
|
|
* space.
|
|
*
|
|
* Horizontal scrolling is supported. Combination scrolling is not.
|
|
*
|
|
* @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 ScrollPane extends dijit.layout.ContentPane implements dijit._Templated {
|
|
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;
|
|
get(property:"attachScope"): Object;
|
|
watch(property:"attachScope", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* whether the scroll helper should hide when mouseleave
|
|
*
|
|
*/
|
|
"autoHide": boolean;
|
|
set(property:"autoHide", value: boolean): void;
|
|
get(property:"autoHide"): boolean;
|
|
watch(property:"autoHide", 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;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"doLayout"): boolean;
|
|
watch(property:"doLayout", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* Message that shows if an error occurs
|
|
*
|
|
*/
|
|
"errorMessage": string;
|
|
set(property:"errorMessage", value: string): void;
|
|
get(property:"errorMessage"): string;
|
|
watch(property:"errorMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Extract visible content from inside of <body> .... </body>.
|
|
* I.e., strip <html> and <head> (and it's contents) from the href
|
|
*
|
|
*/
|
|
"extractContent": boolean;
|
|
set(property:"extractContent", value: boolean): void;
|
|
get(property:"extractContent"): boolean;
|
|
watch(property:"extractContent", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* The href of the content that displays now.
|
|
* 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;
|
|
get(property:"href"): string;
|
|
watch(property:"href", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Parameters to pass to xhrGet() request, for example:
|
|
*
|
|
* <div data-dojo-type="dijit/layout/ContentPane" data-dojo-props="href: './bar', ioArgs: {timeout: 500}">
|
|
*
|
|
*/
|
|
"ioArgs": Object;
|
|
set(property:"ioArgs", value: Object): void;
|
|
get(property:"ioArgs"): Object;
|
|
watch(property:"ioArgs", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget will call resize() on it's child widgets
|
|
* when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"isLoaded"): boolean;
|
|
watch(property:"isLoaded", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Message that shows while downloading
|
|
*
|
|
*/
|
|
"loadingMessage": string;
|
|
set(property:"loadingMessage", value: string): void;
|
|
get(property:"loadingMessage"): string;
|
|
watch(property:"loadingMessage", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* This is the dojo.Deferred returned by set('href', ...) and refresh().
|
|
* 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;
|
|
get(property:"onLoadDeferred"): Object;
|
|
watch(property:"onLoadDeferred", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* either "horizontal" or "vertical" for scroll orientation.
|
|
*
|
|
*/
|
|
"orientation": string;
|
|
set(property:"orientation", value: string): void;
|
|
get(property:"orientation"): string;
|
|
watch(property:"orientation", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Parse content and create the widgets, if any.
|
|
*
|
|
*/
|
|
"parseOnLoad": boolean;
|
|
set(property:"parseOnLoad", value: boolean): void;
|
|
get(property:"parseOnLoad"): boolean;
|
|
watch(property:"parseOnLoad", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Flag passed to parser. Root for attribute names to search for. If scopeName is dojo,
|
|
* 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;
|
|
get(property:"parserScope"): string;
|
|
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;
|
|
get(property:"preload"): boolean;
|
|
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;
|
|
get(property:"preventCache"): boolean;
|
|
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;
|
|
get(property:"searchContainerNode"): boolean;
|
|
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;
|
|
get(property:"stopParser"): boolean;
|
|
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;
|
|
get(property:"style"): string;
|
|
watch(property:"style", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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;
|
|
get(property:"templateString"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* Should we parse the template to find widgets that might be
|
|
* declared in markup inside it? False by default.
|
|
*
|
|
*/
|
|
"widgetsInTemplate": boolean;
|
|
set(property:"widgetsInTemplate", value: boolean): void;
|
|
get(property:"widgetsInTemplate"): boolean;
|
|
watch(property:"widgetsInTemplate", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
connect(obj: any, event: Function, method: Function): any;
|
|
/**
|
|
*
|
|
* @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.
|
|
*/
|
|
defer(fcn: Function, delay: number): Object;
|
|
/**
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Destroy all the widgets inside the ContentPane and empty containerNode
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy the ContentPane and its contents
|
|
*
|
|
* @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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
markupFactory(params: any, node: any, ctor: any): any;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
*
|
|
*/
|
|
postMixInProperties(): void;
|
|
/**
|
|
* [Re]download contents of href and display
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* calculates required sizes. Call this if you add/remove
|
|
* content manually, or reload the content.
|
|
*
|
|
* @param size Optional
|
|
*/
|
|
resize(size: 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: String): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: HTMLElement): void;
|
|
/**
|
|
* Deprecated. Use set('content', ...) instead.
|
|
*
|
|
* @param data
|
|
*/
|
|
setContent(data: NodeList): void;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: String): any;
|
|
/**
|
|
* Deprecated. Use set('href', ...) instead.
|
|
*
|
|
* @param href
|
|
*/
|
|
setHref(href: URL): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Static method to get a template based on the templatePath or
|
|
* templateString key
|
|
*/
|
|
getCachedTemplate(): any;
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
onContentError(error: Error): void;
|
|
/**
|
|
* Connect to this function to receive notifications of mouse double click events.
|
|
*
|
|
* @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
|
|
*/
|
|
onDownloadError(error: Error): any;
|
|
/**
|
|
* Called before download starts.
|
|
* 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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyUp(event: any): void;
|
|
/**
|
|
* Event hook, is called after everything is loaded and widgetified
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/TableContainer.html
|
|
*
|
|
* A container that lays out its child widgets in a table layout.
|
|
* The TableContainer lays out child widgets in a Table layout.
|
|
* Each widget can specify a "label" or a "title" parameter.
|
|
* This label is displayed either above or to the left of
|
|
* a widget depending on whether the "orientation" attribute
|
|
* is "horiz" or "vert", for horizontal and vertical respectively.
|
|
* The number of columns is configured using the "cols" attribute.
|
|
* The width of labels can be configured using the "labelWidth" parameter.
|
|
*
|
|
* @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 TableContainer extends dijit.layout._LayoutWidget {
|
|
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;
|
|
get(property:"attributeMap"): Object;
|
|
watch(property:"attributeMap", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
* This class name is applied to the widget's domNode
|
|
* and also may be used to generate names for sub nodes,
|
|
* for example dijitTabContainer-content.
|
|
*
|
|
*/
|
|
"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}
|
|
/**
|
|
* Properties to be set on children of TableContainer
|
|
*
|
|
*/
|
|
"ChildWidgetProperties": Object;
|
|
set(property:"ChildWidgetProperties", value: Object): void;
|
|
get(property:"ChildWidgetProperties"): Object;
|
|
watch(property:"ChildWidgetProperties", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"class": string;
|
|
set(property:"class", value: string): void;
|
|
get(property:"class"): string;
|
|
watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
*
|
|
*/
|
|
"cols": number;
|
|
set(property:"cols", value: number): void;
|
|
get(property:"cols"): number;
|
|
watch(property:"cols", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* 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:
|
|
*
|
|
* <div data-dojo-type=myWidget>
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* </div>
|
|
* containerNode would point to:
|
|
*
|
|
* <b> here's a plain DOM node
|
|
* <span data-dojo-type=subWidget>and a widget</span>
|
|
* <i> and another plain DOM node </i>
|
|
* 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}
|
|
/**
|
|
* A CSS class that will be applied to child elements. For example, if
|
|
* the class is "myClass", the table will have "myClass-table" applied to it,
|
|
* each label TD will have "myClass-labelCell" applied, and each
|
|
* widget TD will have "myClass-valueCell" applied.
|
|
*
|
|
*/
|
|
"customClass": string;
|
|
set(property:"customClass", value: string): void;
|
|
get(property:"customClass"): string;
|
|
watch(property:"customClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* This is our visible representation of the widget! Other DOM
|
|
* 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}
|
|
/**
|
|
* 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;
|
|
get(property:"focused"): boolean;
|
|
watch(property:"focused", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* A unique, opaque ID string that can be assigned by users or by the
|
|
* 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;
|
|
get(property:"id"): string;
|
|
watch(property:"id", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* Indicates that this widget is going to call resize() on its
|
|
* children widgets, setting their size, when they become visible.
|
|
*
|
|
*/
|
|
"isLayoutContainer": boolean;
|
|
set(property:"isLayoutContainer", value: boolean): void;
|
|
get(property:"isLayoutContainer"): boolean;
|
|
watch(property:"isLayoutContainer", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* Defines the width of a label. If the value is a number, it is
|
|
* treated as a pixel value. The other valid value is a percentage,
|
|
* e.g. "50%"
|
|
*
|
|
*/
|
|
"labelWidth": number;
|
|
set(property:"labelWidth", value: number): void;
|
|
get(property:"labelWidth"): number;
|
|
watch(property:"labelWidth", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void}
|
|
/**
|
|
* Rarely used. Overrides the default Dojo locale used to render this widget,
|
|
* 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}
|
|
/**
|
|
* Either "horiz" or "vert" for label orientation.
|
|
*
|
|
*/
|
|
"orientation": string;
|
|
set(property:"orientation", value: string): void;
|
|
get(property:"orientation"): string;
|
|
watch(property:"orientation", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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}
|
|
/**
|
|
* True if labels should be displayed, false otherwise.
|
|
*
|
|
*/
|
|
"showLabels": boolean;
|
|
set(property:"showLabels", value: boolean): void;
|
|
get(property:"showLabels"): boolean;
|
|
watch(property:"showLabels", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void}
|
|
/**
|
|
* The cell spacing to apply to the table.
|
|
*
|
|
*/
|
|
"spacing": number;
|
|
set(property:"spacing", value: number): void;
|
|
get(property:"spacing"): number;
|
|
watch(property:"spacing", callback:{(property?:string, oldValue?:number, newValue?: number):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}
|
|
/**
|
|
* HTML style attributes as cssText string or name/value hash
|
|
*
|
|
*/
|
|
"style": string;
|
|
set(property:"style", value: string): void;
|
|
get(property:"style"): string;
|
|
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;
|
|
get(property:"title"): string;
|
|
watch(property:"title", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void}
|
|
/**
|
|
* 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 child
|
|
* @param insertIndex Optional
|
|
*/
|
|
addChild(child: 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.
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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.
|
|
*/
|
|
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
|
|
*/
|
|
destroy(preserveDom?: boolean): void;
|
|
/**
|
|
* Destroys all the widgets inside this.containerNode,
|
|
* but not this widget itself
|
|
*
|
|
* @param preserveDom
|
|
*/
|
|
destroyDescendants(preserveDom: boolean): void;
|
|
/**
|
|
* Destroy this widget and its descendants
|
|
* 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.
|
|
*/
|
|
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.
|
|
*/
|
|
destroyRendering(preserveDom?: boolean): void;
|
|
/**
|
|
* Deprecated, will be removed in 2.0, use handle.remove() instead.
|
|
*
|
|
* Disconnects handle created by connect.
|
|
*
|
|
* @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
|
|
*/
|
|
emit(type: String, eventObj: Object, callbackArgs: any[]): any;
|
|
/**
|
|
* Get a property from a widget.
|
|
* 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.
|
|
*/
|
|
get(name: any): any;
|
|
/**
|
|
* Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent
|
|
* 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;
|
|
/**
|
|
* Gets the index of the child in this container or -1 if not found
|
|
*
|
|
* @param child
|
|
*/
|
|
getIndexOfChild(child: dijit._WidgetBase): 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;
|
|
/**
|
|
* 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;
|
|
/**
|
|
* Lays out the child widgets.
|
|
*
|
|
*/
|
|
layout(): void;
|
|
/**
|
|
*
|
|
* @param type protected
|
|
* @param func
|
|
*/
|
|
on(type: String, func: Function): any;
|
|
/**
|
|
*
|
|
* @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;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: String): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: String, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: HTMLElement, position: number): any;
|
|
/**
|
|
* Place this widget somewhere in the DOM based
|
|
* on standard domConstruct.place() conventions.
|
|
* 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().
|
|
*/
|
|
placeAt(reference: dijit._WidgetBase, position: number): any;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
* Called after the parameters to the widget have been read-in,
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
removeChild(widget: number): void;
|
|
/**
|
|
* Resizes all children. This widget itself
|
|
* does not resize, as it takes up 100% of the
|
|
* available width.
|
|
*
|
|
*/
|
|
resize(): 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.
|
|
*/
|
|
set(name: any, value: any): any;
|
|
/**
|
|
* Deprecated. Use set() instead.
|
|
*
|
|
* @param attr
|
|
* @param value
|
|
*/
|
|
setAttribute(attr: String, value: any): 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
|
|
*/
|
|
subscribe(t: String, method: Function): any;
|
|
/**
|
|
* Returns a string that represents the widget.
|
|
* 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
|
|
*/
|
|
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.
|
|
*/
|
|
watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
|
|
/**
|
|
* Called when the widget stops being "active" because
|
|
* 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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onKeyDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of printable keys being typed.
|
|
*
|
|
* @param event key Event
|
|
*/
|
|
onKeyPress(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of keys being released.
|
|
*
|
|
* @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
|
|
*/
|
|
onMouseDown(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse moves onto this widget.
|
|
*
|
|
* @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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
onMouseOver(event: any): void;
|
|
/**
|
|
* Connect to this function to receive notifications of when the mouse button is released.
|
|
*
|
|
* @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;
|
|
}
|
|
namespace TableContainer {
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/TableContainer.ChildWidgetProperties.html
|
|
*
|
|
* Properties to be set on children of TableContainer
|
|
*
|
|
*/
|
|
interface ChildWidgetProperties {
|
|
/**
|
|
* The number of columns this widget should span.
|
|
*
|
|
*/
|
|
colspan: number;
|
|
/**
|
|
* The label to display for a given widget
|
|
*
|
|
*/
|
|
label: string;
|
|
/**
|
|
* Setting spanLabel to true makes the widget take up both the
|
|
* label and value cells. Defaults to false.
|
|
*
|
|
*/
|
|
spanLabel: boolean;
|
|
/**
|
|
* The label to display for a given widget. This is interchangeable
|
|
* with the 'label' parameter, as some widgets already have a use
|
|
* for the 'label', and this can be used instead to avoid conflicts.
|
|
*
|
|
*/
|
|
title: string;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/ToggleSplitter.html
|
|
*
|
|
* A draggable and clickable spacer between two items in a dijit.layout.BorderContainer.
|
|
* This is instantiated by dijit.layout.BorderContainer. Users should not
|
|
* create it directly.
|
|
*
|
|
*/
|
|
class ToggleSplitter {
|
|
constructor();
|
|
/**
|
|
*
|
|
*/
|
|
"baseClass": string;
|
|
/**
|
|
* Pointer to the pane associated with this splitter
|
|
*
|
|
*/
|
|
"child": Object;
|
|
/**
|
|
* Pointer to the parent BorderContainer
|
|
*
|
|
*/
|
|
"container": Object;
|
|
/**
|
|
* Region of pane associated with this splitter.
|
|
* "top", "bottom", "left", "right".
|
|
*
|
|
*/
|
|
"region": string;
|
|
/**
|
|
* the initial and current state of the splitter (and its attached pane)
|
|
* It has three values: full, collapsed (optional), closed
|
|
*
|
|
*/
|
|
"state": string;
|
|
/**
|
|
*
|
|
*/
|
|
"templateString": string;
|
|
/**
|
|
*
|
|
*/
|
|
postCreate(): void;
|
|
/**
|
|
*
|
|
*/
|
|
startup(): Function;
|
|
/**
|
|
*
|
|
* @param pane
|
|
*/
|
|
onClosed(pane: any): void;
|
|
/**
|
|
*
|
|
* @param pane
|
|
*/
|
|
onCollapsed(pane: any): void;
|
|
/**
|
|
*
|
|
* @param pane
|
|
*/
|
|
onOpen(pane: any): void;
|
|
}
|
|
namespace dnd {
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/dnd/Avatar.html
|
|
*
|
|
* An Object, which represents the object being moved in a GridContainer
|
|
*
|
|
* @param manager
|
|
* @param opacity
|
|
*/
|
|
class Avatar extends dojo.dnd.Avatar {
|
|
constructor(manager: any, opacity: any);
|
|
/**
|
|
* a DnD manager object
|
|
*
|
|
*/
|
|
"manager": Object;
|
|
/**
|
|
* A constructor function. it is separate so it can be (dynamically)
|
|
* overwritten in case of need.
|
|
*
|
|
*/
|
|
construct(): void;
|
|
/**
|
|
* destructor for the avatar; called to remove all references so it can be garbage-collected
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
* Updates the avatar to reflect the current DnD state.
|
|
*
|
|
*/
|
|
update(): void;
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/dnd/PlottedDnd.html
|
|
*
|
|
* dnd source handling plotted zone to show the dropping area
|
|
*
|
|
* @param node
|
|
* @param params
|
|
*/
|
|
class PlottedDnd extends dojo.dnd.Source {
|
|
constructor(node: HTMLElement, params: Object);
|
|
/**
|
|
*
|
|
*/
|
|
"accept": any[];
|
|
/**
|
|
* Indicates whether to allow dnd item nodes to be nested within other elements.
|
|
* By default this is false, indicating that only direct children of the container can
|
|
* be draggable dnd item nodes
|
|
*
|
|
*/
|
|
"allowNested": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"autoSync": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"copyOnly": boolean;
|
|
/**
|
|
* The DOM node the mouse is currently hovered over
|
|
*
|
|
*/
|
|
"current": HTMLElement;
|
|
/**
|
|
*
|
|
*/
|
|
"delay": number;
|
|
/**
|
|
*
|
|
*/
|
|
"GC_OFFSET_X": Object;
|
|
/**
|
|
*
|
|
*/
|
|
"GC_OFFSET_Y": Object;
|
|
/**
|
|
*
|
|
*/
|
|
"generateText": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"horizontal": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"isSource": boolean;
|
|
/**
|
|
* Map from an item's id (which is also the DOMNode's id) to
|
|
* the dojo/dnd/Container.Item itself.
|
|
*
|
|
*/
|
|
"map": Object;
|
|
/**
|
|
* The set of id's that are currently selected, such that this.selection[id] == 1
|
|
* if the node w/that id is selected. Can iterate over selected node's id's like:
|
|
*
|
|
* for(var id in this.selection)
|
|
*
|
|
*/
|
|
"selection": Object;
|
|
/**
|
|
*
|
|
*/
|
|
"selfAccept": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"selfCopy": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"singular": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"skipForm": boolean;
|
|
/**
|
|
*
|
|
*/
|
|
"withHandles": boolean;
|
|
/**
|
|
* checks if the target can accept nodes from this source
|
|
*
|
|
* @param source the source which provides items
|
|
* @param nodes the list of transferred items
|
|
*/
|
|
checkAcceptance(source: Object, nodes: any[]): boolean;
|
|
/**
|
|
* removes all data items from the map
|
|
*
|
|
*/
|
|
clearItems(): void;
|
|
/**
|
|
* Returns true if we need to copy items, false to move.
|
|
* It is separated to be overwritten dynamically, if needed.
|
|
*
|
|
* @param keyPressed the "copy" key was pressed
|
|
* @param self Optionaloptional flag that means that we are about to drop on itself
|
|
*/
|
|
copyState(keyPressed: boolean, self: boolean): any;
|
|
/**
|
|
* creator function, dummy at the moment
|
|
*
|
|
*/
|
|
creator(): void;
|
|
/**
|
|
* hide the dashed zone
|
|
*
|
|
*/
|
|
deleteDashedZone(): void;
|
|
/**
|
|
* deletes all selected items
|
|
*
|
|
*/
|
|
deleteSelectedNodes(): Function;
|
|
/**
|
|
* removes a data item from the map by its key (id)
|
|
*
|
|
* @param key
|
|
*/
|
|
delItem(key: String): void;
|
|
/**
|
|
* prepares the object to be garbage-collected
|
|
*
|
|
*/
|
|
destroy(): void;
|
|
/**
|
|
*
|
|
* @param type
|
|
* @param event
|
|
*/
|
|
emit(type: any, event: any): any;
|
|
/**
|
|
* iterates over a data map skipping members that
|
|
* are present in the empty object (IE and/or 3rd-party libraries).
|
|
*
|
|
* @param f
|
|
* @param o Optional
|
|
*/
|
|
forInItems(f: Function, o: Object): String;
|
|
/**
|
|
* iterates over selected items;
|
|
* see dojo/dnd/Container.forInItems() for details
|
|
*
|
|
* @param f
|
|
* @param o Optional
|
|
*/
|
|
forInSelectedItems(f: Function, o: Object): void;
|
|
/**
|
|
* returns a list (an array) of all valid child nodes
|
|
*
|
|
*/
|
|
getAllNodes(): any;
|
|
/**
|
|
* Return one or more widget selected during the drag.
|
|
*
|
|
* @param node
|
|
*/
|
|
getDraggedWidget(node: HTMLElement): any;
|
|
/**
|
|
* returns a data item by its key (id)
|
|
*
|
|
* @param key
|
|
*/
|
|
getItem(key: String): any;
|
|
/**
|
|
* returns a list (an array) of selected nodes
|
|
*
|
|
*/
|
|
getSelectedNodes(): any;
|
|
/**
|
|
* Insert the dashed zone at the right place
|
|
*
|
|
* @param before
|
|
*/
|
|
insertDashedZone(before: boolean): void;
|
|
/**
|
|
* inserts an array of new nodes before/after an anchor node
|
|
*
|
|
* @param data Logical representation of the object being dragged.If the drag object's type is "text" then data is a String,if it's another type then data could be a different Object,perhaps a name/value hash.
|
|
* @param before insert before the anchor, if true, and after the anchor otherwise
|
|
* @param anchor the anchor node to be used as a point of insertion
|
|
*/
|
|
insertNodes(data: Object, before: boolean, anchor: HTMLElement): Function;
|
|
/**
|
|
* inserts new data items (see dojo/dnd/Container.insertNodes() method for details)
|
|
*
|
|
* @param addSelected all new nodes will be added to selected items, if true, no selection change otherwise
|
|
* @param data a list of data items, which should be processed by the creator function
|
|
* @param before insert before the anchor, if true, and after the anchor otherwise
|
|
* @param anchor the anchor node to be used as a point of insertion
|
|
*/
|
|
insertNodes(addSelected: boolean, data: any[], before: boolean, anchor: HTMLElement): Function;
|
|
/**
|
|
* test if this node can be accepted
|
|
*
|
|
* @param node
|
|
*/
|
|
isAccepted(node: HTMLElement): Object;
|
|
/**
|
|
*
|
|
* @param params
|
|
* @param node
|
|
* @param Ctor
|
|
*/
|
|
markupFactory(params: any, node: any, Ctor: any): any;
|
|
/**
|
|
*
|
|
* @param type
|
|
* @param listener
|
|
*/
|
|
on(type: any, listener: any): any;
|
|
/**
|
|
* selects all items
|
|
*
|
|
*/
|
|
selectAll(): any;
|
|
/**
|
|
* unselects all items
|
|
*
|
|
*/
|
|
selectNone(): any;
|
|
/**
|
|
* set an item as selectable
|
|
*
|
|
* @param node
|
|
* @param isSelectable
|
|
*/
|
|
setDndItemSelectable(node: HTMLElement, isSelectable: boolean): void;
|
|
/**
|
|
* set the position of the drop indicator
|
|
*
|
|
* @param e
|
|
*/
|
|
setIndicatorPosition(e: Event): boolean;
|
|
/**
|
|
* associates a data item with its key (id)
|
|
*
|
|
* @param key
|
|
* @param data
|
|
*/
|
|
setItem(key: String, data: any): void;
|
|
/**
|
|
* collects valid child items and populate the map
|
|
*
|
|
*/
|
|
startup(): void;
|
|
/**
|
|
* sync up the node list with the data map
|
|
*
|
|
*/
|
|
sync(): Function;
|
|
/**
|
|
* Called to cancel the DnD operation.
|
|
*
|
|
*/
|
|
onDndCancel(): void;
|
|
/**
|
|
* Called to finish the DnD operation
|
|
*
|
|
* @param source
|
|
* @param nodes
|
|
* @param copy
|
|
* @param target
|
|
*/
|
|
onDndDrop(source: any, nodes: any, copy: any, target: any): void;
|
|
/**
|
|
* topic event processor for /dnd/source/over, called when detected a current source
|
|
*
|
|
* @param source the source which has the mouse over it
|
|
*/
|
|
onDndSourceOver(source: Object): void;
|
|
/**
|
|
* Called to initiate the DnD operation.
|
|
*
|
|
* @param source
|
|
* @param nodes
|
|
* @param copy
|
|
*/
|
|
onDndStart(source: Object, nodes: any[], copy: Object): void;
|
|
/**
|
|
* called during the active DnD operation, when items
|
|
* are dragged away from this target, and it is not disabled
|
|
*
|
|
*/
|
|
onDraggingOut(): void;
|
|
/**
|
|
* called during the active DnD operation, when items
|
|
* are dragged over this target, and it is not disabled
|
|
*
|
|
*/
|
|
onDraggingOver(): void;
|
|
/**
|
|
* called only on the current target, when drop is performed
|
|
*
|
|
* @param source the source which provides items
|
|
* @param nodes the list of transferred items
|
|
* @param copy copy items, if true, move items otherwise
|
|
*/
|
|
onDrop(source: Object, nodes: any[], copy: boolean): void;
|
|
/**
|
|
* called only on the current target, when drop is performed
|
|
* from an external source
|
|
*
|
|
* @param source the source which provides items
|
|
* @param nodes the list of transferred items
|
|
* @param copy copy items, if true, move items otherwise
|
|
*/
|
|
onDropExternal(source: Object, nodes: any[], copy: boolean): void;
|
|
/**
|
|
* called only on the current target, when drop is performed
|
|
* from the same target/source
|
|
*
|
|
* @param nodes the list of transferred items
|
|
* @param copy copy items, if true, move items otherwise
|
|
*/
|
|
onDropInternal(nodes: any[], copy: boolean): void;
|
|
/**
|
|
* Event processor for onmousedown.
|
|
*
|
|
* @param e
|
|
*/
|
|
onMouseDown(e: Event): void;
|
|
/**
|
|
* Event processor for onmousemove
|
|
*
|
|
* @param e
|
|
*/
|
|
onMouseMove(e: any): void;
|
|
/**
|
|
* event processor for onmouseout
|
|
*
|
|
* @param e mouse event
|
|
*/
|
|
onMouseOut(e: Event): void;
|
|
/**
|
|
* event processor for onmouseover or touch, to mark that element as the current element
|
|
*
|
|
* @param e mouse event
|
|
*/
|
|
onMouseOver(e: Event): void;
|
|
/**
|
|
* Event processor for onmouseup.
|
|
*
|
|
* @param e
|
|
*/
|
|
onMouseUp(e: Event): void;
|
|
/**
|
|
*
|
|
*/
|
|
onOutEvent(): void;
|
|
/**
|
|
*
|
|
*/
|
|
onOverEvent(): void;
|
|
/**
|
|
* event processor for onselectevent and ondragevent
|
|
*
|
|
* @param e mouse event
|
|
*/
|
|
onSelectStart(e: Event): void;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/BorderContainer.html
|
|
*
|
|
*
|
|
*/
|
|
interface BorderContainer {
|
|
}
|
|
/**
|
|
* Permalink: http://dojotoolkit.org/api/1.9/dojox/layout/RadioGroup.html
|
|
*
|
|
* dojox.layout.RadioGroup - an experimental (probably poorly named) Layout widget extending StackContainer
|
|
* that accepts ContentPanes as children, and applies aesthetically pleasing responsive transition animations
|
|
* attached to :hover of the Buttons created.
|
|
*
|
|
*/
|
|
interface RadioGroup {
|
|
}
|
|
}
|
|
|
|
|
|
}
|
|
|
|
declare module "dojox/layout/BorderContainer" {
|
|
var exp: dojox.layout.BorderContainer
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/RadioGroup" {
|
|
var exp: dojox.layout.RadioGroup
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/Dock" {
|
|
var exp: typeof dojox.layout.Dock
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/DragPane" {
|
|
var exp: typeof dojox.layout.DragPane
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/ExpandoPane" {
|
|
var exp: typeof dojox.layout.ExpandoPane
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/ContentPane" {
|
|
var exp: typeof dojox.layout.ContentPane
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/GridContainer" {
|
|
var exp: typeof dojox.layout.GridContainer
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/FloatingPane" {
|
|
var exp: typeof dojox.layout.FloatingPane
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/GridContainerLite" {
|
|
var exp: typeof dojox.layout.GridContainerLite
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/GridContainerLite.ChildWidgetProperties" {
|
|
var exp: dojox.layout.GridContainerLite.ChildWidgetProperties
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/ResizeHandle" {
|
|
var exp: typeof dojox.layout.ResizeHandle
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/ToggleSplitter" {
|
|
var exp: typeof dojox.layout.ToggleSplitter
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/RotatorContainer" {
|
|
var exp: typeof dojox.layout.RotatorContainer
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/TableContainer" {
|
|
var exp: typeof dojox.layout.TableContainer
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/TableContainer.ChildWidgetProperties" {
|
|
var exp: dojox.layout.TableContainer.ChildWidgetProperties
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/ScrollPane" {
|
|
var exp: typeof dojox.layout.ScrollPane
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/dnd/Avatar" {
|
|
var exp: typeof dojox.layout.dnd.Avatar
|
|
export=exp;
|
|
}
|
|
declare module "dojox/layout/dnd/PlottedDnd" {
|
|
var exp: typeof dojox.layout.dnd.PlottedDnd
|
|
export=exp;
|
|
}
|