// Type definitions for Dojo v1.9 // Project: http://dojotoolkit.org // Definitions by: Michael Van Sickle // Definitions: https://github.com/borisyankov/DefinitelyTyped /// /// declare module dojox { /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile.html * * Deprecated. Should require dojox/mobile classes directly rather than trying to access them through * this module. * */ interface mobile { } module mobile { /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_ComboBoxMenu.html * * Focus-less menu for internal use in dojox/mobile/ComboBox. * Abstract methods that must be defined externally: * * onChange: item was explicitly chosen (mousedown somewhere on the menu and mouseup somewhere on the menu); * onPage: next(1) or previous(-1) button pressed. * * @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 _ComboBoxMenu extends dijit._WidgetBase implements dojox.mobile._ListTouchMixin, dijit.form._ComboBoxMenuMixin { 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} /** * The name of the CSS class of this widget. * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * */ "class": string; set(property:"class", value: string): void; 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: * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * 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} /** * currently selected node * */ "selected": HTMLElement; set(property:"selected", value: HTMLElement): void; get(property:"selected"): HTMLElement; watch(property:"selected", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * pointer to original DOM node * */ "srcNodeRef": HTMLElement; set(property:"srcNodeRef", value: HTMLElement): void; 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} /** * */ buildRendering(): void; /** * Clears the entries in the drop down list, but of course keeps the previous and next buttons. * */ clearResultList(): 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; /** * Fills in the items in the drop down list * * @param results Array of items * @param options The options to the query function of the store * @param labelFunc Function to produce a label in the drop down list from a dojo.data item */ createOptions(results: any, options: any, labelFunc: 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 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; /** * */ destroyRendering(): 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[]; /** * */ getHighlightedOption(): any; /** * Returns the parent widget of this widget. * */ getParent(): any; /** * Highlight the first real item in the list (not Previous Choices). * */ highlightFirstOption(): void; /** * Highlight the last real item in the list (not More Choices). * */ highlightLastOption(): void; /** * Return true if this widget can currently be focused * and false if not * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) * */ isLeftToRight(): any; /** * 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; /** * */ 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; /** * Select the first displayed item in the list. * */ selectFirstNode(): void; /** * Select the last displayed item in the list * */ selectLastNode(): void; /** * Select the item just below the current selection. * If nothing selected, select first node. * */ selectNextNode(): void; /** * Select the item just above the current selection. * If nothing selected, select last node (if * you select Previous and try to keep scrolling up the list). * */ selectPreviousNode(): void; /** * 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; /** * 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; /** * Notifies ComboBox/FilteringSelect that user selected an option. * * @param direction */ onChange(direction: number): void; /** * * @param node */ onClick(node: HTMLElement): void; /** * Called when the menu closes. * */ onClose(): void; /** * Remove selected CSS. * * @param node */ onDeselect(node: HTMLElement): void; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. * */ onFocus(): void; /** * Called when the menu opens. * */ onOpen(): void; /** * Notifies ComboBox/FilteringSelect that user clicked to advance to next/previous page. * * @param direction */ onPage(direction: number): void; /** * Add selected CSS. * * @param node */ onSelect(node: HTMLElement): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_ContentPaneMixin.html * * Mixin for a very simple content pane to embed an HTML fragment. * By mixing this class into a widget, the widget can have the ability * to embed an external HTML fragment and to run the parser. * */ class _ContentPaneMixin extends dojox.mobile._ExecScriptMixin { constructor(); /** * An HTML fragment to embed. * */ "content": string; /** * If true, executes scripts that is found in the content. * */ "executeScripts": boolean; /** * URL of the content to embed. * */ "href": string; /** * If true, external content specified with the href property is * not loaded at startup time. It can be loaded by calling load(). * */ "lazy": string; /** * If true, runs the parser when the load completes. * */ "parseOnLoad": boolean; /** * If true, shows progress indicator while loading an HTML fragment * specified by href. * */ "prog": boolean; /** * An error handler called when load fails. * * @param err */ errorHandler(err: any): void; /** * Finds script tags and executes the script. * * @param html The HTML input. */ execScript(html: String): any; /** * Loads external content specified with href. * */ load(): void; /** * A handler called when load completes. * * @param response */ loadHandler(response: String): void; /** * Stub method to allow the application to connect to the * loading of external content (see load()). * Called when parsing is done and the content is ready. * */ onLoad(): boolean; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_DataMixin.html * * Mixin for widgets to enable dojo/data data store. * By mixing this class into a widget, it can get data through a * dojo/data data store. The widget must implement * onComplete(/Array/items) to handle the retrieved data. * */ class _DataMixin { constructor(); /** * A query that can be passed to 'store' to initially filter the items. * */ "query": Object; /** * An optional parameter for the query. * */ "queryOptions": Object; /** * Reference to data provider object used by this widget. * */ "store": Object; /** * Fetches the data and generates the list items. * */ refresh(): any; /** * Sets a query. * * @param query * @param queryOptions Optional */ setQuery(query: dojo.data.api.Request , queryOptions: Object): any; /** * Sets a query. * * @param query * @param queryOptions Optional */ setQuery(query: Object, queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions Optional */ setStore(store: dojo.data.api.Read, query: dojo.data.api.Request , queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions Optional */ setStore(store: dojo.data.api.Read, query: Object, queryOptions: Object): any; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_DataListMixin.html * * Mixin for widgets to generate the list items corresponding to * the data provider object. * By mixing this class into the widgets, the list item nodes are * generated as the child nodes of the widget and automatically * regenerated whenever the corresponding data items are modified. * */ class _DataListMixin extends dojox.mobile._DataMixin { constructor(); /** * If true, refresh() does not clear the existing items. * */ "append": boolean; /** * An optional parameter mapping field names from the store to ItemList name. * */ "itemMap": Object; /** * A query that can be passed to 'store' to initially filter the items. * */ "query": Object; /** * An optional parameter for the query. * */ "queryOptions": Object; /** * Reference to data provider object used by this widget. * */ "store": Object; /** * */ buildRendering(): void; /** * Creates a list item widget. * * @param item */ createListItem(item: Object): any; /** * Given the data, generates a list of items. * * @param items * @param dataObject */ generateList(items: any[], dataObject: Object): void; /** * The class used to create list items. Default is dojox/mobile/ListItem. * */ itemRenderer(): void; /** * Fetches the data and generates the list items. * */ refresh(): any; /** * Sets a query. * * @param query * @param queryOptions Optional */ setQuery(query: dojo.data.api.Request , queryOptions: Object): any; /** * Sets a query. * * @param query * @param queryOptions Optional */ setQuery(query: Object, queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions Optional */ setStore(store: dojo.data.api.Read, query: dojo.data.api.Request , queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions Optional */ setStore(store: dojo.data.api.Read, query: Object, queryOptions: Object): any; /** * An handler that is called after the fetch completes. * * @param items * @param request */ onComplete(items: any[], request: Object): void; /** * See dojo/data/api/Notification.onDelete(). * * @param deletedItem */ onDelete(deletedItem: Object): void; /** * An error handler. * * @param errorData * @param request */ onError(errorData: Object, request: Object): void; /** * See dojo/data/api/Notification.onNew(). * * @param newItem * @param parentInfo Optional */ onNew(newItem: Object, parentInfo: Object): void; /** * See dojo/data/api/Notification.onSet(). * * @param item * @param attribute * @param oldValue * @param newValue */ onSet(item: Object, attribute: String, oldValue: Object, newValue: Object): void; /** * See dojo/data/api/Notification.onSet(). * * @param item * @param attribute * @param oldValue * @param newValue */ onSet(item: Object, attribute: String, oldValue: any[], newValue: Object): void; /** * See dojo/data/api/Notification.onSet(). * * @param item * @param attribute * @param oldValue * @param newValue */ onSet(item: Object, attribute: String, oldValue: Object, newValue: any[]): void; /** * See dojo/data/api/Notification.onSet(). * * @param item * @param attribute * @param oldValue * @param newValue */ onSet(item: Object, attribute: String, oldValue: any[], newValue: any[]): void; /** * Refresh list on close. * * @param request Optional */ onStoreClose(request: Object): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_DatePickerMixin.html * * A mixin for date picker widget. * */ class _DatePickerMixin { constructor(); /** * A pattern to be used to format day. * */ "dayPattern": string; /** * A pattern to be used to format month. * */ "monthPattern": string; /** * A string representing the date value. * The setter of this property first converts the value argument by calling * the fromISOString method of the dojo/date/stamp module, then sets the * values of the picker according to the resulting Date object. * If the string cannot be parsed by fromISOString, the method does nothing. * Example: set("value", "2012-1-20"); // January 20, 2012 * The getter returns the string formatted as described in the dojo/date/stamp * module. * */ "value": string; /** * A pattern to be used to format year. * */ "yearPattern": string; /** * Initializes the slots. * */ initSlots(): void; /** * Reorders the slots. * */ reorderSlots(): void; /** * Goes to today. * */ reset(): void; /** * A handler called when the day value is changed. * */ onDaySet(): void; /** * A handler called when the month value is changed. * */ onMonthSet(): void; /** * A handler called when the year value is changed. * */ onYearSet(): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_EditableIconMixin.html * * A mixin for IconContainer to make it editable. * */ class _EditableIconMixin { constructor(); /** * */ "deleteIconForEdit": string; /** * */ "threshold": number; /** * User-defined function to handle clicks for the delete icon. * * @param e */ deleteIconClicked(e: Event): void; /** * Deletes the given item. * * @param item */ deleteItem(item: dijit._WidgetBase): void; /** * Destroys the container. * */ destroy(): void; /** * Ends the editing. * */ endEdit(): void; /** * Moves a child without animation. * * @param widget * @param insertIndex Optional */ moveChild(widget: dijit._WidgetBase, insertIndex: number): void; /** * Moves a child without animation. * * @param widget * @param insertIndex Optional */ moveChild(widget: number, insertIndex: number): void; /** * Moves a child with animation. * * @param widget * @param insertIndex Optional */ moveChildWithAnimation(widget: dijit._WidgetBase, insertIndex: number): void; /** * Moves a child with animation. * * @param widget * @param insertIndex Optional */ moveChildWithAnimation(widget: number, insertIndex: number): void; /** * Removes the given child with animation. * * @param widget */ removeChildWithAnimation(widget: dijit._WidgetBase): void; /** * Removes the given child with animation. * * @param widget */ removeChildWithAnimation(widget: number): void; /** * Scales an item according to the specified ratio. * * @param widget * @param ratio */ scaleItem(widget: dijit._WidgetBase, ratio: number): void; /** * Starts the editing. * */ startEdit(): void; /** * Stub function to connect to from your application. * * @param item */ onDeleteItem(item: dijit._WidgetBase): void; /** * Stub function to connect to from your application. * */ onEndEdit(): void; /** * Stub function to connect to from your application. * * @param item * @param from * @param to */ onMoveItem(item: dijit._WidgetBase, from: number, to: number): void; /** * Stub function to connect to from your application. * */ onStartEdit(): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_ExecScriptMixin.html * * Mixin for providing script execution capability to content handlers. * This module defines the execScript method, which is called * from an HTML content handler. * */ class _ExecScriptMixin { constructor(); /** * Finds script tags and executes the script. * * @param html The HTML input. */ execScript(html: String): any; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_EditableListMixin.html * * A rounded rectangle list. * EditableRoundRectList is a rounded rectangle list, which can be used to * display a group of items. Each item must be a dojox/mobile/ListItem. * */ class _EditableListMixin { constructor(); /** * */ "deleteIconForEdit": string; /** * A read-only flag that indicates whether the widget is in the editing mode. * */ "isEditing": boolean; /** * */ "rightIconForEdit": string; /** * Destroys the widget. * */ destroy(): void; /** * Ends the editing. * */ endEdit(): void; /** * Starts the editing. * */ startEdit(): void; /** * User-defined function to handle clicks. * * @param e */ onClick(e: Event): void; /** * Stub function to connect to from your application. * This function is called when a user clicks the delete * button. * You have to provide that function or subscribe to /dojox/mobile/deleteListItem, * otherwise the delete button will have no-effect. * * @param item */ onDeleteItem(item: dijit._WidgetBase): void; /** * Stub function to connect to from your application. * */ onEndEdit(): void; /** * Stub function to connect to from your application. * * @param item * @param from * @param to */ onMoveItem(item: dijit._WidgetBase, from: number, to: number): void; /** * Stub function to connect to from your application. * */ onStartEdit(): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_IconItemPane.html * * An internal widget used for IconContainer. * * @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 _IconItemPane extends dojox.mobile.Pane { 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} /** * The name of the CSS class of this widget. * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * */ "class": string; set(property:"class", value: string): void; get(property:"class"): string; watch(property:"class", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * CSS class for the close icon. * */ "closeIcon": string; set(property:"closeIcon", value: string): void; get(property:"closeIcon"): string; watch(property:"closeIcon", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The HTML role of the close icon. Example: "button". * */ "closeIconRole": string; set(property:"closeIconRole", value: string): void; get(property:"closeIconRole"): string; watch(property:"closeIconRole", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The title of the close icon. * */ "closeIconTitle": string; set(property:"closeIconTitle", value: string): void; get(property:"closeIconTitle"): string; watch(property:"closeIconTitle", 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: * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * 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} /** * The default icon position for child items. * */ "iconPos": string; set(property:"iconPos", value: string): void; get(property:"iconPos"): string; watch(property:"iconPos", 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} /** * The label of the item. * */ "label": string; set(property:"label", value: string): void; get(property:"label"): string; watch(property:"label", 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} /** * 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} /** * Tab index for the close button, such that users can hit the tab * key to focus on it. * */ "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} /** * 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} /** * */ 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 index of this widget within its container parent. * It returns -1 if the parent does not exist, or if the parent * is not a dijit/_Container * */ getIndexInParent(): any; /** * Returns null if this is the last child of the parent, * otherwise returns the next element sibling to the "right". * */ getNextSibling(): any; /** * Returns the parent widget of this widget. * */ getParent(): any; /** * Returns null if this is the first child of the parent, * otherwise returns the next element sibling to the "left". * */ getPreviousSibling(): any; /** * Hides the widget. * */ hide(): void; /** * Return true if this widget can currently be focused * and false if not * */ isFocusable(): any; /** * Return this widget's explicit or implicit orientation (true for LTR, false for RTL) * */ isLeftToRight(): any; /** * Tests whether the widget is open. * * @param e */ isOpen(e: any): boolean; /** * 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; /** * Calls resize() of each child widget. * */ 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; /** * Shows the widget. * */ show(): 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; /** * 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/mobile/_ListTouchMixin.html * * Focus-less menu to handle touch events consistently. * Focus-less menu to handle touch events consistently. Abstract * method that must be defined externally: * * onClick: item was chosen (mousedown somewhere on the menu and mouseup somewhere on the menu). * */ class _ListTouchMixin extends dijit.form._ListBase { constructor(); /** * currently selected node * */ "selected": HTMLElement; /** * */ postCreate(): void; /** * Select the first displayed item in the list. * */ selectFirstNode(): void; /** * Select the last displayed item in the list * */ selectLastNode(): void; /** * Select the item just below the current selection. * If nothing selected, select first node. * */ selectNextNode(): void; /** * Select the item just above the current selection. * If nothing selected, select last node (if * you select Previous and try to keep scrolling up the list). * */ selectPreviousNode(): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_ItemBase.html * * A base class for item classes (e.g. ListItem, IconItem, etc.). * _ItemBase is a base class for widgets that have capability to * make a view transition when clicked. * * @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 _ItemBase extends dijit._WidgetBase implements dijit._Container, dijit._Contained { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * An alternate text for the icon image. * */ "alt": string; set(property:"alt", value: string): void; get(property:"alt"): string; watch(property:"alt", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * 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} /** * If true, history.back() is called when clicked. * */ "back": boolean; set(property:"back", value: boolean): void; get(property:"back"): boolean; watch(property:"back", 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} /** * A callback function that is called when the transition has been * finished. A function reference, or name of a function in * context. * */ "callback": Function; set(property:"callback", value: Function): void; get(property:"callback"): Function; watch(property:"callback", callback:{(property?:string, oldValue?:Function, newValue?: Function):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} /** * If true, this item becomes clickable even if a transition * destination (moveTo, etc.) is not specified. * */ "clickable": boolean; set(property:"clickable", value: boolean): void; get(property:"clickable"): boolean; watch(property:"clickable", 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: * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * 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 URL of another web page to go to. * */ "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 target that specifies where to open a page specified by * href. The value will be passed to the 2nd argument of * window.open(). * */ "hrefTarget": string; set(property:"hrefTarget", value: string): void; get(property:"hrefTarget"): string; watch(property:"hrefTarget", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * An icon image to display. The value can be either a path for an * image file or a class name of a DOM button. If icon is not * specified, the iconBase parameter of the parent widget is used. * */ "icon": string; set(property:"icon", value: string): void; get(property:"icon"): string; watch(property:"icon", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The position of an aggregated icon. IconPos is comma separated * values like top,left,width,height (ex. "0,0,29,29"). If iconPos * is not specified, the iconPos parameter of the parent widget is * used. * */ "iconPos": string; set(property:"iconPos", value: string): void; get(property:"iconPos"): string; watch(property:"iconPos", 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} /** * A label of the item. If the label is not specified, innerHTML is * used as a label. * */ "label": string; set(property:"label", value: string): void; get(property:"label"): string; watch(property:"label", 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 id of the transition destination view which resides in the * current page. * * If the value has a hash sign ('#') before the id (e.g. #view1) * and the dojo/hash module is loaded by the user application, the * view transition updates the hash in the browser URL so that the * user can bookmark the destination view. In this case, the user * can also use the browser's back/forward button to navigate * through the views in the browser history. * * If null, transitions to a blank view. * If '#', returns immediately without transition. * */ "moveTo": string; set(property:"moveTo", value: string): void; get(property:"moveTo"): string; watch(property:"moveTo", 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} /** * Comma separated parameters to inherit from the parent. * */ "paramsToInherit": string; set(property:"paramsToInherit", value: string): void; get(property:"paramsToInherit"): string; watch(property:"paramsToInherit", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The name of a scene. Used from dojox/mobile/app. * */ "scene": string; set(property:"scene", value: string): void; get(property:"scene"): string; watch(property:"scene", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * If true, the item is highlighted to indicate it is selected. * */ "selected": boolean; set(property:"selected", value: boolean): void; get(property:"selected"): boolean; watch(property:"selected", 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} /** * Tabindex setting for the item so users can hit the tab key to * focus on it. * */ "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} /** * 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} /** * If true, the item acts like a toggle button. * */ "toggle": boolean; set(property:"toggle", value: boolean): void; get(property:"toggle"): boolean; watch(property:"toggle", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):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} /** * A type of animated transition effect. You can choose from the * standard transition types, "slide", "fade", "flip", or from the * extended transition types, "cover", "coverv", "dissolve", * "reveal", "revealv", "scaleIn", "scaleOut", "slidev", * "swirl", "zoomIn", "zoomOut", "cube", and "swap". If "none" is * specified, transition occurs immediately without animation. * */ "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 transition direction. If 1, transition forward. If -1, * transition backward. For example, the slide transition slides * the view from right to left when dir == 1, and from left to * right when dir == -1. * */ "transitionDir": number; set(property:"transitionDir", value: number): void; get(property:"transitionDir"): number; watch(property:"transitionDir", callback:{(property?:string, oldValue?:number, newValue?: number):void}) :{unwatch():void} /** * A hash object that holds transition options. * */ "transitionOptions": Object; set(property:"transitionOptions", value: Object): void; get(property:"transitionOptions"): Object; watch(property:"transitionOptions", callback:{(property?:string, oldValue?:Object, newValue?: Object):void}) :{unwatch():void} /** * A URL of an html fragment page or JSON data that represents a * new view content. The view content is loaded with XHR and * inserted in the current page. Then a view transition occurs to * the newly created view. The view is cached so that subsequent * requests would not load the content again. * */ "url": string; set(property:"url", value: string): void; get(property:"url"): string; watch(property:"url", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * Node id under which a new view will be created according to the * url parameter. If not specified, The new view will be created as * a sibling of the current view. * */ "urlTarget": string; set(property:"urlTarget", value: string): void; get(property:"urlTarget"): string; watch(property:"urlTarget", 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; /** * */ buildRendering(): void; /** * Cancels an ongoing selection (if any). * */ 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; /** * The default action of this item. * * @param e */ defaultClickAction(e: Event): 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 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 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; /** * Copies from the parent and returns the values of parametersspecified by the property paramsToInherit. * */ getTransOpts(): String; /** * Handles this items selection state. * * @param e */ handleSelection(e: Event): void; /** * Returns true if widget has child widgets, i.e. if this.containerNode contains widgets. * */ hasChildren(): boolean; /** * Copies from the parent the values of parameters specified * by the property paramsToInherit. * */ inheritParams(): 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; /** * Makes a transition. * * @param e */ makeTransition(e: Event): void; /** * 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; /** * 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; /** * 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; /** * Stores the clicked position for later use. * Some of the transition animations (e.g. ScaleIn) need the * clicked position. * * @param e */ setTransitionPos(e: 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; /** * Performs a view transition. * Given a transition destination, this method performs a view * transition. This method is typically called when this item * is clicked. * * @param moveTo * @param href * @param url * @param scene */ transitionTo(moveTo: String, href: String, url: String, scene: String): void; /** * Performs a view transition. * Given a transition destination, this method performs a view * transition. This method is typically called when this item * is clicked. * * @param moveTo * @param href * @param url * @param scene */ transitionTo(moveTo: Object, href: String, url: String, scene: String): void; /** * 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; /** * User-defined click action. * * @param e */ userClickAction(e: Event): 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; /** * Called when the widget becomes "active" because * it or a widget inside of it either has focus, or has recently * been clicked. * */ onFocus(): void; /** * User-defined function to handle touchStart events. * * @param e */ onTouchStart(e: Event): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_PickerBase.html * * A base class for picker classes (e.g. SpinWheel, ValuePicker). * * @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 _PickerBase extends dijit._WidgetBase implements dijit._Container, dijit._Contained { 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} /** * An array of slot colors. * Warning: Do not use this property directly, make sure to call set() or get() methods. * */ "colors": any[]; set(property:"colors", value: any[]): void; get(property:"colors"): any[]; watch(property:"colors", callback:{(property?:string, oldValue?:any[], newValue?: any[]):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: * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * 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} /** * An array of slot classes. This property is intended to be used * when you create a subclass of this widget that has specific slots. * */ "slotClasses": any[]; set(property:"slotClasses", value: any[]): void; get(property:"slotClasses"): any[]; watch(property:"slotClasses", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void} /** * An array of index of slotClasses and slotProps. * If there are three slots and slotOrder=[2,1,0], the slots are * displayed in reversed order. This property is intended to be used * when you create a subclass of this widget that has specific slots. * */ "slotOrder": any[]; set(property:"slotOrder", value: any[]): void; get(property:"slotOrder"): any[]; watch(property:"slotOrder", callback:{(property?:string, oldValue?:any[], newValue?: any[]):void}) :{unwatch():void} /** * An array of property objects for each slot class specified in * slotClasses. This property is intended to be used when you * create a subclass of this widget that has specific slots. * */ "slotProps": any[]; set(property:"slotProps", value: any[]): void; get(property:"slotProps"): any[]; watch(property:"slotProps", callback:{(property?:string, oldValue?:any[], newValue?: any[]):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} /** * An array of slot values. * Warning: Do not use this property directly, make sure to call set() or get() methods. * */ "values": any[]; set(property:"values", value: any[]): void; get(property:"values"): any[]; watch(property:"values", callback:{(property?:string, oldValue?:any[], newValue?: any[]):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; /** * */ 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 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 an array of child slot widgets. * */ getSlots(): 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; /** * 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; /** * 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; /** * Resets the picker to show the initial values. * */ reset(): 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}; /** * 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/mobile/_StoreListMixin.html * * Mixin for widgets to generate the list items corresponding to * the dojo/store data provider object. * Mixin for widgets to generate the list items corresponding to * the dojo/store data provider object. * By mixing this class into the widgets, the list item nodes are * generated as the child nodes of the widget and automatically * regenerated whenever the corresponding data items are modified. * */ class _StoreListMixin extends dojox.mobile._StoreMixin { constructor(); /** * If true, refresh() does not clear the existing items. * */ "append": boolean; /** * A property name (a property in the dojo/store item) that specifies that item's children. * */ "childrenProperty": string; /** * An optional parameter mapping field names from the store to ItemList names. * Example: itemMap:{text:'label', profile_image_url:'icon'} * */ "itemMap": Object; /** * A property name (a property in the dojo/store item) that specifies that item's label. * */ "labelProperty": string; /** * A query that can be passed to 'store' to initially filter the items. * */ "query": Object; /** * An optional parameter for the query. * */ "queryOptions": Object; /** * Reference to data provider object used by this widget. * */ "store": Object; /** * */ buildRendering(): void; /** * Creates a list item widget. * * @param item */ createListItem(item: Object): any; /** * */ destroy(): void; /** * Given the data, generates a list of items. * * @param items */ generateList(items: any[]): void; /** * The class used to create list items. Default is dojox/mobile/ListItem. * */ itemRenderer(): void; /** * Fetches the data and generates the list items. * */ refresh(): any; /** * * @param query * @param queryOptions */ setQuery(query: String, queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions */ setStore(store: dojo.store.api.Store, query: String, queryOptions: Object): any; /** * Calls createListItem and adds the new list item when a new data item has been added to the store. * * @param item * @param insertedInto */ onAdd(item: Object, insertedInto: number): void; /** * A handler that is called after the fetch completes. * * @param items */ onComplete(items: any[]): void; /** * Deletes an existing item. * * @param item * @param removedFrom */ onDelete(item: Object, removedFrom: number): void; /** * An error handler. * * @param errorData */ onError(errorData: Object): void; /** * Updates an existing list item when a data item has been modified. * * @param item * @param insertedInto */ onUpdate(item: Object, insertedInto: number): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_ScrollableMixin.html * * Mixin for widgets to have a touch scrolling capability. * */ class _ScrollableMixin extends dojox.mobile.scrollable { constructor(); /** * Flag to allow scrolling in nested containers, e.g. to allow ScrollableView in a SwapView. * */ "allowNestedScrolls": boolean; /** * Enables the search for application-specific bars (header or footer). * */ "appBars": boolean; /** * bounce back to the content area * */ "constraint": boolean; /** * disable the move handler if scroll starts in the unexpected direction * */ "dirLock": boolean; /** * */ "disableFlashScrollBar": boolean; /** * */ "fadeScrollBar": boolean; /** * Id of the fixed footer. * */ "fixedFooter": string; /** * height of a fixed footer * */ "fixedFooterHeight": number; /** * Id of the fixed header. * */ "fixedHeader": string; /** * height of a fixed header * */ "fixedHeaderHeight": number; /** * explicitly specified height of this widget (ex. "300px") * */ "height": string; /** * footer is view-local (as opposed to application-wide) * */ "isLocalFooter": boolean; /** * let touchstart event propagate up * */ "propagatable": boolean; /** * Parameters for dojox/mobile/scrollable.init(). * */ "scrollableParams": Object; /** * show scroll bar or not * */ "scrollBar": boolean; /** * v: vertical, h: horizontal, vh: both, f: flip * */ "scrollDir": string; /** * * 1: use (-webkit-)transform:translate3d(x,y,z) style, use (-webkit-)animation for slide animation * 2: use top/left style, * 3: use (-webkit-)transform:translate3d(x,y,z) style, use (-webkit-)transition for slide animation * 0: use default value (3 for Android, iOS6+, and BlackBerry; otherwise 1) * */ "scrollType": number; /** * drag threshold value in pixels * */ "threshold": number; /** * a node that will have touch event handlers * */ "touchNode": HTMLElement; /** * frictional drag * */ "weight": number; /** * Aborts scrolling. * This function stops the scrolling animation that is currently * running. It is called when the user touches the screen while * scrolling. * */ abort(): void; /** * Adds the transparent DIV cover. * The cover is to prevent DOM events from affecting the child * widgets such as a list widget. Without the cover, for example, * child widgets may receive a click event and respond to it * unexpectedly when the user flicks the screen to scroll. * Note that only the desktop browsers need the cover. * */ addCover(): void; /** * A stub function to be overridden by subclasses. * This function is called from onTouchEnd(). The purpose is to give its * subclasses a chance to adjust the destination position. If this * function returns false, onTouchEnd() returns immediately without * performing scroll. * * @param to The destination position. An object with x and y. * @param pos The current position. An object with x and y. * @param dim Dimension information returned by getDim(). */ adjustDestination(to: Object, pos: Object, dim: Object): boolean; /** * Calculates the scroll bar position. * Given the scroll destination position, calculates the top and/or * the left of the scroll bar(s). Returns an object with x and y. * * @param to The scroll destination position. An object with x and y.ex. {x:0, y:-5} */ calcScrollBarPos(to: Object): Object; /** * Calculate the speed given the distance and time. * * @param distance * @param time */ calcSpeed(distance: number, time: number): number; /** * Checks if the given node is a fixed bar or not. * * @param node * @param local */ checkFixedBar(node: HTMLElement, local: boolean): any; /** * Uninitialize the module. * */ cleanup(): void; /** * Creates a mask for a scroll bar edge. * This function creates a mask that hides corners of one scroll * bar edge to make it round edge. The other side of the edge is * always visible and round shaped with the border-radius style. * */ createMask(): void; /** * */ destroy(): void; /** * Search for application-specific header or footer. * */ findAppBars(): void; /** * Finds the currently displayed view node from my sibling nodes. * * @param node */ findDisp(node: HTMLElement): any; /** * Shows the scroll bar instantly. * This function shows the scroll bar, and then hides it 300ms * later. This is used to show the scroll bar to the user for a * short period of time when a hidden view is revealed. * */ flashScrollBar(): void; /** * Returns various internal dimensional information needed for calculation. * */ getDim(): Object; /** * Gets the top position in the midst of animation. * */ getPos(): Object; /** * Returns the dimensions of the browser window. * */ getScreenSize(): Object; /** * Returns an object that indicates the scrolling speed. * From the position and elapsed time information, calculates the * scrolling speed, and returns an object with x and y. * */ getSpeed(): Object; /** * Hides the scroll bar. * If the fadeScrollBar property is true, hides the scroll bar with * the fade animation. * */ hideScrollBar(): void; /** * Initialize according to the given params. * Mixes in the given params into this instance. At least domNode * and containerNode have to be given. * Starts listening to the touchstart events. * Calls resize(), if this widget is a top level widget. * * @param params Optional */ init(params: Object): void; /** * Returns true if the given node is a form control. * * @param node */ isFormElement(node: HTMLElement): boolean; /** * Returns true if this is a top-level widget. * Subclass may want to override. * */ isTopLevel(): boolean; /** * Constructs a string value that is passed to the -webkit-transform property. * Return value example: "translate3d(0px,-8px,0px)" * * @param to The destination position. An object with x and/or y. */ makeTranslateStr(to: Object): String; /** * Removes the transparent DIV cover. * */ removeCover(): void; /** * Resets the scroll bar length, position, etc. * */ resetScrollBar(): void; /** * Adjusts the height of the widget. * If the height property is 'inherit', the height is inherited * from its offset parent. If 'auto', the content height, which * could be smaller than the entire screen height, is used. If an * explicit height value (ex. "300px"), it is used as the new * height. If nothing is specified as the height property, from the * current top position of the widget to the bottom of the screen * will be the new height. * * @param e */ resize(e: any): void; /** * Scrolls the pane until the searching node is in the view. * Just like the scrollIntoView method of DOM elements, this * function causes the given node to scroll into view, aligning it * either at the top or bottom of the pane. * * @param node A DOM node to be searched for view. * @param alignWithTop OptionalIf true, aligns the node at the top of the pane.If false, aligns the node at the bottom of the pane. * @param duration OptionalDuration of scrolling in seconds. (ex. 0.3)If not specified, scrolls without animation. */ scrollIntoView(node: HTMLElement, alignWithTop: boolean, duration: number): void; /** * Moves the scroll bar(s) to the given position without animation. * * @param to The destination position. An object with x and/or y.ex. {x:2, y:5}, {y:20}, etc. */ scrollScrollBarTo(to: Object): void; /** * Scrolls to the given position immediately without animation. * * @param to The destination position. An object with x and y.ex. {x:0, y:-5} * @param doNotMoveScrollBar OptionalIf true, the scroll bar will not be updated. If not specified,it will be updated. * @param node OptionalA DOM node to scroll. If not specified, defaults tothis.containerNode. */ scrollTo(to: Object, doNotMoveScrollBar: boolean, node: HTMLElement): void; /** * Programmatically sets key frames for the scroll animation. * * @param from * @param to * @param idx */ setKeyframes(from: Object, to: Object, idx: number): void; /** * Sets the given node as selectable or unselectable. * * @param node * @param selectable */ setSelectable(node: HTMLElement, selectable: boolean): void; /** * Shows the scroll bar. * This function creates the scroll bar instance if it does not * exist yet, and calls resetScrollBar() to reset its length and * position. * */ showScrollBar(): void; /** * Moves the scroll bar(s) to the given position with the slide animation. * * @param to The destination position. An object with x and y.ex. {x:0, y:-5} * @param duration Duration of the animation in seconds. (ex. 0.3) * @param easing The name of easing effect which webkit supports."ease", "linear", "ease-in", "ease-out", etc. */ slideScrollBarTo(to: Object, duration: number, easing: String): void; /** * Scrolls to the given position with the slide animation. * * @param to The scroll destination position. An object with x and/or y.ex. {x:0, y:-5}, {y:-29}, etc. * @param duration Duration of scrolling in seconds. (ex. 0.3) * @param easing The name of easing effect which webkit supports."ease", "linear", "ease-in", "ease-out", etc. */ slideTo(to: Object, duration: number, easing: String): void; /** * */ startup(): void; /** * Stops the currently running animation. * */ stopAnimation(): void; /** * called after a scroll has been performed. * * @param e the scroll event, that contains the following attributes:x (x coordinate of the scroll destination),y (y coordinate of the scroll destination),beforeTop (a boolean that is true if the scroll detination is before the top of the scrollable),beforeTopHeight (the number of pixels before the top of the scrollable for the scroll destination),afterBottom (a boolean that is true if the scroll destination is after the bottom of the scrollable),afterBottomHeight (the number of pixels after the bottom of the scrollable for the scroll destination) */ onAfterScroll(e: Event): void; /** * called before a scroll is initiated. If this method returns false, * the scroll is canceled. * * @param e the scroll event, that contains the following attributes:x (x coordinate of the scroll destination),y (y coordinate of the scroll destination),beforeTop (a boolean that is true if the scroll detination is before the top of the scrollable),beforeTopHeight (the number of pixels before the top of the scrollable for the scroll destination),afterBottom (a boolean that is true if the scroll destination is after the bottom of the scrollable),afterBottomHeight (the number of pixels after the bottom of the scrollable for the scroll destination) */ onBeforeScroll(e: Event): boolean; /** * * @param e */ onFlickAnimationEnd(e: any): void; /** * * @param e */ onFlickAnimationStart(e: any): void; /** * User-defined function to handle touchEnd events. * * @param e */ onTouchEnd(e: Event): void; /** * User-defined function to handle touchMove events. * * @param e */ onTouchMove(e: any): void; /** * User-defined function to handle touchStart events. * * @param e */ onTouchStart(e: any): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_StoreMixin.html * * Mixin for widgets to enable dojo/store data store. * By mixing this class into a widget, it can get data through a * dojo/store data store. The widget must implement the following * methods to handle the retrieved data: * * onComplete(/Array/items), onError(/Object/errorData), * onUpdate(/Object/item, /Number/insertedInto), and * onDelete(/Object/item, /Number/removedFrom). * */ class _StoreMixin { constructor(); /** * A property name (a property in the dojo/store item) that specifies that item's children. * */ "childrenProperty": string; /** * A property name (a property in the dojo/store item) that specifies that item's label. * */ "labelProperty": string; /** * A query that can be passed to 'store' to initially filter the items. * */ "query": Object; /** * An optional parameter for the query. * */ "queryOptions": Object; /** * Reference to data provider object used by this widget. * */ "store": Object; /** * */ destroy(): void; /** * Fetches the data and generates the list items. * */ refresh(): any; /** * * @param query * @param queryOptions */ setQuery(query: String, queryOptions: Object): any; /** * Sets the store to use with this widget. * * @param store * @param query * @param queryOptions */ setStore(store: dojo.store.api.Store, query: String, queryOptions: Object): any; /** * Called when a new data item has been added to the store. * Note: for compatibility with previous versions where this function did not exist, * if onAdd is not defined, onUpdate will be called instead. * * @param item * @param insertedInto */ onAdd(item: any, insertedInto: any): void; /** * A handler that is called after the fetch completes. * * @param items */ onComplete(items: any): void; /** * Called when a data item has been removed from the store. * * @param item * @param removedFrom */ onDelete(item: any, removedFrom: any): void; /** * An error handler. * * @param errorData */ onError(errorData: any): void; /** * Called when an existing data item has been modified in the store. * Note: for compatibility with previous versions where only onUpdate was present, * if onAdd is not defined, onUpdate will be called instead. * * @param item * @param insertedInto */ onUpdate(item: any, insertedInto: any): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/_TimePickerMixin.html * * A mixin for time picker widget. * */ class _TimePickerMixin { constructor(); /** * A Date object corresponding to the current values of the picker. * */ "date": Date; /** * Goes to now. Resets the hour and minutes to the current time. * */ reset(): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/Accordion.html * * A container widget that can display a group of child panes in a stacked format. * Typically, dojox/mobile/Pane, dojox/mobile/Container, or dojox/mobile/ContentPane are * used as child widgets, but Accordion requires no specific child widget. * Accordion supports three modes for opening child panes: multiselect, fixed-height, * and single-select. Accordion can have rounded corners, and it can lazy-load the * content modules. * * @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 Accordion extends dijit._WidgetBase implements dijit._Container, dijit._Contained { constructor(params?: Object, srcNodeRef?: HTMLElement); /** * If true, animation is used when a pane is opened or * collapsed. The animation works only on webkit browsers. * */ "animation": boolean; set(property:"animation", value: boolean): void; get(property:"animation"): boolean; watch(property:"animation", 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} /** * The name of the CSS class of this widget. * */ "baseClass": string; set(property:"baseClass", value: string): void; get(property:"baseClass"): string; watch(property:"baseClass", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * These properties can be specified for the children of a dojox/mobile/Accordion. * */ "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} /** * Designates where children of the source DOM node will be placed. * "Children" in this case refers to both DOM nodes and widgets. * For example, for myWidget: * *
* here's a plain DOM node * and a widget * and another plain DOM node *
* containerNode would point to: * * here's a plain DOM node * and a widget * and another plain DOM node * In templated widgets, "containerNode" is set via a * data-dojo-attach-point assignment. * * containerNode must be defined for any widget that accepts innerHTML * (like ContentPane or BorderContainer or even Button), and conversely * is null for widgets that don't, like TextBox. * */ "containerNode": HTMLElement; set(property:"containerNode", value: HTMLElement): void; get(property:"containerNode"): HTMLElement; watch(property:"containerNode", callback:{(property?:string, oldValue?:HTMLElement, newValue?: HTMLElement):void}) :{unwatch():void} /** * 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} /** * */ "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} /** * If true, the entire accordion widget has fixed height regardless * of the height of each pane; in this mode, there is always an open pane and * collapsing a pane can only be done by opening a different pane. * */ "fixedHeight": boolean; set(property:"fixedHeight", value: boolean): void; get(property:"fixedHeight"): boolean; watch(property:"fixedHeight", 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 default icon path for child widgets. * */ "iconBase": string; set(property:"iconBase", value: string): void; get(property:"iconBase"): string; watch(property:"iconBase", callback:{(property?:string, oldValue?:string, newValue?: string):void}) :{unwatch():void} /** * The default icon position for child widgets. * */ "iconPos": string; set(property:"iconPos", value: string): void; get(property:"iconPos"): string; watch(property:"iconPos", 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} /** * 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} /** * If true, the widget shows rounded corners. * Adding the "mblAccordionRoundRect" class to domNode has the same effect. * */ "roundRect": boolean; set(property:"roundRect", value: boolean): void; get(property:"roundRect"): boolean; watch(property:"roundRect", callback:{(property?:string, oldValue?:boolean, newValue?: boolean):void}) :{unwatch():void} /** * If true, only one pane is open at a time. The current open pane * is collapsed, when another pane is opened. * */ "singleOpen": boolean; set(property:"singleOpen", value: boolean): void; get(property:"singleOpen"): boolean; watch(property:"singleOpen", 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} /** * 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 widget * @param insertIndex Optional */ addChild(widget: dijit._WidgetBase, insertIndex: number): void; /** * */ buildRendering(): void; /** * Collapses the given pane to close it. * * @param pane A pane widget to collapse. * @param noAnimation If true, the pane collapses immediately without animation effect. */ collapse(pane: dijit._WidgetBase, noAnimation: boolean): 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; /** * Unhighlights the title bar of the given pane. * * @param pane A pane widget to unhighlight. */ deselect(pane: dijit._WidgetBase): void; /** * 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; /** * Expands the given pane to make it visible. * * @param pane A pane widget to expand. * @param noAnimation If true, the pane expands immediately without animation effect. */ expand(pane: dijit._WidgetBase, noAnimation: boolean): 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; /** * */ getChildren(): 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; /** * */ getSelectedPanes(): 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; /** * 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; /** * * @param widget */ removeChild(widget: dijit._WidgetBase): void; /** * * @param widget */ removeChild(widget: number): void; /** * */ resize(): void; /** * Highlights the title bar of the given pane. * * @param pane A pane widget to highlight. */ select(pane: dijit._WidgetBase): 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}; /** * 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; } module Accordion { /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/Accordion.ChildWidgetProperties.html * * These properties can be specified for the children of a dojox/mobile/Accordion. * */ interface ChildWidgetProperties { /** * The alternate text of the Accordion title. * */ alt: string; /** * The unselected icon of the Accordion title. * */ icon1: string; /** * The selected icon of the Accordion title. * */ icon2: string; /** * The position ("top,left,width,height") of the unselected aggregated icon of the Accordion title. * */ iconPos1: string; /** * The position ("top,left,width,height") of the selected aggregated icon of the Accordion title. * */ iconPos2: string; /** * The label of the Accordion title. * */ label: string; /** * Specifies that the Accordion child must be lazily loaded. * */ lazy: boolean; /** * The selected state of the Accordion title. * */ selected: boolean; } } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/Badge.html * * A utility class to create and update a badge node. * Badge is not a widget, but a simple utility class for creating and * updating a badge node. A badge consists of a simple DOM button. * It is intended to be used from other widgets such as dojox/mobile/IconItem * or dojox/mobile/TabBarButton. * * @param params OptionalContains properties to be set. * @param node OptionalThe DOM node. If none is specified, it is automatically created. */ class Badge { constructor(params?: Object, node?: HTMLElement); /** * A CSS class name of a DOM button. * */ "className": string; /** * Font size in pixel. The other style attributes are determined by the DOM * button itself. * Note that changing the value of the property after the badge * creation has no effect. * */ "fontSize": number; /** * A text to show in a badge. * Note that changing the value of the property after the badge * creation has no effect. * */ "value": string; /** * Returns the text shown in the badge. * */ getValue(): String; /** * Set a label text to the badge. * * @param value */ setValue(value: String): void; } /** * Permalink: http://dojotoolkit.org/api/1.9/dojox/mobile/Audio.html * * A thin wrapper around the HTML5